Class Node

Hierarchy (View Summary)

Node
- Node

Index

Constructors

Properties

Methods

_getCachedStatus _isHyperchain getAccountByPubkey getAccountByPubkeyAndHash getAccountByPubkeyAndHeight getAccountNextNonce getAuctionEntryByName getChainEnds getChannelByPubkey getContract getContractCode getContractPoI getCurrency getCurrentGeneration getCurrentKeyBlock getCurrentKeyBlockHash getCurrentKeyBlockHeight getGenerationByHash getGenerationByHeight getHyperchainContractPubkeys getKeyBlockByHash getKeyBlockByHeight getMicroBlockHeaderByHash getMicroBlockTransactionByHashAndIndex getMicroBlockTransactionsByHash getMicroBlockTransactionsCountByHash getNameEntryByName getNameEntryByNameHash getNetworkId getNodeInfo getOracleByPubkey getOracleQueriesByPubkey getOracleQueryByPubkeyAndQueryId getPeerPubkey getPendingAccountTransactionsByPubkey getPendingKeyBlock getPinningTx getRecentGasPrices getStatus getSyncStatus getTopHeader getTransactionByHash getTransactionInfoByHash postTransaction protectedDryRunTxs

Constructors

constructor

new Node(
    url: string,
    options?: NodeOptionalParams & {
        ignoreVersion?: boolean;
        retryCount?: number;
        retryOverallDelay?: number;
    },
): Node
Parameters
- url: string
  Url for node API
- options: NodeOptionalParams & {
      ignoreVersion?: boolean;
      retryCount?: number;
      retryOverallDelay?: number;
  } = {}
  Options
  - OptionalignoreVersion?: boolean
    Print warning instead of throwing exception if node or consensus protocol version is not supported, use with caution
  - OptionalretryCount?: number
    Amount of extra requests to do in case of failure
  - OptionalretryOverallDelay?: number
    Time in ms to wait between all retries
Returns Node
Overrides Node.constructor
- Defined in Node.ts:37

Properties

`Readonly`$host

$host: string

Methods

_getCachedStatus

_getCachedStatus(options?: OperationOptions): Promise<Status>
Parameters
- Optionaloptions: OperationOptions
Returns Promise<Status>
- Defined in Node.ts:76

_isHyperchain

_isHyperchain(): Promise<boolean>
Returns Promise<boolean>
- Defined in Node.ts:96

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>
Inherited from Node.getAccountByPubkey
- Defined in apis/node/node.ts:138

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>
Inherited from Node.getAccountByPubkeyAndHash
- Defined in apis/node/node.ts:155

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>
Inherited from Node.getAccountByPubkeyAndHeight
- Defined in apis/node/node.ts:172

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>
Inherited from Node.getAccountNextNonce
- Defined in apis/node/node.ts:189

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>
Inherited from Node.getAuctionEntryByName
- Defined in apis/node/node.ts:219

getChainEnds

getChainEnds(
options?: GetChainEndsOptionalParams,
): Promise<GetChainEndsResponse>
Get oldest keyblock hashes counting from genesis including orphans
Parameters
- Optionaloptions: GetChainEndsOptionalParams
  The options parameters.
Returns Promise<GetChainEndsResponse>
Inherited from Node.getChainEnds
- Defined in apis/node/node.ts:651

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>
Inherited from Node.getChannelByPubkey
- Defined in apis/node/node.ts:234

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>
Inherited from Node.getContract
- Defined in apis/node/node.ts:249

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>
Inherited from Node.getContractCode
- Defined in apis/node/node.ts:264

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>
Inherited from Node.getContractPoI
- Defined in apis/node/node.ts:279

getCurrency

getCurrency(options?: GetCurrencyOptionalParams): Promise<Currency>
Get the currency metadata of a node
Parameters
- Optionaloptions: GetCurrencyOptionalParams
  The options parameters.
Returns Promise<Currency>
Inherited from Node.getCurrency
- Defined in apis/node/node.ts:293

getCurrentGeneration

getCurrentGeneration(
options?: GetCurrentGenerationOptionalParams,
): Promise<Generation>
Get the current generation
Parameters
- Optionaloptions: GetCurrentGenerationOptionalParams
  The options parameters.
