Class AssetHolding

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

Hierarchy

BaseModel
- AssetHolding

Index

Constructors

Properties

amount assetId attribute_map isFrozen

Methods

get_obj_for_encoding from_obj_for_encoding

Constructors

constructor

new AssetHolding(__namedParameters: { amount: number | bigint; assetId: number | bigint; isFrozen: boolean }): modelsv2.AssetHolding
Creates a new AssetHolding object.
Parameters
- __namedParameters: { amount: number | bigint; assetId: number | bigint; isFrozen: boolean }
  - amount: number | bigint
  - assetId: number | bigint
  - isFrozen: boolean
Returns modelsv2.AssetHolding
Overrides BaseModel.constructor
- Defined in client/v2/algod/models/types.ts:1405

Properties

amount

amount: number | bigint

(a) number of units held.

assetId

assetId: number | bigint

Asset ID of the holding.

attribute_map

attribute_map: Record<string, string>

isFrozen

isFrozen: boolean

(f) whether or not the holding is frozen.

Methods

get_obj_for_encoding

get_obj_for_encoding(binary?: boolean): Record<string, any>
Get an object ready for encoding to either JSON or msgpack.
Parameters
- binary: boolean = false
  
  Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.
Returns Record<string, any>
Inherited from BaseModel.get_obj_for_encoding
- Defined in client/v2/basemodel.ts:65

`Static` from_obj_for_encoding

from_obj_for_encoding(data: Record<string, any>): modelsv2.AssetHolding
Parameters
- data: Record<string, any>
Returns modelsv2.AssetHolding
- Defined in client/v2/algod/models/types.ts:1427

Generated using TypeDoc