Polymesh

Main entry point of the Polymesh SDK

Hierarchy

• Polymesh

Index

Properties

• claims

• middleware

• settlements

Accessors

• _polkadotApi

Methods

• addSigner

• claimClassicTicker

• disconnect

• getAccount

• getAccountBalance

• getAccounts

• getCurrentIdentity

• getIdentity

• getLatestBlock

• getNetworkProperties

• getSecurityToken

• getSecurityTokens

• getTickerReservation

• getTickerReservations

• getTransactionFees

• getTreasuryAccount

• getTreasuryBalance

• isIdentityValid

• isTickerAvailable

• onConnectionError

• onDisconnect

• registerIdentity

• reserveTicker

• setSigner

• transferPolyx

• connect

Properties

claims

• claims: Claims

Defined in src/Polymesh.ts:79

middleware

• middleware: Middleware

Defined in src/Polymesh.ts:80

settlements

• settlements: Settlements

Defined in src/Polymesh.ts:81

Accessors

_polkadotApi

• get _polkadotApi(): ApiPromise

Defined in src/Polymesh.ts:756

Polkadot client

Returns: ApiPromise

Methods

addSigner

▸ addSigner(params: object): Account

Defined in src/Polymesh.ts:711

Adds a new signing key to the SDK instance. This will not change the current signer. For that, you must explicitly call setSigner

Parameters:

▪ params: object

Name	Type	Description
accountSeed	string	hex seed of the account

Returns: Account

▸ addSigner(params: object): Account

Defined in src/Polymesh.ts:719

Adds a new signing key to the SDK instance. This will not change the current signer. For that, you must explicitly call setSigner

Parameters:

▪ params: object

Name	Type	Description
accountMnemonic	string	account mnemonic

Returns: Account

▸ addSigner(params: object): Account

Defined in src/Polymesh.ts:727

Adds a new signing key to the SDK instance. This will not change the current signer. For that, you must explicitly call setSigner

Parameters:

▪ params: object

Name	Type	Description
accountUri	string	account URI

Returns: Account

claimClassicTicker

