Skip to content

@gala-chain/connect ∙ API

API > TokenApi

Class: TokenApi

API client for token-related operations on the GalaChain network. Provides methods for token lifecycle management including creation, minting, transfers, and burns.

Contents

Extends

Constructors

new TokenApi(chainCodeUrl, connection)

new TokenApi(chainCodeUrl, connection): TokenApi

Creates a new TokenApi instance.

Parameters

▪ chainCodeUrl: string

The URL of the token chaincode service

▪ connection: GalaChainProvider

The GalaChain provider for network communication

Overrides

GalaChainBaseApi.constructor

Source

chain-connect/src/chainApis/TokenApi.ts:98

Properties

chainCodeUrl

protected chainCodeUrl: string

The URL of the chaincode service

Inherited from

GalaChainBaseApi.chainCodeUrl

Source

chain-connect/src/chainApis/GalaChainBaseApi.ts:31

connection

protected connection: GalaChainProvider

The GalaChain provider for network communication

Inherited from

GalaChainBaseApi.connection

Source

chain-connect/src/chainApis/GalaChainBaseApi.ts:32

Methods

BatchMintToken()

BatchMintToken(dto): Promise\<GalaChainResponseSuccess\<TokenInstanceKey[]>>

Parameters

▪ dto: BatchMintTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:285

BurnTokens()

BurnTokens(dto): Promise\<GalaChainResponseSuccess\<TokenBurn[]>>

Parameters

▪ dto: BurnTokensRequest

Source

chain-connect/src/chainApis/TokenApi.ts:373

CreateTokenClass()

CreateTokenClass(dto): Promise\<GalaChainResponseSuccess\<TokenClass>>

Parameters

▪ dto: CreateTokenClassRequest

Source

chain-connect/src/chainApis/TokenApi.ts:103

DeleteAllowances()

DeleteAllowances(dto): Promise\<GalaChainResponseSuccess\<unknown>>

Parameters

▪ dto: DeleteAllowancesRequest

Source

chain-connect/src/chainApis/TokenApi.ts:201

DryRun()

DryRun(dto): Promise\<GalaChainResponseSuccess\<DryRunResult>>

Performs a dry run of a chaincode operation without committing to the ledger.

Parameters

▪ dto: PublicProperties\<ConstructorArgs\<DryRunDto>>

The dry run request parameters

Returns

Promise resolving to the dry run results

Inherited from

GalaChainBaseApi.DryRun

Source

chain-connect/src/chainApis/GalaChainBaseApi.ts:40

FetchAllowances()

FetchAllowances(dto): Promise\<GalaChainResponseSuccess\<FetchAllowancesResponse>>

Parameters

▪ dto: FetchAllowancesRequest

Source

chain-connect/src/chainApis/TokenApi.ts:190

FetchBalances()

FetchBalances(dto): Promise\<GalaChainResponseSuccess\<TokenBalance[]>>

Parameters

▪ dto: FetchBalancesRequest

Source

chain-connect/src/chainApis/TokenApi.ts:211

FetchBalancesWithTokenMetadata()

FetchBalancesWithTokenMetadata(dto): Promise\<GalaChainResponseSuccess\<FetchBalancesWithTokenMetadataResponse>>

Parameters

▪ dto: FetchBalancesWithPaginationRequest

Source

chain-connect/src/chainApis/TokenApi.ts:221

FetchBurns()

FetchBurns(dto): Promise\<GalaChainResponseSuccess\<TokenBurn[]>>

Parameters

▪ dto: FetchBurnsRequest

Source

chain-connect/src/chainApis/TokenApi.ts:384

FetchMintRequests()

FetchMintRequests(dto): Promise\<GalaChainResponseSuccess\<MintRequest[]>>

Parameters

▪ dto: FetchMintRequestsRequest

Source

chain-connect/src/chainApis/TokenApi.ts:253

FetchTokenClasses()

FetchTokenClasses(dto): Promise\<GalaChainResponseSuccess\<TokenClass[]>>

Parameters

▪ dto: FetchTokenClassesRequest

Source

chain-connect/src/chainApis/TokenApi.ts:125

FetchTokenClassesWithPagination()

FetchTokenClassesWithPagination(dto): Promise\<GalaChainResponseSuccess\<FetchTokenClassesResponse>>

Parameters

▪ dto: FetchTokenClassesWithPaginationRequest

Source

chain-connect/src/chainApis/TokenApi.ts:146

FetchTokenClassesWithSupply()

FetchTokenClassesWithSupply(dto): Promise\<GalaChainResponseSuccess\<TokenClass[]>>

