algod

type AccountApplicationInformation ¶

type AccountApplicationInformation struct {
	// contains filtered or unexported fields
}

AccountApplicationInformation 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.

func (s *AccountApplicationInformation) Do(ctx context.Context, headers ...*common.Header) (response models.AccountApplicationResponse, err error)

type AccountApplicationInformationParams ¶

type AccountApplicationInformationParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

AccountApplicationInformationParams contains all of the query parameters for url serialization.

type AccountAssetInformation ¶

type AccountAssetInformation struct {
	// contains filtered or unexported fields
}

AccountAssetInformation 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.

func (s *AccountAssetInformation) Do(ctx context.Context, headers ...*common.Header) (response models.AccountAssetResponse, err error)

type AccountAssetInformationParams ¶

type AccountAssetInformationParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

AccountAssetInformationParams contains all of the query parameters for url serialization.

type AccountInformation ¶

type AccountInformation struct {
	// contains filtered or unexported fields
}

AccountInformation given a specific account public key, this call returns the accounts status, balance and spendable amounts

func (s *AccountInformation) Do(ctx context.Context, headers ...*common.Header) (response models.Account, err error)

func (s *AccountInformation) Exclude(Exclude string) *AccountInformation

type AccountInformationParams ¶

type AccountInformationParams struct {

	// Exclude when set to `all` will exclude asset holdings, application local state,
	// created asset parameters, any created application parameters. Defaults to
	// `none`.
	Exclude string `url:"exclude,omitempty"`

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

AccountInformationParams contains all of the query parameters for url serialization.

type Block ¶

type Block struct {
	// contains filtered or unexported fields
}

Block get the block for the given round.

func (s *Block) Do(ctx context.Context, headers ...*common.Header) (result types.Block, err error)

type BlockParams ¶

type BlockParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

BlockParams contains all of the query parameters for url serialization.

type BlockRaw ¶

type BlockRaw struct {
	// contains filtered or unexported fields
}

BlockRaw contains metadata required to execute a BlockRaw query.

func (s *BlockRaw) Do(ctx context.Context, headers ...*common.Header) (result []byte, err error)

type Client ¶

type Client common.Client

func MakeClient(address string, apiToken string) (c *Client, err error)

func MakeClientWithHeaders(address string, apiToken string, headers []*common.Header) (c *Client, err error)

func MakeClientWithTransport(address string, apiToken string, headers []*common.Header, transport http.RoundTripper) (c *Client, err error)

func (c *Client) AccountApplicationInformation(address string, applicationId uint64) *AccountApplicationInformation

func (c *Client) AccountAssetInformation(address string, assetId uint64) *AccountAssetInformation

func (c *Client) AccountInformation(address string) *AccountInformation

func (c *Client) Block(round uint64) *Block

func (c *Client) BlockRaw(round uint64) *BlockRaw

func (c *Client) GetApplicationBoxByName(applicationId uint64, name []byte) *GetApplicationBoxByName

func (c *Client) GetApplicationBoxes(applicationId uint64) *GetApplicationBoxes

func (c *Client) GetApplicationByID(applicationId uint64) *GetApplicationByID

func (c *Client) GetAssetByID(assetId uint64) *GetAssetByID

func (c *Client) GetBlockHash(round uint64) *GetBlockHash

func (c *Client) GetBlockLogs(round uint64) *GetBlockLogs

func (c *Client) GetBlockTimeStampOffset() *GetBlockTimeStampOffset

func (c *Client) GetBlockTxids(round uint64) *GetBlockTxids

func (c *Client) GetGenesis() *GetGenesis

func (c *Client) GetLedgerStateDelta(round uint64) *GetLedgerStateDelta

func (c *Client) GetLedgerStateDeltaForTransactionGroup(id string) *GetLedgerStateDeltaForTransactionGroup

func (c *Client) GetLightBlockHeaderProof(round uint64) *GetLightBlockHeaderProof

func (c *Client) GetReady() *GetReady

func (c *Client) GetStateProof(round uint64) *GetStateProof

func (c *Client) GetSyncRound() *GetSyncRound

func (c *Client) GetTransactionGroupLedgerStateDeltasForRound(round uint64) *GetTransactionGroupLedgerStateDeltasForRound

func (c *Client) GetTransactionProof(round uint64, txid string) *GetTransactionProof

func (c *Client) HealthCheck() *HealthCheck

func (c *Client) PendingTransactionInformation(txid string) *PendingTransactionInformation

func (c *Client) PendingTransactions() *PendingTransactions

func (c *Client) PendingTransactionsByAddress(address string) *PendingTransactionsByAddress

func (c *Client) SendRawTransaction(rawtxn []byte) *SendRawTransaction

func (c *Client) SetBlockTimeStampOffset(offset uint64) *SetBlockTimeStampOffset

func (c *Client) SetSyncRound(round uint64) *SetSyncRound

func (c *Client) SimulateTransaction(request models.SimulateRequest) *SimulateTransaction

func (c *Client) Status() *Status

func (c *Client) StatusAfterBlock(round uint64) *StatusAfterBlock

func (c *Client) SuggestedParams() *SuggestedParams

func (c *Client) Supply() *Supply

func (c *Client) TealCompile(source []byte) *TealCompile

func (c *Client) TealDisassemble(source []byte) *TealDisassemble

func (c *Client) TealDryrun(request models.DryrunRequest) *TealDryrun

func (c *Client) UnsetSyncRound() *UnsetSyncRound

func (c *Client) Versions() *Versions

type GetApplicationBoxByName ¶

type GetApplicationBoxByName struct {
	// contains filtered or unexported fields
}

GetApplicationBoxByName 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...'.

func (s *GetApplicationBoxByName) Do(ctx context.Context, headers ...*common.Header) (response models.Box, err error)

type GetApplicationBoxByNameParams ¶

type GetApplicationBoxByNameParams struct {

	// Name a box name, in the goal app call arg 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...'.
	Name string `url:"name,omitempty"`
}

GetApplicationBoxByNameParams contains all of the query parameters for url serialization.

type GetApplicationBoxes ¶

type GetApplicationBoxes struct {
	// contains filtered or unexported fields
}

GetApplicationBoxes 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.

func (s *GetApplicationBoxes) Do(ctx context.Context, headers ...*common.Header) (response models.BoxesResponse, err error)

func (s *GetApplicationBoxes) Max(Max uint64) *GetApplicationBoxes

type GetApplicationBoxesParams ¶

type GetApplicationBoxesParams struct {

	// Max max number of box names to return. If max is not set, or max == 0, returns
	// all box-names.
	Max uint64 `url:"max,omitempty"`
}

GetApplicationBoxesParams contains all of the query parameters for url serialization.

type GetApplicationByID ¶

type GetApplicationByID struct {
	// contains filtered or unexported fields
}

GetApplicationByID given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

func (s *GetApplicationByID) Do(ctx context.Context, headers ...*common.Header) (response models.Application, err error)

type GetAssetByID ¶

type GetAssetByID struct {
	// contains filtered or unexported fields
}

GetAssetByID given a asset ID, it returns asset information including creator, name, total supply and special addresses.

func (s *GetAssetByID) Do(ctx context.Context, headers ...*common.Header) (response models.Asset, err error)

type GetBlockHash ¶

type GetBlockHash struct {
	// contains filtered or unexported fields
}

GetBlockHash get the block hash for the block on the given round.

func (s *GetBlockHash) Do(ctx context.Context, headers ...*common.Header) (response models.BlockHashResponse, err error)

type GetBlockLogs ¶ added in v2.5.0

type GetBlockLogs struct {
	// contains filtered or unexported fields
}

GetBlockLogs get all of the logs from outer and inner app calls in the given round

func (s *GetBlockLogs) Do(ctx context.Context, headers ...*common.Header) (response models.BlockLogsResponse, err error)

type GetBlockParams ¶

type GetBlockParams struct {
	// Return raw msgpack block bytes or json
	Format string `url:"format,omitempty"`
}

GetBlockParams defines parameters for GetBlock.

type GetBlockTimeStampOffset ¶ added in v2.1.0

type GetBlockTimeStampOffset struct {
	// contains filtered or unexported fields
}

GetBlockTimeStampOffset gets the current timestamp offset.

func (s *GetBlockTimeStampOffset) Do(ctx context.Context, headers ...*common.Header) (response models.GetBlockTimeStampOffsetResponse, err error)

type GetBlockTxids ¶ added in v2.3.0

type GetBlockTxids struct {
	// contains filtered or unexported fields
}

GetBlockTxids get the top level transaction IDs for the block on the given round.

func (s *GetBlockTxids) Do(ctx context.Context, headers ...*common.Header) (response models.BlockTxidsResponse, err error)

type GetGenesis ¶

type GetGenesis struct {
	// contains filtered or unexported fields
}

GetGenesis returns the entire genesis file in json.

func (s *GetGenesis) Do(ctx context.Context, headers ...*common.Header) (response string, err error)

type GetLedgerStateDelta ¶

type GetLedgerStateDelta struct {
	// contains filtered or unexported fields
}

GetLedgerStateDelta get ledger deltas for a round.

func (s *GetLedgerStateDelta) Do(ctx context.Context, headers ...*common.Header) (response types.LedgerStateDelta, err error)

type GetLedgerStateDeltaForTransactionGroup ¶ added in v2.2.0

type GetLedgerStateDeltaForTransactionGroup struct {
	// contains filtered or unexported fields
}

GetLedgerStateDeltaForTransactionGroup get a ledger delta for a given transaction group.

func (s *GetLedgerStateDeltaForTransactionGroup) Do(ctx context.Context, headers ...*common.Header) (response types.LedgerStateDelta, err error)

type GetLedgerStateDeltaForTransactionGroupParams ¶ added in v2.2.0

type GetLedgerStateDeltaForTransactionGroupParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

GetLedgerStateDeltaForTransactionGroupParams contains all of the query parameters for url serialization.

type GetLedgerStateDeltaParams ¶ added in v2.2.0

type GetLedgerStateDeltaParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

GetLedgerStateDeltaParams contains all of the query parameters for url serialization.

type GetLightBlockHeaderProof ¶

type GetLightBlockHeaderProof struct {
	// contains filtered or unexported fields
}

GetLightBlockHeaderProof gets a proof for a given light block header inside a state proof commitment

func (s *GetLightBlockHeaderProof) Do(ctx context.Context, headers ...*common.Header) (response models.LightBlockHeaderProof, err error)

type GetReady ¶ added in v2.1.0

type GetReady struct {
	// contains filtered or unexported fields
}

GetReady returns OK if healthy and fully caught up.

func (s *GetReady) Do(ctx context.Context, headers ...*common.Header) (response string, err error)

type GetStateProof ¶

type GetStateProof struct {
	// contains filtered or unexported fields
}

GetStateProof get a state proof that covers a given round

func (s *GetStateProof) Do(ctx context.Context, headers ...*common.Header) (response models.StateProof, err error)

type GetSyncRound ¶

type GetSyncRound struct {
	// contains filtered or unexported fields
}

GetSyncRound gets the minimum sync round for the ledger.

func (s *GetSyncRound) Do(ctx context.Context, headers ...*common.Header) (response models.GetSyncRoundResponse, err error)

type GetTransactionGroupLedgerStateDeltasForRound ¶ added in v2.2.0

type GetTransactionGroupLedgerStateDeltasForRound struct {
	// contains filtered or unexported fields
}

GetTransactionGroupLedgerStateDeltasForRound get ledger deltas for transaction groups in a given round.

func (s *GetTransactionGroupLedgerStateDeltasForRound) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionGroupLedgerStateDeltasForRoundResponse, err error)

