Context
Context in which the SDK is being used
Holds the current low level API
Holds the current keyring pair
Holds the current Identity
Hierarchy
Context
Index
Properties
Accessors
Methods
Properties
Optional currentPair
Optional currentPair• currentPair? : KeyringPair
Defined in src/base/Context.ts:114
isArchiveNode
• isArchiveNode: boolean = false
Defined in src/base/Context.ts:119
Whether the current node is an archive node (contains a full history from genesis onward) or not
polymeshApi
• polymeshApi: ApiPromise
Defined in src/base/Context.ts:112
ss58Format
• ss58Format: number
Defined in src/base/Context.ts:121
Accessors
middlewareApi
• get middlewareApi(): ApolloClient‹NormalizedCacheObject›
Defined in src/base/Context.ts:953
Retrieve the middleware client
throws if the middleware is not enabled
Returns: ApolloClient‹NormalizedCacheObject›
Methods
accountBalance
▸ accountBalance(account?: string | Account): Promise‹AccountBalance›
Defined in src/base/Context.ts:344
Retrieve the account level POLYX balance
note can be subscribed to
Parameters:
Name
Type
account?
string | Account
Returns: Promise‹AccountBalance›
▸ accountBalance(account: string | Account | undefined, callback: SubCallback‹AccountBalance›): Promise‹UnsubCallback›
Defined in src/base/Context.ts:345
Retrieve the account level POLYX balance
note can be subscribed to
Parameters:
Returns: Promise‹UnsubCallback›
addPair
▸ addPair(params: AddPairParams): KeyringPair
Defined in src/base/Context.ts:284
Add a signing pair to the Keyring
Parameters:
Name
Type
params
Returns: KeyringPair
clone
▸ clone(): Context
Defined in src/base/Context.ts:1041
Returns a (shallow) clone of this instance. Useful for providing a separate Context to Procedures with different signers
Returns: Context
disconnect
▸ disconnect(): Promise‹void›
Defined in src/base/Context.ts:1023
Disconnect the Polkadot API, middleware, and render this instance unusable
note after disconnecting, trying to access any property in this objecct will result in an error
Returns: Promise‹void›
getAccounts
▸ getAccounts(): []
Defined in src/base/Context.ts:261
Retrieve a list of Accounts that can act as signers
Returns: []
getCurrentAccount
▸ getCurrentAccount(): CurrentAccount
Defined in src/base/Context.ts:406
Retrieve current Account
throws if there is no current account associated to the SDK instance
Returns: CurrentAccount
getCurrentIdentity
▸ getCurrentIdentity(): Promise‹CurrentIdentity›
Defined in src/base/Context.ts:426
Retrieve current Identity
throws if there is no Identity associated to the current Account (or there is no current Account associated to the SDK instance)
Returns: Promise‹CurrentIdentity›
getCurrentPair
▸ getCurrentPair(): KeyringPair
Defined in src/base/Context.ts:446
Retrieve current Keyring Pair
throws if there is no Account associated to the SDK instance
Returns: KeyringPair
getInvalidDids
▸ getInvalidDids(identities: (string | Identity‹›)[]): Promise‹string[]›
Defined in src/base/Context.ts:475
Check whether Identities exist
Parameters:
Name
Type
identities
(string | Identity‹›)[]
Returns: Promise‹string[]›
getLatestBlock
▸ getLatestBlock(): Promise‹BigNumber›
Defined in src/base/Context.ts:1011
Retrieve the latest block number
Returns: Promise‹BigNumber›
getSigner
▸ getSigner(): AddressOrPair
Defined in src/base/Context.ts:462
Retrieve the signer address (or keyring pair)
Returns: AddressOrPair
getTransactionArguments
▸ getTransactionArguments(args: object): TransactionArgument[]
Defined in src/base/Context.ts:525
Retrieve the types of arguments that a certain transaction requires to be run
Parameters:
▪ args: object
Name
Type
Description
tag
TxTag
tag associated with the transaction that will be executed if the proposal passes
Returns: TransactionArgument[]
getTransactionFees
▸ getTransactionFees(tag: TxTag): Promise‹BigNumber›
Defined in src/base/Context.ts:498
Retrieve the protocol fees associated with running a specific transaction
Parameters:
Name
Type
Description
tag
TxTag
transaction tag (i.e. TxTags.asset.CreateAsset or "asset.createAsset")
Returns: Promise‹BigNumber›
isMiddlewareAvailable
▸ isMiddlewareAvailable(): Promise‹boolean›
Defined in src/base/Context.ts:998
Return whether the middleware is enabled and online
Returns: Promise‹boolean›
isMiddlewareEnabled
▸ isMiddlewareEnabled(): boolean
Defined in src/base/Context.ts:991
Return whether the middleware was enabled at startup
Returns: boolean
issuedClaims
▸ issuedClaims(opts: object): Promise‹ResultSet‹ClaimData››
Defined in src/base/Context.ts:902
Retrieve a list of claims. Can be filtered using parameters
note uses the middleware (optional)
Parameters:
▪Default value opts: object= {}
Name
Type
Description
claimTypes?
types of the claims to fetch. Defaults to any type
includeExpired?
undefined | false | true
whether to include expired claims. Defaults to true
size?
undefined | number
page size
start?
undefined | number
page offset
targets?
(string | Identity‹›)[]
identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets
trustedClaimIssuers?
(string | Identity‹›)[]
identity IDs of claim issuers. Defaults to all claim issuers
Returns: Promise‹ResultSet‹ClaimData››
queryMiddleware
▸ queryMiddleware‹Result›(query: GraphqlQuery‹unknown›): Promise‹ApolloQueryResult‹Result››
Defined in src/base/Context.ts:969
Make a query to the middleware server using the apollo client
Type parameters:
▪ Result: Partial‹Query›
Parameters:
Name
Type
query
GraphqlQuery‹unknown›
Returns: Promise‹ApolloQueryResult‹Result››
setPair
▸ setPair(address: string): void
Defined in src/base/Context.ts:326
Set a pair as the current Account keyring pair
Parameters:
Name
Type
address
string
Returns: void
Static create
Static create▸ create(params: object): Promise‹Context›
Defined in src/base/Context.ts:182
Create the Context instance
Parameters:
▪ params: object
Name
Type
accountMnemonic?
undefined | string
accountSeed?
undefined | string
accountUri?
undefined | string
keyring?
middlewareApi
ApolloClient‹NormalizedCacheObject› | null
polymeshApi
ApiPromise
Returns: Promise‹Context›
Last updated