model

package
v0.0.0-...-5bffa0e Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2025 License: AGPL-3.0 Imports: 3 Imported by: 1

Documentation

Overview

Package model provides primitives to interact with the openapi HTTP API.

Code generated by github.com/algorand/oapi-codegen DO NOT EDIT.

Index

Constants

View Source 
const (
	Api_keyScopes = "api_key.Scopes"
)

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 Specifies maximums on the number of each type that may be stored.
	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"`

	// 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"`

	// IncentiveEligible Whether or not the account can receive block incentives if its balance is in range at proposal time.
	IncentiveEligible *bool `json:"incentive-eligible,omitempty"`

	// LastHeartbeat The round in which this account last went online, or explicitly renewed their online status.
	LastHeartbeat *uint64 `json:"last-heartbeat,omitempty"`

	// LastProposed The round in which this account last proposed the block.
	LastProposed *uint64 `json:"last-proposed,omitempty"`

	// MinBalance MicroAlgo balance required by the account.
	//
	// The requirement grows based on asset and application usage.
	MinBalance uint64 `json:"min-balance"`

	// 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
	SigType *AccountSigType `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"`

	// TotalBoxBytes \[tbxb\] The total number of bytes used by this account's app's box keys and values.
	TotalBoxBytes *uint64 `json:"total-box-bytes,omitempty"`

	// TotalBoxes \[tbx\] The number of existing boxes created by this account's app.
	TotalBoxes *uint64 `json:"total-boxes,omitempty"`

	// 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 AccountApplicationInformationParams 

type AccountApplicationInformationParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *AccountApplicationInformationParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

AccountApplicationInformationParams defines parameters for AccountApplicationInformation.

type AccountApplicationInformationParamsFormat 

type AccountApplicationInformationParamsFormat string

AccountApplicationInformationParamsFormat defines parameters for AccountApplicationInformation. 

const (
	AccountApplicationInformationParamsFormatJson    AccountApplicationInformationParamsFormat = "json"
	AccountApplicationInformationParamsFormatMsgpack AccountApplicationInformationParamsFormat = "msgpack"
)

Defines values for AccountApplicationInformationParamsFormat.

type AccountApplicationResponse 

type AccountApplicationResponse struct {
	// AppLocalState Stores local state associated with an application.
	AppLocalState *ApplicationLocalState `json:"app-local-state,omitempty"`

	// CreatedApp Stores the global information associated with an application.
	CreatedApp *ApplicationParams `json:"created-app,omitempty"`

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

AccountApplicationResponse defines model for AccountApplicationResponse.

type AccountAssetHolding 

type AccountAssetHolding struct {
	// AssetHolding Describes an asset held by an account.
	//
	// Definition:
	// data/basics/userBalance.go : AssetHolding
	AssetHolding AssetHolding `json:"asset-holding"`

	// AssetParams AssetParams specifies the parameters for an asset.
	//
	// \[apar\] when part of an AssetConfig transaction.
	//
	// Definition:
	// data/transactions/asset.go : AssetParams
	AssetParams *AssetParams `json:"asset-params,omitempty"`
}

AccountAssetHolding AccountAssetHolding describes the account's asset holding and asset parameters (if either exist) for a specific asset ID.

type AccountAssetInformationParams 

type AccountAssetInformationParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *AccountAssetInformationParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

AccountAssetInformationParams defines parameters for AccountAssetInformation.

type AccountAssetInformationParamsFormat 

type AccountAssetInformationParamsFormat string

AccountAssetInformationParamsFormat defines parameters for AccountAssetInformation. 

const (
	AccountAssetInformationParamsFormatJson    AccountAssetInformationParamsFormat = "json"
	AccountAssetInformationParamsFormatMsgpack AccountAssetInformationParamsFormat = "msgpack"
)

Defines values for AccountAssetInformationParamsFormat.

type AccountAssetResponse 

type AccountAssetResponse struct {
	// AssetHolding Describes an asset held by an account.
	//
	// Definition:
	// data/basics/userBalance.go : AssetHolding
	AssetHolding *AssetHolding `json:"asset-holding,omitempty"`

	// CreatedAsset AssetParams specifies the parameters for an asset.
	//
	// \[apar\] when part of an AssetConfig transaction.
	//
	// Definition:
	// data/transactions/asset.go : AssetParams
	CreatedAsset *AssetParams `json:"created-asset,omitempty"`

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

AccountAssetResponse defines model for AccountAssetResponse.

type AccountAssetsInformationParams 

type AccountAssetsInformationParams struct {
	// Limit Maximum number of results to return.
	Limit *uint64 `form:"limit,omitempty" json:"limit,omitempty"`

	// Next The next page of results. Use the next token provided by the previous results.
	Next *string `form:"next,omitempty" json:"next,omitempty"`
}

AccountAssetsInformationParams defines parameters for AccountAssetsInformation.

type AccountAssetsInformationResponse 

type AccountAssetsInformationResponse struct {
	AssetHoldings *[]AccountAssetHolding `json:"asset-holdings,omitempty"`

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

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

AccountAssetsInformationResponse defines model for AccountAssetsInformationResponse.

type AccountID 

type AccountID = string

AccountID defines model for account-id.

type AccountInformationParams 

type AccountInformationParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *AccountInformationParamsFormat `form:"format,omitempty" json:"format,omitempty"`

	// Exclude When set to `all` will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to `none`.
	Exclude *AccountInformationParamsExclude `form:"exclude,omitempty" json:"exclude,omitempty"`
}

AccountInformationParams defines parameters for AccountInformation.

type AccountInformationParamsExclude 

type AccountInformationParamsExclude string

AccountInformationParamsExclude defines parameters for AccountInformation. 

const (
	AccountInformationParamsExcludeAll  AccountInformationParamsExclude = "all"
	AccountInformationParamsExcludeNone AccountInformationParamsExclude = "none"
)

Defines values for AccountInformationParamsExclude.

type AccountInformationParamsFormat 

type AccountInformationParamsFormat string

AccountInformationParamsFormat defines parameters for AccountInformation. 

const (
	AccountInformationParamsFormatJson    AccountInformationParamsFormat = "json"
	AccountInformationParamsFormatMsgpack AccountInformationParamsFormat = "msgpack"
)

Defines values for AccountInformationParamsFormat.

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 = Account

AccountResponse Account information at a given round.

Definition: data/basics/userBalance.go : AccountData

type AccountSigType 

type AccountSigType string

AccountSigType Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig 

const (
	AccountSigTypeLsig AccountSigType = "lsig"
	AccountSigTypeMsig AccountSigType = "msig"
	AccountSigTypeSig  AccountSigType = "sig"
)

Defines values for AccountSigType.

type AccountStateDelta 

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

	// Delta Application state delta.
	Delta StateDelta `json:"delta"`
}

AccountStateDelta Application state delta.

type Address 

type Address = string

Address defines model for address.

type AddressRole 

type AddressRole string

AddressRole defines model for address-role. 

const (
	AddressRoleFreezeTarget AddressRole = "freeze-target"
	AddressRoleReceiver     AddressRole = "receiver"
	AddressRoleSender       AddressRole = "sender"
)

Defines values for AddressRole.

type AfterTime 

type AfterTime = time.Time

AfterTime defines model for after-time.

type AppCallLogs 

type AppCallLogs struct {
	// ApplicationIndex The application from which the logs were generated
	ApplicationIndex uint64 `json:"application-index"`

	// Logs An array of logs
	Logs [][]byte `json:"logs"`

	// TxId The transaction ID of the outer app call that lead to these logs
	TxId string `json:"txId"`
}

AppCallLogs The logged messages from an app call along with the app ID and outer transaction ID. Logs appear in the same order that they were emitted.

type Application 

type Application struct {
	// Id \[appidx\] application index.
	Id uint64 `json:"id"`

	// Params Stores the global information associated with an application.
	Params ApplicationParams `json:"params"`
}

Application Application index and its parameters

type ApplicationInitialStates 

type ApplicationInitialStates struct {
	// AppBoxes An application's global/local/box state.
	AppBoxes *ApplicationKVStorage `json:"app-boxes,omitempty"`

	// AppGlobals An application's global/local/box state.
	AppGlobals *ApplicationKVStorage `json:"app-globals,omitempty"`

	// AppLocals An application's initial local states tied to different accounts.
	AppLocals *[]ApplicationKVStorage `json:"app-locals,omitempty"`

	// Id Application index.
	Id uint64 `json:"id"`
}

ApplicationInitialStates An application's initial global/local/box states that were accessed during simulation.

type ApplicationKVStorage 

type ApplicationKVStorage struct {
	// Account The address of the account associated with the local state.
	Account *string `json:"account,omitempty"`

	// Kvs Key-Value pairs representing application states.
	Kvs []AvmKeyValue `json:"kvs"`
}

ApplicationKVStorage An application's global/local/box state.

type ApplicationLocalReference 

type ApplicationLocalReference struct {
	// Account Address of the account with the local state.
	Account string `json:"account"`

	// App Application ID of the local state application.
	App uint64 `json:"app"`
}

ApplicationLocalReference References an account's local state for an application.

type ApplicationLocalState 

type ApplicationLocalState struct {
	// Id The application which this local state is for.
	Id uint64 `json:"id"`

	// KeyValue Represents a key-value store for use in an application.
	KeyValue *TealKeyValueStore `json:"key-value,omitempty"`

	// Schema Specifies maximums on the number of each type that may be stored.
	Schema ApplicationStateSchema `json:"schema"`
}

ApplicationLocalState Stores local state associated with an application.

type ApplicationParams 

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"`

	// ExtraProgramPages \[epp\] the amount of extra program pages available to this app.
	ExtraProgramPages *uint64 `json:"extra-program-pages,omitempty"`

	// GlobalState Represents a key-value store for use in an application.
	GlobalState *TealKeyValueStore `json:"global-state,omitempty"`

	// GlobalStateSchema Specifies maximums on the number of each type that may be stored.
	GlobalStateSchema *ApplicationStateSchema `json:"global-state-schema,omitempty"`

	// LocalStateSchema Specifies maximums on the number of each type that may be stored.
	LocalStateSchema *ApplicationStateSchema `json:"local-state-schema,omitempty"`
}

