Finalize API v2 specification along with the new requirements

[kacpersaw]

Description

The ask is to prepare new schema for new improved API v2.

List of endpoints required for now (spec is still in progress):

1. current head layer number and nodeID hash
   • known chain head block/layer
   • current highest layer
   • sync status (in sync, syncing, offline)
2. detail of given layer by layer number
   • empty layer, or return single canonical block with:
     • block header/block ID
     • list of transactions (effective and ineffective, possibly with option to filter effective only)
3. account details by address
   • current balance and counter
   • projected balance and counter
4. broadcast raw, signed tx
   • return txid
5. tx by txid
   • state (unknown, pending, contextually invalid/malformed, duplicate, ineffective/contextually invalid, in mempool, included in block, passed hare, passed tortoise/verified, reorg'ed out/replaced)
   • gas consumed
   • execution success/failure (receipt)
   • tx type
     • single sig spend
     • multi sig spend
     • single sig spawn
     • multi sig spawn
   • principal
   • parsed contents
     • amount
     • recipient
6. gas estimation
   • recommended maxGas per tx type

[brusherru]

Here are the list of APIs required by Wallet application:

Network-specific data

• Node info: node/nodeinfo To get a proper HRP, First genesis layer & epoch size for timestamps
• GenesisTime: mesh/genesistime To calculate timestamps
• LayerDuration: mesh/layerduration To calculate timestamps

Node status:

• Node status: node/status To ensure that Node is synced & can publish txs

User data:

• Balance: globalstate/accountdataquery (can be replaced with globalstate/account)
• Txs:
  • Tx data: mesh/accountmeshdataquery
  • Tx states: transaction/transactionsstate
• Rewards: globalstate/accountdataquery

Publishing txs:

• Gas estimation: transaction/parsetransaction Funny thing that it may parse TX without a signature, but then it will estimate the wrong gas amount, like it may be published without a signature. So if you don't have a signature yet — put there 64 zero-bytes and verify: false :) This statement is valid for gRPC as well.
• Submit: transaction/submittransaction

All of them already exist and should work via JSON RPC (I haven't tested all of them yet). So I'm using them now, and propose to focus on endpoints that consume too much resources or are unsafe.

[kacpersaw]

Done

• Activation service: https://github.com/spacemeshos/api/pull/305
• Reward service: https://github.com/spacemeshos/api/pull/307
• Network service: https://github.com/spacemeshos/api/pull/315
• Node service: https://github.com/spacemeshos/api/pull/316
• Layer and block service: https://github.com/spacemeshos/api/pull/319
• Transaction service https://github.com/spacemeshos/go-spacemesh/pull/5933
• Account service https://github.com/spacemeshos/go-spacemesh/pull/5982

[kacpersaw]

API is implemented and exposed on https://mainnet-api-docs.spacemesh.network/index.html