PolymathBase

Class that wraps the polymathnetwork/contract-wrappers library to add utility functions

Hierarchy

• PolymathAPI

  ↳ PolymathBase

Index

Constructors

• constructor

Properties

• contractFactory

• featureRegistry

• getAccount

• getBalance

• getERC20TokenWrapper

• getPolyTokens

• isTestnet

• moduleFactory

• moduleRegistry

• polyToken

• polyTokenFaucet

• polymathRegistry

• securityTokenRegistry

• tokenFactory

• web3Wrapper

Methods

• getAllDividends
• getAttachedModules
• getCheckpoint
• getCheckpoints
• getDividend
• getDividends
• getDividendsByCheckpoint
• getModuleAddressesByName
• getModuleFactoryAddress
• getTreasuryWallet
• roleToPermission

Constructors

constructor

+ new PolymathBase(params: ApiConstructorParams): PolymathBase

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79

Instantiates a new PolymathAPI instance.

Parameters:

Name	Type
params	ApiConstructorParams

Returns: PolymathBase

An instance of the PolymathAPI class.

Properties

contractFactory

• contractFactory: ContractFactory

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79

featureRegistry

• featureRegistry: FeatureRegistryWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:62

An instance of the FeatureRegistryWrapper class containing methods for interacting with FeatureRegistry smart contract.

getAccount

• getAccount: function

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:95

Get the account currently used by PolymathAPI

returns Address string

Type declaration:

▸ (): Promise‹string›

getBalance

• getBalance: function

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:100

Get the ETH balance

returns Balance BigNumber

Type declaration:

▸ (params: GetBalanceParams): Promise‹BigNumber›

Parameters:

Name	Type
params	GetBalanceParams

getERC20TokenWrapper

• getERC20TokenWrapper: function

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:90

Get a wrapped token from an address

returns TokenWrapper ERC20

Type declaration:

▸ (params: GetERC20WrapperParams): Promise‹ERC20›

Parameters:

Name	Type
params	GetERC20WrapperParams

getPolyTokens

• getPolyTokens: function

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:85

Type declaration:

▸ (params: GetTokensParams): Promise‹PolyResponse›

Parameters:

Name	Type
params	GetTokensParams

isTestnet

• isTestnet: function

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:104

Is it Testnet network?

Type declaration:

▸ (): Promise‹boolean›

moduleFactory

• moduleFactory: ModuleWrapperFactory

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:72

An instance of the ModuleWrapperFactory class to get different module wrapper instances to interact with SecurityToken smart contracts

moduleRegistry

• moduleRegistry: ModuleRegistryWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:57

An instance of the ModuleRegistryWrapper class containing methods for interacting with ModuleRegistry smart contract.

polyToken

• polyToken: PolyTokenWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:52

An instance of the PolyTokenWrapper class containing methods for interacting with PolyToken smart contract.

polyTokenFaucet

• polyTokenFaucet: PolyTokenFaucetWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:77

An instance of the PolyTokenFaucetWrapper class containing methods for interacting with PolyTokenFaucet smart contract.

polymathRegistry

• polymathRegistry: PolymathRegistryWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:42

An instance of the PolymathRegistryWrapper class containing methods for interacting with PolymathRegistry smart contract.

securityTokenRegistry

• securityTokenRegistry: SecurityTokenRegistryWrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:47

An instance of the SecurityTokenRegistryWrapper class containing methods for interacting with SecurityTokenRegistry smart contract.

tokenFactory

• tokenFactory: TokenWrapperFactory

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:67

An instance of the TokenWrapperFactory class to get TokenWrapper instances to interact with SecurityToken or ERC20 smart contracts

web3Wrapper

• web3Wrapper: Web3Wrapper

Inherited from void

Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:78

Methods

getAllDividends

▸ getAllDividends(__namedParameters: object): Promise‹BaseDividend[]›

Defined in src/PolymathBase.ts:888

Auxiliary function to fetch all dividend distributions

Parameters:

▪ __namedParameters: object

Name	Type	Description
checkpointId	undefined | number	checkpoint UUID
securityTokenSymbol	string	symbol of the Security Token

Returns: Promise‹BaseDividend[]›

getAttachedModules

▸ getAttachedModules(__namedParameters: object, opts?: GetAttachedModulesOpts): Promise‹any[]›

Defined in src/PolymathBase.ts:523

Fetch all Modules of a certain type attached to a Security Token

Parameters:

▪ __namedParameters: object

