Skip to content
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

Create draft EIP-symbol #3014

Merged
merged 15 commits into from
Oct 3, 2020
48 changes: 48 additions & 0 deletions EIPS/eip-3014.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
eip: 3014
title: Create `eth_symbol` method for JSON-RPC
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Create `eth_symbol` method for JSON-RPC
title: `eth_symbol` JSON-RPC method

Consider tightening up the title to be a bit more terse.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point #3018

author: Peter Grassberger (@PeterTheOne)
discussions-to: https://github.com/ethereum/EIPs/issues/3012
status: Draft
type: Standards Track
category: Interface
created: 2020-09-30
---

## Simple Summary
Add `eth_symbol` method to the JSON-RPC that returns the symbol of the native coin of the network.

## Abstract
The new method `eth_symbol` (`eth_`-namespaced) has no parameters and returns a string of the native coin of the network. For the Ethereum mainnet this will be `ETH`, other networks will have other symbols.

## Motivation
Wallets (Metamask, Mobile Wallets, Web Wallets, etc.) that deal with multiple networks need some basic information for every blockchain that they connect to. One of those things is the symbol of the native coin of the network. Instead of requiring the user to research and manually add the symbol it could be provided to the wallet via this proposed JSON-RPC endpoint and used automatically. There are lists of networks with symbols like https://github.com/ethereum-lists/chains where a user can manually look up the correct values. But this information could easily come from the network itself.
PeterTheOne marked this conversation as resolved.
Show resolved Hide resolved

## Specification
Method: `eth_symbol`.

Params: none.

Returns: `result` - the native coin symbol, string

Example:

```js
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_symbol","params":[],"id":1}'

// Result
{
"id": 1,
"jsonrpc": "2.0",
"result": "ETH"
}
```

## Rationale
This endpoint is similar to https://eips.ethereum.org/EIPS/eip-695 but it provides the symbol instead of chainId. It provides functionality that is already there for ERC-20 tokens (https://eips.ethereum.org/EIPS/eip-20), but not yet for the native coin of the network. Alternative naming of `eth_nativeCurrencySymbol` was considered, but the context and the fact that it just returns one value makes it clear that that it returns the symbol for the native coin of the network.
PeterTheOne marked this conversation as resolved.
Show resolved Hide resolved

## Security Considerations
It is a read only endpoint. The information is only as trusted as the JSON-RPC node itself, it could supply wrong information and thereby trick the user in beleaving he/she is dealing with another native coin.
PeterTheOne marked this conversation as resolved.
Show resolved Hide resolved

## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).