darkfid JSON-RPC API

• clock
• dnet_switch
• dnet.subscribe_events
• ping_miner

clock

Returns current system clock as u64 (String) timestamp.
^[src]

--> {"jsonrpc": "2.0", "method": "clock", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": "1234", "id": 1}

dnet_switch

Activate or deactivate dnet in the P2P stack. By sending true, dnet will be activated, and by sending false dnet will be deactivated. Returns true on success.
^[src]

--> {"jsonrpc": "2.0", "method": "dnet_switch", "params": [true], "id": 42}
<-- {"jsonrpc": "2.0", "result": true, "id": 42}

dnet.subscribe_events

Initializes a subscription to p2p dnet events. Once a subscription is established, darkfid will send JSON-RPC notifications of new network events to the subscriber.
^[src]

--> {"jsonrpc": "2.0", "method": "dnet.subscribe_events", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "method": "dnet.subscribe_events", "params": [`event`]}

ping_miner

Pings configured miner daemon for liveness. Returns true on success.
^[src]

--> {"jsonrpc": "2.0", "method": "ping_miner", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": "true", "id": 1}

blockchain methods

• blockchain.get_block
• blockchain.get_tx
• blockchain.last_confirmed_block
• blockchain.best_fork_next_block_height
• blockchain.block_target
• blockchain.subscribe_blocks
• blockchain.subscribe_txs
• blockchain.subscribe_proposals
• blockchain.lookup_zkas
• blockchain.get_contract_state
• blockchain.get_contract_state_key

blockchain.get_block

Queries the blockchain database for a block in the given height. Returns a readable block upon success.

Params:

• array[0]: u64 Block height (as string)

Returns:

• BlockInfo struct serialized into base64.
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.get_block", "params": ["0"], "id": 1}
<-- {"jsonrpc": "2.0", "result": {...}, "id": 1}

blockchain.get_tx

Queries the blockchain database for a given transaction. Returns a serialized Transaction object.

Params:

• array[0]: Hex-encoded transaction hash string

Returns:

• Serialized Transaction object encoded with base64
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.get_tx", "params": ["TxHash"], "id": 1}
<-- {"jsonrpc": "2.0", "result": "ABCD...", "id": 1}

blockchain.last_confirmed_block

Queries the blockchain database to find the last confirmed block.

Params:

• None

Returns:

• f64 : Height of the last confirmed block
• String: Header hash of the last confirmed block
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.last_confirmed_block", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": [1234, "HeaderHash"], "id": 1}

blockchain.best_fork_next_block_height

Queries the validator to find the current best fork next block height.

Params:

• None

Returns:

• f64: Current best fork next block height
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.best_fork_next_block_height", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": 1234, "id": 1}

blockchain.block_target

Queries the validator to get the currently configured block target time.

Params:

• None

Returns:

• f64: Current block target time
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.block_target", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": 1234, "id": 1}

blockchain.subscribe_blocks

Initializes a subscription to new incoming blocks. Once a subscription is established, darkfid will send JSON-RPC notifications of new incoming blocks to the subscriber.
^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.subscribe_blocks", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_blocks", "params": [`blockinfo`]}

blockchain.subscribe_txs

Initializes a subscription to new incoming transactions. Once a subscription is established, darkfid will send JSON-RPC notifications of new incoming transactions to the subscriber.
^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.subscribe_txs", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_txs", "params": [`tx_hash`]}

blockchain.subscribe_proposals

Initializes a subscription to new incoming proposals. Once a subscription is established, darkfid will send JSON-RPC notifications of new incoming proposals to the subscriber.
^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.subscribe_proposals", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_proposals", "params": [`blockinfo`]}

blockchain.lookup_zkas

Performs a lookup of zkas bincodes for a given contract ID and returns all of them, including their namespace.

Params:

• array[0]: base58-encoded contract ID string

Returns:

• array[n]: Pairs of: zkas_namespace string, serialized ZkBinary object
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.lookup_zkas", "params": ["BZHKGQ26bzmBithTQYTJtjo2QdCqpkR9tjSBopT4yf4o"], "id": 1}
<-- {"jsonrpc": "2.0", "result": [["Foo", "ABCD..."], ["Bar", "EFGH..."]], "id": 1}

blockchain.get_contract_state

Queries the blockchain database for a given contract state records. Returns the records value raw bytes as a BTreeMap.

Params:

• array[0]: base58-encoded contract ID string
• array[1]: Contract tree name string

Returns:

• Records serialized BTreeMap encoded with base64
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.get_contract_state", "params": ["BZHK...", "tree"], "id": 1}
<-- {"jsonrpc": "2.0", "result": "ABCD...", "id": 1}

blockchain.get_contract_state_key

Queries the blockchain database for a given contract state key raw bytes. Returns the record value raw bytes.

Params:

• array[0]: base58-encoded contract ID string
• array[1]: Contract tree name string
• array[2]: Key raw bytes, encoded with base64

Returns:

• Record value raw bytes encoded with base64
  ^[src]

--> {"jsonrpc": "2.0", "method": "blockchain.get_contract_state_key", "params": ["BZHK...", "tree", "ABCD..."], "id": 1}
<-- {"jsonrpc": "2.0", "result": "ABCD...", "id": 1}

tx methods

• tx.simulate
• tx.broadcast
• tx.pending
• tx.clean_pending
• tx.calculate_fee

tx.simulate

Simulate a network state transition with the given transaction. Returns true if the transaction is valid, otherwise, a corresponding error.
^[src]

--> {"jsonrpc": "2.0", "method": "tx.simulate", "params": ["base64encodedTX"], "id": 1}
<-- {"jsonrpc": "2.0", "result": true, "id": 1}

tx.broadcast

Broadcast a given transaction to the P2P network. The function will first simulate the state transition in order to see if the transaction is actually valid, and in turn it will return an error if this is the case. Otherwise, a transaction ID will be returned.
^[src]

--> {"jsonrpc": "2.0", "method": "tx.broadcast", "params": ["base64encodedTX"], "id": 1}
<-- {"jsonrpc": "2.0", "result": "txID...", "id": 1}

tx.pending

Queries the node pending transactions store to retrieve all transactions. Returns a vector of hex-encoded transaction hashes.
^[src]

--> {"jsonrpc": "2.0", "method": "tx.pending", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": "[TxHash,...]", "id": 1}

tx.clean_pending

Queries the node pending transactions store to remove all transactions. Returns a vector of hex-encoded transaction hashes.
^[src]

--> {"jsonrpc": "2.0", "method": "tx.clean_pending", "params": [], "id": 1}
<-- {"jsonrpc": "2.0", "result": "[TxHash,...]", "id": 1}

tx.calculate_fee

Compute provided transaction's total gas, against current best fork. Returns the gas value if the transaction is valid, otherwise, a corresponding error.
^[src]

--> {"jsonrpc": "2.0", "method": "tx.calculate_fee", "params": ["base64encodedTX", "include_fee"], "id": 1}
<-- {"jsonrpc": "2.0", "result": true, "id": 1}