ApplicationParams Stores the global information associated with an application.

type ApplicationResponse 

type ApplicationResponse = Application

ApplicationResponse Application index and its parameters

type ApplicationStateOperation 

type ApplicationStateOperation struct {
	// Account For local state changes, the address of the account associated with the local state.
	Account *string `json:"account,omitempty"`

	// AppStateType Type of application state. Value `g` is **global state**, `l` is **local state**, `b` is **boxes**.
	AppStateType string `json:"app-state-type"`

	// Key The key (name) of the global/local/box state.
	Key []byte `json:"key"`

	// NewValue Represents an AVM value.
	NewValue *AvmValue `json:"new-value,omitempty"`

	// Operation Operation type. Value `w` is **write**, `d` is **delete**.
	Operation string `json:"operation"`
}

ApplicationStateOperation An operation against an application's global/local/box state.

type ApplicationStateSchema 

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 Asset 

type Asset struct {
	// 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 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"`

	// IsFrozen \[f\] whether or not the holding is frozen.
	IsFrozen bool `json:"is-frozen"`
}

AssetHolding Describes an asset held by an account.

Definition: data/basics/userBalance.go : AssetHolding

type AssetHoldingReference 

type AssetHoldingReference struct {
	// Account Address of the account holding the asset.
	Account string `json:"account"`

	// Asset Asset ID of the holding.
	Asset uint64 `json:"asset"`
}

AssetHoldingReference References an asset held by an account.

type AssetID 

type AssetID uint64

AssetID defines model for asset-id.

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 = Asset

AssetResponse Specifies both the unique identifier and the parameters for an asset

type AvmKeyValue 

type AvmKeyValue struct {
	Key []byte `json:"key"`

	// Value Represents an AVM value.
	Value AvmValue `json:"value"`
}

AvmKeyValue Represents an AVM key-value pair in an application store.

type AvmValue 

type AvmValue struct {
	// Bytes bytes value.
	Bytes *[]byte `json:"bytes,omitempty"`

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

	// Uint uint value.
	Uint *uint64 `json:"uint,omitempty"`
}

AvmValue Represents an AVM value.

type BeforeTime 

type BeforeTime = time.Time

BeforeTime defines model for before-time.

type BlockHashResponse 

type BlockHashResponse struct {
	// BlockHash Block header hash.
	BlockHash string `json:"blockHash"`
}

BlockHashResponse defines model for BlockHashResponse.

type BlockHeaderResponse 

type BlockHeaderResponse struct {
	// BlockHeader Block header data.
	BlockHeader map[string]interface{} `json:"blockHeader"`
}

BlockHeaderResponse defines model for BlockHeaderResponse.

type BlockLogsResponse 

type BlockLogsResponse struct {
	Logs []AppCallLogs `json:"logs"`
}

