Class ResourceRef

ResourceRef names a single resource. Only one of the fields should be set.

Implements

Encodable

Index

Constructors

constructor

new ResourceRef(__namedParameters): ResourceRef
Creates a new ResourceRef object.
Parameters
- __namedParameters: {
      address?: string | Address;
      applicationId?: number | bigint;
      assetId?: number | bigint;
      box?: indexerModels.BoxReference;
      holding?: HoldingRef;
      local?: LocalsRef;
  }
  - Optional address?: string | Address
  - Optional applicationId?: number | bigint
  - Optional assetId?: number | bigint
  - Optional box?: indexerModels.BoxReference
  - Optional holding?: HoldingRef
  - Optional local?: LocalsRef
Returns ResourceRef
- Defined in client/v2/indexer/models/types.ts:5394

Properties

`Optional` address

address?: Address

(d) Account whose balance record is accessible by the executing ApprovalProgram or ClearStateProgram.

`Optional` applicationId

applicationId?: number

(p) Application id whose GlobalState may be read by the executing ApprovalProgram or ClearStateProgram.

`Optional` assetId

assetId?: number

(s) Asset whose AssetParams may be read by the executing ApprovalProgram or ClearStateProgram.

`Optional` box

box?: indexerModels.BoxReference

BoxReference names a box by its name and the application ID it belongs to.

`Optional` holding

holding?: HoldingRef

HoldingRef names a holding by referring to an Address and Asset it belongs to.

`Optional` local

local?: LocalsRef

LocalsRef names a local state by referring to an Address and App it belongs to.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/indexer/models/types.ts:5310

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/indexer/models/types.ts:5423

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/indexer/models/types.ts:5427

`Static` fromEncodingData

fromEncodingData(data): ResourceRef
Parameters
- data: unknown
Returns ResourceRef
- Defined in client/v2/indexer/models/types.ts:5456

Class ResourceRef

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { address?: string | Address; applicationId?: number | bigint; assetId?: number | bigint; box?: indexerModels.BoxReference; holding?: HoldingRef; local?: LocalsRef; }

Optional address?: string | Address

Optional applicationId?: number | bigint

Optional assetId?: number | bigint

Optional box?: indexerModels.BoxReference

Optional holding?: HoldingRef

Optional local?: LocalsRef

Returns ResourceRef

Properties

Optional address

Optional applicationId

Optional assetId

Optional box

Optional holding

Optional local

Static Private encodingSchemaValue

Accessors

Static encodingSchema

Returns Schema

Methods

getEncodingSchema

Returns Schema

toEncodingData

Returns Map<string, unknown>

Static fromEncodingData

Parameters

data: unknown

Returns ResourceRef

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
address?: string | Address;
applicationId?: number | bigint;
assetId?: number | bigint;
box?: indexerModels.BoxReference;
holding?: HoldingRef;
local?: LocalsRef;
}

`Optional` address?: string | Address

`Optional` applicationId?: number | bigint

`Optional` assetId?: number | bigint

`Optional` box?: indexerModels.BoxReference

`Optional` holding?: HoldingRef

`Optional` local?: LocalsRef

`Optional` address

`Optional` applicationId

`Optional` assetId

`Optional` box

`Optional` holding

`Optional` local

`Static` `Private` encodingSchemaValue

`Static` encodingSchema

`Static` fromEncodingData