API Reference
3.0.0
beta3.0.0
3.0.0
beta3.0.0
  • Introduction
  • Globals
  • External Modules
    • Context
    • Context
    • ConstructorParams
    • Factories
    • Polymath
    • Polymath
    • AddressParams
    • Connect
    • ConnectParams
    • GetSecurityToken
    • PolymathNetworkNodeParams
    • PolymathNetworkParams
    • SymbolParams
    • PolymathBase
    • PolymathBase
    • BaseCheckpoint
    • BaseDividend
    • GetAttachedModulesOpts
    • GetAttachedModulesParams
    • GetModuleAddressesByNameOpts
    • GetModuleAddressesByNameParams
    • GetModuleFactoryAddressArgs
    • PolymathError
    • PolymathError
    • PostTransactionResolver
    • Wallet
    • Args
    • browserUtils
    • BrowserSupport
    • Ethereum
    • ExtendedWindow
    • InjectedWeb3
    • Web3VersionAPI
    • WindowWithEthereum
    • WindowWithWeb3
    • entities/Checkpoint
    • Checkpoint
    • Params
    • UniqueIdentifiers
    • entities/DividendDistribution
    • DividendDistribution
    • Params
    • UniqueIdentifiers
    • entities/Entity
    • Entity
    • entities/Erc20TokenBalance
    • Erc20TokenBalance
    • Params
    • UniqueIdentifiers
    • entities/Investment
    • Investment
    • Params
    • UniqueIdentifiers
    • entities/PolyTransaction
    • Event
    • PolyTransaction
    • entities/SecurityToken/Controller
    • Controller
    • entities/SecurityToken/Dividends
    • Dividends
    • GetDistributionParams
    • entities/SecurityToken/Documents
    • Documents
    • Document
    • entities/SecurityToken/Features
    • Features
    • Enable
    • EnableErc20DividendsOpts
    • EnablePercentageOwnershipRestrictionsOpts
    • EnableTokenholderCountRestrictionsOpts
    • FeatureStatuses
    • entities/SecurityToken/Issuance/Issuance
    • Issuance
    • entities/SecurityToken/Issuance/Offerings
    • Offerings
    • GetStoMethod
    • GetStoParams
    • LaunchTieredStoCustomCurrencyBothNoStableCoinParams
    • LaunchTieredStoCustomCurrencyBothParams
    • LaunchTieredStoCustomCurrencyEthNoStableCoinParams
    • LaunchTieredStoCustomCurrencyEthParams
    • LaunchTieredStoCustomCurrencyPolyNoStableCoinParams
    • LaunchTieredStoCustomCurrencyPolyParams
    • LaunchTieredStoMethod
    • LaunchTieredStoNoCustomCurrencyNoStableCoinParams
    • LaunchTieredStoNoCustomCurrencyParams
    • LaunchTieredStoParams
    • entities/SecurityToken/Issuance/index
    • entities/SecurityToken/Permissions
    • Permissions
    • entities/SecurityToken/SecurityToken
    • SecurityToken
    • Params
    • UniqueIdentifiers
    • entities/SecurityToken/SubModule
    • SubModule
    • entities/SecurityToken/Tokenholders
    • Tokenholders
    • GetCheckpointParams
    • entities/SecurityToken/Transfers/Restrictions/CountRestrictions
    • CountRestrictions
    • entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions
    • PercentageRestrictions
    • ModifyExemptionsMethod
    • PercentageIssuanceParams
    • PercentageWhitelistParams
    • entities/SecurityToken/Transfers/Restrictions/Restrictions
    • Restrictions
    • entities/SecurityToken/Transfers/Restrictions/index
    • entities/SecurityToken/Transfers/Transfers
    • Transfers
    • entities/SecurityToken/Transfers/index
    • entities/SecurityToken/index
    • entities/SecurityTokenReservation
    • SecurityTokenReservation
    • Params
    • UniqueIdentifiers
    • entities/SimpleSto
    • SimpleSto
    • Params
    • entities/Sto
    • Sto
    • Params
    • UniqueIdentifiers
    • entities/TaxWithholding
    • TaxWithholding
    • Params
    • UniqueIdentifiers
    • entities/TieredSto
    • TieredSto
    • Params
    • Tier
    • entities/Tokenholder
    • Tokenholder
    • Params
    • UniqueIdentifiers
    • entities/TransactionQueue
    • Events
    • TransactionQueue
    • entities/Wallet
    • Wallet
    • Params
    • UniqueIdentifiers
    • entities/factories/CheckpointFactory
    • entities/factories/DividendDistributionFactory
    • entities/factories/Erc20TokenBalanceFactory
    • Erc20TokenBalanceFactory
    • entities/factories/Factory
    • Factory
    • EntityClass
    • entities/factories/InvestmentFactory
    • InvestmentFactory
    • entities/factories/SecurityTokenFactory
    • entities/factories/SecurityTokenReservationFactory
    • entities/factories/SimpleStoFactory
    • SimpleStoFactory
    • entities/factories/TaxWithholdingFactory
    • TaxWithholdingFactory
    • entities/factories/TieredStoFactory
    • TieredStoFactory
    • entities/factories/TokenholderFactory
    • TokenholderFactory
    • entities/factories/WalletFactory
    • WalletFactory
    • entities/factories/index
    • entities/index
    • index
    • procedures/ApproveErc20
    • ApproveErc20
    • procedures/AssignSecurityTokenRole
    • AssignSecurityTokenRole
    • procedures/AssignStoRole
    • AssignStoRole
    • procedures/ControllerRedeem
    • ControllerRedeem
    • procedures/ControllerTransfer
    • ControllerTransfer
    • procedures/CreateCheckpoint
    • CreateCheckpoint
    • procedures/CreateDividendDistribution
    • CreateDividendDistribution
    • procedures/CreateSecurityToken
    • CreateSecurityToken
    • procedures/DisableController
    • DisableController
    • procedures/DisableFeature
    • DisableFeature
    • procedures/EnableCountTransferManager
    • EnableCountTransferManager
    • procedures/EnableDividendManager
    • EnableDividendManager
    • procedures/EnableGeneralPermissionManager
    • EnableGeneralPermissionManager
    • procedures/EnableGeneralTransferManager
    • EnableGeneralTransferManager
    • procedures/EnablePercentageTransferManager
    • EnablePercentageTransferManager
    • procedures/FinalizeSto
    • FinalizeSto
    • procedures/FreezeIssuance
    • FreezeIssuance
    • procedures/InvestInSimpleSto
    • InvestInSimpleSto
    • procedures/InvestInTieredSto
    • InvestInTieredSto
    • procedures/IssueTokens
    • IssueTokens
    • procedures/LaunchSimpleSto
    • LaunchSimpleSto
    • procedures/LaunchTieredSto
    • LaunchTieredSto
    • procedures/ModifyDividendsDefaultExclusionList
    • ModifyDividendsDefaultExclusionList
    • procedures/ModifyMaxHolderCount
    • ModifyMaxHolderCount
    • procedures/ModifyMaxHolderPercentage
    • ModifyMaxHolderPercentage
    • procedures/ModifyPercentageExemptions
    • ModifyPercentageExemptions
    • procedures/ModifyTieredStoData
    • ModifyTieredStoData
    • procedures/ModifyTokenholderData
    • ModifyTokenholderData
    • procedures/Procedure
    • ProcedureClass
    • procedures/PullDividendPayment
    • PullDividendPayment
    • procedures/PushDividendPayment
    • PushDividendPayment
    • procedures/ReclaimFunds
    • ReclaimFunds
    • procedures/RemoveDocument
    • RemoveDocument
    • procedures/ReserveSecurityToken
    • ReserveSecurityToken
    • procedures/RevokeKyc
    • RevokeKyc
    • procedures/SetController
    • SetController
    • procedures/SetDividendsWallet
    • SetDividendsWallet
    • procedures/SetDocument
    • SetDocument
    • procedures/SignDisableControllerAck
    • SignDisableControllerAck
    • procedures/SignFreezeIssuanceAck
    • SignFreezeIssuanceAck
    • procedures/SignTransferData
    • SignTransferData
    • procedures/ToggleAllowBeneficialInvestments
    • ToggleAllowBeneficialInvestments
    • procedures/ToggleAllowPreIssuing
    • ToggleAllowPreIssuing
    • procedures/ToggleFreezeTransfers
    • ToggleFreezeTransfers
    • procedures/TogglePauseSto
    • TogglePauseSto
    • procedures/TransferErc20
    • TransferErc20
    • procedures/TransferOwnership
    • TransferOwnership
    • procedures/TransferReservationOwnership
    • TransferReservationOwnership
    • procedures/TransferSecurityTokens
    • TransferSecurityTokens
    • procedures/UpdateDividendsTaxWithholdingList
    • UpdateDividendsTaxWithholdingList
    • procedures/WithdrawTaxes
    • WithdrawTaxes
    • procedures/index
    • types/index
    • ErrorCode
    • Feature
    • PolyTransactionTag
    • ProcedureType
    • SecurityTokenRole
    • StoRole
    • StoType
    • TransactionSpeed
    • TransactionStatus
    • TransferStatusCode
    • ApproveErc20ProcedureArgs
    • AssignSecurityTokenRoleProcedureArgs
    • AssignStoRoleProcedureArgs
    • ControllerRedeemProcedureArgs
    • ControllerTransferProcedureArgs
    • CreateCheckpointProcedureArgs
    • CreateDividendDistributionProcedureArgs
    • CreateSecurityTokenProcedureArgs
    • CustomCurrency
    • DisableControllerProcedureArgs
    • DisableFeatureProcedureArgs
    • DividendTokenholderStatus
    • EnableCountTransferManagerProcedureArgs
    • EnableDividendManagerProcedureArgs
    • EnableGeneralPermissionManagerProcedureArgs
    • EnableGeneralTransferManagerProcedureArgs
    • EnablePercentageTransferManagerProcedureArgs
    • Fees
    • FinalizeStoProcedureArgs
    • FreezeIssuanceProcedureArgs
    • FutureLowLevelMethod
    • InvestInSimpleStoProcedureArgs
    • InvestInTieredStoBaseProcedureArgs
    • InvestWithStableCoinArgs
    • IssuanceDataEntry
    • IssueTokensProcedureArgs
    • LaunchSimpleStoProcedureArgs
    • LaunchTieredStoProcedureArgs
    • ModifyDividendsDefaultExclusionListProcedureArgs
    • ModifyMaxHolderCountProcedureArgs
    • ModifyMaxHolderPercentageProcedureArgs
    • ModifyPercentageExemptionsProcedureArgs
    • ModifyTieredStoDataProcedureArgs
    • ModifyTokenholderDataProcedureArgs
    • PercentageWhitelistEntry
    • Pojo
    • PullDividendPaymentProcedureArgs
    • PushDividendPaymentProcedureArgs
    • ReclaimFundsProcedureArgs
    • RemoveDocumentProcedureArgs
    • ReserveSecurityTokenProcedureArgs
    • RevokeKycProcedureArgs
    • SetControllerProcedureArgs
    • SetDividendsWalletProcedureArgs
    • SetDocumentProcedureArgs
    • SignDisableControllerAckProcedureArgs
    • SignFreezeIssuanceAckProcedureArgs
    • SignTransferDataProcedureArgs
    • StoTier
    • TaxWithholdingEntry
    • ToggleAllowBeneficialInvestmentsProcedureArgs
    • ToggleAllowPreIssuingProcedureArgs
    • ToggleFreezeTransfersProcedureArgs
    • TogglePauseStoProcedureArgs
    • TokenholderBalance
    • TokenholderDataEntry
    • TransactionSpec
    • TransferErc20ProcedureArgs
    • TransferOwnershipProcedureArgs
    • TransferReservationOwnershipProcedureArgs
    • TransferSecurityTokensProcedureArgs
    • UpdateDividendsTaxWithholdingListProcedureArgs
    • WithdrawTaxesProcedureArgs
    • utils/constants
    • utils/index
    • FindCappedStoPauseParams
    • FindCappedStoPreMintAllowedParams
    • FindCheckpointCreatedParams
    • FindControllerTransferParams
    • FindErc20DividendClaimedParams
    • FindErc20DividendDepositedParams
    • FindErc20DividendReclaimedParams
    • FindErc20SetWalletParams
    • FindErc20SetWithholdingParams
    • FindEthDividendClaimedParams
    • FindEthDividendReclaimedParams
    • FindEthSetWalletParams
    • FindEthSetWithholdingParams
    • FindEtherDividendDepositedParams
    • FindEventParams
    • FindEvents
    • FindModifyInvestorFlagParams
    • FindModifyKycDataParams
    • FindModuleAddedParams
    • FindNewSecurityTokenParams
    • FindTickerRegisteredParams
    • FindTieredStoPauseParams
    • FindTieredStoPreMintAllowedParams
  • Classes
    • Context
    • Polymath
    • PolymathBase
    • PolymathError
    • Checkpoint
    • DividendDistribution
    • Entity
    • Erc20TokenBalance
    • Investment
    • PolyTransaction
    • Controller
    • Dividends
    • Documents
    • Features
    • Issuance
    • Offerings
    • Permissions
    • SecurityToken
    • SubModule
    • Tokenholders
    • CountRestrictions
    • PercentageRestrictions
    • Restrictions
    • Transfers
    • SecurityTokenReservation
    • SimpleSto
    • Sto
    • TaxWithholding
    • TieredSto
    • Tokenholder
    • TransactionQueue
    • Wallet
    • Erc20TokenBalanceFactory
    • Factory
    • InvestmentFactory
    • SimpleStoFactory
    • TaxWithholdingFactory
    • TieredStoFactory
    • TokenholderFactory
    • WalletFactory
    • ApproveErc20
    • AssignSecurityTokenRole
    • AssignStoRole
    • ControllerRedeem
    • ControllerTransfer
    • CreateCheckpoint
    • CreateDividendDistribution
    • CreateSecurityToken
    • DisableController
    • DisableFeature
    • EnableCountTransferManager
    • EnableDividendManager
    • EnableGeneralPermissionManager
    • EnableGeneralTransferManager
    • EnablePercentageTransferManager
    • FinalizeSto
    • FreezeIssuance
    • InvestInSimpleSto
    • InvestInTieredSto
    • IssueTokens
    • LaunchSimpleSto
    • LaunchTieredSto
    • ModifyDividendsDefaultExclusionList
    • ModifyMaxHolderCount
    • ModifyMaxHolderPercentage
    • ModifyPercentageExemptions
    • ModifyTieredStoData
    • ModifyTokenholderData
    • PullDividendPayment
    • PushDividendPayment
    • ReclaimFunds
    • RemoveDocument
    • ReserveSecurityToken
    • RevokeKyc
    • SetController
    • SetDividendsWallet
    • SetDocument
    • SignDisableControllerAck
    • SignFreezeIssuanceAck
    • SignTransferData
    • ToggleAllowBeneficialInvestments
    • ToggleAllowPreIssuing
    • ToggleFreezeTransfers
    • TogglePauseSto
    • TransferErc20
    • TransferOwnership
    • TransferReservationOwnership
    • TransferSecurityTokens
    • UpdateDividendsTaxWithholdingList
    • WithdrawTaxes
  • Enums
    • BrowserSupport
    • Event
    • Events
    • ErrorCode
    • Feature
    • PolyTransactionTag
    • ProcedureType
    • SecurityTokenRole
    • StoRole
    • StoType
    • TransactionSpeed
    • TransactionStatus
    • TransferStatusCode
  • Interfaces
    • ConstructorParams
    • Factories
    • AddressParams
    • Connect
    • ConnectParams
    • GetSecurityToken
    • PolymathNetworkNodeParams
    • PolymathNetworkParams
    • SymbolParams
    • BaseCheckpoint
    • BaseDividend
    • GetAttachedModulesOpts
    • GetAttachedModulesParams
    • GetModuleAddressesByNameOpts
    • GetModuleAddressesByNameParams
    • GetModuleFactoryAddressArgs
    • Args
    • Ethereum
    • ExtendedWindow
    • InjectedWeb3
    • Web3VersionAPI
    • WindowWithEthereum
    • WindowWithWeb3
    • Params
    • UniqueIdentifiers
    • Params
    • UniqueIdentifiers
    • Params
    • UniqueIdentifiers
    • Params
    • UniqueIdentifiers
    • GetDistributionParams
    • Document
    • Enable
    • EnableErc20DividendsOpts
    • EnablePercentageOwnershipRestrictionsOpts
    • EnableTokenholderCountRestrictionsOpts
    • FeatureStatuses
    • GetStoMethod
    • GetStoParams
    • LaunchTieredStoCustomCurrencyBothNoStableCoinParams
    • LaunchTieredStoCustomCurrencyBothParams
    • LaunchTieredStoCustomCurrencyEthNoStableCoinParams
    • LaunchTieredStoCustomCurrencyEthParams
    • LaunchTieredStoCustomCurrencyPolyNoStableCoinParams
    • LaunchTieredStoCustomCurrencyPolyParams
    • LaunchTieredStoMethod
    • LaunchTieredStoNoCustomCurrencyNoStableCoinParams
    • LaunchTieredStoNoCustomCurrencyParams
    • LaunchTieredStoParams
    • Params
    • UniqueIdentifiers
    • GetCheckpointParams
    • ModifyExemptionsMethod
    • PercentageIssuanceParams
    • PercentageWhitelistParams
    • Params
    • UniqueIdentifiers
    • Params
    • Params
    • UniqueIdentifiers
    • Params
    • UniqueIdentifiers
    • Params
    • Tier
    • Params
    • UniqueIdentifiers
    • Params
    • UniqueIdentifiers
    • EntityClass
    • ProcedureClass
    • ApproveErc20ProcedureArgs
    • AssignSecurityTokenRoleProcedureArgs
    • AssignStoRoleProcedureArgs
    • ControllerRedeemProcedureArgs
    • ControllerTransferProcedureArgs
    • CreateCheckpointProcedureArgs
    • CreateDividendDistributionProcedureArgs
    • CreateSecurityTokenProcedureArgs
    • CustomCurrency
    • DisableControllerProcedureArgs
    • DisableFeatureProcedureArgs
    • DividendTokenholderStatus
    • EnableCountTransferManagerProcedureArgs
    • EnableDividendManagerProcedureArgs
    • EnableGeneralPermissionManagerProcedureArgs
    • EnableGeneralTransferManagerProcedureArgs
    • EnablePercentageTransferManagerProcedureArgs
    • Fees
    • FinalizeStoProcedureArgs
    • FreezeIssuanceProcedureArgs
    • FutureLowLevelMethod
    • InvestInSimpleStoProcedureArgs
    • InvestInTieredStoBaseProcedureArgs
    • InvestWithStableCoinArgs
    • IssuanceDataEntry
    • IssueTokensProcedureArgs
    • LaunchSimpleStoProcedureArgs
    • LaunchTieredStoProcedureArgs
    • ModifyDividendsDefaultExclusionListProcedureArgs
    • ModifyMaxHolderCountProcedureArgs
    • ModifyMaxHolderPercentageProcedureArgs
    • ModifyPercentageExemptionsProcedureArgs
    • ModifyTieredStoDataProcedureArgs
    • ModifyTokenholderDataProcedureArgs
    • PercentageWhitelistEntry
    • Pojo
    • PullDividendPaymentProcedureArgs
    • PushDividendPaymentProcedureArgs
    • ReclaimFundsProcedureArgs
    • RemoveDocumentProcedureArgs
    • ReserveSecurityTokenProcedureArgs
    • RevokeKycProcedureArgs
    • SetControllerProcedureArgs
    • SetDividendsWalletProcedureArgs
    • SetDocumentProcedureArgs
    • SignDisableControllerAckProcedureArgs
    • SignFreezeIssuanceAckProcedureArgs
    • SignTransferDataProcedureArgs
    • StoTier
    • TaxWithholdingEntry
    • ToggleAllowBeneficialInvestmentsProcedureArgs
    • ToggleAllowPreIssuingProcedureArgs
    • ToggleFreezeTransfersProcedureArgs
    • TogglePauseStoProcedureArgs
    • TokenholderBalance
    • TokenholderDataEntry
    • TransactionSpec
    • TransferErc20ProcedureArgs
    • TransferOwnershipProcedureArgs
    • TransferReservationOwnershipProcedureArgs
    • TransferSecurityTokensProcedureArgs
    • UpdateDividendsTaxWithholdingListProcedureArgs
    • WithdrawTaxesProcedureArgs
    • FindCappedStoPauseParams
    • FindCappedStoPreMintAllowedParams
    • FindCheckpointCreatedParams
    • FindControllerTransferParams
    • FindErc20DividendClaimedParams
    • FindErc20DividendDepositedParams
    • FindErc20DividendReclaimedParams
    • FindErc20SetWalletParams
    • FindErc20SetWithholdingParams
    • FindEthDividendClaimedParams
    • FindEthDividendReclaimedParams
    • FindEthSetWalletParams
    • FindEthSetWithholdingParams
    • FindEtherDividendDepositedParams
    • FindEventParams
    • FindEvents
    • FindModifyInvestorFlagParams
    • FindModifyKycDataParams
    • FindModuleAddedParams
    • FindNewSecurityTokenParams
    • FindTickerRegisteredParams
    • FindTieredStoPauseParams
    • FindTieredStoPreMintAllowedParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Properties
  • Optional network

Was this helpful?

  1. External Modules

Web3VersionAPI

PreviousInjectedWeb3NextWindowWithEthereum

Last updated 4 years ago

Was this helpful?

Hierarchy

  • Web3VersionAPI

Index

Properties

Properties

Optional network

• network? : undefined | string

Defined in

src/browserUtils.ts:22
network