@gala-chain/connect ∙ API

---

API > TokenApi

Class: TokenApi

Contents

• Extends
• Constructors
• new TokenApi(chainCodeUrl, connection)
• Properties
• chainCodeUrl
• connection
• Methods
• BatchMintToken()
• BurnTokens()
• CreateTokenClass()
• DeleteAllowances()
• DryRun()
• FetchAllowances()
• FetchBalances()
• FetchBalancesWithTokenMetadata()
• FetchBurns()
• FetchMintRequests()
• FetchTokenClasses()
• FetchTokenClassesWithPagination()
• FetchTokenClassesWithSupply()
• FulfillMint()
• FullAllowanceCheck()
• GetObjectByKey()
• GetObjectHistory()
• GrantAllowance()
• LockToken()
• LockTokens()
• MintToken()
• MintTokenWithAllowance()
• RefreshAllowances()
• ReleaseToken()
• RequestMint()
• TransferToken()
• UnlockToken()
• UnlockTokens()
• UpdateTokenClass()
• UseToken()

Extends

• GalaChainBaseApi

Constructors

new TokenApi(chainCodeUrl, connection)

new TokenApi(chainCodeUrl, connection): TokenApi

Parameters

▪ chainCodeUrl: string

▪ connection: GalaChainProvider

Overrides

GalaChainBaseApi.constructor

Source

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

Properties

chainCodeUrl

protected chainCodeUrl: string

Inherited from

GalaChainBaseApi.chainCodeUrl

Source

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

---

connection

protected connection: GalaChainProvider

Inherited from

GalaChainBaseApi.connection

Source

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

Methods

BatchMintToken()

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

Parameters

▪ dto: BatchMintTokenRequest

Source

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

---

BurnTokens()

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

Parameters

▪ dto: BurnTokensRequest

Source

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

---

CreateTokenClass()

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

Parameters

▪ dto: CreateTokenClassRequest

Source

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

---

DeleteAllowances()

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

Parameters

▪ dto: DeleteAllowancesRequest

Source

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

---

DryRun()

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

Parameters

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

Inherited from

GalaChainBaseApi.DryRun

Source

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

---

FetchAllowances()

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

Parameters

▪ dto: FetchAllowancesRequest

Source

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

---

FetchBalances()

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

Parameters

▪ dto: FetchBalancesRequest

Source

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

---

FetchBalancesWithTokenMetadata()

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

Parameters

▪ dto: FetchBalancesWithPaginationRequest

Source

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

---

FetchBurns()

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

Parameters

▪ dto: FetchBurnsRequest

Source

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

---

FetchMintRequests()

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

Parameters

▪ dto: FetchMintRequestsRequest

Source

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

---

FetchTokenClasses()

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

Parameters

▪ dto: FetchTokenClassesRequest

Source

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

---

FetchTokenClassesWithPagination()

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

Parameters

▪ dto: FetchTokenClassesWithPaginationRequest

Source

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

---

FetchTokenClassesWithSupply()

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

Parameters

▪ dto: FetchTokenClassesRequest

Source

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

---

FulfillMint()

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

Parameters

▪ dto: FulfillMintRequest

Source

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

---

FullAllowanceCheck()

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

Parameters

▪ dto: FullAllowanceCheckRequest

Source

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

---

GetObjectByKey()

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

Type parameters

▪ T = Record\<string, unknown>

Parameters

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

Inherited from

GalaChainBaseApi.GetObjectByKey

Source

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

---

GetObjectHistory()

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

Type parameters

▪ T = Record\<string, unknown>

Parameters

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

Inherited from

GalaChainBaseApi.GetObjectHistory

Source

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

---

GrantAllowance()

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

Parameters

▪ dto: GrantAllowanceRequest

Source

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

---

LockToken()

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

Parameters

▪ dto: LockTokenRequest

Source

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

---

LockTokens()

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

Parameters

▪ dto: LockTokensRequest

Source

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

---

MintToken()

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

Parameters

▪ dto: MintTokenRequest

Source

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

---

MintTokenWithAllowance()

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

Parameters

▪ dto: MintTokenWithAllowanceRequest

Source

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

---

RefreshAllowances()

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

Parameters

▪ dto: RefreshAllowanceRequest

Source

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

---

ReleaseToken()

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

Parameters

▪ dto: ReleaseTokenRequest

Source

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

---

RequestMint()

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

Parameters

▪ dto: HighThroughputMintTokenRequest

Source

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

---

TransferToken()

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

Parameters

▪ dto: TransferTokenRequest

Source

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

---

UnlockToken()

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

Parameters

▪ dto: UnlockTokenRequest

Source

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

---

UnlockTokens()

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

Parameters

▪ dto: UnlockTokensRequest

Source

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

---

UpdateTokenClass()

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

Parameters

▪ dto: UpdateTokenClassRequest

Source

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

---

UseToken()

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

Parameters

▪ dto: UseTokenRequest

Source

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