models

package
v1.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 25, 2022 License: MIT Imports: 1 Imported by: 44

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	// Address the account public key
	Address string `json:"address"`

	// Amount (algo) total number of MicroAlgos in the account
	Amount uint64 `json:"amount"`

	// AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account,
	// without the pending rewards.
	AmountWithoutPendingRewards uint64 `json:"amount-without-pending-rewards"`

	// AppsLocalState (appl) applications local data stored in this account.
	// Note the raw object uses `map[int] -> AppLocalState` for this type.
	AppsLocalState []ApplicationLocalState `json:"apps-local-state,omitempty"`

	// AppsTotalExtraPages (teap) the sum of all extra application program pages for
	// this account.
	AppsTotalExtraPages uint64 `json:"apps-total-extra-pages,omitempty"`

	// AppsTotalSchema (tsch) stores the sum of all of the local schemas and global
	// schemas in this account.
	// Note: the raw account uses `StateSchema` for this type.
	AppsTotalSchema ApplicationStateSchema `json:"apps-total-schema,omitempty"`

	// Assets (asset) assets held by this account.
	// Note the raw object uses `map[int] -> AssetHolding` for this type.
	Assets []AssetHolding `json:"assets,omitempty"`

	// AuthAddr (spend) the address against which signing should be checked. If empty,
	// the address of the current account is used. This field can be updated in any
	// transaction by setting the RekeyTo field.
	AuthAddr string `json:"auth-addr,omitempty"`

	// ClosedAtRound round during which this account was most recently closed.
	ClosedAtRound uint64 `json:"closed-at-round,omitempty"`

	// CreatedApps (appp) parameters of applications created by this account including
	// app global data.
	// Note: the raw account uses `map[int] -> AppParams` for this type.
	CreatedApps []Application `json:"created-apps,omitempty"`

	// CreatedAssets (apar) parameters of assets created by this account.
	// Note: the raw account uses `map[int] -> Asset` for this type.
	CreatedAssets []Asset `json:"created-assets,omitempty"`

	// CreatedAtRound round during which this account first appeared in a transaction.
	CreatedAtRound uint64 `json:"created-at-round,omitempty"`

	// Deleted whether or not this account is currently closed.
	Deleted bool `json:"deleted,omitempty"`

	// Participation accountParticipation describes the parameters used by this account
	// in consensus protocol.
	Participation AccountParticipation `json:"participation,omitempty"`

	// PendingRewards amount of MicroAlgos of pending rewards in this account.
	PendingRewards uint64 `json:"pending-rewards"`

	// RewardBase (ebase) used as part of the rewards computation. Only applicable to
	// accounts which are participating.
	RewardBase uint64 `json:"reward-base,omitempty"`

	// Rewards (ern) total rewards of MicroAlgos the account has received, including
	// pending rewards.
	Rewards uint64 `json:"rewards"`

	// Round the round for which this information is relevant.
	Round uint64 `json:"round"`

	// SigType indicates what type of signature is used by this account, must be one
	// of:
	// * sig
	// * msig
	// * lsig
	// * or null if unknown
	SigType string `json:"sig-type,omitempty"`

	// Status (onl) delegation status of the account's MicroAlgos
	// * Offline - indicates that the associated account is delegated.
	// * Online - indicates that the associated account used as part of the delegation
	// pool.
	// * NotParticipating - indicates that the associated account is neither a
	// delegator nor a delegate.
	Status string `json:"status"`

	// TotalAppsOptedIn the count of all applications that have been opted in,
	// equivalent to the count of application local data (AppLocalState objects) stored
	// in this account.
	TotalAppsOptedIn uint64 `json:"total-apps-opted-in"`

	// TotalAssetsOptedIn the count of all assets that have been opted in, equivalent
	// to the count of AssetHolding objects held by this account.
	TotalAssetsOptedIn uint64 `json:"total-assets-opted-in"`

	// TotalCreatedApps the count of all apps (AppParams objects) created by this
	// account.
	TotalCreatedApps uint64 `json:"total-created-apps"`

	// TotalCreatedAssets the count of all assets (AssetParams objects) created by this
	// account.
	TotalCreatedAssets uint64 `json:"total-created-assets"`
}

Account account information at a given round. Definition: data/basics/userBalance.go : AccountData

type AccountApplicationResponse added in v1.14.0 

type AccountApplicationResponse struct {
	// AppLocalState (appl) the application local data stored in this account.
	// The raw account uses `AppLocalState` for this type.
	AppLocalState ApplicationLocalState `json:"app-local-state,omitempty"`

	// CreatedApp (appp) parameters of the application created by this account
	// including app global data.
	// The raw account uses `AppParams` for this type.
	CreatedApp ApplicationParams `json:"created-app,omitempty"`

	// Round the round for which this information is relevant.
	Round uint64 `json:"round"`
}

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

type AccountAssetResponse added in v1.14.0 

type AccountAssetResponse struct {
	// AssetHolding (asset) Details about the asset held by this account.
	// The raw account uses `AssetHolding` for this type.
	AssetHolding AssetHolding `json:"asset-holding,omitempty"`

	// CreatedAsset (apar) parameters of the asset created by this account.
	// The raw account uses `AssetParams` for this type.
	CreatedAsset AssetParams `json:"created-asset,omitempty"`

	// Round the round for which this information is relevant.
	Round uint64 `json:"round"`
}

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

type AccountErrorResponse added in v1.14.0 

type AccountErrorResponse struct {
	// Data
	Data string `json:"data,omitempty"`

	// MaxResults
	MaxResults uint64 `json:"max-results,omitempty"`

	// Message
	Message string `json:"message"`

	// TotalAppsLocalState
	TotalAppsLocalState uint64 `json:"total-apps-local-state,omitempty"`

	// TotalAssets
	TotalAssets uint64 `json:"total-assets,omitempty"`

	// TotalCreatedApps
	TotalCreatedApps uint64 `json:"total-created-apps,omitempty"`

	// TotalCreatedAssets
	TotalCreatedAssets uint64 `json:"total-created-assets,omitempty"`
}

AccountErrorResponse an error response for the AccountInformation endpoint, with optional information about limits that were exceeded.

type AccountParticipation 

type AccountParticipation struct {
	// SelectionParticipationKey (sel) Selection public key (if any) currently
	// registered for this round.
	SelectionParticipationKey []byte `json:"selection-participation-key"`

	// StateProofKey (stprf) Root of the state proof key (if any)
	StateProofKey []byte `json:"state-proof-key,omitempty"`

	// VoteFirstValid (voteFst) First round for which this participation is valid.
	VoteFirstValid uint64 `json:"vote-first-valid"`

	// VoteKeyDilution (voteKD) Number of subkeys in each batch of participation keys.
	VoteKeyDilution uint64 `json:"vote-key-dilution"`

	// VoteLastValid (voteLst) Last round for which this participation is valid.
	VoteLastValid uint64 `json:"vote-last-valid"`

	// VoteParticipationKey (vote) root participation public key (if any) currently
	// registered for this round.
	VoteParticipationKey []byte `json:"vote-participation-key"`
}