BlockLogsResponse defines model for BlockLogsResponse.

type BlockResponse 

type BlockResponse struct {
	// Block Block header data.
	Block map[string]interface{} `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 defines model for BlockResponse.

type BlockTxidsResponse 

type BlockTxidsResponse struct {
	// BlockTxids Block transaction IDs.
	BlockTxids []string `json:"blockTxids"`
}

BlockTxidsResponse defines model for BlockTxidsResponse.

type Box 

type Box struct {
	// Name \[name\] box name, base64 encoded
	Name []byte `json:"name"`

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

	// Value \[value\] box value, base64 encoded.
	Value []byte `json:"value"`
}

Box Box name and its content.

type BoxDescriptor 

type BoxDescriptor struct {
	// Name Base64 encoded box name
	Name []byte `json:"name"`
}

BoxDescriptor Box descriptor describes a Box.

type BoxReference 

type BoxReference struct {
	// App Application ID which this box belongs to
	App uint64 `json:"app"`

	// Name Base64 encoded box name
	Name []byte `json:"name"`
}

BoxReference References a box of an application.

type BoxResponse 

type BoxResponse = Box

BoxResponse Box name and its content.

type BoxesResponse 

type BoxesResponse struct {
	Boxes []BoxDescriptor `json:"boxes"`
}

BoxesResponse defines model for BoxesResponse.

type BuildVersion 

type BuildVersion struct {
	Branch      string `json:"branch"`
	BuildNumber uint64 `json:"build_number"`
	Channel     string `json:"channel"`
	CommitHash  string `json:"commit_hash"`
	Major       uint64 `json:"major"`
	Minor       uint64 `json:"minor"`
}

BuildVersion defines model for BuildVersion.

type Catchpoint 

type Catchpoint = string

Catchpoint defines model for catchpoint.

type CatchpointAbortResponse 

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

CatchpointAbortResponse An catchpoint abort response.

type CatchpointStartResponse 

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

CatchpointStartResponse An catchpoint start response.

type CompileResponse 

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 defines model for CompileResponse.

type CurrencyGreaterThan 

type CurrencyGreaterThan uint64

CurrencyGreaterThan defines model for currency-greater-than.

type CurrencyLessThan 

type CurrencyLessThan uint64

CurrencyLessThan defines model for currency-less-than.

type DebugSettingsProf 

type DebugSettingsProf struct {
	// BlockRate The rate of blocking events. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked. To turn off profiling entirely, pass rate 0.
	BlockRate *uint64 `json:"block-rate,omitempty"`

	// MutexRate The rate of mutex events. On average 1/rate events are reported. To turn off profiling entirely, pass rate 0
	MutexRate *uint64 `json:"mutex-rate,omitempty"`
}

DebugSettingsProf algod mutex and blocking profiling state.

type DebugSettingsProfResponse 

type DebugSettingsProfResponse = DebugSettingsProf

DebugSettingsProfResponse algod mutex and blocking profiling state.

type DisassembleResponse 

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

DisassembleResponse defines model for DisassembleResponse.

type DryrunRequest 

type DryrunRequest struct {
	Accounts []Account     `json:"accounts"`
	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 []DryrunSource    `json:"sources"`
	Txns    []json.RawMessage `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 

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

	// ProtocolVersion Protocol version is the protocol version Dryrun was operated under.
	ProtocolVersion string            `json:"protocol-version"`
	Txns            []DryrunTxnResult `json:"txns"`
}

DryrunResponse defines model for DryrunResponse.

type DryrunSource 

type DryrunSource struct {
	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    string `json:"source"`
	TxnIndex  uint64 `json:"txn-index"`
}

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

type DryrunState 

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 *[]TealValue `json:"scratch,omitempty"`
	Stack   []TealValue  `json:"stack"`
}

DryrunState Stores the TEAL eval step data

type DryrunTxnResult 

type DryrunTxnResult struct {
	AppCallMessages *[]string      `json:"app-call-messages,omitempty"`
	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"`

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

	// GlobalDelta Application state delta.
	GlobalDelta *StateDelta          `json:"global-delta,omitempty"`
	LocalDeltas *[]AccountStateDelta `json:"local-deltas,omitempty"`

	// LogicSigDisassembly Disassembled lsig program line by line.
	LogicSigDisassembly *[]string      `json:"logic-sig-disassembly,omitempty"`
	LogicSigMessages    *[]string      `json:"logic-sig-messages,omitempty"`
	LogicSigTrace       *[]DryrunState `json:"logic-sig-trace,omitempty"`
	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    *map[string]interface{} `json:"data,omitempty"`
	Message string                  `json:"message"`
}

ErrorResponse An error response with optional data field.

type EvalDelta 

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 

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

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

EvalDeltaKeyValue Key-value pairs for StateDelta.

type ExcludeCloseTo 

type ExcludeCloseTo = bool

ExcludeCloseTo defines model for exclude-close-to.

type Format 

type Format string

Format defines model for format. 

const (
	FormatJson    Format = "json"
	FormatMsgpack Format = "msgpack"
)

Defines values for Format.

type GenerateParticipationKeysParams 

type GenerateParticipationKeysParams struct {
	// Dilution Key dilution for two-level participation keys (defaults to sqrt of validity window).
	Dilution *uint64 `form:"dilution,omitempty" json:"dilution,omitempty"`

	// First First round for participation key.
	First uint64 `form:"first" json:"first"`

	// Last Last round for participation key.
	Last uint64 `form:"last" json:"last"`
}

GenerateParticipationKeysParams defines parameters for GenerateParticipationKeys.

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 `form:"name" json:"name"`
}

GetApplicationBoxByNameParams defines parameters for GetApplicationBoxByName.

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 `form:"max,omitempty" json:"max,omitempty"`
}

GetApplicationBoxesParams defines parameters for GetApplicationBoxes.

type GetBlockHeaderParams 

type GetBlockHeaderParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetBlockHeaderParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetBlockHeaderParams defines parameters for GetBlockHeader.

type GetBlockHeaderParamsFormat 

type GetBlockHeaderParamsFormat string

GetBlockHeaderParamsFormat defines parameters for GetBlockHeader. 

const (
	GetBlockHeaderParamsFormatJson    GetBlockHeaderParamsFormat = "json"
	GetBlockHeaderParamsFormatMsgpack GetBlockHeaderParamsFormat = "msgpack"
)

Defines values for GetBlockHeaderParamsFormat.

type GetBlockParams 

type GetBlockParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetBlockParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetBlockParams defines parameters for GetBlock.