Parameters

▪ dto: FetchTokenClassesRequest

Source

chain-connect/src/chainApis/TokenApi.ts:135

FulfillMint()

FulfillMint(dto): Promise\<GalaChainResponseSuccess\<TokenInstanceKey[]>>

Parameters

▪ dto: FulfillMintRequest

Source

chain-connect/src/chainApis/TokenApi.ts:242

FullAllowanceCheck()

FullAllowanceCheck(dto): Promise\<GalaChainResponseSuccess\<FullAllowanceCheckResponse>>

Parameters

▪ dto: FullAllowanceCheckRequest

Source

chain-connect/src/chainApis/TokenApi.ts:179

GetObjectByKey()

GetObjectByKey\<T>(dto): Promise\<GalaChainResponseSuccess\<T>>

Retrieves an object from the blockchain by its key.

Type parameters

▪ T = Record\<string, unknown>

The expected type of the retrieved object

Parameters

▪ dto: PublicProperties\<ConstructorArgs\<GetObjectDto>>

The object key request parameters

Returns

Promise resolving to the retrieved object

Inherited from

GalaChainBaseApi.GetObjectByKey

Source

chain-connect/src/chainApis/GalaChainBaseApi.ts:61

GetObjectHistory()

GetObjectHistory\<T>(dto): Promise\<GalaChainResponseSuccess\<T>>

Retrieves the history of changes for an object from the blockchain.

Type parameters

▪ T = Record\<string, unknown>

The expected type of the historical objects

Parameters

▪ dto: PublicProperties\<ConstructorArgs\<GetObjectHistoryDto>>

The object history request parameters

Returns

Promise resolving to the object's history

Inherited from

GalaChainBaseApi.GetObjectHistory

Source

chain-connect/src/chainApis/GalaChainBaseApi.ts:77

GrantAllowance()

GrantAllowance(dto): Promise\<GalaChainResponseSuccess\<TokenAllowance[]>>

Parameters

▪ dto: GrantAllowanceRequest

Source

chain-connect/src/chainApis/TokenApi.ts:157

LockToken()

LockToken(dto): Promise\<GalaChainResponseSuccess\<TokenBalance>>

Parameters

▪ dto: LockTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:318

LockTokens()

LockTokens(dto): Promise\<GalaChainResponseSuccess\<TokenBalance[]>>

Parameters

▪ dto: LockTokensRequest

Source

chain-connect/src/chainApis/TokenApi.ts:329

MintToken()

MintToken(dto): Promise\<GalaChainResponseSuccess\<TokenInstanceKey[]>>

Parameters

▪ dto: MintTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:263

MintTokenWithAllowance()

MintTokenWithAllowance(dto): Promise\<GalaChainResponseSuccess\<TokenInstanceKey[]>>

Parameters

▪ dto: MintTokenWithAllowanceRequest

Source

chain-connect/src/chainApis/TokenApi.ts:274

RefreshAllowances()

RefreshAllowances(dto): Promise\<GalaChainResponseSuccess\<TokenAllowance[]>>

Parameters

▪ dto: RefreshAllowanceRequest

Source

chain-connect/src/chainApis/TokenApi.ts:168

ReleaseToken()

ReleaseToken(dto): Promise\<GalaChainResponseSuccess\<TokenBalance>>

Parameters

▪ dto: ReleaseTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:307

RequestMint()

RequestMint(dto): Promise\<GalaChainResponseSuccess\<HighThroughputMintTokenResponse>>

Parameters

▪ dto: HighThroughputMintTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:231

TransferToken()

TransferToken(dto): Promise\<GalaChainResponseSuccess\<TokenBalance[]>>

Parameters

▪ dto: TransferTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:362

UnlockToken()

UnlockToken(dto): Promise\<GalaChainResponseSuccess\<TokenBalance>>

Parameters

▪ dto: UnlockTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:340

UnlockTokens()

UnlockTokens(dto): Promise\<GalaChainResponseSuccess\<TokenBalance[]>>

Parameters

▪ dto: UnlockTokensRequest

Source

chain-connect/src/chainApis/TokenApi.ts:351

UpdateTokenClass()

UpdateTokenClass(dto): Promise\<GalaChainResponseSuccess\<TokenClassKey>>

Parameters

▪ dto: UpdateTokenClassRequest

Source

chain-connect/src/chainApis/TokenApi.ts:114

UseToken()

UseToken(dto): Promise\<GalaChainResponseSuccess\<TokenBalance>>

Parameters

▪ dto: UseTokenRequest

Source

chain-connect/src/chainApis/TokenApi.ts:296