▸ claimClassicTicker(args: ClaimClassicTickerParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹TickerReservation››

Defined in src/Polymesh.ts:353

Claim a ticker symbol that was reserved in Polymath Classic (Ethereum). The Ethereum account that owns the ticker must sign a special message that contains the DID of the Identity that will own the ticker in Polymesh, and provide the signed data to this call

note this method is of type ProcedureMethod, which means you can call claimClassicTicker.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ClaimClassicTickerParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹TickerReservation››

disconnect

▸ disconnect(): Promise‹void›

Defined in src/Polymesh.ts:701

Disconnect the client and close all open connections and subscriptions

note the SDK will become unusable after this operation. It will throw an error when attempting to access any chain or middleware data. If you wish to continue using the SDK, you must create a new instance by calling connect

Returns: Promise‹void›

getAccount

▸ getAccount(): CurrentAccount

Defined in src/Polymesh.ts:475

Create an Account instance from an address. If no address is passed, the current Account is returned

Returns: CurrentAccount

▸ getAccount(args: object): Account

Defined in src/Polymesh.ts:476

Parameters:

▪ args: object

Name	Type
address	string

Returns: Account

getAccountBalance

▸ getAccountBalance(args?: undefined | object): Promise‹AccountBalance›

Defined in src/Polymesh.ts:291

Get the free/locked POLYX balance of an Account

note can be subscribed to

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹AccountBalance›

▸ getAccountBalance(callback: SubCallback‹AccountBalance›): Promise‹UnsubCallback›

Defined in src/Polymesh.ts:292

Parameters:

Name	Type
callback	SubCallback‹AccountBalance›

Returns: Promise‹UnsubCallback›

▸ getAccountBalance(args: object, callback: SubCallback‹AccountBalance›): Promise‹UnsubCallback›

Defined in src/Polymesh.ts:293

Parameters:

▪ args: object

Name	Type
account	string | Account

▪ callback: SubCallback‹AccountBalance›

Returns: Promise‹UnsubCallback›

getAccounts

▸ getAccounts(): []

Defined in src/Polymesh.ts:494

Return a list that contains all the signing Accounts associated to the SDK instance

throws — if there is no current Account associated to the SDK instance

Returns: []

getCurrentIdentity

▸ getCurrentIdentity(): Promise‹CurrentIdentity | null›

Defined in src/Polymesh.ts:468

Retrieve the Identity associated to the current Account (null if there is none)

Returns: Promise‹CurrentIdentity | null›

getIdentity

▸ getIdentity(args: object): Identity

Defined in src/Polymesh.ts:461

Create an Identity instance from a DID

Parameters:

▪ args: object

Name	Type
did	string

Returns: Identity

getLatestBlock

▸ getLatestBlock(): Promise‹BigNumber›

Defined in src/Polymesh.ts:690

Retrieve the number of the latest block in the chain

Returns: Promise‹BigNumber›

getNetworkProperties

▸ getNetworkProperties(): Promise‹NetworkProperties›

Defined in src/Polymesh.ts:626

Retrieve information for the current network

Returns: Promise‹NetworkProperties›

getSecurityToken

▸ getSecurityToken(args: object): Promise‹SecurityToken›

Defined in src/Polymesh.ts:600

Retrieve a Security Token

Parameters:

▪ args: object

Name	Type	Description
ticker	string	Security Token ticker

Returns: Promise‹SecurityToken›

getSecurityTokens

▸ getSecurityTokens(args?: undefined | object): Promise‹SecurityToken[]›

Defined in src/Polymesh.ts:568

Retrieve all the Security Tokens owned by an Identity

note tokens with unreadable characters in their tickers will be left out

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹SecurityToken[]›

getTickerReservation

▸ getTickerReservation(args: object): Promise‹TickerReservation›

Defined in src/Polymesh.ts:428

Retrieve a Ticker Reservation

Parameters:

▪ args: object

Name	Type	Description
ticker	string	Security Token ticker

Returns: Promise‹TickerReservation›

getTickerReservations

▸ getTickerReservations(args?: undefined | object): Promise‹TickerReservation[]›

Defined in src/Polymesh.ts:394

Retrieve all the ticker reservations currently owned by an Identity. This doesn't include tokens that have already been launched

note reservations with unreadable characters in their tickers will be left out

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹TickerReservation[]›

getTransactionFees

▸ getTransactionFees(args: object): Promise‹BigNumber›

Defined in src/Polymesh.ts:512

Retrieve the protocol fees associated with running a specific transaction

Parameters:

▪ args: object

Name	Type	Description
tag	TxTag	transaction tag (i.e. TxTags.asset.CreateAsset or "asset.createAsset")

Returns: Promise‹BigNumber›

getTreasuryAccount

▸ getTreasuryAccount(): Account

Defined in src/Polymesh.ts:519

Get the treasury wallet address

Returns: Account

getTreasuryBalance

▸ getTreasuryBalance(): Promise‹BigNumber›

Defined in src/Polymesh.ts:650

Get the Treasury POLYX balance

note can be subscribed to

Returns: Promise‹BigNumber›

▸ getTreasuryBalance(callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›

Defined in src/Polymesh.ts:651

Parameters:

Name	Type
callback	SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

isIdentityValid

▸ isIdentityValid(args: object): Promise‹boolean›

Defined in src/Polymesh.ts:501

Return whether the supplied Identity/DID exists

Parameters:

▪ args: object

Name	Type
identity	Identity | string

Returns: Promise‹boolean›

isTickerAvailable

▸ isTickerAvailable(args: object): Promise‹boolean›

Defined in src/Polymesh.ts:362

Check if a ticker hasn't been reserved

note can be subscribed to

Parameters:

▪ args: object

Name	Type
ticker	string

Returns: Promise‹boolean›

▸ isTickerAvailable(args: object, callback: SubCallback‹boolean›): Promise‹UnsubCallback›

Defined in src/Polymesh.ts:363

Parameters:

▪ args: object

Name	Type
ticker	string

▪ callback: SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

onConnectionError

▸ onConnectionError(callback: function): function

Defined in src/Polymesh.ts:532

Handle connection errors

Parameters:

▪ callback: function

▸ (...args: unknown[]): unknown

Parameters:

Name	Type
...args	unknown[]

Returns: function

an unsubscribe callback

▸ (): void

onDisconnect

▸ onDisconnect(callback: function): function

Defined in src/Polymesh.ts:549

Handle disconnection

Parameters:

▪ callback: function

▸ (...args: unknown[]): unknown

Parameters:

Name	Type
...args	unknown[]

Returns: function

an unsubscribe callback

▸ (): void

registerIdentity

▸ registerIdentity(args: RegisterIdentityParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Identity››

Defined in src/Polymesh.ts:683

Register an Identity

note must be a CDD provider

note this may create Authorization Requests which have to be accepted by the corresponding Accounts and/or Identities. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

• Customer Due Diligence Provider

note this method is of type ProcedureMethod, which means you can call registerIdentity.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	RegisterIdentityParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Identity››

reserveTicker

▸ reserveTicker(args: ReserveTickerParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹TickerReservation››

Defined in src/Polymesh.ts:341

Reserve a ticker symbol to later use in the creation of a Security Token. The ticker will expire after a set amount of time, after which other users can reserve it

note this method is of type ProcedureMethod, which means you can call reserveTicker.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ReserveTickerParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹TickerReservation››

setSigner

▸ setSigner(signer: string | Account): void

Defined in src/Polymesh.ts:746

Set the SDK's current signing key to the provided address

note the key must have been previously added via addSigner

Parameters:

Name	Type
signer	string | Account

Returns: void

transferPolyx

▸ transferPolyx(args: TransferPolyxParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/Polymesh.ts:280

Transfer an amount of POLYX to a specified Account

note this method is of type ProcedureMethod, which means you can call transferPolyx.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	TransferPolyxParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

Static connect

▸ connect(params: ConnectParamsBase & object): Promise‹Polymesh›

Defined in src/Polymesh.ts:128

Create the instance and connect to the Polymesh node using an account seed

Parameters:

Name	Type
params	ConnectParamsBase & object

Returns: Promise‹Polymesh›

▸ connect(params: ConnectParamsBase & object): Promise‹Polymesh›

Defined in src/Polymesh.ts:138

Create the instance and connect to the Polymesh node using a keyring

Parameters:

Name	Type
params	ConnectParamsBase & object

Returns: Promise‹Polymesh›

▸ connect(params: ConnectParamsBase & object): Promise‹Polymesh›

Defined in src/Polymesh.ts:151

Create the instance and connect to the Polymesh node using an account URI

Parameters:

Name	Type
params	ConnectParamsBase & object

Returns: Promise‹Polymesh›

▸ connect(params: ConnectParamsBase & object): Promise‹Polymesh›

Defined in src/Polymesh.ts:161

Create the instance and connect to the Polymesh node using an account mnemonic

Parameters:

Name	Type
params	ConnectParamsBase & object

Returns: Promise‹Polymesh›

▸ connect(params: ConnectParamsBase): Promise‹Polymesh›

Defined in src/Polymesh.ts:170

Create the instance and connect to the Polymesh node without an account

Parameters:

Name	Type
params	ConnectParamsBase

Returns: Promise‹Polymesh›