type GetBlockParamsFormat 

type GetBlockParamsFormat string

GetBlockParamsFormat defines parameters for GetBlock. 

const (
	GetBlockParamsFormatJson    GetBlockParamsFormat = "json"
	GetBlockParamsFormatMsgpack GetBlockParamsFormat = "msgpack"
)

Defines values for GetBlockParamsFormat.

type GetBlockTimeStampOffsetResponse 

type GetBlockTimeStampOffsetResponse struct {
	// Offset Timestamp offset in seconds.
	Offset uint64 `json:"offset"`
}

GetBlockTimeStampOffsetResponse defines model for GetBlockTimeStampOffsetResponse.

type GetLedgerStateDeltaForTransactionGroupParams 

type GetLedgerStateDeltaForTransactionGroupParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetLedgerStateDeltaForTransactionGroupParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetLedgerStateDeltaForTransactionGroupParams defines parameters for GetLedgerStateDeltaForTransactionGroup.

type GetLedgerStateDeltaForTransactionGroupParamsFormat 

type GetLedgerStateDeltaForTransactionGroupParamsFormat string

GetLedgerStateDeltaForTransactionGroupParamsFormat defines parameters for GetLedgerStateDeltaForTransactionGroup. 

const (
	GetLedgerStateDeltaForTransactionGroupParamsFormatJson    GetLedgerStateDeltaForTransactionGroupParamsFormat = "json"
	GetLedgerStateDeltaForTransactionGroupParamsFormatMsgpack GetLedgerStateDeltaForTransactionGroupParamsFormat = "msgpack"
)

Defines values for GetLedgerStateDeltaForTransactionGroupParamsFormat.

type GetLedgerStateDeltaParams 

type GetLedgerStateDeltaParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetLedgerStateDeltaParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetLedgerStateDeltaParams defines parameters for GetLedgerStateDelta.

type GetLedgerStateDeltaParamsFormat 

type GetLedgerStateDeltaParamsFormat string

GetLedgerStateDeltaParamsFormat defines parameters for GetLedgerStateDelta. 

const (
	GetLedgerStateDeltaParamsFormatJson    GetLedgerStateDeltaParamsFormat = "json"
	GetLedgerStateDeltaParamsFormatMsgpack GetLedgerStateDeltaParamsFormat = "msgpack"
)

Defines values for GetLedgerStateDeltaParamsFormat.

type GetPendingTransactionsByAddressParams 

