Polymesh

Main entry point of the Polymesh SDK

Hierarchy

Polymesh

Index

Properties

Accessors

_polkadotApi

Methods

Properties

claims

• claims: Claims

Defined in src/Polymesh.ts:74

middleware

• middleware: Middleware

Defined in src/Polymesh.ts:75

registerIdentity

• registerIdentity: ProcedureMethod‹RegisterIdentityParams, Identity›

Defined in src/Polymesh.ts:624

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

reserveTicker

• reserveTicker: ProcedureMethod‹ReserveTickerParams, TickerReservation›

Defined in src/Polymesh.ts:319

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

param ticker symbol to reserve

note required role:

Ticker Owner

transferPolyX

• transferPolyX: ProcedureMethod‹TransferPolyXParams, void›

Defined in src/Polymesh.ts:258

Transfer an amount of POLYX to a specified Account

param account that will receive the POLYX

param amount of POLYX to be transferred

param identifier string to help differentiate transfers

Accessors

_polkadotApi

• get _polkadotApi(): ApiPromise

Defined in src/Polymesh.ts:638

Polkadot client

Returns: ApiPromise

Methods

getAccount

▸ getAccount(): CurrentAccount

Defined in src/Polymesh.ts:432

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:433

Parameters:

▪ args: object

Returns: Account

getAccountBalance

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

Defined in src/Polymesh.ts:267

Get the free/locked POLYX balance of an Account

note can be subscribed to

Parameters:

Returns: Promise‹AccountBalance›

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

Defined in src/Polymesh.ts:268

Parameters:

Returns: Promise‹UnsubCallback›

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

Defined in src/Polymesh.ts:269

Parameters:

▪ args: object

▪ callback: SubCallback‹AccountBalance›

Returns: Promise‹UnsubCallback›

getCurrentIdentity

▸ getCurrentIdentity(): Promise‹CurrentIdentity | null›

Defined in src/Polymesh.ts:425

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:418

Create an Identity instance from a DID

Parameters:

▪ args: object

Returns: Identity

getLatestBlock

▸ getLatestBlock(): Promise‹BigNumber›

Defined in src/Polymesh.ts:629

Retrieve the number of the latest block in the chain

Returns: Promise‹BigNumber›

getNetworkProperties

▸ getNetworkProperties(): Promise‹NetworkProperties›

Defined in src/Polymesh.ts:570

Retrieve information for the current network

Returns: Promise‹NetworkProperties›

getSecurityToken

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

Defined in src/Polymesh.ts:544

Retrieve a Security Token

Parameters:

▪ args: object

Returns: Promise‹SecurityToken›

getSecurityTokens

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

Defined in src/Polymesh.ts:512

Retrieve all the Security Tokens owned by an Identity

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

Parameters:

Returns: Promise‹SecurityToken[]›

getTickerReservation

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

Defined in src/Polymesh.ts:392

Retrieve a Ticker Reservation

Parameters:

▪ args: object

Returns: Promise‹TickerReservation›

getTickerReservations

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

Defined in src/Polymesh.ts:358

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

Parameters:

Returns: Promise‹TickerReservation[]›

getTransactionFees

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

Defined in src/Polymesh.ts:460

Retrieve the protocol fees associated with running a specific transaction

Parameters:

▪ args: object

Returns: Promise‹BigNumber›

getTreasuryAccount

▸ getTreasuryAccount(): Account

Defined in src/Polymesh.ts:467

Get the treasury wallet address

Returns: Account

getTreasuryBalance

▸ getTreasuryBalance(): Promise‹BigNumber›

Defined in src/Polymesh.ts:594

Get the Treasury POLYX balance

note can be subscribed to

Returns: Promise‹BigNumber›

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

Defined in src/Polymesh.ts:595

Parameters:

Returns: Promise‹UnsubCallback›

isIdentityValid

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

Defined in src/Polymesh.ts:449

Return whether the supplied Identity/DID exists

Parameters:

▪ args: object

Returns: Promise‹boolean›

isTickerAvailable

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

Defined in src/Polymesh.ts:326

Check if a ticker hasn't been reserved

note can be subscribed to

Parameters:

▪ args: object

Returns: Promise‹boolean›

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

Defined in src/Polymesh.ts:327

Parameters:

▪ args: object

▪ callback: SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

onConnectionError

▸ onConnectionError(callback: function): function

Defined in src/Polymesh.ts:476

Handle connection errors

Parameters:

▪ callback: function

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

Parameters:

Returns: function

an unsubscribe callback

▸ (): void

onDisconnect

▸ onDisconnect(callback: function): function

Defined in src/Polymesh.ts:493

Handle disconnection

Parameters:

▪ callback: function

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

Parameters:

Returns: function

an unsubscribe callback

▸ (): void

`Static` connect

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

Defined in src/Polymesh.ts:103

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

Parameters: