Class Node

constructor

• new Node($host: string, options?: NodeOptionalParams): Node

  Initializes a new instance of the Node class.

  Parameters

  • $host: string

    server parameter
  • Optionaloptions: NodeOptionalParams

    The parameter options

  Returns Node

Readonly$host

getAccountByPubkey

• getAccountByPubkey(
      pubkey: string,
      options?: GetAccountByPubkeyOptionalParams,
  ): 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: string,
      hash: string,
      options?: GetAccountByPubkeyAndHashOptionalParams,
  ): 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: string,
      height: number,
      options?: GetAccountByPubkeyAndHeightOptionalParams,
  ): 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: string,
      options?: GetAccountNextNonceOptionalParams,
  ): 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: string,
      options?: GetAuctionEntryByNameOptionalParams,
  ): 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?: GetChainEndsOptionalParams,
  ): Promise<GetChainEndsResponse>

  Get oldest keyblock hashes counting from genesis including orphans

  Parameters

  • Optionaloptions: GetChainEndsOptionalParams

    The options parameters.

  Returns Promise<GetChainEndsResponse>

getChannelByPubkey

• getChannelByPubkey(
      pubkey: string,
      options?: GetChannelByPubkeyOptionalParams,
  ): 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: string,
      options?: GetContractOptionalParams,
  ): 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: string,
      options?: GetContractCodeOptionalParams,
  ): 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: string,
      options?: GetContractPoIOptionalParams,
  ): 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?: GetCurrencyOptionalParams): Promise<Currency>

  Get the currency metadata of a node

  Parameters

  • Optionaloptions: GetCurrencyOptionalParams

    The options parameters.

  Returns Promise<Currency>

getCurrentGeneration

• getCurrentGeneration(
      options?: GetCurrentGenerationOptionalParams,
  ): Promise<Generation>

  Get the current generation

  Parameters

  • Optionaloptions: GetCurrentGenerationOptionalParams

    The options parameters.

  Returns Promise<Generation>

getCurrentKeyBlock

• getCurrentKeyBlock(
      options?: GetCurrentKeyBlockOptionalParams,
  ): Promise<KeyBlock>

  Get the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getCurrentKeyBlockHash

• getCurrentKeyBlockHash(
      options?: GetCurrentKeyBlockHashOptionalParams,
  ): Promise<HashResponse>

  Get the hash of the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockHashOptionalParams

    The options parameters.

  Returns Promise<HashResponse>

getCurrentKeyBlockHeight

• getCurrentKeyBlockHeight(
      options?: GetCurrentKeyBlockHeightOptionalParams,
  ): Promise<HeightResponse>

  Get the height of the current key block

  Parameters

  • Optionaloptions: GetCurrentKeyBlockHeightOptionalParams

    The options parameters.

  Returns Promise<HeightResponse>

getGenerationByHash

• getGenerationByHash(
      hash: string,
      options?: GetGenerationByHashOptionalParams,
  ): 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: number,
      options?: GetGenerationByHeightOptionalParams,
  ): Promise<Generation>

  Get a generation by height

  Parameters

  • height: number

    The height
  • Optionaloptions: GetGenerationByHeightOptionalParams

    The options parameters.

  Returns Promise<Generation>

getHyperchainContractPubkeys

• getHyperchainContractPubkeys(
      options?: GetHyperchainContractPubkeysOptionalParams,
  ): Promise<HCContractPubkeys>

  Get the pubkeys for the configured hyperchain contracts for staking, election and rewards

  Parameters

  • Optionaloptions: GetHyperchainContractPubkeysOptionalParams

    The options parameters.

  Returns Promise<HCContractPubkeys>

getKeyBlockByHash

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

  Get a key block by hash

  Parameters

  • hash: string

    The hash of the key block
  • Optionaloptions: GetKeyBlockByHashOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getKeyBlockByHeight

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

  Get a key block by height

  Parameters

  • height: number

    The height
  • Optionaloptions: GetKeyBlockByHeightOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getMicroBlockHeaderByHash

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

  Get a micro block header by hash

  Parameters

  • hash: string

    The hash of the micro block
  • Optionaloptions: GetMicroBlockHeaderByHashOptionalParams

    The options parameters.

  Returns Promise<MicroBlockHeader>

getMicroBlockTransactionByHashAndIndex

• getMicroBlockTransactionByHashAndIndex(
      hash: string,
      index: number,
      options?: GetMicroBlockTransactionByHashAndIndexOptionalParams,
  ): 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: string,
      options?: GetMicroBlockTransactionsByHashOptionalParams,
  ): 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: string,
      options?: GetMicroBlockTransactionsCountByHashOptionalParams,
  ): 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: string,
      options?: GetNameEntryByNameOptionalParams,
  ): 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: string,
      options?: GetNameEntryByNameHashOptionalParams,
  ): 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>

getNodeSettings