type GetPendingTransactionsByAddressParams struct {
	// Max Truncated number of transactions to display. If max=0, returns all pending txns.
	Max *uint64 `form:"max,omitempty" json:"max,omitempty"`

	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetPendingTransactionsByAddressParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetPendingTransactionsByAddressParams defines parameters for GetPendingTransactionsByAddress.

type GetPendingTransactionsByAddressParamsFormat 

type GetPendingTransactionsByAddressParamsFormat string

GetPendingTransactionsByAddressParamsFormat defines parameters for GetPendingTransactionsByAddress. 

const (
	GetPendingTransactionsByAddressParamsFormatJson    GetPendingTransactionsByAddressParamsFormat = "json"
	GetPendingTransactionsByAddressParamsFormatMsgpack GetPendingTransactionsByAddressParamsFormat = "msgpack"
)

Defines values for GetPendingTransactionsByAddressParamsFormat.

type GetPendingTransactionsParams 

type GetPendingTransactionsParams struct {
	// Max Truncated number of transactions to display. If max=0, returns all pending txns.
	Max *uint64 `form:"max,omitempty" json:"max,omitempty"`

	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetPendingTransactionsParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetPendingTransactionsParams defines parameters for GetPendingTransactions.

type GetPendingTransactionsParamsFormat 

type GetPendingTransactionsParamsFormat string

GetPendingTransactionsParamsFormat defines parameters for GetPendingTransactions. 

const (
	GetPendingTransactionsParamsFormatJson    GetPendingTransactionsParamsFormat = "json"
	GetPendingTransactionsParamsFormatMsgpack GetPendingTransactionsParamsFormat = "msgpack"
)

Defines values for GetPendingTransactionsParamsFormat.

type GetSyncRoundResponse 

type GetSyncRoundResponse struct {
	// Round The minimum sync round for the ledger.
	Round uint64 `json:"round"`
}

GetSyncRoundResponse defines model for GetSyncRoundResponse.

type GetTransactionGroupLedgerStateDeltasForRoundParams 

type GetTransactionGroupLedgerStateDeltasForRoundParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetTransactionGroupLedgerStateDeltasForRoundParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetTransactionGroupLedgerStateDeltasForRoundParams defines parameters for GetTransactionGroupLedgerStateDeltasForRound.

type GetTransactionGroupLedgerStateDeltasForRoundParamsFormat 

type GetTransactionGroupLedgerStateDeltasForRoundParamsFormat string

GetTransactionGroupLedgerStateDeltasForRoundParamsFormat defines parameters for GetTransactionGroupLedgerStateDeltasForRound. 

const (
	GetTransactionGroupLedgerStateDeltasForRoundParamsFormatJson    GetTransactionGroupLedgerStateDeltasForRoundParamsFormat = "json"
	GetTransactionGroupLedgerStateDeltasForRoundParamsFormatMsgpack GetTransactionGroupLedgerStateDeltasForRoundParamsFormat = "msgpack"
)

Defines values for GetTransactionGroupLedgerStateDeltasForRoundParamsFormat.

type GetTransactionProofParams 

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

	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *GetTransactionProofParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetTransactionProofParams defines parameters for GetTransactionProof.

type GetTransactionProofParamsFormat 

type GetTransactionProofParamsFormat string

GetTransactionProofParamsFormat defines parameters for GetTransactionProof. 

const (
	GetTransactionProofParamsFormatJson    GetTransactionProofParamsFormat = "json"
	GetTransactionProofParamsFormatMsgpack GetTransactionProofParamsFormat = "msgpack"
)

Defines values for GetTransactionProofParamsFormat.

type GetTransactionProofParamsHashtype 

type GetTransactionProofParamsHashtype string

GetTransactionProofParamsHashtype defines parameters for GetTransactionProof. 

const (
	GetTransactionProofParamsHashtypeSha256    GetTransactionProofParamsHashtype = "sha256"
	GetTransactionProofParamsHashtypeSha512256 GetTransactionProofParamsHashtype = "sha512_256"
)

Defines values for GetTransactionProofParamsHashtype.

type KvDelta 

type KvDelta struct {
	// Key The key, base64 encoded.
	Key *[]byte `json:"key,omitempty"`

	// Value The new value of the KV store entry, base64 encoded.
	Value *[]byte `json:"value,omitempty"`
}

KvDelta A single Delta containing the key, the previous value and the current value for a single round.

type LedgerStateDelta 

type LedgerStateDelta = map[string]interface{}

LedgerStateDelta Ledger StateDelta object

type LedgerStateDeltaForTransactionGroup 

type LedgerStateDeltaForTransactionGroup struct {
	// Delta Ledger StateDelta object
	Delta LedgerStateDelta `json:"Delta"`
	Ids   []string         `json:"Ids"`
}

LedgerStateDeltaForTransactionGroup Contains a ledger delta for a single transaction group

type LedgerStateDeltaForTransactionGroupResponse 

type LedgerStateDeltaForTransactionGroupResponse = LedgerStateDelta

LedgerStateDeltaForTransactionGroupResponse Ledger StateDelta object

type LedgerStateDeltaResponse 

type LedgerStateDeltaResponse = LedgerStateDelta

LedgerStateDeltaResponse Ledger StateDelta object

type LightBlockHeaderProof 

type LightBlockHeaderProof struct {
	// Index The index of the light block header in the vector commitment tree
	Index uint64 `json:"index"`

	// Proof The encoded proof.
	Proof []byte `json:"proof"`

	// 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"`
}

LightBlockHeaderProof Proof of membership and position of a light block header.

type LightBlockHeaderProofResponse 

type LightBlockHeaderProofResponse = LightBlockHeaderProof

LightBlockHeaderProofResponse Proof of membership and position of a light block header.

type Limit 

type Limit uint64

Limit defines model for limit.

type Max 

type Max uint64

Max defines model for max.

type MaxRound 

type MaxRound uint64

MaxRound defines model for max-round.

type MinRound 

type MinRound uint64

MinRound defines model for min-round.

type Next 

type Next = string

Next defines model for next.

type NodeStatusResponse 

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"`

	// CatchpointProcessedKvs The number of key-values (KVs) from the current catchpoint that have been processed so far as part of the catchup
	CatchpointProcessedKvs *uint64 `json:"catchpoint-processed-kvs,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"`

	// CatchpointTotalKvs The total number of key-values (KVs) included in the current catchpoint
	CatchpointTotalKvs *uint64 `json:"catchpoint-total-kvs,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"`

	// CatchpointVerifiedKvs The number of key-values (KVs) from the current catchpoint that have been verified so far as part of the catchup
	CatchpointVerifiedKvs *uint64 `json:"catchpoint-verified-kvs,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"`

	// UpgradeDelay Upgrade delay
	UpgradeDelay *uint64 `json:"upgrade-delay,omitempty"`

	// UpgradeNextProtocolVoteBefore Next protocol round
	UpgradeNextProtocolVoteBefore *uint64 `json:"upgrade-next-protocol-vote-before,omitempty"`

	// UpgradeNoVotes No votes cast for consensus upgrade
	UpgradeNoVotes *uint64 `json:"upgrade-no-votes,omitempty"`

	// UpgradeNodeVote This node's upgrade vote
	UpgradeNodeVote *bool `json:"upgrade-node-vote,omitempty"`

	// UpgradeVoteRounds Total voting rounds for current upgrade
	UpgradeVoteRounds *uint64 `json:"upgrade-vote-rounds,omitempty"`

	// UpgradeVotes Total votes cast for consensus upgrade
	UpgradeVotes *uint64 `json:"upgrade-votes,omitempty"`

	// UpgradeVotesRequired Yes votes required for consensus upgrade
	UpgradeVotesRequired *uint64 `json:"upgrade-votes-required,omitempty"`

	// UpgradeYesVotes Yes votes cast for consensus upgrade
	UpgradeYesVotes *uint64 `json:"upgrade-yes-votes,omitempty"`
}

NodeStatusResponse NodeStatus contains the information about a node status

type NotePrefix 

type NotePrefix = string

NotePrefix defines model for note-prefix.

type ParticipationKey 

type ParticipationKey struct {
	// Address Address the key was generated for.
	Address string `json:"address"`

	// EffectiveFirstValid When registered, this is the first round it may be used.
	EffectiveFirstValid *uint64 `json:"effective-first-valid,omitempty"`

	// EffectiveLastValid When registered, this is the last round it may be used.
	EffectiveLastValid *uint64 `json:"effective-last-valid,omitempty"`

	// Id The key's ParticipationID.
	Id string `json:"id"`

	// Key AccountParticipation describes the parameters used by this account in consensus protocol.
	Key AccountParticipation `json:"key"`

	// LastBlockProposal Round when this key was last used to propose a block.
	LastBlockProposal *uint64 `json:"last-block-proposal,omitempty"`

	// LastStateProof Round when this key was last used to generate a state proof.
	LastStateProof *uint64 `json:"last-state-proof,omitempty"`

	// LastVote Round when this key was last used to vote.
	LastVote *uint64 `json:"last-vote,omitempty"`
}

ParticipationKey Represents a participation key used by the node.

type ParticipationKeyResponse 

type ParticipationKeyResponse = ParticipationKey

ParticipationKeyResponse Represents a participation key used by the node.

type ParticipationKeysResponse 

type ParticipationKeysResponse = []ParticipationKey

ParticipationKeysResponse defines model for ParticipationKeysResponse.

type PendingTransactionInformationParams 

type PendingTransactionInformationParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *PendingTransactionInformationParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

PendingTransactionInformationParams defines parameters for PendingTransactionInformation.

type PendingTransactionInformationParamsFormat 

type PendingTransactionInformationParamsFormat string

PendingTransactionInformationParamsFormat defines parameters for PendingTransactionInformation. 

const (
	PendingTransactionInformationParamsFormatJson    PendingTransactionInformationParamsFormat = "json"
	PendingTransactionInformationParamsFormatMsgpack PendingTransactionInformationParamsFormat = "msgpack"
)

Defines values for PendingTransactionInformationParamsFormat.

type PendingTransactionResponse 

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 Application state delta.
	GlobalStateDelta *StateDelta `json:"global-state-delta,omitempty"`

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

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

	// Logs 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"`

	// Txn The raw signed transaction.
	Txn map[string]interface{} `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 []map[string]interface{} `json:"top-transactions"`

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

PendingTransactionsResponse PendingTransactions is an array of signed transactions exactly as they were submitted.

type PostParticipationResponse 

type PostParticipationResponse struct {
	// PartId encoding of the participation ID.
	PartId string `json:"partId"`
}

PostParticipationResponse defines model for PostParticipationResponse.

type PostTransactionsResponse 

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

PostTransactionsResponse defines model for PostTransactionsResponse.

type Round 

type Round uint64

Round defines model for round.

type RoundNumber 

type RoundNumber uint64

RoundNumber defines model for round-number.

type ScratchChange 

type ScratchChange struct {
	// NewValue Represents an AVM value.
	NewValue AvmValue `json:"new-value"`

	// Slot The scratch slot written.
	Slot uint64 `json:"slot"`
}

ScratchChange A write operation into a scratch slot.

type ShutdownNodeParams 

type ShutdownNodeParams struct {
	Timeout *uint64 `form:"timeout,omitempty" json:"timeout,omitempty"`
}

ShutdownNodeParams defines parameters for ShutdownNode.

type SigType 

type SigType string

SigType defines model for sig-type. 

const (
	SigTypeLsig SigType = "lsig"
	SigTypeMsig SigType = "msig"
	SigTypeSig  SigType = "sig"
)

Defines values for SigType.

type SimulateInitialStates 

type SimulateInitialStates struct {
	// AppInitialStates The initial states of accessed application before simulation. The order of this array is arbitrary.
	AppInitialStates *[]ApplicationInitialStates `json:"app-initial-states,omitempty"`
}

SimulateInitialStates Initial states of resources that were accessed during simulation.

type SimulateRequest 

type SimulateRequest struct {
	// AllowEmptySignatures Allows transactions without signatures to be simulated as if they had correct signatures.
	AllowEmptySignatures *bool `json:"allow-empty-signatures,omitempty"`

	// AllowMoreLogging Lifts limits on log opcode usage during simulation.
	AllowMoreLogging *bool `json:"allow-more-logging,omitempty"`

	// AllowUnnamedResources Allows access to unnamed resources during simulation.
	AllowUnnamedResources *bool `json:"allow-unnamed-resources,omitempty"`

	// ExecTraceConfig An object that configures simulation execution trace.
	ExecTraceConfig *SimulateTraceConfig `json:"exec-trace-config,omitempty"`

	// ExtraOpcodeBudget Applies extra opcode budget during simulation for each transaction group.
	ExtraOpcodeBudget *uint64 `json:"extra-opcode-budget,omitempty"`

	// FixSigners If true, signers for transactions that are missing signatures will be fixed during evaluation.
	FixSigners *bool `json:"fix-signers,omitempty"`

	// Round If provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.
	Round *uint64 `json:"round,omitempty"`

	// TxnGroups The transaction groups to simulate.
	TxnGroups []SimulateRequestTransactionGroup `json:"txn-groups"`
}

SimulateRequest Request type for simulation endpoint.

type SimulateRequestTransactionGroup 

type SimulateRequestTransactionGroup struct {
	// Txns An atomic transaction group.
	Txns []json.RawMessage `json:"txns"`
}

SimulateRequestTransactionGroup A transaction group to simulate.

type SimulateResponse 

type SimulateResponse struct {
	// EvalOverrides The set of parameters and limits override during simulation. If this set of parameters is present, then evaluation parameters may differ from standard evaluation in certain ways.
	EvalOverrides *SimulationEvalOverrides `json:"eval-overrides,omitempty"`

	// ExecTraceConfig An object that configures simulation execution trace.
	ExecTraceConfig *SimulateTraceConfig `json:"exec-trace-config,omitempty"`

	// InitialStates Initial states of resources that were accessed during simulation.
	InitialStates *SimulateInitialStates `json:"initial-states,omitempty"`

	// LastRound The round immediately preceding this simulation. State changes through this round were used to run this simulation.
	LastRound uint64 `json:"last-round"`

	// TxnGroups A result object for each transaction group that was simulated.
	TxnGroups []SimulateTransactionGroupResult `json:"txn-groups"`

	// Version The version of this response object.
	Version uint64 `json:"version"`
}

SimulateResponse defines model for SimulateResponse.

type SimulateTraceConfig 

type SimulateTraceConfig struct {
	// Enable A boolean option for opting in execution trace features simulation endpoint.
	Enable *bool `json:"enable,omitempty"`

	// ScratchChange A boolean option enabling returning scratch slot changes together with execution trace during simulation.
	ScratchChange *bool `json:"scratch-change,omitempty"`

	// StackChange A boolean option enabling returning stack changes together with execution trace during simulation.
	StackChange *bool `json:"stack-change,omitempty"`

	// StateChange A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.
	StateChange *bool `json:"state-change,omitempty"`
}

SimulateTraceConfig An object that configures simulation execution trace.

type SimulateTransactionGroupResult 

type SimulateTransactionGroupResult struct {
	// AppBudgetAdded Total budget added during execution of app calls in the transaction group.
	AppBudgetAdded *uint64 `json:"app-budget-added,omitempty"`

	// AppBudgetConsumed Total budget consumed during execution of app calls in the transaction group.
	AppBudgetConsumed *uint64 `json:"app-budget-consumed,omitempty"`

	// FailedAt If present, indicates which transaction in this group caused the failure. This array represents the path to the failing transaction. Indexes are zero based, the first element indicates the top-level transaction, and successive elements indicate deeper inner transactions.
	FailedAt *[]uint64 `json:"failed-at,omitempty"`

	// FailureMessage If present, indicates that the transaction group failed and specifies why that happened
	FailureMessage *string `json:"failure-message,omitempty"`

	// TxnResults Simulation result for individual transactions
	TxnResults []SimulateTransactionResult `json:"txn-results"`

	// UnnamedResourcesAccessed These are resources that were accessed by this group that would normally have caused failure, but were allowed in simulation. Depending on where this object is in the response, the unnamed resources it contains may or may not qualify for group resource sharing. If this is a field in SimulateTransactionGroupResult, the resources do qualify, but if this is a field in SimulateTransactionResult, they do not qualify. In order to make this group valid for actual submission, resources that qualify for group sharing can be made available by any transaction of the group; otherwise, resources must be placed in the same transaction which accessed them.
	UnnamedResourcesAccessed *SimulateUnnamedResourcesAccessed `json:"unnamed-resources-accessed,omitempty"`
}

SimulateTransactionGroupResult Simulation result for an atomic transaction group

type SimulateTransactionJSONRequestBody 

type SimulateTransactionJSONRequestBody = SimulateRequest

SimulateTransactionJSONRequestBody defines body for SimulateTransaction for application/json ContentType.

type SimulateTransactionParams 

type SimulateTransactionParams struct {
	// Format Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
	Format *SimulateTransactionParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

SimulateTransactionParams defines parameters for SimulateTransaction.

type SimulateTransactionParamsFormat 

type SimulateTransactionParamsFormat string

SimulateTransactionParamsFormat defines parameters for SimulateTransaction. 

const (
	SimulateTransactionParamsFormatJson    SimulateTransactionParamsFormat = "json"
	SimulateTransactionParamsFormatMsgpack SimulateTransactionParamsFormat = "msgpack"
)

Defines values for SimulateTransactionParamsFormat.

type SimulateTransactionResult 

type SimulateTransactionResult struct {
	// AppBudgetConsumed Budget used during execution of an app call transaction. This value includes budged used by inner app calls spawned by this transaction.
	AppBudgetConsumed *uint64 `json:"app-budget-consumed,omitempty"`

	// ExecTrace The execution trace of calling an app or a logic sig, containing the inner app call trace in a recursive way.
	ExecTrace *SimulationTransactionExecTrace `json:"exec-trace,omitempty"`

	// FixedSigner The account that needed to sign this transaction when no signature was provided and the provided signer was incorrect.
	FixedSigner *string `json:"fixed-signer,omitempty"`

	// LogicSigBudgetConsumed Budget used during execution of a logic sig transaction.
	LogicSigBudgetConsumed *uint64 `json:"logic-sig-budget-consumed,omitempty"`

	// TxnResult Details about a pending transaction. If the transaction was recently confirmed, includes confirmation details like the round and reward details.
	TxnResult PendingTransactionResponse `json:"txn-result"`

	// UnnamedResourcesAccessed These are resources that were accessed by this group that would normally have caused failure, but were allowed in simulation. Depending on where this object is in the response, the unnamed resources it contains may or may not qualify for group resource sharing. If this is a field in SimulateTransactionGroupResult, the resources do qualify, but if this is a field in SimulateTransactionResult, they do not qualify. In order to make this group valid for actual submission, resources that qualify for group sharing can be made available by any transaction of the group; otherwise, resources must be placed in the same transaction which accessed them.
	UnnamedResourcesAccessed *SimulateUnnamedResourcesAccessed `json:"unnamed-resources-accessed,omitempty"`
}

SimulateTransactionResult Simulation result for an individual transaction

type SimulateUnnamedResourcesAccessed 

type SimulateUnnamedResourcesAccessed struct {
	// Accounts The unnamed accounts that were referenced. The order of this array is arbitrary.
	Accounts *[]string `json:"accounts,omitempty"`

	// AppLocals The unnamed application local states that were referenced. The order of this array is arbitrary.
	AppLocals *[]ApplicationLocalReference `json:"app-locals,omitempty"`

	// Apps The unnamed applications that were referenced. The order of this array is arbitrary.
	Apps *[]uint64 `json:"apps,omitempty"`

	// AssetHoldings The unnamed asset holdings that were referenced. The order of this array is arbitrary.
	AssetHoldings *[]AssetHoldingReference `json:"asset-holdings,omitempty"`

	// Assets The unnamed assets that were referenced. The order of this array is arbitrary.
	Assets *[]uint64 `json:"assets,omitempty"`

	// Boxes The unnamed boxes that were referenced. The order of this array is arbitrary.
	Boxes *[]BoxReference `json:"boxes,omitempty"`

	// ExtraBoxRefs The number of extra box references used to increase the IO budget. This is in addition to the references defined in the input transaction group and any referenced to unnamed boxes.
	ExtraBoxRefs *uint64 `json:"extra-box-refs,omitempty"`
}

SimulateUnnamedResourcesAccessed These are resources that were accessed by this group that would normally have caused failure, but were allowed in simulation. Depending on where this object is in the response, the unnamed resources it contains may or may not qualify for group resource sharing. If this is a field in SimulateTransactionGroupResult, the resources do qualify, but if this is a field in SimulateTransactionResult, they do not qualify. In order to make this group valid for actual submission, resources that qualify for group sharing can be made available by any transaction of the group; otherwise, resources must be placed in the same transaction which accessed them.

type SimulationEvalOverrides 

type SimulationEvalOverrides struct {
	// AllowEmptySignatures If true, transactions without signatures are allowed and simulated as if they were properly signed.
	AllowEmptySignatures *bool `json:"allow-empty-signatures,omitempty"`

	// AllowUnnamedResources If true, allows access to unnamed resources during simulation.
	AllowUnnamedResources *bool `json:"allow-unnamed-resources,omitempty"`

	// ExtraOpcodeBudget The extra opcode budget added to each transaction group during simulation
	ExtraOpcodeBudget *uint64 `json:"extra-opcode-budget,omitempty"`

	// FixSigners If true, signers for transactions that are missing signatures will be fixed during evaluation.
	FixSigners *bool `json:"fix-signers,omitempty"`

	// MaxLogCalls The maximum log calls one can make during simulation
	MaxLogCalls *uint64 `json:"max-log-calls,omitempty"`

	// MaxLogSize The maximum byte number to log during simulation
	MaxLogSize *uint64 `json:"max-log-size,omitempty"`
}

SimulationEvalOverrides The set of parameters and limits override during simulation. If this set of parameters is present, then evaluation parameters may differ from standard evaluation in certain ways.

type SimulationOpcodeTraceUnit 

type SimulationOpcodeTraceUnit struct {
	// Pc The program counter of the current opcode being evaluated.
	Pc uint64 `json:"pc"`

	// ScratchChanges The writes into scratch slots.
	ScratchChanges *[]ScratchChange `json:"scratch-changes,omitempty"`

	// SpawnedInners The indexes of the traces for inner transactions spawned by this opcode, if any.
	SpawnedInners *[]uint64 `json:"spawned-inners,omitempty"`

	// StackAdditions The values added by this opcode to the stack.
	StackAdditions *[]AvmValue `json:"stack-additions,omitempty"`

	// StackPopCount The number of deleted stack values by this opcode.
	StackPopCount *uint64 `json:"stack-pop-count,omitempty"`

	// StateChanges The operations against the current application's states.
	StateChanges *[]ApplicationStateOperation `json:"state-changes,omitempty"`
}

SimulationOpcodeTraceUnit The set of trace information and effect from evaluating a single opcode.

type SimulationTransactionExecTrace 

type SimulationTransactionExecTrace struct {
	// ApprovalProgramHash SHA512_256 hash digest of the approval program executed in transaction.
	ApprovalProgramHash *[]byte `json:"approval-program-hash,omitempty"`

	// ApprovalProgramTrace Program trace that contains a trace of opcode effects in an approval program.
	ApprovalProgramTrace *[]SimulationOpcodeTraceUnit `json:"approval-program-trace,omitempty"`

	// ClearStateProgramHash SHA512_256 hash digest of the clear state program executed in transaction.
	ClearStateProgramHash *[]byte `json:"clear-state-program-hash,omitempty"`

	// ClearStateProgramTrace Program trace that contains a trace of opcode effects in a clear state program.
	ClearStateProgramTrace *[]SimulationOpcodeTraceUnit `json:"clear-state-program-trace,omitempty"`

	// ClearStateRollback If true, indicates that the clear state program failed and any persistent state changes it produced should be reverted once the program exits.
	ClearStateRollback *bool `json:"clear-state-rollback,omitempty"`

	// ClearStateRollbackError The error message explaining why the clear state program failed. This field will only be populated if clear-state-rollback is true and the failure was due to an execution error.
	ClearStateRollbackError *string `json:"clear-state-rollback-error,omitempty"`

	// InnerTrace An array of SimulationTransactionExecTrace representing the execution trace of any inner transactions executed.
	InnerTrace *[]SimulationTransactionExecTrace `json:"inner-trace,omitempty"`

	// LogicSigHash SHA512_256 hash digest of the logic sig executed in transaction.
	LogicSigHash *[]byte `json:"logic-sig-hash,omitempty"`

	// LogicSigTrace Program trace that contains a trace of opcode effects in a logic sig.
	LogicSigTrace *[]SimulationOpcodeTraceUnit `json:"logic-sig-trace,omitempty"`
}

SimulationTransactionExecTrace The execution trace of calling an app or a logic sig, containing the inner app call trace in a recursive way.

type StartCatchupParams 

type StartCatchupParams struct {
	// Min Specify the minimum number of blocks which the ledger must be advanced by in order to start the catchup. This is useful for simplifying tools which support fast catchup, they can run the catchup unconditionally and the node will skip the catchup if it is not needed.
	Min *uint64 `form:"min,omitempty" json:"min,omitempty"`
}

StartCatchupParams defines parameters for StartCatchup.

type StateDelta 

type StateDelta = []EvalDeltaKeyValue

StateDelta Application state delta.

type StateProof 

type StateProof struct {
	// Message Represents the message that the state proofs are attesting to.
	Message StateProofMessage `json:"Message"`

	// StateProof The encoded StateProof for the message.
	StateProof []byte `json:"StateProof"`
}

StateProof Represents a state proof and its corresponding message

type StateProofMessage 

type StateProofMessage struct {
	// BlockHeadersCommitment The vector commitment root on all light block headers within a state proof interval.
	BlockHeadersCommitment []byte `json:"BlockHeadersCommitment"`

	// FirstAttestedRound The first round the message attests to.
	FirstAttestedRound uint64 `json:"FirstAttestedRound"`

	// LastAttestedRound The last round the message attests to.
	LastAttestedRound uint64 `json:"LastAttestedRound"`

	// LnProvenWeight An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof.
	LnProvenWeight uint64 `json:"LnProvenWeight"`

	// VotersCommitment The vector commitment root of the top N accounts to sign the next StateProof.
	VotersCommitment []byte `json:"VotersCommitment"`
}

StateProofMessage Represents the message that the state proofs are attesting to.

type StateProofResponse 

type StateProofResponse = StateProof

StateProofResponse Represents a state proof and its corresponding message

type SupplyResponse 

type SupplyResponse struct {
	// CurrentRound Round
	CurrentRound 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 TealCompileParams 

type TealCompileParams struct {
	// Sourcemap When set to `true`, returns the source map of the program as a JSON. Defaults to `false`.
	Sourcemap *bool `form:"sourcemap,omitempty" json:"sourcemap,omitempty"`
}

TealCompileParams defines parameters for TealCompile.

type TealCompileTextBody 

type TealCompileTextBody = openapi_types.File

TealCompileTextBody defines parameters for TealCompile.

type TealCompileTextRequestBody 

type TealCompileTextRequestBody = TealCompileTextBody

TealCompileTextRequestBody defines body for TealCompile for text/plain ContentType.

type TealDryrunJSONRequestBody 

type TealDryrunJSONRequestBody = DryrunRequest

TealDryrunJSONRequestBody defines body for TealDryrun for application/json ContentType.

type TealKeyValue 

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

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

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

type TealKeyValueStore 

type TealKeyValueStore = []TealKeyValue

TealKeyValueStore Represents a key-value store for use in an application.

type TealValue 

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 TransactionGroupLedgerStateDeltasForRoundResponse 

type TransactionGroupLedgerStateDeltasForRoundResponse struct {
	Deltas []LedgerStateDeltaForTransactionGroup `json:"Deltas"`
}

TransactionGroupLedgerStateDeltasForRoundResponse defines model for TransactionGroupLedgerStateDeltasForRoundResponse.

type TransactionParametersResponse 

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 TransactionProofResponse 

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

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

	// Proof 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"`
}

