Implement V1 endpoints

[emostov]

Initial v1.0

• /accounts/{accountId}/balance-info (conversion of existing endpoint) (Implement accounts/id/{staking-info, balance-info, vesting-info} & pallets/staking/progress #248)
• /accounts/{accountId}/staking-info (conversion of existing endpoint) (Implement accounts/id/{staking-info, balance-info, vesting-info} & pallets/staking/progress #248)
• /accounts/{accountId}/staking-payouts (Implement accounts/{accountId}/staking-payouts #217)
• /accounts/{accountId}/vesting-info (conversion of existing endpoint) (Implement accounts/id/{staking-info, balance-info, vesting-info} & pallets/staking/progress #248)
• /blocks/{blockId} (conversion of existing endpoint)
• /blocks/head (conversion of existing endpoint)
• /node/network (Implement node endpoints #226)
• /node/transaction-pool (Implement node endpoints #226)
• /node/version (Implement node endpoints #226)
• /transaction (conversion of existing endpoint) (Implement transaction/{ , material, fee-estimate} #246)
• /transaction/dry-run (Implement transaction/dry-run #236)
• /transaction/fee-estimate (conversion of existing endpoint) (Implement transaction/{ , material, fee-estimate} #246)
• /transaction/material (conversion of existing endpoint) (Implement transaction/{ , material, fee-estimate} #246)
• /runtime/code (Implement runtime/code & runtime/spec #228)
• /runtime/spec (Implement runtime/code & runtime/spec #228)
• /runtime/metadata (conversion of existing endpoint) (Implement /runtime/metadata #242)
• /pallets/staking/progress (conversion of existing endpoint) (Implement accounts/id/{staking-info, balance-info, vesting-info} & pallets/staking/progress #248)
• /pallets/{palletId}/storage/{storageItemId}

Other

• hosted swagger ui (Add OpenApi UI structure in docs folder for future use #239)

[vikmeup]

@emostov Is there any plans to support transaction/:hash endpoint? This is very critical endpoint for wallet providers.

Or once transaction is broadcasted is there a way to check its status? to make sure it's been committed and balance now changed for the account?

[emostov]

At the moment I think the closets thing that we are planning on that would aid in the transaction tracking process is /node/transaction-pool. As far as I know Substrate does not support the ability to track arbitrary transactions once they are finalized (or rejected) - for quick look ups one would need watch and index transactions in finalized blocks.

To check that an account balance has been mutated as a side affect from a transaction one could use a combination of events from the transaction (events for a transaction are accessible by the /block resource) and by checking the accounts balance (/accounts/{accountId}/balance-info)

There is a author_submitAndWatchExtrinsic RPC that I believe would let one subscribe to updates until a transaction is finalized or rejected. However, from what I can tell its not exposed for Polkadot or Kusama and we don't have any plans to incorporate it at the moment. @joepetrowski might have more insight into the possibility of supporting this.

For more details on the proposed endpoints you can check out https://emostov.github.io/sidecar-openapi-ui/dist/

[joepetrowski]

@emostov Is there any plans to support transaction/:hash endpoint? This is very critical endpoint for wallet providers.

Or once transaction is broadcasted is there a way to check its status? to make sure it's been committed and balance now changed for the account?

We will definitely not support /transaction/:hash as it's not a correct way to identify the execution of a transaction. You should be syncing every block and seeing if any of the extrinsics match the hash and then, as @emostov mentioned, check the events for what happened. See the unique identifiers section of the Integration Guide for more info.