type GetTransactionGroupLedgerStateDeltasForRoundParams ¶ added in v2.2.0

type GetTransactionGroupLedgerStateDeltasForRoundParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

GetTransactionGroupLedgerStateDeltasForRoundParams contains all of the query parameters for url serialization.

type GetTransactionProof ¶

type GetTransactionProof struct {
	// contains filtered or unexported fields
}

GetTransactionProof get a proof for a transaction in a block.

func (s *GetTransactionProof) Do(ctx context.Context, headers ...*common.Header) (response models.TransactionProofResponse, err error)

func (s *GetTransactionProof) Hashtype(Hashtype string) *GetTransactionProof

type GetTransactionProofParams ¶

type GetTransactionProofParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`

	// Hashtype the type of hash function used to create the proof, must be one of:
	// * sha512_256
	// * sha256
	Hashtype string `url:"hashtype,omitempty"`
}

GetTransactionProofParams contains all of the query parameters for url serialization.

type HealthCheck ¶

type HealthCheck struct {
	// contains filtered or unexported fields
}

HealthCheck returns OK if healthy.

func (s *HealthCheck) Do(ctx context.Context, headers ...*common.Header) error

type PendingTransactionInformation ¶

type PendingTransactionInformation struct {
	// contains filtered or unexported fields
}

PendingTransactionInformation 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.

func (s *PendingTransactionInformation) Do(ctx context.Context, headers ...*common.Header) (response models.PendingTransactionInfoResponse, stxn types.SignedTxn, err error)

type PendingTransactionInformationParams ¶

type PendingTransactionInformationParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

PendingTransactionInformationParams contains all of the query parameters for url serialization.

type PendingTransactions ¶

type PendingTransactions struct {
	// contains filtered or unexported fields
}

PendingTransactions 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.

func (s *PendingTransactions) Do(ctx context.Context, headers ...*common.Header) (total uint64, topTransactions []types.SignedTxn, err error)

func (s *PendingTransactions) Max(Max uint64) *PendingTransactions

type PendingTransactionsByAddress ¶

type PendingTransactionsByAddress struct {
	// contains filtered or unexported fields
}

PendingTransactionsByAddress 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.

func (s *PendingTransactionsByAddress) Do(ctx context.Context, headers ...*common.Header) (total uint64, topTransactions []types.SignedTxn, err error)

func (s *PendingTransactionsByAddress) Max(Max uint64) *PendingTransactionsByAddress

type PendingTransactionsByAddressParams ¶

type PendingTransactionsByAddressParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`

	// Max truncated number of transactions to display. If max=0, returns all pending
	// txns.
	Max uint64 `url:"max,omitempty"`
}

