Polymath
Last updated
Was this helpful?
Last updated
Was this helpful?
Main entry point of the Polymath SDK
Polymath
Private context• isConnected: boolean = false
• isUnsupported: boolean = false
▸ connect(__namedParameters: object): Promise‹this›
Connects the client to an Ethereum node
Parameters:
â–ª __namedParameters: object
Name
Type
Default
Description
polymathRegistryAddress
undefined | string
-
address of a custom Polymath Registry contract. Defaults to the one deployed by Polymath
privateKey
undefined | string
-
private key of the wallet that will sign transactions. If using Metamask, this parameter can be ignored
providerUrl
undefined | string
-
URL of an Ethereum node. If using Metamask, this parameter can be ignored
speed
TransactionSpeed.Fast
desired transaction speed. More gas is spent if a faster speed is chosen
Returns: Promise‹this›
▸ getCurrentAddress(): Promise‹string›
Returns the wallet address of the current user
Returns: Promise‹string›
▸ getLatestProtocolVersion(): Promise‹string›
Get the current version of the Polymath Protocol
Returns: Promise‹string›
version string (i.e. 3.0.0)
▸ getPolyTokenAddress(): Promise‹string›
Get the address of the POLY token
Returns: Promise‹string›
Retrieve a security token by symbol, address or UUID
Parameters:
Name
Type
args
object | object | string
Retrieve a Security Token Reservation by symbol or UUID
Parameters:
Name
Type
args
object | string
Retrieve all Security Token Reservations currently owned by an issuer. This includes Security Tokens that have already been launched
Parameters:
Name
Type
args?
undefined | object
▸ getSecurityTokenSymbols(args?: undefined | object): Promise‹string[]›
Retrieve the symbols of all launched Security Tokens related to a wallet. This includes tokens owned by the wallet and tokens for which the wallet holds some role
Includes token symbols for tokens with version 2.0 or lower
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹string[]›
Retrieve all launched Security Tokens related to a wallet. This includes tokens owned by the wallet and tokens for which the wallet holds some role
Ignores all tokens with version 2.0 or lower
Parameters:
Name
Type
args?
undefined | object
Retrieve a Wallet by address
Parameters:
â–ª args: object
Name
Type
address
string
▸ isSymbolAvailable(args: object): Promise‹boolean›
Check if a token symbol (ticker) is available for reservation
Parameters:
â–ª args: object
Name
Type
symbol
string
Returns: Promise‹boolean›
▸ isValidErc20(args: object): Promise‹void›
Check if a token follows the ERC20 standard
Parameters:
â–ª args: object
Name
Type
address
string
Returns: Promise‹void›
Reserve a Security Token
Parameters:
â–ª args: object
Name
Type
owner?
undefined | string
symbol
string
• context: = {} as Context
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
▸ getSecurityToken(args: object | object | string): Promise‹›
Defined in
Returns: Promise‹›
▸ getSecurityTokenReservation(args: object | string): Promise‹›
Defined in
Returns: Promise‹›
▸ getSecurityTokenReservations(args?: undefined | object): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ getSecurityTokens(args?: undefined | object): Promise‹[]›
Defined in
NOTE: This method is extremely slow if the wallet in question owns more than 20 tokens. If that is your case, use
Returns: Promise‹[]›
â–¸ getWallet(args: object):
Defined in
Returns:
Defined in
Defined in
▸ reserveSecurityToken(args: object): Promise‹‹, ››
Defined in
Returns: Promise‹‹, ››