PublicService
Constructors
new PublicService()
new PublicService(
httpRequest):PublicService
Parameters
• httpRequest: BaseHttpRequest
Returns
Defined in
services.gen.ts:262
Properties
httpRequest
readonlyhttpRequest:BaseHttpRequest
Defined in
services.gen.ts:262
Methods
accountApplicationInformation()
accountApplicationInformation(
data):CancelablePromise<AccountApplicationInformationResponse>
Get account information about a given app. 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
• data: AccountApplicationInformationData
The data for the request.
Returns
CancelablePromise<AccountApplicationInformationResponse>
unknown AccountApplicationResponse describes the account’s application local state and global state (AppLocalState and AppParams, if either exists) for a specific application ID. Global state will only be returned if the provided address is the application’s creator.
Throws
ApiError
Defined in
services.gen.ts:383
accountAssetInformation()
accountAssetInformation(
data):CancelablePromise<AccountAssetInformationResponse>
Get account information about a given asset. 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
• data: AccountAssetInformationData
The data for the request.
Returns
CancelablePromise<AccountAssetInformationResponse>
unknown AccountAssetResponse describes the account’s asset holding and asset parameters (if either exist) for a specific asset ID. Asset parameters will only be returned if the provided address is the asset’s creator.
Throws
ApiError
Defined in
services.gen.ts:443
accountAssetsInformation()
accountAssetsInformation(
data):CancelablePromise<AccountAssetsInformationResponse>
Get a list of assets held by an account, inclusive of asset params. Lookup an account’s asset holdings.
Parameters
• data: AccountAssetsInformationData
The data for the request.
Returns
CancelablePromise<AccountAssetsInformationResponse>
unknown AccountAssetsInformationResponse contains a list of assets held by an account.
Throws
ApiError
Defined in
services.gen.ts:413
accountInformation()
accountInformation(
data):CancelablePromise<Account>
Get account information. Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Parameters
• data: AccountInformationData
The data for the request.
Returns
Account AccountResponse wraps the Account type in a response.
Throws
ApiError
Defined in
services.gen.ts:353
experimentalCheck()
experimentalCheck():
CancelablePromise<unknown>
Returns OK if experimental API is enabled.
Returns
CancelablePromise<unknown>
unknown Experimental API enabled
Throws
ApiError
Defined in
services.gen.ts:897
getApplicationBoxByName()
getApplicationBoxByName(
data):CancelablePromise<Box>
Get box information for a given application. Given an application ID and box name, it returns the round, box name, and value (each base64 encoded). Box names must be in the goal app call arg encoding form ‘encoding:value ’. For ints, use the form ‘int:1234’. For raw bytes, use the form ‘b64:A ==‘. For printable strings, use the form ‘str:hello ’. For addresses, use the form ‘addr:XYZ …‘.
Parameters
• data: GetApplicationBoxByNameData
The data for the request.
Returns
Box Box information
Throws
ApiError
Defined in
services.gen.ts:529
getApplicationBoxes()
getApplicationBoxes(
data):CancelablePromise<GetApplicationBoxesResponse>
Get all box names for a given application. 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
• data: GetApplicationBoxesData
The data for the request.
Returns
CancelablePromise<GetApplicationBoxesResponse>
unknown Box names of an application
Throws
ApiError
Defined in
services.gen.ts:558
getApplicationById()
getApplicationById(
data):CancelablePromise<Application>
Get application information. Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Parameters
• data: GetApplicationByIdData
The data for the request.
Returns
CancelablePromise<Application>
Application Application information
Throws
ApiError
Defined in
services.gen.ts:503
getAssetById()
getAssetById(
data):CancelablePromise<Asset>
Get asset information. Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
Parameters
• data: GetAssetByIdData
The data for the request.
Returns
Asset Asset information
Throws
ApiError
Defined in
services.gen.ts:585
getBlock()
getBlock(
data):CancelablePromise<GetBlockResponse>
Get the block for the given round.
Parameters
• data: GetBlockData
The data for the request.
Returns
CancelablePromise<GetBlockResponse>
unknown Encoded block object.
Throws
ApiError
Defined in
services.gen.ts:610
getBlockHash()
getBlockHash(
data):CancelablePromise<GetBlockHashResponse>
Get the block hash for the block on the given round.
Parameters
• data: GetBlockHashData
The data for the request.
Returns
CancelablePromise<GetBlockHashResponse>
unknown Hash of a block header.
Throws
ApiError
Defined in
services.gen.ts:637
getBlockLogs()
getBlockLogs(
data):CancelablePromise<GetBlockLogsResponse>
Get all of the logs from outer and inner app calls in the given round Get all of the logs from outer and inner app calls in the given round
Parameters
• data: GetBlockLogsData
The data for the request.
Returns
CancelablePromise<GetBlockLogsResponse>
unknown All logs emitted in the given round. Each app call, whether top-level or inner, that contains logs results in a separate AppCallLogs object. Therefore there may be multiple AppCallLogs with the same application ID and outer transaction ID in the event of multiple inner app calls to the same app. App calls with no logs are not included in the response. AppCallLogs are returned in the same order that their corresponding app call appeared in the block (pre-order traversal of inner app calls)
Throws
ApiError
Defined in
services.gen.ts:687
getBlockTimeStampOffset()
getBlockTimeStampOffset():
CancelablePromise<GetBlockTimeStampOffsetResponse>
Returns the timestamp offset. Timestamp offsets can only be set in dev mode. Gets the current timestamp offset.
Returns
CancelablePromise<GetBlockTimeStampOffsetResponse>
unknown Response containing the timestamp offset in seconds
Throws
ApiError
Defined in
services.gen.ts:857
getBlockTxids()
getBlockTxids(
data):CancelablePromise<GetBlockTxidsResponse>
Get the top level transaction IDs for the block on the given round.
Parameters
• data: GetBlockTxidsData
The data for the request.
Returns
CancelablePromise<GetBlockTxidsResponse>
unknown Top level transaction IDs in a block.
Throws
ApiError
Defined in
services.gen.ts:744
getGenesis()
getGenesis():
CancelablePromise<string>
Gets the genesis information. Returns the entire genesis file in json.
Returns
CancelablePromise<string>
string The genesis file in json.
Throws
ApiError
Defined in
services.gen.ts:270
getLedgerStateDelta()
getLedgerStateDelta(
data):CancelablePromise<LedgerStateDelta>
Get a LedgerStateDelta object for a given round Get ledger deltas for a round.
Parameters
• data: GetLedgerStateDeltaData
The data for the request.
Returns
CancelablePromise<LedgerStateDelta>
LedgerStateDelta Contains ledger deltas
Throws
ApiError
Defined in
services.gen.ts:800
getLedgerStateDeltaForTransactionGroup()
getLedgerStateDeltaForTransactionGroup(
data):CancelablePromise<LedgerStateDelta>
Get a LedgerStateDelta object for a given transaction group Get a ledger delta for a given transaction group.
Parameters
• data: GetLedgerStateDeltaForTransactionGroupData
The data for the request.
Returns
CancelablePromise<LedgerStateDelta>
LedgerStateDelta Response containing a ledger state delta for a single transaction group.
Throws
ApiError
Defined in
services.gen.ts:770
getLightBlockHeaderProof()
getLightBlockHeaderProof(
data):CancelablePromise<LightBlockHeaderProof>
Gets a proof for a given light block header inside a state proof commitment
Parameters
• data: GetLightBlockHeaderProofData
The data for the request.
Returns
CancelablePromise<LightBlockHeaderProof>
LightBlockHeaderProof Proof of a light block header.
Throws
ApiError
Defined in
services.gen.ts:661
getPendingTransactions()
getPendingTransactions(
data):CancelablePromise<GetPendingTransactionsResponse>
Get a list of unconfirmed transactions currently in the transaction pool. 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
• data: GetPendingTransactionsData = {}
The data for the request.
Returns
CancelablePromise<GetPendingTransactionsResponse>
unknown A potentially truncated list of transactions currently in the node’s transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions.
Throws
ApiError
Defined in
services.gen.ts:1183
getPendingTransactionsByAddress()
getPendingTransactionsByAddress(
data):CancelablePromise<GetPendingTransactionsByAddressResponse>
Get a list of unconfirmed transactions currently in the transaction pool by address. 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
• data: GetPendingTransactionsByAddressData
The data for the request.
Returns
CancelablePromise<GetPendingTransactionsByAddressResponse>
unknown A potentially truncated list of transactions currently in the node’s transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions.
Throws
ApiError
Defined in
services.gen.ts:474
getReady()
getReady():
CancelablePromise<unknown>
Returns OK if healthy and fully caught up.
Returns
CancelablePromise<unknown>
unknown OK.
Throws
ApiError
Defined in
services.gen.ts:315
getStateProof()
getStateProof(
data):CancelablePromise<StateProof>
Get a state proof that covers a given round
Parameters
• data: GetStateProofData
The data for the request.
Returns
StateProof StateProofResponse wraps the StateProof type in a response.
Throws
ApiError
Defined in
services.gen.ts:996
getStatus()
getStatus():
CancelablePromise<GetStatusResponse>
Gets the current node status.
Returns
CancelablePromise<GetStatusResponse>
unknown
Throws
ApiError
Defined in
services.gen.ts:1019
getSupply()
getSupply():
CancelablePromise<GetSupplyResponse>
Get the current supply reported by the ledger.
Returns
CancelablePromise<GetSupplyResponse>
unknown Supply represents the current supply of MicroAlgos in the system.
Throws
ApiError
Defined in
services.gen.ts:913
getSyncRound()
getSyncRound():
CancelablePromise<GetSyncRoundResponse>
Returns the minimum sync round the ledger is keeping in cache. Gets the minimum sync round for the ledger.
Returns
CancelablePromise<GetSyncRoundResponse>
unknown Response containing the ledger’s minimum sync round
Throws
ApiError
Defined in
services.gen.ts:950
getTransactionGroupLedgerStateDeltasForRound()
getTransactionGroupLedgerStateDeltasForRound(
data):CancelablePromise<GetTransactionGroupLedgerStateDeltasForRoundResponse>
Get LedgerStateDelta objects for all transaction groups in a given round Get ledger deltas for transaction groups in a given round.
Parameters
• data: GetTransactionGroupLedgerStateDeltasForRoundData
The data for the request.
Returns
CancelablePromise<GetTransactionGroupLedgerStateDeltasForRoundResponse>
unknown Response containing all ledger state deltas for transaction groups, with their associated Ids, in a single round.
Throws
ApiError
Defined in
services.gen.ts:830
getTransactionProof()
getTransactionProof(
data):CancelablePromise<GetTransactionProofResponse>
Get a proof for a transaction in a block.
Parameters
• data: GetTransactionProofData
The data for the request.
Returns
CancelablePromise<GetTransactionProofResponse>
unknown Proof of transaction in a block.
Throws
ApiError
Defined in
services.gen.ts:715
getVersion()
getVersion():
CancelablePromise<Version>
Retrieves the supported API versions, binary build versions, and genesis information.
Returns
Version VersionsResponse is the response to ‘GET /versions’
Throws
ApiError
Defined in
services.gen.ts:1270
healthCheck()
healthCheck():
CancelablePromise<unknown>
Returns OK if healthy.
Returns
CancelablePromise<unknown>
unknown OK.
Throws
ApiError
Defined in
services.gen.ts:285
metrics()
metrics():
CancelablePromise<unknown>
Return metrics about algod functioning.
Returns
CancelablePromise<unknown>
unknown text with #-comments and key:value lines
Throws
ApiError
Defined in
services.gen.ts:300
pendingTransactionInformation()
pendingTransactionInformation(
data):CancelablePromise<PendingTransactionResponse>
Get a specific pending transaction. 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
• data: PendingTransactionInformationData
The data for the request.
Returns
CancelablePromise<PendingTransactionResponse>
PendingTransactionResponse 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.
Throws
ApiError
Defined in
services.gen.ts:1219
rawTransaction()
rawTransaction(
data):CancelablePromise<RawTransactionResponse>
Broadcasts a raw transaction or transaction group to the network.
Parameters
• data: RawTransactionData
The data for the request.
Returns
CancelablePromise<RawTransactionResponse>
unknown Transaction ID of the submission.
Throws
ApiError
Defined in
services.gen.ts:1139
setBlockTimeStampOffset()
setBlockTimeStampOffset(
data):CancelablePromise<unknown>
Given a timestamp offset in seconds, adds the offset to every subsequent block header’s timestamp. 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
• data: SetBlockTimeStampOffsetData
The data for the request.
Returns
CancelablePromise<unknown>
unknown OK
Throws
ApiError
Defined in
services.gen.ts:876
setSyncRound()
setSyncRound(
data):CancelablePromise<unknown>
Given a round, tells the ledger to keep that round in its cache. Sets the minimum sync round on the ledger.
Parameters
• data: SetSyncRoundData
The data for the request.
Returns
CancelablePromise<unknown>
unknown
Throws
ApiError
Defined in
services.gen.ts:972
simulateTransaction()
simulateTransaction(
data):CancelablePromise<SimulateTransactionResponse>
Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.
Parameters
• data: SimulateTransactionData
The data for the request.
Returns
CancelablePromise<SimulateTransactionResponse>
unknown Result of a transaction group simulation.
Throws
ApiError
Defined in
services.gen.ts:1246
swaggerJson()
swaggerJson():
CancelablePromise<string>
Gets the current swagger spec. Returns the entire swagger spec in json.
Returns
CancelablePromise<string>
string The current swagger spec
Throws
ApiError
Defined in
services.gen.ts:333
tealCompile()
tealCompile(
data):CancelablePromise<TealCompileResponse>
Compile TEAL source code to binary, produce its hash 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
• data: TealCompileData
The data for the request.
Returns
CancelablePromise<TealCompileResponse>
unknown Teal compile Result
Throws
ApiError
Defined in
services.gen.ts:1065
tealDisassemble()
tealDisassemble(
data):CancelablePromise<TealDisassembleResponse>
Disassemble program bytes into the TEAL source code. 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
• data: TealDisassembleData
The data for the request.
Returns
CancelablePromise<TealDisassembleResponse>
unknown Teal disassembly Result
Throws
ApiError
Defined in
services.gen.ts:1092
tealDryrun()
tealDryrun(
data):CancelablePromise<TealDryrunResponse>
Provide debugging information for a transaction (or group). Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node’s configuration file sets EnableDeveloperAPI to true.
Parameters
• data: TealDryrunData = {}
The data for the request.
Returns
CancelablePromise<TealDryrunResponse>
unknown DryrunResponse contains per-txn debug information from a dryrun.
Throws
ApiError
Defined in
services.gen.ts:1116
transactionParams()
transactionParams():
CancelablePromise<TransactionParamsResponse>
Get parameters for constructing a new transaction
Returns
CancelablePromise<TransactionParamsResponse>
unknown TransactionParams contains the parameters that help a client construct a new transaction.
Throws
ApiError
Defined in
services.gen.ts:1160
unsetSyncRound()
unsetSyncRound():
CancelablePromise<unknown>
Removes minimum sync round restriction from the ledger. Unset the ledger sync round.
Returns
CancelablePromise<unknown>
unknown
Throws
ApiError
Defined in
services.gen.ts:930
waitForBlock()
waitForBlock(
data):CancelablePromise<WaitForBlockResponse>
Gets the node status after waiting for a round after the given round. 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
• data: WaitForBlockData
The data for the request.
Returns
CancelablePromise<WaitForBlockResponse>
unknown
Throws
ApiError
Defined in
services.gen.ts:1039