PendingTransactionsByAddressParams contains all of the query parameters for url serialization.

type PendingTransactionsParams ¶

type PendingTransactionsParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`

	// Max truncated number of transactions to display. If max=0, returns all pending
	// txns.
	Max uint64 `url:"max,omitempty"`
}

PendingTransactionsParams contains all of the query parameters for url serialization.

type SendRawTransaction ¶

type SendRawTransaction struct {
	// contains filtered or unexported fields
}

SendRawTransaction broadcasts a raw transaction or transaction group to the network.

func (s *SendRawTransaction) Do(ctx context.Context, headers ...*common.Header) (txid string, err error)

type SetBlockTimeStampOffset ¶ added in v2.1.0

type SetBlockTimeStampOffset struct {
	// contains filtered or unexported fields
}

SetBlockTimeStampOffset 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.

func (s *SetBlockTimeStampOffset) Do(ctx context.Context, headers ...*common.Header) (response string, err error)

type SetSyncRound ¶

type SetSyncRound struct {
	// contains filtered or unexported fields
}

SetSyncRound sets the minimum sync round on the ledger.

func (s *SetSyncRound) Do(ctx context.Context, headers ...*common.Header) (response string, err error)

type SimulateTransaction ¶ added in v2.1.0

type SimulateTransaction struct {
	// contains filtered or unexported fields
}

SimulateTransaction 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.

func (s *SimulateTransaction) Do(ctx context.Context, headers ...*common.Header) (response models.SimulateResponse, err error)

type SimulateTransactionParams ¶ added in v2.1.0

type SimulateTransactionParams struct {

	// Format configures whether the response object is JSON or MessagePack encoded. If
	// not provided, defaults to JSON.
	Format string `url:"format,omitempty"`
}

SimulateTransactionParams contains all of the query parameters for url serialization.

type Status ¶

type Status struct {
	// contains filtered or unexported fields
}

Status gets the current node status.

func (s *Status) Do(ctx context.Context, headers ...*common.Header) (response models.NodeStatus, err error)

type StatusAfterBlock ¶

type StatusAfterBlock struct {
	// contains filtered or unexported fields
}

StatusAfterBlock 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.

func (s *StatusAfterBlock) Do(ctx context.Context, headers ...*common.Header) (response models.NodeStatus, err error)

type SuggestedParams ¶

type SuggestedParams struct {
	// contains filtered or unexported fields
}

SuggestedParams get parameters for constructing a new transaction

func (s *SuggestedParams) Do(ctx context.Context, headers ...*common.Header) (params types.SuggestedParams, err error)

type Supply ¶

type Supply struct {
	// contains filtered or unexported fields
}

Supply get the current supply reported by the ledger.

func (s *Supply) Do(ctx context.Context, headers ...*common.Header) (response models.Supply, err error)

type TealCompile ¶

type TealCompile struct {
	// contains filtered or unexported fields
}

TealCompile 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.

func (s *TealCompile) Do(ctx context.Context, headers ...*common.Header) (response models.CompileResponse, err error)

func (s *TealCompile) Sourcemap(Sourcemap bool) *TealCompile

type TealCompileParams ¶

type TealCompileParams struct {

	// Sourcemap when set to `true`, returns the source map of the program as a JSON.
	// Defaults to `false`.
	Sourcemap bool `url:"sourcemap,omitempty"`
}

TealCompileParams contains all of the query parameters for url serialization.

type TealDisassemble ¶

type TealDisassemble struct {
	// contains filtered or unexported fields
}

TealDisassemble 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.

func (s *TealDisassemble) Do(ctx context.Context, headers ...*common.Header) (response models.DisassembleResponse, err error)

type TealDryRun ¶

type TealDryRun struct {
	// contains filtered or unexported fields
}

TealDryRun /v2/teal/dryrun

func (s *TealDryRun) Do(
	ctx context.Context,
	headers ...*common.Header,
) (response models.DryrunResponse, err error)

type TealDryrun ¶

type TealDryrun struct {
	// contains filtered or unexported fields
}

TealDryrun 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.

func (s *TealDryrun) Do(ctx context.Context, headers ...*common.Header) (response models.DryrunResponse, err error)

type UnsetSyncRound ¶

type UnsetSyncRound struct {
	// contains filtered or unexported fields
}

UnsetSyncRound unset the ledger sync round.

func (s *UnsetSyncRound) Do(ctx context.Context, headers ...*common.Header) (response string, err error)

type Versions ¶

type Versions struct {
	// contains filtered or unexported fields
}

Versions retrieves the supported API versions, binary build versions, and genesis information.

func (s *Versions) Do(ctx context.Context, headers ...*common.Header) (response models.Version, err error)