TransactionProofResponse defines model for TransactionProofResponse.

type TransactionProofResponseHashtype 

type TransactionProofResponseHashtype string

TransactionProofResponseHashtype The type of hash function used to create the proof, must be one of: * sha512_256 * sha256 

const (
	TransactionProofResponseHashtypeSha256    TransactionProofResponseHashtype = "sha256"
	TransactionProofResponseHashtypeSha512256 TransactionProofResponseHashtype = "sha512_256"
)

Defines values for TransactionProofResponseHashtype.

type TxID 

type TxID = string

TxID defines model for tx-id.

type TxType 

type TxType string

TxType defines model for tx-type. 

const (
	TxTypeAcfg   TxType = "acfg"
	TxTypeAfrz   TxType = "afrz"
	TxTypeAppl   TxType = "appl"
	TxTypeAxfer  TxType = "axfer"
	TxTypeKeyreg TxType = "keyreg"
	TxTypePay    TxType = "pay"
	TxTypeStpf   TxType = "stpf"
)

Defines values for TxType.

type Version 

type Version struct {
	Build          BuildVersion `json:"build"`
	GenesisHashB64 []byte       `json:"genesis_hash_b64"`
	GenesisId      string       `json:"genesis_id"`
	Versions       []string     `json:"versions"`
}

Version algod version information.

type VersionsResponse 

type VersionsResponse = Version

VersionsResponse algod version information.

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.