• getNodeSettings(options?: GetNodeSettingsOptionalParams): Promise<NodeSettings>

  Get this node's local policy settings. These are not consensus rules: they are operator configuration, they may differ between nodes, and an operator can change them at runtime. min_miner_gas_price is a decimal string; the other values are JSON numbers, or strings when int-as-string=true.

  Parameters

  • Optionaloptions: GetNodeSettingsOptionalParams

    The options parameters.

  Returns Promise<NodeSettings>

getOracleByPubkey

• getOracleByPubkey(
      pubkey: string,
      options?: GetOracleByPubkeyOptionalParams,
  ): 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: string,
      options?: GetOracleQueriesByPubkeyOptionalParams,
  ): 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: string,
      queryId: string,
      options?: GetOracleQueryByPubkeyAndQueryIdOptionalParams,
  ): 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?: GetPeerPubkeyOptionalParams): Promise<PeerPubKey>

  Get peer public key

  Parameters

  • Optionaloptions: GetPeerPubkeyOptionalParams

    The options parameters.

  Returns Promise<PeerPubKey>

getPendingAccountTransactionsByPubkey

• getPendingAccountTransactionsByPubkey(
      pubkey: string,
      options?: GetPendingAccountTransactionsByPubkeyOptionalParams,
  ): 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?: GetPendingKeyBlockOptionalParams,
  ): Promise<KeyBlock>

  Get the pending key block

  Parameters

  • Optionaloptions: GetPendingKeyBlockOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getPinningTx

• getPinningTx(options?: GetPinningTxOptionalParams): Promise<PinningTx>

  Get the pinning transaction for the current epoch. Returns both the individual parameters as well as the parent chain type (aeternity, btc etc.), network id and a packaged 80 byte readymade payload for that chain type.

  Parameters

  • Optionaloptions: GetPinningTxOptionalParams

    The options parameters.

  Returns Promise<PinningTx>

getProtocolParameters

• getProtocolParameters(
      options?: GetProtocolParametersOptionalParams,
  ): Promise<ProtocolParameters>

  Get the consensus protocol parameters needed to build valid transactions. Covers the protocol effective at the current top block and any later protocol whose fork height has not been reached yet; a community fork under signalling is reported only once it has activated, since until then it may still fail to. See /node-settings for this node's local policy. Aettos amounts (minimum_gas_price, name_claim_fees, name_claim_locked_fee) are always decimal strings, never JSON numbers: the largest name fee is about 2^69 and would lose precision in an IEEE-754 client. Gas, key block heights, counts and version numbers are JSON numbers; pass int-as-string=true to receive those as strings too.

  Parameters

  • Optionaloptions: GetProtocolParametersOptionalParams

    The options parameters.

  Returns Promise<ProtocolParameters>

getRecentGasPrices

• getRecentGasPrices(
      options?: GetRecentGasPricesOptionalParams,
  ): Promise<GetRecentGasPricesResponse>

  Get minimum gas prices in recent blocks

  Parameters

  • Optionaloptions: GetRecentGasPricesOptionalParams

    The options parameters.

  Returns Promise<GetRecentGasPricesResponse>

getStatus

• getStatus(options?: GetStatusOptionalParams): Promise<Status>

  Get the status of a node

  Parameters

  • Optionaloptions: GetStatusOptionalParams

    The options parameters.

  Returns Promise<Status>

getSyncStatus

• getSyncStatus(options?: GetSyncStatusOptionalParams): Promise<SyncStatus>

  Get the sync status of a node

  Parameters

  • Optionaloptions: GetSyncStatusOptionalParams

    The options parameters.

  Returns Promise<SyncStatus>

getTopHeader

• getTopHeader(options?: GetTopHeaderOptionalParams): Promise<Header>

  Get the top header (either key or micro block)

  Parameters

  • Optionaloptions: GetTopHeaderOptionalParams

    The options parameters.

  Returns Promise<Header>

getTransactionByHash

• getTransactionByHash(
      hash: string,
      options?: GetTransactionByHashOptionalParams,
  ): 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: string,
      options?: GetTransactionInfoByHashOptionalParams,
  ): Promise<TxInfoObject>

  Parameters

  • hash: string

    The hash of the transaction
  • Optionaloptions: GetTransactionInfoByHashOptionalParams

    The options parameters.

  Returns Promise<TxInfoObject>

postTransaction

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

  Post a new transaction

  Parameters

  • body: EncodedTx

    The new transaction
  • Optionaloptions: PostTransactionOptionalParams

    The options parameters.

  Returns Promise<PostTxResponse>

protectedDryRunTxs

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

  Dry-run unsigned transactions on top of a given block. Supports all TXs except GAMetaTx, PayingForTx and OffchainTx. Gas defaults to 1000000 when not set on a call request; total gas per request is capped by a node-configured limit. FATE contract-storage reads are metered at a size-proportional gas cost, so reported gas is an estimate of the on-chain cost, not an exact figure. Reported gas is never below what the same call costs on chain at the currently activated protocol, because each repriced storage register read is floored at that charge.

  Parameters

  • body: DryRunInput

    transactions
  • Optionaloptions: ProtectedDryRunTxsOptionalParams

    The options parameters.

  Returns Promise<DryRunResults>