Polymath
Main entry point of the Polymath SDK
Hierarchy
Polymath
Index
Properties
context
isConnected
isUnsupported
Methods
connect
getCurrentAddress
getLatestProtocolVersion
getPolyTokenAddress
getSecurityToken
getSecurityTokenReservation
getSecurityTokenReservations
getSecurityTokenSymbols
getSecurityTokens
getWallet
isSymbolAvailable
isValidErc20
reserveSecurityToken
Properties
Private
context
Private
context• context: Context = {} as Context
Defined in src/Polymath.ts:98
isConnected
• isConnected: boolean = false
Defined in src/Polymath.ts:96
isUnsupported
• isUnsupported: boolean = false
Defined in src/Polymath.ts:94
Methods
connect
▸ connect(__namedParameters
: object): Promise‹this›
Defined in src/Polymath.ts:103
Connects the client to an Ethereum node
Parameters:
▪ __namedParameters: object
Returns: Promise‹this›
getCurrentAddress
▸ getCurrentAddress(): Promise‹string›
Defined in src/Polymath.ts:451
Returns the wallet address of the current user
Returns: Promise‹string›
getLatestProtocolVersion
▸ getLatestProtocolVersion(): Promise‹string›
Defined in src/Polymath.ts:430
Get the current version of the Polymath Protocol
Returns: Promise‹string›
version string (i.e. 3.0.0)
getPolyTokenAddress
▸ getPolyTokenAddress(): Promise‹string›
Defined in src/Polymath.ts:442
Get the address of the POLY token
Returns: Promise‹string›
getSecurityToken
▸ getSecurityToken(args
: object | object | string): Promise‹SecurityToken›
Defined in src/Polymath.ts:320
Retrieve a security token by symbol, address or UUID
Parameters:
Returns: Promise‹SecurityToken›
getSecurityTokenReservation
▸ getSecurityTokenReservation(args
: object | string): Promise‹SecurityTokenReservation›
Defined in src/Polymath.ts:220
Retrieve a Security Token Reservation by symbol or UUID
Parameters:
Returns: Promise‹SecurityTokenReservation›
getSecurityTokenReservations
▸ getSecurityTokenReservations(args?
: undefined | object): Promise‹SecurityTokenReservation[]›
Defined in src/Polymath.ts:188
Retrieve all Security Token Reservations currently owned by an issuer. This includes Security Tokens that have already been launched
Parameters:
Returns: Promise‹SecurityTokenReservation[]›
getSecurityTokenSymbols
▸ getSecurityTokenSymbols(args?
: undefined | object): Promise‹string[]›
Defined in src/Polymath.ts:286
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:
Returns: Promise‹string[]›
getSecurityTokens
▸ getSecurityTokens(args?
: undefined | object): Promise‹SecurityToken[]›
Defined in src/Polymath.ts:244
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
NOTE: This method is extremely slow if the wallet in question owns more than 20 tokens. If that is your case, use getSecurityTokenSymbols
Parameters:
Returns: Promise‹SecurityToken[]›
getWallet
▸ getWallet(args
: object): Wallet
Defined in src/Polymath.ts:419
Retrieve a Wallet by address
Parameters:
▪ args: object
Returns: Wallet
isSymbolAvailable
▸ isSymbolAvailable(args
: object): Promise‹boolean›
Defined in src/Polymath.ts:394
Check if a token symbol (ticker) is available for reservation
Parameters:
▪ args: object
Returns: Promise‹boolean›
isValidErc20
▸ isValidErc20(args
: object): Promise‹void›
Defined in src/Polymath.ts:405
Check if a token follows the ERC20 standard
Parameters:
▪ args: object
Returns: Promise‹void›
reserveSecurityToken
▸ reserveSecurityToken(args
: object): Promise‹TransactionQueue‹ReserveSecurityTokenProcedureArgs, SecurityTokenReservation››
Defined in src/Polymath.ts:176
Reserve a Security Token
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹ReserveSecurityTokenProcedureArgs, SecurityTokenReservation››
Last updated