Class TokenEndpoint

Hierarchy

BaseEndpoint
- TokenEndpoint

Index

Constructors

Properties

Methods

getBalance getBalances getEscrowedAmounts getInitializationFees getSupportedTokens getTotalSupply hasEscrowAccount hasUserAccount init isSupported

Constructors

constructor

new TokenEndpoint(stores: NamedRegistry, offchainStores: NamedRegistry): TokenEndpoint
Parameters
- stores: NamedRegistry
- offchainStores: NamedRegistry
Returns TokenEndpoint
Inherited from BaseEndpoint.constructor
- Defined in framework/src/modules/base_endpoint.ts:20

Properties

`Private` _moduleConfig

_moduleConfig: ModuleConfig

`Protected` offchainStores

offchainStores: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

getBalance

getBalance(context: ModuleEndpointContext): Promise<{
availableBalance: string;
lockedBalances: ({ module: string; amount: string; })[];
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
availableBalance: string;
lockedBalances: ({ module: string; amount: string; })[];
}>
- Defined in framework/src/modules/token/endpoint.ts:65

getBalances

getBalances(context: ModuleEndpointContext): Promise<{
    balances: {
        availableBalance: string;
        lockedBalances: ({ module: string; amount: string; })[];
        tokenID: string;
    }[];
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
    balances: {
        availableBalance: string;
        lockedBalances: ({ module: string; amount: string; })[];
        tokenID: string;
    }[];
}>
- Defined in framework/src/modules/token/endpoint.ts:41

getEscrowedAmounts

getEscrowedAmounts(context: ModuleEndpointContext): Promise<{
    escrowedAmounts: {
        amount: string;
        escrowChainID: string;
        tokenID: string;
    }[];
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
    escrowedAmounts: {
        amount: string;
        escrowChainID: string;
        tokenID: string;
    }[];
}>
- Defined in framework/src/modules/token/endpoint.ts:161

getInitializationFees

getInitializationFees(): {
escrowAccount: string;
userAccount: string;
}
Returns {
escrowAccount: string;
userAccount: string;
}
- escrowAccount: string
- userAccount: string
- Defined in framework/src/modules/token/endpoint.ts:182

getSupportedTokens

getSupportedTokens(context: ModuleEndpointContext): Promise<{
supportedTokens: string[];
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
supportedTokens: string[];
}>
- Defined in framework/src/modules/token/endpoint.ts:108

getTotalSupply

getTotalSupply(context: ModuleEndpointContext): Promise<{
    totalSupply: {
        tokenID: string;
        totalSupply: string;
    }[];
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
    totalSupply: {
        tokenID: string;
        totalSupply: string;
    }[];
}>
- Defined in framework/src/modules/token/endpoint.ts:94

hasEscrowAccount

hasEscrowAccount(context: ModuleEndpointContext): Promise<{
exists: boolean;
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
exists: boolean;
}>
- Defined in framework/src/modules/token/endpoint.ts:202

hasUserAccount

hasUserAccount(context: ModuleEndpointContext): Promise<{
exists: boolean;
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
exists: boolean;
}>
- Defined in framework/src/modules/token/endpoint.ts:189

init

init(moduleConfig: ModuleConfig): void
Parameters
- moduleConfig: ModuleConfig
Returns void
- Defined in framework/src/modules/token/endpoint.ts:37

isSupported

isSupported(context: ModuleEndpointContext): Promise<{
supported: boolean;
}>
Parameters
- context: ModuleEndpointContext
Returns Promise<{
supported: boolean;
}>
- Defined in framework/src/modules/token/endpoint.ts:152

Class TokenEndpoint

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

offchainStores: NamedRegistry

Returns TokenEndpoint

Properties

Private _moduleConfig

Protected offchainStores

Protected stores

Methods

getBalance

Parameters

context: ModuleEndpointContext

Returns Promise<{ availableBalance: string; lockedBalances: ({ module: string; amount: string; })[]; }>

getBalances

Parameters

context: ModuleEndpointContext

Returns Promise<{ balances: { availableBalance: string; lockedBalances: ({ module: string; amount: string; })[]; tokenID: string; }[]; }>

getEscrowedAmounts

Parameters

context: ModuleEndpointContext

Returns Promise<{ escrowedAmounts: { amount: string; escrowChainID: string; tokenID: string; }[]; }>

getInitializationFees

Returns { escrowAccount: string; userAccount: string; }

escrowAccount: string

userAccount: string

getSupportedTokens

Parameters

context: ModuleEndpointContext

Returns Promise<{ supportedTokens: string[]; }>

getTotalSupply

Parameters

context: ModuleEndpointContext

Returns Promise<{ totalSupply: { tokenID: string; totalSupply: string; }[]; }>

hasEscrowAccount

Parameters

context: ModuleEndpointContext

Returns Promise<{ exists: boolean; }>

hasUserAccount

Parameters

context: ModuleEndpointContext

Returns Promise<{ exists: boolean; }>

init

Parameters

moduleConfig: ModuleConfig

Returns void

isSupported

Parameters

context: ModuleEndpointContext

Returns Promise<{ supported: boolean; }>

Settings

Member Visibility

Theme

On This Page

`Private` _moduleConfig

`Protected` offchainStores

`Protected` stores

Returns Promise<{
availableBalance: string;
lockedBalances: ({ module: string; amount: string; })[];
}>

Returns Promise<{
balances: {
availableBalance: string;
lockedBalances: ({ module: string; amount: string; })[];
tokenID: string;
}[];
}>

Returns Promise<{
escrowedAmounts: {
amount: string;
escrowChainID: string;
tokenID: string;
}[];
}>

Returns {
escrowAccount: string;
userAccount: string;
}

Returns Promise<{
supportedTokens: string[];
}>

Returns Promise<{
totalSupply: {
tokenID: string;
totalSupply: string;
}[];
}>

Returns Promise<{
exists: boolean;
}>

Returns Promise<{
exists: boolean;
}>

Returns Promise<{
supported: boolean;
}>