Class Token

Hierarchy

Token

Implements

Model

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Token(client: HttpClient, pod: Readonly<PODModel & { consumesAssets: boolean; creator: string; grant: TokenGrantSpec; name?: string; transferability: TokenTransferability }>): Token

- Defined in src/tokenization.ts:45
Parameters
- client: HttpClient
- pod: Readonly<PODModel & { consumesAssets: boolean; creator: string; grant: TokenGrantSpec; name?: string; transferability: TokenTransferability }>
Returns Token

Properties

Private #client

#client: HttpClient

Readonly consumesAssets

consumesAssets: boolean

Readonly createdAt

createdAt: Date

The number of seconds since the Unix epoch when this model was created

Readonly creator

creator: IdentityId

Readonly grant

grant: TokenGrantSpec

Readonly id

The model's unique ID.

Optional Readonly name

name: string

Readonly transferability

transferability: TokenTransferability

Methods

addAsset

addAsset(asset: AssetId): Promise<TokenizationReceipt>

- Defined in src/tokenization.ts:73
Adds an asset to this token. The asset must be held by the escrow identity and not have been consumed by another token.

Parameters
- asset: AssetId
Returns Promise<TokenizationReceipt>

delete

delete(): Promise<void>

- Defined in src/tokenization.ts:56
Returns Promise<void>

listTransfers

listTransfers(filter?: ListTokenTransfersFilter & Partial<{ pageSize: number; pageToken: string }>): Promise<Page<TransferReceipt>>

- Defined in src/tokenization.ts:89
Parameters
- Optional filter: ListTokenTransfersFilter & Partial<{ pageSize: number; pageToken: string }>
Returns Promise<Page<TransferReceipt>>

removeAsset

removeAsset(asset: AssetId): Promise<void>

- Defined in src/tokenization.ts:81
Removes an asset from this token. You must hold the entire supply of the token to do this. If this token previously consumed the asset, it will again become available to tokenize.

Parameters
- asset: AssetId
Returns Promise<void>

searchAssets

searchAssets(filter?: Except<EscrowedAssetSearchParams, "token"> & Partial<{ pageSize: number; pageToken: string }>): Promise<Page<EscrowedAsset>>

- Defined in src/tokenization.ts:60
Parameters
- Optional filter: Except<EscrowedAssetSearchParams, "token"> & Partial<{ pageSize: number; pageToken: string }>
Returns Promise<Page<EscrowedAsset>>

transfer

transfer(amount: number, recipient: IdentityId): Promise<TransferReceipt>

- Defined in src/tokenization.ts:85
Parameters
- amount: number
- recipient: IdentityId
Returns Promise<TransferReceipt>

Generated using TypeDoc