Returns Promise<Generation>
Inherited from Node.getCurrentGeneration
- Defined in apis/node/node.ts:321

getCurrentKeyBlock

getCurrentKeyBlock(
options?: GetCurrentKeyBlockOptionalParams,
): Promise<KeyBlock>
Get the current key block
Parameters
- Optionaloptions: GetCurrentKeyBlockOptionalParams
  The options parameters.
Returns Promise<KeyBlock>
Inherited from Node.getCurrentKeyBlock
- Defined in apis/node/node.ts:399

getCurrentKeyBlockHash

getCurrentKeyBlockHash(
options?: GetCurrentKeyBlockHashOptionalParams,
): Promise<HashResponse>
Get the hash of the current key block
Parameters
- Optionaloptions: GetCurrentKeyBlockHashOptionalParams
  The options parameters.
Returns Promise<HashResponse>
Inherited from Node.getCurrentKeyBlockHash
- Defined in apis/node/node.ts:412

getCurrentKeyBlockHeight

getCurrentKeyBlockHeight(
options?: GetCurrentKeyBlockHeightOptionalParams,
): Promise<HeightResponse>
Get the height of the current key block
Parameters
- Optionaloptions: GetCurrentKeyBlockHeightOptionalParams
  The options parameters.
Returns Promise<HeightResponse>
Inherited from Node.getCurrentKeyBlockHeight
- Defined in apis/node/node.ts:425

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>
Inherited from Node.getGenerationByHash
- Defined in apis/node/node.ts:335

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>
Inherited from Node.getGenerationByHeight
- Defined in apis/node/node.ts:350

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>
Inherited from Node.getHyperchainContractPubkeys
- Defined in apis/node/node.ts:386

getKeyBlockByHash

getKeyBlockByHash(
hash: string,
options?: GetKeyBlockByHashOptionalParams,
): 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>
Inherited from Node.getKeyBlockByHash
- Defined in apis/node/node.ts:439

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>
Inherited from Node.getKeyBlockByHeight
- Defined in apis/node/node.ts:454

getMicroBlockHeaderByHash

getMicroBlockHeaderByHash(
hash: string,
options?: GetMicroBlockHeaderByHashOptionalParams,
): 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>
Inherited from Node.getMicroBlockHeaderByHash
- Defined in apis/node/node.ts:482

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>
Inherited from Node.getMicroBlockTransactionByHashAndIndex
- Defined in apis/node/node.ts:528

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>
Inherited from Node.getMicroBlockTransactionsByHash
- Defined in apis/node/node.ts:497

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>
Inherited from Node.getMicroBlockTransactionsCountByHash
- Defined in apis/node/node.ts:512

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>
Inherited from Node.getNameEntryByName
- Defined in apis/node/node.ts:544

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>
Inherited from Node.getNameEntryByNameHash
- Defined in apis/node/node.ts:559

getNetworkId

getNetworkId(): Promise<string>
Returns network ID provided by node. This method won't do extra requests on subsequent calls.

Returns Promise<string>
- Defined in Node.ts:114

getNodeInfo

getNodeInfo(): Promise<NodeInfo>
Returns Promise<NodeInfo>
- Defined in Node.ts:118

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>
Inherited from Node.getOracleByPubkey
- Defined in apis/node/node.ts:574

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>
Inherited from Node.getOracleQueriesByPubkey
- Defined in apis/node/node.ts:589

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>
Inherited from Node.getOracleQueryByPubkeyAndQueryId
- Defined in apis/node/node.ts:605

getPeerPubkey

getPeerPubkey(options?: GetPeerPubkeyOptionalParams): Promise<PeerPubKey>
Get peer public key
Parameters
- Optionaloptions: GetPeerPubkeyOptionalParams
  The options parameters.
Returns Promise<PeerPubKey>
Inherited from Node.getPeerPubkey
- Defined in apis/node/node.ts:620

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>
Inherited from Node.getPendingAccountTransactionsByPubkey
- Defined in apis/node/node.ts:204

getPendingKeyBlock

getPendingKeyBlock(
options?: GetPendingKeyBlockOptionalParams,
): Promise<KeyBlock>
Get the pending key block
Parameters
- Optionaloptions: GetPendingKeyBlockOptionalParams
  The options parameters.
