AlgodApi
Defined in: packages/algod_client/src/apis/api-service.ts:70
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AlgodApi(
httpRequest):AlgodApi
Defined in: packages/algod_client/src/apis/api-service.ts:71
Parameters
Section titled “Parameters”httpRequest
Section titled “httpRequest”Returns
Section titled “Returns”AlgodApi
Properties
Section titled “Properties”httpRequest
Section titled “httpRequest”
readonlyhttpRequest:BaseHttpRequest
Defined in: packages/algod_client/src/apis/api-service.ts:71
Methods
Section titled “Methods”accountApplicationInformation()
Section titled “accountApplicationInformation()”accountApplicationInformation(
address,applicationId):Promise<AccountApplicationResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:80
Given a specific account public key and application ID, this call returns the account’s application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application’s creator.
Parameters
Section titled “Parameters”address
Section titled “address”applicationId
Section titled “applicationId”number | bigint
Returns
Section titled “Returns”Promise<AccountApplicationResponse>
accountAssetInformation()
Section titled “accountAssetInformation()”accountAssetInformation(
address,assetId):Promise<AccountAssetResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:100
Given a specific account public key and asset ID, this call returns the account’s asset holding and asset parameters (if either exist). Asset parameters will only be returned if the provided address is the asset’s creator.
Parameters
Section titled “Parameters”address
Section titled “address”assetId
Section titled “assetId”number | bigint
Returns
Section titled “Returns”Promise<AccountAssetResponse>
accountInformation()
Section titled “accountInformation()”accountInformation(
address,params?):Promise<Account>
Defined in: packages/algod_client/src/apis/api-service.ts:120
Given a specific account public key, this call returns the account’s status, balance and spendable amounts
Parameters
Section titled “Parameters”address
Section titled “address”params?
Section titled “params?”exclude?
Section titled “exclude?”"all" | "none"
Returns
Section titled “Returns”Promise<Account>
applicationBoxByName()
Section titled “applicationBoxByName()”applicationBoxByName(
applicationId,boxName):Promise<Box>
Defined in: packages/algod_client/src/apis/api-service.ts:789
Given an application ID and box name, it returns the round, box name, and value.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
boxName
Section titled “boxName”Uint8Array
Returns
Section titled “Returns”Promise<Box>
applicationBoxes()
Section titled “applicationBoxes()”applicationBoxes(
applicationId,params?):Promise<BoxesResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:160
Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
params?
Section titled “params?”number
Returns
Section titled “Returns”Promise<BoxesResponse>
applicationById()
Section titled “applicationById()”applicationById(
applicationId):Promise<Application>
Defined in: packages/algod_client/src/apis/api-service.ts:180
Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
Returns
Section titled “Returns”Promise<Application>
assetById()
Section titled “assetById()”assetById(
assetId):Promise<Asset>
Defined in: packages/algod_client/src/apis/api-service.ts:200
Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
Parameters
Section titled “Parameters”assetId
Section titled “assetId”number | bigint
Returns
Section titled “Returns”Promise<Asset>
block()
Section titled “block()”block(
round,params?):Promise<BlockResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:217
Parameters
Section titled “Parameters”number | bigint
params?
Section titled “params?”headerOnly?
Section titled “headerOnly?”boolean
Returns
Section titled “Returns”Promise<BlockResponse>
blockHash()
Section titled “blockHash()”blockHash(
round):Promise<BlockHashResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:234
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<BlockHashResponse>
blockTimeStampOffset()
Section titled “blockTimeStampOffset()”blockTimeStampOffset():
Promise<GetBlockTimeStampOffsetResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:254
Gets the current timestamp offset.
Returns
Section titled “Returns”Promise<GetBlockTimeStampOffsetResponse>
blockTxIds()
Section titled “blockTxIds()”blockTxIds(
round):Promise<BlockTxidsResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:271
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<BlockTxidsResponse>
genesis()
Section titled “genesis()”genesis():
Promise<Genesis>
Defined in: packages/algod_client/src/apis/api-service.ts:291
Returns the entire genesis file in json.
Returns
Section titled “Returns”Promise<Genesis>
healthCheck()
Section titled “healthCheck()”healthCheck():
Promise<void>
Defined in: packages/algod_client/src/apis/api-service.ts:308
Returns
Section titled “Returns”Promise<void>
ledgerStateDelta()
Section titled “ledgerStateDelta()”ledgerStateDelta(
round):Promise<LedgerStateDelta>
Defined in: packages/algod_client/src/apis/api-service.ts:326
Get ledger deltas for a round.
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<LedgerStateDelta>
ledgerStateDeltaForTransactionGroup()
Section titled “ledgerStateDeltaForTransactionGroup()”ledgerStateDeltaForTransactionGroup(
id):Promise<LedgerStateDelta>
Defined in: packages/algod_client/src/apis/api-service.ts:346
Get a ledger delta for a given transaction group.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<LedgerStateDelta>
lightBlockHeaderProof()
Section titled “lightBlockHeaderProof()”lightBlockHeaderProof(
round):Promise<LightBlockHeaderProof>
Defined in: packages/algod_client/src/apis/api-service.ts:363
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<LightBlockHeaderProof>
pendingTransactionInformation()
Section titled “pendingTransactionInformation()”pendingTransactionInformation(
txId):Promise<PendingTransactionResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:387
Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:
- transaction committed (committed round > 0)
- transaction still in the pool (committed round = 0, pool error = "")
- transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<PendingTransactionResponse>
pendingTransactions()
Section titled “pendingTransactions()”pendingTransactions(
params?):Promise<PendingTransactionsResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:407
Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
Parameters
Section titled “Parameters”params?
Section titled “params?”number
Returns
Section titled “Returns”Promise<PendingTransactionsResponse>
pendingTransactionsByAddress()
Section titled “pendingTransactionsByAddress()”pendingTransactionsByAddress(
address,params?):Promise<PendingTransactionsResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:427
Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
Parameters
Section titled “Parameters”address
Section titled “address”params?
Section titled “params?”number
Returns
Section titled “Returns”Promise<PendingTransactionsResponse>
ready()
Section titled “ready()”ready():
Promise<void>
Defined in: packages/algod_client/src/apis/api-service.ts:465
Returns
Section titled “Returns”Promise<void>
sendRawTransaction()
Section titled “sendRawTransaction()”sendRawTransaction(
stxOrStxs):Promise<PostTransactionsResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:773
Send a signed transaction or array of signed transactions to the network.
Parameters
Section titled “Parameters”stxOrStxs
Section titled “stxOrStxs”Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]
Returns
Section titled “Returns”Promise<PostTransactionsResponse>
setBlockTimeStampOffset()
Section titled “setBlockTimeStampOffset()”setBlockTimeStampOffset(
offset):Promise<void>
Defined in: packages/algod_client/src/apis/api-service.ts:483
Sets the timestamp offset (seconds) for blocks in dev mode. Providing an offset of 0 will unset this value and try to use the real clock for the timestamp.
Parameters
Section titled “Parameters”offset
Section titled “offset”number
Returns
Section titled “Returns”Promise<void>
setSyncRound()
Section titled “setSyncRound()”setSyncRound(
round):Promise<void>
Defined in: packages/algod_client/src/apis/api-service.ts:501
Sets the minimum sync round on the ledger.
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<void>
simulateRawTransactions()
Section titled “simulateRawTransactions()”simulateRawTransactions(
stxOrStxs):Promise<SimulateResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:822
Simulate an encoded signed transaction or array of encoded signed transactions.
Parameters
Section titled “Parameters”stxOrStxs
Section titled “stxOrStxs”Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]
Returns
Section titled “Returns”Promise<SimulateResponse>
simulateTransactions()
Section titled “simulateTransactions()”simulateTransactions(
body):Promise<SimulateResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:516
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SimulateResponse>
stateProof()
Section titled “stateProof()”stateProof(
round):Promise<StateProof>
Defined in: packages/algod_client/src/apis/api-service.ts:538
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<StateProof>
status()
Section titled “status()”status():
Promise<NodeStatusResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:555
Returns
Section titled “Returns”Promise<NodeStatusResponse>
statusAfterBlock()
Section titled “statusAfterBlock()”statusAfterBlock(
round):Promise<NodeStatusResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:575
Waits for a block to appear after round {round} and returns the node’s status at the time. There is a 1 minute timeout, when reached the current status is returned regardless of whether or not it is the round after the given round.
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<NodeStatusResponse>
suggestedParams()
Section titled “suggestedParams()”suggestedParams():
Promise<{consensusVersion:string;fee:bigint;firstValid:bigint;flatFee:boolean;genesisHash:Uint8Array;genesisId:string;lastValid:bigint;minFee:bigint; }>
Defined in: packages/algod_client/src/apis/api-service.ts:797
Returns the common needed parameters for a new transaction.
Returns
Section titled “Returns”Promise<{ consensusVersion: string; fee: bigint; firstValid: bigint; flatFee: boolean; genesisHash: Uint8Array; genesisId: string; lastValid: bigint; minFee: bigint; }>
supply()
Section titled “supply()”supply():
Promise<SupplyResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:592
Returns
Section titled “Returns”Promise<SupplyResponse>
syncRound()
Section titled “syncRound()”syncRound():
Promise<GetSyncRoundResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:612
Gets the minimum sync round for the ledger.
Returns
Section titled “Returns”Promise<GetSyncRoundResponse>
tealCompile()
Section titled “tealCompile()”tealCompile(
body,params?):Promise<CompileResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:632
Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style). This endpoint is only enabled when a node’s configuration file sets EnableDeveloperAPI to true.
Parameters
Section titled “Parameters”string
params?
Section titled “params?”sourcemap?
Section titled “sourcemap?”boolean
Returns
Section titled “Returns”Promise<CompileResponse>
tealDisassemble()
Section titled “tealDisassemble()”tealDisassemble(
body):Promise<DisassembleResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:657
Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node’s configuration file sets EnableDeveloperAPI to true.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”Promise<DisassembleResponse>
transactionGroupLedgerStateDeltasForRound()
Section titled “transactionGroupLedgerStateDeltasForRound()”transactionGroupLedgerStateDeltasForRound(
round):Promise<TransactionGroupLedgerStateDeltasForRoundResponse>
Defined in: packages/algod_client/src/apis/api-service.ts:681
Get ledger deltas for transaction groups in a given round.
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Promise<TransactionGroupLedgerStateDeltasForRoundResponse>
transactionParams()
Section titled “transactionParams()”transactionParams():
Promise<{consensusVersion:string;fee:bigint;firstValid:bigint;flatFee:boolean;genesisHash:Uint8Array;genesisId:string;lastValid:bigint;minFee:bigint; }>
Defined in: packages/algod_client/src/apis/api-service.ts:815
Returns the common needed parameters for a new transaction.
Returns
Section titled “Returns”Promise<{ consensusVersion: string; fee: bigint; firstValid: bigint; flatFee: boolean; genesisHash: Uint8Array; genesisId: string; lastValid: bigint; minFee: bigint; }>
transactionProof()
Section titled “transactionProof()”transactionProof(
round,txId,params?):Promise<TransactionProof>
Defined in: packages/algod_client/src/apis/api-service.ts:715
Parameters
Section titled “Parameters”number | bigint
string
params?
Section titled “params?”hashtype?
Section titled “hashtype?”"sha512_256" | "sha256"
Returns
Section titled “Returns”Promise<TransactionProof>
unsetSyncRound()
Section titled “unsetSyncRound()”unsetSyncRound():
Promise<void>
Defined in: packages/algod_client/src/apis/api-service.ts:735
Unset the ledger sync round.
Returns
Section titled “Returns”Promise<void>
version()
Section titled “version()”version():
Promise<Version>
Defined in: packages/algod_client/src/apis/api-service.ts:753
Retrieves the supported API versions, binary build versions, and genesis information.
Returns
Section titled “Returns”Promise<Version>