Name	Type	Description
moduleName	ModuleName	name of the Module
symbol	string	symbol of the Security Token

▪Optional opts: GetAttachedModulesOpts

Returns: Promise‹any[]›

getCheckpoint

▸ getCheckpoint(__namedParameters: object): Promise‹BaseCheckpoint›

Defined in src/PolymathBase.ts:697

Get data associated to a Checkpoint

Parameters:

▪ __namedParameters: object

Name	Type	Description
checkpointId	number	checkpoint UUID
securityToken	SecurityToken_3_0_0	instance of the Security Token

Returns: Promise‹BaseCheckpoint›

getCheckpoints

▸ getCheckpoints(__namedParameters: object): Promise‹BaseCheckpoint[]›

Defined in src/PolymathBase.ts:722

Get all Checkpoints of a Security Token

Parameters:

▪ __namedParameters: object

Name	Type	Description
securityToken	SecurityToken_3_0_0	instance of the Security Token

Returns: Promise‹BaseCheckpoint[]›

getDividend

▸ getDividend(__namedParameters: object): Promise‹BaseDividend›

Defined in src/PolymathBase.ts:783

Get data associated to a specific Dividend Distribution

Parameters:

▪ __namedParameters: object

Name	Type	Description
dividendIndex	number	index of the Dividend
dividendsModule	ERC20DividendCheckpoint_3_0_0	-

Returns: Promise‹BaseDividend›

getDividends

▸ getDividends(__namedParameters: object): Promise‹BaseDividend[]›

Defined in src/PolymathBase.ts:868

Parameters:

▪ __namedParameters: object

Name	Type
dividendsModule	ERC20DividendCheckpoint_3_0_0

Returns: Promise‹BaseDividend[]›

getDividendsByCheckpoint

▸ getDividendsByCheckpoint(__namedParameters: object): Promise‹BaseDividend[]›

Defined in src/PolymathBase.ts:849

Fetch list of all Dividends at a certain Checkpoint

Parameters:

▪ __namedParameters: object

Name	Type	Description
checkpointId	number	checkpoint UUID
dividendsModule	ERC20DividendCheckpoint_3_0_0	-

Returns: Promise‹BaseDividend[]›

getModuleAddressesByName

▸ getModuleAddressesByName(__namedParameters: object, opts?: GetModuleAddressesByNameOpts): Promise‹string[]›

Defined in src/PolymathBase.ts:485

Fetch addresses of all Modules of a certain type attached to a Security Token

Parameters:

▪ __namedParameters: object

Name	Type	Description
moduleName	ModuleName	name of the Module
symbol	string	symbol of the Security Token

▪Optional opts: GetModuleAddressesByNameOpts

Returns: Promise‹string[]›

getModuleFactoryAddress

▸ getModuleFactoryAddress(__namedParameters: object): Promise‹string›

Defined in src/PolymathBase.ts:362

Fetch the address of a specified Module Factory

Parameters:

▪ __namedParameters: object

Name	Type	Description
moduleName	ModuleName	name of the Module corresponding to the Module Factory
tokenAddress	string	address of the Security Token

Returns: Promise‹string›

getTreasuryWallet

▸ getTreasuryWallet(__namedParameters: object): Promise‹string›

Defined in src/PolymathBase.ts:425

Fetch a Module's Treasury Wallet

Parameters:

▪ __namedParameters: object

Name

Type

module

GeneralPermissionManager_3_0_0 | GeneralPermissionManager_3_1_0 | CountTransferManager_3_0_0 | GeneralTransferManager_3_0_0 | GeneralTransferManager_3_1_0 | ManualApprovalTransferManager_3_0_0 | PercentageTransferManager_3_0_0 | VolumeRestrictionTransferManager_3_0_0 | BlacklistTransferManager_3_0_0 | LockUpTransferManager_3_0_0 | RestrictedPartialSaleTransferManager_3_1_0 | CappedSTO_3_0_0 | CappedSTO_3_1_0 | USDTieredSTO_3_0_0 | USDTieredSTO_3_1_0 | ERC20DividendCheckpoint_3_0_0 | VestingEscrowWallet_3_0_0 | VestingEscrowWallet_3_1_0 | EtherDividendCheckpoint_3_0_0

Returns: Promise‹string›

roleToPermission

▸ roleToPermission(__namedParameters: object): Promise‹object›

Defined in src/PolymathBase.ts:923

Parameters:

▪ __namedParameters: object

Name	Type
role	SecurityTokenRole

Returns: Promise‹object›