AccountParticipation accountParticipation describes the parameters used by this account in consensus protocol.

type AccountResponse 

type AccountResponse struct {
	// Account account information at a given round.
	// Definition:
	// data/basics/userBalance.go : AccountData
	Account Account `json:"account"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`
}

AccountResponse

type AccountStateDelta added in v1.5.0 

type AccountStateDelta struct {
	// Address
	Address string `json:"address"`

	// Delta application state delta.
	Delta []EvalDeltaKeyValue `json:"delta"`
}

AccountStateDelta application state delta.

type AccountsResponse 

type AccountsResponse struct {
	// Accounts
	Accounts []Account `json:"accounts"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

AccountsResponse

type Application added in v1.5.0 

type Application struct {
	// CreatedAtRound round when this application was created.
	CreatedAtRound uint64 `json:"created-at-round,omitempty"`

	// Deleted whether or not this application is currently deleted.
	Deleted bool `json:"deleted,omitempty"`

	// DeletedAtRound round when this application was deleted.
	DeletedAtRound uint64 `json:"deleted-at-round,omitempty"`

	// Id (appidx) application index.
	Id uint64 `json:"id"`

	// Params (appparams) application parameters.
	Params ApplicationParams `json:"params"`
}

Application application index and its parameters

type ApplicationLocalState added in v1.5.0 

type ApplicationLocalState struct {
	// ClosedOutAtRound round when account closed out of the application.
	ClosedOutAtRound uint64 `json:"closed-out-at-round,omitempty"`

	// Deleted whether or not the application local state is currently deleted from its
	// account.
	Deleted bool `json:"deleted,omitempty"`

	// Id the application which this local state is for.
	Id uint64 `json:"id"`

	// KeyValue (tkv) storage.
	KeyValue []TealKeyValue `json:"key-value,omitempty"`

	// OptedInAtRound round when the account opted into the application.
	OptedInAtRound uint64 `json:"opted-in-at-round,omitempty"`

	// Schema (hsch) schema.
	Schema ApplicationStateSchema `json:"schema"`
}

ApplicationLocalState stores local state associated with an application.

type ApplicationLocalStatesResponse added in v1.14.0 

type ApplicationLocalStatesResponse struct {
	// AppsLocalStates
	AppsLocalStates []ApplicationLocalState `json:"apps-local-states"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

ApplicationLocalStatesResponse

type ApplicationLogData added in v1.11.0 

type ApplicationLogData struct {
	// Logs (lg) Logs for the application being executed by the transaction.
	Logs [][]byte `json:"logs"`

	// Txid transaction ID
	Txid string `json:"txid"`
}

ApplicationLogData stores the global information associated with an application.

type ApplicationLogsResponse added in v1.11.0 

type ApplicationLogsResponse struct {
	// ApplicationId (appidx) application index.
	ApplicationId uint64 `json:"application-id"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// LogData
	LogData []ApplicationLogData `json:"log-data,omitempty"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

ApplicationLogsResponse

type ApplicationParams added in v1.5.0 

type ApplicationParams struct {
	// ApprovalProgram (approv) approval program.
	ApprovalProgram []byte `json:"approval-program"`

	// ClearStateProgram (clearp) approval program.
	ClearStateProgram []byte `json:"clear-state-program"`

	// Creator the address that created this application. This is the address where the
	// parameters and global state for this application can be found.
	Creator string `json:"creator,omitempty"`

	// ExtraProgramPages (epp) the amount of extra program pages available to this app.
	ExtraProgramPages uint64 `json:"extra-program-pages,omitempty"`

	// GlobalState [\gs) global schema
	GlobalState []TealKeyValue `json:"global-state,omitempty"`

	// GlobalStateSchema [\gsch) global schema
	GlobalStateSchema ApplicationStateSchema `json:"global-state-schema,omitempty"`

	// LocalStateSchema [\lsch) local schema
	LocalStateSchema ApplicationStateSchema `json:"local-state-schema,omitempty"`
}

ApplicationParams stores the global information associated with an application.

type ApplicationResponse added in v1.5.0 

type ApplicationResponse struct {
	// Application application index and its parameters
	Application Application `json:"application,omitempty"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`
}

ApplicationResponse

type ApplicationStateSchema added in v1.5.0 

type ApplicationStateSchema struct {
	// NumByteSlice (nbs) num of byte slices.
	NumByteSlice uint64 `json:"num-byte-slice"`

	// NumUint (nui) num of uints.
	NumUint uint64 `json:"num-uint"`
}

ApplicationStateSchema specifies maximums on the number of each type that may be stored.

type ApplicationsResponse added in v1.5.0 

type ApplicationsResponse struct {
	// Applications
	Applications []Application `json:"applications"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

ApplicationsResponse

type Asset 

type Asset struct {
	// CreatedAtRound round during which this asset was created.
	CreatedAtRound uint64 `json:"created-at-round,omitempty"`

	// Deleted whether or not this asset is currently deleted.
	Deleted bool `json:"deleted,omitempty"`

	// DestroyedAtRound round during which this asset was destroyed.
	DestroyedAtRound uint64 `json:"destroyed-at-round,omitempty"`

	// Index unique asset identifier
	Index uint64 `json:"index"`

	// Params assetParams specifies the parameters for an asset.
	// (apar) when part of an AssetConfig transaction.
	// Definition:
	// data/transactions/asset.go : AssetParams
	Params AssetParams `json:"params"`
}

Asset specifies both the unique identifier and the parameters for an asset

type AssetBalancesResponse 

type AssetBalancesResponse struct {
	// Balances
	Balances []MiniAssetHolding `json:"balances"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

AssetBalancesResponse

type AssetHolding 

type AssetHolding struct {
	// Amount (a) number of units held.
	Amount uint64 `json:"amount"`

	// AssetId asset ID of the holding.
	AssetId uint64 `json:"asset-id"`

	// Deleted whether or not the asset holding is currently deleted from its account.
	Deleted bool `json:"deleted,omitempty"`

	// IsFrozen (f) whether or not the holding is frozen.
	IsFrozen bool `json:"is-frozen"`

	// OptedInAtRound round during which the account opted into this asset holding.
	OptedInAtRound uint64 `json:"opted-in-at-round,omitempty"`

	// OptedOutAtRound round during which the account opted out of this asset holding.
	OptedOutAtRound uint64 `json:"opted-out-at-round,omitempty"`
}

AssetHolding describes an asset held by an account. Definition: data/basics/userBalance.go : AssetHolding

type AssetHoldingsResponse added in v1.14.0 

type AssetHoldingsResponse struct {
	// Assets
	Assets []AssetHolding `json:"assets"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

AssetHoldingsResponse

type AssetParams 

type AssetParams struct {
	// Clawback (c) Address of account used to clawback holdings of this asset. If
	// empty, clawback is not permitted.
	Clawback string `json:"clawback,omitempty"`

	// Creator the address that created this asset. This is the address where the
	// parameters for this asset can be found, and also the address where unwanted
	// asset units can be sent in the worst case.
	Creator string `json:"creator"`

	// Decimals (dc) The number of digits to use after the decimal point when
	// displaying this asset. If 0, the asset is not divisible. If 1, the base unit of
	// the asset is in tenths. If 2, the base unit of the asset is in hundredths, and
	// so on. This value must be between 0 and 19 (inclusive).
	Decimals uint64 `json:"decimals"`

	// DefaultFrozen (df) Whether holdings of this asset are frozen by default.
	DefaultFrozen bool `json:"default-frozen,omitempty"`

	// Freeze (f) Address of account used to freeze holdings of this asset. If empty,
	// freezing is not permitted.
	Freeze string `json:"freeze,omitempty"`

	// Manager (m) Address of account used to manage the keys of this asset and to
	// destroy it.
	Manager string `json:"manager,omitempty"`

	// MetadataHash (am) A commitment to some unspecified asset metadata. The format of
	// this metadata is up to the application.
	MetadataHash []byte `json:"metadata-hash,omitempty"`

	// Name (an) Name of this asset, as supplied by the creator. Included only when the
	// asset name is composed of printable utf-8 characters.
	Name string `json:"name,omitempty"`

	// NameB64 base64 encoded name of this asset, as supplied by the creator.
	NameB64 []byte `json:"name-b64,omitempty"`

	// Reserve (r) Address of account holding reserve (non-minted) units of this asset.
	Reserve string `json:"reserve,omitempty"`

	// Total (t) The total number of units of this asset.
	Total uint64 `json:"total"`

	// UnitName (un) Name of a unit of this asset, as supplied by the creator. Included
	// only when the name of a unit of this asset is composed of printable utf-8
	// characters.
	UnitName string `json:"unit-name,omitempty"`

	// UnitNameB64 base64 encoded name of a unit of this asset, as supplied by the
	// creator.
	UnitNameB64 []byte `json:"unit-name-b64,omitempty"`

	// Url (au) URL where more information about the asset can be retrieved. Included
	// only when the URL is composed of printable utf-8 characters.
	Url string `json:"url,omitempty"`

	// UrlB64 base64 encoded URL where more information about the asset can be
	// retrieved.
	UrlB64 []byte `json:"url-b64,omitempty"`
}

AssetParams assetParams specifies the parameters for an asset. (apar) when part of an AssetConfig transaction. Definition: data/transactions/asset.go : AssetParams

type AssetResponse 

type AssetResponse struct {
	// Asset specifies both the unique identifier and the parameters for an asset
	Asset Asset `json:"asset"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`
}

AssetResponse

type AssetsResponse 

type AssetsResponse struct {
	// Assets
	Assets []Asset `json:"assets"`

	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`
}

AssetsResponse

type Block 

type Block struct {
	// GenesisHash (gh) hash to which this block belongs.
	GenesisHash []byte `json:"genesis-hash"`

	// GenesisId (gen) ID to which this block belongs.
	GenesisId string `json:"genesis-id"`

	// PreviousBlockHash (prev) Previous block hash.
	PreviousBlockHash []byte `json:"previous-block-hash"`

	// Rewards fields relating to rewards,
	Rewards BlockRewards `json:"rewards,omitempty"`

	// Round (rnd) Current round on which this block was appended to the chain.
	Round uint64 `json:"round"`

	// Seed (seed) Sortition seed.
	Seed []byte `json:"seed"`

	// Timestamp (ts) Block creation timestamp in seconds since eposh
	Timestamp uint64 `json:"timestamp"`

	// Transactions (txns) list of transactions corresponding to a given round.
	Transactions []Transaction `json:"transactions,omitempty"`

	// TransactionsRoot (txn) TransactionsRoot authenticates the set of transactions
	// appearing in the block. More specifically, it's the root of a merkle tree whose
	// leaves are the block's Txids, in lexicographic order. For the empty block, it's
	// 0. Note that the TxnRoot does not authenticate the signatures on the
	// transactions, only the transactions themselves. Two blocks with the same
	// transactions but in a different order and with different signatures will have
	// the same TxnRoot.
	TransactionsRoot []byte `json:"transactions-root"`

	// TxnCounter (tc) TxnCounter counts the number of transactions committed in the
	// ledger, from the time at which support for this feature was introduced.
	// Specifically, TxnCounter is the number of the next transaction that will be
	// committed after this block. It is 0 when no transactions have ever been
	// committed (since TxnCounter started being supported).
	TxnCounter uint64 `json:"txn-counter,omitempty"`

	// UpgradeState fields relating to a protocol upgrade.
	UpgradeState BlockUpgradeState `json:"upgrade-state,omitempty"`

	// UpgradeVote fields relating to voting for a protocol upgrade.
	UpgradeVote BlockUpgradeVote `json:"upgrade-vote,omitempty"`
}

Block block information. Definition: data/bookkeeping/block.go : Block

type BlockResponse 

type BlockResponse struct {
	// Block block header data.
	Block types.Block `json:"block"`

	// Cert optional certificate object. This is only included when the format is set
	// to message pack.
	Cert *map[string]interface{} `json:"cert,omitempty"`
}

BlockResponse encoded block object.

type BlockRewards 

type BlockRewards struct {
	// FeeSink (fees) accepts transaction fees, it can only spend to the incentive
	// pool.
	FeeSink string `json:"fee-sink"`

	// RewardsCalculationRound (rwcalr) number of leftover MicroAlgos after the
	// distribution of rewards-rate MicroAlgos for every reward unit in the next round.
	RewardsCalculationRound uint64 `json:"rewards-calculation-round"`

	// RewardsLevel (earn) How many rewards, in MicroAlgos, have been distributed to
	// each RewardUnit of MicroAlgos since genesis.
	RewardsLevel uint64 `json:"rewards-level"`

	// RewardsPool (rwd) accepts periodic injections from the fee-sink and continually
	// redistributes them as rewards.
	RewardsPool string `json:"rewards-pool"`

	// RewardsRate (rate) Number of new MicroAlgos added to the participation stake
	// from rewards at the next round.
	RewardsRate uint64 `json:"rewards-rate"`

	// RewardsResidue (frac) Number of leftover MicroAlgos after the distribution of
	// RewardsRate/rewardUnits MicroAlgos for every reward unit in the next round.
	RewardsResidue uint64 `json:"rewards-residue"`
}

BlockRewards fields relating to rewards,

type BlockUpgradeState 

type BlockUpgradeState struct {
	// CurrentProtocol (proto) The current protocol version.
	CurrentProtocol string `json:"current-protocol"`

	// NextProtocol (nextproto) The next proposed protocol version.
	NextProtocol string `json:"next-protocol,omitempty"`

	// NextProtocolApprovals (nextyes) Number of blocks which approved the protocol
	// upgrade.
	NextProtocolApprovals uint64 `json:"next-protocol-approvals,omitempty"`

	// NextProtocolSwitchOn (nextswitch) Round on which the protocol upgrade will take
	// effect.
	NextProtocolSwitchOn uint64 `json:"next-protocol-switch-on,omitempty"`

	// NextProtocolVoteBefore (nextbefore) Deadline round for this protocol upgrade (No
	// votes will be consider after this round).
	NextProtocolVoteBefore uint64 `json:"next-protocol-vote-before,omitempty"`
}

BlockUpgradeState fields relating to a protocol upgrade.

type BlockUpgradeVote 

type BlockUpgradeVote struct {
	// UpgradeApprove (upgradeyes) Indicates a yes vote for the current proposal.
	UpgradeApprove bool `json:"upgrade-approve,omitempty"`

	// UpgradeDelay (upgradedelay) Indicates the time between acceptance and execution.
	UpgradeDelay uint64 `json:"upgrade-delay,omitempty"`

	// UpgradePropose (upgradeprop) Indicates a proposed upgrade.
	UpgradePropose string `json:"upgrade-propose,omitempty"`
}

BlockUpgradeVote fields relating to voting for a protocol upgrade.

type BuildVersion added in v1.6.0 

type BuildVersion struct {
	// Branch
	Branch string `json:"branch"`

	// BuildNumber
	BuildNumber uint64 `json:"build_number"`

	// Channel
	Channel string `json:"channel"`

	// CommitHash
	CommitHash string `json:"commit_hash"`

	// Major
	Major uint64 `json:"major"`

	// Minor
	Minor uint64 `json:"minor"`
}

BuildVersion defines a model for BuildVersion.

type CatchpointAbortResponse added in v1.5.0 

type CatchpointAbortResponse struct {
	// CatchupMessage catchup abort response string
	CatchupMessage string `json:"catchup-message"`
}

CatchpointAbortResponse

type CatchpointStartResponse added in v1.5.0 

type CatchpointStartResponse struct {
	// CatchupMessage catchup start response string
	CatchupMessage string `json:"catchup-message"`
}

CatchpointStartResponse

type CompileResponse added in v1.5.0 

type CompileResponse struct {
	// Hash base32 SHA512_256 of program bytes (Address style)
	Hash string `json:"hash"`

	// Result base64 encoded program bytes
	Result string `json:"result"`

	// Sourcemap jSON of the source map
	Sourcemap *map[string]interface{} `json:"sourcemap,omitempty"`
}

CompileResponse teal compile Result

type DisassembleResponse added in v1.16.0 

type DisassembleResponse struct {
	// Result disassembled Teal code
	Result string `json:"result"`
}

DisassembleResponse teal disassembly Result

type DryrunRequest added in v1.5.0 

type DryrunRequest struct {
	// Accounts
	Accounts []Account `json:"accounts"`

	// Apps
	Apps []Application `json:"apps"`

	// LatestTimestamp latestTimestamp is available to some TEAL scripts. Defaults to
	// the latest confirmed timestamp this algod is attached to.
	LatestTimestamp uint64 `json:"latest-timestamp"`

	// ProtocolVersion protocolVersion specifies a specific version string to operate
	// under, otherwise whatever the current protocol of the network this algod is
	// running in.
	ProtocolVersion string `json:"protocol-version"`

	// Round round is available to some TEAL scripts. Defaults to the current round on
	// the network this algod is attached to.
	Round uint64 `json:"round"`

	// Sources
	Sources []DryrunSource `json:"sources"`

	// Txns
	Txns []types.SignedTxn `json:"txns"`
}

DryrunRequest request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.

type DryrunResponse added in v1.5.0 

type DryrunResponse struct {
	// Error
	Error string `json:"error"`

	// ProtocolVersion protocol version is the protocol version Dryrun was operated
	// under.
	ProtocolVersion string `json:"protocol-version"`

	// Txns
	Txns []DryrunTxnResult `json:"txns"`
}

DryrunResponse dryrunResponse contains per-txn debug information from a dryrun.

type DryrunSource added in v1.5.0 

type DryrunSource struct {
	// AppIndex
	AppIndex uint64 `json:"app-index"`

	// FieldName fieldName is what kind of sources this is. If lsig then it goes into
	// the transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
	// Approval Program or Clear State Program of application[this.AppIndex].
	FieldName string `json:"field-name"`

	// Source
	Source string `json:"source"`

	// TxnIndex
	TxnIndex uint64 `json:"txn-index"`
}

DryrunSource dryrunSource is TEAL source text that gets uploaded, compiled, and inserted into transactions or application state.

type DryrunState added in v1.5.0 

type DryrunState struct {
	// Error evaluation error if any
	Error string `json:"error,omitempty"`

	// Line line number
	Line uint64 `json:"line"`

	// Pc program counter
	Pc uint64 `json:"pc"`

	// Scratch
	Scratch []TealValue `json:"scratch,omitempty"`

	// Stack
	Stack []TealValue `json:"stack"`
}

DryrunState stores the TEAL eval step data

type DryrunTxnResult added in v1.5.0 

type DryrunTxnResult struct {
	// AppCallMessages
	AppCallMessages []string `json:"app-call-messages,omitempty"`

	// AppCallTrace
	AppCallTrace []DryrunState `json:"app-call-trace,omitempty"`

	// BudgetAdded budget added during execution of app call transaction.
	BudgetAdded uint64 `json:"budget-added,omitempty"`

	// BudgetConsumed budget consumed during execution of app call transaction.
	BudgetConsumed uint64 `json:"budget-consumed,omitempty"`

	// Cost net cost of app execution. Field is DEPRECATED and is subject for removal.
	// Instead, use `budget-added` and `budget-consumed.
	Cost uint64 `json:"cost,omitempty"`

	// Disassembly disassembled program line by line.
	Disassembly []string `json:"disassembly"`

	// GlobalDelta application state delta.
	GlobalDelta []EvalDeltaKeyValue `json:"global-delta,omitempty"`

	// LocalDeltas
	LocalDeltas []AccountStateDelta `json:"local-deltas,omitempty"`

	// LogicSigDisassembly disassembled lsig program line by line.
	LogicSigDisassembly []string `json:"logic-sig-disassembly,omitempty"`

	// LogicSigMessages
	LogicSigMessages []string `json:"logic-sig-messages,omitempty"`

	// LogicSigTrace
	LogicSigTrace []DryrunState `json:"logic-sig-trace,omitempty"`

	// Logs
	Logs [][]byte `json:"logs,omitempty"`
}

DryrunTxnResult dryrunTxnResult contains any LogicSig or ApplicationCall program debug information and state updates from a dryrun.

type ErrorResponse 

type ErrorResponse struct {
	// Data
	Data *map[string]interface{} `json:"data,omitempty"`

	// Message
	Message string `json:"message"`
}

ErrorResponse response for errors

type EvalDelta added in v1.5.0 

type EvalDelta struct {
	// Action (at) delta action.
	Action uint64 `json:"action"`

	// Bytes (bs) bytes value.
	Bytes string `json:"bytes,omitempty"`

	// Uint (ui) uint value.
	Uint uint64 `json:"uint,omitempty"`
}

EvalDelta represents a TEAL value delta.

type EvalDeltaKeyValue added in v1.5.0 

type EvalDeltaKeyValue struct {
	// Key
	Key string `json:"key"`

	// Value represents a TEAL value delta.
	Value EvalDelta `json:"value"`
}

EvalDeltaKeyValue key-value pairs for StateDelta.

type HealthCheck 

type HealthCheck struct {
	// Data
	Data *map[string]interface{} `json:"data,omitempty"`

	// DbAvailable
	DbAvailable bool `json:"db-available"`

	// Errors
	Errors []string `json:"errors,omitempty"`

	// IsMigrating
	IsMigrating bool `json:"is-migrating"`

	// Message
	Message string `json:"message"`

	// Round
	Round uint64 `json:"round"`

	// Version current version.
	Version string `json:"version"`
}

HealthCheck a health check response.

type HealthCheckResponse 

type HealthCheckResponse HealthCheck

HealthCheckResponse defines model for HealthCheckResponse.

type MiniAssetHolding 

type MiniAssetHolding struct {
	// Address
	Address string `json:"address"`

	// Amount
	Amount uint64 `json:"amount"`

	// Deleted whether or not this asset holding is currently deleted from its account.
	Deleted bool `json:"deleted,omitempty"`

	// IsFrozen
	IsFrozen bool `json:"is-frozen"`

	// OptedInAtRound round during which the account opted into the asset.
	OptedInAtRound uint64 `json:"opted-in-at-round,omitempty"`

	// OptedOutAtRound round during which the account opted out of the asset.
	OptedOutAtRound uint64 `json:"opted-out-at-round,omitempty"`
}

MiniAssetHolding a simplified version of AssetHolding

type NodeStatus 

type NodeStatus NodeStatusResponse

NodeStatus is the algod status report.

type NodeStatusResponse added in v1.6.0 

type NodeStatusResponse struct {
	// Catchpoint the current catchpoint that is being caught up to
	Catchpoint string `json:"catchpoint,omitempty"`

	// CatchpointAcquiredBlocks the number of blocks that have already been obtained by
	// the node as part of the catchup
	CatchpointAcquiredBlocks uint64 `json:"catchpoint-acquired-blocks,omitempty"`

	// CatchpointProcessedAccounts the number of accounts from the current catchpoint
	// that have been processed so far as part of the catchup
	CatchpointProcessedAccounts uint64 `json:"catchpoint-processed-accounts,omitempty"`

	// CatchpointTotalAccounts the total number of accounts included in the current
	// catchpoint
	CatchpointTotalAccounts uint64 `json:"catchpoint-total-accounts,omitempty"`

	// CatchpointTotalBlocks the total number of blocks that are required to complete
	// the current catchpoint catchup
	CatchpointTotalBlocks uint64 `json:"catchpoint-total-blocks,omitempty"`

	// CatchpointVerifiedAccounts the number of accounts from the current catchpoint
	// that have been verified so far as part of the catchup
	CatchpointVerifiedAccounts uint64 `json:"catchpoint-verified-accounts,omitempty"`

	// CatchupTime catchupTime in nanoseconds
	CatchupTime uint64 `json:"catchup-time"`

	// LastCatchpoint the last catchpoint seen by the node
	LastCatchpoint string `json:"last-catchpoint,omitempty"`

	// LastRound lastRound indicates the last round seen
	LastRound uint64 `json:"last-round"`

	// LastVersion lastVersion indicates the last consensus version supported
	LastVersion string `json:"last-version"`

	// NextVersion nextVersion of consensus protocol to use
	NextVersion string `json:"next-version"`

	// NextVersionRound nextVersionRound is the round at which the next consensus
	// version will apply
	NextVersionRound uint64 `json:"next-version-round"`

	// NextVersionSupported nextVersionSupported indicates whether the next consensus
	// version is supported by this node
	NextVersionSupported bool `json:"next-version-supported"`

	// StoppedAtUnsupportedRound stoppedAtUnsupportedRound indicates that the node does
	// not support the new rounds and has stopped making progress
	StoppedAtUnsupportedRound bool `json:"stopped-at-unsupported-round"`

	// TimeSinceLastRound timeSinceLastRound in nanoseconds
	TimeSinceLastRound uint64 `json:"time-since-last-round"`
}

NodeStatusResponse

type PendingTransactionInfoResponse 

type PendingTransactionInfoResponse PendingTransactionResponse

PendingTransactionInfoResponse is the single pending transaction response.

type PendingTransactionResponse added in v1.6.0 

type PendingTransactionResponse struct {
	// ApplicationIndex the application index if the transaction was found and it
	// created an application.
	ApplicationIndex uint64 `json:"application-index,omitempty"`

	// AssetClosingAmount the number of the asset's unit that were transferred to the
	// close-to address.
	AssetClosingAmount uint64 `json:"asset-closing-amount,omitempty"`

	// AssetIndex the asset index if the transaction was found and it created an asset.
	AssetIndex uint64 `json:"asset-index,omitempty"`

	// CloseRewards rewards in microalgos applied to the close remainder to account.
	CloseRewards uint64 `json:"close-rewards,omitempty"`

	// ClosingAmount closing amount for the transaction.
	ClosingAmount uint64 `json:"closing-amount,omitempty"`

	// ConfirmedRound the round where this transaction was confirmed, if present.
	ConfirmedRound uint64 `json:"confirmed-round,omitempty"`

	// GlobalStateDelta (gd) Global state key/value changes for the application being
	// executed by this transaction.
	GlobalStateDelta []EvalDeltaKeyValue `json:"global-state-delta,omitempty"`

	// InnerTxns inner transactions produced by application execution.
	InnerTxns []PendingTransactionResponse `json:"inner-txns,omitempty"`

	// LocalStateDelta (ld) Local state key/value changes for the application being
	// executed by this transaction.
	LocalStateDelta []AccountStateDelta `json:"local-state-delta,omitempty"`

	// Logs (lg) Logs for the application being executed by this transaction.
	Logs [][]byte `json:"logs,omitempty"`

	// PoolError indicates that the transaction was kicked out of this node's
	// transaction pool (and specifies why that happened). An empty string indicates
	// the transaction wasn't kicked out of this node's txpool due to an error.
	PoolError string `json:"pool-error"`

	// ReceiverRewards rewards in microalgos applied to the receiver account.
	ReceiverRewards uint64 `json:"receiver-rewards,omitempty"`

	// SenderRewards rewards in microalgos applied to the sender account.
	SenderRewards uint64 `json:"sender-rewards,omitempty"`

	// Transaction the raw signed transaction.
	Transaction types.SignedTxn `json:"txn"`
}

PendingTransactionResponse details about a pending transaction. If the transaction was recently confirmed, includes confirmation details like the round and reward details.

type PendingTransactionsResponse 

type PendingTransactionsResponse struct {
	// TopTransactions an array of signed transaction objects.
	TopTransactions []types.SignedTxn `json:"top-transactions"`

	// TotalTransactions total number of transactions in the pool.
	TotalTransactions uint64 `json:"total-transactions"`
}

PendingTransactionsResponse 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**.

type PostTransactionsResponse added in v1.6.0 

type PostTransactionsResponse struct {
	// Txid encoding of the transaction hash.
	Txid string `json:"txId"`
}

PostTransactionsResponse transaction ID of the submission.

type ProofResponse added in v1.6.0 

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

	// Idx index of the transaction in the block's payset.
	Idx uint64 `json:"idx"`

	// Proof merkle proof of transaction membership.
	Proof []byte `json:"proof"`

	// Stibhash hash of SignedTxnInBlock for verifying proof.
	Stibhash []byte `json:"stibhash"`

	// Treedepth represents the depth of the tree that is being proven, i.e. the number
	// of edges from a leaf to the root.
	Treedepth uint64 `json:"treedepth"`
}

ProofResponse proof of transaction in a block.

type StateSchema added in v1.5.0 

type StateSchema struct {
	// NumByteSlice maximum number of TEAL byte slices that may be stored in the
	// key/value store.
	NumByteSlice uint64 `json:"num-byte-slice"`

	// NumUint maximum number of TEAL uints that may be stored in the key/value store.
	NumUint uint64 `json:"num-uint"`
}

StateSchema represents a (apls) local-state or (apgs) global-state schema. These schemas determine how much storage may be used in a local-state or global-state for an application. The more space used, the larger minimum balance must be maintained in the account holding the data.

type Supply 

type Supply SupplyResponse

Supply

type SupplyResponse added in v1.6.0 

type SupplyResponse struct {
	// Current_round round
	Current_round uint64 `json:"current_round"`

	// OnlineMoney onlineMoney
	OnlineMoney uint64 `json:"online-money"`

	// TotalMoney totalMoney
	TotalMoney uint64 `json:"total-money"`
}

SupplyResponse supply represents the current supply of MicroAlgos in the system.

type TealKeyValue added in v1.5.0 

type TealKeyValue struct {
	// Key
	Key string `json:"key"`

	// Value represents a TEAL value.
	Value TealValue `json:"value"`
}

TealKeyValue represents a key-value pair in an application store.

type TealValue added in v1.5.0 

type TealValue struct {
	// Bytes (tb) bytes value.
	Bytes string `json:"bytes"`

	// Type (tt) value type. Value `1` refers to **bytes**, value `2` refers to
	// **uint**
	Type uint64 `json:"type"`

	// Uint (ui) uint value.
	Uint uint64 `json:"uint"`
}

TealValue represents a TEAL value.

type Transaction 

type Transaction struct {
	// ApplicationTransaction fields for application transactions.
	// Definition:
	// data/transactions/application.go : ApplicationCallTxnFields
	ApplicationTransaction TransactionApplication `json:"application-transaction,omitempty"`

	// AssetConfigTransaction fields for asset allocation, re-configuration, and
	// destruction.
	// A zero value for asset-id indicates asset creation.
	// A zero value for the params indicates asset destruction.
	// Definition:
	// data/transactions/asset.go : AssetConfigTxnFields
	AssetConfigTransaction TransactionAssetConfig `json:"asset-config-transaction,omitempty"`

	// AssetFreezeTransaction fields for an asset freeze transaction.
	// Definition:
	// data/transactions/asset.go : AssetFreezeTxnFields
	AssetFreezeTransaction TransactionAssetFreeze `json:"asset-freeze-transaction,omitempty"`

	// AssetTransferTransaction fields for an asset transfer transaction.
	// Definition:
	// data/transactions/asset.go : AssetTransferTxnFields
	AssetTransferTransaction TransactionAssetTransfer `json:"asset-transfer-transaction,omitempty"`

	// AuthAddr (sgnr) this is included with signed transactions when the signing
	// address does not equal the sender. The backend can use this to ensure that auth
	// addr is equal to the accounts auth addr.
	AuthAddr string `json:"auth-addr,omitempty"`

	// CloseRewards (rc) rewards applied to close-remainder-to account.
	CloseRewards uint64 `json:"close-rewards,omitempty"`

	// ClosingAmount (ca) closing amount for transaction.
	ClosingAmount uint64 `json:"closing-amount,omitempty"`

	// ConfirmedRound round when the transaction was confirmed.
	ConfirmedRound uint64 `json:"confirmed-round,omitempty"`

	// CreatedApplicationIndex specifies an application index (ID) if an application
	// was created with this transaction.
	CreatedApplicationIndex uint64 `json:"created-application-index,omitempty"`

	// CreatedAssetIndex specifies an asset index (ID) if an asset was created with
	// this transaction.
	CreatedAssetIndex uint64 `json:"created-asset-index,omitempty"`

	// Fee (fee) Transaction fee.
	Fee uint64 `json:"fee"`

	// FirstValid (fv) First valid round for this transaction.
	FirstValid uint64 `json:"first-valid"`

	// GenesisHash (gh) Hash of genesis block.
	GenesisHash []byte `json:"genesis-hash,omitempty"`

	// GenesisId (gen) genesis block ID.
	GenesisId string `json:"genesis-id,omitempty"`

	// GlobalStateDelta (gd) Global state key/value changes for the application being
	// executed by this transaction.
	GlobalStateDelta []EvalDeltaKeyValue `json:"global-state-delta,omitempty"`

	// Group (grp) Base64 encoded byte array of a sha512/256 digest. When present
	// indicates that this transaction is part of a transaction group and the value is
	// the sha512/256 hash of the transactions in that group.
	Group []byte `json:"group,omitempty"`

	// Id transaction ID
	Id string `json:"id,omitempty"`

	// InnerTxns inner transactions produced by application execution.
	InnerTxns []Transaction `json:"inner-txns,omitempty"`

	// IntraRoundOffset offset into the round where this transaction was confirmed.
	IntraRoundOffset uint64 `json:"intra-round-offset,omitempty"`

	// KeyregTransaction fields for a keyreg transaction.
	// Definition:
	// data/transactions/keyreg.go : KeyregTxnFields
	KeyregTransaction TransactionKeyreg `json:"keyreg-transaction,omitempty"`

	// LastValid (lv) Last valid round for this transaction.
	LastValid uint64 `json:"last-valid"`

	// Lease (lx) Base64 encoded 32-byte array. Lease enforces mutual exclusion of
	// transactions. If this field is nonzero, then once the transaction is confirmed,
	// it acquires the lease identified by the (Sender, Lease) pair of the transaction
	// until the LastValid round passes. While this transaction possesses the lease, no
	// other transaction specifying this lease can be confirmed.
	Lease []byte `json:"lease,omitempty"`

	// LocalStateDelta (ld) Local state key/value changes for the application being
	// executed by this transaction.
	LocalStateDelta []AccountStateDelta `json:"local-state-delta,omitempty"`

	// Logs (lg) Logs for the application being executed by this transaction.
	Logs [][]byte `json:"logs,omitempty"`

	// Note (note) Free form data.
	Note []byte `json:"note,omitempty"`

	// PaymentTransaction fields for a payment transaction.
	// Definition:
	// data/transactions/payment.go : PaymentTxnFields
	PaymentTransaction TransactionPayment `json:"payment-transaction,omitempty"`

	// ReceiverRewards (rr) rewards applied to receiver account.
	ReceiverRewards uint64 `json:"receiver-rewards,omitempty"`

	// RekeyTo (rekey) when included in a valid transaction, the accounts auth addr
	// will be updated with this value and future signatures must be signed with the
	// key represented by this address.
	RekeyTo string `json:"rekey-to,omitempty"`

	// RoundTime time when the block this transaction is in was confirmed.
	RoundTime uint64 `json:"round-time,omitempty"`

	// Sender (snd) Sender's address.
	Sender string `json:"sender"`

	// SenderRewards (rs) rewards applied to sender account.
	SenderRewards uint64 `json:"sender-rewards,omitempty"`

	// Signature validation signature associated with some data. Only one of the
	// signatures should be provided.
	Signature TransactionSignature `json:"signature,omitempty"`

	// Type (type) Indicates what type of transaction this is. Different types have
	// different fields.
	// Valid types, and where their fields are stored:
	// * (pay) payment-transaction
	// * (keyreg) keyreg-transaction
	// * (acfg) asset-config-transaction
	// * (axfer) asset-transfer-transaction
	// * (afrz) asset-freeze-transaction
	// * (appl) application-transaction
	Type string `json:"tx-type,omitempty"`
}

Transaction contains all fields common to all transactions and serves as an envelope to all transactions type. Represents both regular and inner transactions. Definition: data/transactions/signedtxn.go : SignedTxn data/transactions/transaction.go : Transaction

type TransactionApplication added in v1.5.0 

type TransactionApplication struct {
	// Accounts (apat) List of accounts in addition to the sender that may be accessed
	// from the application's approval-program and clear-state-program.
	Accounts []string `json:"accounts,omitempty"`

	// ApplicationArgs (apaa) transaction specific arguments accessed from the
	// application's approval-program and clear-state-program.
	ApplicationArgs [][]byte `json:"application-args,omitempty"`

	// ApplicationId (apid) ID of the application being configured or empty if
	// creating.
	ApplicationId uint64 `json:"application-id"`

	// ApprovalProgram (apap) Logic executed for every application transaction, except
	// when on-completion is set to "clear". It can read and write global state for the
	// application, as well as account-specific local state. Approval programs may
	// reject the transaction.
	ApprovalProgram []byte `json:"approval-program,omitempty"`

	// ClearStateProgram (apsu) Logic executed for application transactions with
	// on-completion set to "clear". It can read and write global state for the
	// application, as well as account-specific local state. Clear state programs
	// cannot reject the transaction.
	ClearStateProgram []byte `json:"clear-state-program,omitempty"`

	// ExtraProgramPages (epp) specifies the additional app program len requested in
	// pages.
	ExtraProgramPages uint64 `json:"extra-program-pages,omitempty"`

	// ForeignApps (apfa) Lists the applications in addition to the application-id
	// whose global states may be accessed by this application's approval-program and
	// clear-state-program. The access is read-only.
	ForeignApps []uint64 `json:"foreign-apps,omitempty"`

	// ForeignAssets (apas) lists the assets whose parameters may be accessed by this
	// application's ApprovalProgram and ClearStateProgram. The access is read-only.
	ForeignAssets []uint64 `json:"foreign-assets,omitempty"`

	// GlobalStateSchema represents a (apls) local-state or (apgs) global-state schema.
	// These schemas determine how much storage may be used in a local-state or
	// global-state for an application. The more space used, the larger minimum balance
	// must be maintained in the account holding the data.
	GlobalStateSchema StateSchema `json:"global-state-schema,omitempty"`

	// LocalStateSchema represents a (apls) local-state or (apgs) global-state schema.
	// These schemas determine how much storage may be used in a local-state or
	// global-state for an application. The more space used, the larger minimum balance
	// must be maintained in the account holding the data.
	LocalStateSchema StateSchema `json:"local-state-schema,omitempty"`

	// OnCompletion (apan) defines the what additional actions occur with the
	// transaction.
	// Valid types:
	// * noop
	// * optin
	// * closeout
	// * clear
	// * update
	// * update
	// * delete
	OnCompletion string `json:"on-completion,omitempty"`
}

TransactionApplication fields for application transactions. Definition: data/transactions/application.go : ApplicationCallTxnFields

type TransactionAssetConfig 

type TransactionAssetConfig struct {
	// AssetId (xaid) ID of the asset being configured or empty if creating.
	AssetId uint64 `json:"asset-id,omitempty"`

	// Params assetParams specifies the parameters for an asset.
	// (apar) when part of an AssetConfig transaction.
	// Definition:
	// data/transactions/asset.go : AssetParams
	Params AssetParams `json:"params,omitempty"`
}

TransactionAssetConfig fields for asset allocation, re-configuration, and destruction. A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction. Definition: data/transactions/asset.go : AssetConfigTxnFields

type TransactionAssetFreeze 

type TransactionAssetFreeze struct {
	// Address (fadd) Address of the account whose asset is being frozen or thawed.
	Address string `json:"address"`

	// AssetId (faid) ID of the asset being frozen or thawed.
	AssetId uint64 `json:"asset-id"`

	// NewFreezeStatus (afrz) The new freeze status.
	NewFreezeStatus bool `json:"new-freeze-status"`
}

TransactionAssetFreeze fields for an asset freeze transaction. Definition: data/transactions/asset.go : AssetFreezeTxnFields

type TransactionAssetTransfer 

type TransactionAssetTransfer struct {
	// Amount (aamt) Amount of asset to transfer. A zero amount transferred to self
	// allocates that asset in the account's Assets map.
	Amount uint64 `json:"amount"`

	// AssetId (xaid) ID of the asset being transferred.
	AssetId uint64 `json:"asset-id"`

	// CloseAmount number of assets transfered to the close-to account as part of the
	// transaction.
	CloseAmount uint64 `json:"close-amount,omitempty"`

	// CloseTo (aclose) Indicates that the asset should be removed from the account's
	// Assets map, and specifies where the remaining asset holdings should be
	// transferred. It's always valid to transfer remaining asset holdings to the
	// creator account.
	CloseTo string `json:"close-to,omitempty"`

	// Receiver (arcv) Recipient address of the transfer.
	Receiver string `json:"receiver"`

	// Sender (asnd) The effective sender during a clawback transactions. If this is
	// not a zero value, the real transaction sender must be the Clawback address from
	// the AssetParams.
	Sender string `json:"sender,omitempty"`
}

TransactionAssetTransfer fields for an asset transfer transaction. Definition: data/transactions/asset.go : AssetTransferTxnFields

type TransactionKeyreg 

type TransactionKeyreg struct {
	// NonParticipation (nonpart) Mark the account as participating or
	// non-participating.
	NonParticipation bool `json:"non-participation,omitempty"`

	// SelectionParticipationKey (selkey) Public key used with the Verified Random
	// Function (VRF) result during committee selection.
	SelectionParticipationKey []byte `json:"selection-participation-key,omitempty"`

	// StateProofKey (sprfkey) State proof key used in key registration transactions.
	StateProofKey []byte `json:"state-proof-key,omitempty"`

	// VoteFirstValid (votefst) First round this participation key is valid.
	VoteFirstValid uint64 `json:"vote-first-valid,omitempty"`

	// VoteKeyDilution (votekd) Number of subkeys in each batch of participation keys.
	VoteKeyDilution uint64 `json:"vote-key-dilution,omitempty"`

	// VoteLastValid (votelst) Last round this participation key is valid.
	VoteLastValid uint64 `json:"vote-last-valid,omitempty"`

	// VoteParticipationKey (votekey) Participation public key used in key registration
	// transactions.
	VoteParticipationKey []byte `json:"vote-participation-key,omitempty"`
}

TransactionKeyreg fields for a keyreg transaction. Definition: data/transactions/keyreg.go : KeyregTxnFields

type TransactionParametersResponse added in v1.6.0 

type TransactionParametersResponse struct {
	// ConsensusVersion consensusVersion indicates the consensus protocol version
	// as of LastRound.
	ConsensusVersion string `json:"consensus-version"`

	// Fee fee is the suggested transaction fee
	// Fee is in units of micro-Algos per byte.
	// Fee may fall to zero but transactions must still have a fee of
	// at least MinTxnFee for the current network protocol.
	Fee uint64 `json:"fee"`

	// GenesisHash genesisHash is the hash of the genesis block.
	GenesisHash []byte `json:"genesis-hash"`

	// GenesisId genesisID is an ID listed in the genesis block.
	GenesisId string `json:"genesis-id"`

	// LastRound lastRound indicates the last round seen
	LastRound uint64 `json:"last-round"`

	// MinFee the minimum transaction fee (not per byte) required for the
	// txn to validate for the current network protocol.
	MinFee uint64 `json:"min-fee"`
}

TransactionParametersResponse transactionParams contains the parameters that help a client construct a new transaction.

type TransactionPayment 

type TransactionPayment struct {
	// Amount (amt) number of MicroAlgos intended to be transferred.
	Amount uint64 `json:"amount"`

	// CloseAmount number of MicroAlgos that were sent to the close-remainder-to
	// address when closing the sender account.
	CloseAmount uint64 `json:"close-amount,omitempty"`

	// CloseRemainderTo (close) when set, indicates that the sending account should be
	// closed and all remaining funds be transferred to this address.
	CloseRemainderTo string `json:"close-remainder-to,omitempty"`

	// Receiver (rcv) receiver's address.
	Receiver string `json:"receiver"`
}

TransactionPayment fields for a payment transaction. Definition: data/transactions/payment.go : PaymentTxnFields

type TransactionResponse added in v1.6.0 

type TransactionResponse struct {
	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// Transaction contains all fields common to all transactions and serves as an
	// envelope to all transactions type. Represents both regular and inner
	// transactions.
	// Definition:
	// data/transactions/signedtxn.go : SignedTxn
	// data/transactions/transaction.go : Transaction
	Transaction Transaction `json:"transaction"`
}

TransactionResponse

type TransactionSignature 

type TransactionSignature struct {
	// Logicsig (lsig) Programatic transaction signature.
	// Definition:
	// data/transactions/logicsig.go
	Logicsig TransactionSignatureLogicsig `json:"logicsig,omitempty"`

	// Multisig (msig) structure holding multiple subsignatures.
	// Definition:
	// crypto/multisig.go : MultisigSig
	Multisig TransactionSignatureMultisig `json:"multisig,omitempty"`

	// Sig (sig) Standard ed25519 signature.
	Sig []byte `json:"sig,omitempty"`
}

TransactionSignature validation signature associated with some data. Only one of the signatures should be provided.

type TransactionSignatureLogicsig 

type TransactionSignatureLogicsig struct {
	// Args (arg) Logic arguments, base64 encoded.
	Args [][]byte `json:"args,omitempty"`

	// Logic (l) Program signed by a signature or multi signature, or hashed to be the
	// address of ana ccount. Base64 encoded TEAL program.
	Logic []byte `json:"logic"`

	// MultisigSignature (msig) structure holding multiple subsignatures.
	// Definition:
	// crypto/multisig.go : MultisigSig
	MultisigSignature TransactionSignatureMultisig `json:"multisig-signature,omitempty"`

	// Signature (sig) ed25519 signature.
	Signature []byte `json:"signature,omitempty"`
}

TransactionSignatureLogicsig (lsig) Programatic transaction signature. Definition: data/transactions/logicsig.go

type TransactionSignatureMultisig 

type TransactionSignatureMultisig struct {
	// Subsignature (subsig) holds pairs of public key and signatures.
	Subsignature []TransactionSignatureMultisigSubsignature `json:"subsignature,omitempty"`

	// Threshold (thr)
	Threshold uint64 `json:"threshold,omitempty"`

	// Version (v)
	Version uint64 `json:"version,omitempty"`
}

TransactionSignatureMultisig (msig) structure holding multiple subsignatures. Definition: crypto/multisig.go : MultisigSig

type TransactionSignatureMultisigSubsignature 

type TransactionSignatureMultisigSubsignature struct {
	// PublicKey (pk)
	PublicKey []byte `json:"public-key,omitempty"`

	// Signature (s)
	Signature []byte `json:"signature,omitempty"`
}

TransactionSignatureMultisigSubsignature defines a model for TransactionSignatureMultisigSubsignature.

type TransactionsResponse 

type TransactionsResponse struct {
	// CurrentRound round at which the results were computed.
	CurrentRound uint64 `json:"current-round"`

	// NextToken used for pagination, when making another request provide this token
	// with the next parameter.
	NextToken string `json:"next-token,omitempty"`

	// Transactions
	Transactions []Transaction `json:"transactions"`
}

TransactionsResponse

type Version 

type Version struct {
	// Build
	Build BuildVersion `json:"build"`

	// GenesisHash
	GenesisHash []byte `json:"genesis_hash_b64"`

	// GenesisID
	GenesisID string `json:"genesis_id"`

	// Versions
	Versions []string `json:"versions"`
}

Version algod version information.

type VersionBuild 

type VersionBuild BuildVersion

VersionBuild

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.