Skip to content

REFERENCE.md

Latest commit

 

History

History
82 lines (50 loc) · 2.16 KB

REFERENCE.md

File metadata and controls

82 lines (50 loc) · 2.16 KB

Back to the main page

API Reference

Table of Contents

Layer 1 endpoints

generate

Note: regtest only

Generates blocks on demand for regression tests.

Params
name type description
args.amount number Amount of blocks to generate
Response
name type description
blockHashes promise (string array) Returns a promise containing strings of block hashes

getBestBlockHash

Returns best block hash (hash of the chaintip)

takes no arguments

Response
name type description
blockHash promise (string) hash of chaintip

getBlockHash

Returns block hash for a given height.

Params
name type description
args.height number block height
Response
name type description
blockHash promise (string) promise containing a string of a block hash

getMnListDiff

needs definition

Params
name type description
packet string ST Packet object serialized using CBOR
Response
name type description
packet string ST Packet object serialized using CBOR