Returns Promise<KeyBlock>
Inherited from Node.getPendingKeyBlock
- Defined in apis/node/node.ts:468

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>
Inherited from Node.getPinningTx
- Defined in apis/node/node.ts:376

getRecentGasPrices

getRecentGasPrices(
options?: GetRecentGasPricesOptionalParams,
): Promise<GetRecentGasPricesResponse>
Get minimum gas prices in recent blocks
Parameters
- Optionaloptions: GetRecentGasPricesOptionalParams
  The options parameters.
Returns Promise<GetRecentGasPricesResponse>
Inherited from Node.getRecentGasPrices
- Defined in apis/node/node.ts:630

getStatus

getStatus(...args: [options?: GetStatusOptionalParams]): Promise<Status>
Get the status of a node
Parameters
- ...args: [options?: GetStatusOptionalParams]
Returns Promise<Status>
Overrides Node.getStatus
- Defined in Node.ts:81

getSyncStatus

getSyncStatus(options?: GetSyncStatusOptionalParams): Promise<SyncStatus>
Get the sync status of a node
Parameters
- Optionaloptions: GetSyncStatusOptionalParams
  The options parameters.
Returns Promise<SyncStatus>
Inherited from Node.getSyncStatus
- Defined in apis/node/node.ts:661

getTopHeader

getTopHeader(options?: GetTopHeaderOptionalParams): Promise<Header>
Get the top header (either key or micro block)
Parameters
- Optionaloptions: GetTopHeaderOptionalParams
  The options parameters.
Returns Promise<Header>
Inherited from Node.getTopHeader
- Defined in apis/node/node.ts:364

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>
Inherited from Node.getTransactionByHash
- Defined in apis/node/node.ts:687

getTransactionInfoByHash

getTransactionInfoByHash(
hash: string,
options?: GetTransactionInfoByHashOptionalParams,
): Promise<TxInfoObject>
Parameters
- hash: string
  The hash of the transaction
- Optionaloptions: GetTransactionInfoByHashOptionalParams
  The options parameters.
Returns Promise<TxInfoObject>
Inherited from Node.getTransactionInfoByHash
- Defined in apis/node/node.ts:701

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>
Inherited from Node.postTransaction
- Defined in apis/node/node.ts:672

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. 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>
Inherited from Node.protectedDryRunTxs
- Defined in apis/node/node.ts:307

Class Node

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalignoreVersion?: boolean

OptionalretryCount?: number

OptionalretryOverallDelay?: number

Returns Node

Properties

Readonly$host

Methods

_getCachedStatus

Parameters

Returns Promise<Status>

_isHyperchain

Returns Promise<boolean>

getAccountByPubkey

Parameters

Returns Promise<Account>

getAccountByPubkeyAndHash

Parameters

Returns Promise<Account>

getAccountByPubkeyAndHeight

Parameters

Returns Promise<Account>

getAccountNextNonce

Parameters

Returns Promise<NextNonceResponse>

getAuctionEntryByName

Parameters

Returns Promise<AuctionEntry>

getChainEnds

Parameters

Returns Promise<GetChainEndsResponse>

getChannelByPubkey

Parameters

Returns Promise<Channel>

getContract

Parameters

Returns Promise<ContractObject>

getContractCode

Parameters

Returns Promise<ByteCode>

getContractPoI

Parameters

Returns Promise<PoI>

getCurrency

Parameters

Returns Promise<Currency>

getCurrentGeneration

Parameters

Returns Promise<Generation>

getCurrentKeyBlock

Parameters

Returns Promise<KeyBlock>

getCurrentKeyBlockHash

Parameters

Returns Promise<HashResponse>

getCurrentKeyBlockHeight

Parameters

Returns Promise<HeightResponse>

getGenerationByHash

Parameters

Returns Promise<Generation>

getGenerationByHeight

Parameters

Returns Promise<Generation>

getHyperchainContractPubkeys

Parameters

Returns Promise<HCContractPubkeys>

getKeyBlockByHash

Parameters

Returns Promise<KeyBlock>

getKeyBlockByHeight

Parameters

`Optional`ignoreVersion?: boolean

`Optional`retryCount?: number

`Optional`retryOverallDelay?: number

`Readonly`$host