PoS Migration Guide for JSON-RPC ​

1. General ​

• params property in requests is now required
  While in PoW the params property in requests could be left out for requests that didn't take any parameters (or only optional ones), this is no longer the case in PoS. At least an empty array ([]) must now be passed.

• Most params are now required
  In PoW many parameters could be left out, because they had a default in the server. In PoS most parameters are now required. For non-required parameters, null must still be passed in their place to use the server's default.

• The result of a JSON-RPC response is in result.data
  In PoS, every RPC response contains result: { data, metadata }. The actual result of the request is in result.data, while result.metadata contains information about the current chainstate (only for chainstate-related requests, otherwise this is null).

• Timestamps are now in milliseconds
  All timestamps (e.g. for blocks and transactions) are now specified in milliseconds since the Unix epoch.

2. Network ​

2.1 Network methods ​

3. Transactions ​

3.1 Plain transaction objects ​

• from & to are now the user-friendly addresses. The fields fromAddress & toAddress have been removed.

• data has been renamed to recipientData.

• timestamp is now in milliseconds.

• blockHash has been removed.

• transactionIndex has been removed.

• The following fields have been added:

  ts

  {
    fromType: number
    toType: number
    senderData: string
    validityStartHeight: number
    proof: string
    networkId: number
    executionResult: boolean
  }

3.2 Transaction methods ​

4. Mempool ​

Mempool methods are only available when the node has a mempool.

4.1 Mempool methods ​

5. Miner ​

All mining-related methods have been removed as they are no longer relevant.

6. Accounts ​

6.1 Plain account objects ​

• The id field has been removed.
• The type field is now one of these strings: "basic" | "vesting" | "htlc" | "staking".
• In vesting accounts, the owner field is now the address, the ownerAddress field has been removed.
• In HTLC accounts, the sender & recipient fields are now the addresses, the senderAddress & recipientAddress have been removed.
• In HTLC accounts, the hashRoot field is now an object containing a algorithm: 'blake2b' | 'sha256' | 'sha512' field (replacing the toplevel hashAlgorithm field) and a hash: string field.

6.2 Account methods ​

7. Blockchain ​

7.1. Plain block object ​

Blocks in PoS are one of two types: a micro block or a macro block. Both types can include transactions, although macro blocks only include validator reward transactions from the coinbase (with an empty proof). Additionally, micro blocks can be skip blocks which don't include transactions.

• accountsHash has been renamed to stateHash.
• timestamp is now in milliseconds.
• For changes to transactions plain objects, see 3.1 Plain transaction objects.
• difficulty has been removed.
• nonce has been removed.
• miner has been removed.
• minerAddress for micro blocks is now producer.validator. Macro blocks do not have producer.
• pow has been removed.
• The following fields have been added:
  ts

  // All blocks
  {
    type: 'micro' | 'macro'
    batch: number
    epoch: number
    network: string
    version: number
    seed: string
    historyHash: string
  }
  
  // Micro blocks
  {
    producer: MicroProducer
    equivocationProofs: Array<EquivocationProof>
    justification: MicroJustification
  }
  
  // Macro blocks
  {
    isElectionBlock: boolean
    parentElectionHash: string
    nextBatchInitialPunishedSet: Array<number>
    justification: MacroJustification
  }

7.2 Blockchain methods ​

8. Miscellaneous ​

8.1 Miscellaneous methods ​