Skip to content

Finalize API v2 specification along with the new requirements #295

@kacpersaw

Description

@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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions