Class Node

Readonly$host

getAccountByPubkey

• getAccountByPubkey(pubkey, options?): Promise<Account>

• Get an account by public key

  Parameters

  • pubkey: string

    The public key of the account
  • Optionaloptions: GetAccountByPubkeyOptionalParams

    The options parameters.

  Returns Promise<Account>

getAccountByPubkeyAndHash

• getAccountByPubkeyAndHash(pubkey, hash, options?): Promise<Account>

• Get an account by public key after the block indicated by hash. Can be either a micro block or a keyblock hash

  Parameters

  • pubkey: string

    The public key of the account
  • hash: string

    The hash of the block - either a keyblock or a microblock
  • Optionaloptions: GetAccountByPubkeyAndHashOptionalParams

    The options parameters.

  Returns Promise<Account>

getAccountByPubkeyAndHeight

• getAccountByPubkeyAndHeight(pubkey, height, options?): Promise<Account>

• Get an account by public key after the opening key block of the generation at height

  Parameters

  • pubkey: string

    The public key of the account
  • height: number

    The height
  • Optionaloptions: GetAccountByPubkeyAndHeightOptionalParams

    The options parameters.

  Returns Promise<Account>

getAccountNextNonce

• getAccountNextNonce(pubkey, options?): Promise<NextNonceResponse>

• Get an account's next nonce; This is computed according to whatever is the current account nonce and what transactions are currently present in the transaction pool

  Parameters

  • pubkey: string

    The public key of the account
  • Optionaloptions: GetAccountNextNonceOptionalParams

    The options parameters.

  Returns Promise<NextNonceResponse>

getAuctionEntryByName

• getAuctionEntryByName(name, options?): Promise<AuctionEntry>

• Get auction entry from naming system

  Parameters

  • name: string

    The name key of the name entry
  • Optionaloptions: GetAuctionEntryByNameOptionalParams

    The options parameters.

  Returns Promise<AuctionEntry>

getChainEnds

• getChainEnds(options?): Promise<GetChainEndsResponse>

• Get oldest keyblock hashes counting from genesis including orphans

  Parameters

  • Optionaloptions: GetChainEndsOptionalParams

    The options parameters.

  Returns Promise<GetChainEndsResponse>

getChannelByPubkey

• getChannelByPubkey(pubkey, options?): Promise<Channel>

• Get channel by public key

  Parameters

  • pubkey: string

    The pubkey of the channel
  • Optionaloptions: GetChannelByPubkeyOptionalParams

    The options parameters.

  Returns Promise<Channel>

getContract

• getContract(pubkey, options?): Promise<ContractObject>

• Get a contract by pubkey

  Parameters

  • pubkey: string

    Contract pubkey to get proof for
  • Optionaloptions: GetContractOptionalParams

    The options parameters.

  Returns Promise<ContractObject>

getContractCode

• getContractCode(pubkey, options?): Promise<ByteCode>

• Get contract code by pubkey

  Parameters

  • pubkey: string

    Contract pubkey to get proof for
  • Optionaloptions: GetContractCodeOptionalParams

    The options parameters.

  Returns Promise<ByteCode>

getContractPoI

• getContractPoI(pubkey, options?): Promise<PoI>

• Get a proof of inclusion for a contract

  Parameters

  • pubkey: string

    Contract pubkey to get proof for
  • Optionaloptions: GetContractPoIOptionalParams

    The options parameters.

  Returns Promise<PoI>

getCurrency

• getCurrency(options?): Promise<Currency>

• Get the currency metadata of a node

  Parameters

  • Optionaloptions: GetCurrencyOptionalParams

    The options parameters.

  Returns Promise<Currency>

getCurrentGeneration

• getCurrentGeneration(options?): Promise<Generation>

• Get the current generation

  Parameters

  • Optionaloptions: GetCurrentGenerationOptionalParams

    The options parameters.

  Returns Promise<Generation>

getCurrentKeyBlock

• getCurrentKeyBlock(options?): Promise<KeyBlock>

• Get the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getCurrentKeyBlockHash

• getCurrentKeyBlockHash(options?): Promise<HashResponse>

• Get the hash of the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockHashOptionalParams

    The options parameters.

  Returns Promise<HashResponse>

getCurrentKeyBlockHeight

• getCurrentKeyBlockHeight(options?): Promise<HeightResponse>

• Get the height of the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockHeightOptionalParams

    The options parameters.

  Returns Promise<HeightResponse>

getGenerationByHash

• getGenerationByHash(hash, options?): Promise<Generation>

• Get a generation by hash

  Parameters

  • hash: string

    The hash of the key block
  • Optionaloptions: GetGenerationByHashOptionalParams

    The options parameters.

  Returns Promise<Generation>

getGenerationByHeight

• getGenerationByHeight(height, options?): Promise<Generation>

• Get a generation by height

  Parameters

  • height: number

    The height
  • Optionaloptions: GetGenerationByHeightOptionalParams

    The options parameters.

  Returns Promise<Generation>

getKeyBlockByHash

• getKeyBlockByHash(hash, options?): Promise<KeyBlock>

• Get a key block by hash

  Parameters

  • hash: string

    The hash of the block - either a keyblock or a microblock
  • Optionaloptions: GetKeyBlockByHashOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getKeyBlockByHeight

• getKeyBlockByHeight(height, options?): Promise<KeyBlock>

• Get a key block by height

  Parameters

  • height: number

    The height
  • Optionaloptions: GetKeyBlockByHeightOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getMicroBlockHeaderByHash

• getMicroBlockHeaderByHash(hash, options?): Promise<MicroBlockHeader>

• Get a micro block header by hash

  Parameters

  • hash: string

    The hash of the block - either a keyblock or a microblock
  • Optionaloptions: GetMicroBlockHeaderByHashOptionalParams

    The options parameters.

  Returns Promise<MicroBlockHeader>

getMicroBlockTransactionByHashAndIndex

• getMicroBlockTransactionByHashAndIndex(hash, index, options?): Promise<SignedTx>

• Get a micro block transaction by hash and index

  Parameters

  • hash: string

    The hash of the micro block
  • index: number

    The index of the transaction in a block
  • Optionaloptions: GetMicroBlockTransactionByHashAndIndexOptionalParams

    The options parameters.

  Returns Promise<SignedTx>

getMicroBlockTransactionsByHash

• getMicroBlockTransactionsByHash(hash, options?): Promise<SignedTxs>

• Get micro block transactions by hash

  Parameters

  • hash: string

    The hash of the micro block
  • Optionaloptions: GetMicroBlockTransactionsByHashOptionalParams

    The options parameters.

  Returns Promise<SignedTxs>

getMicroBlockTransactionsCountByHash

• getMicroBlockTransactionsCountByHash(hash, options?): Promise<CountResponse>

• Get micro block transaction count by hash

  Parameters

  • hash: string

    The hash of the micro block
  • Optionaloptions: GetMicroBlockTransactionsCountByHashOptionalParams

    The options parameters.

  Returns Promise<CountResponse>

getNameEntryByName

• getNameEntryByName(name, options?): Promise<NameEntry>

• Get name entry from naming system

  Parameters

  • name: string

    The name key of the name entry
  • Optionaloptions: GetNameEntryByNameOptionalParams

    The options parameters.

  Returns Promise<NameEntry>

getNameEntryByNameHash

• getNameEntryByNameHash(nameHash, options?): Promise<NameEntry>

• Get name entry from naming system

  Parameters

  • nameHash: string

    The name hash of the name entry
  • Optionaloptions: GetNameEntryByNameHashOptionalParams

    The options parameters.

  Returns Promise<NameEntry>

getOracleByPubkey

• getOracleByPubkey(pubkey, options?): Promise<RegisteredOracle>

• Get an oracle by public key

  Parameters

  • pubkey: string

    The public key of the oracle
  • Optionaloptions: GetOracleByPubkeyOptionalParams

    The options parameters.

  Returns Promise<RegisteredOracle>

getOracleQueriesByPubkey

• getOracleQueriesByPubkey(pubkey, options?): Promise<OracleQueries>

• Get oracle queries by public key

  Parameters

  • pubkey: string

    The public key of the oracle
  • Optionaloptions: GetOracleQueriesByPubkeyOptionalParams

    The options parameters.

  Returns Promise<OracleQueries>

getOracleQueryByPubkeyAndQueryId

• getOracleQueryByPubkeyAndQueryId(pubkey, queryId, options?): Promise<OracleQuery>

• Get an oracle query by public key and query ID

  Parameters

  • pubkey: string

    The public key of the oracle
  • queryId: string

    The ID of the query
  • Optionaloptions: GetOracleQueryByPubkeyAndQueryIdOptionalParams

    The options parameters.

  Returns Promise<OracleQuery>

getPeerPubkey

• getPeerPubkey(options?): Promise<PeerPubKey>

• Get peer public key

  Parameters

  • Optionaloptions: GetPeerPubkeyOptionalParams

    The options parameters.

  Returns Promise<PeerPubKey>

getPendingAccountTransactionsByPubkey

• getPendingAccountTransactionsByPubkey(pubkey, options?): Promise<SignedTxs>

• Get pending account transactions by public key

  Parameters

  • pubkey: string

    The public key of the account
  • Optionaloptions: GetPendingAccountTransactionsByPubkeyOptionalParams

    The options parameters.

  Returns Promise<SignedTxs>

getPendingKeyBlock

• getPendingKeyBlock(options?): Promise<KeyBlock>

• Get the pending key block

  Parameters

  • Optionaloptions: GetPendingKeyBlockOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getRecentGasPrices

• getRecentGasPrices(options?): Promise<GetRecentGasPricesResponse>

• Get minimum gas prices in recent blocks

  Parameters

  • Optionaloptions: GetRecentGasPricesOptionalParams

    The options parameters.

  Returns Promise<GetRecentGasPricesResponse>

getSyncStatus

• getSyncStatus(options?): Promise<SyncStatus>

• Get the sync status of a node

  Parameters

  • Optionaloptions: GetSyncStatusOptionalParams

    The options parameters.

  Returns Promise<SyncStatus>

getTopHeader

• getTopHeader(options?): Promise<Header>

• Get the top header (either key or micro block)

  Parameters

  • Optionaloptions: GetTopHeaderOptionalParams

    The options parameters.

  Returns Promise<Header>

getTransactionByHash

• getTransactionByHash(hash, options?): Promise<SignedTx>

• Get a transaction by hash

  Parameters

  • hash: string

    The hash of the transaction
  • Optionaloptions: GetTransactionByHashOptionalParams

    The options parameters.

  Returns Promise<SignedTx>

getTransactionInfoByHash

• getTransactionInfoByHash(hash, options?): Promise<TxInfoObject>

• Parameters

  • hash: string

    The hash of the transaction
  • Optionaloptions: GetTransactionInfoByHashOptionalParams

    The options parameters.

  Returns Promise<TxInfoObject>

postTransaction

• postTransaction(body, options?): Promise<PostTxResponse>

• Post a new transaction

  Parameters

  • body: EncodedTx

    The new transaction
  • Optionaloptions: PostTransactionOptionalParams

    The options parameters.

  Returns Promise<PostTxResponse>

protectedDryRunTxs

• protectedDryRunTxs(body, options?): Promise<DryRunResults>

• Dry-run unsigned transactions on top of a given block. Supports all TXs except GAMetaTx, PayingForTx and OffchainTx. The maximum gas limit of all calls is capped. The maximum gas limit per request is a global node setting. Since DryRunCallReq object do not have a mandatory gas field, if not set a default value of 1000000 is being used instead.

  Parameters

  • body: DryRunInput

    transactions
  • Optionaloptions: ProtectedDryRunTxsOptionalParams

    The options parameters.

  Returns Promise<DryRunResults>