github.com/algorand/go-algorand-sdk@v1.24.0/client/v2/common/models/account.go (about)

     1  package models
     2  
     3  // Account account information at a given round.
     4  // Definition:
     5  // data/basics/userBalance.go : AccountData
     6  type Account struct {
     7  	// Address the account public key
     8  	Address string `json:"address"`
     9  
    10  	// Amount (algo) total number of MicroAlgos in the account
    11  	Amount uint64 `json:"amount"`
    12  
    13  	// AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account,
    14  	// without the pending rewards.
    15  	AmountWithoutPendingRewards uint64 `json:"amount-without-pending-rewards"`
    16  
    17  	// AppsLocalState (appl) applications local data stored in this account.
    18  	// Note the raw object uses `map[int] -> AppLocalState` for this type.
    19  	AppsLocalState []ApplicationLocalState `json:"apps-local-state,omitempty"`
    20  
    21  	// AppsTotalExtraPages (teap) the sum of all extra application program pages for
    22  	// this account.
    23  	AppsTotalExtraPages uint64 `json:"apps-total-extra-pages,omitempty"`
    24  
    25  	// AppsTotalSchema (tsch) stores the sum of all of the local schemas and global
    26  	// schemas in this account.
    27  	// Note: the raw account uses `StateSchema` for this type.
    28  	AppsTotalSchema ApplicationStateSchema `json:"apps-total-schema,omitempty"`
    29  
    30  	// Assets (asset) assets held by this account.
    31  	// Note the raw object uses `map[int] -> AssetHolding` for this type.
    32  	Assets []AssetHolding `json:"assets,omitempty"`
    33  
    34  	// AuthAddr (spend) the address against which signing should be checked. If empty,
    35  	// the address of the current account is used. This field can be updated in any
    36  	// transaction by setting the RekeyTo field.
    37  	AuthAddr string `json:"auth-addr,omitempty"`
    38  
    39  	// ClosedAtRound round during which this account was most recently closed.
    40  	ClosedAtRound uint64 `json:"closed-at-round,omitempty"`
    41  
    42  	// CreatedApps (appp) parameters of applications created by this account including
    43  	// app global data.
    44  	// Note: the raw account uses `map[int] -> AppParams` for this type.
    45  	CreatedApps []Application `json:"created-apps,omitempty"`
    46  
    47  	// CreatedAssets (apar) parameters of assets created by this account.
    48  	// Note: the raw account uses `map[int] -> Asset` for this type.
    49  	CreatedAssets []Asset `json:"created-assets,omitempty"`
    50  
    51  	// CreatedAtRound round during which this account first appeared in a transaction.
    52  	CreatedAtRound uint64 `json:"created-at-round,omitempty"`
    53  
    54  	// Deleted whether or not this account is currently closed.
    55  	Deleted bool `json:"deleted,omitempty"`
    56  
    57  	// Participation accountParticipation describes the parameters used by this account
    58  	// in consensus protocol.
    59  	Participation AccountParticipation `json:"participation,omitempty"`
    60  
    61  	// PendingRewards amount of MicroAlgos of pending rewards in this account.
    62  	PendingRewards uint64 `json:"pending-rewards"`
    63  
    64  	// RewardBase (ebase) used as part of the rewards computation. Only applicable to
    65  	// accounts which are participating.
    66  	RewardBase uint64 `json:"reward-base,omitempty"`
    67  
    68  	// Rewards (ern) total rewards of MicroAlgos the account has received, including
    69  	// pending rewards.
    70  	Rewards uint64 `json:"rewards"`
    71  
    72  	// Round the round for which this information is relevant.
    73  	Round uint64 `json:"round"`
    74  
    75  	// SigType indicates what type of signature is used by this account, must be one
    76  	// of:
    77  	// * sig
    78  	// * msig
    79  	// * lsig
    80  	// * or null if unknown
    81  	SigType string `json:"sig-type,omitempty"`
    82  
    83  	// Status (onl) delegation status of the account's MicroAlgos
    84  	// * Offline - indicates that the associated account is delegated.
    85  	// * Online - indicates that the associated account used as part of the delegation
    86  	// pool.
    87  	// * NotParticipating - indicates that the associated account is neither a
    88  	// delegator nor a delegate.
    89  	Status string `json:"status"`
    90  
    91  	// TotalAppsOptedIn the count of all applications that have been opted in,
    92  	// equivalent to the count of application local data (AppLocalState objects) stored
    93  	// in this account.
    94  	TotalAppsOptedIn uint64 `json:"total-apps-opted-in"`
    95  
    96  	// TotalAssetsOptedIn the count of all assets that have been opted in, equivalent
    97  	// to the count of AssetHolding objects held by this account.
    98  	TotalAssetsOptedIn uint64 `json:"total-assets-opted-in"`
    99  
   100  	// TotalBoxBytes for app-accounts only. The total number of bytes allocated for the
   101  	// keys and values of boxes which belong to the associated application.
   102  	TotalBoxBytes uint64 `json:"total-box-bytes"`
   103  
   104  	// TotalBoxes for app-accounts only. The total number of boxes which belong to the
   105  	// associated application.
   106  	TotalBoxes uint64 `json:"total-boxes"`
   107  
   108  	// TotalCreatedApps the count of all apps (AppParams objects) created by this
   109  	// account.
   110  	TotalCreatedApps uint64 `json:"total-created-apps"`
   111  
   112  	// TotalCreatedAssets the count of all assets (AssetParams objects) created by this
   113  	// account.
   114  	TotalCreatedAssets uint64 `json:"total-created-assets"`
   115  }