Add API Table to API Markdown File

[idea404]

What 💻

• Adds a table with APIs including their statuses and description to the SUPPORTED_APIS.md file.

Why ✋

• Quick overview of progress in API support.

Evidence 📷

Notes 📝

• The APIS in the table were sourced from:
  • https://hardhat.org/hardhat-network/docs/reference#hardhat-network-methods
  • https://ganache.dev/

[MexicanAce]

Overall, we are missing the following API namespaces:

1. eth_
2. evm_
3. debug_
4. hardhat_
5. miner_ (Optional)
6. web3_ (Optional)

[idea404]

Overall, we are missing the following API namespaces:

1. eth_
2. evm_
3. debug_
4. hardhat_
5. miner_ (Optional)
6. web3_ (Optional)

@MexicanAce Is the hardhat_ namespace actually required? I see an overlap in functionality between what is or can be implemented and the what the hardhat_ methods do. For example, hardhat_setLoggingEnabled is very similar to what config_setShowCalls does. Additionally, I believe it would make maintaining the repo easier if there are a set of general APIs made available which could be called by APIs with different names on the developer interface/CLI.

[MexicanAce]

Overall, we are missing the following API namespaces:

1. eth_
2. evm_
3. debug_
4. hardhat_
5. miner_ (Optional)
6. web3_ (Optional)

@MexicanAce Is the hardhat_ namespace actually required? I see an overlap in functionality between what is or can be implemented and the what the hardhat_ methods do. For example, hardhat_setLoggingEnabled is very similar to what config_setShowCalls does. Additionally, I believe it would make maintaining the repo easier if there are a set of general APIs made available which could be called by APIs with different names on the developer interface/CLI.

Yes hardhat_ is required as we'll want to support native integration with Hardhat (Ex: hardhat_impersonateAccount is heavily used).

hardhat_setLogging controls the network node's listener for console.log() contract. We currently are always listening to this output and it's different output than our in-memory node's config_setShowCalls.

For clarity, these are the underlying JSON RPC requests that the JavaScript helper functions call and expect to work. There is an abstraction layer on top of this from the Hardhat/Foundry/Ganache side of things.

[idea404]

@MexicanAce I've updated the listed APIs to match those of ganache and hardhat, keen to hear what you think.

[MexicanAce]

This is IMPLEMENTED: https://github.com/matter-labs/era-test-node/blob/main/src/node.rs#L678

[idea404]

This one's a little confusing. The code points to bytes but I send this:

POST http://localhost:8011
content-type: application/json

{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "eth_sendRawTransaction",
    "params": ["bogus"]
}

And returns:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32602,
    "message": "Invalid params: invalid value: string \"bogus\", expected 0x prefix."
  },
  "id": "1"
}

and sending:

POST http://localhost:8011
content-type: application/json

{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "eth_sendRawTransaction",
    "params": ["0x0000"]
}

returns:

socket hang up on VSCode and thread 'tokio-runtime-worker' panicked at 'called Result::unwrap()on anErr value: UnknownTransactionFormat', src/node.rs:688:82 on logs for node

[MexicanAce]

Sending "bogus" is interpreted as a string and not bytes in Rust. If you prefix with 0x than it'll read as bytes in RPC.

Yeah, the node doesn't gracefully handle errors when you send random bytes that aren't a real transaction. This is the work @dutterbutter is working on right now as part of this upcoming release.

[idea404]

Great! I pushed a success eth_call example, and tried using that for this function too, but with the same error message as a result sadly. Here's what I tried:

const obj = {
        "to": "0x36615Cf349d7F6344891B1e7CA7C72883F5dc049",
        "data": "0x0000",
        "from": "0xa61464658AfeAf65CccaaFD3a512b69A83B77618",
        "gas": "0x0000",
        "gasPrice": "0x0000",
        "value": "0x0000",
        "nonce": "0x0000"
};

function utf8ToHex(str) {
  return '0x' + Array.from(str).map(c =>
    c.charCodeAt(0) < 128 ? c.charCodeAt(0).toString(16) :
    encodeURIComponent(c).replace(/\%/g,'').toLowerCase()
  ).join('');
}

console.log(utf8ToHex(JSON.stringify(obj)));

to:

###
POST http://localhost:8011
content-type: application/json

{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "eth_sendRawTransaction",
    "params": ["0x7b22746f223a22307833363631354366333439643746363334343839314231653743413743373238383346356463303439222c2264617461223a22307830303030222c2266726f6d223a22307861363134363436353841666541663635436363616146443361353132623639413833423737363138222c22676173223a22307830303030222c226761735072696365223a22307830303030222c2276616c7565223a22307830303030222c226e6f6e6365223a22307830303030227d"]
}

[idea404]

Have modified it to IMPLEMENTED on the table now 👍

[MexicanAce]

I think eth_sendRawTransaction is still showing as NOT IMPLEMENTED

[idea404]

Keen eye, added:) @MexicanAce

[MexicanAce]

LGTM