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

     1  package models
     2  
     3  // AssetParams assetParams specifies the parameters for an asset.
     4  // (apar) when part of an AssetConfig transaction.
     5  // Definition:
     6  // data/transactions/asset.go : AssetParams
     7  type AssetParams struct {
     8  	// Clawback (c) Address of account used to clawback holdings of this asset. If
     9  	// empty, clawback is not permitted.
    10  	Clawback string `json:"clawback,omitempty"`
    11  
    12  	// Creator the address that created this asset. This is the address where the
    13  	// parameters for this asset can be found, and also the address where unwanted
    14  	// asset units can be sent in the worst case.
    15  	Creator string `json:"creator"`
    16  
    17  	// Decimals (dc) The number of digits to use after the decimal point when
    18  	// displaying this asset. If 0, the asset is not divisible. If 1, the base unit of
    19  	// the asset is in tenths. If 2, the base unit of the asset is in hundredths, and
    20  	// so on. This value must be between 0 and 19 (inclusive).
    21  	Decimals uint64 `json:"decimals"`
    22  
    23  	// DefaultFrozen (df) Whether holdings of this asset are frozen by default.
    24  	DefaultFrozen bool `json:"default-frozen,omitempty"`
    25  
    26  	// Freeze (f) Address of account used to freeze holdings of this asset. If empty,
    27  	// freezing is not permitted.
    28  	Freeze string `json:"freeze,omitempty"`
    29  
    30  	// Manager (m) Address of account used to manage the keys of this asset and to
    31  	// destroy it.
    32  	Manager string `json:"manager,omitempty"`
    33  
    34  	// MetadataHash (am) A commitment to some unspecified asset metadata. The format of
    35  	// this metadata is up to the application.
    36  	MetadataHash []byte `json:"metadata-hash,omitempty"`
    37  
    38  	// Name (an) Name of this asset, as supplied by the creator. Included only when the
    39  	// asset name is composed of printable utf-8 characters.
    40  	Name string `json:"name,omitempty"`
    41  
    42  	// NameB64 base64 encoded name of this asset, as supplied by the creator.
    43  	NameB64 []byte `json:"name-b64,omitempty"`
    44  
    45  	// Reserve (r) Address of account holding reserve (non-minted) units of this asset.
    46  	Reserve string `json:"reserve,omitempty"`
    47  
    48  	// Total (t) The total number of units of this asset.
    49  	Total uint64 `json:"total"`
    50  
    51  	// UnitName (un) Name of a unit of this asset, as supplied by the creator. Included
    52  	// only when the name of a unit of this asset is composed of printable utf-8
    53  	// characters.
    54  	UnitName string `json:"unit-name,omitempty"`
    55  
    56  	// UnitNameB64 base64 encoded name of a unit of this asset, as supplied by the
    57  	// creator.
    58  	UnitNameB64 []byte `json:"unit-name-b64,omitempty"`
    59  
    60  	// Url (au) URL where more information about the asset can be retrieved. Included
    61  	// only when the URL is composed of printable utf-8 characters.
    62  	Url string `json:"url,omitempty"`
    63  
    64  	// UrlB64 base64 encoded URL where more information about the asset can be
    65  	// retrieved.
    66  	UrlB64 []byte `json:"url-b64,omitempty"`
    67  }