-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Add EIP: Ethereum Intent URI (EIURI) #9644
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
101e512
2e39657
f072ba7
f7592a2
9e97e39
15a4bc0
c71c6b7
7d6c65a
2811279
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
--- | ||
eip: 7933 | ||
title: Ethereum Intent URI (EIURI) | ||
description: A Universal action URI format for Ethereum (represent and trigger Ethereum RPC requests) | ||
author: Frani (@frani) | ||
discussions-to: https://ethereum-magicians.org/t/eip-7924-ethereum-intent-uri-ei-uri-a-universal-action-uri-format-for-ethereum/23554 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. eip number and eip number in link doesn't match, |
||
status: Draft | ||
type: Standards Track | ||
category: Interface | ||
created: 2025-04-15 | ||
requires: 681 | ||
--- | ||
|
||
## Abstract | ||
|
||
This EIP introduces a standardized URI format for representing and triggering Ethereum JSON-RPC requests, allowing users to execute blockchain actions directly via URLs or QR codes. It extends the existing `ethereum:` URI scheme by supporting full RPC methods, optional chain identifiers, and additional semantic metadata such as `intent`, enhancing Web3 UX and interoperability across wallets. | ||
|
||
## Motivation | ||
|
||
ERC-681 introduced a way to encode Ethereum payment requests via URIs, laying the foundation for user-friendly interactions such as QR-code based payments. However, its scope is limited to eth_sendTransaction and lacks flexibility for more complex interactions, such as multi-call sequences, RPC methods beyond simple transfers, and chain-specific contexts. | ||
|
||
As the ecosystem matures, users are increasingly performing a variety of Web3 actions—depositing into vaults, interacting with smart contracts, switching chains, or batch-signing transactions—all of which are not easily represented within the current URI standard. | ||
|
||
This proposal aims to extend the URI pattern introduced in ERC-681 to support: | ||
|
||
Arbitrary RPC calls (e.g., wallet_addEthereumChain, eth_call, eth_signTypedData) | ||
|
||
Chained or multi-step requests via base64-encoded payloads | ||
|
||
A clear and consistent way to encode the target chain (via chainId) | ||
|
||
A more versatile way to encode intent (e.g., "deposit", "swap", "vote", etc.) | ||
|
||
Seamless QR-based user interactions without requiring wallet connection or dapp session | ||
|
||
By standardizing this flexible URI format, wallets can parse and act on requests directly from a link or QR code, enabling smoother real-world interactions and improving onboarding, security, and UX across Ethereum applications. | ||
|
||
## Specification | ||
|
||
The URI format extends the current `ethereum:` scheme: | ||
|
||
``` | ||
request = schema_prefix [ rpc_method ] [ "-" target_address ] [ "@" chain_id ] [ "?" parameters ] | ||
schema_prefix = "ethereum" ":" [ "pay-" / rpc_method "-" ] | ||
rpc_method = STRING | ||
target_address = ethereum_address / "CURRENT_ACCOUNT" | ||
chain_id = 1*DIGIT | ||
ethereum_address = ( "0x" 40*HEXDIG ) / ENS_NAME | ||
parameters = parameter *( "&" parameter ) | ||
parameter = key "=" value | ||
key = STRING | ||
value = number / ethereum_address / STRING / base64_string / hex_value / "CURRENT_ACCOUNT" | ||
number = [ "-" / "+" ] *DIGIT [ "." 1*DIGIT ] [ ( "e" / "E" ) [ 1*DIGIT ] ] | ||
base64_string = *( ALPHA / DIGIT / "+" / "/" ) [ "=" [ "=" ] ] | ||
hex_value = "0x" 1*HEXDIG | ||
``` | ||
|
||
`ethereum:<rpc_method>-0x0000000000000000000000000000000000000000@<chain_id>[\?<key>=<value>&...]` | ||
|
||
The special value `CURRENT_ACCOUNT` is a placeholder that will be replaced by the wallet implementation with the user's currently selected Ethereum address. When a wallet encounters this placeholder in the URI, it should substitute the user's current active address before processing the request. This allows URIs to be created that dynamically target the user's active wallet address without needing to know it in advance. The uppercase format follows common convention for symbolic constants. | ||
|
||
The zero address (`0x0000000000000000000000000000000000000000`) is used as a placeholder in URIs when calling RPC methods that don't require a target address. This maintains consistency with the URI format while allowing for RPC calls like `wallet_addEthereumChain` or `eth_chainId` that operate at the wallet/node level rather than targeting a specific contract. Wallets should ignore this zero address for methods where it's not relevant to the operation. | ||
|
||
### JSON-like Bracket Notation | ||
|
||
For parameters that represent nested objects or arrays, the URI format supports JSON-like bracket notation: | ||
|
||
- Objects: Use `[key]` to denote nested object properties | ||
- Arrays: Use `[index]` to denote array elements | ||
|
||
For example, a nested object parameter like: | ||
|
||
```json | ||
{ | ||
"chainId": "0x1", | ||
"chainName": "Ethereum Mainnet", | ||
"rpcUrls": ["https://mainnet.infura.io/v3/..."], | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid using real services, this URL can be example.com. |
||
"iconUrls": ["https://example.com/icon.png"], | ||
"nativeCurrency": { | ||
"name": "Ether", | ||
"symbol": "ETH", | ||
"decimals": 18 | ||
}, | ||
"blockExplorerUrls": ["https://etherscan.io"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid using real services, this URL can be example.com. |
||
} | ||
``` | ||
|
||
Can be represented as: | ||
|
||
` | ||
ethereum:wallet_addEthereumChain-0x0000000000000000000000000000000000000000?chainId=0x1&chainName=Ethereum%20Mainnet&rpcUrls[0]=https%3A%2F%2Fmainnet.infura.io%2Fv3%2F...&iconUrls[0]=https%3A%2F%2Fexample.com%2Ficon.png&nativeCurrency[name]=Ether&nativeCurrency[symbol]=ETH&nativeCurrency[decimals]=18&blockExplorerUrls[0]=https%3A%2F%2Fetherscan.io | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid using real services and instead use example.com domains. |
||
` | ||
|
||
### Required components | ||
|
||
- `rpc_method`: any valid Ethereum JSON-RPC method supported by the wallet (e.g. `eth_sendTransaction`, `wallet_addEthereumChain`, etc.) | ||
- `chain_id`: optional chain identifier (e.g. `1` for Ethereum Mainnet, `324` for ZkSync Era) | ||
- URL parameters: key-value pairs representing the parameters of the RPC method | ||
|
||
### Optional components | ||
|
||
- `requests_b64`: for `multi-request`, a base64-encoded array of RPC calls | ||
|
||
### Example URIs | ||
|
||
**eth_sendTransaction** | ||
|
||
``` | ||
ethereum:eth_sendTransaction-0x0000000000000000000000000000000000000000@324?from=CURRENT_ACCOUNT&to=0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238&gas=0x76c0&gasPrice=0x4a817c800&value=0x0&data=0xa9059cbb000000000000000000000000ffce4d191cb5007ee9ad7226581f7e217b68cafe00000000000000000000000000000000000000000000000000000000000f4240636166656369746f | ||
``` | ||
|
||
**wallet_addEthereumChain** | ||
|
||
` | ||
ethereum:wallet_addEthereumChain-0x0000000000000000000000000000000000000000?chainId=0x64&chainName=Gnosis&rpcUrls[0]=https%3A%2F%2Frpc.gnosischain.com&iconUrls[0]=https%3A%2F%2Fxdaichain.com%2Ffake%2Fexample%2Furl%2Fxdai.svg%2Chttps%3A%2F%2Fxdaichain.com%2Ffake%2Fexample%2Furl%2Fxdai.png&nativeCurrency[name]=xDAI&nativeCurrency[symbol]=xDAI&nativeCurrency[decimals]=18&blockExplorerUrls[0]=https%3A%2F%2Fgnosisscan.io | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid using real services and products names in the examples. |
||
` | ||
|
||
**multiRequest** | ||
|
||
``` | ||
ethereum:multiRequest-0x0000000000000000000000000000000000000000@324?requests_b64=W3sibWV0aG9kIjoid2FsbGV0X3N3aXRjaEV0aGVyZXVtQ2hhaW4iLCJwYXJhbXMiOlt7ImNoYWluSWQiOiIweDE0NCJ9XX0seyJtZXRob2QiOiJldGhfc2VuZFRyYW5zYWN0aW9uIiwicGFyYW1zIjpbeyJmcm9tIjoiMHg4MDgyZGE2NzcxMGMxNGU3ZjY2OGVmYzczYWMyN2FkNmIyZDdjYWZlIiwidG8iOiIweDFjN0Q0QjE5NkNiMEM3QjAxZDc0M0ZiYzYxMTZhOTAyMzc5QzcyMzgiLCJnYXMiOiIweDc2YzAiLCJnYXNQcmljZSI6IjB4NGE4MTdjODAwIiwidmFsdWUiOiIweDAiLCJkYXRhIjoiMHhhOTA1OWNiYjAwMDAwMDAwMDAwMDAwMDAwMDBmZmNlNGQxOTFjYjUwMDdlZTlhZDcyMjY1ODFmN2UyMTdiNjhjYWZlMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwZjQyNDA2MzYxNmY2NjYzNjk3In1dfV0= | ||
``` | ||
|
||
## Rationale | ||
|
||
- **Intents** allow wallet interfaces to preemptively guide users through transactions with clear context. | ||
- **Chain-specific targeting** improves safety and predictability across networks. | ||
- **Multi-request** support allows for batch operations, simplifying advanced workflows (e.g., approval + vault deposit). | ||
- **QR-friendly design** enables real-world usage (e.g., payments, POS, offline signing). | ||
|
||
Alternate designs such as JSON files or app links introduce complexity and dependency on frontend apps, while EI-URI stays fully compatible with existing URI schemes and QR infrastructure. | ||
|
||
## Backwards Compatibility | ||
|
||
The proposed format extends the existing `ethereum:` URI standard but remains backward-compatible. Wallets that do not support the extended format will simply ignore unknown parameters. | ||
|
||
## Test Cases | ||
|
||
TBD – Will include example URIs and expected behavior in compatible wallets. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add a html <--TODO--> tag so that bot can flag this if you try to move beyond draft and still not addressed this TBD |
||
|
||
## Reference Implementation | ||
|
||
A reference implementation could be built as a lightweight URI parser in JavaScript that extracts and maps the URL to a `window.ethereum.request(...)` call. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
## Security Considerations | ||
|
||
Wallets MUST validate all parameters before executing actions. Special care must be taken with `multi-request`, base64 decoding, and default values like `gas` or `value` to avoid exploits or phishing vectors. | ||
|
||
## Copyright | ||
|
||
Copyright and related rights waived via [CC0](../LICENSE.md). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.