From 24f67a07d36b3a80949487ade576dd742b21a3a2 Mon Sep 17 00:00:00 2001 From: Jeremias Diaz Date: Thu, 18 Jun 2020 03:16:46 +0000 Subject: [PATCH] GitBook: [master] 745 pages and one asset modified --- docs/api/.gitbook/assets/Polymath.png | Bin 0 -> 52424 bytes docs/api/README.md | 29 +- docs/api/SUMMARY.md | 752 ++--- docs/api/classes/README.md | 2 + docs/api/classes/_context_.context.md | 43 +- .../_entities_checkpoint_.checkpoint.md | 168 +- ...idenddistribution_.dividenddistribution.md | 305 +- docs/api/classes/_entities_entity_.entity.md | 31 +- ...es_erc20tokenbalance_.erc20tokenbalance.md | 135 +- ...alancefactory_.erc20tokenbalancefactory.md | 123 +- .../_entities_factories_factory_.factory.md | 119 +- ...es_investmentfactory_.investmentfactory.md | 123 +- ...ries_simplestofactory_.simplestofactory.md | 139 +- ...thholdingfactory_.taxwithholdingfactory.md | 123 +- ...ries_tieredstofactory_.tieredstofactory.md | 139 +- ..._tokenholderfactory_.tokenholderfactory.md | 123 +- ..._factories_walletfactory_.walletfactory.md | 139 +- .../_entities_investment_.investment.md | 170 +- ...tities_polytransaction_.polytransaction.md | 180 +- ...es_securitytoken_controller_.controller.md | 134 +- ...ties_securitytoken_dividends_.dividends.md | 203 +- ...ties_securitytoken_documents_.documents.md | 101 +- ...tities_securitytoken_features_.features.md | 129 +- ...curitytoken_issuance_issuance_.issuance.md | 102 +- ...ritytoken_issuance_offerings_.offerings.md | 117 +- ..._securitytoken_permissions_.permissions.md | 204 +- ...uritytoken_securitytoken_.securitytoken.md | 283 +- ...ties_securitytoken_submodule_.submodule.md | 29 +- ...ecuritytoken_tokenholders_.tokenholders.md | 138 +- ...ns_countrestrictions_.countrestrictions.md | 64 +- ...agerestrictions_.percentagerestrictions.md | 102 +- ...restrictions_restrictions_.restrictions.md | 51 +- ...itytoken_transfers_transfers_.transfers.md | 167 +- ...enreservation_.securitytokenreservation.md | 202 +- .../classes/_entities_simplesto_.simplesto.md | 469 ++- docs/api/classes/_entities_sto_.sto.md | 384 +-- ...entities_taxwithholding_.taxwithholding.md | 137 +- .../classes/_entities_tieredsto_.tieredsto.md | 547 ++-- .../_entities_tokenholder_.tokenholder.md | 200 +- ...ties_transactionqueue_.transactionqueue.md | 194 +- docs/api/classes/_entities_wallet_.wallet.md | 146 +- docs/api/classes/_polymath_.polymath.md | 245 +- .../classes/_polymathbase_.polymathbase.md | 433 ++- .../classes/_polymatherror_.polymatherror.md | 63 +- .../_procedures_approveerc20_.approveerc20.md | 155 +- ...uritytokenrole_.assignsecuritytokenrole.md | 163 +- ...procedures_assignstorole_.assignstorole.md | 158 +- ...ures_controllerredeem_.controllerredeem.md | 161 +- ..._controllertransfer_.controllertransfer.md | 161 +- ...ures_createcheckpoint_.createcheckpoint.md | 151 +- ...istribution_.createdividenddistribution.md | 162 +- ...reatesecuritytoken_.createsecuritytoken.md | 160 +- ...es_disablecontroller_.disablecontroller.md | 158 +- ...ocedures_disablefeature_.disablefeature.md | 151 +- ...sfermanager_.enablecounttransfermanager.md | 151 +- ...edividendmanager_.enabledividendmanager.md | 151 +- ...manager_.enablegeneralpermissionmanager.md | 151 +- ...ermanager_.enablegeneraltransfermanager.md | 153 +- ...anager_.enablepercentagetransfermanager.md | 151 +- .../_procedures_finalizesto_.finalizesto.md | 166 +- ...ocedures_freezeissuance_.freezeissuance.md | 158 +- ...es_investinsimplesto_.investinsimplesto.md | 170 +- ...es_investintieredsto_.investintieredsto.md | 170 +- .../_procedures_issuetokens_.issuetokens.md | 160 +- ...edures_launchsimplesto_.launchsimplesto.md | 162 +- ...edures_launchtieredsto_.launchtieredsto.md | 164 +- ...st_.modifydividendsdefaultexclusionlist.md | 151 +- ...ifymaxholdercount_.modifymaxholdercount.md | 154 +- ...erpercentage_.modifymaxholderpercentage.md | 156 +- ...eexemptions_.modifypercentageexemptions.md | 160 +- ...odifytieredstodata_.modifytieredstodata.md | 172 +- ...ytokenholderdata_.modifytokenholderdata.md | 168 +- ...ulldividendpayment_.pulldividendpayment.md | 160 +- ...ushdividendpayment_.pushdividendpayment.md | 156 +- .../_procedures_reclaimfunds_.reclaimfunds.md | 156 +- ...ocedures_removedocument_.removedocument.md | 158 +- ...ervesecuritytoken_.reservesecuritytoken.md | 155 +- .../_procedures_revokekyc_.revokekyc.md | 162 +- ...procedures_setcontroller_.setcontroller.md | 159 +- ..._setdividendswallet_.setdividendswallet.md | 156 +- .../_procedures_setdocument_.setdocument.md | 158 +- ...controllerack_.signdisablecontrollerack.md | 151 +- ...reezeissuanceack_.signfreezeissuanceack.md | 151 +- ...ures_signtransferdata_.signtransferdata.md | 160 +- ...ments_.toggleallowbeneficialinvestments.md | 162 +- ...eallowpreissuing_.toggleallowpreissuing.md | 166 +- ...efreezetransfers_.togglefreezetransfers.md | 156 +- ...ocedures_togglepausesto_.togglepausesto.md | 158 +- ...procedures_transfererc20_.transfererc20.md | 160 +- ...es_transferownership_.transferownership.md | 156 +- ...ownership_.transferreservationownership.md | 158 +- ...rsecuritytokens_.transfersecuritytokens.md | 154 +- ...list_.updatedividendstaxwithholdinglist.md | 156 +- ...procedures_withdrawtaxes_.withdrawtaxes.md | 156 +- docs/api/enums/README.md | 2 + .../enums/_browserutils_.browsersupport.md | 25 +- .../enums/_entities_polytransaction_.event.md | 7 +- .../_entities_transactionqueue_.events.md | 13 +- docs/api/enums/_types_index_.errorcode.md | 109 +- docs/api/enums/_types_index_.feature.md | 31 +- .../enums/_types_index_.polytransactiontag.md | 379 +-- docs/api/enums/_types_index_.proceduretype.md | 307 +- .../enums/_types_index_.securitytokenrole.md | 37 +- docs/api/enums/_types_index_.storole.md | 13 +- docs/api/enums/_types_index_.stotype.md | 13 +- .../enums/_types_index_.transactionspeed.md | 25 +- .../enums/_types_index_.transactionstatus.md | 37 +- .../enums/_types_index_.transferstatuscode.md | 55 +- docs/api/external-modules/README.md | 2 + .../_browserutils_.browsersupport.md | 37 + .../_browserutils_.ethereum.md | 61 + .../_browserutils_.extendedwindow.md | 2819 ++++++++++++++++ .../_browserutils_.injectedweb3.md | 27 + docs/api/external-modules/_browserutils_.md | 89 + .../_browserutils_.web3versionapi.md | 20 + .../_browserutils_.windowwithethereum.md | 2807 ++++++++++++++++ .../_browserutils_.windowwithweb3.md | 2807 ++++++++++++++++ .../_context_.constructorparams.md | 20 + .../api/external-modules/_context_.context.md | 60 + .../external-modules/_context_.factories.md | 83 + .../_context_.md | 3 +- .../_entities_checkpoint_.checkpoint.md | 186 ++ .../_entities_checkpoint_.md | 17 +- .../_entities_checkpoint_.params.md | 56 + ..._entities_checkpoint_.uniqueidentifiers.md | 33 + ...idenddistribution_.dividenddistribution.md | 293 ++ .../_entities_dividenddistribution_.md | 17 +- .../_entities_dividenddistribution_.params.md | 129 + ...dividenddistribution_.uniqueidentifiers.md | 33 + .../_entities_entity_.entity.md | 79 + .../_entities_entity_.md | 3 +- ...es_erc20tokenbalance_.erc20tokenbalance.md | 164 + .../_entities_erc20tokenbalance_.md | 17 +- .../_entities_erc20tokenbalance_.params.md | 29 + ...es_erc20tokenbalance_.uniqueidentifiers.md | 29 + .../_entities_factories_checkpointfactory_.md | 2 + ..._factories_dividenddistributionfactory_.md | 2 + ...alancefactory_.erc20tokenbalancefactory.md | 157 + ...ies_factories_erc20tokenbalancefactory_.md | 3 +- ...entities_factories_factory_.entityclass.md | 76 + .../_entities_factories_factory_.factory.md | 162 + .../_entities_factories_factory_.md | 3 +- .../_entities_factories_index_.md | 2 + ...es_investmentfactory_.investmentfactory.md | 157 + .../_entities_factories_investmentfactory_.md | 20 + ...ntities_factories_securitytokenfactory_.md | 2 + ...tories_securitytokenreservationfactory_.md | 2 + .../_entities_factories_simplestofactory_.md | 3 +- ...ries_simplestofactory_.simplestofactory.md | 174 + ...tities_factories_taxwithholdingfactory_.md | 3 +- ...thholdingfactory_.taxwithholdingfactory.md | 157 + .../_entities_factories_tieredstofactory_.md | 3 +- ...ries_tieredstofactory_.tieredstofactory.md | 174 + ..._entities_factories_tokenholderfactory_.md | 3 +- ..._tokenholderfactory_.tokenholderfactory.md | 157 + .../_entities_factories_walletfactory_.md | 3 +- ..._factories_walletfactory_.walletfactory.md | 174 + docs/api/external-modules/_entities_index_.md | 2 + .../_entities_investment_.investment.md | 193 ++ .../_entities_investment_.md | 3 +- .../_entities_investment_.params.md | 43 + ..._entities_investment_.uniqueidentifiers.md | 36 + .../_entities_polytransaction_.event.md | 16 + .../_entities_polytransaction_.md | 3 +- ...tities_polytransaction_.polytransaction.md | 218 ++ ...es_securitytoken_controller_.controller.md | 159 + .../_entities_securitytoken_controller_.md | 3 +- ...ties_securitytoken_dividends_.dividends.md | 231 ++ ...ytoken_dividends_.getdistributionparams.md | 24 + .../_entities_securitytoken_dividends_.md | 3 +- ...ities_securitytoken_documents_.document.md | 49 + ...ties_securitytoken_documents_.documents.md | 135 + .../_entities_securitytoken_documents_.md | 3 +- ...entities_securitytoken_features_.enable.md | 84 + ...oken_features_.enableerc20dividendsopts.md | 20 + ...ablepercentageownershiprestrictionsopts.md | 27 + ....enabletokenholdercountrestrictionsopts.md | 20 + ...tities_securitytoken_features_.features.md | 159 + ...securitytoken_features_.featurestatuses.md | 50 + .../_entities_securitytoken_features_.md | 9 +- .../_entities_securitytoken_index_.md | 2 + ..._entities_securitytoken_issuance_index_.md | 2 + ...curitytoken_issuance_issuance_.issuance.md | 132 + ...tities_securitytoken_issuance_issuance_.md | 3 +- ...ytoken_issuance_offerings_.getstomethod.md | 50 + ...ytoken_issuance_offerings_.getstoparams.md | 29 + ...stocustomcurrencybothnostablecoinparams.md | 35 + ...launchtieredstocustomcurrencybothparams.md | 120 + ...dstocustomcurrencyethnostablecoinparams.md | 34 + ....launchtieredstocustomcurrencyethparams.md | 119 + ...stocustomcurrencypolynostablecoinparams.md | 34 + ...launchtieredstocustomcurrencypolyparams.md | 119 + ...suance_offerings_.launchtieredstomethod.md | 104 + ...edstonocustomcurrencynostablecoinparams.md | 22 + ..._.launchtieredstonocustomcurrencyparams.md | 29 + ...suance_offerings_.launchtieredstoparams.md | 96 + ...ities_securitytoken_issuance_offerings_.md | 47 +- ...ritytoken_issuance_offerings_.offerings.md | 144 + .../_entities_securitytoken_permissions_.md | 3 +- ..._securitytoken_permissions_.permissions.md | 238 ++ .../_entities_securitytoken_securitytoken_.md | 52 + ...ies_securitytoken_securitytoken_.params.md | 88 + ...uritytoken_securitytoken_.securitytoken.md | 286 ++ ...ytoken_securitytoken_.uniqueidentifiers.md | 24 + .../_entities_securitytoken_submodule_.md | 3 +- ...ties_securitytoken_submodule_.submodule.md | 76 + ...token_tokenholders_.getcheckpointparams.md | 22 + .../_entities_securitytoken_tokenholders_.md | 3 +- ...ecuritytoken_tokenholders_.tokenholders.md | 175 + ...entities_securitytoken_transfers_index_.md | 2 + ...ns_countrestrictions_.countrestrictions.md | 95 + ...ansfers_restrictions_countrestrictions_.md | 3 +- ...ritytoken_transfers_restrictions_index_.md | 2 + ...rs_restrictions_percentagerestrictions_.md | 3 +- ...agerestrictions_.modifyexemptionsmethod.md | 32 + ...erestrictions_.percentageissuanceparams.md | 20 + ...agerestrictions_.percentagerestrictions.md | 131 + ...restrictions_.percentagewhitelistparams.md | 20 + ...en_transfers_restrictions_restrictions_.md | 3 +- ...restrictions_restrictions_.restrictions.md | 74 + ...ties_securitytoken_transfers_transfers_.md | 3 +- ...itytoken_transfers_transfers_.transfers.md | 192 ++ .../_entities_securitytokenreservation_.md | 17 +- ...tities_securitytokenreservation_.params.md | 45 + ...enreservation_.securitytokenreservation.md | 231 ++ ...ritytokenreservation_.uniqueidentifiers.md | 22 + .../_entities_simplesto_.md | 9 +- .../_entities_simplesto_.params.md | 189 ++ .../_entities_simplesto_.simplesto.md | 506 +++ .../_entities_sto_.md | 17 +- .../external-modules/_entities_sto_.params.md | 145 + .../external-modules/_entities_sto_.sto.md | 401 +++ .../_entities_sto_.uniqueidentifiers.md | 36 + .../_entities_taxwithholding_.md | 3 +- .../_entities_taxwithholding_.params.md | 29 + ...entities_taxwithholding_.taxwithholding.md | 160 + ...ities_taxwithholding_.uniqueidentifiers.md | 29 + .../_entities_tieredsto_.md | 9 +- .../_entities_tieredsto_.params.md | 210 ++ .../_entities_tieredsto_.tier.md | 67 + .../_entities_tieredsto_.tieredsto.md | 581 ++++ .../_entities_tokenholder_.md | 3 +- .../_entities_tokenholder_.params.md | 64 + .../_entities_tokenholder_.tokenholder.md | 223 ++ ...entities_tokenholder_.uniqueidentifiers.md | 29 + .../_entities_transactionqueue_.events.md | 23 + .../_entities_transactionqueue_.md | 3 +- ...ties_transactionqueue_.transactionqueue.md | 238 ++ .../_entities_wallet_.md | 3 +- .../_entities_wallet_.params.md | 26 + .../_entities_wallet_.uniqueidentifiers.md | 24 + .../_entities_wallet_.wallet.md | 184 ++ docs/api/external-modules/_index_.md | 23 + .../_polymath_.addressparams.md | 20 + .../external-modules/_polymath_.connect.md | 32 + .../_polymath_.connectparams.md | 47 + .../_polymath_.getsecuritytoken.md | 44 + .../_polymath_.md | 3 +- .../external-modules/_polymath_.polymath.md | 266 ++ .../_polymath_.polymathnetworknodeparams.md | 47 + .../_polymath_.polymathnetworkparams.md | 31 + .../_polymath_.symbolparams.md | 20 + .../_polymathbase_.basecheckpoint.md | 51 + .../_polymathbase_.basedividend.md | 141 + .../_polymathbase_.getattachedmodulesopts.md | 24 + ..._polymathbase_.getattachedmodulesparams.md | 33 + ...ymathbase_.getmoduleaddressesbynameopts.md | 24 + ...athbase_.getmoduleaddressesbynameparams.md | 33 + ...lymathbase_.getmodulefactoryaddressargs.md | 33 + .../_polymathbase_.md | 3 +- .../_polymathbase_.polymathbase.md | 467 +++ docs/api/external-modules/_polymatherror_.md | 40 + .../_polymatherror_.polymatherror.md | 83 + .../_posttransactionresolver_.md | 2 + .../_procedures_approveerc20_.approveerc20.md | 195 ++ .../_procedures_approveerc20_.md | 3 +- ...uritytokenrole_.assignsecuritytokenrole.md | 198 ++ .../_procedures_assignsecuritytokenrole_.md | 3 +- ...procedures_assignstorole_.assignstorole.md | 197 ++ .../_procedures_assignstorole_.md | 3 +- ...ures_controllerredeem_.controllerredeem.md | 197 ++ .../_procedures_controllerredeem_.md | 3 +- ..._controllertransfer_.controllertransfer.md | 197 ++ .../_procedures_controllertransfer_.md | 3 +- ...ures_createcheckpoint_.createcheckpoint.md | 187 ++ .../_procedures_createcheckpoint_.md | 3 +- ...istribution_.createdividenddistribution.md | 192 ++ ..._procedures_createdividenddistribution_.md | 3 +- ...reatesecuritytoken_.createsecuritytoken.md | 194 ++ .../_procedures_createsecuritytoken_.md | 3 +- ...es_disablecontroller_.disablecontroller.md | 197 ++ .../_procedures_disablecontroller_.md | 3 +- ...ocedures_disablefeature_.disablefeature.md | 191 ++ .../_procedures_disablefeature_.md | 3 +- ...sfermanager_.enablecounttransfermanager.md | 191 ++ ..._procedures_enablecounttransfermanager_.md | 3 +- ...edividendmanager_.enabledividendmanager.md | 191 ++ .../_procedures_enabledividendmanager_.md | 3 +- ...manager_.enablegeneralpermissionmanager.md | 191 ++ ...cedures_enablegeneralpermissionmanager_.md | 3 +- ...ermanager_.enablegeneraltransfermanager.md | 191 ++ ...rocedures_enablegeneraltransfermanager_.md | 3 +- ...anager_.enablepercentagetransfermanager.md | 193 ++ ...edures_enablepercentagetransfermanager_.md | 3 +- .../_procedures_finalizesto_.finalizesto.md | 200 ++ .../_procedures_finalizesto_.md | 3 +- ...ocedures_freezeissuance_.freezeissuance.md | 197 ++ .../_procedures_freezeissuance_.md | 3 +- .../external-modules/_procedures_index_.md | 2 + ...es_investinsimplesto_.investinsimplesto.md | 202 ++ .../_procedures_investinsimplesto_.md | 3 +- ...es_investintieredsto_.investintieredsto.md | 201 ++ .../_procedures_investintieredsto_.md | 3 +- .../_procedures_issuetokens_.issuetokens.md | 192 ++ .../_procedures_issuetokens_.md | 3 +- ...edures_launchsimplesto_.launchsimplesto.md | 195 ++ .../_procedures_launchsimplesto_.md | 3 +- ...edures_launchtieredsto_.launchtieredsto.md | 196 ++ .../_procedures_launchtieredsto_.md | 3 +- ...es_modifydividendsdefaultexclusionlist_.md | 20 + ...st_.modifydividendsdefaultexclusionlist.md | 193 ++ .../_procedures_modifymaxholdercount_.md | 3 +- ...ifymaxholdercount_.modifymaxholdercount.md | 193 ++ .../_procedures_modifymaxholderpercentage_.md | 3 +- ...erpercentage_.modifymaxholderpercentage.md | 196 ++ ..._procedures_modifypercentageexemptions_.md | 3 +- ...eexemptions_.modifypercentageexemptions.md | 198 ++ .../_procedures_modifytieredstodata_.md | 3 +- ...odifytieredstodata_.modifytieredstodata.md | 205 ++ .../_procedures_modifytokenholderdata_.md | 20 + ...ytokenholderdata_.modifytokenholderdata.md | 197 ++ .../_procedures_procedure_.md | 3 +- .../_procedures_procedure_.procedureclass.md | 35 + .../_procedures_pulldividendpayment_.md | 3 +- ...ulldividendpayment_.pulldividendpayment.md | 198 ++ .../_procedures_pushdividendpayment_.md | 20 + ...ushdividendpayment_.pushdividendpayment.md | 196 ++ .../_procedures_reclaimfunds_.md | 3 +- .../_procedures_reclaimfunds_.reclaimfunds.md | 196 ++ .../_procedures_removedocument_.md | 3 +- ...ocedures_removedocument_.removedocument.md | 197 ++ .../_procedures_reservesecuritytoken_.md | 20 + ...ervesecuritytoken_.reservesecuritytoken.md | 191 ++ .../_procedures_revokekyc_.md | 3 +- .../_procedures_revokekyc_.revokekyc.md | 194 ++ .../_procedures_setcontroller_.md | 3 +- ...procedures_setcontroller_.setcontroller.md | 196 ++ .../_procedures_setdividendswallet_.md | 3 +- ..._setdividendswallet_.setdividendswallet.md | 196 ++ .../_procedures_setdocument_.md | 3 +- .../_procedures_setdocument_.setdocument.md | 197 ++ .../_procedures_signdisablecontrollerack_.md | 3 +- ...controllerack_.signdisablecontrollerack.md | 191 ++ .../_procedures_signfreezeissuanceack_.md | 3 +- ...reezeissuanceack_.signfreezeissuanceack.md | 191 ++ .../_procedures_signtransferdata_.md | 3 +- ...ures_signtransferdata_.signtransferdata.md | 196 ++ ...dures_toggleallowbeneficialinvestments_.md | 3 +- ...ments_.toggleallowbeneficialinvestments.md | 199 ++ .../_procedures_toggleallowpreissuing_.md | 3 +- ...eallowpreissuing_.toggleallowpreissuing.md | 200 ++ .../_procedures_togglefreezetransfers_.md | 3 +- ...efreezetransfers_.togglefreezetransfers.md | 196 ++ .../_procedures_togglepausesto_.md | 3 +- ...ocedures_togglepausesto_.togglepausesto.md | 197 ++ .../_procedures_transfererc20_.md | 3 +- ...procedures_transfererc20_.transfererc20.md | 199 ++ .../_procedures_transferownership_.md | 3 +- ...es_transferownership_.transferownership.md | 196 ++ ...rocedures_transferreservationownership_.md | 3 +- ...ownership_.transferreservationownership.md | 197 ++ .../_procedures_transfersecuritytokens_.md | 3 +- ...rsecuritytokens_.transfersecuritytokens.md | 193 ++ ...ures_updatedividendstaxwithholdinglist_.md | 20 + ...list_.updatedividendstaxwithholdinglist.md | 196 ++ .../_procedures_withdrawtaxes_.md | 3 +- ...procedures_withdrawtaxes_.withdrawtaxes.md | 196 ++ ..._types_index_.approveerc20procedureargs.md | 42 + ...x_.assignsecuritytokenroleprocedureargs.md | 60 + ...types_index_.assignstoroleprocedureargs.md | 67 + ...es_index_.controllerredeemprocedureargs.md | 60 + ..._index_.controllertransferprocedureargs.md | 69 + ...es_index_.createcheckpointprocedureargs.md | 24 + ...createdividenddistributionprocedureargs.md | 96 + ...index_.createsecuritytokenprocedureargs.md | 60 + .../_types_index_.customcurrency.md | 42 + ...s_index_.disablecontrollerprocedureargs.md | 33 + ...ypes_index_.disablefeatureprocedureargs.md | 33 + ..._types_index_.dividendtokenholderstatus.md | 69 + ...enablecounttransfermanagerprocedureargs.md | 33 + ...dex_.enabledividendmanagerprocedureargs.md | 33 + ...legeneralpermissionmanagerprocedureargs.md | 24 + ...ablegeneraltransfermanagerprocedureargs.md | 24 + ...epercentagetransfermanagerprocedureargs.md | 42 + .../_types_index_.errorcode.md | 137 + .../external-modules/_types_index_.feature.md | 44 + .../external-modules/_types_index_.fees.md | 33 + .../_types_index_.finalizestoprocedureargs.md | 40 + ...ypes_index_.freezeissuanceprocedureargs.md | 33 + .../_types_index_.futurelowlevelmethod.md | 53 + ...s_index_.investinsimplestoprocedureargs.md | 51 + ...dex_.investintieredstobaseprocedureargs.md | 69 + .../_types_index_.investwithstablecoinargs.md | 86 + .../_types_index_.issuancedataentry.md | 42 + .../_types_index_.issuetokensprocedureargs.md | 33 + ...pes_index_.launchsimplestoprocedureargs.md | 96 + ...pes_index_.launchtieredstoprocedureargs.md | 123 + .../_types_index_.md | 131 +- ...idendsdefaultexclusionlistprocedureargs.md | 33 + ...ndex_.modifymaxholdercountprocedureargs.md | 33 + ....modifymaxholderpercentageprocedureargs.md | 33 + ...modifypercentageexemptionsprocedureargs.md | 42 + ...index_.modifytieredstodataprocedureargs.md | 35 + ...dex_.modifytokenholderdataprocedureargs.md | 33 + .../_types_index_.percentagewhitelistentry.md | 33 + .../external-modules/_types_index_.pojo.md | 10 + .../_types_index_.polytransactiontag.md | 452 +++ .../_types_index_.proceduretype.md | 368 +++ ...index_.pulldividendpaymentprocedureargs.md | 31 + ...index_.pushdividendpaymentprocedureargs.md | 40 + ..._types_index_.reclaimfundsprocedureargs.md | 31 + ...ypes_index_.removedocumentprocedureargs.md | 33 + ...ndex_.reservesecuritytokenprocedureargs.md | 33 + .../_types_index_.revokekycprocedureargs.md | 33 + .../_types_index_.securitytokenrole.md | 51 + ...types_index_.setcontrollerprocedureargs.md | 33 + ..._index_.setdividendswalletprocedureargs.md | 33 + .../_types_index_.setdocumentprocedureargs.md | 49 + ..._.signdisablecontrollerackprocedureargs.md | 24 + ...dex_.signfreezeissuanceackprocedureargs.md | 24 + ...es_index_.signtransferdataprocedureargs.md | 51 + .../external-modules/_types_index_.storole.md | 23 + .../external-modules/_types_index_.stotier.md | 51 + .../external-modules/_types_index_.stotype.md | 23 + .../_types_index_.taxwithholdingentry.md | 33 + ...allowbeneficialinvestmentsprocedureargs.md | 51 + ...dex_.toggleallowpreissuingprocedureargs.md | 51 + ...dex_.togglefreezetransfersprocedureargs.md | 33 + ...ypes_index_.togglepausestoprocedureargs.md | 49 + .../_types_index_.tokenholderbalance.md | 33 + .../_types_index_.tokenholderdataentry.md | 69 + .../_types_index_.transactionspec.md | 53 + .../_types_index_.transactionspeed.md | 37 + .../_types_index_.transactionstatus.md | 51 + ...types_index_.transfererc20procedureargs.md | 42 + ...s_index_.transferownershipprocedureargs.md | 33 + ...ansferreservationownershipprocedureargs.md | 33 + ...ex_.transfersecuritytokensprocedureargs.md | 60 + .../_types_index_.transferstatuscode.md | 72 + ...ividendstaxwithholdinglistprocedureargs.md | 42 + ...types_index_.withdrawtaxesprocedureargs.md | 31 + .../api/external-modules/_utils_constants_.md | 23 + .../_utils_index_.findcappedstopauseparams.md | 33 + ...ndex_.findcappedstopremintallowedparams.md | 33 + ...tils_index_.findcheckpointcreatedparams.md | 33 + ...ils_index_.findcontrollertransferparams.md | 33 + ...s_index_.finderc20dividendclaimedparams.md | 33 + ...index_.finderc20dividenddepositedparams.md | 33 + ...index_.finderc20dividendreclaimedparams.md | 33 + .../_utils_index_.finderc20setwalletparams.md | 33 + ...ls_index_.finderc20setwithholdingparams.md | 33 + ...ils_index_.findethdividendclaimedparams.md | 33 + ...s_index_.findethdividendreclaimedparams.md | 33 + ...index_.findetherdividenddepositedparams.md | 33 + .../_utils_index_.findethsetwalletparams.md | 33 + ...tils_index_.findethsetwithholdingparams.md | 33 + .../_utils_index_.findeventparams.md | 69 + .../_utils_index_.findevents.md | 260 ++ ...ils_index_.findmodifyinvestorflagparams.md | 33 + .../_utils_index_.findmodifykycdataparams.md | 33 + .../_utils_index_.findmoduleaddedparams.md | 33 + ...utils_index_.findnewsecuritytokenparams.md | 33 + ...utils_index_.findtickerregisteredparams.md | 33 + .../_utils_index_.findtieredstopauseparams.md | 33 + ...ndex_.findtieredstopremintallowedparams.md | 33 + .../_utils_index_.md | 77 +- docs/api/external-modules/_wallet_.args.md | 24 + .../{modules => external-modules}/_wallet_.md | 3 +- docs/api/globals.md | 221 +- docs/api/interfaces/README.md | 2 + .../api/interfaces/_browserutils_.ethereum.md | 47 +- .../_browserutils_.extendedwindow.md | 2876 +++++++---------- .../interfaces/_browserutils_.injectedweb3.md | 15 +- .../_browserutils_.web3versionapi.md | 7 +- .../_browserutils_.windowwithethereum.md | 2873 +++++++--------- .../_browserutils_.windowwithweb3.md | 2873 +++++++--------- .../interfaces/_context_.constructorparams.md | 9 +- docs/api/interfaces/_context_.factories.md | 79 +- .../_entities_checkpoint_.params.md | 39 +- ..._entities_checkpoint_.uniqueidentifiers.md | 17 +- .../_entities_dividenddistribution_.params.md | 111 +- ...dividenddistribution_.uniqueidentifiers.md | 17 +- .../_entities_erc20tokenbalance_.params.md | 15 +- ...es_erc20tokenbalance_.uniqueidentifiers.md | 15 +- ...entities_factories_factory_.entityclass.md | 49 +- .../_entities_investment_.params.md | 31 +- ..._entities_investment_.uniqueidentifiers.md | 23 +- ...ytoken_dividends_.getdistributionparams.md | 9 +- ...ities_securitytoken_documents_.document.md | 31 +- ...entities_securitytoken_features_.enable.md | 79 +- ...oken_features_.enableerc20dividendsopts.md | 9 +- ...ablepercentageownershiprestrictionsopts.md | 13 +- ....enabletokenholdercountrestrictionsopts.md | 9 +- ...securitytoken_features_.featurestatuses.md | 51 +- ...ytoken_issuance_offerings_.getstomethod.md | 47 +- ...ytoken_issuance_offerings_.getstoparams.md | 15 +- ...stocustomcurrencybothnostablecoinparams.md | 23 +- ...launchtieredstocustomcurrencybothparams.md | 115 +- ...dstocustomcurrencyethnostablecoinparams.md | 20 +- ....launchtieredstocustomcurrencyethparams.md | 112 +- ...stocustomcurrencypolynostablecoinparams.md | 20 +- ...launchtieredstocustomcurrencypolyparams.md | 112 +- ...suance_offerings_.launchtieredstomethod.md | 99 +- ...edstonocustomcurrencynostablecoinparams.md | 9 +- ..._.launchtieredstonocustomcurrencyparams.md | 15 +- ...suance_offerings_.launchtieredstoparams.md | 81 +- ...ies_securitytoken_securitytoken_.params.md | 74 +- ...ytoken_securitytoken_.uniqueidentifiers.md | 9 +- ...token_tokenholders_.getcheckpointparams.md | 9 +- ...agerestrictions_.modifyexemptionsmethod.md | 27 +- ...erestrictions_.percentageissuanceparams.md | 9 +- ...restrictions_.percentagewhitelistparams.md | 9 +- ...tities_securitytokenreservation_.params.md | 31 +- ...ritytokenreservation_.uniqueidentifiers.md | 9 +- .../interfaces/_entities_simplesto_.params.md | 157 +- docs/api/interfaces/_entities_sto_.params.md | 113 +- .../_entities_sto_.uniqueidentifiers.md | 23 +- .../_entities_taxwithholding_.params.md | 15 +- ...ities_taxwithholding_.uniqueidentifiers.md | 15 +- .../interfaces/_entities_tieredsto_.params.md | 181 +- .../interfaces/_entities_tieredsto_.tier.md | 49 +- .../_entities_tokenholder_.params.md | 55 +- ...entities_tokenholder_.uniqueidentifiers.md | 15 +- .../interfaces/_entities_wallet_.params.md | 11 +- .../_entities_wallet_.uniqueidentifiers.md | 9 +- .../interfaces/_polymath_.addressparams.md | 9 +- docs/api/interfaces/_polymath_.connect.md | 27 +- .../interfaces/_polymath_.connectparams.md | 29 +- .../interfaces/_polymath_.getsecuritytoken.md | 39 +- .../_polymath_.polymathnetworknodeparams.md | 33 +- .../_polymath_.polymathnetworkparams.md | 13 +- .../api/interfaces/_polymath_.symbolparams.md | 9 +- .../_polymathbase_.basecheckpoint.md | 33 +- .../interfaces/_polymathbase_.basedividend.md | 113 +- .../_polymathbase_.getattachedmodulesopts.md | 9 +- ..._polymathbase_.getattachedmodulesparams.md | 17 +- ...ymathbase_.getmoduleaddressesbynameopts.md | 9 +- ...athbase_.getmoduleaddressesbynameparams.md | 17 +- ...lymathbase_.getmodulefactoryaddressargs.md | 17 +- .../_procedures_procedure_.procedureclass.md | 21 +- ..._types_index_.approveerc20procedureargs.md | 25 +- ...x_.assignsecuritytokenroleprocedureargs.md | 43 +- ...types_index_.assignstoroleprocedureargs.md | 49 +- ...es_index_.controllerredeemprocedureargs.md | 41 +- ..._index_.controllertransferprocedureargs.md | 45 +- ...es_index_.createcheckpointprocedureargs.md | 9 +- ...createdividenddistributionprocedureargs.md | 69 +- ...index_.createsecuritytokenprocedureargs.md | 37 +- .../_types_index_.customcurrency.md | 27 +- ...s_index_.disablecontrollerprocedureargs.md | 15 +- ...ypes_index_.disablefeatureprocedureargs.md | 17 +- ..._types_index_.dividendtokenholderstatus.md | 49 +- ...enablecounttransfermanagerprocedureargs.md | 17 +- ...dex_.enabledividendmanagerprocedureargs.md | 17 +- ...legeneralpermissionmanagerprocedureargs.md | 9 +- ...ablegeneraltransfermanagerprocedureargs.md | 9 +- ...epercentagetransfermanagerprocedureargs.md | 26 +- docs/api/interfaces/_types_index_.fees.md | 17 +- .../_types_index_.finalizestoprocedureargs.md | 27 +- ...ypes_index_.freezeissuanceprocedureargs.md | 15 +- .../_types_index_.futurelowlevelmethod.md | 28 +- ...s_index_.investinsimplestoprocedureargs.md | 31 +- ...dex_.investintieredstobaseprocedureargs.md | 48 +- .../_types_index_.investwithstablecoinargs.md | 68 +- .../_types_index_.issuancedataentry.md | 23 +- .../_types_index_.issuetokensprocedureargs.md | 17 +- ...pes_index_.launchsimplestoprocedureargs.md | 74 +- ...pes_index_.launchtieredstoprocedureargs.md | 97 +- ...idendsdefaultexclusionlistprocedureargs.md | 18 +- ...ndex_.modifymaxholdercountprocedureargs.md | 17 +- ....modifymaxholderpercentageprocedureargs.md | 17 +- ...modifypercentageexemptionsprocedureargs.md | 24 +- ...index_.modifytieredstodataprocedureargs.md | 17 +- ...dex_.modifytokenholderdataprocedureargs.md | 17 +- .../_types_index_.percentagewhitelistentry.md | 17 +- docs/api/interfaces/_types_index_.pojo.md | 5 +- ...index_.pulldividendpaymentprocedureargs.md | 17 +- ...index_.pushdividendpaymentprocedureargs.md | 23 +- ..._types_index_.reclaimfundsprocedureargs.md | 17 +- ...ypes_index_.removedocumentprocedureargs.md | 17 +- ...ndex_.reservesecuritytokenprocedureargs.md | 15 +- .../_types_index_.revokekycprocedureargs.md | 17 +- ...types_index_.setcontrollerprocedureargs.md | 17 +- ..._index_.setdividendswalletprocedureargs.md | 17 +- .../_types_index_.setdocumentprocedureargs.md | 31 +- ..._.signdisablecontrollerackprocedureargs.md | 9 +- ...dex_.signfreezeissuanceackprocedureargs.md | 9 +- ...es_index_.signtransferdataprocedureargs.md | 33 +- docs/api/interfaces/_types_index_.stotier.md | 35 +- .../_types_index_.taxwithholdingentry.md | 17 +- ...allowbeneficialinvestmentsprocedureargs.md | 35 +- ...dex_.toggleallowpreissuingprocedureargs.md | 38 +- ...dex_.togglefreezetransfersprocedureargs.md | 17 +- ...ypes_index_.togglepausestoprocedureargs.md | 35 +- .../_types_index_.tokenholderbalance.md | 17 +- .../_types_index_.tokenholderdataentry.md | 49 +- .../_types_index_.transactionspec.md | 35 +- ...types_index_.transfererc20procedureargs.md | 25 +- ...s_index_.transferownershipprocedureargs.md | 17 +- ...ansferreservationownershipprocedureargs.md | 17 +- ...ex_.transfersecuritytokensprocedureargs.md | 39 +- ...ividendstaxwithholdinglistprocedureargs.md | 25 +- ...types_index_.withdrawtaxesprocedureargs.md | 17 +- .../_utils_index_.findcappedstopauseparams.md | 19 +- ...ndex_.findcappedstopremintallowedparams.md | 19 +- ...tils_index_.findcheckpointcreatedparams.md | 19 +- ...ils_index_.findcontrollertransferparams.md | 19 +- ...s_index_.finderc20dividendclaimedparams.md | 19 +- ...index_.finderc20dividenddepositedparams.md | 19 +- ...index_.finderc20dividendreclaimedparams.md | 19 +- .../_utils_index_.finderc20setwalletparams.md | 19 +- ...ls_index_.finderc20setwithholdingparams.md | 19 +- ...ils_index_.findethdividendclaimedparams.md | 19 +- ...s_index_.findethdividendreclaimedparams.md | 19 +- ...index_.findetherdividenddepositedparams.md | 19 +- .../_utils_index_.findethsetwalletparams.md | 19 +- ...tils_index_.findethsetwithholdingparams.md | 19 +- .../_utils_index_.findeventparams.md | 15 +- .../interfaces/_utils_index_.findevents.md | 255 +- ...ils_index_.findmodifyinvestorflagparams.md | 19 +- .../_utils_index_.findmodifykycdataparams.md | 19 +- .../_utils_index_.findmoduleaddedparams.md | 19 +- ...utils_index_.findnewsecuritytokenparams.md | 19 +- ...utils_index_.findtickerregisteredparams.md | 19 +- .../_utils_index_.findtieredstopauseparams.md | 19 +- ...ndex_.findtieredstopremintallowedparams.md | 19 +- docs/api/interfaces/_wallet_.args.md | 11 +- docs/api/modules/_browserutils_.md | 92 - .../_entities_factories_checkpointfactory_.md | 3 - ..._factories_dividenddistributionfactory_.md | 3 - .../api/modules/_entities_factories_index_.md | 3 - .../_entities_factories_investmentfactory_.md | 19 - ...ntities_factories_securitytokenfactory_.md | 3 - ...tories_securitytokenreservationfactory_.md | 3 - docs/api/modules/_entities_index_.md | 3 - .../modules/_entities_securitytoken_index_.md | 3 - ..._entities_securitytoken_issuance_index_.md | 3 - .../_entities_securitytoken_securitytoken_.md | 53 - ...entities_securitytoken_transfers_index_.md | 3 - ...ritytoken_transfers_restrictions_index_.md | 3 - docs/api/modules/_index_.md | 24 - docs/api/modules/_polymatherror_.md | 39 - docs/api/modules/_posttransactionresolver_.md | 3 - docs/api/modules/_procedures_index_.md | 3 - ...es_modifydividendsdefaultexclusionlist_.md | 19 - .../_procedures_modifytokenholderdata_.md | 19 - .../_procedures_pushdividendpayment_.md | 19 - .../_procedures_reservesecuritytoken_.md | 19 - ...ures_updatedividendstaxwithholdinglist_.md | 19 - docs/api/modules/_utils_constants_.md | 24 - 660 files changed, 48860 insertions(+), 17880 deletions(-) create mode 100644 docs/api/.gitbook/assets/Polymath.png create mode 100644 docs/api/classes/README.md create mode 100644 docs/api/enums/README.md create mode 100644 docs/api/external-modules/README.md create mode 100644 docs/api/external-modules/_browserutils_.browsersupport.md create mode 100644 docs/api/external-modules/_browserutils_.ethereum.md create mode 100644 docs/api/external-modules/_browserutils_.extendedwindow.md create mode 100644 docs/api/external-modules/_browserutils_.injectedweb3.md create mode 100644 docs/api/external-modules/_browserutils_.md create mode 100644 docs/api/external-modules/_browserutils_.web3versionapi.md create mode 100644 docs/api/external-modules/_browserutils_.windowwithethereum.md create mode 100644 docs/api/external-modules/_browserutils_.windowwithweb3.md create mode 100644 docs/api/external-modules/_context_.constructorparams.md create mode 100644 docs/api/external-modules/_context_.context.md create mode 100644 docs/api/external-modules/_context_.factories.md rename docs/api/{modules => external-modules}/_context_.md (87%) create mode 100644 docs/api/external-modules/_entities_checkpoint_.checkpoint.md rename docs/api/{modules => external-modules}/_entities_checkpoint_.md (55%) create mode 100644 docs/api/external-modules/_entities_checkpoint_.params.md create mode 100644 docs/api/external-modules/_entities_checkpoint_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_dividenddistribution_.dividenddistribution.md rename docs/api/{modules => external-modules}/_entities_dividenddistribution_.md (56%) create mode 100644 docs/api/external-modules/_entities_dividenddistribution_.params.md create mode 100644 docs/api/external-modules/_entities_dividenddistribution_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_entity_.entity.md rename docs/api/{modules => external-modules}/_entities_entity_.md (66%) create mode 100644 docs/api/external-modules/_entities_erc20tokenbalance_.erc20tokenbalance.md rename docs/api/{modules => external-modules}/_entities_erc20tokenbalance_.md (55%) create mode 100644 docs/api/external-modules/_entities_erc20tokenbalance_.params.md create mode 100644 docs/api/external-modules/_entities_erc20tokenbalance_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_factories_checkpointfactory_.md create mode 100644 docs/api/external-modules/_entities_factories_dividenddistributionfactory_.md create mode 100644 docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md rename docs/api/{modules => external-modules}/_entities_factories_erc20tokenbalancefactory_.md (68%) create mode 100644 docs/api/external-modules/_entities_factories_factory_.entityclass.md create mode 100644 docs/api/external-modules/_entities_factories_factory_.factory.md rename docs/api/{modules => external-modules}/_entities_factories_factory_.md (78%) create mode 100644 docs/api/external-modules/_entities_factories_index_.md create mode 100644 docs/api/external-modules/_entities_factories_investmentfactory_.investmentfactory.md create mode 100644 docs/api/external-modules/_entities_factories_investmentfactory_.md create mode 100644 docs/api/external-modules/_entities_factories_securitytokenfactory_.md create mode 100644 docs/api/external-modules/_entities_factories_securitytokenreservationfactory_.md rename docs/api/{modules => external-modules}/_entities_factories_simplestofactory_.md (66%) create mode 100644 docs/api/external-modules/_entities_factories_simplestofactory_.simplestofactory.md rename docs/api/{modules => external-modules}/_entities_factories_taxwithholdingfactory_.md (67%) create mode 100644 docs/api/external-modules/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md rename docs/api/{modules => external-modules}/_entities_factories_tieredstofactory_.md (66%) create mode 100644 docs/api/external-modules/_entities_factories_tieredstofactory_.tieredstofactory.md rename docs/api/{modules => external-modules}/_entities_factories_tokenholderfactory_.md (67%) create mode 100644 docs/api/external-modules/_entities_factories_tokenholderfactory_.tokenholderfactory.md rename docs/api/{modules => external-modules}/_entities_factories_walletfactory_.md (66%) create mode 100644 docs/api/external-modules/_entities_factories_walletfactory_.walletfactory.md create mode 100644 docs/api/external-modules/_entities_index_.md create mode 100644 docs/api/external-modules/_entities_investment_.investment.md rename docs/api/{modules => external-modules}/_entities_investment_.md (85%) create mode 100644 docs/api/external-modules/_entities_investment_.params.md create mode 100644 docs/api/external-modules/_entities_investment_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_polytransaction_.event.md rename docs/api/{modules => external-modules}/_entities_polytransaction_.md (79%) create mode 100644 docs/api/external-modules/_entities_polytransaction_.polytransaction.md create mode 100644 docs/api/external-modules/_entities_securitytoken_controller_.controller.md rename docs/api/{modules => external-modules}/_entities_securitytoken_controller_.md (64%) create mode 100644 docs/api/external-modules/_entities_securitytoken_dividends_.dividends.md create mode 100644 docs/api/external-modules/_entities_securitytoken_dividends_.getdistributionparams.md rename docs/api/{modules => external-modules}/_entities_securitytoken_dividends_.md (80%) create mode 100644 docs/api/external-modules/_entities_securitytoken_documents_.document.md create mode 100644 docs/api/external-modules/_entities_securitytoken_documents_.documents.md rename docs/api/{modules => external-modules}/_entities_securitytoken_documents_.md (77%) create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.enable.md create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.enableerc20dividendsopts.md create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.features.md create mode 100644 docs/api/external-modules/_entities_securitytoken_features_.featurestatuses.md rename docs/api/{modules => external-modules}/_entities_securitytoken_features_.md (54%) create mode 100644 docs/api/external-modules/_entities_securitytoken_index_.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_index_.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_issuance_.issuance.md rename docs/api/{modules => external-modules}/_entities_securitytoken_issuance_issuance_.md (62%) create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstomethod.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstoparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md rename docs/api/{modules => external-modules}/_entities_securitytoken_issuance_offerings_.md (54%) create mode 100644 docs/api/external-modules/_entities_securitytoken_issuance_offerings_.offerings.md rename docs/api/{modules => external-modules}/_entities_securitytoken_permissions_.md (65%) create mode 100644 docs/api/external-modules/_entities_securitytoken_permissions_.permissions.md create mode 100644 docs/api/external-modules/_entities_securitytoken_securitytoken_.md create mode 100644 docs/api/external-modules/_entities_securitytoken_securitytoken_.params.md create mode 100644 docs/api/external-modules/_entities_securitytoken_securitytoken_.securitytoken.md create mode 100644 docs/api/external-modules/_entities_securitytoken_securitytoken_.uniqueidentifiers.md rename docs/api/{modules => external-modules}/_entities_securitytoken_submodule_.md (64%) create mode 100644 docs/api/external-modules/_entities_securitytoken_submodule_.submodule.md create mode 100644 docs/api/external-modules/_entities_securitytoken_tokenholders_.getcheckpointparams.md rename docs/api/{modules => external-modules}/_entities_securitytoken_tokenholders_.md (79%) create mode 100644 docs/api/external-modules/_entities_securitytoken_tokenholders_.tokenholders.md create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_index_.md create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md rename docs/api/{modules => external-modules}/_entities_securitytoken_transfers_restrictions_countrestrictions_.md (63%) create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_index_.md rename docs/api/{modules => external-modules}/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md (87%) create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md rename docs/api/{modules => external-modules}/_entities_securitytoken_transfers_restrictions_restrictions_.md (61%) create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md rename docs/api/{modules => external-modules}/_entities_securitytoken_transfers_transfers_.md (62%) create mode 100644 docs/api/external-modules/_entities_securitytoken_transfers_transfers_.transfers.md rename docs/api/{modules => external-modules}/_entities_securitytokenreservation_.md (57%) create mode 100644 docs/api/external-modules/_entities_securitytokenreservation_.params.md create mode 100644 docs/api/external-modules/_entities_securitytokenreservation_.securitytokenreservation.md create mode 100644 docs/api/external-modules/_entities_securitytokenreservation_.uniqueidentifiers.md rename docs/api/{modules => external-modules}/_entities_simplesto_.md (51%) create mode 100644 docs/api/external-modules/_entities_simplesto_.params.md create mode 100644 docs/api/external-modules/_entities_simplesto_.simplesto.md rename docs/api/{modules => external-modules}/_entities_sto_.md (53%) create mode 100644 docs/api/external-modules/_entities_sto_.params.md create mode 100644 docs/api/external-modules/_entities_sto_.sto.md create mode 100644 docs/api/external-modules/_entities_sto_.uniqueidentifiers.md rename docs/api/{modules => external-modules}/_entities_taxwithholding_.md (85%) create mode 100644 docs/api/external-modules/_entities_taxwithholding_.params.md create mode 100644 docs/api/external-modules/_entities_taxwithholding_.taxwithholding.md create mode 100644 docs/api/external-modules/_entities_taxwithholding_.uniqueidentifiers.md rename docs/api/{modules => external-modules}/_entities_tieredsto_.md (56%) create mode 100644 docs/api/external-modules/_entities_tieredsto_.params.md create mode 100644 docs/api/external-modules/_entities_tieredsto_.tier.md create mode 100644 docs/api/external-modules/_entities_tieredsto_.tieredsto.md rename docs/api/{modules => external-modules}/_entities_tokenholder_.md (85%) create mode 100644 docs/api/external-modules/_entities_tokenholder_.params.md create mode 100644 docs/api/external-modules/_entities_tokenholder_.tokenholder.md create mode 100644 docs/api/external-modules/_entities_tokenholder_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_transactionqueue_.events.md rename docs/api/{modules => external-modules}/_entities_transactionqueue_.md (79%) create mode 100644 docs/api/external-modules/_entities_transactionqueue_.transactionqueue.md rename docs/api/{modules => external-modules}/_entities_wallet_.md (85%) create mode 100644 docs/api/external-modules/_entities_wallet_.params.md create mode 100644 docs/api/external-modules/_entities_wallet_.uniqueidentifiers.md create mode 100644 docs/api/external-modules/_entities_wallet_.wallet.md create mode 100644 docs/api/external-modules/_index_.md create mode 100644 docs/api/external-modules/_polymath_.addressparams.md create mode 100644 docs/api/external-modules/_polymath_.connect.md create mode 100644 docs/api/external-modules/_polymath_.connectparams.md create mode 100644 docs/api/external-modules/_polymath_.getsecuritytoken.md rename docs/api/{modules => external-modules}/_polymath_.md (94%) create mode 100644 docs/api/external-modules/_polymath_.polymath.md create mode 100644 docs/api/external-modules/_polymath_.polymathnetworknodeparams.md create mode 100644 docs/api/external-modules/_polymath_.polymathnetworkparams.md create mode 100644 docs/api/external-modules/_polymath_.symbolparams.md create mode 100644 docs/api/external-modules/_polymathbase_.basecheckpoint.md create mode 100644 docs/api/external-modules/_polymathbase_.basedividend.md create mode 100644 docs/api/external-modules/_polymathbase_.getattachedmodulesopts.md create mode 100644 docs/api/external-modules/_polymathbase_.getattachedmodulesparams.md create mode 100644 docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameopts.md create mode 100644 docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameparams.md create mode 100644 docs/api/external-modules/_polymathbase_.getmodulefactoryaddressargs.md rename docs/api/{modules => external-modules}/_polymathbase_.md (95%) create mode 100644 docs/api/external-modules/_polymathbase_.polymathbase.md create mode 100644 docs/api/external-modules/_polymatherror_.md create mode 100644 docs/api/external-modules/_polymatherror_.polymatherror.md create mode 100644 docs/api/external-modules/_posttransactionresolver_.md create mode 100644 docs/api/external-modules/_procedures_approveerc20_.approveerc20.md rename docs/api/{modules => external-modules}/_procedures_approveerc20_.md (67%) create mode 100644 docs/api/external-modules/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md rename docs/api/{modules => external-modules}/_procedures_assignsecuritytokenrole_.md (69%) create mode 100644 docs/api/external-modules/_procedures_assignstorole_.assignstorole.md rename docs/api/{modules => external-modules}/_procedures_assignstorole_.md (68%) create mode 100644 docs/api/external-modules/_procedures_controllerredeem_.controllerredeem.md rename docs/api/{modules => external-modules}/_procedures_controllerredeem_.md (68%) create mode 100644 docs/api/external-modules/_procedures_controllertransfer_.controllertransfer.md rename docs/api/{modules => external-modules}/_procedures_controllertransfer_.md (68%) create mode 100644 docs/api/external-modules/_procedures_createcheckpoint_.createcheckpoint.md rename docs/api/{modules => external-modules}/_procedures_createcheckpoint_.md (68%) create mode 100644 docs/api/external-modules/_procedures_createdividenddistribution_.createdividenddistribution.md rename docs/api/{modules => external-modules}/_procedures_createdividenddistribution_.md (69%) create mode 100644 docs/api/external-modules/_procedures_createsecuritytoken_.createsecuritytoken.md rename docs/api/{modules => external-modules}/_procedures_createsecuritytoken_.md (69%) create mode 100644 docs/api/external-modules/_procedures_disablecontroller_.disablecontroller.md rename docs/api/{modules => external-modules}/_procedures_disablecontroller_.md (68%) create mode 100644 docs/api/external-modules/_procedures_disablefeature_.disablefeature.md rename docs/api/{modules => external-modules}/_procedures_disablefeature_.md (68%) create mode 100644 docs/api/external-modules/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md rename docs/api/{modules => external-modules}/_procedures_enablecounttransfermanager_.md (69%) create mode 100644 docs/api/external-modules/_procedures_enabledividendmanager_.enabledividendmanager.md rename docs/api/{modules => external-modules}/_procedures_enabledividendmanager_.md (69%) create mode 100644 docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md rename docs/api/{modules => external-modules}/_procedures_enablegeneralpermissionmanager_.md (70%) create mode 100644 docs/api/external-modules/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md rename docs/api/{modules => external-modules}/_procedures_enablegeneraltransfermanager_.md (70%) create mode 100644 docs/api/external-modules/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md rename docs/api/{modules => external-modules}/_procedures_enablepercentagetransfermanager_.md (70%) create mode 100644 docs/api/external-modules/_procedures_finalizesto_.finalizesto.md rename docs/api/{modules => external-modules}/_procedures_finalizesto_.md (67%) create mode 100644 docs/api/external-modules/_procedures_freezeissuance_.freezeissuance.md rename docs/api/{modules => external-modules}/_procedures_freezeissuance_.md (68%) create mode 100644 docs/api/external-modules/_procedures_index_.md create mode 100644 docs/api/external-modules/_procedures_investinsimplesto_.investinsimplesto.md rename docs/api/{modules => external-modules}/_procedures_investinsimplesto_.md (68%) create mode 100644 docs/api/external-modules/_procedures_investintieredsto_.investintieredsto.md rename docs/api/{modules => external-modules}/_procedures_investintieredsto_.md (68%) create mode 100644 docs/api/external-modules/_procedures_issuetokens_.issuetokens.md rename docs/api/{modules => external-modules}/_procedures_issuetokens_.md (67%) create mode 100644 docs/api/external-modules/_procedures_launchsimplesto_.launchsimplesto.md rename docs/api/{modules => external-modules}/_procedures_launchsimplesto_.md (68%) create mode 100644 docs/api/external-modules/_procedures_launchtieredsto_.launchtieredsto.md rename docs/api/{modules => external-modules}/_procedures_launchtieredsto_.md (68%) create mode 100644 docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.md create mode 100644 docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md rename docs/api/{modules => external-modules}/_procedures_modifymaxholdercount_.md (69%) create mode 100644 docs/api/external-modules/_procedures_modifymaxholdercount_.modifymaxholdercount.md rename docs/api/{modules => external-modules}/_procedures_modifymaxholderpercentage_.md (69%) create mode 100644 docs/api/external-modules/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md rename docs/api/{modules => external-modules}/_procedures_modifypercentageexemptions_.md (69%) create mode 100644 docs/api/external-modules/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md rename docs/api/{modules => external-modules}/_procedures_modifytieredstodata_.md (69%) create mode 100644 docs/api/external-modules/_procedures_modifytieredstodata_.modifytieredstodata.md create mode 100644 docs/api/external-modules/_procedures_modifytokenholderdata_.md create mode 100644 docs/api/external-modules/_procedures_modifytokenholderdata_.modifytokenholderdata.md rename docs/api/{modules => external-modules}/_procedures_procedure_.md (70%) create mode 100644 docs/api/external-modules/_procedures_procedure_.procedureclass.md rename docs/api/{modules => external-modules}/_procedures_pulldividendpayment_.md (69%) create mode 100644 docs/api/external-modules/_procedures_pulldividendpayment_.pulldividendpayment.md create mode 100644 docs/api/external-modules/_procedures_pushdividendpayment_.md create mode 100644 docs/api/external-modules/_procedures_pushdividendpayment_.pushdividendpayment.md rename docs/api/{modules => external-modules}/_procedures_reclaimfunds_.md (67%) create mode 100644 docs/api/external-modules/_procedures_reclaimfunds_.reclaimfunds.md rename docs/api/{modules => external-modules}/_procedures_removedocument_.md (68%) create mode 100644 docs/api/external-modules/_procedures_removedocument_.removedocument.md create mode 100644 docs/api/external-modules/_procedures_reservesecuritytoken_.md create mode 100644 docs/api/external-modules/_procedures_reservesecuritytoken_.reservesecuritytoken.md rename docs/api/{modules => external-modules}/_procedures_revokekyc_.md (67%) create mode 100644 docs/api/external-modules/_procedures_revokekyc_.revokekyc.md rename docs/api/{modules => external-modules}/_procedures_setcontroller_.md (68%) create mode 100644 docs/api/external-modules/_procedures_setcontroller_.setcontroller.md rename docs/api/{modules => external-modules}/_procedures_setdividendswallet_.md (68%) create mode 100644 docs/api/external-modules/_procedures_setdividendswallet_.setdividendswallet.md rename docs/api/{modules => external-modules}/_procedures_setdocument_.md (67%) create mode 100644 docs/api/external-modules/_procedures_setdocument_.setdocument.md rename docs/api/{modules => external-modules}/_procedures_signdisablecontrollerack_.md (69%) create mode 100644 docs/api/external-modules/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md rename docs/api/{modules => external-modules}/_procedures_signfreezeissuanceack_.md (69%) create mode 100644 docs/api/external-modules/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md rename docs/api/{modules => external-modules}/_procedures_signtransferdata_.md (68%) create mode 100644 docs/api/external-modules/_procedures_signtransferdata_.signtransferdata.md rename docs/api/{modules => external-modules}/_procedures_toggleallowbeneficialinvestments_.md (70%) create mode 100644 docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md rename docs/api/{modules => external-modules}/_procedures_toggleallowpreissuing_.md (69%) create mode 100644 docs/api/external-modules/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md rename docs/api/{modules => external-modules}/_procedures_togglefreezetransfers_.md (69%) create mode 100644 docs/api/external-modules/_procedures_togglefreezetransfers_.togglefreezetransfers.md rename docs/api/{modules => external-modules}/_procedures_togglepausesto_.md (68%) create mode 100644 docs/api/external-modules/_procedures_togglepausesto_.togglepausesto.md rename docs/api/{modules => external-modules}/_procedures_transfererc20_.md (68%) create mode 100644 docs/api/external-modules/_procedures_transfererc20_.transfererc20.md rename docs/api/{modules => external-modules}/_procedures_transferownership_.md (68%) create mode 100644 docs/api/external-modules/_procedures_transferownership_.transferownership.md rename docs/api/{modules => external-modules}/_procedures_transferreservationownership_.md (70%) create mode 100644 docs/api/external-modules/_procedures_transferreservationownership_.transferreservationownership.md rename docs/api/{modules => external-modules}/_procedures_transfersecuritytokens_.md (69%) create mode 100644 docs/api/external-modules/_procedures_transfersecuritytokens_.transfersecuritytokens.md create mode 100644 docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.md create mode 100644 docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md rename docs/api/{modules => external-modules}/_procedures_withdrawtaxes_.md (68%) create mode 100644 docs/api/external-modules/_procedures_withdrawtaxes_.withdrawtaxes.md create mode 100644 docs/api/external-modules/_types_index_.approveerc20procedureargs.md create mode 100644 docs/api/external-modules/_types_index_.assignsecuritytokenroleprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.assignstoroleprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.controllerredeemprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.controllertransferprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.createcheckpointprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.createdividenddistributionprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.createsecuritytokenprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.customcurrency.md create mode 100644 docs/api/external-modules/_types_index_.disablecontrollerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.disablefeatureprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.dividendtokenholderstatus.md create mode 100644 docs/api/external-modules/_types_index_.enablecounttransfermanagerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.enabledividendmanagerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.enablegeneralpermissionmanagerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.enablegeneraltransfermanagerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.enablepercentagetransfermanagerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.errorcode.md create mode 100644 docs/api/external-modules/_types_index_.feature.md create mode 100644 docs/api/external-modules/_types_index_.fees.md create mode 100644 docs/api/external-modules/_types_index_.finalizestoprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.freezeissuanceprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.futurelowlevelmethod.md create mode 100644 docs/api/external-modules/_types_index_.investinsimplestoprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.investintieredstobaseprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.investwithstablecoinargs.md create mode 100644 docs/api/external-modules/_types_index_.issuancedataentry.md create mode 100644 docs/api/external-modules/_types_index_.issuetokensprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.launchsimplestoprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.launchtieredstoprocedureargs.md rename docs/api/{modules => external-modules}/_types_index_.md (74%) create mode 100644 docs/api/external-modules/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.modifymaxholdercountprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.modifymaxholderpercentageprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.modifypercentageexemptionsprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.modifytieredstodataprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.modifytokenholderdataprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.percentagewhitelistentry.md create mode 100644 docs/api/external-modules/_types_index_.pojo.md create mode 100644 docs/api/external-modules/_types_index_.polytransactiontag.md create mode 100644 docs/api/external-modules/_types_index_.proceduretype.md create mode 100644 docs/api/external-modules/_types_index_.pulldividendpaymentprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.pushdividendpaymentprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.reclaimfundsprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.removedocumentprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.reservesecuritytokenprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.revokekycprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.securitytokenrole.md create mode 100644 docs/api/external-modules/_types_index_.setcontrollerprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.setdividendswalletprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.setdocumentprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.signdisablecontrollerackprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.signfreezeissuanceackprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.signtransferdataprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.storole.md create mode 100644 docs/api/external-modules/_types_index_.stotier.md create mode 100644 docs/api/external-modules/_types_index_.stotype.md create mode 100644 docs/api/external-modules/_types_index_.taxwithholdingentry.md create mode 100644 docs/api/external-modules/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.toggleallowpreissuingprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.togglefreezetransfersprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.togglepausestoprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.tokenholderbalance.md create mode 100644 docs/api/external-modules/_types_index_.tokenholderdataentry.md create mode 100644 docs/api/external-modules/_types_index_.transactionspec.md create mode 100644 docs/api/external-modules/_types_index_.transactionspeed.md create mode 100644 docs/api/external-modules/_types_index_.transactionstatus.md create mode 100644 docs/api/external-modules/_types_index_.transfererc20procedureargs.md create mode 100644 docs/api/external-modules/_types_index_.transferownershipprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.transferreservationownershipprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.transfersecuritytokensprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.transferstatuscode.md create mode 100644 docs/api/external-modules/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md create mode 100644 docs/api/external-modules/_types_index_.withdrawtaxesprocedureargs.md create mode 100644 docs/api/external-modules/_utils_constants_.md create mode 100644 docs/api/external-modules/_utils_index_.findcappedstopauseparams.md create mode 100644 docs/api/external-modules/_utils_index_.findcappedstopremintallowedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findcheckpointcreatedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findcontrollertransferparams.md create mode 100644 docs/api/external-modules/_utils_index_.finderc20dividendclaimedparams.md create mode 100644 docs/api/external-modules/_utils_index_.finderc20dividenddepositedparams.md create mode 100644 docs/api/external-modules/_utils_index_.finderc20dividendreclaimedparams.md create mode 100644 docs/api/external-modules/_utils_index_.finderc20setwalletparams.md create mode 100644 docs/api/external-modules/_utils_index_.finderc20setwithholdingparams.md create mode 100644 docs/api/external-modules/_utils_index_.findethdividendclaimedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findethdividendreclaimedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findetherdividenddepositedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findethsetwalletparams.md create mode 100644 docs/api/external-modules/_utils_index_.findethsetwithholdingparams.md create mode 100644 docs/api/external-modules/_utils_index_.findeventparams.md create mode 100644 docs/api/external-modules/_utils_index_.findevents.md create mode 100644 docs/api/external-modules/_utils_index_.findmodifyinvestorflagparams.md create mode 100644 docs/api/external-modules/_utils_index_.findmodifykycdataparams.md create mode 100644 docs/api/external-modules/_utils_index_.findmoduleaddedparams.md create mode 100644 docs/api/external-modules/_utils_index_.findnewsecuritytokenparams.md create mode 100644 docs/api/external-modules/_utils_index_.findtickerregisteredparams.md create mode 100644 docs/api/external-modules/_utils_index_.findtieredstopauseparams.md create mode 100644 docs/api/external-modules/_utils_index_.findtieredstopremintallowedparams.md rename docs/api/{modules => external-modules}/_utils_index_.md (64%) create mode 100644 docs/api/external-modules/_wallet_.args.md rename docs/api/{modules => external-modules}/_wallet_.md (70%) create mode 100644 docs/api/interfaces/README.md delete mode 100644 docs/api/modules/_browserutils_.md delete mode 100644 docs/api/modules/_entities_factories_checkpointfactory_.md delete mode 100644 docs/api/modules/_entities_factories_dividenddistributionfactory_.md delete mode 100644 docs/api/modules/_entities_factories_index_.md delete mode 100644 docs/api/modules/_entities_factories_investmentfactory_.md delete mode 100644 docs/api/modules/_entities_factories_securitytokenfactory_.md delete mode 100644 docs/api/modules/_entities_factories_securitytokenreservationfactory_.md delete mode 100644 docs/api/modules/_entities_index_.md delete mode 100644 docs/api/modules/_entities_securitytoken_index_.md delete mode 100644 docs/api/modules/_entities_securitytoken_issuance_index_.md delete mode 100644 docs/api/modules/_entities_securitytoken_securitytoken_.md delete mode 100644 docs/api/modules/_entities_securitytoken_transfers_index_.md delete mode 100644 docs/api/modules/_entities_securitytoken_transfers_restrictions_index_.md delete mode 100644 docs/api/modules/_index_.md delete mode 100644 docs/api/modules/_polymatherror_.md delete mode 100644 docs/api/modules/_posttransactionresolver_.md delete mode 100644 docs/api/modules/_procedures_index_.md delete mode 100644 docs/api/modules/_procedures_modifydividendsdefaultexclusionlist_.md delete mode 100644 docs/api/modules/_procedures_modifytokenholderdata_.md delete mode 100644 docs/api/modules/_procedures_pushdividendpayment_.md delete mode 100644 docs/api/modules/_procedures_reservesecuritytoken_.md delete mode 100644 docs/api/modules/_procedures_updatedividendstaxwithholdinglist_.md delete mode 100644 docs/api/modules/_utils_constants_.md diff --git a/docs/api/.gitbook/assets/Polymath.png b/docs/api/.gitbook/assets/Polymath.png new file mode 100644 index 0000000000000000000000000000000000000000..b1ca4eb6de5038b38da7e8edcda8d420a5df8e4e GIT binary patch literal 52424 zcmYhDV|d(K*T!QfjcqozZKqLV+qP}nNz>Sz*tTt}Ng6wO({p;B>-{n_pXOS#_g?q< zt$VNkgv-l`!^2?1009BPOG=0+0s(<^e13j}g7|#hq0^!Jd;@k=6c+-jn#4T;0ulg{ z6cJQ*1OC+k>1XskneSb(aFW-3SRI@!ECOsr!7ii+9GY#rl`v#rgY_3NvBBe77pnn~ zXnp|_+%aL^S5QOj_^%223uxdN+Ou#dT*@9hAKnj(XE53=(sSCv!e??=&Jd>=mWn~mEK0wqG3A^dlC^v^nFVTs3v zT7TLYFr1nOmSElO3T}VFPT4qb@jqyLuixt0-RH*&!5YWx5k>s`Qbe#rB#=p-jB=Up zh-SPXgxux$+MV-Z9-hk~wO^LUfs6Ei9YGx0#8}f_oNAj{@ptxh(eWKOR9nlcvGa83 z%a+{DGFDe4z+Ks9pnu` zx>e`Ecr=MM&+PEsJf=X$GT~W6yTuOKG98pzN4Qt%tHG}a*^B80_!wfZUY7pn0~XA~2MY=D(X*}1)jdtC<)z))8e;DNmF@E&TfKl`s$T|>xPjtb zdxK*0-GQhxCH$nvUSs1obnEowr^{U;cpHmlvs&I>WGnc>O9CnN|ePXK8R!qv3VrTT~d6%%ayv1N^?{J_gbyI#MvC{`RHWOB@lbs|NRD z)3VEF_M+_15iNg-0!y={Pv>^&8r`Zeb*Z!D=CCE*N^mFvk@Zn z4VA|@hF57bYwRUU2^~ig)-C?1SP&zPdBX$bA=Wv;wY_g8FOGc(K5zM3cSFuw99-H} zm02i%!V*AC(*X;*m7{-WdWI9&?q;TorP=yL4=v+MzvXfd>vg#>y?q`?KSVdZPFq7` zW~X3*vObz98EwlpIK+l!-mVGACQ<8|lHGbe4SdjY);vgYC|rQ5;MsY7;D|rQ`0+z~ z-(9^AfM=-JV_;@J_TeZYTa`X{=wXurSc%OPvkSFV?+OFE0A2FhBTb`~K>8cg2~^UD zs!x$L?KLzAt-$tiA{{p_OdGRaOwE_pwSk5T;7D>9`9ZnhZ8>CkqtOZSXeWnq!Rt&p zYbCHqqtS;qAh6S7w~y1lhpH8Z(#k9|ED&3coq&UllsmFD`**BENQ>ycNk|9`tavlH zBeOc7pJ-#iGmSMiSUE4$=qEa348G`Yo7pGPgNc?)Is3uZ2ikvk(S?w(z}2N9QDVga zOeNcCq$^-Q3nRS$x$cBCEV>x#TVyEZF&#sKAwAYS4fzlowhaVKUzSPyJ_hL;XiF<} zH7tJTQAQgq_NYEABFAY#b!EW)I}U^C^4txRC~v~?{p~%D_giEQ^p##r0v0ft5141J zu14q8Sp5Dn3468sQcAwqwcy`a7KuJ%S)@&e;z0wu$HI=e_(k(Vqm?*WlJke^wiR1iuCTG>W7PD0V?ApoZ-#ZTublGD`BGbtgaJQz-Nu zOr`48p=kx<2~`G@4{jFcNS046ons-svRQy^?C4aDL1bkSxf``}k&dy=mjoRg z#U|}!`T3QWw9EgJ{3`Fw(`S+QBmSl9PQ)DVNejn+fx_nws4vDF^bjr-+1A1-5*AK6 zZ|9-r;$$BXyIyjB^Er+4w0+r~)2}@7 zAi%~}lnQIKT#86sccKl5qW+XmM{MAk+sTuIXAclSzi5hdpb|!EJQ`d%&QusqLpD7`fhH zSX~7{P!(J!mK0)@!*^jnUOl#oUD#Pnhb>*0?FixUR%phA0D2F)7wQjBZM}R&Hyane z8*6|lQn4J*Ln8I16D=q#&Cj!SNCSd4FYV~k$yDne(0#gqF*yD{jG;$tM{dm-$?Ah0 z1eLW6BWVj2ohdmN$p5;$>uQ04)B_w&1!FBUB(5W`KLLZcHVQ9e5EZ3QIynXIV<)-z z&FALorSrk7rS;}uJz|dzGfcd4N|5B;wtHxwTqrfm1Y<oQa2hrs$Fg=vrsanL^%$Po@06H5vS><}GyfSawjFwQQgtmQ7yOxzu^75I5_V(^=Inua!yz#q`` zON-9TALkJFoXo~9)z6v_n<2)yyO8JiMOl>0=$!wE{4o#6lWAKvfuKj`?{_H=#QOuAAY(1_S|f`>?}T2vpP@jZn*c@AHirhnAdQV?vL?8pia)? z1Z4+SH-eHY1PIl0hfKls%L}+TBA=-ZU%0!jKeuofIU|Dy61Z(+A=zD_G=txO8VdH1 zaiad4+h#-{LLQn>MNX{VP!)VnvtO2r96^`2>b!zNEUx_w{LGc9socS3@K(PQ$J04w zr~3EPBA+oCgac<)R|L~h#FBU6doVw^Se-GoQFt7^hjyN2LlW>LeO2`Z6d1%3CW0S8`T{a=VmPBY!%dvRP0xD^&mA0K&m`0pNo zGIY#5e_Y+Qv$T%I>mqKc<$p7`WiCasu*1QY($9NrZ|pMXvQ#v=guLgz-OzPWoRs~- z^Lt{}uMz%^H#=Ds&f8plJ;E1y(xO-q0b|k}A8-EmEZby%DU-_l`b$pJ%1!&jR_zXR zlq#EHgt?fUi1HT?id`QD5@s<5B#}Rb#Gf<7&&=a!IbgE*q=M_ST$}jbhJ@k0#rgDW zQ|y3CMES|v+7mN!oDPlt@W>K0DC#tH!-0V*UM#&-g~o zM^7<9lfgiQi%bC)(wR;DwKYb?MO~}U`EspNeCgycake8>~f3i#(O$e@&-Z?d^2#s-mMAz4b*ribo#*`D*jBSyh13b6Kl$>S@mK>HRtQ#mzCP8 zH7kni*j4>XBnPM=#>BfbLg_5ThDxO62evZj%4qP$jxf}o5_qyhI0;F8(pHQeY&75K z@k%#k^7U=l{Rc!5+GcZ0lTSHx{oVFn+q^jb+F)STYbp^@ zW0~t)7}49^Lvz80)$t&iWA_|@czKe9zI`E6b}=V4u)2-3io_QXYx1YyMNDX{O}`~t zNZjX~JHoE=(S>a2qfM{fr|OeBjI9{>9&x1b9xQ?_usUuSMYR=^rmS@th+X%U580h~f!=EjQBIVf)#fw5KiSN8klGF!gc<0w!t37V zLY+HtHWL4&v{I4(mTSW$dalp= z{j9>Uj6oA?xs<9<*PQw*$lM6+>369J>2kK`^dM}PT3{KVMbZ3@CgGpY#7sO^0a8v% zdN`T^6`Y4+m9_kvjdN;ktcBE}owd|7w)6tqRZS*(P303R86Ol8>PuSeo>zEH2)=m= zTC3{50}=W|(Z-$2+|7OJ4I77I{i4l{wboNuKQ(h%FFx)DCcd?12S{)IE36J+CfQ13 zG((#GwjloO@Y!A7>vCH9nllTHD01_RK)K}9iT;OH#@0cMH*-;_f)iHMFb221<`bfa z3}$2$u271okq^Qs5)@T4*Zpn|<*k!u;x*k)zm8`>VO=@7a*kE^SDlrhT;e7lk!&^R zAH)$j_Nz(!uP!F0ow^Xydc+C@HVa}v_XfIqO{cc7YqKh2QbmJ;+^+pM*ovbYEyrYv z+SSB6&Mk#8FUzYg&(pG}E!d~tBn}1L2pR{Yzoih^drV%`?{0avH+zcmFuF;xYzD%I z`e^KQ|ETrdsajD}-NKq9NsprXbJV)m#q*wYlUrh=$L$~pYfkqgb3NIxNz{bU;!%BL423` zLwXyw#rohVWakcls_WgYPN*57IK#OU%Vv2)yOymOjdZjvx9P^iCPfjvwHD}!#vfE- z2gyIl-a6y|Y3e)w31L7}Z_+=KwP(3{$0!rat`>Og3j$G@0W;|Jtl+CUW-lcN1r#6q zAa&`H#|(VeJS;&h)n+>Hv+t5@l2%yU9LQ(>6Sn=senE+F+zK44J^oSTc+)^Q_(uC4 zUpdjDq!1n<(|ETtC93pjd(tEBk;Mcj0K_r-OQqFuDVc;0$r$p&DC-Y@jyGNxC9@4Pvjv<{p8lWk!Be;S)6XEmvB zv?6+UYxKNhOuwcAAw&aHR;L0~dK&x@%#~Q4MP+o1GC~EXE&3sf8!dWL)vHa2$O~SEpk?a zBaE~Ts@N~TB9e*w2eKY3te(waARUIs(!FW+{`x1pIvBFuBHc43}WYXd5Fx+c_IWOI!h(~SMR3DKO1ZSwAu-P6D)@F z@Vd$>)t3)hse`_I&v`k9ZAl?nMGAC<_y!1vG)})k!bC$MEhEj`S(tXafKM_>AZl*| zHfn#lNHVq9p;u|2_m^NMW50mi38Gjcih)^2%S)f1fz)vt$Y%?J1kk)jSN6v>MvplpJmT7mqK5nfk(t^6VU*xrY#EE4uQ!2a73}O&33tHd@Qrh9 z5=^Z9+Pu9}Gj~#}HvuLCVjf=gj0lO4HeN|8IZGC(7C(8XG+}!^ zzeks4H(TMk%op>aL=VypS{ahIXE~xGaj>KxDbp@r#rWP9Z}ILOWg|)q{=*&uhzxLy zwsCErW|EroY#~Jem{!PA{vuaJa&88B2Whf#nCcTb>(n9MTAq8h;*OzhrMmHakjCny z+metdf;qN)xeaTr1l?PfBR2HPetvEKIjy8MHe+zQ3=wJBz@4Pu9o8-~I3oq;mn5t( zwm^Xt);?8eP6twMakuZ(xWb?oQ7uzg(EYW}7Kok}L%dUOmW!h~(Eb`tB?F0NXLJ6L zIWx&>t^2)UD4ww}kg1>`_w8a8mICp*787%&m0Ma59n75ys>O!nsdn#4x&5i}I83Fr@GBSqLfX1N4(uOvl_UO?tVFXhH58}{OzaEEW$CFQ z!xP^bqhetgt~g3GqCDc#OvKt!&=AJGJu4#@v$75wuon#r&nux`h^#U(BS|3=u~gzt z`aGK(4n<~3*|tQ-hB6-D^L_NfM4Vo0g)>cGuZ?!}G>4%Y1t^e^%TdlgMqKQ^e8I>H zD2Btn_i)h0RT%=j1hY|b;`9jIxxZe)E$Gd6Mq_Uo!T}**G7M@#vN|OWY&Kv~H5j8@DuH?`Y^N{ni559H+b(-Q-KCW(3QHD4 z*`?M3tmAq)tK1<(SVk{H=&LEmxa1VCyit~%&AindkKd8GX%r&?)>wg@=RLivtY$-q zaLnVfB}sTyW)1Li)2$D={pD$}EHeXmErIhKiSU`tZ{E#WP%i_IyN0BLmfS}t+LxSeJXWx#}8^zJEzmbXv zjN|O{9bwjshS5Jp_FA}Vi5;oB%879L`@Ua1J(b=(KiD}9LZ@C9hKRBvYG3B zP<1$zrZLv1;`6%U!s3E-QQA-1J66T$JE&CTE^J|SwzQ<}3(=b@`Jd@Z2R7Pb{w0({9TkF#dB5<`j<0b@w9Yqd`nZVN+ri`zB25%&Z>dotOTG%SfBWDSocM18?2~(xa zYgD0a4KiKgT@5Xi9%9m>wOm&wd>R>-S~oiqedVF4o`grAiU79UkjE+;jd@Z#F@$IL z`{dH*faC7o`MB(x*LuuAwVxb+&*MO0@b#=rU}l_*gVWpLFMy-;+5f;`l9&PQyNoGW z@{9=?$Pm7#jxC`4(h`8?-ZWYR!Niaq9J~F~ezn4-M6Ywj2{~hAq`!m?T3|Xog(K0V zw~DK)%B=6Vp`pz8^|)+W6y^SC(Xo4l`?}~f4w(#CBSQb8MO9me(t5W*8b` zACxWbYZ19`kAWXcQk(_!e+6O?DQ%ZtVGmR)@+q);hC-{s5z%>(L(VAJW1aV0DU=-f zz8y(K?bt})Yt_mFSEQ1&_nX5&QeU*0Uh*3?F;P@(C)9<;M>ETZTKj9VY%vJkV6y%Y zPux6`v8k3<<>WWQwxnG1I7v6G!-{DhQG!h1-P@d(;SS5m^7^HWg+KN%og>CwhK~t1 zg#o>N;5aodcWZX09Nxv#if}n^85j43>>*L@b<%f`sCQX-b9kslb{!Z$FAhq*_r1Xc^LOlqfXY=!=6 z8*6$9Vxj^p0hpi`q{NtDY2B)<6>OrF#>0aEzr^Onvm}hk#2M<@5n9%)8_W|BIVb;@ zme9-2!^B1-=;~^YivWMObxa0tQ%`yZml|0^Q#ItvkWCjBIA4n48YmEYKS@#L^zV9b z8B9jZdtwj>&e*vlA3?LgwYEJmK5Uu1Z;O|m53P1Q?ihc)SRF9(k4WB*>)~TZApf6o zowulKb@ajK2S6j6(l zFhPFF&c*zl6)ZNd7G-9|otLWZ-z_)Ye-T3DBG6WN>_()c4aFR)giU~`8&#?VdA2tT zk9-JHkCgDJI0tXx?)jYB$3yyDnCo@4aTHWH()N$*7|?x7BLAXl_iT&`Z2}JhjJrtp zLMkNbjZM6!QO;f;B<@B@>X_D5muH>5rF5xZK#Ezg}ZMh%15VuEl~e9&eEETHKs6dQ5S?`SVUT!F`s(bv?#NTw5Fu;MjBYx=T5sBdG%uZ zWO;vS>uGRq=g6J48Ym6_H!sK$x2xk&1@%UuDs;T{b7u%z5V00FS7zWWqa~^&pe1cl zDIDCDWrhfbEuME>t-I$f z8R;I;9Z#WCqsfxd41t7=kjr`Bc7S2n%G!}sWd0bsZ73GRW%64*g0~O*`rs&I`XG%_5{5`&Y99 zicp7}LnlCc#oGNIw$cTE-*mGreVm4x^3D9_nElT;Bl(2AbEt7g$GA^N*Qv}o(yxETYv&QmANJLB=8MIPn0V>6>~Uo^oa<` zd4Z@BjAlA?L#|nZmeR`vM>}~~OOC3|dX|dnnF}mSJIXcS$`8={`h_WO-vFbVWlTBo zgAr;RzD8R&7qIuR(RxVAXl%B}B(d~QNp64vChDjZa^SmT=CQ)N+mhx#P`fYAgU*ac zusldHOhB*IDn!Wn2}m`no`J$Z2rG~5|1yDULAP^UI4IM{D3=bK#=G@uO#Jj}Xu0Imyz=O14Iqf~6?(5kG^sHD^L<^~@6qWH?hDC3#iJ zQZ2mxQpx$iSRlMr->Qxrl1R*|j)mg}T(hQJCiY}bzZz$IFa_5=0=KRe$nmkMp|F7F zW(=BzqdBuoJvgEd)V1mq`~}OzHXF(C=F?BsOOIB=x?zF8pkgifiBy_;*_qi@*j&C} z<|3a=1#EuY@U+?nFG6^`qUvm{Bo<)30O!RL4wvJ6+=$5BaNc*QLU% zGp(mLo8u*y6jE!wyr-1*o3wGz&V$72!Nn4Xi}W&Iz^t5nfy;OALejl~L|mou@}d`n+$Oh zt;}RgW~EfZ`sKAfq9MaCnD0<^Ozuzqu=f1v$!1u|5Ddc1r&Hk}f{usW@P%?L^14~xN=A;=xmaA*9nW@h2j zv{>kc?o!|^A(UXPAV9d@iIUU}U-@h&g~X*1k7#yDKCo8TxyQTPC+-71ZC~$8r&Lk} zt6=_KZK8cT2$RXlR((8w1{`8n=;4LA@9pEhNEd5a_X%VlJD5KrUXTx-_H z)y(d|GTNAHZV=*(yTzy5p4Rq(26Fsk9Heue?5I6Jl`JFl_T%A={F)7Vxt z98*Ur7*159v`h;%L$rU+GESApN#WMw52?#vSw<{>kLW!KVaDdYAy2v3XD>cr>qO%S zKRhp2|9R1hyiOXdL=lqgVSDh@Zm4;F3`aUF$D+@WeK|khk>zhp+KNt`v;r$7EM>}O zg<{va(TujN5gLjjybF|Z%%H;%P7^D6J8_#9kLx>vxpt2mW*dSczYoxg(zTdGO8RBY zD=l`MnZSUE_OMvy+nLO+LI2k;>sWlS>b%RfR;dBqp z?@wPNWseX_zhAP%t?e#NL^+qAgo|UeRu)Mz`L5CJ>x)i>!e}lGTo9GJWOJgS<`7oJYJX*EiE6LL(G}G_>Y!2o!}p@|8x_2 zK17J`xD(atV^)!fYPAN-;q;oE4|Xvj#$d#t2WtAfy`LnrFcU0D%o!=5v#xR?*A&k?`a#}} z;7ZG%2F1u_H}BD)We%Km8LNH<2_vRZr+E_25rC#}h!Do>&z#7eKRyjX@Vl(b`SK}E z|Mf?S=F^|CrcV`SI6^|4axbEG!W5LOlccKI zF@0m>3?}P+5@1EF*6PosNYt8GG8dm=fxb%zc1z4o|G1H1jie=oW5{Z|b4 zIgV2E>ru3vXUW7@kvw@Nx^cyR#^-N`Q2Grk0pBiU% z&H|XFC___YLYFN+CjpUzp|u(jl;F;4Mmb-XBjR$ z>7R!yxlSRQ`FOfBqspRTt-vueAb1>DZZ!(efd9YUD7mNRI-=m;BLBP)P8CnFx#NTU z@>Va2D*JShnSC?suJ9b_@J91Y!ys5xOn|0TdI@!YN4&lZ+= zz_C42Z#jh#K4{4SAZh^*BNC35Z2{uWXn#~N5>)E`)-put)a^9F$WhH`V#gRxyG9vK z$0i8Z6|zq?IwIRNhaxD^?6WprC9rlj3P?@-Td*CGKS9RPL7n28#lTuuU5RD6FV=8h zxJH{Mqu*-^d+3}04V}Z zRM7S_W#8~FE=vF#lV_=A1keOL2|4dW)yZiZ> zfZXWi-?&GVhtjQaTMYO>!5<;%BYsTo37!UFOdvjvqE*&{#|NK(t@m%C`z4{D5I6Cg zwP^Ds>l27t8t4~DIjpKTDW1op6`bPxh_vamaR?jCV9W59Uv@?BW-i;{VSNzXAF)GIJ%$cUmB=st#}`V{$#8#_E+;%mn>j3RxN- zEQWxs(fPs`PA!Y*fURYQ{G@(@EbN?bLEzHcd0R_P-O_pH6S$}NooQ?s%q=MwymZn8 zrlIT6q6Ap@$0>fz1e$(5%y|R+`l$GN9suLMYdQw`46#itcs9cT>_hQv(d=w-LDi)_ zZOllU`2u?V+a2nr>%5Qa9UY_M@OFwQIlC7@ia6~VVnbJ94qrjc-x~2t{If><((Q|2 z=6FsTdq*Rx?u7A}MjO+f%A4K6JwR=Q&vu<`lrFmby*pLbm-Lo7k3|1nmhuhA_3=y1;MIT=2Ps!m^i1+Gq^ zE>jF(BTHJ%5-6YSose=~S8il`g-!}tu|I9ttE2>G=Vz;%pjE^H;gjsH!w)nO@~||Z z_}6qu!+~lDHyMYwGdZIP2?_c6b8&X6PydJ}L9tTO+K8=XjkujVNlbR_n?j*|53 zz&q>70p|2-$hv&v7jAQ-SCz%WC0}-fw)-D*@--eWrry?HWX`Fq{cgyS@9t+hJxGgJ zP*GH6TqO1z=O4)n6>Oc@dm3>!?rDCN?DRv-`CW7x!-U>X6f~IPg%hJ+me+mB4;NpQ zCRR@`3R=dx^Md8~RB6g*@6#d+i$Ef7%?hdG^`Cz)b;nWva(mLU zJlyRCf}#?X0oIyml#9KhhI-|;5UmWqWw9iMG~#>c)r@q?c&&@ z_>y~0q3Oyre*2gIB2iYCaKc)QIhV}m{+?zpYfDwsZiXhRauZnFmODXLp(aW9 zPc{4;@uU31!SM%LZ!xx20Ixl&vAUEtyHVn?IeSa2K9w$(+CpKha5!ji)+SE53XaO> zMByMSdpbW*?;mw1)@c5-c}W(&$xngUp-Y;qD&CKYUXIo`ICvW|M*IOK;OQ(mn@WYc z;y?C(pk!7}$|C>rh(Bz8yP1XldhDb!r4~n{THV=l@^su46sRERMNj(yfeu14^v?p0 z>x1nRysCFLQ-AAl3TJ0>Da*utg0o^oSsetVEz8+448X%cgY;=mH~?9MRg#4BdD#b0YqX6#r?l55Yf&kxX}(5|6pe4Z#(S@h}QH*o&CfQbY|q z9+AGuir^2IoA;<3a@1C~2kAH0xx{bU8NoBK=F?gG!s9(hsc$)*>gm|B#|yKuEk9Tc z0bbQcU;RxGpys}J8wvMFZ#Fun)oo2~u#mP&&1ovuFA&6&)mVWuu3f@o1-#)$~RkmKRrc*O_#oIQZ#$B0o=kF;;(b=~EuP6fWPY5Y2{ z3^;RUla;H%cdTlay*P>h6pS?opmX~7p8#cZ86=Fz(SErCUX@A9mMH6|(vxZ36*xzR z`EH=5$k9brhs#F^sM$%ON(ZH>+>&)#3r<64^ok&89^& z#FkGewNXcr7AM>dEFRkoSurswRJQ1Gl68mN&#_O7;)p%R;A2+nZ--^_hjv0L$28wh z5(KB%RS7v3ucom&p;y<>WtkHwT2ZdAk*s0p@uWVd-3m+h(Gj=6!)Op0KL^VC{9A+} zVjGJS(k%^|)!hW@q-8IikT!XYG6ZKgGw6}+arTv0-glc9z|v}+LBFjXhA=UxgHPy| zq3w#8a?n}}%J!dIe+iowB6$LXb}xpauSJl>nOE}bMxNEInRod54=HPj{aHRWZDei! z8U$gT(7h|8C#a!1SE||Llw_oE=y?*$*Qg`qbVG@+h>$Drk>{jQ9E!8846ehWRT(1Y zy{C@X+2n-Gm1gJkEVZKMu|&l%u#4E)We!%-%odOnT4}$CU{KO9C1}HKpFI5}DU}cT zHoxij{D=VoX@QvvUCQ(cm08Y;k7Cz!x(ylBaD-W{{kDf2<}PdqB=u=ld@iC1<7W;O zn_sEmy7maPQ`?6ffD^VJ#zV0JA`h00Sy~UkNja~0%np82R|PxU?@tc`1B{lArM#??rLokYL zx4-OKmEt56F{hi&=C2E^0`aqZh3So7or#_Xa#EmO>r%OPCUL z(Y;(fZsTA78a`=fe=Mc~rIUWT5TXEu^^GTwa@AfM2JYrSlgwa$!%?l() zzn3!4e|vdY?LQG)S6{?vunvU{=wJKQd`TY1*4baUY_6HI+Y7}m^2OCE+k{)#tD5JV zMXF@X&%|I6(7a1)4a$xGYQ;u3eO42IJe6^LvbAu}p+SKF?aE=I_VlAf9PT zCil9R5vvw9--S(nl1(@N?O`Yr8)NN4S~kqGlz!scK`Lo$uV39s+&6HvKw(vs)-h$_ z_2`gY8idvU1t(iNeG;2X^h$URB3lKko=tRa4KYkn{ZBIat4DqMM{G2k5kDe5TV-$V zI*mIQZlizph`RoK+f@#`2udStb&{A3Qb{Zbx8&G%U%emPO(te6CGZgSITjGvEpHf% zkdeKpuDM)sshIsjEwqKHkcD+aBj+UuQeD^S-*3^Y(v>7fTEx=GQkVxwMQ|EemAe&{ zWtK6Kx>xW(jMK51E}C?Y_X7b8tj09mSmq-uqNcIgIrtOwU$NblniuR>|5YWp&$P0Q zL^nMs)x7|0J z7+BrxeU4JFz?pI5XYp@%!~L#vp8QN}#Yr90Q>ttbrvAeXAz zya%AukdR;-2?k-ss>Z6?DOiUlF>CIOkjJz@hxf)beJ{N3(6#|vrD1lLM#s3r#i|4W z2Z7(~w>wgA#@2cNEACEzJX0ls4D5|&Jlr54NQ^A@?J#aPqft{u;tslyqku7&L!Dipy_-=lA;27}BNn3RcfSINd25_QoH6v1b~ zyV335UetOh?TH5^LVDvdUu%iI`u%Q1d_E!O$wfq zv<8DfP`#=l_0hIxag#&Kku_08+rnk6uVOP+?mOfG7gQbujettZSN4oX@sr5;A54=9 zlv0`o2~?sA+1g{qj87GGD><6SUKt6RH!Wnys%Q}lK_REwdC$3hBMiBL3R0})PjbZ3 zM77Bg3U`me`H^M9!n4usnWqTHY^8CA4n~dv57mDupg$i1y(7y!^C8sgtWQbKl>+(~ zCeuSc&oP9G(Q%Zet5mdc6=)A{`>@lG1MCe4p(`Yo_7_t3IP^c9cSEog#ztYB?_j&T~fAJ_IPe zZRQ}nzVsc;eFd_@l7?}PZ{mPMC~6e>e&v+z!&Oz`qRqwwl!Vz5_+P0HZAh+Jj8CpL z*y9ee|Ku8H08pTjR4J(c-nR~y@S|1sZKSImxZQ6Fc@sdVX6q4Dg!olbVhUSdIu`G3 z`~j{aNGpRPdQ5>(!~$?-45m_sTw}^bqgSwCKJTa#YTtKZ`wb?G2K7hd##c^|gL!^7 z{y0B~T-8D6EBxBv{GCGjy=F^{rCi@JWYn-f?1YBJIxnRu;8lU&UmW*;FvJ6L6OP8x zktQsh`T!Yo=RFqQx%i-IU96d_MoLyCMH5Fs->5-lO>gCyIag!uAZvhnsR6Y+3wk|X zdq%R+Xk>ZmJX~T_Nl<=2I(M?^xT?GC!z^Y?&RVoPm(YAF^s?FPK(%)m_JDqwJR1BK zf6I0lHS$7+z2`kw$~7X%UI$s5P#D%O64F+hR^Q04)rs2z zcT>i@4#bl2ADIb$MYR_adIPg#rq=P9E)Ykm&I82n|mYr)~#A-V?0X9`ok z0jnF;`%b6OH#k&35y!#TiXUukd-BC6d522Npe{5FCUCGHgC|FaNl9>g-8{rFQ8CPK z^Ok`|z2xnn11a)hv9xEQ)?>`N3PyZpsAey^-w~(aWCPcJOKGJ+a0HzdRB0TCoIXG6 zU)ON*&){Eg0s{P7cT6mTP7uLmA_WxvDOK;9Bs}rpY)11SK5ginBA{b0Gr9PEex#M0 z0nS~tlD@I4b?StSZAXh@Q_v|X#6BdPm1wI04+zuwvezE|#BFZG`t_Iu@3&Ip1-yl* zWCE*m6&r8|=cx!tghv3oyzqp)adKCk-5ZLmZ6kQ{r=|2M&Er^~%Auk*YGr%K!|~Fd zieOnNn#ti5rm&OBTaLSIF&C}K**7(h8XMj27d!EQbYHmDI0Aa^g;MhXkC$%}bC|m7 z*3!7(K@BLjc1X|i7fJmwD#O%q;nOEr7xo_PnYH8je#f=0ekFzBQ#MqTx)qH%POjlx zj25%?$VigIa01cQcR<$b9Z(RSa(`^;1!PY2*AEFYPQ?JGI3RarPw-le(-_7sdINW%v-ahWH@$c++44_(b>dptc@ zz&O3CmH9xf3(QiFmBtiR+W0NTMww_d|BCKsn{Rsju{vUvDjQ?XcIi>V$Aiw6v+W#P z^MR<5Vv6pNt(=7ZA2_ea0Q2RgN5VXDeJ&ou1RBhJ)JvOm(o`y zQ3CKLthJ?WvCS-@J;r>{w|T=7ioGvCnO7m<1W0zcjmv7Nejxv}-H8#)_mto0;_|{^ zqaAidb{%A%;&1h_vNYL8p$vb@0D2+tVEe6$fo(oy` z6J+RMT+raLJ(2qt#q)SRK@!%^{mgu+V=7!^N-5U991CudG#xyf&08WLruv4fH)%om zcgY(mk^!L6GBj=Ym}SVolR$)|u)5*5&sP4k3kaUgy$Zw9L? zx4Da+l{%;DCHKE4_(Z`DvANAGqBlLB8;8_l968lQqxg$hBZ*;2iO;D|6<8bFX-Stz zPe*D~=ShA85?#zbXv{v$&ZIN96m*;)|Pa~n<|2(cC(RO3fLSX$+zKyY;&KLA)DzDaK)< zmieF{LzZ`(glEg)aOX-;1Ye~|Ya!gpOPU&I?9Q<-@o({q>~5#%7|Qav%d}c+p<{@? z5SxW*V&?)%R1lCBozRw!WJ@>8wYDv-(V#A=Z>5!wU1Lqpte~Z_Ub!_Lz_8bBvJWdV zE?=(k+YeAnm`+%hOQR_OZ2Mp?WoX?aAsft-trRL@pF4Z%HCd9(Wn_3^MgQ90K|9CW z>RHxT3`?N6(7nk@h2KPfyx8;T%ZG00q*#docWGxZPjhF?w9j4AU(GA>Dlts*z#QjKBBz= ze*=vrlC?Gt?K$%ozmz3uY6?KB1f@^I_vyk`XqrYnb+o1?Z^x3LA~~(@D4X-q)1pHb z5^Il}{$xNC*Jv-gVf(NV5qy3MbG5>%)&L!AT7+G%J`J+)aIF?8gqa(brfOo_AUmQI zG4ryDd86BVEqB)o2EQe|yWnqBc8}AxfFEY}c_{MAmb|=6UXA7zbXc+L|NR%hRD(Zq zz%%Sgc1~e}!aw69$6rBi5^g&W_NjHT96f9U&W{|5jIG-nn60o3Bub4?qou#w!Xo#P zHg>p0>0s1WHSM*Ynmd?qhiio~lQPMJRol<9xpQ#MtVosfJZTh9`6(WTQHNJBsY_sp zsOOD<;8hBtq$nn2qOi}aa6v&Xa@XKyXb0h)1w^xidDk1cfk*psfPV8&<)R&hRq1xbE}~Rku1SFSu(@Xdw&#eP~=ShNyd4 zZcYb*>s8n@rcE=I#Ka7&!Z_e<+20mIr60un>$7v?n;zn6I`EbVQ=t~)PC&G21FS$E zrUuaxq!qq5Nz9aj2-d^`n0iee1&7?$MTp9xVZC^12arG>?7U@8~g7CSWUmA-NirbLz8bDo3+?2@!`Re9M7e4*#< zMLE9j!I>P^^;;(aMe8rc&rsNp?D9&D#Xgk%RM|H_O;IfU87Z}n9rkYJ7%d* zv{orqbUq@JJ$;qH!n)<}rZ=IEloA8(Wky>$jSsz!jqNmZy6b%^ozowP04rEr7fhoq z=y%?eh#$kOpNRMA9qe?Q`rZ5n4tllOtM@ss>N4}w97bu23f|@`81=#FB4Wh7GAmB%Gmt`DAvy2QO!7Kb~uf$rsjt&eH zYq>6xf(e(H`rW_J!kET186^y|&vKAUB<;lf(7ax zE!yl$-3KTdZY!>qV*WjF`=Zu9OtmnLa=2KTI^CQ1mqQ>8IiX!FE)81wdzY&=xNkv~8mXqe zAC-Tn&GqhUFaw3G+hO=d2#N3OW^8Q7BH?ghSKM%&kwCY>GWI8{x@1dH%oqP7;V82| zxn}g0_7+v%h}8N`h!z_{h4~jg$@aq5nAVs=T_S0kg<}x& zFD^AosC>@YCDQZH1x`ngYd&~-3R6fO4Jf_hSciDpC(5gk!CRQ9lb1}Svd@lQ>X}B1 zC3nq@61`@&*!Y$9i9)-mwsZEN+PVm33YE=_bTf)_>VyB!Sp&#@Y2^V41H~o~E93A7 z5oh5YJ2!E)uxeQ|)$~@?fzJw`k3&DWV>+TyV|)Rm67b|QdjX`X9FLV9#(IxE4nMi6 z`C3#Jgu8EcQ_`I0fDd)rJ{$&6GzjlC!k3Kbg0wG1mqR#gfY)BtN%Ldh&&97^GXz&= zmCox41RdA%22tMfX{PVKc*Sl+a&wObeYCN;9%j9)^)DB+66MO!zH2!IzIRcj{&rEh z-w&a9{lO-Iv&AW5Q(ste;c4rnjBWo9LDZ=6Hk?CX?4tD1nTWDV1a@0ztH>@ojgV+^OPhwZ!dGU60YFxE!pv&ZiC2{aA3PN|DHCzlepxI_!BEP*$tdd_J2PKD;Fn#s*JLn5uHl}>;jU05IA zk{^AoXP}o5bR(di>o0D4s$w&F$6iACb+$bUz{Y+uk5^7Yuy?5z`1?tNVcCNEv#Vs!w&;W z120Q)p2TOi^HsBz_%dgWT0qMd9G!hu9kK+#P^S^VJf^w%kbj8Wo#ghP$bavhW}1K4 zm|v@~Imq-AR1r?k-iD;0E^hr(sw`a5#5>|c^T;26lZ4U9S_Xe4joommqPdb{oGAz- z0T>!-%c{>h`ZrfAUL<4DgiZM#;s}S~d8elBisH=hq+Kq?L_T$183?;fJiWFyZ`|ko3MOy7^zIEY zT84jHAc%e2j?H&{MyyfO9|LpM+9`AoppOTQST`IX zoxCturBLYDl;SHE(6+|9;!^aKF>fL*&6W=TZrbyQ3^EbctSNw>-ghXIfwF36a(rsk z-%>v^O)gqKdA{{l-j}+x(ZilAZoC22}Q*$6qfY7(G)^2k}Lo1Z{CInxSfHkd0=`*09r3&y!VM zcrVn~uGqpA)DE`CH~3M!ufY3t_Frbrm@f7;#{KrF%9STFGq59O{iIH0iC-&LLri!w zKc;5dy}d?m*oxkX>%ATo$MPHFiVnW3>}<}|qTl=8+X5!yjH%*2HCpaL{(4+(aeT>m zaPyPF(QGOtw}tVte23n?Bc13)atjJ^1n*-^cyszpEC^yXWDM&Z$8C!CWqy{$Zld4k zlxY#g%_0#is9edgsJz7z56fo9DwcDGSfIQotEmJv+uX}H9Ah3+<#oGMhg*zy4cL{Z zroioY&RYbbd^wjX?1T|pt+TEmSG)hc;!2_s?AxQ+18@;Q`E`P~+K{PjJmAp@9YAcsd2K zs(*Wtj!-<`fF_8Z8wdfHsLQ==P~7&Yz@uXe6w=SFgX2_<5rPTyBE5JF>>i~OR==!x? z>pB0Nr~Z~=PGTW`B9->}o%y0mp)hQHGx_XtL)ky(^?2I|_N{x+&#?B`XXt&4OaTjA z1~I-()|#++xMSrwezID~Ji@!Hh^66w+(@FPgnB#)-C4ia~5~70_j4x5z2yD%=3^R@UWIJ>1rvF$n&( zm#&zR0WQAa5g*Y)zhhvZQR>@gcq%Gg(t5!mS9{?IEXa8k@=)pNh zT}xnJztv+#lb~5SA{uR@viNurpAl#RA5R7EH`VoZ97fOcE38kp?hiGfi*KyZ3cN28 zn|OWpQb;?}A3bI$H8G3g*tt+-iGlAOxU?$E!Z5X3JA!-W!f>cW_3L@dy<91@29Q_B zx|ET(>GGtXP4xAKjUGlQ^WrUajsNDVwnh!`4<+{)13bxz0hX=!9}YKpH8G+&33zmj z3|+xpC~JxoS{A7OyB8Y!4ZUpVHSp_J^MWlcjYN?X8yH@8hdraC0Q*nT8uM%?!$6xR zL{-6lYt37&01^%B>5YbNQ9;hx^C1qWNtaVB*B&A#&qbfdyk+A2a{!bX8a zs=l|KKjMHljC`>5iG{tSsELf}Uw_dG6&j*kroE4s^r;oBtGV;x8(34JF&si2EJe1r zU&3D8Ll^9PY=~%zv$+VF+yBZ@xtNXin4BwGJy510Yz;$BNIzyBbQS)gRCuJYi8j+f zJpWT5i&1@B#Sw+6Rdm}EcHliSEwZxy@}=aGvtti^fmif&J(5a_vZW28rk-U{n_wbS zl&!Zqx?dZCTA36%bB(>5g=Z?;l=)f8Hi0x9V}#^zo_^GKfTpuHMCFN=}7nw-;V z`H;qI0>_v=UT?D!jB2N-OUfP1MVFq70a_YP`xJnazt#w#qBV-b>*!8HXU1oiZkChH z8S+7*w$HClVZmJuy?9t=Rn=^5RIAzhZDYc&F0zT8_q>ahJdn5Z**jkIPhu06*3ZVy z4!obADj10t;^5`^r?#jo*OhBL9{A@sGpp>p!52?e6~6+3unEAwRZvzG{}>BkrT^kD zE_tsBuP~Nq$VP^EcTN(loSU6;h01U4OWT~so#*81_idRuS|~iXJ2E?Xo}33-2EnjD zsyQHi1v|hf(YyIll(rI^C)lP^br-1(W@?<}kEuVtusM|yjeU%rJA~Pht7-b_eH_W7 zXGMf{Tmj+##TmIu(cHXL0sCd} znLfIv%n@i?n7rZV=+-fiJMBwDd1cS_$DMqvL7%NA3$_b9uC{EEm7Sk4wwm9g$%gE* zijjd=`Das}=!tiAg@E<@!S-rm%Y}|YgTKy~9@_P(OyU&2lJE7m%!$Q9U`^{5o`qRB*hOlDUvs>hFZ=!fBL(+PDWWYY7 z(aI4@!p|2aYnn4JuknCS$hqFAh<^IKR7SEpsv=Qa#^<$m^L9Hq>uKYQD*3~HeTCfh zxjqKdQ_ED66LU|-{_lp{+UEmGay+atBf3#S7{`o}OP8|4%Jy6Xvlx+3Rk``KiWw~FwEIOa zY%oda4FG45F^a1Tc{J$ORiwpUz#SEprpjeASDFuT=uAB*_}>4xHC51cqnX&EwXgUB z*my=oH1iy|_f;J!&p26HN;;TYa9SAgZdt?jsr$(sdTW=>*I|d7lhC2B^%nw6iWgzi z6F9V(N4-rNZtEO$sYGyjd`Ml3_r!c;5WwVUTu%T&1O9I>Mg?m5o18k~U9cWTt&fGr zY4>^jSDzs?W27m6StmLXWFm*FW_dgQ*3#OvxAT-OSi_aOBOqG=rLQ-ln;5+&a8bpZ zyEX3FRK7F2)o2#0Q+cQsdmCto2-iFK=-F(5>V5W`VQ?LfcI_qZ zD-h>HEzJ)^90~~s5&)$KCOYJZ|1T^DD_5VJ28t=NDrfya4*bE^zj5H6ohB8038oDm z4)iqMYO|Z7=ef^^oF3Z?!Ut=FmmMybSs$fTgGa0zHoo29jX^0Wow*I1U^TB^3gGfg zbY2!?cDlRw$uo5^P)Dj>q5dpl`YEfIk9FCHV{ z!zFJ6W>8Ba7eVY7SWz8)zUAOvdENe|oBH(nlE8CXRG@tnaDQy@mNuhT$dok{D2+Xr zGy17`$Th34LZ4elEp}OWQAJ=Axc-FDkfnfi>wDg9PE8J4`^~qqIt;f8GWz6~df_;V z+PAnk-Y{y5`BFM9%pwb+qcHV7b?LmLB+nFt|N5pO=s3~nTU`REcLDx5(C;#Bzf{0+ zOn)%E?TNBnWM|`zvKo9s7Zbp8?+!Jm+u9ZL@z@zW>$RA@yCOrY?*Es%ogZH^n5=wNp$ zrD{6SL$N^T+pyO_X9k%;iH2w4kbV)(F|;d<=;NMeG_AGw(-Q9nwehjYcI(ffO)*=F z#1*p@yHOBXU@FL>Z^CQ)KPqMkVRx%e!WauuK@X2Ens&P*vCgrQKZ+#KHpXu2JpI9E z$i!_lA|xj$A5)Ex;wdRdF;v$nRA@EVFMf7{+3;OQTxBHz z?dxn`WXeL^>1{i3a)sL30_MI*-L zVu(wlJHxVjh{@Jtopc1Y4_x(YSv5yNS8wpd#X0_0%eIq80%4}0St)2vzUT7{hI%`7 z^4kBRWQ1tYOJ8|c3n?YD&*v5-3)X%ORJ*ZZMEjqRui$5aAWUTD?_yeZGgL@y>W;r~ z_U51=Hcu1_Y7r^?6V=*1eUnI7uBVB(GlbG1@I4ca@q5LAYNW)`X# z&zA4u#UhpNWciY{%dkFYV7&JsAb~=AcksiPkO7?)3U%uK-Ib>Ois=Y)#3~&3eL(nQ zjyJH^g@^{#?d6_uKzjFB!F>&T{5p58*PEHH-8;_3mEFe9?)+COtl2rsG}X&%P0NO<(3=ZT(5MJ68UZ9wirkxbE6WM9xUZ*s?GQn*LNOjaJDx`Iac!Zi9_-J*&LORHoX9x&Hu1 zSnKi@Af!bCyg##hX}~n$U>Wc}4zW}i#bKXl4gqKoa`J6bgHGc?cBp8}sboc9fv!Zn z2Ulo#{V+vmX40rq%q4;@Mn>=Jb?f5OaFNff8x;PHjA1~WEb?;fRe}+9EQeT{lh|^O zA%jBr&||ag(c%|{{fUwI|2pqKaDpJXhO}!KGkVvhl7etzx@Z51r3--%jMeo$!scLJ z>2SoS^=K*WT3v@l`>#jLe6n04mRGnN^J6^~d3r%Oh4_zSib)Y*D@+LFFMIZh$1!h% zJ9h?evi&2h=RF~rp_a|V3z)&%M7Jri$mB`qC_@9yh@Xz$t`5LemNJXAJO6LxSf%#R_Y%=*y~!E{3qhr)H?mhxN>b4r_U?j5w}h6$%N;CFrN$#;mXy3KsY> z2!u)JL-;}svDZKMAE|m%yi}*CAbdy9S#x~uv-KF6qPFlSmSuR-x=FzQWGkY4oy3{` z#+Oa*dTUVF&&fuo_iTCVBK0twiLbZsnORrt5rE?6Z{-)t{~<(3rO>TE0&9H!Pn9RM zYfTSR1t&$oF7oBy}Ve|O@$%(DQ6BIlv^oY5PbMau;wfX@ADKFTA= zh~Q~a9m;mERaRH=CP6ni7;kh{_L3HDy}ZZC=`iae)N*fylEIC%*p z%#5CGF}VlHfI0(fUM&w?m*mAtY#N)%P+QA{UnC}or@Behmql&bn7x%ybMH8s*-eDD zDHm{kY8L!_VOcIprSW$m_qZWEQh4y-oPI52HI*3YgpytM(56uk8!zpl6qf~b@3_5# z=9AP}HzvcWXJHAtFF-c<@?z_fmm2%?==Ry%n+tLXg@1@u{IGhEG z6&kA#!VMg)*>B8T&SO@vJx%_z{xST$9w5LRZa4|{^gZl zzYZVUo>C(I=0*WseB!xb*PSPmZg;NGdmjyDBt>K%%=%=!v9?=!3M7iy)%xVE8E6W` zF%C#OKa;#rAkFVpr2E_{RC!E9)$gp;Y|X51NxuDZknqj2@#XcCaC(g`S{B1G%V1LS5X-K?><&Ug&6;jG;5kA5i-MWtzlzmAQOYpJp(YF zb<7+$I8WW&IjJt*D((Bk#5)J%j}F+QP(Aao)fT3h`-kP&B54yG4in1Lx_$4la{9IBjviU(p%2ZzqQ%J2ic{Df z%A@)|lIZAv5|0;r4$1gDN^1hkugr|XqGBh-82yQQJFK;^ym*#@^cQyYDulWb7O-r%)=SQYbFs;|_NKNB} zb&ftpxL69bkE_D-K_}8|JRbl3)KdG<@Qj>m8cR=X1I zjuJ|6;)kCFhiS)88;#IfdC(+keJjQ~Ag$#h-MYYANd+&eG9eMNpHeEa@lNg0w8R9o z4Ec^j=_vSYzcwKx|UZZBL!4SBUw0?b#6?CXZTjvw0 z6kIm9;A*=Ur^txe$_oLI+5}7`)*=@YvjNdE^EhiNpjdjCb%u>?#Ia2n+6&^VObm&j zj4UiF7m}^ZY$Kk@)zMQj%e+SQ5xuwId$J~Q2^fD)OMU&T;{9H*6~cqUrv#Y-hq8dq zFD~^#=hG{6euG*01<5q33s|`Be-2n5=)=brhY%+RfV8T3V+3*W^43<;-$g~r!%zuo zBsxD`+xx*a1Bw{<WvU`@Uy76V5I_|+MkG?1h1D+N^XmczjVE*@t%}Ro|*gpi=F*P z@__jr`w8M1nc-g((x&t_coq)QU@363AC#sn@wGQkR-;Q^jq*WocU^Qx0J}rH!aL|^Likb1$*lmn=SxG6m+ZUc z5{NgDBnK)b+`t%Eoz+V|Hmey8H_%hwXm{Jm!&6fPKJ{lij2!fdY=3J)|4<#sq4tOl zy$|w~%JP z?*rqdW1E8Rrz^Uh)?5aAJpdua9dsc^DP9P&)`FRf!032=D-$DNu0EUf!J*Fjc~mRe zbXh??-Xgdvv|z>b5QpTUKLpu2ZB6Viy!oG7sNsXZha|8an_*>REb3H0j3`{DAUKF~ zo!#P^aTQr^Nx(}$Z&AfC4i5S2a_=J4_V0!|m6?01eRjHY0S+4^&Vg}+{)8PzxQ^mg zgp_hFhZy|zS-6G{Bsrq4Y|r>_luFepsRXz@{M*vK65lm-j*C<@Dt|ptpvqn|!u}gp z_>oSs{4*=;3|EwWywPl#RFOl8vwhp%1Dic-PLxe7dd7M*35tDpML4geCxJAhRQS3Q zmAhkJFL_T@-VNQw${+*?XJbg;wRUt^4%?(skV1FNf=~)J!MMd5=r_~1T~FaizoeT#JE#%skpCdp?Yby%GpLMCrlqQ>=x7sN2zt@GmUy#n0DETMic;Q7>S1O?9P zGuQzdlJ=|iOad#)WNY$GsPW&jgJ)HeGcuPE6&4a!HWZIk(jh50;S_D2soNGTmK;Vs zaWj*4POQT@P)mQXn%BH;tDT~)N2vc568q<9VTT)~n?^i6S}9`&gj^@Q2fJT2JIvLh z^&3sMS|}wIZ}3){_*9y`s~sI3>zlvrHCi3WZ)Kd47?PFa8&j)-gMx4zywbfyHbi;o z@fMQ$n$J78GvY}ps;=J5>JP#Ba~TGe{QI$UuyN)8vkH@6q4tmu*Y0xNPCj5FCFewTEnL1OEoSU3oWtx*?Sp5D1)7~R4|mLeUcQ;*ge*s);lN^D zkc#OHW2fYv4@%8=vrXgp%!*SnCpN?^c*V<@*~-J6ofKzs!w@+8_vMFo-L#0V4l+%aOVC`m9dg3%}B%HvG*sl6Wzloj4i zhFvzKnuWv;MgF~V-k033i;oP{n_?v3l+e^|gT{{b<6{t20l#fITy;VqvzKroKR7lF zf=M~$J^{(I^GPr}QQ((wSrIS`P7K@CnuepG12SX!z_@@-z9+JeO7rs^D|>sb*srOX zUq6D}3&1df_Mq8h!M80f)H&`3)xS^5{BtUykTWq#fnTe=fd=>EBz>|P(Vuvzk?9xb zq)0!CAH&(nL&Q-__zn%8%cW3tR)M{bF53G&D&t+OOKmqhAjZwYFW=c}M(0V$)nGGf zI7T`7(xqq`n70p^YwY@$Mc}HpDViKh3*9pM|AONGiGGR14fW&JyK3b_Doq>EXJD)@ zALFz&J$5zVMA_$(w{hhuvtzd+B@gnb<6{)7QbD^Ho^BwcpF2`dBXC_6MuLd&Vk6wO z4h4x~Nie9=;+Mw|PM8}TA&pNR?WWHOE`l#^@Z9Qn`mKM@*I8vQF(J(6)MBdb zIVS_uid|mQx9}(nKNZ_bYrrGcY>C8=anS1q{<@v?UU+t+8OW(NA>?!R>8X+ZZk%Z| zA=4A-JQs2D^9C*o9c|r7QvXDsD#)#Kotee%Zz*Xhs_VzXHPHV71-3Qxm<&`Q`n2{6 z-QKlO!5YNb;UQ9ooJC&O^zxvvp2k%jyx4HOhVNlXGZSND(9z1QW@S{2+ho}M`v7mU zZDR{~7E00%)qoqLwRc;V1*YS#VFER96-8dinJ~qgf_$M#GAJZy(@AJ zW0e$Nx?NqB+18D!yz#oU94o-bYn!#iNHwaDGJAabg*D{;X`y&|KyV0744~7q^2d5=77L+V2mtrL+dq-IED2{P_G|=ZZQYXJ#Bd607xrgK52a*2S zQLTPmKd3;}JoneB-2%5YR@(X)#KrM?HSP*&IDJCyG`wt$X7Ntidd?vgdcJNiqjF2v z_b$IW9)4^z75g3*DM6v|Ul)K3TNq0$A&KUv-!r_;);B@Vg^wg^@o(mPpk@YmGSzqa zw#?sH^`2HNCIeeNQb@WQ%yzbma8KY#0$O-Z&Jt)|d7sO}H6AZa`4 zCJ-m<8`uVJiL%{}GnsPq3C;Bmb+2abMXB#ca}iPI>(;NTCxlk^kXm~Ht@k9T zSN6)?IaE!%!!)M1V1eQFXtx!X2(GRBfBqm0?fnm`lM`Ja!o~%p!?mQ|Glsg#6(TG* zeVL46Y)I0tbNyeeNS*VjV!eY+03}Pc+sy(#`?m~@L-N0-yWs5G3pLoVy$zkd{|03u zY#_7SJMeh^wSMw_mQa`=7!nTp54CVamPZmYID{ZFS8k=YulDC6gEWY6kZAFn+TsB* zMBX^CxUz5W5DG8hAtWEaCv_ZffY8M{NWq8qj%qBf#judX^1oB=Cy`4SAp8^wV28^^4pL(QZ?l$Rcgi8M$3n!hfxigYw5VU7vK@EVT_0$0ieCG_FaB2Sp5xjT}ljt~f*g zQ5)Wx1;vrhtwCajpcVoYbnvuZ4kJ*hB~*SD<^27g|GLd29Gf_lc2eO2)2;_hz2gYc z;-~K82`kuuJ2=A}yl!hhD|J|Hdt2Yg#8!Q(_{9xD;9c>YT$$)MWD93jAC+_e)YSQkYPIXGul1e2PMX_%I&9aYlEy%zH>M5xU z^ZHlseUAe^PK4Ih>&mK<|2@#h=q>>$ZKSE+r4HzDx++}E#vXOsP>enS>y_Vr(TZqH zbu$?WX%E8h%!CxCCZrLi=Mwj09=!dZ&(cPMU%(Bg&UBT65C+u%f>9L zfED1Dql$x}HyGo$7>)L2ggp973HxC9*hc%*lTYNK)*9OXa_;wG{a@f3;PMy1Ln>v% zZ6eEv@Zc#@uNPAHx$aN9%6cCM+0fcZT^(eZzPIj9-119)>+UxZ7r)!g>-@ha;s0Y2 zmFlaoxSqvY6TyXh{hf?^a+d9n$zauHzI;(UGF^$2pW}TF{c)Gek>U;qSt;|aZT$bo ziA>?xJoB3;x)4zdLM|fb0Wp;NV%Bj?4vN#dgCUh)1?VU{v4U)O$4i*DlVcC1kdu|B ze*OO}X`qD4;GeS2STgSoX>QydBda~nZmG1TEwi1Ap-a3R=v={Czc8CKe|(p>dOx84 zXCwU<&TYj6RjBEgY<$^f*KK2f{O2cu*Qt>-k!Auq$~WP!mFO0SaMyx#xM;khl`<7V zu)pk=r4l`YdwEI6a~2E-%*ezv@x5ZVCIO!5t=40so5Y6s1(^-k{&_1U=oW@hZ8@(= z3pE_>EkwB?Sl?QUz3#@3(8yTbAvGk;ebLC`zU^<&lOD`kZW`$UksdhW)~b>tCUg>I z`oZE2p=wIfu{lq|_I7gXbC#%l5Z>~5p2cX{^;BB|_PjT0WZ^?Do_JU~aLn@(Hnjmv zwT}J!>qJ3N)*M|&;{zTgZvF*<>b=UHWCN3y30J|VRj@~B>9y7 zTzJWt!Tj#&C>(9H$>r6z2nhJHyl=i^+edhmY>PzI1ajz9Y2lW(MYx>YW*j5IHvu1c zECT@Pfb}rbUBwFe5i_2 zQf>tJ5QGjlUpB`ViL2$XPi^qw>lokjxe*l4p^_2Swze2V zF(-_L&s4rK+*Q(gNl9NE?;dHOoovJHll5K_Mv7yXK(^{?h6aa;E0*$HVYu+SjqaeY%_oBYZj;Nf)HIKC)`ohwjc{8L9r@ z;mN@sJui#iY9SUp=2^V?c^emZ@GaRApE(o-vYQuTdQ;HMh5xzyxpzRYe(;Njr|67e z+X^~_qj(h2f`e$dVXoMAK&h+|PuF3J@6Be$x?uZ`gmBj3L5+OXsftVVjK<|RyA*az zjKnuAEa+ph?60C6!_+c*Y%E#(r7M}4q(5T*%=Xwsxr!j#O*{>;GO9Bq<2!sRP$sUgQqa#E0d z%L|;85e>eo*H9@pVV|6}_`y#VxZ`7Gf&^o(T8H$c+Qcx+=gLOT{nKokXgbn|UcMW( znDG)bIQp08v)C!-36tnR7`mHv%n7Vx>e*#|J zPBhvSy4wlRG>-+J!#foVa9p+niTxc#P=%bCkaq-pW86lV1yNml!PKm=Kva-P+LjRs zsqGDx^7JZ8nXM>7a2M`pOWqSXA&ZxuhSBE72C&P@mUs0K?*Z(nKZIWfW>?%O1S>>% z1aDUE<2chIDft*(ci-Hw>Oo6@PP+&v3pNFWH&}kM)CCs`jE}bJR&npuKMo14R=oSu zBZ%j1;Fwcl4+qK!(%`OqfAT^!th*}tP!@2cubMcNmrH6P(kFnhy%IH;&ceWqdkVXD zQq6ON`j{yu>P(fv4k2e&U-cy-AQ))KFBs%h+G3r1=-(z*IhbfZ;p1#A_j~q`9RlGa z`}(Ka57KjX{JOGd9PX=1EvNE&Y)sC2hyk7YG_k)zl{nyy%k%?Qa1W5BPt@%c@%$N_ zYRjPOR~j-`>q!@Hgm#ocDGYBh2^k2|wxMhQBib*>Efl*82!tDg$nk2Xolv!LpFN^lU2>x-J@aSqvQrOv*PjT+-?Mlb-MT8HKwuc;7w>ujI zUjgQ!VS?HhNx8dJqKO&{-7%=wGe08885ps9Fu$Y!=x{-r!k1=Wv^BVGh9WD?7zpAa zR-q%WSeUo-L5*K+CCw#^b}Fe)-W2B94vrhVBJSB_kGRtI-mDtnXu$J;DY|o|@IWZh zHegQoW<5!R74<;fULva2#+feEPdZ=Wlr;J*f*5DUr(V{K!K6qFyFAS!&U~jve4K;t zk54vf!$~2<3`52Q+jBzOE2-;o1!2>7*Uc{&U?=05(;C5Y7XcnS};RSb`I z?v@y5`gUeM%11(Ap$)GiUg<|17VAz>vhY-*IZU%e+rJnphqbw!VG7$hzua zW>f_b1?H_wOY*5DeY_-yu`S*FAbdC@iOj~kaIo7Kb$z!?#&(`+`u{L`|a+mV9PJ%!R47TAPcwltj`uIlcJxy~1AlA=A2;tMG?$*~_+aNa!a)i94C^|G`{CuvhSO*IU6 zH{gdCX~<2#NDR@Hg&74KR=NujLn_T$l7h$cLOh`0M7-qqt5l1>&3t%Tza{?ayHM%d z4A#I(07iOb)J?m`DLk0QjlVEsDm+|zecFn6T%O*_>AJj34m0s;IzohipiFc0S9Q<; z*yccJ{TAOOQt02?QA0B4(N#?!8OJfhDFMFRF7_(4xt#D2F&A~v;qP8$zEk=}1$Se3 zC--L*bKBuj9zP{4+I;<^SGU9bTMAt()J+%Gm$GE1pVZwKvOXk=(p_W-wwc9=_=}ft zf0T80D*n?foF8%P0$<^&vRK^9M`VZoFYA+rapHnoJIo}HLW+s5dY0Lns?|5lG|__C zkjJSPF5iMHe$Ev!nN#ncU@Ud>Vy2N;`Wm0vho1Ta3;|)pxyGJQ z;^a?SgXAO}s{;%jF6|K==*+!Gr|}=hd3F8LMmL@SVOJ~2r#t47_1CoSeq_??*Qgiz z%H}2>kgSwPN^*Zr_tQ~V;&RoQJNwJrRno;v{E?YdR_@vF!p~G|{p7U6Hdc|aKGxDgN5;f}O>1wP{ROTncY5s8k7(52zsH7+$p=SvP=?k_7$x4BIo0jR zZeYp@icgiey_GCXIxwb0j9EBM>DX*=IJ?`2ewFXvXqV$wwLLuY?CuEz5NTOS=AlQtvFo1 zAQEl~^1f^Cibl?^PE?eihluAcQ~D#sTB+0^7i$(@a?cN3=hA*qAiBn*U^LbOw+8?& z{cXwnScTuIJ+?PMmW>^<7`2RY4ZmJ=!}o5t_Xclqz7ojrnqJQHv#co_!&9-9KQMu- z3=YLMRawJi$J={c617W3(*WQ98qN!~9c)^E1|qJwrN~{Z*(}B4z9~v$9QhL;bq_QW zhGAZ`PenM78FM9sn-Eou@a$J*PdY^{%9Xpv%$uyb>U`N=zhj|tr)z{5y!h$XYLr9O zdPN^*Aw|NXC8ElwY07H6zKtbcNmxWXC;C>(4B^`4l@z&{dQg9DG@7&*kU$6Wp)qBH zEixWp?sV(HEv2K~;epvPL;g`+`~&KD%ypH+P39j&(@{c#Y!mH$XFSI&W%l9@w7m-6 zmhcs!*&^iq6qZD@`_08fTV5FaBG%v?`2*28Y-kS8S)Sc_Svazeb1YoTX2z=ah>6Nv z7_Sg4Rudx%B(6O4NeyrExZxPJoZUH5ePI`y=S{JgIJzsC##$PXA^&b4x$;1^{G;Z^ zEL;nzp}P)0brC;mQ|D%da&&DSk|Bk)f75YevJGIe7q25;{g=_G6GoWkL9MdP>Fpds zqZt=y91pxW#j8Hytt?%C?9A|X?@uI7l)CnzJs&pC<53h%F(YA`Dexw+#(}-`q*{ z9gB_hV+z1?X{7sv)jA6f%-S})s9Tbw1%nrex89`ndI#n@)gH(8qJ-)*{npwi0FlAP zZs~Glxv?@p6>H190OdW@x94p^RPUJ|yx$gHx=3s83o^geqWucTOrKs>Eps8FpO4o% z<^4W7ywITLK!YMI>6bDjHLYYeO-k%WK0kBwlRT3-(3kgW{VA_5Xe|Asi^~WV=&~9t4b+?JxslsdN!m_APz`!1})sm&iUsoAi3(16Z{o zGkN6Oe4-M4NS(YHMNrJ^G5Y>Ep1*r1o>pjrR=3M0MUikQ#;sjudd`Zg`O@ zo{0z&hnQDIMLK2#eLthKyc(Pz^~zWJ!Fxk$RGGH}C%UE;O{V0-PSIqSGfo5fyp4A2uZQHhOJ72$3H8nN!59V;6@7nvuy4I@gIUJ;m1VSrVjo7ysk+Hwz;(w(b;mp)52%S%6g)@RPg*TPI z0%Uyy}#Dc-~hkiiIg??Eo$p9uxrWhT>khLoF4=Kbd-x)+5vu*VV<&-1vm%j#I@F+5ge{88+XQFP%yt?T@+=(B!m7?T9&PHNQNQ{ z1k$}+T7{0nz|D&TBgE%hut_zws_1%)Uw1DNe;zH&%^2$wYUYb&uF0a((FhfXkkEfo z{IXJ4%7==V!WrjXRYs2%+ow=AN*Zl3Kt*;Oz#44y^v+$WkF{7_J(Yn!J60oLr-4Sj zFVf;?v|OFcASytIpui|H&S0im;!h(O_;mbOHlm{AxwAJ`XWpMi``9Q$rM4COVLB=N z=wA0z@|%NP1OXOG3|M{hA*Q`_$*5R8zO&O>eQuMSwNwbHSA%tA@6U7_0FN+Q*mUYE z0jkRPURcurk+2rhi|lRt!qaDx6O*Xcy_Bp6O;|MuUvnnLR#;|c7TBJpv8#SVn`*z= z+7=p-3!E8Xp%)M*iczwv=v*c|ws*!YN@YiwJ5m(J4u<=wf4RZ~{v{{=(-sTVkyT=@<`3I3U&$7n+wpync3U%km6vk6)~ zMRVn;esHrwMOp=1Q~-$lZJ>O^jUnOEmF{7NOI?S@8wu{=K?AJ36tQ!X9V?Z`Dm0L~ ztT&!*SJe@A__$`#%LJ0Q)IVqF38IyC z6daZ_T)PexyCv52XL_$hhS<2Z7Tdtj5F>S)557)6Mt(Rj_aCgv{LL5df-jT7f$f*6 zHGvEIWqXp^9PL}8Up%zsB~>Njp;1?zs7?`ae(axCUP$6|!Z6_UC*41Jy^hf^uO?2Q z{9`~G1YkR)^5|f1ag${CgJ{Y;kgp<+v7l}MxBuQ>xm;CB;5fXWih@xD5|{dDlV@KK z!dtp{a^^VYKI85JWEsJq7=MIH&hJf>1StJ6DxNEm|NslAg!6m_H<~+T_QPoiL zONU4v8O$^LRUSTS{v*Pm&qJ|DyZ69@l8Bk$nGnoxE|dccGk7*wS(pa(3`1oIYCj%M zEOT6z_6Z)R#{KK_xDfrTEsmB z&i#^C7GGLi?3NM=4DyiN;qZzbaQ=}h98CRlS$)Pnbjza7(N?~N63q?^byACt!yn&v zT{CV7Ew=uzqJ{f{JO7dl)=Rv$L~Uu$!?pee^r!Beb}!Td)cv66K@rQ_t`>6$q%hp# zwlI9-t;DhwGcNua7sTc5*A@h_c*@ffHlqBOs%XR7YvqTY%u!}_Qau1T92wRxGnz{t zJFlLHs;BmrP!itH7`&e{WoO}EyPt_~@7%X~0NZegGC0r$SqMex<(3K5>`nR6zmKRV zBn}$GC9xrhm+m?}EQgDPv!+X z3EfFIF$CU3r4mAhoXD-Gsr_j%!Q~PsDW|$iJN6b>&u|^60uCD(X&u00iNsnC!8)0- zE4jH;%?3ZIWeWJxg3R#@5Rn|4rKF&f72nzuzZ)+9w~3q5OKtk`NRMf$CAT25kUGPzpcRTH>N z6Meg4VCUJIc?%WC^o^-@B~^#j9K+_P)$RhPYmMYoqV%Khukc|wn;(B)(!Ebg5AVVC zXQP9$*q#Z(q8!?@)xUDYmJkqi-Ctkev4m$=t{jX_(~BRv3Q+foBKZ zrYrgAx>4_!$_2NGeRAG-328uWju?!JIj&EWIvBnWj!5x~rm6A1#5Fu<;5NkyeG(K= zm?k}*{4wzDQUW7rK1sdmF|+*2KW{u?zEyfR!A+R8uEBL)6(c-b7YjQ1Tp+R4ZcUqU zi-wvwu-`yzTkA_=|9($g5s^OioldP0n5aXc`eiiG9?@uH45Se^d%}_GXLYQ(Ti9Xq zhJaE?#OQ>Qt5 zmhx;S<)$irTeId8c~m1(Z=c5{Vnp@(p&)zSLbm{|@{orN!u?aw4p-6Rq>R2v_94=_ z^K}(M`T8dk3PZb~H5sge8cV21fnnRHP{=!g7AjxnbMi>}4cpSrd6|jz0Fi;!uBT+? zdSQhAPhHhK$r)h_IWk6c+cbV69H4_Qt9li?p;ZopAG{0bgh#&1tK)foOcfq%3n*?3Zx$FPfc|9Dr(y_Y8nE1fa+$Da zAKjWb@z9FKsp%hAtA9HQ2Vs8aq$q6d-8($w=~u{Qm8=ku*`qbZU)JshA%6qqLfDB4jOKZ>-3fmJJug8(s@zZb=2VVj0a(#plIGoS(BKIP(_^|5`dI z*re{&2u{kMRfeQf`DmTjOgPJ8;PZEpAoPxz<8~6wXNIL%aAe;Q*CFLjYQaD`fTLIz zNOb=kcE^Oqw+Qxs8I{{m)Sa7<;uoMdyR{_dY@>`3q7s+b$?kl-^i2K^WdPYmu_*4; zckPKD9K;S*oFo^$*hC2Qs!RQXdu?Mhlw5}~+xHGm<3v!-NE;S3h^RvUa5sS;W<_ zM4w?R2)=+=#Yh`0-k_aQ>NZ{l(uA@^d8`$x4ijlLRw@+JUgry1tO1o4*&Nb!kAA-j z!Sor*%n-4Fs=!ncB&%iu5&6leMZUO19);}t-s(`4utYR=r6kH_p@|5e_%le7x5EU( zeVPuiUzfiKdXFDC(Un8lnx`=sAh3=>owFQ~bxS?pT{;C zmY&s>vt*FN)_4UmZjLq?!u(qWMMm&DR`b%%+)uQ8aD87H$l_l0Oxyo{et0}usuN7Z zl#9gP-SY3OZIey7Zw)MPpQ~hvtcG~~u4>$0Sz|v7F?f%lVVDKe=6qWDV^}{iB72Yi>J(lh4&@=@b4w`{GmlMRWzSZ z{hTJDU%&D)H^xfC9j>MkNC>y6iMy0nzXZnA$}8$ml(EYAW-}Wtc5)hTRwoWvBC%#d z8IVN2xL>W76qqZVRn#WB@*HK>+%|KK2AhPvT8J+*1GtZN&6~*bnp6DBuQRL zC{tV)!nxeg8}U+>e^GX73AxU)T2$QHk`*OAmT@LS1-_LE9yZrb^$;N0Zg!?%6Xe9V zbc#Yg{&lSjdX5|+YCfu>U(<;ED$De-!zi3oTaQI=@vJt}k^(JP6ZqygcaxP7xm9aa zvv41s;F2oXpt?5sob7n`Vm720G4^4R0K>08sq@riTPAO^B3Y-` zNwP|2*D-~A)*eS5AMwmEPD|id#T}cv2<#b19ms^4&qiW*wNHm=C8qQX zX2zGOKIp$*`DbAFW(I};{K0|xfIQMrqBXL=7bytt#;d(otQ-nFjVdfy<4=HJ2AEFF0183L^M z1+U~Gv*nA1)>guiG>G@rKi|kOi6JE@ffgPe-BI@~G~Xa#oQr^K2&l^}rZD{^_j(AI z?^hhCCC0ejys^8ThRnYC3LKN8jZ~bz(j^oVp zJ_z@~{r}KO$@)c6Yhy3%f5S#rV~}vU^N~=Es_ocz zRD~nC5%$+9heFKjqUfsN$T!VohR^##=%JmX{u6CUfDwmfyWO`GXPM!OL)n~jF5iwt z!?0s;KL0|z_~niaR`r1rm)si-%wA`%IFs~-GQo${+{kNf5l4l-z^O=$E0SLDAcDEy zQ5i}(ti8GMC}IU+QLA*ZIXC-n&HxwYZxDj#RM353@Y{uR(!I0a;adxvDz`P?9t3+! zbK8W$iul-%Ywx#ArS$lP^@zgCk2ZswN6!9lv>a2K(Y&L{evhPTG6-mKFN42I`k31U zZ*P4Fnwbas6Ic>48wI3x+q2z5X*-8aJcNj&mdI(><-j)S`0h^px8?jRALwEvOZ~+W z+rv0~Qw7Xm4G%|RoW;u#EK#b;%Jt@{W~h%PH-e7m<>yp>LLBb;4;*v)&Z09(UfD`& zO?owfbv}lSCo1Ai-;jZ5a|H7+cF8NW>I*##9gkF9P$@6b-_{b4)ZeFbirD79OwR>N z`0i}0!rR>j)1gx|fS4njGcCkR30O~5_>jOwmZwiO)~VToFRDv>_OInR2Nv`{%C&$| zL}{mU#w8|E*tot`$c`>A^rrjg)0rTM08*JpTrOjGvxUda@>Y?fR&W$327`IT(QAJh zZ72X0c(*6~_4}wm=~l@=3O4t_3%(5ns-G73;4i%phP;Fg%j{c|#xR5W9uKaQ?sUKY zDo`uS6R%6ai|h4QgF_30r4LZxhjX^}31&fAr_=s4_hx_xlvk&@EUlmcOOjN4`b-PJ zFu{U!X?cm;9+FxSzFK+PnrqsG!IB!ll<&5ixv$Ac_Gu_8Z9PZ}-dt;;Dh7`{;$frX zPPTu!{1pkd?gL)3Z&m39>6We;o6oHM*W1s=VJ;6p)_zNBnWOO!SZ1RKDCv?;E!t&t z1TxvbHyj~QZS7W7+Hxm{tMs%C(TXow9M?R-rS|272CXyM zqz_!Moe(Vt+?_a`Dp<|>>=xwqeXjpw1Ock3-lwj-ubkgMhXP6v5vH3jvG1{i z*n$!cRB646Npmu6#b}`|e2Ot(p*O5kG2a1nI1iGax|dllUt{I#&}HGFgqeJ2GYATv z9K@9Z7LZ#dV7^{y_~4DWmU~?>AQ5q$KuON*GYaXC9lpPM@*Y9kC4(Y>BMFx>{N;Z_ zt0yP%d|oT0=3^Is!JhR_#NFiY2!>^h3a}DUN?)0^+X|wvA?G_IQ!#k6$iO6%PP1S` zHGvH-$O~mjOj6n_l0)eUsoWsd3#lvaEQ)>_E}d~;C;Y6fnw`9Q`gFVi=0W9+8jCkY zNq4Fhr7NX-_suNDx9;y^B=Zc&Mzdq1jbKoaB`3I|np?~n`FQ98DWp0RG&ucgoL{65 zV$ZxihS!6h3U;ifbg3bHm0>MnxCKq9t0igc9|7nxM(*^bhae^pOK=R8HS$7zKC$>|mneH`@fmayp* z-3(N6W^V0cAgTW-jWwVDL*0fA&`v!D)-E zXWK73o_Jm@mfM4zGbP*O!S6j2{3m?D4mj|0)$&rld--eX&~IdEs?JeuNcSze{+SfY z39XJJ1A7q3=3q+N|F>B8;*Si_#y%^(;=9pGptpJdqf0H(>|ppdJ`=eQWJz0FMi#TO zGXZJg`&`0Pp^*+EzY+7SD zx`$;kRILN^yyZW=Z#zDs(J}o%ZF@kxG!a7#a(>O?^XQ)R#VOHoMfg|Fv$Y+Q3@W z*fQ4p=0<5xGDuyaOTeb^Jr~P-mBn2dAe({(W0`f+*(*}f%@D+=uyo~ z#6J@<8_h1EvJdRL)SHI;UjW%oKCc?gTz&Ib*lq)5GaRtq-wlxN57uOgpDX64^6y>) zk-Y^K?PFbbh0uR}4d0HcG;G7!#*xkc;QWE~uVF*lB$ClWVw7@}Vl0)gV4hcQ-^Qi; zCNG=L@#E~lXIJ@sLOgxs!45DdclHqz0D--$>4&iL%WerikyuOnItogs`M@<}R9SBw z$O>{>_TTk}oXS3y$5wAZvpk}LMC z+q)skW@0*Us%W1jsB>od2}Wkw4>O>X^`39+aUv5eHt@tyGOH*m@gZ+O>=dTo3&twW zBmR@BPg+;ic2JEA6S)}U3?Le@8KZ@0*(ksKvv~N6$`oC&?24i9!u!zv{&)F~&Nra0 zRt`8%LT2VoJ_B;PW|9&^J4dR;ISv}0Z$N+WUUrm{IjE$wIESv$` zbA|kXP6CCoJ0vI)ku%C;S8iWZjiodkd3dl~EPyKo7lhpcTy{nBBqP>xv~|u!V)drf z5A*V=xqUuwiIrABu`Hl)(3AKX5n3hUP>LU7W*}PAQ2wAJ;|4 zbW&Re{YAgFXp?0Bg1!l+hpPVk%l{un@WyLakMJ*p=|f0H1DnN5otsshz7UVl?1|s| z0v_^f0XlcqSHAgfA*wdezLJ1oOr2rRn~8P*1}V`Xf%#uF#j3jM6Mocj;IG&s-#F2$ zr(}-QjaG}-XL^f?RmH(m8^?or*xRGLp--`I9EYo9cAm*xWpDt;uvY-ypN zIgTS-tac;maFR40+wz2g*ZNYb2|Dt5Y@a6VhRrgU73i@ta%`+!@EIM>A{&`QNR=kY zgrPh7&3D1O3H}AmN+v=7vdfo~V`A%kEe>*o(FXVNIwu@1Uy!O7FG8_o6F__Ln>l<@ zrItd6TjjonHGh*7;*g~lhu12nW$K|C?fl`$Nzjm&y<2A3>$e5|RS7r1W&A?w`I zx?PGOCkuk(MljsCn+U01AjHISl=HNc1q6Z#N|wM>$xmqoMt7K{5R*E!nh-G;{wO zx%oeI$^Qi&{67H8|L4b9YoxzZ&ByKg5HuiUpGR%*3U1`m@wqTY$Lul9oZLG~bt7lA*ErlpQSA zOE{w|gCUv1Z|Oa}ppr4yGg9mMSYjRv(xdP7sPV-wx}tFG(~ zD;TzuDgq|j-Hb!N*Afb`s50w3$|_4xBIRJ8?jtGO&jH(_B*46CmtTL(0+(>XoGt0Y zv7@OJnW^<8RSK1vEDi=BlXdL|*)DgH;@G_%ny9hZUgn$?uFY1{EUca=oO+wvPpG5m zY@PS?-C{&MtVN1isVNDQP&BxWsFA=6^qng8b@S@uOwJ&>YCT&HKwkw{l{%T>Ai(b7 zDG`UqQ=Ddk-lk~3(xkyCYEkKY^a;PwoTx8PJW;b-LJ^ki*pNm4n%e(nwVaqCK&H`t z@AXCZVa2uI5^I=Pl&#j!h=Dv^@`hEvuwQmBlA8+q+M%V5ZJNbAL0G?7$8!O_;nM^C zG>txR&sp-We1yJcYS;2svQ2|mQ@3orRJ#m8o7AqT$W07G>HBC5w?3jeI zS5aFMJicIj4_MCB89x4mT&5wSj#BL6v!8?+K{}r}B5uCBfU8pNh*|kA{P9dSc;zg@ zq*DxkW#4Ch{OXS=Y(W-OYJM>*+%eZP{Nq-tm^@#ro@zOT?Kmc7BV6qu9X;Mvx%y3@ z(k@L8NF_x#{(8Yqm}#Aq@J6)@8-d1fwcgmA!ut|8og6j)qJ-p4(rKq^Nt3bJ*iLV1 zBz<75`y9Nn)Pb`>^QkRKFD@=P?HIfE5_szfvP<98x_{5w@M>FHvNx>c{uz{O;)M(n zZm#|?JqyJ^R;*-;uuGm&*?+>dMc;>{@Wvf0KnfFHre0rl?b<-E%$8cKd0nSfZy9_C zw2`&;kwjdZ1h8Vk;9)ke*l?>(sl~X&p`4;eg+xk3Q_Hbkw;Odg6=SLJz5ODqKyB9Q z(Wpu>U5b9Pi{V!i^VjO$QP;gW2+nGA+{q)2@TUq zY^qpX-wfc)?LiVdHaV)#GgABmh)`g$Nq0sNw~#YRbe)P3@s$bfVwkZZSamjb;1^vZ z7L7RwH~6cl;xuR%A2lD5`i=mV7x@XjbuV?_d{G6wBHc#cIMO;ycnp+!)I?5+k0B0^ z0Rwl5opGZ5FmIeUcaG;oT1418UZ2K_F(Yk-9{;3}S%lOI(VnBua8mhc&=(hJT0~|H zuES&D-#9s8t(9%#QO^m4XDLC)V62>aI9?nyES;l^nY0j$oN@#e7$hFj`4jwbH105FeM!*btGj zt+6QS(y+WP7C@z4Q~Q-R=KJczDt4h9DC)rso0+ zzWLc=o&04;3I&RzGM3KXyYpC=k5(d`dSy@Xt+(Dy2h;?EJ|EiM{5+^Gc4+#k+DNVT zG;|^7+i4EgXJfy?2nJ5vsaaH=`CTPzW$d-ZIGGg^tQH$@%(JLGNPJF}op6pvC#Xw- z99`({J5e*f0?JLlyD!24KblM_MaJYrqIYyWp+6G4$0)!j6QQ)qUdx%nB946yCFR4#TeA#6EeD4a!LP#P^ zpu%{DxO0;-%1Ya8WwBVzLRI%5)Zva@38hSheLpcO1U3)DiXK(2w ze&E}n0Hj-tQ6=bbCTvv9MUu}Dbe^}NtD(m(dCats~f22xA0*=Tf z&N1!OTP02E$jWpQAg^h42EYSxg!kzJUhM_M5_Um|3HIjDZrfy+C>S`RkWUz~j~#JH zeTvN@&Me<`kUB$;JTRmAwJNpoIQQmjLh^c{u!C-IZYaSwmOj}o6cbk-I2%=+*CM{=7tbtpM=orLkhkTC( z!r%mPW>~$~5WvjG&U~t~xj#3|#M)?APd#5iUihY%apDziRKYM?c6voS$hS?Si7CyS ziz?Yn9?{g@@$R4wRu9DFx_$Qs6*ivHlJ280%U+RV3j`B&neNlZfji*61lZ?(3bae? zhY&dv8H`%v>sK8LlK7{FMi>t}CGEMnN*CfRii$H@xO6ENh!G=c4qOl6qF*crnUmr# zH~tY@oJ+YRtd_S=O1_b#(gJ*Vq{7y$?j3S~crSp3GjSk1v-FHyo3p4o<2~ti1=Ads zWk*Hw)n5cBvUOaXGEz$6>__6`yKhO(XEs^tcV63JC|+`Zex>15y30qSrn<^?`M-^v z9kHzm@(-$r6Z(~fA)B$hGX>r(3}s^^So-pgs1L?lCkSHGSk6mDR>w_xe0Y=f6~tYz zdG0N$c%bq2@S85L>W3c44u=0oDB6skxgVCI2Z;;y)UUZ2m_Vg2Cfarv= z_gv=uX3-4gz2eSd`A~hr8Ig_F7@UpLZ`8;D1uKIuy;C+=6y~g?H1;O7Kn>*wppZJ& z#PEQUJszkht~#NU&aCxK_OGEwu+nm?a}Tv7R9M_EWvWSkh4jfPd9o&HZA+0Mtx+SC z?>}w{_lAPpGe!wNmw0)JI07^ehV&R-HeB2(NZ?~+s?3)#$yjG6&Acj)GuMImEBa2^!qig#jLS5e zhir+eZ$_WX{gW`W!9#LUrQ20OjHqsu8oYPJsfO7$o!-=3!}kW-V+B?EGO4?ehtRG% zdY-+gx>%h=3{~9W4;KZ}$auZ^cG$M-wrK_nZQ77Y8RB-7?#xpa^3w_pf`9RoQavIe zOFQ3IvrS4V#=GPauhHTc*$9z=85MZ~_lAtnEE(EpG=D-*EcZ=o-7ae~YBSDqnEkf2 zq8L@iuKb!%^^!G)FfrR9=NGW|*=N?3x4Tcr5B#)A?bomw;KQB&P-W`6vltm0Q zMrcRF$D&) z(%oem3B!zc{xASj!!fyt{54SLALT>d!FAp$0uI(VF?d;>w0@ubG!wIx_0IkFI^R$1 zs$hjAFya%R_;KDd>IviQbVUpP>0$f&ZYIS1wo_jp=<&IqLCHi#bQgNY{a#21-IDld z&azY!JZgasa!?8aM7R+|(6GS$j5XV%+6(4sJ_-+Ui%Y9Ld5u*Mh+%E_R?RyYa$|l= zrHAR!cs`d4KNR-BcN#jf2@JSl>Hc`=o9kiLHcZ^0f(1z>Swxf{)^HX%mIB2Ibi`rL zbOvDYyI10uFj;>2*^$@TyR7HstBs;)uU<6}aX8 z2LAbFzTmdB(PYPMmTD5C6!7;r`92M%XN|ohQUe~x`6@XI@_`%pX)WgOJg+1vLyfk+ zhE9reQFU6;TF=nx=>Snao4}|E2JVdop=n-LM5EjFpu&$hwcqR$9bVMiv!D5Z=>S7+ z_1PwP0_+ve7bkX%^rY}XvU>CT_D^chacXGJiL~Et8X;;9mP0{HkpEA4DwQlgZn6%!r2%%`r^iBPXr+jTS zSUcv0{GoZXrH@xPhxX@`kPu1OI--dxz-X z2z-ATA%#C>F`D09b2wR8!XOG8%Yw|uL>u>5#j+Lmu7DI$pz&WtlvSi2nhbZ*=6iz^ zeDCKGdlQUF(kV@uLchJtx2rW<3}%-W;s&R^lMV@C=BF?Gj5|t*lV&G#UQggckiVHr zZqE{C%q*$YHhd*Ma{uCzNo1i(cRCXoKi43~wIpL+zHXMSq_Ng$lG2ku@wWl(p~05o zRPMys=aZ8fCUBLr?u7H}$N(>?jtp z1z#%929rMT#R=O%A#*oMIO=z$&FwkVL&M@0}wEO&9CnTvNYl$KDy2P?bU4DEsgywxh97!lkQ zhw@#RabxO?6Ak(4a^KAt9fO1*i+U3mIYFJwvCKM0-(!8}zxAW6Bvg?2|cJEq1spy2p0P zzP8xYXva?eY7ycy(lrowUAT+GJcOCFiWie-_Nf|wh5kWcYNbhMAGkNg1NqpI!=~7l z8qP6`mr0TUdD_%18w*)a_n=lToT?sUCR7obB|pAfa_RI9oT83)a0e&eM}~;bP@KJy zTTtS3DJhpU+6nW%!!~_e=STmjF(iBJDOda+eD{94r5Q?Qj|+tCAEudM0p&#u)9+=Hf4Dt5+ezOu1>tI1j1XIgQmBqjK;6f{!+T3Q zDCd`joo9d5_C+}u);L~+=}H6}Uoxoetv2F@uecnUHNwYAss%&RiPGy~S=*qiuF`Yk zpi%Bji%r#`dHN^KONZzrd4RSkK&H#ye!?71g%o+7nJ;+d0d@iHRMzGu9G6XQoR$vC zmjsvIl1%`8ZW_@Ur0funzJ%&(LjrJn5Bpg9-!z7G7KVE5!|{;2h{nqy~ZRzNJ{U1{D?oiZJx?bY~>*hFVeNAE1uTeEuPbtd<)C zqMYICW~6gXIT7+w;c!K8Mcf?j+sv^P=3jqeodw0MpZCOiwcD;6^E)ruKspF@{w8!T zH-ez?JAQK6akV-3HYxFjEgp5{Y`l0k?=M;HvqnEDKfRBI&Tr4=dHyBK$S~2e7y%ru zeOKX}wX()$*x+pc)C(a^@oV6=>mc%Ngr40fdeSj@tMxw5L!i7A=_u4hnkO7@5x@20 z=fZeI)X?z#@=-nea?j(qkC_^NZecQIrf4#(+rOH;!2peTsYupH^Xdv%dQ;HC5ZuT-vjix)d+l6Z7|Qb&OZh$(Pg26-JGo>t?% z^joZak1ZwX4Qkrg6TRm7ARXBJX$JROT8{Pv2&YKzyUqk+pR|CeJ>xNvXkSl*1Nf9# zg2TS{@uKj$osAd`SyeZ?d7cu9ifnHFR62iW0@V7st&CHCmwz&kQ40gL!&>pzP*brH znSx50OH!AaWJ4dfH${tfM-t2nr_3k*1a~zYW*c>LPhYN5)ZTY-uQYFm5V>!XuI`-G zHvDDbkP#*dSvA|9sRt=cP#_7^MD7~PUvfjB1WV2f298bB1}V)iqM^%T*~Kbejbf%C zb6iU6GoeI?22TGhkB=O=yZN2qyc+dokO+kEDYj?ecuE<9LLpbRV^rC6O*6Aa?6ckjGaW6-oWah8= z%@R6}zmVmF;cz+ez}cw#`mb1PrD?BzDt$r{E$_w;B7qW?KtIzzYBo+$we+iJtn9_# zh^-d+G0OA`M|!&(36{|Pg5!tg;B591;|B5C&HuYW2)=pL2fDMy$)9TQ@ZCNPOCPSQ zJt98VuDZRgK=p{hl>JM?%h9THWya6(@DsR@ERKcxhDl%f8rHpG*%=4PyVSD+b00or zAYm!hLu90Hr5oL?01|n5o#^P!J{B9)5D*qEqDuocq#BQbwz9FFQBG3a;d6q%UD+*5 z{i%l;>#c%Ye0)(V=2L{uF>%0`6t$``Ybq^?^315R-PDbs!pBSz#E=P2=30I3#BTSS z?!{Lo(2YPE4LiC*yT1`B;-9e!7~S9s?rS^z#_PuHv&i4M-fVvIS#b++Ot@l3!|v=_ zWgm1l0f${ZTI_}f1I!)}Baf0nPtOq#`E zqo=aRe#B1d3cKdO3dYUmW{SenVfpd=xeCXV=oNIISI>*xt88H_im+AeG_o->ov)6+ z3gw5(w0tO4pJP` zTTXTQLcN*XqhJK73SI(9=mEzx^t;$cH^~+j zb&_;MOVuV1$mYxx>gutv=ewvTsACTv3l8h$XO<$-{$QJ5C`boHTG#h%H_@_BMNwAb zqdj}sw|MJj)+a859q?yzSTiht7acJ0-#>>+jL9B4B$IDD5f`0URj~g9+qd=_Yan22 z!r8Mjj$|sf0=HPC?T0+(>!)dFU~SVRtBw5~`cnH>oCvNP-E6$vrY6|huJMj;$b9>A zKRl2qzTmQ({Vrl6(vXC@5U>w=(}TAo8Qww+OCWT(Xzo&8-DDnBgM@e3UlGHd0$HEZ zMQ(3(bECu0@Vwc2UF{G?GKQnYw|&S1Cm9WXILt!)UVt}N^BHs0niF{0+#i!e5<^qa z?&SKJ=dq%;N}Qu|ETKBxq{{*?A})=C4JlR_<1us+VxTNuWJMa=j5Y4WpX!Jo?7c@V=>@`*i8+e=+Yr@% zA|FZ z<)5j8%Y<1$Hcmwm@sdPsR8);c}kmqGKS zyLtm4F(7rG6p~YP>kiwfRP)@Q7K{uT3WN5Za!#Xy@p`j6p`9GPJTNePpfOT$+ds0z z#8gQ=nLO8c6jV2!quhKsvS< zK@>*~abqe)AviTMW-4)WQ?LD#SMIT4bXQ;uuXrtIKa`u3J;KF?c;nK5 zuYllF9E>mj^{|hl$?xF>3Ek&+r*K(@vS*hh$O|Jda+5a?5op$7Z5!0b4{i_gjD~b; zA1t|QrjE$E=*~-x&8G=FMD=3uf!AMQUQ>?`DCaPbTbSlzCqmnZY0HIr9LfkigJM(! zR~1BAj=a>F4oaFJocWX=J=0#t`#AcexuU{<$&lQk4iuYRF5@}F4l@d>suVNziZ{uh zPbz!<`S8Jm?b?A;t?ue1gH<@4k*)>3W=lFKKfwI%OU^Q#a&q!Bx`nHG9PS5$U}bQ5 zE@;|OC85R$#)KK=P)4S1ayjbW>Y;uzP!1-?8n|Uk5Pkd?x7`O8jby`-)&GV>kR<@V(PwA)Y|*|_&pm#fo56!Q z3DXNV9|axy(r$3~$(%L(*cO%>puf(*=@`wjDv2de66{^@wJ)7jw)Q`9GSr(lS}YoY zcMp!Z4_!VfO>|u8OQ7i%&@`lOKJ-hoos5;z{#{|_-h7QXCxl-H%Ah1WOH9h{zvDI$ zi+3{A{E4P}b<)@HNs$fjs3-EX8Y3IB1{%E=(u6$uO9-Ah_66{|6a@?r%QcT&ioN?uc)XqI^nT?RW zQ2(#^LF%6l1fFnCAGhVlQ?+8Zbp}Uv1BR@b0I}KV3NyUOd0X8{4yKDgHRPyKc?5U4 z-ggS;y@w&Mp&f6oXTxSQ90!dmQAN0bAg#oSU2q?K1bZLQu8y~Vf8HkxEhX`E(8u}5 zoue5H*GR!?u%50<3;hd(TBkz?(kKO!4i4aVWanXXVREW=Ey;4$lWeSPgt8W}S`%V!U{ zN`oB!z6ls{$r=9WevKWWUkS6>I0(qWMZJqEJL6k1S}3lw$@)g9tr^gp|K-p}*?18gu+nvVW1epJV3MUlXqpQKn5-%}x`-WmZ~9&8zI_iX8(nc~ zY0BZjMfr*?es{REa1#%HV@3Zktjf+KyT)FffmvB+SzQoK`V8j-$H|<kj8El0g&T877+uMQfw7o|sFGl*w z*ov2W^+d!{BDj;0(k?p#E~pSfJ=vNy8xOCW52@{FbYb0MVLBPfu~oc~q*HlgV0#_u z3YYPw3BTwOD)8VwRRnXc7X481sIcX82n{cFS89qkVVPm>_En%O?k@Z%n^(loq+g%( zKjez)&ropIVhk@2J> zNE-9$@*RvM!iT|gBx+e-3b){fY=eUZHqt49TIe*uV1)1x?C2o41BKq8CXnU89avX6 zsBmd??Ay>xDoh!EKfZ#L<*2K(1#pIxMhZ0(Au>Y3IBcHW|5lwA`%;`<03GgpWOsX& zGZ^j6Vlv{qZd->i(~s8f!uJs)nq5TnXN~SFL<>#3J*nIaLAxasWG&)IfXn7>WTCV% zH6W<#B2XKM!m+>+~UCZBc6NqVCq6Z2%R76h1RUzV}E%{i2f0$vD&>LYMhq*mzoY7VGjUapcaWA>yxY2_HA-? zckGVJQM6_9rZ#O4Cs8a*`ye8O#^rh@)EjI>&;?vdHRVXGamr9tW59XK`Wa69o0}19 zd$z?^r%4EBFuvXQ@3gS)M+efm1<0d0>XSQOLH|q2%7qr8jaB~Mos7{U_d0x9Cnjp$ zMk=3^OXlv0NtLLT%1B=k=#NUJ|`Qo1z_1&yK-696LPcOVV&y7+k z1|Nl-pJ8Fo+7Q@ihDD;|mBGQfTHm`^3- zxu6%Lm7mA96RCFR+{_!E0o^NkBPg%suj@O_VQY(oAwokM)6_e>LEtaYSQjlqqq?Z) z#QBrNp={b2x;tb@qJCbM-o3qNos{8~PpHCgF%M(x<+`rZJBYHKisfH!r2>bg$7GD{ zeMrW#^}G+JN7R%q+-%P~&gQa)I^}*N4hWX8#NaG4;zfqY2hL*``4XBz48_uib*Rff z#mm@@J-YX?A9~4q3ov0hey8D)EUS<1s1h3wCL2bdJiV~WRB}T{A}X{Y%3KiA(?wfZ zkxG)=QGtEv@mU}r^IgdkJ?K^UoFEyJUs@;t_bqx}l;eJ-0rsxD{20m#VBN5biwL5f z5Wx7`W<;mW?x`8J);D9Rb->C5n$}=PcxE>Rc>&$0!1r|FaGTRg4x{9RZs_HAw74DL8Mi)dlk)CG*g>R0{!JqWFoZZYasvHJecX6XpdO`l-=0 zhnAj=HR)0irahs~41<`Q2Et-mcx~3~Or&P2?84w#N)mR*;L(#`N7&pEupj#)i04DF zF_%Kp_^L43Un85>&8uqmpx#Y&L2bJMc3~@QO7{35*sGdu{=`4OIpCU?2ID}2b0Mu9 zh5-7@3umSdmI=z!hDq@E04~cWW`dllYR=VvI|zM1X>=7(-YhsAtZHx};?qt$R=O4^ z7;O&V9NKiR;+(uajK@}Dqi9vOZB*}TDPlPBTW+y;XdGXLP3GgKR2!AABkPq_F5 zYI!e)Eb=$lu5!^Y3u)MSNtm&J6+V3#n4098frRX8|5eyKY^QV`;)`wxo2}BeKe3?C z!Jy&y?Ko8BB}az-59*qcaQeY9=LnSLIPb%8>4oU#5F$@hI;kx&i|XH{?Et&)fUQ-^ zY+zI&=`Bw@@5xK14;VA48+f=2FqTIIwwA&ipD5-p>4m|$iSWn|SV!RDrLe5tXHd;6 zPt-jnNyc(wrd-9Ic1qVmVzz+?JW0peyorDQe8AO{9zZ*;!JJ*k{WTktiRC5xzHW1g z40IB!k-wh`qjW*1jcM1EWcifevndThm-Yi9TkKYhY~^(rrC{B{JTJ31Eq`g>r=Y$* zz%2)-NB$3Ito%2fGa${g-uwUdt|ml|A_`Ym_22CD{Ov4BAY|S34-B3Xau7Y_ESn&~ z5hEJKC|(jGf_QT_pqKm~Rzen8$R?+e9D*nWmG!dmFQ{u00+Ns)b~n3|u)94o-P6-u z)#ca9f;-Oi%gHzaOz&+XGGSSwFO&L2mT9I5`$j;WF;s!93rm zhTfB3YqYjG<_f%swat3s?WV^hQI-x;D7?IF%Zob@9QG!Ti3J!)Ho#@49C+?Ha_OE= z_dhuk=W5oBGi1Sv$-a+mVNqx>dw7~iaK;SZ7$5T*oY!b1yXP?DU%0KD_zx7{vs)r)}|n9 z8g3UE@zDN#q5hLRy}gA`AvwktFO`a*d9(@3`Y%%`F&wyCzU6iG7paLp__Ha9ey#^0 zS=qk*aR*vdSAbyY6_f%o89M(lKpKdOlOi)o+qx#dZYf-^O@@J zr&>3)RC>WP^zRg}(%AZ3&c1%Kb-VTadkwPtg^wma6h74zmRuyoqJR~4J*fWfvk7vc zs$^gHwTPpec^dh6;Gdfl_4^n{HjksS>~B&!1!?F!(Kj3&f?{ECtM1JHAP#XNjBMI3 zciM+G3~&6?zPtP?L%nz-b+4zO(bcsrv9<@hSlh9LM>nyb86SKx!*%B{ZIBbHrqK|| z*)>B}bc console.log(`Connection status: ${status Here is an overview of the parameters passed to the `connect` function: -- `providerUrl` is a URL that points to a running Ethereum node -- `privateKey` is the private key of the wallet that will be performing transactions +* `providerUrl` is a URL that points to a running Ethereum node +* `privateKey` is the private key of the wallet that will be performing transactions + +**NOTE:** if using the SDK on a browser environment \(i.e. with MetaMask\), there is no need to supply the node URL nor the private key. -**NOTE:** if using the SDK on a browser environment (i.e. with MetaMask), there is no need to supply the node URL nor the private key. diff --git a/docs/api/SUMMARY.md b/docs/api/SUMMARY.md index 0b08c52..59f0995 100644 --- a/docs/api/SUMMARY.md +++ b/docs/api/SUMMARY.md @@ -1,466 +1,469 @@ +# Table of contents + +* [Introduction](README.md) * [Globals](globals.md) -* [External Modules]() - * [Context](modules/_context_.md) +* [External Modules](external-modules/README.md) + * [Context](external-modules/_context_.md) + * [Context](external-modules/_context_.context.md) + * [ConstructorParams](external-modules/_context_.constructorparams.md) + * [Factories](external-modules/_context_.factories.md) + * [Polymath](external-modules/_polymath_.md) + * [Polymath](external-modules/_polymath_.polymath.md) + * [AddressParams](external-modules/_polymath_.addressparams.md) + * [Connect](external-modules/_polymath_.connect.md) + * [ConnectParams](external-modules/_polymath_.connectparams.md) + * [GetSecurityToken](external-modules/_polymath_.getsecuritytoken.md) + * [PolymathNetworkNodeParams](external-modules/_polymath_.polymathnetworknodeparams.md) + * [PolymathNetworkParams](external-modules/_polymath_.polymathnetworkparams.md) + * [SymbolParams](external-modules/_polymath_.symbolparams.md) + * [PolymathBase](external-modules/_polymathbase_.md) + * [PolymathBase](external-modules/_polymathbase_.polymathbase.md) + * [BaseCheckpoint](external-modules/_polymathbase_.basecheckpoint.md) + * [BaseDividend](external-modules/_polymathbase_.basedividend.md) + * [GetAttachedModulesOpts](external-modules/_polymathbase_.getattachedmodulesopts.md) + * [GetAttachedModulesParams](external-modules/_polymathbase_.getattachedmodulesparams.md) + * [GetModuleAddressesByNameOpts](external-modules/_polymathbase_.getmoduleaddressesbynameopts.md) + * [GetModuleAddressesByNameParams](external-modules/_polymathbase_.getmoduleaddressesbynameparams.md) + * [GetModuleFactoryAddressArgs](external-modules/_polymathbase_.getmodulefactoryaddressargs.md) + * [PolymathError](external-modules/_polymatherror_.md) + * [PolymathError](external-modules/_polymatherror_.polymatherror.md) + * [PostTransactionResolver](external-modules/_posttransactionresolver_.md) + * [Wallet](external-modules/_wallet_.md) + * [Args](external-modules/_wallet_.args.md) + * [browserUtils](external-modules/_browserutils_.md) + * [BrowserSupport](external-modules/_browserutils_.browsersupport.md) + * [Ethereum](external-modules/_browserutils_.ethereum.md) + * [ExtendedWindow](external-modules/_browserutils_.extendedwindow.md) + * [InjectedWeb3](external-modules/_browserutils_.injectedweb3.md) + * [Web3VersionAPI](external-modules/_browserutils_.web3versionapi.md) + * [WindowWithEthereum](external-modules/_browserutils_.windowwithethereum.md) + * [WindowWithWeb3](external-modules/_browserutils_.windowwithweb3.md) + * [entities/Checkpoint](external-modules/_entities_checkpoint_.md) + * [Checkpoint](external-modules/_entities_checkpoint_.checkpoint.md) + * [Params](external-modules/_entities_checkpoint_.params.md) + * [UniqueIdentifiers](external-modules/_entities_checkpoint_.uniqueidentifiers.md) + * [entities/DividendDistribution](external-modules/_entities_dividenddistribution_.md) + * [DividendDistribution](external-modules/_entities_dividenddistribution_.dividenddistribution.md) + * [Params](external-modules/_entities_dividenddistribution_.params.md) + * [UniqueIdentifiers](external-modules/_entities_dividenddistribution_.uniqueidentifiers.md) + * [entities/Entity](external-modules/_entities_entity_.md) + * [Entity](external-modules/_entities_entity_.entity.md) + * [entities/Erc20TokenBalance](external-modules/_entities_erc20tokenbalance_.md) + * [Erc20TokenBalance](external-modules/_entities_erc20tokenbalance_.erc20tokenbalance.md) + * [Params](external-modules/_entities_erc20tokenbalance_.params.md) + * [UniqueIdentifiers](external-modules/_entities_erc20tokenbalance_.uniqueidentifiers.md) + * [entities/Investment](external-modules/_entities_investment_.md) + * [Investment](external-modules/_entities_investment_.investment.md) + * [Params](external-modules/_entities_investment_.params.md) + * [UniqueIdentifiers](external-modules/_entities_investment_.uniqueidentifiers.md) + * [entities/PolyTransaction](external-modules/_entities_polytransaction_.md) + * [Event](external-modules/_entities_polytransaction_.event.md) + * [PolyTransaction](external-modules/_entities_polytransaction_.polytransaction.md) + * [entities/SecurityToken/Controller](external-modules/_entities_securitytoken_controller_.md) + * [Controller](external-modules/_entities_securitytoken_controller_.controller.md) + * [entities/SecurityToken/Dividends](external-modules/_entities_securitytoken_dividends_.md) + * [Dividends](external-modules/_entities_securitytoken_dividends_.dividends.md) + * [GetDistributionParams](external-modules/_entities_securitytoken_dividends_.getdistributionparams.md) + * [entities/SecurityToken/Documents](external-modules/_entities_securitytoken_documents_.md) + * [Documents](external-modules/_entities_securitytoken_documents_.documents.md) + * [Document](external-modules/_entities_securitytoken_documents_.document.md) + * [entities/SecurityToken/Features](external-modules/_entities_securitytoken_features_.md) + * [Features](external-modules/_entities_securitytoken_features_.features.md) + * [Enable](external-modules/_entities_securitytoken_features_.enable.md) + * [EnableErc20DividendsOpts](external-modules/_entities_securitytoken_features_.enableerc20dividendsopts.md) + * [EnablePercentageOwnershipRestrictionsOpts](external-modules/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md) + * [EnableTokenholderCountRestrictionsOpts](external-modules/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) + * [FeatureStatuses](external-modules/_entities_securitytoken_features_.featurestatuses.md) + * [entities/SecurityToken/Issuance/Issuance](external-modules/_entities_securitytoken_issuance_issuance_.md) + * [Issuance](external-modules/_entities_securitytoken_issuance_issuance_.issuance.md) + * [entities/SecurityToken/Issuance/Offerings](external-modules/_entities_securitytoken_issuance_offerings_.md) + * [Offerings](external-modules/_entities_securitytoken_issuance_offerings_.offerings.md) + * [GetStoMethod](external-modules/_entities_securitytoken_issuance_offerings_.getstomethod.md) + * [GetStoParams](external-modules/_entities_securitytoken_issuance_offerings_.getstoparams.md) + * [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md) + * [LaunchTieredStoCustomCurrencyBothParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) + * [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md) + * [LaunchTieredStoCustomCurrencyEthParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) + * [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md) + * [LaunchTieredStoCustomCurrencyPolyParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) + * [LaunchTieredStoMethod](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md) + * [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md) + * [LaunchTieredStoNoCustomCurrencyParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md) + * [LaunchTieredStoParams](external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) + * [entities/SecurityToken/Issuance/index](external-modules/_entities_securitytoken_issuance_index_.md) + * [entities/SecurityToken/Permissions](external-modules/_entities_securitytoken_permissions_.md) + * [Permissions](external-modules/_entities_securitytoken_permissions_.permissions.md) + * [entities/SecurityToken/SecurityToken](external-modules/_entities_securitytoken_securitytoken_.md) + * [SecurityToken](external-modules/_entities_securitytoken_securitytoken_.securitytoken.md) + * [Params](external-modules/_entities_securitytoken_securitytoken_.params.md) + * [UniqueIdentifiers](external-modules/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) + * [entities/SecurityToken/SubModule](external-modules/_entities_securitytoken_submodule_.md) + * [SubModule](external-modules/_entities_securitytoken_submodule_.submodule.md) + * [entities/SecurityToken/Tokenholders](external-modules/_entities_securitytoken_tokenholders_.md) + * [Tokenholders](external-modules/_entities_securitytoken_tokenholders_.tokenholders.md) + * [GetCheckpointParams](external-modules/_entities_securitytoken_tokenholders_.getcheckpointparams.md) + * [entities/SecurityToken/Transfers/Restrictions/CountRestrictions](external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md) + * [CountRestrictions](external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + * [entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md) + * [PercentageRestrictions](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) + * [ModifyExemptionsMethod](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md) + * [PercentageIssuanceParams](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) + * [PercentageWhitelistParams](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) + * [entities/SecurityToken/Transfers/Restrictions/Restrictions](external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.md) + * [Restrictions](external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + * [entities/SecurityToken/Transfers/Restrictions/index](external-modules/_entities_securitytoken_transfers_restrictions_index_.md) + * [entities/SecurityToken/Transfers/Transfers](external-modules/_entities_securitytoken_transfers_transfers_.md) + * [Transfers](external-modules/_entities_securitytoken_transfers_transfers_.transfers.md) + * [entities/SecurityToken/Transfers/index](external-modules/_entities_securitytoken_transfers_index_.md) + * [entities/SecurityToken/index](external-modules/_entities_securitytoken_index_.md) + * [entities/SecurityTokenReservation](external-modules/_entities_securitytokenreservation_.md) + * [SecurityTokenReservation](external-modules/_entities_securitytokenreservation_.securitytokenreservation.md) + * [Params](external-modules/_entities_securitytokenreservation_.params.md) + * [UniqueIdentifiers](external-modules/_entities_securitytokenreservation_.uniqueidentifiers.md) + * [entities/SimpleSto](external-modules/_entities_simplesto_.md) + * [SimpleSto](external-modules/_entities_simplesto_.simplesto.md) + * [Params](external-modules/_entities_simplesto_.params.md) + * [entities/Sto](external-modules/_entities_sto_.md) + * [Sto](external-modules/_entities_sto_.sto.md) + * [Params](external-modules/_entities_sto_.params.md) + * [UniqueIdentifiers](external-modules/_entities_sto_.uniqueidentifiers.md) + * [entities/TaxWithholding](external-modules/_entities_taxwithholding_.md) + * [TaxWithholding](external-modules/_entities_taxwithholding_.taxwithholding.md) + * [Params](external-modules/_entities_taxwithholding_.params.md) + * [UniqueIdentifiers](external-modules/_entities_taxwithholding_.uniqueidentifiers.md) + * [entities/TieredSto](external-modules/_entities_tieredsto_.md) + * [TieredSto](external-modules/_entities_tieredsto_.tieredsto.md) + * [Params](external-modules/_entities_tieredsto_.params.md) + * [Tier](external-modules/_entities_tieredsto_.tier.md) + * [entities/Tokenholder](external-modules/_entities_tokenholder_.md) + * [Tokenholder](external-modules/_entities_tokenholder_.tokenholder.md) + * [Params](external-modules/_entities_tokenholder_.params.md) + * [UniqueIdentifiers](external-modules/_entities_tokenholder_.uniqueidentifiers.md) + * [entities/TransactionQueue](external-modules/_entities_transactionqueue_.md) + * [Events](external-modules/_entities_transactionqueue_.events.md) + * [TransactionQueue](external-modules/_entities_transactionqueue_.transactionqueue.md) + * [entities/Wallet](external-modules/_entities_wallet_.md) + * [Wallet](external-modules/_entities_wallet_.wallet.md) + * [Params](external-modules/_entities_wallet_.params.md) + * [UniqueIdentifiers](external-modules/_entities_wallet_.uniqueidentifiers.md) + * [entities/factories/CheckpointFactory](external-modules/_entities_factories_checkpointfactory_.md) + * [entities/factories/DividendDistributionFactory](external-modules/_entities_factories_dividenddistributionfactory_.md) + * [entities/factories/Erc20TokenBalanceFactory](external-modules/_entities_factories_erc20tokenbalancefactory_.md) + * [Erc20TokenBalanceFactory](external-modules/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + * [entities/factories/Factory](external-modules/_entities_factories_factory_.md) + * [Factory](external-modules/_entities_factories_factory_.factory.md) + * [EntityClass](external-modules/_entities_factories_factory_.entityclass.md) + * [entities/factories/InvestmentFactory](external-modules/_entities_factories_investmentfactory_.md) + * [InvestmentFactory](external-modules/_entities_factories_investmentfactory_.investmentfactory.md) + * [entities/factories/SecurityTokenFactory](external-modules/_entities_factories_securitytokenfactory_.md) + * [entities/factories/SecurityTokenReservationFactory](external-modules/_entities_factories_securitytokenreservationfactory_.md) + * [entities/factories/SimpleStoFactory](external-modules/_entities_factories_simplestofactory_.md) + * [SimpleStoFactory](external-modules/_entities_factories_simplestofactory_.simplestofactory.md) + * [entities/factories/TaxWithholdingFactory](external-modules/_entities_factories_taxwithholdingfactory_.md) + * [TaxWithholdingFactory](external-modules/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + * [entities/factories/TieredStoFactory](external-modules/_entities_factories_tieredstofactory_.md) + * [TieredStoFactory](external-modules/_entities_factories_tieredstofactory_.tieredstofactory.md) + * [entities/factories/TokenholderFactory](external-modules/_entities_factories_tokenholderfactory_.md) + * [TokenholderFactory](external-modules/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + * [entities/factories/WalletFactory](external-modules/_entities_factories_walletfactory_.md) + * [WalletFactory](external-modules/_entities_factories_walletfactory_.walletfactory.md) + * [entities/factories/index](external-modules/_entities_factories_index_.md) + * [entities/index](external-modules/_entities_index_.md) + * [index](external-modules/_index_.md) + * [procedures/ApproveErc20](external-modules/_procedures_approveerc20_.md) + * [ApproveErc20](external-modules/_procedures_approveerc20_.approveerc20.md) + * [procedures/AssignSecurityTokenRole](external-modules/_procedures_assignsecuritytokenrole_.md) + * [AssignSecurityTokenRole](external-modules/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) + * [procedures/AssignStoRole](external-modules/_procedures_assignstorole_.md) + * [AssignStoRole](external-modules/_procedures_assignstorole_.assignstorole.md) + * [procedures/ControllerRedeem](external-modules/_procedures_controllerredeem_.md) + * [ControllerRedeem](external-modules/_procedures_controllerredeem_.controllerredeem.md) + * [procedures/ControllerTransfer](external-modules/_procedures_controllertransfer_.md) + * [ControllerTransfer](external-modules/_procedures_controllertransfer_.controllertransfer.md) + * [procedures/CreateCheckpoint](external-modules/_procedures_createcheckpoint_.md) + * [CreateCheckpoint](external-modules/_procedures_createcheckpoint_.createcheckpoint.md) + * [procedures/CreateDividendDistribution](external-modules/_procedures_createdividenddistribution_.md) + * [CreateDividendDistribution](external-modules/_procedures_createdividenddistribution_.createdividenddistribution.md) + * [procedures/CreateSecurityToken](external-modules/_procedures_createsecuritytoken_.md) + * [CreateSecurityToken](external-modules/_procedures_createsecuritytoken_.createsecuritytoken.md) + * [procedures/DisableController](external-modules/_procedures_disablecontroller_.md) + * [DisableController](external-modules/_procedures_disablecontroller_.disablecontroller.md) + * [procedures/DisableFeature](external-modules/_procedures_disablefeature_.md) + * [DisableFeature](external-modules/_procedures_disablefeature_.disablefeature.md) + * [procedures/EnableCountTransferManager](external-modules/_procedures_enablecounttransfermanager_.md) + * [EnableCountTransferManager](external-modules/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) + * [procedures/EnableDividendManager](external-modules/_procedures_enabledividendmanager_.md) + * [EnableDividendManager](external-modules/_procedures_enabledividendmanager_.enabledividendmanager.md) + * [procedures/EnableGeneralPermissionManager](external-modules/_procedures_enablegeneralpermissionmanager_.md) + * [EnableGeneralPermissionManager](external-modules/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) + * [procedures/EnableGeneralTransferManager](external-modules/_procedures_enablegeneraltransfermanager_.md) + * [EnableGeneralTransferManager](external-modules/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) + * [procedures/EnablePercentageTransferManager](external-modules/_procedures_enablepercentagetransfermanager_.md) + * [EnablePercentageTransferManager](external-modules/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) + * [procedures/FinalizeSto](external-modules/_procedures_finalizesto_.md) + * [FinalizeSto](external-modules/_procedures_finalizesto_.finalizesto.md) + * [procedures/FreezeIssuance](external-modules/_procedures_freezeissuance_.md) + * [FreezeIssuance](external-modules/_procedures_freezeissuance_.freezeissuance.md) + * [procedures/InvestInSimpleSto](external-modules/_procedures_investinsimplesto_.md) + * [InvestInSimpleSto](external-modules/_procedures_investinsimplesto_.investinsimplesto.md) + * [procedures/InvestInTieredSto](external-modules/_procedures_investintieredsto_.md) + * [InvestInTieredSto](external-modules/_procedures_investintieredsto_.investintieredsto.md) + * [procedures/IssueTokens](external-modules/_procedures_issuetokens_.md) + * [IssueTokens](external-modules/_procedures_issuetokens_.issuetokens.md) + * [procedures/LaunchSimpleSto](external-modules/_procedures_launchsimplesto_.md) + * [LaunchSimpleSto](external-modules/_procedures_launchsimplesto_.launchsimplesto.md) + * [procedures/LaunchTieredSto](external-modules/_procedures_launchtieredsto_.md) + * [LaunchTieredSto](external-modules/_procedures_launchtieredsto_.launchtieredsto.md) + * [procedures/ModifyDividendsDefaultExclusionList](external-modules/_procedures_modifydividendsdefaultexclusionlist_.md) + * [ModifyDividendsDefaultExclusionList](external-modules/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) + * [procedures/ModifyMaxHolderCount](external-modules/_procedures_modifymaxholdercount_.md) + * [ModifyMaxHolderCount](external-modules/_procedures_modifymaxholdercount_.modifymaxholdercount.md) + * [procedures/ModifyMaxHolderPercentage](external-modules/_procedures_modifymaxholderpercentage_.md) + * [ModifyMaxHolderPercentage](external-modules/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) + * [procedures/ModifyPercentageExemptions](external-modules/_procedures_modifypercentageexemptions_.md) + * [ModifyPercentageExemptions](external-modules/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) + * [procedures/ModifyTieredStoData](external-modules/_procedures_modifytieredstodata_.md) + * [ModifyTieredStoData](external-modules/_procedures_modifytieredstodata_.modifytieredstodata.md) + * [procedures/ModifyTokenholderData](external-modules/_procedures_modifytokenholderdata_.md) + * [ModifyTokenholderData](external-modules/_procedures_modifytokenholderdata_.modifytokenholderdata.md) + * [procedures/Procedure](external-modules/_procedures_procedure_.md) + * [ProcedureClass](external-modules/_procedures_procedure_.procedureclass.md) + * [procedures/PullDividendPayment](external-modules/_procedures_pulldividendpayment_.md) + * [PullDividendPayment](external-modules/_procedures_pulldividendpayment_.pulldividendpayment.md) + * [procedures/PushDividendPayment](external-modules/_procedures_pushdividendpayment_.md) + * [PushDividendPayment](external-modules/_procedures_pushdividendpayment_.pushdividendpayment.md) + * [procedures/ReclaimFunds](external-modules/_procedures_reclaimfunds_.md) + * [ReclaimFunds](external-modules/_procedures_reclaimfunds_.reclaimfunds.md) + * [procedures/RemoveDocument](external-modules/_procedures_removedocument_.md) + * [RemoveDocument](external-modules/_procedures_removedocument_.removedocument.md) + * [procedures/ReserveSecurityToken](external-modules/_procedures_reservesecuritytoken_.md) + * [ReserveSecurityToken](external-modules/_procedures_reservesecuritytoken_.reservesecuritytoken.md) + * [procedures/RevokeKyc](external-modules/_procedures_revokekyc_.md) + * [RevokeKyc](external-modules/_procedures_revokekyc_.revokekyc.md) + * [procedures/SetController](external-modules/_procedures_setcontroller_.md) + * [SetController](external-modules/_procedures_setcontroller_.setcontroller.md) + * [procedures/SetDividendsWallet](external-modules/_procedures_setdividendswallet_.md) + * [SetDividendsWallet](external-modules/_procedures_setdividendswallet_.setdividendswallet.md) + * [procedures/SetDocument](external-modules/_procedures_setdocument_.md) + * [SetDocument](external-modules/_procedures_setdocument_.setdocument.md) + * [procedures/SignDisableControllerAck](external-modules/_procedures_signdisablecontrollerack_.md) + * [SignDisableControllerAck](external-modules/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) + * [procedures/SignFreezeIssuanceAck](external-modules/_procedures_signfreezeissuanceack_.md) + * [SignFreezeIssuanceAck](external-modules/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) + * [procedures/SignTransferData](external-modules/_procedures_signtransferdata_.md) + * [SignTransferData](external-modules/_procedures_signtransferdata_.signtransferdata.md) + * [procedures/ToggleAllowBeneficialInvestments](external-modules/_procedures_toggleallowbeneficialinvestments_.md) + * [ToggleAllowBeneficialInvestments](external-modules/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) + * [procedures/ToggleAllowPreIssuing](external-modules/_procedures_toggleallowpreissuing_.md) + * [ToggleAllowPreIssuing](external-modules/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) + * [procedures/ToggleFreezeTransfers](external-modules/_procedures_togglefreezetransfers_.md) + * [ToggleFreezeTransfers](external-modules/_procedures_togglefreezetransfers_.togglefreezetransfers.md) + * [procedures/TogglePauseSto](external-modules/_procedures_togglepausesto_.md) + * [TogglePauseSto](external-modules/_procedures_togglepausesto_.togglepausesto.md) + * [procedures/TransferErc20](external-modules/_procedures_transfererc20_.md) + * [TransferErc20](external-modules/_procedures_transfererc20_.transfererc20.md) + * [procedures/TransferOwnership](external-modules/_procedures_transferownership_.md) + * [TransferOwnership](external-modules/_procedures_transferownership_.transferownership.md) + * [procedures/TransferReservationOwnership](external-modules/_procedures_transferreservationownership_.md) + * [TransferReservationOwnership](external-modules/_procedures_transferreservationownership_.transferreservationownership.md) + * [procedures/TransferSecurityTokens](external-modules/_procedures_transfersecuritytokens_.md) + * [TransferSecurityTokens](external-modules/_procedures_transfersecuritytokens_.transfersecuritytokens.md) + * [procedures/UpdateDividendsTaxWithholdingList](external-modules/_procedures_updatedividendstaxwithholdinglist_.md) + * [UpdateDividendsTaxWithholdingList](external-modules/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) + * [procedures/WithdrawTaxes](external-modules/_procedures_withdrawtaxes_.md) + * [WithdrawTaxes](external-modules/_procedures_withdrawtaxes_.withdrawtaxes.md) + * [procedures/index](external-modules/_procedures_index_.md) + * [types/index](external-modules/_types_index_.md) + * [ErrorCode](external-modules/_types_index_.errorcode.md) + * [Feature](external-modules/_types_index_.feature.md) + * [PolyTransactionTag](external-modules/_types_index_.polytransactiontag.md) + * [ProcedureType](external-modules/_types_index_.proceduretype.md) + * [SecurityTokenRole](external-modules/_types_index_.securitytokenrole.md) + * [StoRole](external-modules/_types_index_.storole.md) + * [StoType](external-modules/_types_index_.stotype.md) + * [TransactionSpeed](external-modules/_types_index_.transactionspeed.md) + * [TransactionStatus](external-modules/_types_index_.transactionstatus.md) + * [TransferStatusCode](external-modules/_types_index_.transferstatuscode.md) + * [ApproveErc20ProcedureArgs](external-modules/_types_index_.approveerc20procedureargs.md) + * [AssignSecurityTokenRoleProcedureArgs](external-modules/_types_index_.assignsecuritytokenroleprocedureargs.md) + * [AssignStoRoleProcedureArgs](external-modules/_types_index_.assignstoroleprocedureargs.md) + * [ControllerRedeemProcedureArgs](external-modules/_types_index_.controllerredeemprocedureargs.md) + * [ControllerTransferProcedureArgs](external-modules/_types_index_.controllertransferprocedureargs.md) + * [CreateCheckpointProcedureArgs](external-modules/_types_index_.createcheckpointprocedureargs.md) + * [CreateDividendDistributionProcedureArgs](external-modules/_types_index_.createdividenddistributionprocedureargs.md) + * [CreateSecurityTokenProcedureArgs](external-modules/_types_index_.createsecuritytokenprocedureargs.md) + * [CustomCurrency](external-modules/_types_index_.customcurrency.md) + * [DisableControllerProcedureArgs](external-modules/_types_index_.disablecontrollerprocedureargs.md) + * [DisableFeatureProcedureArgs](external-modules/_types_index_.disablefeatureprocedureargs.md) + * [DividendTokenholderStatus](external-modules/_types_index_.dividendtokenholderstatus.md) + * [EnableCountTransferManagerProcedureArgs](external-modules/_types_index_.enablecounttransfermanagerprocedureargs.md) + * [EnableDividendManagerProcedureArgs](external-modules/_types_index_.enabledividendmanagerprocedureargs.md) + * [EnableGeneralPermissionManagerProcedureArgs](external-modules/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) + * [EnableGeneralTransferManagerProcedureArgs](external-modules/_types_index_.enablegeneraltransfermanagerprocedureargs.md) + * [EnablePercentageTransferManagerProcedureArgs](external-modules/_types_index_.enablepercentagetransfermanagerprocedureargs.md) + * [Fees](external-modules/_types_index_.fees.md) + * [FinalizeStoProcedureArgs](external-modules/_types_index_.finalizestoprocedureargs.md) + * [FreezeIssuanceProcedureArgs](external-modules/_types_index_.freezeissuanceprocedureargs.md) + * [FutureLowLevelMethod](external-modules/_types_index_.futurelowlevelmethod.md) + * [InvestInSimpleStoProcedureArgs](external-modules/_types_index_.investinsimplestoprocedureargs.md) + * [InvestInTieredStoBaseProcedureArgs](external-modules/_types_index_.investintieredstobaseprocedureargs.md) + * [InvestWithStableCoinArgs](external-modules/_types_index_.investwithstablecoinargs.md) + * [IssuanceDataEntry](external-modules/_types_index_.issuancedataentry.md) + * [IssueTokensProcedureArgs](external-modules/_types_index_.issuetokensprocedureargs.md) + * [LaunchSimpleStoProcedureArgs](external-modules/_types_index_.launchsimplestoprocedureargs.md) + * [LaunchTieredStoProcedureArgs](external-modules/_types_index_.launchtieredstoprocedureargs.md) + * [ModifyDividendsDefaultExclusionListProcedureArgs](external-modules/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) + * [ModifyMaxHolderCountProcedureArgs](external-modules/_types_index_.modifymaxholdercountprocedureargs.md) + * [ModifyMaxHolderPercentageProcedureArgs](external-modules/_types_index_.modifymaxholderpercentageprocedureargs.md) + * [ModifyPercentageExemptionsProcedureArgs](external-modules/_types_index_.modifypercentageexemptionsprocedureargs.md) + * [ModifyTieredStoDataProcedureArgs](external-modules/_types_index_.modifytieredstodataprocedureargs.md) + * [ModifyTokenholderDataProcedureArgs](external-modules/_types_index_.modifytokenholderdataprocedureargs.md) + * [PercentageWhitelistEntry](external-modules/_types_index_.percentagewhitelistentry.md) + * [Pojo](external-modules/_types_index_.pojo.md) + * [PullDividendPaymentProcedureArgs](external-modules/_types_index_.pulldividendpaymentprocedureargs.md) + * [PushDividendPaymentProcedureArgs](external-modules/_types_index_.pushdividendpaymentprocedureargs.md) + * [ReclaimFundsProcedureArgs](external-modules/_types_index_.reclaimfundsprocedureargs.md) + * [RemoveDocumentProcedureArgs](external-modules/_types_index_.removedocumentprocedureargs.md) + * [ReserveSecurityTokenProcedureArgs](external-modules/_types_index_.reservesecuritytokenprocedureargs.md) + * [RevokeKycProcedureArgs](external-modules/_types_index_.revokekycprocedureargs.md) + * [SetControllerProcedureArgs](external-modules/_types_index_.setcontrollerprocedureargs.md) + * [SetDividendsWalletProcedureArgs](external-modules/_types_index_.setdividendswalletprocedureargs.md) + * [SetDocumentProcedureArgs](external-modules/_types_index_.setdocumentprocedureargs.md) + * [SignDisableControllerAckProcedureArgs](external-modules/_types_index_.signdisablecontrollerackprocedureargs.md) + * [SignFreezeIssuanceAckProcedureArgs](external-modules/_types_index_.signfreezeissuanceackprocedureargs.md) + * [SignTransferDataProcedureArgs](external-modules/_types_index_.signtransferdataprocedureargs.md) + * [StoTier](external-modules/_types_index_.stotier.md) + * [TaxWithholdingEntry](external-modules/_types_index_.taxwithholdingentry.md) + * [ToggleAllowBeneficialInvestmentsProcedureArgs](external-modules/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) + * [ToggleAllowPreIssuingProcedureArgs](external-modules/_types_index_.toggleallowpreissuingprocedureargs.md) + * [ToggleFreezeTransfersProcedureArgs](external-modules/_types_index_.togglefreezetransfersprocedureargs.md) + * [TogglePauseStoProcedureArgs](external-modules/_types_index_.togglepausestoprocedureargs.md) + * [TokenholderBalance](external-modules/_types_index_.tokenholderbalance.md) + * [TokenholderDataEntry](external-modules/_types_index_.tokenholderdataentry.md) + * [TransactionSpec](external-modules/_types_index_.transactionspec.md) + * [TransferErc20ProcedureArgs](external-modules/_types_index_.transfererc20procedureargs.md) + * [TransferOwnershipProcedureArgs](external-modules/_types_index_.transferownershipprocedureargs.md) + * [TransferReservationOwnershipProcedureArgs](external-modules/_types_index_.transferreservationownershipprocedureargs.md) + * [TransferSecurityTokensProcedureArgs](external-modules/_types_index_.transfersecuritytokensprocedureargs.md) + * [UpdateDividendsTaxWithholdingListProcedureArgs](external-modules/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) + * [WithdrawTaxesProcedureArgs](external-modules/_types_index_.withdrawtaxesprocedureargs.md) + * [utils/constants](external-modules/_utils_constants_.md) + * [utils/index](external-modules/_utils_index_.md) + * [FindCappedStoPauseParams](external-modules/_utils_index_.findcappedstopauseparams.md) + * [FindCappedStoPreMintAllowedParams](external-modules/_utils_index_.findcappedstopremintallowedparams.md) + * [FindCheckpointCreatedParams](external-modules/_utils_index_.findcheckpointcreatedparams.md) + * [FindControllerTransferParams](external-modules/_utils_index_.findcontrollertransferparams.md) + * [FindErc20DividendClaimedParams](external-modules/_utils_index_.finderc20dividendclaimedparams.md) + * [FindErc20DividendDepositedParams](external-modules/_utils_index_.finderc20dividenddepositedparams.md) + * [FindErc20DividendReclaimedParams](external-modules/_utils_index_.finderc20dividendreclaimedparams.md) + * [FindErc20SetWalletParams](external-modules/_utils_index_.finderc20setwalletparams.md) + * [FindErc20SetWithholdingParams](external-modules/_utils_index_.finderc20setwithholdingparams.md) + * [FindEthDividendClaimedParams](external-modules/_utils_index_.findethdividendclaimedparams.md) + * [FindEthDividendReclaimedParams](external-modules/_utils_index_.findethdividendreclaimedparams.md) + * [FindEthSetWalletParams](external-modules/_utils_index_.findethsetwalletparams.md) + * [FindEthSetWithholdingParams](external-modules/_utils_index_.findethsetwithholdingparams.md) + * [FindEtherDividendDepositedParams](external-modules/_utils_index_.findetherdividenddepositedparams.md) + * [FindEventParams](external-modules/_utils_index_.findeventparams.md) + * [FindEvents](external-modules/_utils_index_.findevents.md) + * [FindModifyInvestorFlagParams](external-modules/_utils_index_.findmodifyinvestorflagparams.md) + * [FindModifyKycDataParams](external-modules/_utils_index_.findmodifykycdataparams.md) + * [FindModuleAddedParams](external-modules/_utils_index_.findmoduleaddedparams.md) + * [FindNewSecurityTokenParams](external-modules/_utils_index_.findnewsecuritytokenparams.md) + * [FindTickerRegisteredParams](external-modules/_utils_index_.findtickerregisteredparams.md) + * [FindTieredStoPauseParams](external-modules/_utils_index_.findtieredstopauseparams.md) + * [FindTieredStoPreMintAllowedParams](external-modules/_utils_index_.findtieredstopremintallowedparams.md) +* [Classes](classes/README.md) * [Context](classes/_context_.context.md) - * [ConstructorParams](interfaces/_context_.constructorparams.md) - * [Factories](interfaces/_context_.factories.md) - * [Polymath](modules/_polymath_.md) * [Polymath](classes/_polymath_.polymath.md) - * [AddressParams](interfaces/_polymath_.addressparams.md) - * [Connect](interfaces/_polymath_.connect.md) - * [ConnectParams](interfaces/_polymath_.connectparams.md) - * [GetSecurityToken](interfaces/_polymath_.getsecuritytoken.md) - * [PolymathNetworkNodeParams](interfaces/_polymath_.polymathnetworknodeparams.md) - * [PolymathNetworkParams](interfaces/_polymath_.polymathnetworkparams.md) - * [SymbolParams](interfaces/_polymath_.symbolparams.md) - * [PolymathBase](modules/_polymathbase_.md) * [PolymathBase](classes/_polymathbase_.polymathbase.md) - * [BaseCheckpoint](interfaces/_polymathbase_.basecheckpoint.md) - * [BaseDividend](interfaces/_polymathbase_.basedividend.md) - * [GetAttachedModulesOpts](interfaces/_polymathbase_.getattachedmodulesopts.md) - * [GetAttachedModulesParams](interfaces/_polymathbase_.getattachedmodulesparams.md) - * [GetModuleAddressesByNameOpts](interfaces/_polymathbase_.getmoduleaddressesbynameopts.md) - * [GetModuleAddressesByNameParams](interfaces/_polymathbase_.getmoduleaddressesbynameparams.md) - * [GetModuleFactoryAddressArgs](interfaces/_polymathbase_.getmodulefactoryaddressargs.md) - * [PolymathError](modules/_polymatherror_.md) * [PolymathError](classes/_polymatherror_.polymatherror.md) - * [PostTransactionResolver](modules/_posttransactionresolver_.md) - * [Wallet](modules/_wallet_.md) - * [Args](interfaces/_wallet_.args.md) - * [browserUtils](modules/_browserutils_.md) - * [BrowserSupport](enums/_browserutils_.browsersupport.md) - * [Ethereum](interfaces/_browserutils_.ethereum.md) - * [ExtendedWindow](interfaces/_browserutils_.extendedwindow.md) - * [InjectedWeb3](interfaces/_browserutils_.injectedweb3.md) - * [Web3VersionAPI](interfaces/_browserutils_.web3versionapi.md) - * [WindowWithEthereum](interfaces/_browserutils_.windowwithethereum.md) - * [WindowWithWeb3](interfaces/_browserutils_.windowwithweb3.md) - * [entities/Checkpoint](modules/_entities_checkpoint_.md) * [Checkpoint](classes/_entities_checkpoint_.checkpoint.md) - * [Params](interfaces/_entities_checkpoint_.params.md) - * [UniqueIdentifiers](interfaces/_entities_checkpoint_.uniqueidentifiers.md) - * [entities/DividendDistribution](modules/_entities_dividenddistribution_.md) * [DividendDistribution](classes/_entities_dividenddistribution_.dividenddistribution.md) - * [Params](interfaces/_entities_dividenddistribution_.params.md) - * [UniqueIdentifiers](interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) - * [entities/Entity](modules/_entities_entity_.md) * [Entity](classes/_entities_entity_.entity.md) - * [entities/Erc20TokenBalance](modules/_entities_erc20tokenbalance_.md) * [Erc20TokenBalance](classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) - * [Params](interfaces/_entities_erc20tokenbalance_.params.md) - * [UniqueIdentifiers](interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) - * [entities/Investment](modules/_entities_investment_.md) * [Investment](classes/_entities_investment_.investment.md) - * [Params](interfaces/_entities_investment_.params.md) - * [UniqueIdentifiers](interfaces/_entities_investment_.uniqueidentifiers.md) - * [entities/PolyTransaction](modules/_entities_polytransaction_.md) - * [Event](enums/_entities_polytransaction_.event.md) * [PolyTransaction](classes/_entities_polytransaction_.polytransaction.md) - * [entities/SecurityToken/Controller](modules/_entities_securitytoken_controller_.md) * [Controller](classes/_entities_securitytoken_controller_.controller.md) - * [entities/SecurityToken/Dividends](modules/_entities_securitytoken_dividends_.md) * [Dividends](classes/_entities_securitytoken_dividends_.dividends.md) - * [GetDistributionParams](interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) - * [entities/SecurityToken/Documents](modules/_entities_securitytoken_documents_.md) * [Documents](classes/_entities_securitytoken_documents_.documents.md) - * [Document](interfaces/_entities_securitytoken_documents_.document.md) - * [entities/SecurityToken/Features](modules/_entities_securitytoken_features_.md) * [Features](classes/_entities_securitytoken_features_.features.md) - * [Enable](interfaces/_entities_securitytoken_features_.enable.md) - * [EnableErc20DividendsOpts](interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md) - * [EnablePercentageOwnershipRestrictionsOpts](interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md) - * [EnableTokenholderCountRestrictionsOpts](interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) - * [FeatureStatuses](interfaces/_entities_securitytoken_features_.featurestatuses.md) - * [entities/SecurityToken/Issuance/Issuance](modules/_entities_securitytoken_issuance_issuance_.md) * [Issuance](classes/_entities_securitytoken_issuance_issuance_.issuance.md) - * [entities/SecurityToken/Issuance/Offerings](modules/_entities_securitytoken_issuance_offerings_.md) * [Offerings](classes/_entities_securitytoken_issuance_offerings_.offerings.md) - * [GetStoMethod](interfaces/_entities_securitytoken_issuance_offerings_.getstomethod.md) - * [GetStoParams](interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) - * [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md) - * [LaunchTieredStoCustomCurrencyBothParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) - * [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md) - * [LaunchTieredStoCustomCurrencyEthParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) - * [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md) - * [LaunchTieredStoCustomCurrencyPolyParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) - * [LaunchTieredStoMethod](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md) - * [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md) - * [LaunchTieredStoNoCustomCurrencyParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md) - * [LaunchTieredStoParams](interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) - * [entities/SecurityToken/Issuance/index](modules/_entities_securitytoken_issuance_index_.md) - * [entities/SecurityToken/Permissions](modules/_entities_securitytoken_permissions_.md) * [Permissions](classes/_entities_securitytoken_permissions_.permissions.md) - * [entities/SecurityToken/SecurityToken](modules/_entities_securitytoken_securitytoken_.md) * [SecurityToken](classes/_entities_securitytoken_securitytoken_.securitytoken.md) - * [Params](interfaces/_entities_securitytoken_securitytoken_.params.md) - * [UniqueIdentifiers](interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) - * [entities/SecurityToken/SubModule](modules/_entities_securitytoken_submodule_.md) * [SubModule](classes/_entities_securitytoken_submodule_.submodule.md) - * [entities/SecurityToken/Tokenholders](modules/_entities_securitytoken_tokenholders_.md) * [Tokenholders](classes/_entities_securitytoken_tokenholders_.tokenholders.md) - * [GetCheckpointParams](interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) - * [entities/SecurityToken/Transfers/Restrictions/CountRestrictions](modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md) * [CountRestrictions](classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) - * [entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions](modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md) * [PercentageRestrictions](classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) - * [ModifyExemptionsMethod](interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md) - * [PercentageIssuanceParams](interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) - * [PercentageWhitelistParams](interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) - * [entities/SecurityToken/Transfers/Restrictions/Restrictions](modules/_entities_securitytoken_transfers_restrictions_restrictions_.md) * [Restrictions](classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) - * [entities/SecurityToken/Transfers/Restrictions/index](modules/_entities_securitytoken_transfers_restrictions_index_.md) - * [entities/SecurityToken/Transfers/Transfers](modules/_entities_securitytoken_transfers_transfers_.md) * [Transfers](classes/_entities_securitytoken_transfers_transfers_.transfers.md) - * [entities/SecurityToken/Transfers/index](modules/_entities_securitytoken_transfers_index_.md) - * [entities/SecurityToken/index](modules/_entities_securitytoken_index_.md) - * [entities/SecurityTokenReservation](modules/_entities_securitytokenreservation_.md) * [SecurityTokenReservation](classes/_entities_securitytokenreservation_.securitytokenreservation.md) - * [Params](interfaces/_entities_securitytokenreservation_.params.md) - * [UniqueIdentifiers](interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) - * [entities/SimpleSto](modules/_entities_simplesto_.md) * [SimpleSto](classes/_entities_simplesto_.simplesto.md) - * [Params](interfaces/_entities_simplesto_.params.md) - * [entities/Sto](modules/_entities_sto_.md) * [Sto](classes/_entities_sto_.sto.md) - * [Params](interfaces/_entities_sto_.params.md) - * [UniqueIdentifiers](interfaces/_entities_sto_.uniqueidentifiers.md) - * [entities/TaxWithholding](modules/_entities_taxwithholding_.md) * [TaxWithholding](classes/_entities_taxwithholding_.taxwithholding.md) - * [Params](interfaces/_entities_taxwithholding_.params.md) - * [UniqueIdentifiers](interfaces/_entities_taxwithholding_.uniqueidentifiers.md) - * [entities/TieredSto](modules/_entities_tieredsto_.md) * [TieredSto](classes/_entities_tieredsto_.tieredsto.md) - * [Params](interfaces/_entities_tieredsto_.params.md) - * [Tier](interfaces/_entities_tieredsto_.tier.md) - * [entities/Tokenholder](modules/_entities_tokenholder_.md) * [Tokenholder](classes/_entities_tokenholder_.tokenholder.md) - * [Params](interfaces/_entities_tokenholder_.params.md) - * [UniqueIdentifiers](interfaces/_entities_tokenholder_.uniqueidentifiers.md) - * [entities/TransactionQueue](modules/_entities_transactionqueue_.md) - * [Events](enums/_entities_transactionqueue_.events.md) * [TransactionQueue](classes/_entities_transactionqueue_.transactionqueue.md) - * [entities/Wallet](modules/_entities_wallet_.md) * [Wallet](classes/_entities_wallet_.wallet.md) - * [Params](interfaces/_entities_wallet_.params.md) - * [UniqueIdentifiers](interfaces/_entities_wallet_.uniqueidentifiers.md) - * [entities/factories/CheckpointFactory](modules/_entities_factories_checkpointfactory_.md) - * [entities/factories/DividendDistributionFactory](modules/_entities_factories_dividenddistributionfactory_.md) - * [entities/factories/Erc20TokenBalanceFactory](modules/_entities_factories_erc20tokenbalancefactory_.md) * [Erc20TokenBalanceFactory](classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) - * [entities/factories/Factory](modules/_entities_factories_factory_.md) * [Factory](classes/_entities_factories_factory_.factory.md) - * [EntityClass](interfaces/_entities_factories_factory_.entityclass.md) - * [entities/factories/InvestmentFactory](modules/_entities_factories_investmentfactory_.md) * [InvestmentFactory](classes/_entities_factories_investmentfactory_.investmentfactory.md) - * [entities/factories/SecurityTokenFactory](modules/_entities_factories_securitytokenfactory_.md) - * [entities/factories/SecurityTokenReservationFactory](modules/_entities_factories_securitytokenreservationfactory_.md) - * [entities/factories/SimpleStoFactory](modules/_entities_factories_simplestofactory_.md) * [SimpleStoFactory](classes/_entities_factories_simplestofactory_.simplestofactory.md) - * [entities/factories/TaxWithholdingFactory](modules/_entities_factories_taxwithholdingfactory_.md) * [TaxWithholdingFactory](classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) - * [entities/factories/TieredStoFactory](modules/_entities_factories_tieredstofactory_.md) * [TieredStoFactory](classes/_entities_factories_tieredstofactory_.tieredstofactory.md) - * [entities/factories/TokenholderFactory](modules/_entities_factories_tokenholderfactory_.md) * [TokenholderFactory](classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) - * [entities/factories/WalletFactory](modules/_entities_factories_walletfactory_.md) * [WalletFactory](classes/_entities_factories_walletfactory_.walletfactory.md) - * [entities/factories/index](modules/_entities_factories_index_.md) - * [entities/index](modules/_entities_index_.md) - * [index](modules/_index_.md) - * [procedures/ApproveErc20](modules/_procedures_approveerc20_.md) * [ApproveErc20](classes/_procedures_approveerc20_.approveerc20.md) - * [procedures/AssignSecurityTokenRole](modules/_procedures_assignsecuritytokenrole_.md) * [AssignSecurityTokenRole](classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) - * [procedures/AssignStoRole](modules/_procedures_assignstorole_.md) * [AssignStoRole](classes/_procedures_assignstorole_.assignstorole.md) - * [procedures/ControllerRedeem](modules/_procedures_controllerredeem_.md) * [ControllerRedeem](classes/_procedures_controllerredeem_.controllerredeem.md) - * [procedures/ControllerTransfer](modules/_procedures_controllertransfer_.md) * [ControllerTransfer](classes/_procedures_controllertransfer_.controllertransfer.md) - * [procedures/CreateCheckpoint](modules/_procedures_createcheckpoint_.md) * [CreateCheckpoint](classes/_procedures_createcheckpoint_.createcheckpoint.md) - * [procedures/CreateDividendDistribution](modules/_procedures_createdividenddistribution_.md) * [CreateDividendDistribution](classes/_procedures_createdividenddistribution_.createdividenddistribution.md) - * [procedures/CreateSecurityToken](modules/_procedures_createsecuritytoken_.md) * [CreateSecurityToken](classes/_procedures_createsecuritytoken_.createsecuritytoken.md) - * [procedures/DisableController](modules/_procedures_disablecontroller_.md) * [DisableController](classes/_procedures_disablecontroller_.disablecontroller.md) - * [procedures/DisableFeature](modules/_procedures_disablefeature_.md) * [DisableFeature](classes/_procedures_disablefeature_.disablefeature.md) - * [procedures/EnableCountTransferManager](modules/_procedures_enablecounttransfermanager_.md) * [EnableCountTransferManager](classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) - * [procedures/EnableDividendManager](modules/_procedures_enabledividendmanager_.md) * [EnableDividendManager](classes/_procedures_enabledividendmanager_.enabledividendmanager.md) - * [procedures/EnableGeneralPermissionManager](modules/_procedures_enablegeneralpermissionmanager_.md) * [EnableGeneralPermissionManager](classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) - * [procedures/EnableGeneralTransferManager](modules/_procedures_enablegeneraltransfermanager_.md) * [EnableGeneralTransferManager](classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) - * [procedures/EnablePercentageTransferManager](modules/_procedures_enablepercentagetransfermanager_.md) * [EnablePercentageTransferManager](classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) - * [procedures/FinalizeSto](modules/_procedures_finalizesto_.md) * [FinalizeSto](classes/_procedures_finalizesto_.finalizesto.md) - * [procedures/FreezeIssuance](modules/_procedures_freezeissuance_.md) * [FreezeIssuance](classes/_procedures_freezeissuance_.freezeissuance.md) - * [procedures/InvestInSimpleSto](modules/_procedures_investinsimplesto_.md) * [InvestInSimpleSto](classes/_procedures_investinsimplesto_.investinsimplesto.md) - * [procedures/InvestInTieredSto](modules/_procedures_investintieredsto_.md) * [InvestInTieredSto](classes/_procedures_investintieredsto_.investintieredsto.md) - * [procedures/IssueTokens](modules/_procedures_issuetokens_.md) * [IssueTokens](classes/_procedures_issuetokens_.issuetokens.md) - * [procedures/LaunchSimpleSto](modules/_procedures_launchsimplesto_.md) * [LaunchSimpleSto](classes/_procedures_launchsimplesto_.launchsimplesto.md) - * [procedures/LaunchTieredSto](modules/_procedures_launchtieredsto_.md) * [LaunchTieredSto](classes/_procedures_launchtieredsto_.launchtieredsto.md) - * [procedures/ModifyDividendsDefaultExclusionList](modules/_procedures_modifydividendsdefaultexclusionlist_.md) * [ModifyDividendsDefaultExclusionList](classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) - * [procedures/ModifyMaxHolderCount](modules/_procedures_modifymaxholdercount_.md) * [ModifyMaxHolderCount](classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md) - * [procedures/ModifyMaxHolderPercentage](modules/_procedures_modifymaxholderpercentage_.md) * [ModifyMaxHolderPercentage](classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) - * [procedures/ModifyPercentageExemptions](modules/_procedures_modifypercentageexemptions_.md) * [ModifyPercentageExemptions](classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) - * [procedures/ModifyTieredStoData](modules/_procedures_modifytieredstodata_.md) * [ModifyTieredStoData](classes/_procedures_modifytieredstodata_.modifytieredstodata.md) - * [procedures/ModifyTokenholderData](modules/_procedures_modifytokenholderdata_.md) * [ModifyTokenholderData](classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) - * [procedures/Procedure](modules/_procedures_procedure_.md) - * [ProcedureClass](interfaces/_procedures_procedure_.procedureclass.md) - * [procedures/PullDividendPayment](modules/_procedures_pulldividendpayment_.md) * [PullDividendPayment](classes/_procedures_pulldividendpayment_.pulldividendpayment.md) - * [procedures/PushDividendPayment](modules/_procedures_pushdividendpayment_.md) * [PushDividendPayment](classes/_procedures_pushdividendpayment_.pushdividendpayment.md) - * [procedures/ReclaimFunds](modules/_procedures_reclaimfunds_.md) * [ReclaimFunds](classes/_procedures_reclaimfunds_.reclaimfunds.md) - * [procedures/RemoveDocument](modules/_procedures_removedocument_.md) * [RemoveDocument](classes/_procedures_removedocument_.removedocument.md) - * [procedures/ReserveSecurityToken](modules/_procedures_reservesecuritytoken_.md) * [ReserveSecurityToken](classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) - * [procedures/RevokeKyc](modules/_procedures_revokekyc_.md) * [RevokeKyc](classes/_procedures_revokekyc_.revokekyc.md) - * [procedures/SetController](modules/_procedures_setcontroller_.md) * [SetController](classes/_procedures_setcontroller_.setcontroller.md) - * [procedures/SetDividendsWallet](modules/_procedures_setdividendswallet_.md) * [SetDividendsWallet](classes/_procedures_setdividendswallet_.setdividendswallet.md) - * [procedures/SetDocument](modules/_procedures_setdocument_.md) * [SetDocument](classes/_procedures_setdocument_.setdocument.md) - * [procedures/SignDisableControllerAck](modules/_procedures_signdisablecontrollerack_.md) * [SignDisableControllerAck](classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) - * [procedures/SignFreezeIssuanceAck](modules/_procedures_signfreezeissuanceack_.md) * [SignFreezeIssuanceAck](classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) - * [procedures/SignTransferData](modules/_procedures_signtransferdata_.md) * [SignTransferData](classes/_procedures_signtransferdata_.signtransferdata.md) - * [procedures/ToggleAllowBeneficialInvestments](modules/_procedures_toggleallowbeneficialinvestments_.md) * [ToggleAllowBeneficialInvestments](classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) - * [procedures/ToggleAllowPreIssuing](modules/_procedures_toggleallowpreissuing_.md) * [ToggleAllowPreIssuing](classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) - * [procedures/ToggleFreezeTransfers](modules/_procedures_togglefreezetransfers_.md) * [ToggleFreezeTransfers](classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md) - * [procedures/TogglePauseSto](modules/_procedures_togglepausesto_.md) * [TogglePauseSto](classes/_procedures_togglepausesto_.togglepausesto.md) - * [procedures/TransferErc20](modules/_procedures_transfererc20_.md) * [TransferErc20](classes/_procedures_transfererc20_.transfererc20.md) - * [procedures/TransferOwnership](modules/_procedures_transferownership_.md) * [TransferOwnership](classes/_procedures_transferownership_.transferownership.md) - * [procedures/TransferReservationOwnership](modules/_procedures_transferreservationownership_.md) * [TransferReservationOwnership](classes/_procedures_transferreservationownership_.transferreservationownership.md) - * [procedures/TransferSecurityTokens](modules/_procedures_transfersecuritytokens_.md) * [TransferSecurityTokens](classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md) - * [procedures/UpdateDividendsTaxWithholdingList](modules/_procedures_updatedividendstaxwithholdinglist_.md) * [UpdateDividendsTaxWithholdingList](classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) - * [procedures/WithdrawTaxes](modules/_procedures_withdrawtaxes_.md) * [WithdrawTaxes](classes/_procedures_withdrawtaxes_.withdrawtaxes.md) - * [procedures/index](modules/_procedures_index_.md) - * [types/index](modules/_types_index_.md) - * [ErrorCode](enums/_types_index_.errorcode.md) - * [Feature](enums/_types_index_.feature.md) - * [PolyTransactionTag](enums/_types_index_.polytransactiontag.md) - * [ProcedureType](enums/_types_index_.proceduretype.md) - * [SecurityTokenRole](enums/_types_index_.securitytokenrole.md) - * [StoRole](enums/_types_index_.storole.md) - * [StoType](enums/_types_index_.stotype.md) - * [TransactionSpeed](enums/_types_index_.transactionspeed.md) - * [TransactionStatus](enums/_types_index_.transactionstatus.md) - * [TransferStatusCode](enums/_types_index_.transferstatuscode.md) - * [ApproveErc20ProcedureArgs](interfaces/_types_index_.approveerc20procedureargs.md) - * [AssignSecurityTokenRoleProcedureArgs](interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) - * [AssignStoRoleProcedureArgs](interfaces/_types_index_.assignstoroleprocedureargs.md) - * [ControllerRedeemProcedureArgs](interfaces/_types_index_.controllerredeemprocedureargs.md) - * [ControllerTransferProcedureArgs](interfaces/_types_index_.controllertransferprocedureargs.md) - * [CreateCheckpointProcedureArgs](interfaces/_types_index_.createcheckpointprocedureargs.md) - * [CreateDividendDistributionProcedureArgs](interfaces/_types_index_.createdividenddistributionprocedureargs.md) - * [CreateSecurityTokenProcedureArgs](interfaces/_types_index_.createsecuritytokenprocedureargs.md) - * [CustomCurrency](interfaces/_types_index_.customcurrency.md) - * [DisableControllerProcedureArgs](interfaces/_types_index_.disablecontrollerprocedureargs.md) - * [DisableFeatureProcedureArgs](interfaces/_types_index_.disablefeatureprocedureargs.md) - * [DividendTokenholderStatus](interfaces/_types_index_.dividendtokenholderstatus.md) - * [EnableCountTransferManagerProcedureArgs](interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) - * [EnableDividendManagerProcedureArgs](interfaces/_types_index_.enabledividendmanagerprocedureargs.md) - * [EnableGeneralPermissionManagerProcedureArgs](interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) - * [EnableGeneralTransferManagerProcedureArgs](interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) - * [EnablePercentageTransferManagerProcedureArgs](interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) - * [Fees](interfaces/_types_index_.fees.md) - * [FinalizeStoProcedureArgs](interfaces/_types_index_.finalizestoprocedureargs.md) - * [FreezeIssuanceProcedureArgs](interfaces/_types_index_.freezeissuanceprocedureargs.md) - * [FutureLowLevelMethod](interfaces/_types_index_.futurelowlevelmethod.md) - * [InvestInSimpleStoProcedureArgs](interfaces/_types_index_.investinsimplestoprocedureargs.md) - * [InvestInTieredStoBaseProcedureArgs](interfaces/_types_index_.investintieredstobaseprocedureargs.md) - * [InvestWithStableCoinArgs](interfaces/_types_index_.investwithstablecoinargs.md) - * [IssuanceDataEntry](interfaces/_types_index_.issuancedataentry.md) - * [IssueTokensProcedureArgs](interfaces/_types_index_.issuetokensprocedureargs.md) - * [LaunchSimpleStoProcedureArgs](interfaces/_types_index_.launchsimplestoprocedureargs.md) - * [LaunchTieredStoProcedureArgs](interfaces/_types_index_.launchtieredstoprocedureargs.md) - * [ModifyDividendsDefaultExclusionListProcedureArgs](interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) - * [ModifyMaxHolderCountProcedureArgs](interfaces/_types_index_.modifymaxholdercountprocedureargs.md) - * [ModifyMaxHolderPercentageProcedureArgs](interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) - * [ModifyPercentageExemptionsProcedureArgs](interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) - * [ModifyTieredStoDataProcedureArgs](interfaces/_types_index_.modifytieredstodataprocedureargs.md) - * [ModifyTokenholderDataProcedureArgs](interfaces/_types_index_.modifytokenholderdataprocedureargs.md) - * [PercentageWhitelistEntry](interfaces/_types_index_.percentagewhitelistentry.md) - * [Pojo](interfaces/_types_index_.pojo.md) - * [PullDividendPaymentProcedureArgs](interfaces/_types_index_.pulldividendpaymentprocedureargs.md) - * [PushDividendPaymentProcedureArgs](interfaces/_types_index_.pushdividendpaymentprocedureargs.md) - * [ReclaimFundsProcedureArgs](interfaces/_types_index_.reclaimfundsprocedureargs.md) - * [RemoveDocumentProcedureArgs](interfaces/_types_index_.removedocumentprocedureargs.md) - * [ReserveSecurityTokenProcedureArgs](interfaces/_types_index_.reservesecuritytokenprocedureargs.md) - * [RevokeKycProcedureArgs](interfaces/_types_index_.revokekycprocedureargs.md) - * [SetControllerProcedureArgs](interfaces/_types_index_.setcontrollerprocedureargs.md) - * [SetDividendsWalletProcedureArgs](interfaces/_types_index_.setdividendswalletprocedureargs.md) - * [SetDocumentProcedureArgs](interfaces/_types_index_.setdocumentprocedureargs.md) - * [SignDisableControllerAckProcedureArgs](interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) - * [SignFreezeIssuanceAckProcedureArgs](interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) - * [SignTransferDataProcedureArgs](interfaces/_types_index_.signtransferdataprocedureargs.md) - * [StoTier](interfaces/_types_index_.stotier.md) - * [TaxWithholdingEntry](interfaces/_types_index_.taxwithholdingentry.md) - * [ToggleAllowBeneficialInvestmentsProcedureArgs](interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) - * [ToggleAllowPreIssuingProcedureArgs](interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) - * [ToggleFreezeTransfersProcedureArgs](interfaces/_types_index_.togglefreezetransfersprocedureargs.md) - * [TogglePauseStoProcedureArgs](interfaces/_types_index_.togglepausestoprocedureargs.md) - * [TokenholderBalance](interfaces/_types_index_.tokenholderbalance.md) - * [TokenholderDataEntry](interfaces/_types_index_.tokenholderdataentry.md) - * [TransactionSpec](interfaces/_types_index_.transactionspec.md) - * [TransferErc20ProcedureArgs](interfaces/_types_index_.transfererc20procedureargs.md) - * [TransferOwnershipProcedureArgs](interfaces/_types_index_.transferownershipprocedureargs.md) - * [TransferReservationOwnershipProcedureArgs](interfaces/_types_index_.transferreservationownershipprocedureargs.md) - * [TransferSecurityTokensProcedureArgs](interfaces/_types_index_.transfersecuritytokensprocedureargs.md) - * [UpdateDividendsTaxWithholdingListProcedureArgs](interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) - * [WithdrawTaxesProcedureArgs](interfaces/_types_index_.withdrawtaxesprocedureargs.md) - * [utils/constants](modules/_utils_constants_.md) - * [utils/index](modules/_utils_index_.md) - * [FindCappedStoPauseParams](interfaces/_utils_index_.findcappedstopauseparams.md) - * [FindCappedStoPreMintAllowedParams](interfaces/_utils_index_.findcappedstopremintallowedparams.md) - * [FindCheckpointCreatedParams](interfaces/_utils_index_.findcheckpointcreatedparams.md) - * [FindControllerTransferParams](interfaces/_utils_index_.findcontrollertransferparams.md) - * [FindErc20DividendClaimedParams](interfaces/_utils_index_.finderc20dividendclaimedparams.md) - * [FindErc20DividendDepositedParams](interfaces/_utils_index_.finderc20dividenddepositedparams.md) - * [FindErc20DividendReclaimedParams](interfaces/_utils_index_.finderc20dividendreclaimedparams.md) - * [FindErc20SetWalletParams](interfaces/_utils_index_.finderc20setwalletparams.md) - * [FindErc20SetWithholdingParams](interfaces/_utils_index_.finderc20setwithholdingparams.md) - * [FindEthDividendClaimedParams](interfaces/_utils_index_.findethdividendclaimedparams.md) - * [FindEthDividendReclaimedParams](interfaces/_utils_index_.findethdividendreclaimedparams.md) - * [FindEthSetWalletParams](interfaces/_utils_index_.findethsetwalletparams.md) - * [FindEthSetWithholdingParams](interfaces/_utils_index_.findethsetwithholdingparams.md) - * [FindEtherDividendDepositedParams](interfaces/_utils_index_.findetherdividenddepositedparams.md) - * [FindEventParams](interfaces/_utils_index_.findeventparams.md) - * [FindEvents](interfaces/_utils_index_.findevents.md) - * [FindModifyInvestorFlagParams](interfaces/_utils_index_.findmodifyinvestorflagparams.md) - * [FindModifyKycDataParams](interfaces/_utils_index_.findmodifykycdataparams.md) - * [FindModuleAddedParams](interfaces/_utils_index_.findmoduleaddedparams.md) - * [FindNewSecurityTokenParams](interfaces/_utils_index_.findnewsecuritytokenparams.md) - * [FindTickerRegisteredParams](interfaces/_utils_index_.findtickerregisteredparams.md) - * [FindTieredStoPauseParams](interfaces/_utils_index_.findtieredstopauseparams.md) - * [FindTieredStoPreMintAllowedParams](interfaces/_utils_index_.findtieredstopremintallowedparams.md) -* [Classes]() - * [Context](classes/_context_.context.md) - * [Polymath](classes/_polymath_.polymath.md) - * [PolymathBase](classes/_polymathbase_.polymathbase.md) - * [PolymathError](classes/_polymatherror_.polymatherror.md) - * [Checkpoint](classes/_entities_checkpoint_.checkpoint.md) - * [DividendDistribution](classes/_entities_dividenddistribution_.dividenddistribution.md) - * [Entity](classes/_entities_entity_.entity.md) - * [Erc20TokenBalance](classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) - * [Investment](classes/_entities_investment_.investment.md) - * [PolyTransaction](classes/_entities_polytransaction_.polytransaction.md) - * [Controller](classes/_entities_securitytoken_controller_.controller.md) - * [Dividends](classes/_entities_securitytoken_dividends_.dividends.md) - * [Documents](classes/_entities_securitytoken_documents_.documents.md) - * [Features](classes/_entities_securitytoken_features_.features.md) - * [Issuance](classes/_entities_securitytoken_issuance_issuance_.issuance.md) - * [Offerings](classes/_entities_securitytoken_issuance_offerings_.offerings.md) - * [Permissions](classes/_entities_securitytoken_permissions_.permissions.md) - * [SecurityToken](classes/_entities_securitytoken_securitytoken_.securitytoken.md) - * [SubModule](classes/_entities_securitytoken_submodule_.submodule.md) - * [Tokenholders](classes/_entities_securitytoken_tokenholders_.tokenholders.md) - * [CountRestrictions](classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) - * [PercentageRestrictions](classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) - * [Restrictions](classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) - * [Transfers](classes/_entities_securitytoken_transfers_transfers_.transfers.md) - * [SecurityTokenReservation](classes/_entities_securitytokenreservation_.securitytokenreservation.md) - * [SimpleSto](classes/_entities_simplesto_.simplesto.md) - * [Sto](classes/_entities_sto_.sto.md) - * [TaxWithholding](classes/_entities_taxwithholding_.taxwithholding.md) - * [TieredSto](classes/_entities_tieredsto_.tieredsto.md) - * [Tokenholder](classes/_entities_tokenholder_.tokenholder.md) - * [TransactionQueue](classes/_entities_transactionqueue_.transactionqueue.md) - * [Wallet](classes/_entities_wallet_.wallet.md) - * [Erc20TokenBalanceFactory](classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) - * [Factory](classes/_entities_factories_factory_.factory.md) - * [InvestmentFactory](classes/_entities_factories_investmentfactory_.investmentfactory.md) - * [SimpleStoFactory](classes/_entities_factories_simplestofactory_.simplestofactory.md) - * [TaxWithholdingFactory](classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) - * [TieredStoFactory](classes/_entities_factories_tieredstofactory_.tieredstofactory.md) - * [TokenholderFactory](classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) - * [WalletFactory](classes/_entities_factories_walletfactory_.walletfactory.md) - * [ApproveErc20](classes/_procedures_approveerc20_.approveerc20.md) - * [AssignSecurityTokenRole](classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) - * [AssignStoRole](classes/_procedures_assignstorole_.assignstorole.md) - * [ControllerRedeem](classes/_procedures_controllerredeem_.controllerredeem.md) - * [ControllerTransfer](classes/_procedures_controllertransfer_.controllertransfer.md) - * [CreateCheckpoint](classes/_procedures_createcheckpoint_.createcheckpoint.md) - * [CreateDividendDistribution](classes/_procedures_createdividenddistribution_.createdividenddistribution.md) - * [CreateSecurityToken](classes/_procedures_createsecuritytoken_.createsecuritytoken.md) - * [DisableController](classes/_procedures_disablecontroller_.disablecontroller.md) - * [DisableFeature](classes/_procedures_disablefeature_.disablefeature.md) - * [EnableCountTransferManager](classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) - * [EnableDividendManager](classes/_procedures_enabledividendmanager_.enabledividendmanager.md) - * [EnableGeneralPermissionManager](classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) - * [EnableGeneralTransferManager](classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) - * [EnablePercentageTransferManager](classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) - * [FinalizeSto](classes/_procedures_finalizesto_.finalizesto.md) - * [FreezeIssuance](classes/_procedures_freezeissuance_.freezeissuance.md) - * [InvestInSimpleSto](classes/_procedures_investinsimplesto_.investinsimplesto.md) - * [InvestInTieredSto](classes/_procedures_investintieredsto_.investintieredsto.md) - * [IssueTokens](classes/_procedures_issuetokens_.issuetokens.md) - * [LaunchSimpleSto](classes/_procedures_launchsimplesto_.launchsimplesto.md) - * [LaunchTieredSto](classes/_procedures_launchtieredsto_.launchtieredsto.md) - * [ModifyDividendsDefaultExclusionList](classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) - * [ModifyMaxHolderCount](classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md) - * [ModifyMaxHolderPercentage](classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) - * [ModifyPercentageExemptions](classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) - * [ModifyTieredStoData](classes/_procedures_modifytieredstodata_.modifytieredstodata.md) - * [ModifyTokenholderData](classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) - * [PullDividendPayment](classes/_procedures_pulldividendpayment_.pulldividendpayment.md) - * [PushDividendPayment](classes/_procedures_pushdividendpayment_.pushdividendpayment.md) - * [ReclaimFunds](classes/_procedures_reclaimfunds_.reclaimfunds.md) - * [RemoveDocument](classes/_procedures_removedocument_.removedocument.md) - * [ReserveSecurityToken](classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) - * [RevokeKyc](classes/_procedures_revokekyc_.revokekyc.md) - * [SetController](classes/_procedures_setcontroller_.setcontroller.md) - * [SetDividendsWallet](classes/_procedures_setdividendswallet_.setdividendswallet.md) - * [SetDocument](classes/_procedures_setdocument_.setdocument.md) - * [SignDisableControllerAck](classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) - * [SignFreezeIssuanceAck](classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) - * [SignTransferData](classes/_procedures_signtransferdata_.signtransferdata.md) - * [ToggleAllowBeneficialInvestments](classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) - * [ToggleAllowPreIssuing](classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) - * [ToggleFreezeTransfers](classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md) - * [TogglePauseSto](classes/_procedures_togglepausesto_.togglepausesto.md) - * [TransferErc20](classes/_procedures_transfererc20_.transfererc20.md) - * [TransferOwnership](classes/_procedures_transferownership_.transferownership.md) - * [TransferReservationOwnership](classes/_procedures_transferreservationownership_.transferreservationownership.md) - * [TransferSecurityTokens](classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md) - * [UpdateDividendsTaxWithholdingList](classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) - * [WithdrawTaxes](classes/_procedures_withdrawtaxes_.withdrawtaxes.md) -* [Enums]() +* [Enums](enums/README.md) * [BrowserSupport](enums/_browserutils_.browsersupport.md) * [Event](enums/_entities_polytransaction_.event.md) * [Events](enums/_entities_transactionqueue_.events.md) @@ -474,7 +477,7 @@ * [TransactionSpeed](enums/_types_index_.transactionspeed.md) * [TransactionStatus](enums/_types_index_.transactionstatus.md) * [TransferStatusCode](enums/_types_index_.transferstatuscode.md) -* [Interfaces]() +* [Interfaces](interfaces/README.md) * [ConstructorParams](interfaces/_context_.constructorparams.md) * [Factories](interfaces/_context_.factories.md) * [AddressParams](interfaces/_polymath_.addressparams.md) @@ -631,4 +634,5 @@ * [FindNewSecurityTokenParams](interfaces/_utils_index_.findnewsecuritytokenparams.md) * [FindTickerRegisteredParams](interfaces/_utils_index_.findtickerregisteredparams.md) * [FindTieredStoPauseParams](interfaces/_utils_index_.findtieredstopauseparams.md) - * [FindTieredStoPreMintAllowedParams](interfaces/_utils_index_.findtieredstopremintallowedparams.md) \ No newline at end of file + * [FindTieredStoPreMintAllowedParams](interfaces/_utils_index_.findtieredstopremintallowedparams.md) + diff --git a/docs/api/classes/README.md b/docs/api/classes/README.md new file mode 100644 index 0000000..3a3986b --- /dev/null +++ b/docs/api/classes/README.md @@ -0,0 +1,2 @@ +# Classes + diff --git a/docs/api/classes/_context_.context.md b/docs/api/classes/_context_.context.md index 65b2785..f83da0a 100644 --- a/docs/api/classes/_context_.context.md +++ b/docs/api/classes/_context_.context.md @@ -1,10 +1,10 @@ -# Class: Context +# Context Context in which the SDK is being used -- Holds the current instance of the contract wrappers -- Holds the current wallet -- Holds the factories that create and cache entities +* Holds the current instance of the contract wrappers +* Holds the current wallet +* Holds the factories that create and cache entities ## Hierarchy @@ -24,40 +24,37 @@ Context in which the SDK is being used ## Constructors -### constructor +### constructor -\+ **new Context**(`params`: [ConstructorParams](../interfaces/_context_.constructorparams.md)): *[Context](_context_.context.md)* ++ **new Context**\(`params`: [ConstructorParams](../interfaces/_context_.constructorparams.md)\): [_Context_](_context_.context.md) -*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45)* +_Defined in_ [_src/Context.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45) **Parameters:** -Name | Type | ------- | ------ | -`params` | [ConstructorParams](../interfaces/_context_.constructorparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [ConstructorParams](../interfaces/_context_.constructorparams.md) | -**Returns:** *[Context](_context_.context.md)* +**Returns:** [_Context_](_context_.context.md) ## Properties -### contractWrappers +### contractWrappers -• **contractWrappers**: *[PolymathBase](_polymathbase_.polymathbase.md)* +• **contractWrappers**: [_PolymathBase_](_polymathbase_.polymathbase.md) -*Defined in [src/Context.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L41)* +_Defined in_ [_src/Context.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L41) -___ +### currentWallet -### currentWallet +• **currentWallet**: _Wallet_ -• **currentWallet**: *Wallet* +_Defined in_ [_src/Context.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L43) -*Defined in [src/Context.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L43)* +### factories -___ +• **factories**: [_Factories_](../interfaces/_context_.factories.md) -### factories +_Defined in_ [_src/Context.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45) -• **factories**: *[Factories](../interfaces/_context_.factories.md)* - -*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45)* diff --git a/docs/api/classes/_entities_checkpoint_.checkpoint.md b/docs/api/classes/_entities_checkpoint_.checkpoint.md index e096ce5..1a733f7 100644 --- a/docs/api/classes/_entities_checkpoint_.checkpoint.md +++ b/docs/api/classes/_entities_checkpoint_.checkpoint.md @@ -1,4 +1,4 @@ -# Class: Checkpoint +# Checkpoint Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time @@ -27,186 +27,160 @@ Represents a snapshot of the Security Token's supply and Tokenholder balances at ### Methods -* [_refresh](_entities_checkpoint_.checkpoint.md#_refresh) +* [\_refresh](_entities_checkpoint_.checkpoint.md#_refresh) * [toPojo](_entities_checkpoint_.checkpoint.md#topojo) * [generateId](_entities_checkpoint_.checkpoint.md#static-generateid) * [unserialize](_entities_checkpoint_.checkpoint.md#static-unserialize) ## Constructors -### constructor +### constructor -\+ **new Checkpoint**(`params`: [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)): *[Checkpoint](_entities_checkpoint_.checkpoint.md)* ++ **new Checkpoint**\(`params`: [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)\): [_Checkpoint_](_entities_checkpoint_.checkpoint.md) -*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106)* +_Defined in_ [_src/entities/Checkpoint.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106) Create a new Chekpoint instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) | -**Returns:** *[Checkpoint](_entities_checkpoint_.checkpoint.md)* +**Returns:** [_Checkpoint_](_entities_checkpoint_.checkpoint.md) ## Properties -### createdAt +### createdAt -• **createdAt**: *Date* +• **createdAt**: _Date_ -*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106)* +_Defined in_ [_src/entities/Checkpoint.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106) -___ +### dividendDistributions -### dividendDistributions +• **dividendDistributions**: [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_\[\]_ -• **dividendDistributions**: *[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)[]* - -*Defined in [src/entities/Checkpoint.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L88)* +_Defined in_ [_src/entities/Checkpoint.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L88) dividend distributions associated to this snapshot -___ - -### index +### index -• **index**: *number* +• **index**: _number_ -*Defined in [src/entities/Checkpoint.ts:97](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L97)* +_Defined in_ [_src/entities/Checkpoint.ts:97_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L97) numerical index of the checkpoint associated to this snapshot -___ - -### securityTokenId - -• **securityTokenId**: *string* - -*Defined in [src/entities/Checkpoint.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L92)* +### securityTokenId -___ +• **securityTokenId**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/Checkpoint.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L92) -• **securityTokenSymbol**: *string* +### securityTokenSymbol -*Defined in [src/entities/Checkpoint.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L90)* +• **securityTokenSymbol**: _string_ -___ +_Defined in_ [_src/entities/Checkpoint.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L90) -### tokenholderBalances +### tokenholderBalances -• **tokenholderBalances**: *[TokenholderBalance](../interfaces/_types_index_.tokenholderbalance.md)[]* +• **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ -*Defined in [src/entities/Checkpoint.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L102)* +_Defined in_ [_src/entities/Checkpoint.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L102) tokenholder balances at this specific checkpoint -___ +### totalSupply -### totalSupply +• **totalSupply**: _BigNumber_ -• **totalSupply**: *BigNumber* +_Defined in_ [_src/entities/Checkpoint.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L104) -*Defined in [src/entities/Checkpoint.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L104)* +### uid -___ +• **uid**: _string_ -### uid +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -• **uid**: *string* - -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* - -*Defined in [src/entities/Checkpoint.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L83)* +_Defined in_ [_src/entities/Checkpoint.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L83) ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Checkpoint.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L164)* +_Defined in_ [_src/entities/Checkpoint.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L164) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)› | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)› | -### toPojo +**Returns:** _void_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/Checkpoint.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L137)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/Checkpoint.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L137) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **createdAt**: *Date* +**Returns:** _object_ -* **dividendDistributions**: *object[]* = dividendDistributions.map(distribution => distribution.toPojo()) - -* **index**: *number* - -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **tokenholderBalances**: *[TokenholderBalance](../interfaces/_types_index_.tokenholderbalance.md)[]* - -* **totalSupply**: *BigNumber* - -* **uid**: *string* - -___ +* **createdAt**: _Date_ +* **dividendDistributions**: _object\[\]_ = dividendDistributions.map\(distribution => distribution.toPojo\(\)\) +* **index**: _number_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ +* **totalSupply**: _BigNumber_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/Checkpoint.ts:58](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L58)* +_Defined in_ [_src/entities/Checkpoint.ts:58_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L58) Generate the Checkpoint's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`index` | number | -`securityTokenId` | string | +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) -*Defined in [src/entities/Checkpoint.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L70)* +_Defined in_ [_src/entities/Checkpoint.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L70) Unserialize string to Checkpoint object **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_dividenddistribution_.dividenddistribution.md b/docs/api/classes/_entities_dividenddistribution_.dividenddistribution.md index c9ee7d6..143ade1 100644 --- a/docs/api/classes/_entities_dividenddistribution_.dividenddistribution.md +++ b/docs/api/classes/_entities_dividenddistribution_.dividenddistribution.md @@ -1,4 +1,4 @@ -# Class: DividendDistribution +# DividendDistribution Class used to manage the dividend distribution functionality @@ -37,7 +37,7 @@ Class used to manage the dividend distribution functionality ### Methods -* [_refresh](_entities_dividenddistribution_.dividenddistribution.md#_refresh) +* [\_refresh](_entities_dividenddistribution_.dividenddistribution.md#_refresh) * [pullPayment](_entities_dividenddistribution_.dividenddistribution.md#pullpayment) * [pushPayment](_entities_dividenddistribution_.dividenddistribution.md#pushpayment) * [toPojo](_entities_dividenddistribution_.dividenddistribution.md#topojo) @@ -47,308 +47,247 @@ Class used to manage the dividend distribution functionality ## Constructors -### constructor +### constructor -\+ **new DividendDistribution**(`params`: [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)* ++ **new DividendDistribution**\(`params`: [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md) -*Defined in [src/entities/DividendDistribution.ts:146](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146)* +_Defined in_ [_src/entities/DividendDistribution.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146) Create a new Dividend Distribution instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)* +**Returns:** [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md) ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/entities/DividendDistribution.ts:128](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L128)* +_Defined in_ [_src/entities/DividendDistribution.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L128) -___ +### checkpointId -### checkpointId +• **checkpointId**: _string_ -• **checkpointId**: *string* +_Defined in_ [_src/entities/DividendDistribution.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L116) -*Defined in [src/entities/DividendDistribution.ts:116](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L116)* +### claimedAmount -___ +• **claimedAmount**: _BigNumber_ -### claimedAmount - -• **claimedAmount**: *BigNumber* - -*Defined in [src/entities/DividendDistribution.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L130)* - -___ +_Defined in_ [_src/entities/DividendDistribution.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L130) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Defined in [src/entities/DividendDistribution.ts:146](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146)* - -___ - -### created - -• **created**: *Date* - -*Defined in [src/entities/DividendDistribution.ts:122](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L122)* - -___ - -### currency +• **context**: [_Context_](_context_.context.md) -• **currency**: *string | null* +_Defined in_ [_src/entities/DividendDistribution.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146) -*Defined in [src/entities/DividendDistribution.ts:144](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L144)* +### created -___ +• **created**: _Date_ -### expiry +_Defined in_ [_src/entities/DividendDistribution.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L122) -• **expiry**: *Date* +### currency -*Defined in [src/entities/DividendDistribution.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L126)* +• **currency**: _string \| null_ -___ +_Defined in_ [_src/entities/DividendDistribution.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L144) -### index +### expiry -• **index**: *number* +• **expiry**: _Date_ -*Defined in [src/entities/DividendDistribution.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L114)* +_Defined in_ [_src/entities/DividendDistribution.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L126) -___ +### index -### maturity +• **index**: _number_ -• **maturity**: *Date* +_Defined in_ [_src/entities/DividendDistribution.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L114) -*Defined in [src/entities/DividendDistribution.ts:124](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L124)* +### maturity -___ +• **maturity**: _Date_ -### name +_Defined in_ [_src/entities/DividendDistribution.ts:124_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L124) -• **name**: *string* +### name -*Defined in [src/entities/DividendDistribution.ts:142](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L142)* +• **name**: _string_ -___ +_Defined in_ [_src/entities/DividendDistribution.ts:142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L142) -### reclaimed +### reclaimed -• **reclaimed**: *boolean* +• **reclaimed**: _boolean_ -*Defined in [src/entities/DividendDistribution.ts:134](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L134)* +_Defined in_ [_src/entities/DividendDistribution.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L134) -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/DividendDistribution.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L120) -*Defined in [src/entities/DividendDistribution.ts:120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L120)* +### securityTokenSymbol -___ +• **securityTokenSymbol**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/DividendDistribution.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L118) -• **securityTokenSymbol**: *string* +### tokenholders -*Defined in [src/entities/DividendDistribution.ts:118](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L118)* +• **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ -___ +_Defined in_ [_src/entities/DividendDistribution.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L140) -### tokenholders +### totalSupply -• **tokenholders**: *[DividendTokenholderStatus](../interfaces/_types_index_.dividendtokenholderstatus.md)[]* +• **totalSupply**: _BigNumber_ -*Defined in [src/entities/DividendDistribution.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L140)* +_Defined in_ [_src/entities/DividendDistribution.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L132) -___ +### totalWithheld -### totalSupply +• **totalWithheld**: _BigNumber_ -• **totalSupply**: *BigNumber* +_Defined in_ [_src/entities/DividendDistribution.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L136) -*Defined in [src/entities/DividendDistribution.ts:132](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L132)* +### totalWithheldWithdrawn -___ +• **totalWithheldWithdrawn**: _BigNumber_ -### totalWithheld +_Defined in_ [_src/entities/DividendDistribution.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L138) -• **totalWithheld**: *BigNumber* +### uid -*Defined in [src/entities/DividendDistribution.ts:136](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L136)* +• **uid**: _string_ -___ +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -### totalWithheldWithdrawn - -• **totalWithheldWithdrawn**: *BigNumber* - -*Defined in [src/entities/DividendDistribution.ts:138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L138)* - -___ - -### uid - -• **uid**: *string* - -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* - -*Defined in [src/entities/DividendDistribution.ts:112](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L112)* +_Defined in_ [_src/entities/DividendDistribution.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L112) ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/DividendDistribution.ts:290](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L290)* +_Defined in_ [_src/entities/DividendDistribution.ts:290_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L290) Hydrate the Dividend Distribution entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)› | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)› | -___ +**Returns:** _void_ -### pullPayment +### pullPayment -▸ **pullPayment**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md), void››* +▸ **pullPayment**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)_, void››_ -*Defined in [src/entities/DividendDistribution.ts:215](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L215)* +_Defined in_ [_src/entities/DividendDistribution.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L215) Pull payment from this dividend distribution to the current address -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)_, void››_ -___ +### pushPayment -### pushPayment +▸ **pushPayment**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)_, void››_ -▸ **pushPayment**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md), void››* - -*Defined in [src/entities/DividendDistribution.ts:200](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L200)* +_Defined in_ [_src/entities/DividendDistribution.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L200) Push payment for this dividend distribution -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)_, void››_ -### toPojo +### toPojo -▸ **toPojo**(): *object* +▸ **toPojo**\(\): _object_ -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -*Defined in [src/entities/DividendDistribution.ts:245](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L245)* +_Defined in_ [_src/entities/DividendDistribution.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L245) -Convert entity to POJO (Plain Old Javascript Object) +Convert entity to POJO \(Plain Old Javascript Object\) -**Returns:** *object* +**Returns:** _object_ -* **amount**: *BigNumber* +* **amount**: _BigNumber_ +* **checkpointId**: _string_ +* **claimedAmount**: _BigNumber_ +* **created**: _Date_ +* **currency**: _null \| string_ +* **expiry**: _Date_ +* **index**: _number_ +* **maturity**: _Date_ +* **name**: _string_ +* **reclaimed**: _boolean_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ +* **totalSupply**: _BigNumber_ +* **totalWithheld**: _BigNumber_ +* **totalWithheldWithdrawn**: _BigNumber_ +* **uid**: _string_ -* **checkpointId**: *string* +### withdrawTaxes -* **claimedAmount**: *BigNumber* +▸ **withdrawTaxes**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)_, void››_ -* **created**: *Date* - -* **currency**: *null | string* - -* **expiry**: *Date* - -* **index**: *number* - -* **maturity**: *Date* - -* **name**: *string* - -* **reclaimed**: *boolean* - -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **tokenholders**: *[DividendTokenholderStatus](../interfaces/_types_index_.dividendtokenholderstatus.md)[]* - -* **totalSupply**: *BigNumber* - -* **totalWithheld**: *BigNumber* - -* **totalWithheldWithdrawn**: *BigNumber* - -* **uid**: *string* - -___ - -### withdrawTaxes - -▸ **withdrawTaxes**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md), void››* - -*Defined in [src/entities/DividendDistribution.ts:230](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L230)* +_Defined in_ [_src/entities/DividendDistribution.ts:230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L230) Withdraw collected taxes from this dividend distribution -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)_, void››_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/DividendDistribution.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L87)* +_Defined in_ [_src/entities/DividendDistribution.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L87) Generate the Dividend Distribution's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`index` | number | -`securityTokenId` | string | +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) -*Defined in [src/entities/DividendDistribution.ts:99](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L99)* +_Defined in_ [_src/entities/DividendDistribution.ts:99_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L99) Unserialize string to a Dividend Distribution object representation **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_entity_.entity.md b/docs/api/classes/_entities_entity_.entity.md index df16bc0..7884570 100644 --- a/docs/api/classes/_entities_entity_.entity.md +++ b/docs/api/classes/_entities_entity_.entity.md @@ -1,4 +1,4 @@ -# Class: Entity <**Params**> +# Entity Represents an object or resource in the Polymath Ecosystem with its own set of properties and functionality @@ -42,39 +42,38 @@ Represents an object or resource in the Polymath Ecosystem with its own set of p ### Methods -* [_refresh](_entities_entity_.entity.md#abstract-_refresh) +* [\_refresh](_entities_entity_.entity.md#abstract-_refresh) * [toPojo](_entities_entity_.entity.md#abstract-topojo) ## Properties ### `Abstract` uid -• **uid**: *string* +• **uid**: _string_ -*Defined in [src/entities/Entity.ts:5](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L5)* +_Defined in_ [_src/entities/Entity.ts:5_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L5) ## Methods -### `Abstract` _refresh +### `Abstract` \_refresh -▸ **_refresh**(`params`: Partial‹Params›): *void* +▸ **\_refresh**\(`params`: Partial‹Params›\): _void_ -*Defined in [src/entities/Entity.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L9)* +_Defined in_ [_src/entities/Entity.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L9) **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹Params› | +| Name | Type | +| :--- | :--- | +| `params` | Partial‹Params› | -**Returns:** *void* - -___ +**Returns:** _void_ ### `Abstract` toPojo -▸ **toPojo**(): *any* +▸ **toPojo**\(\): _any_ + +_Defined in_ [_src/entities/Entity.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L7) -*Defined in [src/entities/Entity.ts:7](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L7)* +**Returns:** _any_ -**Returns:** *any* diff --git a/docs/api/classes/_entities_erc20tokenbalance_.erc20tokenbalance.md b/docs/api/classes/_entities_erc20tokenbalance_.erc20tokenbalance.md index f569eb9..dd6acf3 100644 --- a/docs/api/classes/_entities_erc20tokenbalance_.erc20tokenbalance.md +++ b/docs/api/classes/_entities_erc20tokenbalance_.erc20tokenbalance.md @@ -1,4 +1,4 @@ -# Class: Erc20TokenBalance +# Erc20TokenBalance Used to manage a ERC20 token balance @@ -24,158 +24,141 @@ Used to manage a ERC20 token balance ### Methods -* [_refresh](_entities_erc20tokenbalance_.erc20tokenbalance.md#_refresh) +* [\_refresh](_entities_erc20tokenbalance_.erc20tokenbalance.md#_refresh) * [toPojo](_entities_erc20tokenbalance_.erc20tokenbalance.md#topojo) * [generateId](_entities_erc20tokenbalance_.erc20tokenbalance.md#static-generateid) * [unserialize](_entities_erc20tokenbalance_.erc20tokenbalance.md#static-unserialize) ## Constructors -### constructor +### constructor -\+ **new Erc20TokenBalance**(`params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)): *[Erc20TokenBalance](_entities_erc20tokenbalance_.erc20tokenbalance.md)* ++ **new Erc20TokenBalance**\(`params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)\): [_Erc20TokenBalance_](_entities_erc20tokenbalance_.erc20tokenbalance.md) -*Defined in [src/entities/Erc20TokenBalance.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84) Create an ERC20 Token balance instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) | -**Returns:** *[Erc20TokenBalance](_entities_erc20tokenbalance_.erc20tokenbalance.md)* +**Returns:** [_Erc20TokenBalance_](_entities_erc20tokenbalance_.erc20tokenbalance.md) ## Properties -### balance +### balance -• **balance**: *BigNumber* +• **balance**: _BigNumber_ -*Defined in [src/entities/Erc20TokenBalance.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84) total number of tokens belonging to token holder -___ +### tokenAddress -### tokenAddress +• **tokenAddress**: _string_ -• **tokenAddress**: *string* - -*Defined in [src/entities/Erc20TokenBalance.ts:74](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L74)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L74) address of the ERC20 token -___ - -### tokenSymbol - -• **tokenSymbol**: *string | null* +### tokenSymbol -*Defined in [src/entities/Erc20TokenBalance.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L69)* +• **tokenSymbol**: _string \| null_ -___ +_Defined in_ [_src/entities/Erc20TokenBalance.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L69) -### uid +### uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/Erc20TokenBalance.ts:67](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L67)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:67_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L67) unique generated identifier for an ERC20 token balance -___ +### walletAddress -### walletAddress +• **walletAddress**: _string_ -• **walletAddress**: *string* - -*Defined in [src/entities/Erc20TokenBalance.ts:79](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L79)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L79) wallet address of the token holder ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Erc20TokenBalance.ts:122](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L122)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L122) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | -### toPojo +**Returns:** _void_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/Erc20TokenBalance.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L107)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/Erc20TokenBalance.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L107) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **balance**: *BigNumber* +**Returns:** _object_ -* **tokenAddress**: *string* - -* **tokenSymbol**: *null | string* - -* **uid**: *string* - -* **walletAddress**: *string* - -___ +* **balance**: _BigNumber_ +* **tokenAddress**: _string_ +* **tokenSymbol**: _null \| string_ +* **uid**: _string_ +* **walletAddress**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/Erc20TokenBalance.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L39)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L39) Generate the ERC20 Token Balance's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`walletAddress` | string | +▪ **\_\_namedParameters**: _object_ -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `tokenAddress` | string | +| `walletAddress` | string | -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: any): *[UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: any\): [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) -*Defined in [src/entities/Erc20TokenBalance.ts:51](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L51)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L51) Unserialize a serialized erc20 token balance **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`serialized` | any | string with erc20 token balance entity information | +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | any | string with erc20 token balance entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md b/docs/api/classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md index 7153ab7..caf3ecd 100644 --- a/docs/api/classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md +++ b/docs/api/classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md @@ -1,4 +1,4 @@ -# Class: Erc20TokenBalanceFactory +# Erc20TokenBalanceFactory Factory generates information for an ERC20 Token Balance @@ -29,138 +29,129 @@ Factory generates information for an ERC20 Token Balance ## Constructors -### constructor +### constructor -\+ **new Erc20TokenBalanceFactory**(`context`: [Context](_context_.context.md)): *[Erc20TokenBalanceFactory](_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md)* ++ **new Erc20TokenBalanceFactory**\(`context`: [Context](_context_.context.md)\): [_Erc20TokenBalanceFactory_](_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/Erc20TokenBalanceFactory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Erc20TokenBalanceFactory.ts#L28)* +_Defined in_ [_src/entities/factories/Erc20TokenBalanceFactory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Erc20TokenBalanceFactory.ts#L28) Create an instance of the ERC20 Token Balance Factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Erc20TokenBalanceFactory](_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md)* +**Returns:** [_Erc20TokenBalanceFactory_](_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md), [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_erc20tokenbalance_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [Erc20TokenBalance](_entities_erc20tokenbalance_.erc20tokenbalance.md) | undefined - -___ +* \[ **key**: _string_\]: [Erc20TokenBalance](_entities_erc20tokenbalance_.erc20tokenbalance.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) | constructor data for the entity | - -**Returns:** *EntityType* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) | constructor data for the entity | -___ +**Returns:** _EntityType_ -### fetch +### fetch -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -**Returns:** *Promise‹EntityType›* +**Returns:** _Promise‹EntityType›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_factory_.factory.md b/docs/api/classes/_entities_factories_factory_.factory.md index fd01aa3..6e6a34c 100644 --- a/docs/api/classes/_entities_factories_factory_.factory.md +++ b/docs/api/classes/_entities_factories_factory_.factory.md @@ -1,16 +1,14 @@ -# Class: Factory <**EntityType, T, U**> +# Factory -Factories are tasked with creating instances of their corresponding Entity and managing the internal cache for that Entity type. -So, for example, the Security Token Factory is tasked with fetching necessary data to instance a Security Token, -as well as fetching/refreshing the internal Security Token cache +Factories are tasked with creating instances of their corresponding Entity and managing the internal cache for that Entity type. So, for example, the Security Token Factory is tasked with fetching necessary data to instance a Security Token, as well as fetching/refreshing the internal Security Token cache ## Type parameters -▪ **EntityType**: *[Entity](_entities_entity_.entity.md)‹T›* +▪ **EntityType**: [_Entity_](_entities_entity_.entity.md)_‹T›_ -▪ **T**: *any* +▪ **T**: _any_ -▪ **U**: *any* +▪ **U**: _any_ ## Hierarchy @@ -51,123 +49,114 @@ as well as fetching/refreshing the internal Security Token cache ## Constructors -### constructor +### constructor -\+ **new Factory**(`eClass`: [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U›, `context`: [Context](_context_.context.md)): *[Factory](_entities_factories_factory_.factory.md)* ++ **new Factory**\(`eClass`: [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U›, `context`: [Context](_context_.context.md)\): [_Factory_](_entities_factories_factory_.factory.md) -*Defined in [src/entities/factories/Factory.ts:42](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L42)* +_Defined in_ [_src/entities/factories/Factory.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L42) Create a factory that can generate an entity **Parameters:** -Name | Type | ------- | ------ | -`eClass` | [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U› | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `eClass` | [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U› | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Factory](_entities_factories_factory_.factory.md)* +**Returns:** [_Factory_](_entities_factories_factory_.factory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹T, U›_ -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: EntityType | undefined - -___ +* \[ **key**: _string_\]: EntityType \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: T): *EntityType* +▸ **create**\(`uid`: string, `params`: T\): _EntityType_ -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | T | constructor data for the entity | - -**Returns:** *EntityType* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | T | constructor data for the entity | -___ +**Returns:** _EntityType_ -### fetch +### fetch -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -**Returns:** *Promise‹EntityType›* +**Returns:** _Promise‹EntityType›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹T›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹T›\): _Promise‹void›_ -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹T› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹T› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_investmentfactory_.investmentfactory.md b/docs/api/classes/_entities_factories_investmentfactory_.investmentfactory.md index 3c5cda2..8a462ae 100644 --- a/docs/api/classes/_entities_factories_investmentfactory_.investmentfactory.md +++ b/docs/api/classes/_entities_factories_investmentfactory_.investmentfactory.md @@ -1,4 +1,4 @@ -# Class: InvestmentFactory +# InvestmentFactory Factory generates information for an Investment entity @@ -29,138 +29,129 @@ Factory generates information for an Investment entity ## Constructors -### constructor +### constructor -\+ **new InvestmentFactory**(`context`: [Context](_context_.context.md)): *[InvestmentFactory](_entities_factories_investmentfactory_.investmentfactory.md)* ++ **new InvestmentFactory**\(`context`: [Context](_context_.context.md)\): [_InvestmentFactory_](_entities_factories_investmentfactory_.investmentfactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/InvestmentFactory.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/InvestmentFactory.ts#L106)* +_Defined in_ [_src/entities/factories/InvestmentFactory.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/InvestmentFactory.ts#L106) Create an instance of the Investment Factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[InvestmentFactory](_entities_factories_investmentfactory_.investmentfactory.md)* +**Returns:** [_InvestmentFactory_](_entities_factories_investmentfactory_.investmentfactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_investment_.params.md), [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_investment_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [Investment](_entities_investment_.investment.md) | undefined - -___ +* \[ **key**: _string_\]: [Investment](_entities_investment_.investment.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_investment_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_investment_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_investment_.params.md) | constructor data for the entity | - -**Returns:** *EntityType* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_investment_.params.md) | constructor data for the entity | -___ +**Returns:** _EntityType_ -### fetch +### fetch -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -**Returns:** *Promise‹EntityType›* +**Returns:** _Promise‹EntityType›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_simplestofactory_.simplestofactory.md b/docs/api/classes/_entities_factories_simplestofactory_.simplestofactory.md index 95198f4..170e7e0 100644 --- a/docs/api/classes/_entities_factories_simplestofactory_.simplestofactory.md +++ b/docs/api/classes/_entities_factories_simplestofactory_.simplestofactory.md @@ -1,4 +1,4 @@ -# Class: SimpleStoFactory +# SimpleStoFactory Factory generates information for a simple sto entity @@ -30,156 +30,145 @@ Factory generates information for a simple sto entity ## Constructors -### constructor +### constructor -\+ **new SimpleStoFactory**(`context`: [Context](_context_.context.md)): *[SimpleStoFactory](_entities_factories_simplestofactory_.simplestofactory.md)* ++ **new SimpleStoFactory**\(`context`: [Context](_context_.context.md)\): [_SimpleStoFactory_](_entities_factories_simplestofactory_.simplestofactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/SimpleStoFactory.ts:79](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L79)* +_Defined in_ [_src/entities/factories/SimpleStoFactory.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L79) Create an instance of the simple sto factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SimpleStoFactory](_entities_factories_simplestofactory_.simplestofactory.md)* +**Returns:** [_SimpleStoFactory_](_entities_factories_simplestofactory_.simplestofactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_simplesto_.params.md), [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_simplesto_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [SimpleSto](_entities_simplesto_.simplesto.md) | undefined - -___ +* \[ **key**: _string_\]: [SimpleSto](_entities_simplesto_.simplesto.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_simplesto_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_simplesto_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_simplesto_.params.md) | constructor data for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_simplesto_.params.md) | constructor data for the entity | -**Returns:** *EntityType* +**Returns:** _EntityType_ -___ +### fetch -### fetch +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* - -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹EntityType›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹EntityType›_ ### `Protected` generateProperties -▸ **generateProperties**(`uid`: string): *Promise‹object›* +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ -*Overrides void* +_Overrides void_ -*Defined in [src/entities/factories/SimpleStoFactory.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L12)* +_Defined in_ [_src/entities/factories/SimpleStoFactory.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L12) **Parameters:** -Name | Type | ------- | ------ | -`uid` | string | +| Name | Type | +| :--- | :--- | +| `uid` | string | -**Returns:** *Promise‹object›* +**Returns:** _Promise‹object›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md b/docs/api/classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md index 08ded55..a7f056e 100644 --- a/docs/api/classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md +++ b/docs/api/classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md @@ -1,4 +1,4 @@ -# Class: TaxWithholdingFactory +# TaxWithholdingFactory Factory generates information for a Tax Withholding entity @@ -29,138 +29,129 @@ Factory generates information for a Tax Withholding entity ## Constructors -### constructor +### constructor -\+ **new TaxWithholdingFactory**(`context`: [Context](_context_.context.md)): *[TaxWithholdingFactory](_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md)* ++ **new TaxWithholdingFactory**\(`context`: [Context](_context_.context.md)\): [_TaxWithholdingFactory_](_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/TaxWithholdingFactory.ts:71](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TaxWithholdingFactory.ts#L71)* +_Defined in_ [_src/entities/factories/TaxWithholdingFactory.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TaxWithholdingFactory.ts#L71) Create an instance of the Tax Withholding Factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TaxWithholdingFactory](_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md)* +**Returns:** [_TaxWithholdingFactory_](_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_taxwithholding_.params.md), [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_taxwithholding_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [TaxWithholding](_entities_taxwithholding_.taxwithholding.md) | undefined - -___ +* \[ **key**: _string_\]: [TaxWithholding](_entities_taxwithholding_.taxwithholding.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_taxwithholding_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_taxwithholding_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_taxwithholding_.params.md) | constructor data for the entity | - -**Returns:** *EntityType* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_taxwithholding_.params.md) | constructor data for the entity | -___ +**Returns:** _EntityType_ -### fetch +### fetch -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -**Returns:** *Promise‹EntityType›* +**Returns:** _Promise‹EntityType›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_tieredstofactory_.tieredstofactory.md b/docs/api/classes/_entities_factories_tieredstofactory_.tieredstofactory.md index 9298680..1a832d1 100644 --- a/docs/api/classes/_entities_factories_tieredstofactory_.tieredstofactory.md +++ b/docs/api/classes/_entities_factories_tieredstofactory_.tieredstofactory.md @@ -1,4 +1,4 @@ -# Class: TieredStoFactory +# TieredStoFactory Factory generates information for a tiered sto entity @@ -30,156 +30,145 @@ Factory generates information for a tiered sto entity ## Constructors -### constructor +### constructor -\+ **new TieredStoFactory**(`context`: [Context](_context_.context.md)): *[TieredStoFactory](_entities_factories_tieredstofactory_.tieredstofactory.md)* ++ **new TieredStoFactory**\(`context`: [Context](_context_.context.md)\): [_TieredStoFactory_](_entities_factories_tieredstofactory_.tieredstofactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/TieredStoFactory.ts:148](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L148)* +_Defined in_ [_src/entities/factories/TieredStoFactory.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L148) Create an instance of the tiered sto factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TieredStoFactory](_entities_factories_tieredstofactory_.tieredstofactory.md)* +**Returns:** [_TieredStoFactory_](_entities_factories_tieredstofactory_.tieredstofactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_tieredsto_.params.md), [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_tieredsto_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [TieredSto](_entities_tieredsto_.tieredsto.md) | undefined - -___ +* \[ **key**: _string_\]: [TieredSto](_entities_tieredsto_.tieredsto.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_tieredsto_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_tieredsto_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_tieredsto_.params.md) | constructor data for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_tieredsto_.params.md) | constructor data for the entity | -**Returns:** *EntityType* +**Returns:** _EntityType_ -___ +### fetch -### fetch +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* - -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹EntityType›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹EntityType›_ ### `Protected` generateProperties -▸ **generateProperties**(`uid`: string): *Promise‹object›* +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ -*Overrides void* +_Overrides void_ -*Defined in [src/entities/factories/TieredStoFactory.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L13)* +_Defined in_ [_src/entities/factories/TieredStoFactory.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L13) **Parameters:** -Name | Type | ------- | ------ | -`uid` | string | +| Name | Type | +| :--- | :--- | +| `uid` | string | -**Returns:** *Promise‹object›* +**Returns:** _Promise‹object›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md b/docs/api/classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md index f98dab5..54bea14 100644 --- a/docs/api/classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md +++ b/docs/api/classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md @@ -1,4 +1,4 @@ -# Class: TokenholderFactory +# TokenholderFactory Factory generates information for a Tokenholder entity @@ -29,138 +29,129 @@ Factory generates information for a Tokenholder entity ## Constructors -### constructor +### constructor -\+ **new TokenholderFactory**(`context`: [Context](_context_.context.md)): *[TokenholderFactory](_entities_factories_tokenholderfactory_.tokenholderfactory.md)* ++ **new TokenholderFactory**\(`context`: [Context](_context_.context.md)\): [_TokenholderFactory_](_entities_factories_tokenholderfactory_.tokenholderfactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/TokenholderFactory.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TokenholderFactory.ts#L61)* +_Defined in_ [_src/entities/factories/TokenholderFactory.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TokenholderFactory.ts#L61) Create an instance of the Tokenholder Factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TokenholderFactory](_entities_factories_tokenholderfactory_.tokenholderfactory.md)* +**Returns:** [_TokenholderFactory_](_entities_factories_tokenholderfactory_.tokenholderfactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_tokenholder_.params.md), [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_tokenholder_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [Tokenholder](_entities_tokenholder_.tokenholder.md) | undefined - -___ +* \[ **key**: _string_\]: [Tokenholder](_entities_tokenholder_.tokenholder.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_tokenholder_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_tokenholder_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_tokenholder_.params.md) | constructor data for the entity | - -**Returns:** *EntityType* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_tokenholder_.params.md) | constructor data for the entity | -___ +**Returns:** _EntityType_ -### fetch +### fetch -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -**Returns:** *Promise‹EntityType›* +**Returns:** _Promise‹EntityType›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_factories_walletfactory_.walletfactory.md b/docs/api/classes/_entities_factories_walletfactory_.walletfactory.md index 25ea124..b3a41ca 100644 --- a/docs/api/classes/_entities_factories_walletfactory_.walletfactory.md +++ b/docs/api/classes/_entities_factories_walletfactory_.walletfactory.md @@ -1,4 +1,4 @@ -# Class: WalletFactory +# WalletFactory Factory to generate properties for a wallet entity @@ -30,156 +30,145 @@ Factory to generate properties for a wallet entity ## Constructors -### constructor +### constructor -\+ **new WalletFactory**(`context`: [Context](_context_.context.md)): *[WalletFactory](_entities_factories_walletfactory_.walletfactory.md)* ++ **new WalletFactory**\(`context`: [Context](_context_.context.md)\): [_WalletFactory_](_entities_factories_walletfactory_.walletfactory.md) -*Overrides [Factory](_entities_factories_factory_.factory.md).[constructor](_entities_factories_factory_.factory.md#constructor)* +_Overrides_ [_Factory_](_entities_factories_factory_.factory.md)_._[_constructor_](_entities_factories_factory_.factory.md#constructor) -*Defined in [src/entities/factories/WalletFactory.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L15)* +_Defined in_ [_src/entities/factories/WalletFactory.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L15) Create a wallet factory **Parameters:** -Name | Type | ------- | ------ | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `context` | [Context](_context_.context.md) | -**Returns:** *[WalletFactory](_entities_factories_walletfactory_.walletfactory.md)* +**Returns:** [_WalletFactory_](_entities_factories_walletfactory_.walletfactory.md) ## Properties -### Entity +### Entity -• **Entity**: *[EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹[Params](../interfaces/_entities_wallet_.params.md), [UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md)›* +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_wallet_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md)_›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[Entity](_entities_factories_factory_.factory.md#entity)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_Entity_](_entities_factories_factory_.factory.md#entity) -*Defined in [src/entities/factories/Factory.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37)* +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) entity class that this Factory is in charge of generating and caching -___ +### cache -### cache +• **cache**: _object_ -• **cache**: *object* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_cache_](_entities_factories_factory_.factory.md#cache) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[cache](_entities_factories_factory_.factory.md#cache)* - -*Defined in [src/entities/factories/Factory.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28)* +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) #### Type declaration: -* \[ **key**: *string*\]: [Wallet](_entities_wallet_.wallet.md) | undefined - -___ +* \[ **key**: _string_\]: [Wallet](_entities_wallet_.wallet.md) \| undefined -### context +### context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[context](_entities_factories_factory_.factory.md#context)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_context_](_entities_factories_factory_.factory.md#context) -*Defined in [src/entities/factories/Factory.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32)* +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) ## Methods -### create +### create -▸ **create**(`uid`: string, `params`: [Params](../interfaces/_entities_wallet_.params.md)): *EntityType* +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_wallet_.params.md)\): _EntityType_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[create](_entities_factories_factory_.factory.md#create)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_create_](_entities_factories_factory_.factory.md#create) -*Defined in [src/entities/factories/Factory.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87)* +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) Get an entity from the cache. Creates it if it isn't cached, updates it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | [Params](../interfaces/_entities_wallet_.params.md) | constructor data for the entity | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_wallet_.params.md) | constructor data for the entity | -**Returns:** *EntityType* +**Returns:** _EntityType_ -___ +### fetch -### fetch +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ -▸ **fetch**(`uid`: string): *Promise‹EntityType›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_fetch_](_entities_factories_factory_.factory.md#fetch) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[fetch](_entities_factories_factory_.factory.md#fetch)* - -*Defined in [src/entities/factories/Factory.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57)* +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹EntityType›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹EntityType›_ ### `Protected` generateProperties -▸ **generateProperties**(`uid`: string): *Promise‹object›* +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ -*Overrides void* +_Overrides void_ -*Defined in [src/entities/factories/WalletFactory.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L9)* +_Defined in_ [_src/entities/factories/WalletFactory.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L9) **Parameters:** -Name | Type | ------- | ------ | -`uid` | string | +| Name | Type | +| :--- | :--- | +| `uid` | string | -**Returns:** *Promise‹object›* +**Returns:** _Promise‹object›_ -___ +### refresh -### refresh +▸ **refresh**\(`uid`: string\): _Promise‹void›_ -▸ **refresh**(`uid`: string): *Promise‹void›* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_refresh_](_entities_factories_factory_.factory.md#refresh) -*Inherited from [Factory](_entities_factories_factory_.factory.md).[refresh](_entities_factories_factory_.factory.md#refresh)* - -*Defined in [src/entities/factories/Factory.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108)* +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) Fetch the data for an entity and updates its properties **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | - -**Returns:** *Promise‹void›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | -___ +**Returns:** _Promise‹void›_ -### update +### update -▸ **update**(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›): *Promise‹void›* +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›\): _Promise‹void›_ -*Inherited from [Factory](_entities_factories_factory_.factory.md).[update](_entities_factories_factory_.factory.md#update)* +_Inherited from_ [_Factory_](_entities_factories_factory_.factory.md)_._[_update_](_entities_factories_factory_.factory.md#update) -*Defined in [src/entities/factories/Factory.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126)* +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) Update an entity's properties in place **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`uid` | string | unique identifier for the entity | -`params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | properties that should be updated | +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_entities_investment_.investment.md b/docs/api/classes/_entities_investment_.investment.md index ac1a977..7e5e9c3 100644 --- a/docs/api/classes/_entities_investment_.investment.md +++ b/docs/api/classes/_entities_investment_.investment.md @@ -1,4 +1,4 @@ -# Class: Investment +# Investment Used to manage an Investment in a Security Token Offering @@ -27,193 +27,167 @@ Used to manage an Investment in a Security Token Offering ### Methods -* [_refresh](_entities_investment_.investment.md#_refresh) +* [\_refresh](_entities_investment_.investment.md#_refresh) * [toPojo](_entities_investment_.investment.md#topojo) * [generateId](_entities_investment_.investment.md#static-generateid) * [unserialize](_entities_investment_.investment.md#static-unserialize) ## Constructors -### constructor +### constructor -\+ **new Investment**(`params`: [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)): *[Investment](_entities_investment_.investment.md)* ++ **new Investment**\(`params`: [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)\): [_Investment_](_entities_investment_.investment.md) -*Defined in [src/entities/Investment.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103)* +_Defined in_ [_src/entities/Investment.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103) Create an Investment instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md) | -**Returns:** *[Investment](_entities_investment_.investment.md)* +**Returns:** [_Investment_](_entities_investment_.investment.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Investment.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L88)* +_Defined in_ [_src/entities/Investment.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L88) wallet address of token holder -___ +### index -### index +• **index**: _number_ -• **index**: *number* - -*Defined in [src/entities/Investment.ts:93](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L93)* +_Defined in_ [_src/entities/Investment.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L93) index of the Investment -___ - -### investedFunds +### investedFunds -• **investedFunds**: *BigNumber* +• **investedFunds**: _BigNumber_ -*Defined in [src/entities/Investment.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103)* +_Defined in_ [_src/entities/Investment.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103) amount of funds used to make Investment -___ - -### securityTokenId - -• **securityTokenId**: *string* - -*Defined in [src/entities/Investment.ts:76](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L76)* +### securityTokenId -___ +• **securityTokenId**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/Investment.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L76) -• **securityTokenSymbol**: *string* +### securityTokenSymbol -*Defined in [src/entities/Investment.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L83)* +• **securityTokenSymbol**: _string_ -___ +_Defined in_ [_src/entities/Investment.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L83) -### stoId +### stoId -• **stoId**: *string* +• **stoId**: _string_ -*Defined in [src/entities/Investment.ts:81](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L81)* +_Defined in_ [_src/entities/Investment.ts:81_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L81) unique ID for the Investment -___ +### tokenAmount -### tokenAmount +• **tokenAmount**: _BigNumber_ -• **tokenAmount**: *BigNumber* - -*Defined in [src/entities/Investment.ts:98](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L98)* +_Defined in_ [_src/entities/Investment.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L98) total amount of tokens involved in the Investment -___ - -### uid +### uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/Investment.ts:74](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L74)* +_Defined in_ [_src/entities/Investment.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L74) unique generated identifier for an Investment ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Investment.ts:165](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L165)* +_Defined in_ [_src/entities/Investment.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L165) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | -### toPojo +**Returns:** _void_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/Investment.ts:138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L138)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/Investment.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L138) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **address**: *string* +**Returns:** _object_ -* **index**: *number* - -* **investedFunds**: *BigNumber* - -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **stoId**: *string* - -* **tokenAmount**: *BigNumber* - -* **uid**: *string* - -___ +* **address**: _string_ +* **index**: _number_ +* **investedFunds**: _BigNumber_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **stoId**: _string_ +* **tokenAmount**: _BigNumber_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/Investment.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L45)* +_Defined in_ [_src/entities/Investment.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L45) Generate the Investment's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`index` | number | -`securityTokenId` | string | -`stoId` | string | +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | +| `stoId` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md) -*Defined in [src/entities/Investment.ts:58](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L58)* +_Defined in_ [_src/entities/Investment.ts:58_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L58) Unserialize a serialized Investment entity **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`serialized` | string | string with Investment entity information | +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with Investment entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_polytransaction_.polytransaction.md b/docs/api/classes/_entities_polytransaction_.polytransaction.md index 32595d4..5a754da 100644 --- a/docs/api/classes/_entities_polytransaction_.polytransaction.md +++ b/docs/api/classes/_entities_polytransaction_.polytransaction.md @@ -1,4 +1,4 @@ -# Class: PolyTransaction <**Args, Values**> +# PolyTransaction Wrapper class for a Polymath Transaction @@ -6,7 +6,7 @@ Wrapper class for a Polymath Transaction ▪ **Args** -▪ **Values**: *any[]* +▪ **Values**: _any\[\]_ ## Hierarchy @@ -34,7 +34,7 @@ Wrapper class for a Polymath Transaction ### Methods -* [_refresh](_entities_polytransaction_.polytransaction.md#_refresh) +* [\_refresh](_entities_polytransaction_.polytransaction.md#_refresh) * [onStatusChange](_entities_polytransaction_.polytransaction.md#onstatuschange) * [run](_entities_polytransaction_.polytransaction.md#run) * [toPojo](_entities_polytransaction_.polytransaction.md#topojo) @@ -42,207 +42,177 @@ Wrapper class for a Polymath Transaction ## Constructors -### constructor +### constructor -\+ **new PolyTransaction**(`transaction`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs | string›, `transactionQueue`: [TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹any, any›): *[PolyTransaction](_entities_polytransaction_.polytransaction.md)* ++ **new PolyTransaction**\(`transaction`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs \| string›, `transactionQueue`: [TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹any, any›\): [_PolyTransaction_](_entities_polytransaction_.polytransaction.md) -*Defined in [src/entities/PolyTransaction.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L114)* +_Defined in_ [_src/entities/PolyTransaction.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L114) Creates a poly transaction **Parameters:** -Name | Type | ------- | ------ | -`transaction` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs | string› | -`transactionQueue` | [TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹any, any› | +| Name | Type | +| :--- | :--- | +| `transaction` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs \| string› | +| `transactionQueue` | [TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹any, any› | -**Returns:** *[PolyTransaction](_entities_polytransaction_.polytransaction.md)* +**Returns:** [_PolyTransaction_](_entities_polytransaction_.polytransaction.md) ## Properties -### args +### args -• **args**: *TransactionSpec["args"]* +• **args**: _TransactionSpec\["args"\]_ -*Defined in [src/entities/PolyTransaction.ts:89](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L89)* +_Defined in_ [_src/entities/PolyTransaction.ts:89_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L89) arguments with which the transaction will be called -___ - ### `Optional` error -• **error**? : *[PolymathError](_polymatherror_.polymatherror.md)* - -*Defined in [src/entities/PolyTransaction.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L69)* +• **error**? : [_PolymathError_](_polymatherror_.polymatherror.md) -stores errors thrown while running the transaction (if any) +_Defined in_ [_src/entities/PolyTransaction.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L69) -___ +stores errors thrown while running the transaction \(if any\) -### promise +### promise -• **promise**: *Promise‹any›* +• **promise**: _Promise‹any›_ -*Defined in [src/entities/PolyTransaction.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L64)* +_Defined in_ [_src/entities/PolyTransaction.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L64) internal promise that resolves when the transaction has finished running -___ - ### `Optional` receipt -• **receipt**? : *TransactionReceiptWithDecodedLogs | string* +• **receipt**? : _TransactionReceiptWithDecodedLogs \| string_ -*Defined in [src/entities/PolyTransaction.ts:74](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L74)* +_Defined in_ [_src/entities/PolyTransaction.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L74) -stores the transaction receipt (if successful) +stores the transaction receipt \(if successful\) -___ +### status -### status +• **status**: [_TransactionStatus_](../enums/_types_index_.transactionstatus.md) = TransactionStatus.Idle -• **status**: *[TransactionStatus](../enums/_types_index_.transactionstatus.md)* = TransactionStatus.Idle - -*Defined in [src/entities/PolyTransaction.ts:54](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L54)* +_Defined in_ [_src/entities/PolyTransaction.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L54) current status of the transaction -___ - -### tag +### tag -• **tag**: *[PolyTransactionTag](../enums/_types_index_.polytransactiontag.md)* +• **tag**: [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) -*Defined in [src/entities/PolyTransaction.ts:79](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L79)* +_Defined in_ [_src/entities/PolyTransaction.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L79) type of transaction represented by this instance for display purposes -___ +### transactionQueue -### transactionQueue +• **transactionQueue**: [_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md) -• **transactionQueue**: *[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)* - -*Defined in [src/entities/PolyTransaction.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L59)* +_Defined in_ [_src/entities/PolyTransaction.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L59) transaction queue to which this transaction belongs -___ - ### `Optional` txHash -• **txHash**? : *undefined | string* - -*Defined in [src/entities/PolyTransaction.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L84)* +• **txHash**? : _undefined \| string_ -transaction hash (available after running) +_Defined in_ [_src/entities/PolyTransaction.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L84) -___ +transaction hash \(available after running\) -### uid +### uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/PolyTransaction.ts:49](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L49)* +_Defined in_ [_src/entities/PolyTransaction.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L49) unique generated identifier of the poly transaction ## Methods -### _refresh +### \_refresh -▸ **_refresh**(): *void* +▸ **\_refresh**\(\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/PolyTransaction.ts:330](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L330)* +_Defined in_ [_src/entities/PolyTransaction.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L330) Hydrate the entity -**Returns:** *void* +**Returns:** _void_ -___ +### onStatusChange -### onStatusChange +▸ **onStatusChange**\(`listener`: function\): _\(Anonymous function\)_ -▸ **onStatusChange**(`listener`: function): *(Anonymous function)* - -*Defined in [src/entities/PolyTransaction.ts:203](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L203)* +_Defined in_ [_src/entities/PolyTransaction.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L203) Subscribe to status changes **Parameters:** -▪ **listener**: *function* +▪ **listener**: _function_ callback function that will be called whenever the status changes -▸ (`transaction`: this): *void* +▸ \(`transaction`: this\): _void_ **Parameters:** -Name | Type | ------- | ------ | -`transaction` | this | +| Name | Type | +| :--- | :--- | +| `transaction` | this | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ unsubscribe function -___ - -### run +### run -▸ **run**(): *Promise‹void›* +▸ **run**\(\): _Promise‹void›_ -*Defined in [src/entities/PolyTransaction.ts:171](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L171)* +_Defined in_ [_src/entities/PolyTransaction.ts:171_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L171) Run the poly transaction and update the transaction status -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ -___ +### toPojo -### toPojo +▸ **toPojo**\(\): _object_ -▸ **toPojo**(): *object* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +_Defined in_ [_src/entities/PolyTransaction.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L144) -*Defined in [src/entities/PolyTransaction.ts:144](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L144)* +Convert entity to a POJO \(Plain Old Javascript Object\) -Convert entity to a POJO (Plain Old Javascript Object) +**Returns:** _object_ -**Returns:** *object* - -* **args**: *any* = filteredArgs as any - -* **error**: *undefined | [PolymathError](_polymatherror_.polymatherror.md)* - -* **receipt**: *undefined | string | TransactionReceiptWithDecodedLogs* - -* **status**: *[TransactionStatus](../enums/_types_index_.transactionstatus.md)* - -* **tag**: *[PolyTransactionTag](../enums/_types_index_.polytransactiontag.md)* - -* **transactionQueueUid**: *string* - -* **txHash**: *undefined | string* - -* **uid**: *string* - -___ +* **args**: _any_ = filteredArgs as any +* **error**: _undefined \|_ [_PolymathError_](_polymatherror_.polymatherror.md) +* **receipt**: _undefined \| string \| TransactionReceiptWithDecodedLogs_ +* **status**: [_TransactionStatus_](../enums/_types_index_.transactionstatus.md) +* **tag**: [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) +* **transactionQueueUid**: _string_ +* **txHash**: _undefined \| string_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(): *string* +▸ **generateId**\(\): _string_ -*Defined in [src/entities/PolyTransaction.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L40)* +_Defined in_ [_src/entities/PolyTransaction.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L40) Generate the Poly Transaction's UUID from its identifying properties -**Returns:** *string* +**Returns:** _string_ + diff --git a/docs/api/classes/_entities_securitytoken_controller_.controller.md b/docs/api/classes/_entities_securitytoken_controller_.controller.md index 42354ae..bf8ed5f 100644 --- a/docs/api/classes/_entities_securitytoken_controller_.controller.md +++ b/docs/api/classes/_entities_securitytoken_controller_.controller.md @@ -1,4 +1,4 @@ -# Class: Controller +# Controller Namespace that handles all Controller related functionality @@ -29,143 +29,131 @@ Namespace that handles all Controller related functionality ## Constructors -### constructor +### constructor -\+ **new Controller**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Controller](_entities_securitytoken_controller_.controller.md)* ++ **new Controller**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Controller_](_entities_securitytoken_controller_.controller.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Controller](_entities_securitytoken_controller_.controller.md)* +**Returns:** [_Controller_](_entities_securitytoken_controller_.controller.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### disable +### disable -▸ **disable**(`args?`: undefined | object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md), void››* +▸ **disable**\(`args?`: undefined \| object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Controller.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L33)* +_Defined in_ [_src/entities/SecurityToken/Controller.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L33) Permanently disable controller functionality **Parameters:** -Name | Type | ------- | ------ | -`args?` | undefined | object | - -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md)_, void››_ -### modifyController +### modifyController -▸ **modifyController**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md), void››* +▸ **modifyController**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Controller.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L20)* +_Defined in_ [_src/entities/SecurityToken/Controller.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L20) Set the address of the Security Token's Controller. The controller may perform forced transfers **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`controller` | string | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `controller` | string | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md)_, void››_ -### redeem +### redeem -▸ **redeem**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md), void››* +▸ **redeem**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Controller.ts:77](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L77)* +_Defined in_ [_src/entities/SecurityToken/Controller.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L77) -Redeem (burn) an amount of tokens from a token holder. Only the Security Token's controller can call this -This operation is subject to transfer restrictions and the amount is limited by the token holder's balance. -`balanceOf(tokenHolder)` tokens) and potentially also need to respect other transfer restrictions. +Redeem \(burn\) an amount of tokens from a token holder. Only the Security Token's controller can call this This operation is subject to transfer restrictions and the amount is limited by the token holder's balance. `balanceOf(tokenHolder)` tokens\) and potentially also need to respect other transfer restrictions. **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`amount` | BigNumber | -`data?` | undefined | string | -`from` | string | -`reason?` | undefined | string | +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from` | string | +| `reason?` | undefined \| string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md)_, void››_ -___ +### signDisableAck -### signDisableAck +▸ **signDisableAck**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)_, void››_ -▸ **signDisableAck**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Controller.ts:95](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L95)* +_Defined in_ [_src/entities/SecurityToken/Controller.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L95) Generate a signature string that can be used to permanently disable the Security Token's controller functionality **Note that only the owner's signature is valid for this operation** -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)_, void››_ -### transfer +### transfer -▸ **transfer**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md), void››* +▸ **transfer**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Controller.ts:49](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L49)* +_Defined in_ [_src/entities/SecurityToken/Controller.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L49) -Perform a forced transfer of tokens from one address to another. You must be the -Security Token's controller to do this +Perform a forced transfer of tokens from one address to another. You must be the Security Token's controller to do this **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from` | string | +| `reason?` | undefined \| string | +| `to` | string | -Name | Type | ------- | ------ | -`amount` | BigNumber | -`data?` | undefined | string | -`from` | string | -`reason?` | undefined | string | -`to` | string | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md), void››* diff --git a/docs/api/classes/_entities_securitytoken_dividends_.dividends.md b/docs/api/classes/_entities_securitytoken_dividends_.dividends.md index 5201c52..895414d 100644 --- a/docs/api/classes/_entities_securitytoken_dividends_.dividends.md +++ b/docs/api/classes/_entities_securitytoken_dividends_.dividends.md @@ -1,4 +1,4 @@ -# Class: Dividends +# Dividends Namespace that handles all Dividend related functionality @@ -33,216 +33,199 @@ Namespace that handles all Dividend related functionality ## Constructors -### constructor +### constructor -\+ **new Dividends**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Dividends](_entities_securitytoken_dividends_.dividends.md)* ++ **new Dividends**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Dividends_](_entities_securitytoken_dividends_.dividends.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Dividends](_entities_securitytoken_dividends_.dividends.md)* +**Returns:** [_Dividends_](_entities_securitytoken_dividends_.dividends.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### createErc20Distribution +### createErc20Distribution -▸ **createErc20Distribution**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), [DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)››* +▸ **createErc20Distribution**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_››_ -*Defined in [src/entities/SecurityToken/Dividends.ts:79](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L79)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L79) Distribute dividends in a specified ERC20 token **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`amount` | BigNumber | -`checkpointId` | string | -`erc20Address` | string | -`excludedAddresses?` | string[] | -`expiryDate` | Date | -`maturityDate` | Date | -`name` | string | -`taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)[] | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), [DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)››* +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `checkpointId` | string | +| `erc20Address` | string | +| `excludedAddresses?` | string\[\] | +| `expiryDate` | Date | +| `maturityDate` | Date | +| `name` | string | +| `taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_››_ -### createPolyDistribution +### createPolyDistribution -▸ **createPolyDistribution**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), [DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)››* +▸ **createPolyDistribution**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_››_ -*Defined in [src/entities/SecurityToken/Dividends.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L40)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L40) Distribute dividends in POLY **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`amount` | BigNumber | -`checkpointId` | string | -`excludedAddresses?` | string[] | -`expiryDate` | Date | -`maturityDate` | Date | -`name` | string | -`taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)[] | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), [DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)››* +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `checkpointId` | string | +| `excludedAddresses?` | string\[\] | +| `expiryDate` | Date | +| `maturityDate` | Date | +| `name` | string | +| `taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_››_ -### getDefaultExclusionList +### getDefaultExclusionList -▸ **getDefaultExclusionList**(): *Promise‹string[]›* +▸ **getDefaultExclusionList**\(\): _Promise‹string\[\]›_ -*Defined in [src/entities/SecurityToken/Dividends.ts:278](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L278)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:278_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L278) Retrieve the list of addresses which are excluded from receiving dividend payments by default -**Returns:** *Promise‹string[]›* +**Returns:** _Promise‹string\[\]›_ -___ +### getDistribution -### getDistribution +▸ **getDistribution**\(`args`: [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) \| string\): _Promise‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_›_ -▸ **getDistribution**(`args`: [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) | string): *Promise‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)›* - -*Defined in [src/entities/SecurityToken/Dividends.ts:254](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L254)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L254) Retrieve a particular dividend distribution by type and index or UUID **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`args` | [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) | string | dividend uuid or object containing its index | - -**Returns:** *Promise‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) \| string | dividend uuid or object containing its index | -___ +**Returns:** _Promise‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_›_ -### getDistributions +### getDistributions -▸ **getDistributions**(`args`: object): *Promise‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)[]›* +▸ **getDistributions**\(`args`: object\): _Promise‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_\[\]›_ -*Defined in [src/entities/SecurityToken/Dividends.ts:222](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L222)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L222) Retrieve all dividend distributions at a certain checkpoint **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`checkpointId` | string | +| Name | Type | +| :--- | :--- | +| `checkpointId` | string | -**Returns:** *Promise‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)[]›* +**Returns:** _Promise‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_\[\]›_ -___ +### getTaxWithholdingList -### getTaxWithholdingList +▸ **getTaxWithholdingList**\(\): _Promise‹_[_TaxWithholding_](_entities_taxwithholding_.taxwithholding.md)_\[\]›_ -▸ **getTaxWithholdingList**(): *Promise‹[TaxWithholding](_entities_taxwithholding_.taxwithholding.md)[]›* - -*Defined in [src/entities/SecurityToken/Dividends.ts:169](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L169)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:169_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L169) Retrieve a list of investor addresses and their corresponding tax withholding percentages -**Returns:** *Promise‹[TaxWithholding](_entities_taxwithholding_.taxwithholding.md)[]›* - -___ +**Returns:** _Promise‹_[_TaxWithholding_](_entities_taxwithholding_.taxwithholding.md)_\[\]›_ -### modifyDefaultExclusionList +### modifyDefaultExclusionList -▸ **modifyDefaultExclusionList**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md), void››* +▸ **modifyDefaultExclusionList**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Dividends.ts:152](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L152)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L152) Set default exclusion list for a type of dividends. Addresses on this list won't be considered for dividend distribution. This operation overrides the previous default exclusion list **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`tokenholderAddresses` | string[] | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `tokenholderAddresses` | string\[\] | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)_, void››_ -### modifyStorageWallet +### modifyStorageWallet -▸ **modifyStorageWallet**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md), void››* +▸ **modifyStorageWallet**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Dividends.ts:135](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L135)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L135) Change dividends storage wallet address **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`address` | string | +| Name | Type | +| :--- | :--- | +| `address` | string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md)_, void››_ -___ +### modifyTaxWithholdingList -### modifyTaxWithholdingList +▸ **modifyTaxWithholdingList**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)_, void››_ -▸ **modifyTaxWithholdingList**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Dividends.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L109)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L109) Set default tax withtholding list for a type of dividends **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `taxWithholdings` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | -Name | Type | ------- | ------ | -`taxWithholdings` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)[] | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md), void››* diff --git a/docs/api/classes/_entities_securitytoken_documents_.documents.md b/docs/api/classes/_entities_securitytoken_documents_.documents.md index 1dc38fd..05c4ef1 100644 --- a/docs/api/classes/_entities_securitytoken_documents_.documents.md +++ b/docs/api/classes/_entities_securitytoken_documents_.documents.md @@ -1,4 +1,4 @@ -# Class: Documents +# Documents Namespace that handles all document Related functionality @@ -28,115 +28,108 @@ Namespace that handles all document Related functionality ## Constructors -### constructor +### constructor -\+ **new Documents**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Documents](_entities_securitytoken_documents_.documents.md)* ++ **new Documents**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Documents_](_entities_securitytoken_documents_.documents.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Documents](_entities_securitytoken_documents_.documents.md)* +**Returns:** [_Documents_](_entities_securitytoken_documents_.documents.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### getAllDocuments +### getAllDocuments -▸ **getAllDocuments**(): *Promise‹[Document](../interfaces/_entities_securitytoken_documents_.document.md)[]›* +▸ **getAllDocuments**\(\): _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_\[\]›_ -*Defined in [src/entities/SecurityToken/Documents.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L90)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L90) Retrieve an array of all the documents attached to the security token -**Returns:** *Promise‹[Document](../interfaces/_entities_securitytoken_documents_.document.md)[]›* - -___ +**Returns:** _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_\[\]›_ -### getDocument +### getDocument -▸ **getDocument**(`args`: object): *Promise‹[Document](../interfaces/_entities_securitytoken_documents_.document.md)›* +▸ **getDocument**\(`args`: object\): _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_›_ -*Defined in [src/entities/SecurityToken/Documents.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L61)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L61) Retrieve a specific document's data by name **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`name` | string | +▪ **args**: _object_ -**Returns:** *Promise‹[Document](../interfaces/_entities_securitytoken_documents_.document.md)›* +| Name | Type | +| :--- | :--- | +| `name` | string | -___ +**Returns:** _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_›_ -### remove +### remove -▸ **remove**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md), void››* +▸ **remove**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Documents.ts:50](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L50)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L50) Remove an existing document from the Security Token **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | Description | ------- | ------ | ------ | -`name` | string | should always be unique | +| Name | Type | Description | +| :--- | :--- | :--- | +| `name` | string | should always be unique | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md)_, void››_ -___ +### set -### set +▸ **set**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md)_, void››_ -▸ **set**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Documents.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L37)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L37) Attach a new document to the contract, or update the URI or hash of an existing attached document **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | Description | +| :--- | :--- | :--- | +| `documentHash` | string | hash of the document's contents | +| `name` | string | should always be unique | +| `uri` | string | off-chain uri of the document from where it is accessible to investors/advisors to read | -Name | Type | Description | ------- | ------ | ------ | -`documentHash` | string | hash of the document's contents | -`name` | string | should always be unique | -`uri` | string | off-chain uri of the document from where it is accessible to investors/advisors to read | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md), void››* diff --git a/docs/api/classes/_entities_securitytoken_features_.features.md b/docs/api/classes/_entities_securitytoken_features_.features.md index 9c26aa0..f67a2c5 100644 --- a/docs/api/classes/_entities_securitytoken_features_.features.md +++ b/docs/api/classes/_entities_securitytoken_features_.features.md @@ -1,4 +1,4 @@ -# Class: Features +# Features Namespace that handles all Feature related functionality @@ -30,147 +30,130 @@ Namespace that handles all Feature related functionality ## Constructors -### constructor +### constructor -\+ **new Features**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Features](_entities_securitytoken_features_.features.md)* ++ **new Features**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Features_](_entities_securitytoken_features_.features.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Features](_entities_securitytoken_features_.features.md)* +**Returns:** [_Features_](_entities_securitytoken_features_.features.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) -___ +### list -### list +• **list**: [_Feature_](../enums/_types_index_.feature.md)_\[\]_ = \[ Feature.Permissions, Feature.Tokenholders, Feature.Dividends, Feature.TokenholderCountRestrictions, Feature.PercentageOwnershipRestrictions, \] -• **list**: *[Feature](../enums/_types_index_.feature.md)[]* = [ - Feature.Permissions, - Feature.Tokenholders, - Feature.Dividends, - Feature.TokenholderCountRestrictions, - Feature.PercentageOwnershipRestrictions, - ] - -*Defined in [src/entities/SecurityToken/Features.ts:80](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L80)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L80) List of all existing features -___ - ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### disable +### disable -▸ **disable**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md)››* +▸ **disable**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:213](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L213)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:213_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L213) Disable a feature **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [Feature](../enums/_types_index_.feature.md) | +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md)_››_ -___ +### enable -### enable +▸ **enable**\(`args`: object, `opts?`: [EnableOpts](../external-modules/_entities_securitytoken_features_.md#enableopts)\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_›_ -▸ **enable**(`args`: object, `opts?`: [EnableOpts](../modules/_entities_securitytoken_features_.md#enableopts)): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)›* - -*Defined in [src/entities/SecurityToken/Features.ts:138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L138)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L138) Enable a feature **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`feature` | [Feature](../enums/_types_index_.feature.md) | +▪ **args**: _object_ -▪`Optional` **opts**: *[EnableOpts](../modules/_entities_securitytoken_features_.md#enableopts)* +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)›* +▪`Optional` **opts**: [_EnableOpts_](../external-modules/_entities_securitytoken_features_.md#enableopts) -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_›_ ### `Private` getModuleNameFromFeature -▸ **getModuleNameFromFeature**(`feature`: [Feature](../enums/_types_index_.feature.md)): *ModuleName* +▸ **getModuleNameFromFeature**\(`feature`: [Feature](../enums/_types_index_.feature.md)\): _ModuleName_ -*Defined in [src/entities/SecurityToken/Features.ts:240](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L240)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L240) **Parameters:** -Name | Type | ------- | ------ | -`feature` | [Feature](../enums/_types_index_.feature.md) | +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | -**Returns:** *ModuleName* +**Returns:** _ModuleName_ -___ +### getStatus -### getStatus +▸ **getStatus**\(\): _Promise‹_[_FeatureStatuses_](../interfaces/_entities_securitytoken_features_.featurestatuses.md)_›_ -▸ **getStatus**(): *Promise‹[FeatureStatuses](../interfaces/_entities_securitytoken_features_.featurestatuses.md)›* +_Defined in_ [_src/entities/SecurityToken/Features.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L111) -*Defined in [src/entities/SecurityToken/Features.ts:111](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L111)* +Gets the status on all Security Token features \(true = enabled, false = not enabled/disabled\) -Gets the status on all Security Token features (true = enabled, false = not enabled/disabled) +**Returns:** _Promise‹_[_FeatureStatuses_](../interfaces/_entities_securitytoken_features_.featurestatuses.md)_›_ -**Returns:** *Promise‹[FeatureStatuses](../interfaces/_entities_securitytoken_features_.featurestatuses.md)›* +### isEnabled -___ +▸ **isEnabled**\(`args`: object\): _Promise‹boolean›_ -### isEnabled - -▸ **isEnabled**(`args`: object): *Promise‹boolean›* - -*Defined in [src/entities/SecurityToken/Features.ts:93](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L93)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L93) Returns whether a particular feature has been enabled or not **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | -Name | Type | ------- | ------ | -`feature` | [Feature](../enums/_types_index_.feature.md) | +**Returns:** _Promise‹boolean›_ -**Returns:** *Promise‹boolean›* diff --git a/docs/api/classes/_entities_securitytoken_issuance_issuance_.issuance.md b/docs/api/classes/_entities_securitytoken_issuance_issuance_.issuance.md index 5fb0c35..723a66e 100644 --- a/docs/api/classes/_entities_securitytoken_issuance_issuance_.issuance.md +++ b/docs/api/classes/_entities_securitytoken_issuance_issuance_.issuance.md @@ -1,4 +1,4 @@ -# Class: Issuance +# Issuance Namespace that handles all Issuance related functionality @@ -29,116 +29,104 @@ Namespace that handles all Issuance related functionality ## Constructors -### constructor +### constructor -\+ **new Issuance**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Issuance](_entities_securitytoken_issuance_issuance_.issuance.md)* ++ **new Issuance**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Issuance_](_entities_securitytoken_issuance_issuance_.issuance.md) -*Overrides [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Overrides_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14) Create a new Issuance instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Issuance](_entities_securitytoken_issuance_issuance_.issuance.md)* +**Returns:** [_Issuance_](_entities_securitytoken_issuance_issuance_.issuance.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) -___ +### offerings -### offerings +• **offerings**: [_Offerings_](_entities_securitytoken_issuance_offerings_.offerings.md) -• **offerings**: *[Offerings](_entities_securitytoken_issuance_offerings_.offerings.md)* - -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14)* - -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### allowed - -▸ **allowed**(): *Promise‹Boolean›* +### allowed -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:73](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L73)* +▸ **allowed**\(\): _Promise‹Boolean›_ -Retrieve whether the issuance of tokens is allowed or not -Can be permanently frozen with `freeze` +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L73) -**Returns:** *Promise‹Boolean›* +Retrieve whether the issuance of tokens is allowed or not Can be permanently frozen with `freeze` -___ +**Returns:** _Promise‹Boolean›_ -### freeze +### freeze -▸ **freeze**(`args?`: undefined | object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md), void››* +▸ **freeze**\(`args?`: undefined \| object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L48)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L48) Permanently freeze issuance of the security token **Parameters:** -Name | Type | ------- | ------ | -`args?` | undefined | object | +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md)_, void››_ -___ +### issue -### issue +▸ **issue**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -▸ **issue**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L32) -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L32)* - -Issue a certain amount of tokens to an address. The address must already have been added via `modifyData`. Otherwise, -the corresponding tokenholder data for that address must be supplied to this method -**NOTE: If tokenholder data is supplied, client-side validations to verify if the transfer is possible won't be performed** +Issue a certain amount of tokens to an address. The address must already have been added via `modifyData`. Otherwise, the corresponding tokenholder data for that address must be supplied to this method **NOTE: If tokenholder data is supplied, client-side validations to verify if the transfer is possible won't be performed** **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`issuanceData` | [IssuanceDataEntry](../interfaces/_types_index_.issuancedataentry.md)[] | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* +| Name | Type | +| :--- | :--- | +| `issuanceData` | [IssuanceDataEntry](../interfaces/_types_index_.issuancedataentry.md)\[\] | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -### signFreezeAck +### signFreezeAck -▸ **signFreezeAck**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md), void››* +▸ **signFreezeAck**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Issuance/Issuance.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L61)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L61) Generate a signature string that can be used to permanently freeze issuance of the Security Token **Note that only the owner's signature is valid for this operation** -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)_, void››_ + diff --git a/docs/api/classes/_entities_securitytoken_issuance_offerings_.offerings.md b/docs/api/classes/_entities_securitytoken_issuance_offerings_.offerings.md index 4219804..3866065 100644 --- a/docs/api/classes/_entities_securitytoken_issuance_offerings_.offerings.md +++ b/docs/api/classes/_entities_securitytoken_issuance_offerings_.offerings.md @@ -1,4 +1,4 @@ -# Class: Offerings +# Offerings Namespace that handles all Offering related functionality @@ -28,126 +28,117 @@ Namespace that handles all Offering related functionality ## Constructors -### constructor +### constructor -\+ **new Offerings**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Offerings](_entities_securitytoken_issuance_offerings_.offerings.md)* ++ **new Offerings**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Offerings_](_entities_securitytoken_issuance_offerings_.offerings.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Offerings](_entities_securitytoken_issuance_offerings_.offerings.md)* +**Returns:** [_Offerings_](_entities_securitytoken_issuance_offerings_.offerings.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### getSto +### getSto -▸ **getSto**(`args`: [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) | string): *Promise‹any›* +▸ **getSto**\(`args`: [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) \| string\): _Promise‹any›_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:223](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L223)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:223_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L223) Retrieve an STO by type and address or UUID **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`args` | [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) | string | STO uuid or object containing its type and address | - -**Returns:** *Promise‹any›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) \| string | STO uuid or object containing its type and address | -___ +**Returns:** _Promise‹any›_ -### getStos +### getStos -▸ **getStos**(`opts`: object): *Promise‹[SimpleSto](_entities_simplesto_.simplesto.md) | [TieredSto](_entities_tieredsto_.tieredsto.md)[]›* +▸ **getStos**\(`opts`: object\): _Promise‹_[_SimpleSto_](_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](_entities_tieredsto_.tieredsto.md)_\[\]›_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:260](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L260)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L260) Retrieve all STOs attached to a security token **Parameters:** -▪`Default value` **opts**: *object*= { - stoTypes: [StoType.Simple, StoType.Tiered], - } - -Name | Type | ------- | ------ | -`stoTypes` | [StoType](../enums/_types_index_.stotype.md)[] | +▪`Default value` **opts**: _object_= { stoTypes: \[StoType.Simple, StoType.Tiered\], } -**Returns:** *Promise‹[SimpleSto](_entities_simplesto_.simplesto.md) | [TieredSto](_entities_tieredsto_.tieredsto.md)[]›* +| Name | Type | +| :--- | :--- | +| `stoTypes` | [StoType](../enums/_types_index_.stotype.md)\[\] | -___ +**Returns:** _Promise‹_[_SimpleSto_](_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](_entities_tieredsto_.tieredsto.md)_\[\]›_ -### launchSimpleSto +### launchSimpleSto -▸ **launchSimpleSto**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), [SimpleSto](_entities_simplesto_.simplesto.md)››* +▸ **launchSimpleSto**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md)_,_ [_SimpleSto_](_entities_simplesto_.simplesto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:168](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L168)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L168) Launch a Simple STO **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`allowPreIssuance?` | undefined | false | true | -`currency` | Currency.ETH | Currency.POLY | -`endDate` | Date | -`raisedFundsWallet` | string | -`rate` | BigNumber | -`startDate` | Date | -`tokensOnSale` | BigNumber | -`unsoldTokensWallet` | string | +| Name | Type | +| :--- | :--- | +| `allowPreIssuance?` | undefined \| false \| true | +| `currency` | Currency.ETH \| Currency.POLY | +| `endDate` | Date | +| `raisedFundsWallet` | string | +| `rate` | BigNumber | +| `startDate` | Date | +| `tokensOnSale` | BigNumber | +| `unsoldTokensWallet` | string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), [SimpleSto](_entities_simplesto_.simplesto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md)_,_ [_SimpleSto_](_entities_simplesto_.simplesto.md)_››_ -___ +### launchTieredSto -### launchTieredSto +▸ **launchTieredSto**\(`args`: [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)\): _Promise‹any›_ -▸ **launchTieredSto**(`args`: [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)): *Promise‹any›* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:203](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L203)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L203) Launch a Tiered STO **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) | + +**Returns:** _Promise‹any›_ -**Returns:** *Promise‹any›* diff --git a/docs/api/classes/_entities_securitytoken_permissions_.permissions.md b/docs/api/classes/_entities_securitytoken_permissions_.permissions.md index 46e5ccb..ffa0e05 100644 --- a/docs/api/classes/_entities_securitytoken_permissions_.permissions.md +++ b/docs/api/classes/_entities_securitytoken_permissions_.permissions.md @@ -1,4 +1,4 @@ -# Class: Permissions +# Permissions Namespace that handles all Permissions related functionality @@ -36,221 +36,203 @@ Namespace that handles all Permissions related functionality ## Constructors -### constructor +### constructor -\+ **new Permissions**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Permissions](_entities_securitytoken_permissions_.permissions.md)* ++ **new Permissions**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Permissions_](_entities_securitytoken_permissions_.permissions.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Permissions](_entities_securitytoken_permissions_.permissions.md)* +**Returns:** [_Permissions_](_entities_securitytoken_permissions_.permissions.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### assignRole +### assignRole -▸ **assignRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), void››* +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Permissions.ts:95](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L95)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L95) Assign a role on the Security Token to a delegate **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`delegateAddress` | string | -`description` | string | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description` | string | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ -### getAllDelegates +### getAllDelegates -▸ **getAllDelegates**(): *Promise‹object[]›* +▸ **getAllDelegates**\(\): _Promise‹object\[\]›_ -*Defined in [src/entities/SecurityToken/Permissions.ts:242](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L242)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:242_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L242) Return a list of all delegates with their respective details and roles -**Returns:** *Promise‹object[]›* - -___ +**Returns:** _Promise‹object\[\]›_ -### getAssignedRoles +### getAssignedRoles -▸ **getAssignedRoles**(`args`: object): *Promise‹[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)[]›* +▸ **getAssignedRoles**\(`args`: object\): _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ -*Defined in [src/entities/SecurityToken/Permissions.ts:136](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L136)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L136) Return the list of roles assigned to a delegate address **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`delegateAddress` | string | +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | -**Returns:** *Promise‹[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)[]›* +**Returns:** _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ -___ +### getAvailableRoles -### getAvailableRoles +▸ **getAvailableRoles**\(\): _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ -▸ **getAvailableRoles**(): *Promise‹[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)[]›* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L25) -*Defined in [src/entities/SecurityToken/Permissions.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L25)* +Get a list of all available roles. The returned roles depend on which features are enabled, as per: -Get a list of all available roles. -The returned roles depend on which features are enabled, as per: - -| Feature | Roles | -|---------------------------------|-------------------------------------------------| -| Permissions | Permissions Administrator | -| Tokenholders | Tokenholders Administrator | -| Dividends | Dividends Administrator, Dividends Operator | -| TokenholderCountRestrictions | Tokenholder Count Restrictions Administrator | +| Feature | Roles | +| :--- | :--- | +| Permissions | Permissions Administrator | +| Tokenholders | Tokenholders Administrator | +| Dividends | Dividends Administrator, Dividends Operator | +| TokenholderCountRestrictions | Tokenholder Count Restrictions Administrator | | PercentageOwnershipRestrictions | Percentage Ownership Restrictions Administrator | -**Returns:** *Promise‹[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)[]›* - -___ +**Returns:** _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ -### getDelegatesForRole +### getDelegatesForRole -▸ **getDelegatesForRole**(`args`: object): *Promise‹object[]›* +▸ **getDelegatesForRole**\(`args`: object\): _Promise‹object\[\]›_ -*Defined in [src/entities/SecurityToken/Permissions.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L184)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L184) Return the list of delegate addresses and details that hold a specific role **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -**Returns:** *Promise‹object[]›* +**Returns:** _Promise‹object\[\]›_ -___ +### getFeatureFromRole -### getFeatureFromRole +▸ **getFeatureFromRole**\(`args`: object\): _Promise‹_[_Feature_](../enums/_types_index_.feature.md)_›_ -▸ **getFeatureFromRole**(`args`: object): *Promise‹[Feature](../enums/_types_index_.feature.md)›* - -*Defined in [src/entities/SecurityToken/Permissions.ts:65](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L65)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L65) Return which feature is associated with the supplied role **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +▪ **args**: _object_ -**Returns:** *Promise‹[Feature](../enums/_types_index_.feature.md)›* +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -___ +**Returns:** _Promise‹_[_Feature_](../enums/_types_index_.feature.md)_›_ -### isRoleAvailable +### isRoleAvailable -▸ **isRoleAvailable**(`args`: object): *Promise‹boolean›* +▸ **isRoleAvailable**\(`args`: object\): _Promise‹boolean›_ -*Defined in [src/entities/SecurityToken/Permissions.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L55)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L55) Return whether a certain role is available to be assigned to delegates **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -**Returns:** *Promise‹boolean›* +**Returns:** _Promise‹boolean›_ -___ +### revokeRole -### revokeRole +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ -▸ **revokeRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Permissions.ts:117](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L117)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:117_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L117) Remove a role from a delegate **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`delegateAddress` | string | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ ## Object literals -### rolesPerFeature +### rolesPerFeature + +### ▪ **rolesPerFeature**: _object_ -### ▪ **rolesPerFeature**: *object* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:279_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L279) -*Defined in [src/entities/SecurityToken/Permissions.ts:279](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L279)* +### \_\_computed -### __computed +• **\_\_computed**: [_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]_ = \[ SecurityTokenRole.PercentageOwnershipRestrictionsAdministrator, \] -• **__computed**: *[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)[]* = [ - SecurityTokenRole.PercentageOwnershipRestrictionsAdministrator, - ] +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:280_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L280) -*Defined in [src/entities/SecurityToken/Permissions.ts:280](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L280)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:281_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L281) -*Defined in [src/entities/SecurityToken/Permissions.ts:281](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L281)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:282_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L282) -*Defined in [src/entities/SecurityToken/Permissions.ts:282](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L282)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:286_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L286) -*Defined in [src/entities/SecurityToken/Permissions.ts:286](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L286)* +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L289) -*Defined in [src/entities/SecurityToken/Permissions.ts:289](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L289)* diff --git a/docs/api/classes/_entities_securitytoken_securitytoken_.securitytoken.md b/docs/api/classes/_entities_securitytoken_securitytoken_.securitytoken.md index 5c16857..9451de8 100644 --- a/docs/api/classes/_entities_securitytoken_securitytoken_.securitytoken.md +++ b/docs/api/classes/_entities_securitytoken_securitytoken_.securitytoken.md @@ -1,4 +1,4 @@ -# Class: SecurityToken +# SecurityToken Class used to manage all the Security Token functionality @@ -40,302 +40,247 @@ Class used to manage all the Security Token functionality ### Methods -* [_refresh](_entities_securitytoken_securitytoken_.securitytoken.md#_refresh) +* [\_refresh](_entities_securitytoken_securitytoken_.securitytoken.md#_refresh) * [toPojo](_entities_securitytoken_securitytoken_.securitytoken.md#topojo) * [transferOwnership](_entities_securitytoken_securitytoken_.securitytoken.md#transferownership) * [generateId](_entities_securitytoken_securitytoken_.securitytoken.md#static-generateid) ## Constructors -### constructor +### constructor -\+ **new SecurityToken**(`params`: [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* ++ **new SecurityToken**\(`params`: [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:153](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153) Create a new SecurityToken instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +**Returns:** [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L114)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L114) address that owns the Security Token -___ +### context -### context +• **context**: [_Context_](_context_.context.md) -• **context**: *[Context](_context_.context.md)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:153](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153)* +### controller -___ +• **controller**: [_Controller_](_entities_securitytoken_controller_.controller.md) -### controller +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L147) -• **controller**: *[Controller](_entities_securitytoken_controller_.controller.md)* +### currentCheckpoint -*Defined in [src/entities/SecurityToken/SecurityToken.ts:147](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L147)* +• **currentCheckpoint**: _number_ -___ - -### currentCheckpoint - -• **currentCheckpoint**: *number* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L130)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L130) index of the current checkpoint -___ - -### dividends - -• **dividends**: *[Dividends](_entities_securitytoken_dividends_.dividends.md)* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:141](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L141)* - -___ - -### documents - -• **documents**: *[Documents](_entities_securitytoken_documents_.documents.md)* +### dividends -*Defined in [src/entities/SecurityToken/SecurityToken.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L151)* +• **dividends**: [_Dividends_](_entities_securitytoken_dividends_.dividends.md) -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L141) -### features +### documents -• **features**: *[Features](_entities_securitytoken_features_.features.md)* +• **documents**: [_Documents_](_entities_securitytoken_documents_.documents.md) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L137)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L151) -___ +### features -### granularity +• **features**: [_Features_](_entities_securitytoken_features_.features.md) -• **granularity**: *number* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L137) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:123](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L123)* +### granularity -___ +• **granularity**: _number_ -### issuance +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:123_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L123) -• **issuance**: *[Issuance](_entities_securitytoken_issuance_issuance_.issuance.md)* +### issuance -*Defined in [src/entities/SecurityToken/SecurityToken.ts:143](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L143)* +• **issuance**: [_Issuance_](_entities_securitytoken_issuance_issuance_.issuance.md) -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L143) -### name +### name -• **name**: *string* +• **name**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L104)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L104) -___ +### owner -### owner +• **owner**: _string_ -• **owner**: *string* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L109)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L109) address of the Security Token contract -___ - -### permissions - -• **permissions**: *[Permissions](_entities_securitytoken_permissions_.permissions.md)* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:145](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L145)* +### permissions -___ +• **permissions**: [_Permissions_](_entities_securitytoken_permissions_.permissions.md) -### symbol +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L145) -• **symbol**: *string* +### symbol -*Defined in [src/entities/SecurityToken/SecurityToken.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L102)* +• **symbol**: _string_ -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L102) -### tokenDetails +### tokenDetails -• **tokenDetails**: *string* +• **tokenDetails**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:119](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L119)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:119_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L119) URL pointing to off-chain data associated with the Security Token -___ - -### tokenholders - -• **tokenholders**: *[Tokenholders](_entities_securitytoken_tokenholders_.tokenholders.md)* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:139](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L139)* - -___ +### tokenholders -### totalSupply +• **tokenholders**: [_Tokenholders_](_entities_securitytoken_tokenholders_.tokenholders.md) -• **totalSupply**: *BigNumber* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L139) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L125)* +### totalSupply -___ +• **totalSupply**: _BigNumber_ -### transfers +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L125) -• **transfers**: *[Transfers](_entities_securitytoken_transfers_transfers_.transfers.md)* +### transfers -*Defined in [src/entities/SecurityToken/SecurityToken.ts:149](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L149)* +• **transfers**: [_Transfers_](_entities_securitytoken_transfers_transfers_.transfers.md) -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L149) -### treasuryWallet +### treasuryWallet -• **treasuryWallet**: *string* +• **treasuryWallet**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:135](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L135)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L135) treasury wallet used by some features -___ +### uid -### uid +• **uid**: _string_ -• **uid**: *string* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:100_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L100) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:100](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L100)* +### version -___ +• **version**: _Version_ -### version - -• **version**: *Version* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:121](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L121)* - -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:121_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L121) ### `Static` unserialize -▪ **unserialize**: *unserialize* = unserialize +▪ **unserialize**: _unserialize_ = unserialize -*Defined in [src/entities/SecurityToken/SecurityToken.ts:98](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L98)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L98) ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:249](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L249)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L249) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)› | - -**Returns:** *void* - -___ - -### toPojo - -▸ **toPojo**(): *object* - -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:216](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L216)* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)› | -Convert entity to a POJO (Plain Old Javascript Object) +**Returns:** _void_ -**Returns:** *object* +### toPojo -* **address**: *string* +▸ **toPojo**\(\): _object_ -* **currentCheckpoint**: *number* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -* **granularity**: *number* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L216) -* **name**: *string* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **owner**: *string* +**Returns:** _object_ -* **symbol**: *string* +* **address**: _string_ +* **currentCheckpoint**: _number_ +* **granularity**: _number_ +* **name**: _string_ +* **owner**: _string_ +* **symbol**: _string_ +* **tokenDetails**: _string_ +* **totalSupply**: _BigNumber_ +* **treasuryWallet**: _string_ +* **uid**: _string_ +* **version**: _ContractVersion_ -* **tokenDetails**: *string* +### transferOwnership -* **totalSupply**: *BigNumber* +▸ **transferOwnership**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md)_, void››_ -* **treasuryWallet**: *string* - -* **uid**: *string* - -* **version**: *ContractVersion* - -___ - -### transferOwnership - -▸ **transferOwnership**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:202](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L202)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L202) Transfers ownership of the Security Token to a different wallet address **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`newOwner` | string | +| Name | Type | +| :--- | :--- | +| `newOwner` | string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md)_, void››_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L92)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L92) Generate the Security Token's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `symbol` | string | -Name | Type | ------- | ------ | -`symbol` | string | +**Returns:** _string_ -**Returns:** *string* diff --git a/docs/api/classes/_entities_securitytoken_submodule_.submodule.md b/docs/api/classes/_entities_securitytoken_submodule_.submodule.md index 57a5185..617c0b1 100644 --- a/docs/api/classes/_entities_securitytoken_submodule_.submodule.md +++ b/docs/api/classes/_entities_securitytoken_submodule_.submodule.md @@ -1,4 +1,4 @@ -# Class: SubModule +# SubModule Represents a namespace inside the Security Token that handles a set of related functionality @@ -43,35 +43,34 @@ Represents a namespace inside the Security Token that handles a set of related f ## Constructors -### constructor +### constructor -\+ **new SubModule**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[SubModule](_entities_securitytoken_submodule_.submodule.md)* ++ **new SubModule**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_SubModule_](_entities_securitytoken_submodule_.submodule.md) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SubModule](_entities_securitytoken_submodule_.submodule.md)* +**Returns:** [_SubModule_](_entities_securitytoken_submodule_.submodule.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* diff --git a/docs/api/classes/_entities_securitytoken_tokenholders_.tokenholders.md b/docs/api/classes/_entities_securitytoken_tokenholders_.tokenholders.md index 02f4ec4..2ee9e34 100644 --- a/docs/api/classes/_entities_securitytoken_tokenholders_.tokenholders.md +++ b/docs/api/classes/_entities_securitytoken_tokenholders_.tokenholders.md @@ -1,4 +1,4 @@ -# Class: Tokenholders +# Tokenholders Namespace that handles all Tokenholder related functionality @@ -32,160 +32,144 @@ Namespace that handles all Tokenholder related functionality ## Constructors -### constructor +### constructor -\+ **new Tokenholders**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Tokenholders](_entities_securitytoken_tokenholders_.tokenholders.md)* ++ **new Tokenholders**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Tokenholders_](_entities_securitytoken_tokenholders_.tokenholders.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Tokenholders](_entities_securitytoken_tokenholders_.tokenholders.md)* +**Returns:** [_Tokenholders_](_entities_securitytoken_tokenholders_.tokenholders.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### allTimeInvestorCount +### allTimeInvestorCount -▸ **allTimeInvestorCount**(): *Promise‹number›* +▸ **allTimeInvestorCount**\(\): _Promise‹number›_ -*Defined in [src/entities/SecurityToken/Tokenholders.ts:221](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L221)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L221) Retrieve the amount of wallets that ever held tokens or have any KYC data -**Returns:** *Promise‹number›* - -___ +**Returns:** _Promise‹number›_ -### createCheckpoint +### createCheckpoint -▸ **createCheckpoint**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), [Checkpoint](_entities_checkpoint_.checkpoint.md)››* +▸ **createCheckpoint**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md)_,_ [_Checkpoint_](_entities_checkpoint_.checkpoint.md)_››_ -*Defined in [src/entities/SecurityToken/Tokenholders.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L59)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L59) Create a snapshot of the balances of every tokenholder at the current date -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), [Checkpoint](_entities_checkpoint_.checkpoint.md)››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md)_,_ [_Checkpoint_](_entities_checkpoint_.checkpoint.md)_››_ -### getCheckpoint +### getCheckpoint -▸ **getCheckpoint**(`args`: [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) | string): *Promise‹[Checkpoint](_entities_checkpoint_.checkpoint.md)›* +▸ **getCheckpoint**\(`args`: [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) \| string\): _Promise‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_›_ -*Defined in [src/entities/SecurityToken/Tokenholders.ts:133](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L133)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:133_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L133) Retrieve a checkpoint from the security token by index or UUID **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`args` | [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) | string | checkpoint uuid or object containing its index | +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) \| string | checkpoint uuid or object containing its index | -**Returns:** *Promise‹[Checkpoint](_entities_checkpoint_.checkpoint.md)›* +**Returns:** _Promise‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_›_ -___ +### getCheckpoints -### getCheckpoints +▸ **getCheckpoints**\(\): _Promise‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_\[\]›_ -▸ **getCheckpoints**(): *Promise‹[Checkpoint](_entities_checkpoint_.checkpoint.md)[]›* - -*Defined in [src/entities/SecurityToken/Tokenholders.ts:74](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L74)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L74) Retrieve list of checkpoints and their corresponding dividend distributions of every type -**Returns:** *Promise‹[Checkpoint](_entities_checkpoint_.checkpoint.md)[]›* - -___ +**Returns:** _Promise‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_\[\]›_ -### getTokenholders +### getTokenholders -▸ **getTokenholders**(): *Promise‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[]›* +▸ **getTokenholders**\(\): _Promise‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]›_ -*Defined in [src/entities/SecurityToken/Tokenholders.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L155)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L155) Get data for all tokenholders associated to the Security Token -**Returns:** *Promise‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[]›* +**Returns:** _Promise‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]›_ -___ +### holderCount -### holderCount +▸ **holderCount**\(\): _Promise‹number›_ -▸ **holderCount**(): *Promise‹number›* - -*Defined in [src/entities/SecurityToken/Tokenholders.ts:247](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L247)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:247_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L247) Retrieve the amount of wallets that currently hold tokens -**Returns:** *Promise‹number›* - -___ +**Returns:** _Promise‹number›_ -### modifyData +### modifyData -▸ **modifyData**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* +▸ **modifyData**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -*Defined in [src/entities/SecurityToken/Tokenholders.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L31)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L31) -Add/modify investor data. For an investor to be able to hold, sell or purchase tokens, his address (and other KYC data) -must be added/modified via this method +Add/modify investor data. For an investor to be able to hold, sell or purchase tokens, his address \(and other KYC data\) must be added/modified via this method **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`tokenholderData` | [TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md)[] | +| Name | Type | +| :--- | :--- | +| `tokenholderData` | [TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md)\[\] | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -___ +### revokeKyc -### revokeKyc +▸ **revokeKyc**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -▸ **revokeKyc**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* - -*Defined in [src/entities/SecurityToken/Tokenholders.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L45)* +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L45) Revoke KYC for a group of tokenholder addresses. Supplied addresses must have valid KYC **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenholderAddresses` | string\[\] | -Name | Type | ------- | ------ | -`tokenholderAddresses` | string[] | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md)_,_ [_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\]››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]››* diff --git a/docs/api/classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md b/docs/api/classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md index 5ae53e1..c035ed3 100644 --- a/docs/api/classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md +++ b/docs/api/classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md @@ -1,4 +1,4 @@ -# Class: CountRestrictions +# CountRestrictions Namespace that handles all Count Restriction related functionality @@ -26,74 +26,70 @@ Namespace that handles all Count Restriction related functionality ## Constructors -### constructor +### constructor -\+ **new CountRestrictions**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[CountRestrictions](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md)* ++ **new CountRestrictions**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_CountRestrictions_](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[CountRestrictions](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md)* +**Returns:** [_CountRestrictions_](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### getMaxHolderCount - -▸ **getMaxHolderCount**(): *Promise‹number›* +### getMaxHolderCount -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L31)* +▸ **getMaxHolderCount**\(\): _Promise‹number›_ -Retrieve the maximum amonut of tokenholders allowed to hold the token at once -Can be modified with `modifyMaxHolderCount` +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L31) -**Returns:** *Promise‹number›* +Retrieve the maximum amonut of tokenholders allowed to hold the token at once Can be modified with `modifyMaxHolderCount` -___ +**Returns:** _Promise‹number›_ -### modifyMaxHolderCount +### modifyMaxHolderCount -▸ **modifyMaxHolderCount**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md), void››* +▸ **modifyMaxHolderCount**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:16](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L16)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L16) Modify the maximum amount of tokenholders allowed to hold the token at once **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `maxHolderCount` | number | -Name | Type | ------- | ------ | -`maxHolderCount` | number | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md), void››* diff --git a/docs/api/classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md b/docs/api/classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md index bbfb874..bd86a63 100644 --- a/docs/api/classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md +++ b/docs/api/classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md @@ -1,4 +1,4 @@ -# Class: PercentageRestrictions +# PercentageRestrictions Namespace that handles all Percentage Restriction related functionality @@ -28,112 +28,104 @@ Namespace that handles all Percentage Restriction related functionality ## Constructors -### constructor +### constructor -\+ **new PercentageRestrictions**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[PercentageRestrictions](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md)* ++ **new PercentageRestrictions**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_PercentageRestrictions_](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) Create a new SubModule instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[PercentageRestrictions](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md)* +**Returns:** [_PercentageRestrictions_](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* - -___ +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### getExemptions +### getExemptions -▸ **getExemptions**(): *Promise‹object›* +▸ **getExemptions**\(\): _Promise‹object›_ -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:66](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L66)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:66_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L66) -Retrieve all exemptions that currently apply to percentage restrictions. That includes the whitelist and whether primary issuance (minting) is allowed to bypass percentage ownership restrictions +Retrieve all exemptions that currently apply to percentage restrictions. That includes the whitelist and whether primary issuance \(minting\) is allowed to bypass percentage ownership restrictions Can be modified with `modifyPercentageExemptions` -**Returns:** *Promise‹object›* - -___ - -### getMaxHolderPercentage +**Returns:** _Promise‹object›_ -▸ **getMaxHolderPercentage**(): *Promise‹BigNumber›* +### getMaxHolderPercentage -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:139](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L139)* +▸ **getMaxHolderPercentage**\(\): _Promise‹BigNumber›_ -Retrieve the maximum percentage of the total supply that a single tokenholder can own -Can be modified with `modifyMaxHolderPercentage` +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L139) -**Returns:** *Promise‹BigNumber›* +Retrieve the maximum percentage of the total supply that a single tokenholder can own Can be modified with `modifyMaxHolderPercentage` -___ +**Returns:** _Promise‹BigNumber›_ -### modifyExemptions +### modifyExemptions -▸ **modifyExemptions**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md), void››* +▸ **modifyExemptions**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L47)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L47) -Modify the conditions for exemption from percentage ownership restrictions. There are two (independent) methods of exemption: +Modify the conditions for exemption from percentage ownership restrictions. There are two \(independent\) methods of exemption: -- Whitelisting: an address can be whitelisted and thus percentage ownership restrictions will not apply to it -- Primary issuance: if enabled, issuing tokens to an address will bypass percentage ownership restrictions (for example, if issuing tokens to a particular address would leave that address with a higher percentage than the limit, having this option set to `true` will allow that issuance operation) +* Whitelisting: an address can be whitelisted and thus percentage ownership restrictions will not apply to it +* Primary issuance: if enabled, issuing tokens to an address will bypass percentage ownership restrictions \(for example, if issuing tokens to a particular address would leave that address with a higher percentage than the limit, having this option set to `true` will allow that issuance operation\) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`allowPrimaryIssuance?` | undefined | false | true | -`whitelistEntries?` | [PercentageWhitelistEntry](../interfaces/_types_index_.percentagewhitelistentry.md)[] | +| Name | Type | +| :--- | :--- | +| `allowPrimaryIssuance?` | undefined \| false \| true | +| `whitelistEntries?` | [PercentageWhitelistEntry](../interfaces/_types_index_.percentagewhitelistentry.md)\[\] | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_, void››_ -___ +### modifyMaxHolderPercentage -### modifyMaxHolderPercentage +▸ **modifyMaxHolderPercentage**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)_, void››_ -▸ **modifyMaxHolderPercentage**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:124](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L124)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:124_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L124) Modify the maximum percentage of the total supply that a single tokenholder can own at a given time **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `maxHolderPercentage` | BigNumber | -Name | Type | ------- | ------ | -`maxHolderPercentage` | BigNumber | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md), void››* diff --git a/docs/api/classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md b/docs/api/classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md index 0e1b8dc..00d322f 100644 --- a/docs/api/classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md +++ b/docs/api/classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md @@ -1,4 +1,4 @@ -# Class: Restrictions +# Restrictions Namespace that handles all Transfer Restriction related functionality @@ -23,57 +23,52 @@ Namespace that handles all Transfer Restriction related functionality ## Constructors -### constructor +### constructor -\+ **new Restrictions**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Restrictions](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md)* ++ **new Restrictions**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Restrictions_](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) -*Overrides [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Overrides_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13) Create a new Restrictions instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Restrictions](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md)* +**Returns:** [_Restrictions_](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) -___ +### count -### count +• **count**: [_CountRestrictions_](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) -• **count**: *[CountRestrictions](_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L11) -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L11)* +### percentage -___ +• **percentage**: [_PercentageRestrictions_](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) -### percentage - -• **percentage**: *[PercentageRestrictions](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md)* - -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13)* - -___ +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* diff --git a/docs/api/classes/_entities_securitytoken_transfers_transfers_.transfers.md b/docs/api/classes/_entities_securitytoken_transfers_transfers_.transfers.md index 6d894fd..b1e4d99 100644 --- a/docs/api/classes/_entities_securitytoken_transfers_transfers_.transfers.md +++ b/docs/api/classes/_entities_securitytoken_transfers_transfers_.transfers.md @@ -1,4 +1,4 @@ -# Class: Transfers +# Transfers Namespace that handles all Transfer related functionality @@ -32,178 +32,161 @@ Namespace that handles all Transfer related functionality ## Constructors -### constructor +### constructor -\+ **new Transfers**(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)): *[Transfers](_entities_securitytoken_transfers_transfers_.transfers.md)* ++ **new Transfers**\(`securityToken`: [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](_context_.context.md)\): [_Transfers_](_entities_securitytoken_transfers_transfers_.transfers.md) -*Overrides [SubModule](_entities_securitytoken_submodule_.submodule.md).[constructor](_entities_securitytoken_submodule_.submodule.md#constructor)* +_Overrides_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](_entities_securitytoken_submodule_.submodule.md#constructor) -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21) Create a new Transfers instance **Parameters:** -Name | Type | ------- | ------ | -`securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Transfers](_entities_securitytoken_transfers_transfers_.transfers.md)* +**Returns:** [_Transfers_](_entities_securitytoken_transfers_transfers_.transfers.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[context](_entities_securitytoken_submodule_.submodule.md#protected-context)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_context_](_entities_securitytoken_submodule_.submodule.md#protected-context) -*Defined in [src/entities/SecurityToken/SubModule.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) -___ +### restrictions -### restrictions +• **restrictions**: [_Restrictions_](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) -• **restrictions**: *[Restrictions](_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md)* - -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21)* - -___ +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21) ### `Protected` securityToken -• **securityToken**: *[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)* +• **securityToken**: [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md) -*Inherited from [SubModule](_entities_securitytoken_submodule_.submodule.md).[securityToken](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)* +_Inherited from_ [_SubModule_](_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) -*Defined in [src/entities/SecurityToken/SubModule.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)* +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) ## Methods -### canTransfer +### canTransfer -▸ **canTransfer**(`args`: object): *Promise‹object›* +▸ **canTransfer**\(`args`: object\): _Promise‹object›_ -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L130)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L130) Validate if a transfer of Security Tokens can be performed. This takes all present transfer restrictions into account **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`data?` | undefined | string | -`from?` | undefined | string | -`to` | string | -`value` | BigNumber | +▪ **args**: _object_ -**Returns:** *Promise‹object›* +| Name | Type | +| :--- | :--- | +| `data?` | undefined \| string | +| `from?` | undefined \| string | +| `to` | string | +| `value` | BigNumber | -___ +**Returns:** _Promise‹object›_ -### freeze +### freeze -▸ **freeze**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), void››* +▸ **freeze**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L114)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L114) Freeze transfers of the security token -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), void››* - -___ - -### frozen +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ -▸ **frozen**(): *Promise‹boolean›* +### frozen -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:89](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L89)* +▸ **frozen**\(\): _Promise‹boolean›_ -Retrieve whether the transfer of tokens is frozen or not -Can be modified with `freeze` and `unfreeze` +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:89_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L89) -**Returns:** *Promise‹boolean›* +Retrieve whether the transfer of tokens is frozen or not Can be modified with `freeze` and `unfreeze` -___ +**Returns:** _Promise‹boolean›_ ### `Private` getStatusCode -▸ **getStatusCode**(`statusCode`: RawTransferStatusCode): *[TransferStatusCode](../enums/_types_index_.transferstatuscode.md)* +▸ **getStatusCode**\(`statusCode`: RawTransferStatusCode\): [_TransferStatusCode_](../enums/_types_index_.transferstatuscode.md) -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:168](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L168)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L168) **Parameters:** -Name | Type | ------- | ------ | -`statusCode` | RawTransferStatusCode | +| Name | Type | +| :--- | :--- | +| `statusCode` | RawTransferStatusCode | -**Returns:** *[TransferStatusCode](../enums/_types_index_.transferstatuscode.md)* +**Returns:** [_TransferStatusCode_](../enums/_types_index_.transferstatuscode.md) -___ +### signKycData -### signKycData +▸ **signKycData**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md)_, void››_ -▸ **signKycData**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L47)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L47) Generate a signature string based on dynamic KYC data. This data can be used to: -- Check if a transfer can be made (using `canTransfer`) with different KYC data than is currently present -- Actually make a transfer (using `transfer`) with different KYC data than is currently present (in this case, the existing KYC data will be overwritten) +* Check if a transfer can be made \(using `canTransfer`\) with different KYC data than is currently present +* Actually make a transfer \(using `transfer`\) with different KYC data than is currently present \(in this case, the existing KYC data will be overwritten\) -The signature can be generated by a third party other than the issuer. The signing wallet should have permission to modify KYC data (via the Tokenholders Administrator role) -Otherwise, the new data will be disregarded +The signature can be generated by a third party other than the issuer. The signing wallet should have permission to modify KYC data \(via the Tokenholders Administrator role\) Otherwise, the new data will be disregarded -**Note that, when supplying KYC data for signing, ALL investor entries should be supplied (even those that remain the same)** +**Note that, when supplying KYC data for signing, ALL investor entries should be supplied \(even those that remain the same\)** **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`kycData` | [Omit](../modules/_types_index_.md#omit)‹[Omit](../modules/_types_index_.md#omit)‹[TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md), "canBuyFromSto"›, "isAccredited"›[] | -`validFrom` | Date | -`validTo` | Date | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `kycData` | [Omit](../external-modules/_types_index_.md#omit)‹[Omit](../external-modules/_types_index_.md#omit)‹[TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md), "canBuyFromSto"›, "isAccredited"›\[\] | +| `validFrom` | Date | +| `validTo` | Date | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md)_, void››_ -### transfer +### transfer -▸ **transfer**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md), void››* +▸ **transfer**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)_, void››_ -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L72)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L72) Transfer an amount of Security Tokens to a specified address **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`amount` | BigNumber | -`data?` | undefined | string | -`from?` | undefined | string | -`to` | string | +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from?` | undefined \| string | +| `to` | string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)_, void››_ -___ +### unfreeze -### unfreeze +▸ **unfreeze**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ -▸ **unfreeze**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), void››* - -*Defined in [src/entities/SecurityToken/Transfers/Transfers.ts:201](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L201)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:201_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L201) Unfreeze transfers of the security token -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ + diff --git a/docs/api/classes/_entities_securitytokenreservation_.securitytokenreservation.md b/docs/api/classes/_entities_securitytokenreservation_.securitytokenreservation.md index 18ce56b..19348e0 100644 --- a/docs/api/classes/_entities_securitytokenreservation_.securitytokenreservation.md +++ b/docs/api/classes/_entities_securitytokenreservation_.securitytokenreservation.md @@ -1,4 +1,4 @@ -# Class: SecurityTokenReservation +# SecurityTokenReservation Class used to manage all the Security Token Reservation functionality @@ -26,7 +26,7 @@ Class used to manage all the Security Token Reservation functionality ### Methods -* [_refresh](_entities_securitytokenreservation_.securitytokenreservation.md#_refresh) +* [\_refresh](_entities_securitytokenreservation_.securitytokenreservation.md#_refresh) * [createSecurityToken](_entities_securitytokenreservation_.securitytokenreservation.md#createsecuritytoken) * [isLaunched](_entities_securitytokenreservation_.securitytokenreservation.md#islaunched) * [toPojo](_entities_securitytokenreservation_.securitytokenreservation.md#topojo) @@ -36,224 +36,196 @@ Class used to manage all the Security Token Reservation functionality ## Constructors -### constructor +### constructor -\+ **new SecurityTokenReservation**(`params`: [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)* ++ **new SecurityTokenReservation**\(`params`: [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md) -*Defined in [src/entities/SecurityTokenReservation.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92) Create a new SecurityTokenReservation instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)* +**Returns:** [_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md) ## Properties ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/entities/SecurityTokenReservation.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92) -___ +### expiry -### expiry +• **expiry**: _Date_ -• **expiry**: *Date* - -*Defined in [src/entities/SecurityTokenReservation.ts:75](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L75)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L75) Date at which this reservation expires -___ - -### ownerAddress +### ownerAddress -• **ownerAddress**: *string* +• **ownerAddress**: _string_ -*Defined in [src/entities/SecurityTokenReservation.ts:85](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L85)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:85_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L85) Address of the owner of the reservation -___ - -### reservedAt +### reservedAt -• **reservedAt**: *Date* +• **reservedAt**: _Date_ -*Defined in [src/entities/SecurityTokenReservation.ts:80](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L80)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L80) Date when the Security Token was reserved -___ - ### `Optional` securityTokenAddress -• **securityTokenAddress**? : *undefined | string* +• **securityTokenAddress**? : _undefined \| string_ -*Defined in [src/entities/SecurityTokenReservation.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L90)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L90) Address of the Security Token if it has already been launched, undefined if not -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/entities/SecurityTokenReservation.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L70)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L70) -___ +### uid -### uid +• **uid**: _string_ -• **uid**: *string* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* - -*Defined in [src/entities/SecurityTokenReservation.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L68)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L68) ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/SecurityTokenReservation.ts:167](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L167)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:167_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L167) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)› | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)› | -___ +**Returns:** _void_ -### createSecurityToken +### createSecurityToken -▸ **createSecurityToken**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)››* +▸ **createSecurityToken**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md)_,_ [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_››_ -*Defined in [src/entities/SecurityTokenReservation.ts:119](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L119)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:119_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L119) Creates a security token with the reserved symbol **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`detailsUrl?` | undefined | string | -`divisible` | boolean | -`name` | string | -`treasuryWallet?` | undefined | string | +| Name | Type | +| :--- | :--- | +| `detailsUrl?` | undefined \| string | +| `divisible` | boolean | +| `name` | string | +| `treasuryWallet?` | undefined \| string | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), [SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md)_,_ [_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_››_ -___ +### isLaunched -### isLaunched +▸ **isLaunched**\(\): _Promise‹boolean›_ -▸ **isLaunched**(): *Promise‹boolean›* - -*Defined in [src/entities/SecurityTokenReservation.ts:138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L138)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L138) Returns true if the Security Token associated to this reservation has already been launched -**Returns:** *Promise‹boolean›* - -___ +**Returns:** _Promise‹boolean›_ -### toPojo +### toPojo -▸ **toPojo**(): *object* +▸ **toPojo**\(\): _object_ -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -*Defined in [src/entities/SecurityTokenReservation.ts:158](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L158)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:158_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L158) -Convert entity to a POJO (Plain Old Javascript Object) +Convert entity to a POJO \(Plain Old Javascript Object\) -**Returns:** *object* +**Returns:** _object_ -* **expiry**: *Date* +* **expiry**: _Date_ +* **ownerAddress**: _string_ +* **reservedAt**: _Date_ +* **securityTokenAddress**: _undefined \| string_ +* **symbol**: _string_ +* **uid**: _string_ -* **ownerAddress**: *string* +### transferOwnership -* **reservedAt**: *Date* +▸ **transferOwnership**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)_, void››_ -* **securityTokenAddress**: *undefined | string* - -* **symbol**: *string* - -* **uid**: *string* - -___ - -### transferOwnership - -▸ **transferOwnership**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md), void››* - -*Defined in [src/entities/SecurityTokenReservation.ts:147](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L147)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L147) Transfer the ownership of the ticker **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`newOwner` | string | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `newOwner` | string | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)_, void››_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/SecurityTokenReservation.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L44)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L44) Generate the Security Token Reservation's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`symbol` | string | +| Name | Type | +| :--- | :--- | +| `symbol` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) -*Defined in [src/entities/SecurityTokenReservation.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L55)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L55) Unserialize string to a Security Token Reservation object representation **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_simplesto_.simplesto.md b/docs/api/classes/_entities_simplesto_.simplesto.md index a7d5c17..a92e36c 100644 --- a/docs/api/classes/_entities_simplesto_.simplesto.md +++ b/docs/api/classes/_entities_simplesto_.simplesto.md @@ -1,12 +1,12 @@ -# Class: SimpleSto +# SimpleSto Class used to manage a simple sto ## Hierarchy - ↳ [Sto](_entities_sto_.sto.md)‹[Params](../interfaces/_entities_simplesto_.params.md)› +↳ [Sto](_entities_sto_.sto.md)‹[Params](../interfaces/_entities_simplesto_.params.md)› - ↳ **SimpleSto** +↳ **SimpleSto** ## Index @@ -40,7 +40,7 @@ Class used to manage a simple sto ### Methods -* [_refresh](_entities_simplesto_.simplesto.md#_refresh) +* [\_refresh](_entities_simplesto_.simplesto.md#_refresh) * [allowBeneficialInvestments](_entities_simplesto_.simplesto.md#allowbeneficialinvestments) * [allowPreIssuing](_entities_simplesto_.simplesto.md#allowpreissuing) * [assignRole](_entities_simplesto_.simplesto.md#assignrole) @@ -58,520 +58,449 @@ Class used to manage a simple sto ## Constructors -### constructor +### constructor -\+ **new SimpleSto**(`params`: [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[SimpleSto](_entities_simplesto_.simplesto.md)* ++ **new SimpleSto**\(`params`: [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_SimpleSto_](_entities_simplesto_.simplesto.md) -*Overrides [Sto](_entities_sto_.sto.md).[constructor](_entities_sto_.sto.md#constructor)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_constructor_](_entities_sto_.sto.md#constructor) -*Defined in [src/entities/SimpleSto.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61)* +_Defined in_ [_src/entities/SimpleSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61) Create a new simple sto instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SimpleSto](_entities_simplesto_.simplesto.md)* +**Returns:** [_SimpleSto_](_entities_simplesto_.simplesto.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[address](_entities_sto_.sto.md#address)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_address_](_entities_sto_.sto.md#address) -*Defined in [src/entities/Sto.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107)* +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) ethereum address for the STO -___ +### beneficialInvestmentsAllowed -### beneficialInvestmentsAllowed +• **beneficialInvestmentsAllowed**: _boolean_ -• **beneficialInvestmentsAllowed**: *boolean* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_beneficialInvestmentsAllowed_](_entities_sto_.sto.md#beneficialinvestmentsallowed) -*Inherited from [Sto](_entities_sto_.sto.md).[beneficialInvestmentsAllowed](_entities_sto_.sto.md#beneficialinvestmentsallowed)* - -*Defined in [src/entities/Sto.ts:175](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175)* +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) whether investments can be made on behalf of a beneficiary or not -___ - -### cap +### cap -• **cap**: *BigNumber* +• **cap**: _BigNumber_ -*Defined in [src/entities/SimpleSto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L56)* +_Defined in_ [_src/entities/SimpleSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L56) cap of total tokens that can be sold in sto -___ - -### capReached +### capReached -• **capReached**: *boolean* +• **capReached**: _boolean_ -*Inherited from [Sto](_entities_sto_.sto.md).[capReached](_entities_sto_.sto.md#capreached)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_capReached_](_entities_sto_.sto.md#capreached) -*Defined in [src/entities/Sto.ts:160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160)* +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) whether the STO cap has been reached or not -___ - ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from [Sto](_entities_sto_.sto.md).[context](_entities_sto_.sto.md#protected-context)* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/entities/Sto.ts:177](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_context_](_entities_sto_.sto.md#protected-context) -___ +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) -### endDate +### endDate -• **endDate**: *Date* +• **endDate**: _Date_ -*Inherited from [Sto](_entities_sto_.sto.md).[endDate](_entities_sto_.sto.md#enddate)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_endDate_](_entities_sto_.sto.md#enddate) -*Defined in [src/entities/Sto.ts:120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120)* +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) -___ +### fundraiseCurrencies -### fundraiseCurrencies +• **fundraiseCurrencies**: _Currency\[\]_ -• **fundraiseCurrencies**: *Currency[]* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_fundraiseCurrencies_](_entities_sto_.sto.md#fundraisecurrencies) -*Inherited from [Sto](_entities_sto_.sto.md).[fundraiseCurrencies](_entities_sto_.sto.md#fundraisecurrencies)* - -*Defined in [src/entities/Sto.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150)* +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) types of currency in which funds can be raised -___ - -### investorCount +### investorCount -• **investorCount**: *number* +• **investorCount**: _number_ -*Inherited from [Sto](_entities_sto_.sto.md).[investorCount](_entities_sto_.sto.md#investorcount)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_investorCount_](_entities_sto_.sto.md#investorcount) -*Defined in [src/entities/Sto.ts:145](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145)* +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) number of investors that have purchased tokens in the STO -___ +### isFinalized -### isFinalized +• **isFinalized**: _boolean_ -• **isFinalized**: *boolean* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_isFinalized_](_entities_sto_.sto.md#isfinalized) -*Inherited from [Sto](_entities_sto_.sto.md).[isFinalized](_entities_sto_.sto.md#isfinalized)* - -*Defined in [src/entities/Sto.ts:165](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165)* +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) whether the STO has been finalized or not -___ - -### isPaused +### isPaused -• **isPaused**: *boolean* +• **isPaused**: _boolean_ -*Inherited from [Sto](_entities_sto_.sto.md).[isPaused](_entities_sto_.sto.md#ispaused)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_isPaused_](_entities_sto_.sto.md#ispaused) -*Defined in [src/entities/Sto.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155)* +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) whether the STO is currently paused or not -___ +### preIssueAllowed -### preIssueAllowed +• **preIssueAllowed**: _boolean_ -• **preIssueAllowed**: *boolean* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_preIssueAllowed_](_entities_sto_.sto.md#preissueallowed) -*Inherited from [Sto](_entities_sto_.sto.md).[preIssueAllowed](_entities_sto_.sto.md#preissueallowed)* - -*Defined in [src/entities/Sto.ts:170](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170)* +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made -___ - -### raisedAmount +### raisedAmount -• **raisedAmount**: *BigNumber* +• **raisedAmount**: _BigNumber_ -*Inherited from [Sto](_entities_sto_.sto.md).[raisedAmount](_entities_sto_.sto.md#raisedamount)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_raisedAmount_](_entities_sto_.sto.md#raisedamount) -*Defined in [src/entities/Sto.ts:135](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135)* +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) amount of funds that have been raised so far -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[raisedFundsWallet](_entities_sto_.sto.md#raisedfundswallet)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_raisedFundsWallet_](_entities_sto_.sto.md#raisedfundswallet) -*Defined in [src/entities/Sto.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125)* +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) wallet where raised funds will be forwarded to -___ +### rate -### rate +• **rate**: _BigNumber_ -• **rate**: *BigNumber* - -*Defined in [src/entities/SimpleSto.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61)* +_Defined in_ [_src/entities/SimpleSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61) rate at which the tokens will be sold in sto -___ - -### securityTokenId +### securityTokenId -• **securityTokenId**: *string* +• **securityTokenId**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[securityTokenId](_entities_sto_.sto.md#securitytokenid)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_securityTokenId_](_entities_sto_.sto.md#securitytokenid) -*Defined in [src/entities/Sto.ts:111](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111)* +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) -___ +### securityTokenSymbol -### securityTokenSymbol +• **securityTokenSymbol**: _string_ -• **securityTokenSymbol**: *string* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_securityTokenSymbol_](_entities_sto_.sto.md#securitytokensymbol) -*Inherited from [Sto](_entities_sto_.sto.md).[securityTokenSymbol](_entities_sto_.sto.md#securitytokensymbol)* +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) -*Defined in [src/entities/Sto.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109)* +### soldTokensAmount -___ +• **soldTokensAmount**: _BigNumber_ -### soldTokensAmount +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_soldTokensAmount_](_entities_sto_.sto.md#soldtokensamount) -• **soldTokensAmount**: *BigNumber* - -*Inherited from [Sto](_entities_sto_.sto.md).[soldTokensAmount](_entities_sto_.sto.md#soldtokensamount)* - -*Defined in [src/entities/Sto.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140)* +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) total number of tokens that have been sold so far -___ - -### startDate - -• **startDate**: *Date* +### startDate -*Inherited from [Sto](_entities_sto_.sto.md).[startDate](_entities_sto_.sto.md#startdate)* +• **startDate**: _Date_ -*Defined in [src/entities/Sto.ts:118](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_startDate_](_entities_sto_.sto.md#startdate) -___ +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) -### stoType +### stoType -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -*Inherited from [Sto](_entities_sto_.sto.md).[stoType](_entities_sto_.sto.md#stotype)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_stoType_](_entities_sto_.sto.md#stotype) -*Defined in [src/entities/Sto.ts:116](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116)* +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) type of STO setup -___ +### uid -### uid +• **uid**: _string_ -• **uid**: *string* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_uid_](_entities_sto_.sto.md#abstract-uid) -*Overrides [Sto](_entities_sto_.sto.md).[uid](_entities_sto_.sto.md#abstract-uid)* - -*Defined in [src/entities/SimpleSto.ts:51](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L51)* +_Defined in_ [_src/entities/SimpleSto.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L51) unique generated Tiered STO id -___ - -### unsoldTokensWallet +### unsoldTokensWallet -• **unsoldTokensWallet**: *string* +• **unsoldTokensWallet**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[unsoldTokensWallet](_entities_sto_.sto.md#unsoldtokenswallet)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_unsoldTokensWallet_](_entities_sto_.sto.md#unsoldtokenswallet) -*Defined in [src/entities/Sto.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130)* +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) wallet where unsold tokens will be returned to ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›\): _void_ -*Overrides [Sto](_entities_sto_.sto.md).[_refresh](_entities_sto_.sto.md#_refresh)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_\_refresh_](_entities_sto_.sto.md#_refresh) -*Defined in [src/entities/SimpleSto.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L151)* +_Defined in_ [_src/entities/SimpleSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L151) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | -___ +**Returns:** _void_ -### allowBeneficialInvestments +### allowBeneficialInvestments -▸ **allowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:316](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316)* +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) Enable a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ - -### allowPreIssuing +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **allowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +### allowPreIssuing -*Inherited from [Sto](_entities_sto_.sto.md)* +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:287](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -Enable all offered tokens to be issued instantly at STO start (default behavior is to issue on purchase) -Can be disabled *BEFORE* the STO starts by calling disallowPreIssuing +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -### assignRole +### assignRole -▸ **assignRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:348](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348)* +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) Assign a role on the STO to a delegate **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`delegateAddress` | string | -`description?` | undefined | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -___ +### disallowBeneficialInvestments -### disallowBeneficialInvestments +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **disallowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Inherited from [Sto](_entities_sto_.sto.md)* - -*Defined in [src/entities/Sto.ts:330](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330)* +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) Disable the possibility for a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ - -### disallowPreIssuing - -▸ **disallowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +### disallowPreIssuing -*Defined in [src/entities/Sto.ts:302](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302)* +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -Disable pre-issuing of offered tokens at STO start (goes back to default behavior, which is to issue on purchase) -Can be re-enabled *BEFORE* the STO starts by calling allowPreIssuing +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) -___ +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing -### finalize +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -▸ **finalize**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +### finalize -*Inherited from [Sto](_entities_sto_.sto.md)* +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:275](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -Finalize the offering. The offering's treasury wallet (or the Security Token's treasury wallet if one was not specified for the offering) -will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -### getInvestments +### getInvestments -▸ **getInvestments**(): *Promise‹[Investment](_entities_investment_.investment.md)[]›* +▸ **getInvestments**\(\): _Promise‹_[_Investment_](_entities_investment_.investment.md)_\[\]›_ -*Defined in [src/entities/SimpleSto.ts:81](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L81)* +_Defined in_ [_src/entities/SimpleSto.ts:81_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L81) Retrieve all investments that have been made on this STO -**Returns:** *Promise‹[Investment](_entities_investment_.investment.md)[]›* +**Returns:** _Promise‹_[_Investment_](_entities_investment_.investment.md)_\[\]›_ -___ +### invest -### invest +▸ **invest**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md)_, void››_ -▸ **invest**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md), void››* - -*Defined in [src/entities/SimpleSto.ts:126](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L126)* +_Defined in_ [_src/entities/SimpleSto.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L126) Invest in the STO **Parameters:** -▪ **args**: *object* - -Name | Type | Description | ------- | ------ | ------ | -`amount` | BigNumber | amount to spend | -`beneficiary?` | undefined | string | address that will receive the purchased tokens (defaults to current wallet, will fail if beneficial investments are not allowed for the STO, only applicable if the STO currency is ETH) | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md), void››* +| Name | Type | Description | +| :--- | :--- | :--- | +| `amount` | BigNumber | amount to spend | +| `beneficiary?` | undefined \| string | address that will receive the purchased tokens \(defaults to current wallet, will fail if beneficial investments are not allowed for the STO, only applicable if the STO currency is ETH\) | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md)_, void››_ -### pause +### pause -▸ **pause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:246](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246)* +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) Pause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -### revokeRole +### revokeRole -▸ **revokeRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:374](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374)* +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) Remove a role from a delegate **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`delegateAddress` | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | - -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▪ **args**: _object_ -___ +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -### toPojo +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Sto](_entities_sto_.sto.md).[toPojo](_entities_sto_.sto.md#topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/SimpleSto.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L137)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_toPojo_](_entities_sto_.sto.md#topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/SimpleSto.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L137) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **cap**: *BigNumber* +**Returns:** _object_ -* **rate**: *BigNumber* +* **cap**: _BigNumber_ +* **rate**: _BigNumber_ -___ +### unpause -### unpause +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -▸ **unpause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Inherited from [Sto](_entities_sto_.sto.md)* - -*Defined in [src/entities/Sto.ts:260](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260)* +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) Unpause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/SimpleSto.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L40)* +_Defined in_ [_src/entities/SimpleSto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L40) Generate the Simple STO's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`address` | string | -`securityTokenId` | string | -`stoType` | [StoType](../enums/_types_index_.stotype.md) | +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | +| `stoType` | [StoType](../enums/_types_index_.stotype.md) | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -*Inherited from [Sto](_entities_sto_.sto.md).[unserialize](_entities_sto_.sto.md#static-unserialize)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_unserialize_](_entities_sto_.sto.md#static-unserialize) -*Defined in [src/entities/Sto.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184)* +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) Unserialize string to a Security Token Offering object representation **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_sto_.sto.md b/docs/api/classes/_entities_sto_.sto.md index 1b3c073..8aa0933 100644 --- a/docs/api/classes/_entities_sto_.sto.md +++ b/docs/api/classes/_entities_sto_.sto.md @@ -1,4 +1,4 @@ -# Class: Sto <**P**> +# Sto Abstract class used as a base to manage sto functionalities @@ -46,7 +46,7 @@ Abstract class used as a base to manage sto functionalities ### Methods -* [_refresh](_entities_sto_.sto.md#_refresh) +* [\_refresh](_entities_sto_.sto.md#_refresh) * [allowBeneficialInvestments](_entities_sto_.sto.md#allowbeneficialinvestments) * [allowPreIssuing](_entities_sto_.sto.md#allowpreissuing) * [assignRole](_entities_sto_.sto.md#assignrole) @@ -61,417 +61,341 @@ Abstract class used as a base to manage sto functionalities ## Constructors -### constructor +### constructor -\+ **new Sto**(`params`: [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[Sto](_entities_sto_.sto.md)* ++ **new Sto**\(`params`: [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:195](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L195)* +_Defined in_ [_src/entities/Sto.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L195) Create a new sto instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Sto](_entities_sto_.sto.md)* +**Returns:** [_Sto_](_entities_sto_.sto.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Sto.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107)* +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) ethereum address for the STO -___ +### beneficialInvestmentsAllowed -### beneficialInvestmentsAllowed +• **beneficialInvestmentsAllowed**: _boolean_ -• **beneficialInvestmentsAllowed**: *boolean* - -*Defined in [src/entities/Sto.ts:175](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175)* +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) whether investments can be made on behalf of a beneficiary or not -___ - -### capReached +### capReached -• **capReached**: *boolean* +• **capReached**: _boolean_ -*Defined in [src/entities/Sto.ts:160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160)* +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) whether the STO cap has been reached or not -___ - ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/entities/Sto.ts:177](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177)* +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) -___ +### endDate -### endDate +• **endDate**: _Date_ -• **endDate**: *Date* +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) -*Defined in [src/entities/Sto.ts:120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120)* +### fundraiseCurrencies -___ +• **fundraiseCurrencies**: _Currency\[\]_ -### fundraiseCurrencies - -• **fundraiseCurrencies**: *Currency[]* - -*Defined in [src/entities/Sto.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150)* +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) types of currency in which funds can be raised -___ - -### investorCount +### investorCount -• **investorCount**: *number* +• **investorCount**: _number_ -*Defined in [src/entities/Sto.ts:145](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145)* +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) number of investors that have purchased tokens in the STO -___ +### isFinalized -### isFinalized +• **isFinalized**: _boolean_ -• **isFinalized**: *boolean* - -*Defined in [src/entities/Sto.ts:165](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165)* +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) whether the STO has been finalized or not -___ - -### isPaused +### isPaused -• **isPaused**: *boolean* +• **isPaused**: _boolean_ -*Defined in [src/entities/Sto.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155)* +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) whether the STO is currently paused or not -___ - -### preIssueAllowed +### preIssueAllowed -• **preIssueAllowed**: *boolean* +• **preIssueAllowed**: _boolean_ -*Defined in [src/entities/Sto.ts:170](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170)* +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made -___ +### raisedAmount -### raisedAmount +• **raisedAmount**: _BigNumber_ -• **raisedAmount**: *BigNumber* - -*Defined in [src/entities/Sto.ts:135](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135)* +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) amount of funds that have been raised so far -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Defined in [src/entities/Sto.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125)* +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) wallet where raised funds will be forwarded to -___ - -### securityTokenId +### securityTokenId -• **securityTokenId**: *string* +• **securityTokenId**: _string_ -*Defined in [src/entities/Sto.ts:111](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111)* +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) -___ +### securityTokenSymbol -### securityTokenSymbol +• **securityTokenSymbol**: _string_ -• **securityTokenSymbol**: *string* +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) -*Defined in [src/entities/Sto.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109)* +### soldTokensAmount -___ +• **soldTokensAmount**: _BigNumber_ -### soldTokensAmount - -• **soldTokensAmount**: *BigNumber* - -*Defined in [src/entities/Sto.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140)* +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) total number of tokens that have been sold so far -___ - -### startDate +### startDate -• **startDate**: *Date* +• **startDate**: _Date_ -*Defined in [src/entities/Sto.ts:118](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118)* +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) -___ +### stoType -### stoType +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* - -*Defined in [src/entities/Sto.ts:116](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116)* +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) type of STO setup -___ - ### `Abstract` uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/Sto.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L102)* +_Defined in_ [_src/entities/Sto.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L102) Uniquely generated id for the STO -___ - -### unsoldTokensWallet +### unsoldTokensWallet -• **unsoldTokensWallet**: *string* +• **unsoldTokensWallet**: _string_ -*Defined in [src/entities/Sto.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130)* +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) wallet where unsold tokens will be returned to ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_sto_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_sto_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Sto.ts:438](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L438)* +_Defined in_ [_src/entities/Sto.ts:438_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L438) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_sto_.params.md)› | +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_sto_.params.md)› | -**Returns:** *void* +**Returns:** _void_ -___ +### allowBeneficialInvestments -### allowBeneficialInvestments +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **allowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -*Defined in [src/entities/Sto.ts:316](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316)* +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) Enable a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ - -### allowPreIssuing +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **allowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +### allowPreIssuing -*Defined in [src/entities/Sto.ts:287](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287)* +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -Enable all offered tokens to be issued instantly at STO start (default behavior is to issue on purchase) -Can be disabled *BEFORE* the STO starts by calling disallowPreIssuing +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -### assignRole +### assignRole -▸ **assignRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:348](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348)* +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) Assign a role on the STO to a delegate **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`delegateAddress` | string | -`description?` | undefined | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -___ +### disallowBeneficialInvestments -### disallowBeneficialInvestments +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **disallowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -*Defined in [src/entities/Sto.ts:330](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330)* +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) Disable the possibility for a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -### disallowPreIssuing +### disallowPreIssuing -▸ **disallowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:302](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302)* +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) -Disable pre-issuing of offered tokens at STO start (goes back to default behavior, which is to issue on purchase) -Can be re-enabled *BEFORE* the STO starts by calling allowPreIssuing +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -___ +### finalize -### finalize +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -▸ **finalize**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) -*Defined in [src/entities/Sto.ts:275](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275)* +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens -Finalize the offering. The offering's treasury wallet (or the Security Token's treasury wallet if one was not specified for the offering) -will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +### pause -___ +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -### pause - -▸ **pause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -*Defined in [src/entities/Sto.ts:246](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246)* +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) Pause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -### revokeRole +### revokeRole -▸ **revokeRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:374](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374)* +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) Remove a role from a delegate **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`delegateAddress` | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | - -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* - -___ - -### toPojo - -▸ **toPojo**(): *object* - -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* - -*Defined in [src/entities/Sto.ts:393](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L393)* - -Convert entity to a POJO (Plain Old Javascript Object) - -**Returns:** *object* +▪ **args**: _object_ -* **address**: *string* +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -* **beneficialInvestmentsAllowed**: *boolean* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -* **capReached**: *boolean* +### toPojo -* **endDate**: *Date* +▸ **toPojo**\(\): _object_ -* **fundraiseCurrencies**: *FundRaiseType[]* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -* **investorCount**: *number* +_Defined in_ [_src/entities/Sto.ts:393_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L393) -* **isFinalized**: *boolean* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **isPaused**: *boolean* +**Returns:** _object_ -* **preIssueAllowed**: *boolean* +* **address**: _string_ +* **beneficialInvestmentsAllowed**: _boolean_ +* **capReached**: _boolean_ +* **endDate**: _Date_ +* **fundraiseCurrencies**: _FundRaiseType\[\]_ +* **investorCount**: _number_ +* **isFinalized**: _boolean_ +* **isPaused**: _boolean_ +* **preIssueAllowed**: _boolean_ +* **raisedAmount**: _BigNumber_ +* **raisedFundsWallet**: _string_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **soldTokensAmount**: _BigNumber_ +* **startDate**: _Date_ +* **uid**: _string_ +* **unsoldTokensWallet**: _string_ -* **raisedAmount**: *BigNumber* +### unpause -* **raisedFundsWallet**: *string* +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **soldTokensAmount**: *BigNumber* - -* **startDate**: *Date* - -* **uid**: *string* - -* **unsoldTokensWallet**: *string* - -___ - -### unpause - -▸ **unpause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -*Defined in [src/entities/Sto.ts:260](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260)* +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) Unpause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -*Defined in [src/entities/Sto.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184)* +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) Unserialize string to a Security Token Offering object representation **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_taxwithholding_.taxwithholding.md b/docs/api/classes/_entities_taxwithholding_.taxwithholding.md index 04deb8e..64ff1b2 100644 --- a/docs/api/classes/_entities_taxwithholding_.taxwithholding.md +++ b/docs/api/classes/_entities_taxwithholding_.taxwithholding.md @@ -1,4 +1,4 @@ -# Class: TaxWithholding +# TaxWithholding Represents the percentage that should be withheld from a Tokenholder's dividend payment for tax purposes @@ -24,154 +24,137 @@ Represents the percentage that should be withheld from a Tokenholder's dividend ### Methods -* [_refresh](_entities_taxwithholding_.taxwithholding.md#_refresh) +* [\_refresh](_entities_taxwithholding_.taxwithholding.md#_refresh) * [toPojo](_entities_taxwithholding_.taxwithholding.md#topojo) * [generateId](_entities_taxwithholding_.taxwithholding.md#static-generateid) * [unserialize](_entities_taxwithholding_.taxwithholding.md#static-unserialize) ## Constructors -### constructor +### constructor -\+ **new TaxWithholding**(`params`: [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)): *[TaxWithholding](_entities_taxwithholding_.taxwithholding.md)* ++ **new TaxWithholding**\(`params`: [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)\): [_TaxWithholding_](_entities_taxwithholding_.taxwithholding.md) -*Defined in [src/entities/TaxWithholding.ts:82](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82)* +_Defined in_ [_src/entities/TaxWithholding.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82) Create a new tax withholding instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) | -**Returns:** *[TaxWithholding](_entities_taxwithholding_.taxwithholding.md)* +**Returns:** [_TaxWithholding_](_entities_taxwithholding_.taxwithholding.md) ## Properties -### percentage +### percentage -• **percentage**: *number* +• **percentage**: _number_ -*Defined in [src/entities/TaxWithholding.ts:82](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82)* +_Defined in_ [_src/entities/TaxWithholding.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82) -percentage of tax to be withheld (0 to 1) +percentage of tax to be withheld \(0 to 1\) -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/TaxWithholding.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L75) -*Defined in [src/entities/TaxWithholding.ts:75](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L75)* +### securityTokenSymbol -___ +• **securityTokenSymbol**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/TaxWithholding.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L73) -• **securityTokenSymbol**: *string* +### tokenholderAddress -*Defined in [src/entities/TaxWithholding.ts:73](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L73)* +• **tokenholderAddress**: _string_ -___ +_Defined in_ [_src/entities/TaxWithholding.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L77) -### tokenholderAddress +### uid -• **tokenholderAddress**: *string* +• **uid**: _string_ -*Defined in [src/entities/TaxWithholding.ts:77](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L77)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -___ - -### uid - -• **uid**: *string* - -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* - -*Defined in [src/entities/TaxWithholding.ts:71](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L71)* +_Defined in_ [_src/entities/TaxWithholding.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L71) unique generated identifer for tax withholding entity ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/TaxWithholding.ts:120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L120)* +_Defined in_ [_src/entities/TaxWithholding.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L120) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | -### toPojo +**Returns:** _void_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/TaxWithholding.ts:105](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L105)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/TaxWithholding.ts:105_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L105) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **percentage**: *number* +**Returns:** _object_ -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **tokenholderAddress**: *string* - -* **uid**: *string* - -___ +* **percentage**: _number_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholderAddress**: _string_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/TaxWithholding.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L43)* +_Defined in_ [_src/entities/TaxWithholding.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L43) Generate the Tax Withholding's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* - -Name | Type | ------- | ------ | -`securityTokenId` | string | -`tokenholderAddress` | string | +▪ **\_\_namedParameters**: _object_ -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `securityTokenId` | string | +| `tokenholderAddress` | string | -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) -*Defined in [src/entities/TaxWithholding.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L55)* +_Defined in_ [_src/entities/TaxWithholding.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L55) Unserialize a serialized entity of tax withholding information **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`serialized` | string | string with tax withholding information | +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with tax withholding information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_tieredsto_.tieredsto.md b/docs/api/classes/_entities_tieredsto_.tieredsto.md index 28714f7..806e835 100644 --- a/docs/api/classes/_entities_tieredsto_.tieredsto.md +++ b/docs/api/classes/_entities_tieredsto_.tieredsto.md @@ -1,12 +1,12 @@ -# Class: TieredSto +# TieredSto Used to manage a tiered sto ## Hierarchy - ↳ [Sto](_entities_sto_.sto.md)‹[Params](../interfaces/_entities_tieredsto_.params.md)› +↳ [Sto](_entities_sto_.sto.md)‹[Params](../interfaces/_entities_tieredsto_.params.md)› - ↳ **TieredSto** +↳ **TieredSto** ## Index @@ -43,7 +43,7 @@ Used to manage a tiered sto ### Methods -* [_refresh](_entities_tieredsto_.tieredsto.md#_refresh) +* [\_refresh](_entities_tieredsto_.tieredsto.md#_refresh) * [allowBeneficialInvestments](_entities_tieredsto_.tieredsto.md#allowbeneficialinvestments) * [allowPreIssuing](_entities_tieredsto_.tieredsto.md#allowpreissuing) * [assignRole](_entities_tieredsto_.tieredsto.md#assignrole) @@ -63,600 +63,519 @@ Used to manage a tiered sto ## Constructors -### constructor +### constructor -\+ **new TieredSto**(`params`: [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)): *[TieredSto](_entities_tieredsto_.tieredsto.md)* ++ **new TieredSto**\(`params`: [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](_context_.context.md)\): [_TieredSto_](_entities_tieredsto_.tieredsto.md) -*Overrides [Sto](_entities_sto_.sto.md).[constructor](_entities_sto_.sto.md#constructor)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_constructor_](_entities_sto_.sto.md#constructor) -*Defined in [src/entities/TieredSto.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151)* +_Defined in_ [_src/entities/TieredSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151) Create a new tiered sto instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TieredSto](_entities_tieredsto_.tieredsto.md)* +**Returns:** [_TieredSto_](_entities_tieredsto_.tieredsto.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[address](_entities_sto_.sto.md#address)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_address_](_entities_sto_.sto.md#address) -*Defined in [src/entities/Sto.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107)* +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) ethereum address for the STO -___ +### beneficialInvestmentsAllowed -### beneficialInvestmentsAllowed +• **beneficialInvestmentsAllowed**: _boolean_ -• **beneficialInvestmentsAllowed**: *boolean* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_beneficialInvestmentsAllowed_](_entities_sto_.sto.md#beneficialinvestmentsallowed) -*Inherited from [Sto](_entities_sto_.sto.md).[beneficialInvestmentsAllowed](_entities_sto_.sto.md#beneficialinvestmentsallowed)* - -*Defined in [src/entities/Sto.ts:175](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175)* +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) whether investments can be made on behalf of a beneficiary or not -___ - -### capReached +### capReached -• **capReached**: *boolean* +• **capReached**: _boolean_ -*Inherited from [Sto](_entities_sto_.sto.md).[capReached](_entities_sto_.sto.md#capreached)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_capReached_](_entities_sto_.sto.md#capreached) -*Defined in [src/entities/Sto.ts:160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160)* +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) whether the STO cap has been reached or not -___ - ### `Protected` context -• **context**: *[Context](_context_.context.md)* +• **context**: [_Context_](_context_.context.md) -*Inherited from [Sto](_entities_sto_.sto.md).[context](_entities_sto_.sto.md#protected-context)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_context_](_entities_sto_.sto.md#protected-context) -*Defined in [src/entities/Sto.ts:177](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177)* +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) -___ +### currentTier -### currentTier +• **currentTier**: _number_ -• **currentTier**: *number* - -*Defined in [src/entities/TieredSto.ts:134](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L134)* +_Defined in_ [_src/entities/TieredSto.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L134) index of the current active tier -___ - -### endDate - -• **endDate**: *Date* +### endDate -*Inherited from [Sto](_entities_sto_.sto.md).[endDate](_entities_sto_.sto.md#enddate)* +• **endDate**: _Date_ -*Defined in [src/entities/Sto.ts:120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_endDate_](_entities_sto_.sto.md#enddate) -___ +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) -### fundraiseCurrencies +### fundraiseCurrencies -• **fundraiseCurrencies**: *Currency[]* +• **fundraiseCurrencies**: _Currency\[\]_ -*Inherited from [Sto](_entities_sto_.sto.md).[fundraiseCurrencies](_entities_sto_.sto.md#fundraisecurrencies)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_fundraiseCurrencies_](_entities_sto_.sto.md#fundraisecurrencies) -*Defined in [src/entities/Sto.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150)* +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) types of currency in which funds can be raised -___ +### investorCount -### investorCount +• **investorCount**: _number_ -• **investorCount**: *number* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_investorCount_](_entities_sto_.sto.md#investorcount) -*Inherited from [Sto](_entities_sto_.sto.md).[investorCount](_entities_sto_.sto.md#investorcount)* - -*Defined in [src/entities/Sto.ts:145](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145)* +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) number of investors that have purchased tokens in the STO -___ - -### isFinalized +### isFinalized -• **isFinalized**: *boolean* +• **isFinalized**: _boolean_ -*Inherited from [Sto](_entities_sto_.sto.md).[isFinalized](_entities_sto_.sto.md#isfinalized)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_isFinalized_](_entities_sto_.sto.md#isfinalized) -*Defined in [src/entities/Sto.ts:165](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165)* +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) whether the STO has been finalized or not -___ - -### isPaused +### isPaused -• **isPaused**: *boolean* +• **isPaused**: _boolean_ -*Inherited from [Sto](_entities_sto_.sto.md).[isPaused](_entities_sto_.sto.md#ispaused)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_isPaused_](_entities_sto_.sto.md#ispaused) -*Defined in [src/entities/Sto.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155)* +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) whether the STO is currently paused or not -___ - -### minimumInvestment - -• **minimumInvestment**: *BigNumber* +### minimumInvestment -*Defined in [src/entities/TieredSto.ts:141](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L141)* +• **minimumInvestment**: _BigNumber_ -___ +_Defined in_ [_src/entities/TieredSto.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L141) -### nonAccreditedInvestmentLimit +### nonAccreditedInvestmentLimit -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **nonAccreditedInvestmentLimit**: _BigNumber_ -*Defined in [src/entities/TieredSto.ts:139](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L139)* +_Defined in_ [_src/entities/TieredSto.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L139) maximum investment allowed for non-accredited investors -___ +### preIssueAllowed -### preIssueAllowed +• **preIssueAllowed**: _boolean_ -• **preIssueAllowed**: *boolean* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_preIssueAllowed_](_entities_sto_.sto.md#preissueallowed) -*Inherited from [Sto](_entities_sto_.sto.md).[preIssueAllowed](_entities_sto_.sto.md#preissueallowed)* - -*Defined in [src/entities/Sto.ts:170](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170)* +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made -___ - -### raisedAmount +### raisedAmount -• **raisedAmount**: *BigNumber* +• **raisedAmount**: _BigNumber_ -*Inherited from [Sto](_entities_sto_.sto.md).[raisedAmount](_entities_sto_.sto.md#raisedamount)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_raisedAmount_](_entities_sto_.sto.md#raisedamount) -*Defined in [src/entities/Sto.ts:135](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135)* +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) amount of funds that have been raised so far -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[raisedFundsWallet](_entities_sto_.sto.md#raisedfundswallet)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_raisedFundsWallet_](_entities_sto_.sto.md#raisedfundswallet) -*Defined in [src/entities/Sto.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125)* +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) wallet where raised funds will be forwarded to -___ - -### securityTokenId - -• **securityTokenId**: *string* +### securityTokenId -*Inherited from [Sto](_entities_sto_.sto.md).[securityTokenId](_entities_sto_.sto.md#securitytokenid)* +• **securityTokenId**: _string_ -*Defined in [src/entities/Sto.ts:111](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_securityTokenId_](_entities_sto_.sto.md#securitytokenid) -___ +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) -### securityTokenSymbol +### securityTokenSymbol -• **securityTokenSymbol**: *string* +• **securityTokenSymbol**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[securityTokenSymbol](_entities_sto_.sto.md#securitytokensymbol)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_securityTokenSymbol_](_entities_sto_.sto.md#securitytokensymbol) -*Defined in [src/entities/Sto.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109)* +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) -___ +### soldTokensAmount -### soldTokensAmount +• **soldTokensAmount**: _BigNumber_ -• **soldTokensAmount**: *BigNumber* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_soldTokensAmount_](_entities_sto_.sto.md#soldtokensamount) -*Inherited from [Sto](_entities_sto_.sto.md).[soldTokensAmount](_entities_sto_.sto.md#soldtokensamount)* - -*Defined in [src/entities/Sto.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140)* +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) total number of tokens that have been sold so far -___ - -### stableCoinAddresses +### stableCoinAddresses -• **stableCoinAddresses**: *string[]* +• **stableCoinAddresses**: _string\[\]_ -*Defined in [src/entities/TieredSto.ts:146](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L146)* +_Defined in_ [_src/entities/TieredSto.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L146) array of Stable Coin ERC20 tokens that can be used to purchase tokens in this Offering -___ - -### startDate +### startDate -• **startDate**: *Date* +• **startDate**: _Date_ -*Inherited from [Sto](_entities_sto_.sto.md).[startDate](_entities_sto_.sto.md#startdate)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_startDate_](_entities_sto_.sto.md#startdate) -*Defined in [src/entities/Sto.ts:118](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118)* +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) -___ +### stoType -### stoType +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_stoType_](_entities_sto_.sto.md#stotype) -*Inherited from [Sto](_entities_sto_.sto.md).[stoType](_entities_sto_.sto.md#stotype)* - -*Defined in [src/entities/Sto.ts:116](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116)* +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) type of STO setup -___ - -### tiers +### tiers -• **tiers**: *[Tier](../interfaces/_entities_tieredsto_.tier.md)[]* +• **tiers**: [_Tier_](../interfaces/_entities_tieredsto_.tier.md)_\[\]_ -*Defined in [src/entities/TieredSto.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151)* +_Defined in_ [_src/entities/TieredSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151) array of tier information -___ +### uid -### uid +• **uid**: _string_ -• **uid**: *string* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_uid_](_entities_sto_.sto.md#abstract-uid) -*Overrides [Sto](_entities_sto_.sto.md).[uid](_entities_sto_.sto.md#abstract-uid)* - -*Defined in [src/entities/TieredSto.ts:129](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L129)* +_Defined in_ [_src/entities/TieredSto.ts:129_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L129) unique generated Tiered STO id -___ - -### unsoldTokensWallet +### unsoldTokensWallet -• **unsoldTokensWallet**: *string* +• **unsoldTokensWallet**: _string_ -*Inherited from [Sto](_entities_sto_.sto.md).[unsoldTokensWallet](_entities_sto_.sto.md#unsoldtokenswallet)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_unsoldTokensWallet_](_entities_sto_.sto.md#unsoldtokenswallet) -*Defined in [src/entities/Sto.ts:130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130)* +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) wallet where unsold tokens will be returned to ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›\): _void_ -*Overrides [Sto](_entities_sto_.sto.md).[_refresh](_entities_sto_.sto.md#_refresh)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_\_refresh_](_entities_sto_.sto.md#_refresh) -*Defined in [src/entities/TieredSto.ts:349](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L349)* +_Defined in_ [_src/entities/TieredSto.ts:349_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L349) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | -___ +**Returns:** _void_ -### allowBeneficialInvestments +### allowBeneficialInvestments -▸ **allowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:316](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316)* +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) Enable a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ - -### allowPreIssuing +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **allowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +### allowPreIssuing -*Inherited from [Sto](_entities_sto_.sto.md)* +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:287](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -Enable all offered tokens to be issued instantly at STO start (default behavior is to issue on purchase) -Can be disabled *BEFORE* the STO starts by calling disallowPreIssuing +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -### assignRole +### assignRole -▸ **assignRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:348](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348)* +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) Assign a role on the STO to a delegate **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`delegateAddress` | string | -`description?` | undefined | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -___ +### disallowBeneficialInvestments -### disallowBeneficialInvestments +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **disallowBeneficialInvestments**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Inherited from [Sto](_entities_sto_.sto.md)* - -*Defined in [src/entities/Sto.ts:330](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330)* +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) Disable the possibility for a party to invest in the STO on behalf of another party -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), void››* - -___ - -### disallowPreIssuing +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ -▸ **disallowPreIssuing**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +### disallowPreIssuing -*Inherited from [Sto](_entities_sto_.sto.md)* +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -*Defined in [src/entities/Sto.ts:302](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -Disable pre-issuing of offered tokens at STO start (goes back to default behavior, which is to issue on purchase) -Can be re-enabled *BEFORE* the STO starts by calling allowPreIssuing +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), void››* +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ -### finalize +### finalize -▸ **finalize**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:275](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275)* +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) -Finalize the offering. The offering's treasury wallet (or the Security Token's treasury wallet if one was not specified for the offering) -will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ -___ +### getCurrency -### getCurrency +▸ **getCurrency**\(\): _Promise‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ -▸ **getCurrency**(): *Promise‹[CustomCurrency](../interfaces/_types_index_.customcurrency.md)›* - -*Defined in [src/entities/TieredSto.ts:225](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L225)* +_Defined in_ [_src/entities/TieredSto.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L225) Retrieve the denomination in which the tokens are priced in this STO -**Returns:** *Promise‹[CustomCurrency](../interfaces/_types_index_.customcurrency.md)›* - -___ +**Returns:** _Promise‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ -### getInvestments +### getInvestments -▸ **getInvestments**(): *Promise‹[Investment](_entities_investment_.investment.md)[]›* +▸ **getInvestments**\(\): _Promise‹_[_Investment_](_entities_investment_.investment.md)_\[\]›_ -*Defined in [src/entities/TieredSto.ts:181](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L181)* +_Defined in_ [_src/entities/TieredSto.ts:181_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L181) Retrieve all investments that have been made on this STO -**Returns:** *Promise‹[Investment](_entities_investment_.investment.md)[]›* +**Returns:** _Promise‹_[_Investment_](_entities_investment_.investment.md)_\[\]›_ -___ +### invest -### invest +▸ **invest**\(`params`: InvestInStableCoinParams\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](../external-modules/_types_index_.md#investintieredstoprocedureargs)_››_ -▸ **invest**(`params`: InvestInStableCoinParams): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)››* - -*Defined in [src/entities/TieredSto.ts:296](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L296)* +_Defined in_ [_src/entities/TieredSto.ts:296_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L296) Invest in the STO **Parameters:** -Name | Type | ------- | ------ | -`params` | InvestInStableCoinParams | +| Name | Type | +| :--- | :--- | +| `params` | InvestInStableCoinParams | -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](../external-modules/_types_index_.md#investintieredstoprocedureargs)_››_ -▸ **invest**(`params`: InvestInOtherParams): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)››* +▸ **invest**\(`params`: InvestInOtherParams\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](../external-modules/_types_index_.md#investintieredstoprocedureargs)_››_ -*Defined in [src/entities/TieredSto.ts:301](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L301)* +_Defined in_ [_src/entities/TieredSto.ts:301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L301) Invest in the STO **Parameters:** -Name | Type | ------- | ------ | -`params` | InvestInOtherParams | - -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)››* +| Name | Type | +| :--- | :--- | +| `params` | InvestInOtherParams | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](../external-modules/_types_index_.md#investintieredstoprocedureargs)_››_ -### modifyData +### modifyData -▸ **modifyData**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md), void››* +▸ **modifyData**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)_, void››_ -*Defined in [src/entities/TieredSto.ts:277](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L277)* +_Defined in_ [_src/entities/TieredSto.ts:277_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L277) Modify STO parameters. Must be done before the STO starts **Parameters:** -▪ **args**: *object* - -Name | Type | Description | ------- | ------ | ------ | -`customCurrency?` | Partial‹[CustomCurrency](../interfaces/_types_index_.customcurrency.md)› | custom currency data. Allows the STO to raise funds pegged to a different currency. Optional, defaults to USD | -`endDate?` | Date | date when the STO should end | -`fundariseCurrencies?` | Currency[] | - | -`minimumInvestment?` | BigNumber | minimum investment amount | -`nonAccreditedInvestmentLimit?` | BigNumber | maximum investment for non-accredited investors | -`raisedFundsWallet?` | undefined | string | wallet address that will receive the funds that are being raised | -`stableCoinAddresses?` | string[] | addresses of supported stablecoins | -`startDate?` | Date | date when the STO should start | -`tiers?` | [StoTier](../interfaces/_types_index_.stotier.md)[] | tier information | -`unsoldTokensWallet?` | undefined | string | wallet address that will receive unsold tokens when the end date is reached | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md), void››* +| Name | Type | Description | +| :--- | :--- | :--- | +| `customCurrency?` | Partial‹[CustomCurrency](../interfaces/_types_index_.customcurrency.md)› | custom currency data. Allows the STO to raise funds pegged to a different currency. Optional, defaults to USD | +| `endDate?` | Date | date when the STO should end | +| `fundariseCurrencies?` | Currency\[\] | - | +| `minimumInvestment?` | BigNumber | minimum investment amount | +| `nonAccreditedInvestmentLimit?` | BigNumber | maximum investment for non-accredited investors | +| `raisedFundsWallet?` | undefined \| string | wallet address that will receive the funds that are being raised | +| `stableCoinAddresses?` | string\[\] | addresses of supported stablecoins | +| `startDate?` | Date | date when the STO should start | +| `tiers?` | [StoTier](../interfaces/_types_index_.stotier.md)\[\] | tier information | +| `unsoldTokensWallet?` | undefined \| string | wallet address that will receive unsold tokens when the end date is reached | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)_, void››_ -### pause +### pause -▸ **pause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -*Inherited from [Sto](_entities_sto_.sto.md)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Defined in [src/entities/Sto.ts:246](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246)* +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) Pause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -___ +### revokeRole -### revokeRole +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -▸ **revokeRole**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -*Inherited from [Sto](_entities_sto_.sto.md)* - -*Defined in [src/entities/Sto.ts:374](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374)* +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) Remove a role from a delegate **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`delegateAddress` | string | -`role` | [StoRole](../enums/_types_index_.storole.md) | +▪ **args**: _object_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), void››* +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ -### toPojo +### toPojo -▸ **toPojo**(): *object* +▸ **toPojo**\(\): _object_ -*Overrides [Sto](_entities_sto_.sto.md).[toPojo](_entities_sto_.sto.md#topojo)* +_Overrides_ [_Sto_](_entities_sto_.sto.md)_._[_toPojo_](_entities_sto_.sto.md#topojo) -*Defined in [src/entities/TieredSto.ts:335](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L335)* +_Defined in_ [_src/entities/TieredSto.ts:335_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L335) -Convert entity to a POJO (Plain Old Javascript Object) +Convert entity to a POJO \(Plain Old Javascript Object\) -**Returns:** *object* +**Returns:** _object_ -* **currentTier**: *number* +* **currentTier**: _number_ +* **tiers**: [_Tier_](../interfaces/_entities_tieredsto_.tier.md)_\[\]_ -* **tiers**: *[Tier](../interfaces/_entities_tieredsto_.tier.md)[]* +### unpause -___ +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ -### unpause +_Inherited from_ [_Sto_](_entities_sto_.sto.md) -▸ **unpause**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -*Inherited from [Sto](_entities_sto_.sto.md)* - -*Defined in [src/entities/Sto.ts:260](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260)* +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) Unpause the offering -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), void››* - -___ +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/TieredSto.ts:118](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L118)* +_Defined in_ [_src/entities/TieredSto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L118) Generate the Tiered STO's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`address` | string | -`securityTokenId` | string | -`stoType` | [StoType](../enums/_types_index_.stotype.md) | +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | +| `stoType` | [StoType](../enums/_types_index_.stotype.md) | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -*Inherited from [Sto](_entities_sto_.sto.md).[unserialize](_entities_sto_.sto.md#static-unserialize)* +_Inherited from_ [_Sto_](_entities_sto_.sto.md)_._[_unserialize_](_entities_sto_.sto.md#static-unserialize) -*Defined in [src/entities/Sto.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184)* +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) Unserialize string to a Security Token Offering object representation **Parameters:** -Name | Type | ------- | ------ | -`serialized` | string | +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_tokenholder_.tokenholder.md b/docs/api/classes/_entities_tokenholder_.tokenholder.md index bb8bd04..7149456 100644 --- a/docs/api/classes/_entities_tokenholder_.tokenholder.md +++ b/docs/api/classes/_entities_tokenholder_.tokenholder.md @@ -1,4 +1,4 @@ -# Class: Tokenholder +# Tokenholder Used to manage a Tokenholder @@ -29,7 +29,7 @@ Used to manage a Tokenholder ### Methods -* [_refresh](_entities_tokenholder_.tokenholder.md#_refresh) +* [\_refresh](_entities_tokenholder_.tokenholder.md#_refresh) * [isRevoked](_entities_tokenholder_.tokenholder.md#isrevoked) * [toPojo](_entities_tokenholder_.tokenholder.md#topojo) * [generateId](_entities_tokenholder_.tokenholder.md#static-generateid) @@ -37,221 +37,187 @@ Used to manage a Tokenholder ## Constructors -### constructor +### constructor -\+ **new Tokenholder**(`params`: [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)): *[Tokenholder](_entities_tokenholder_.tokenholder.md)* ++ **new Tokenholder**\(`params`: [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)\): [_Tokenholder_](_entities_tokenholder_.tokenholder.md) -*Defined in [src/entities/Tokenholder.ts:112](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112)* +_Defined in_ [_src/entities/Tokenholder.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112) Create a new Tokenholder instance **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) | -**Returns:** *[Tokenholder](_entities_tokenholder_.tokenholder.md)* +**Returns:** [_Tokenholder_](_entities_tokenholder_.tokenholder.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Tokenholder.ts:112](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112)* +_Defined in_ [_src/entities/Tokenholder.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112) wallet address -___ +### balance -### balance +• **balance**: _BigNumber_ -• **balance**: *BigNumber* - -*Defined in [src/entities/Tokenholder.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L107)* +_Defined in_ [_src/entities/Tokenholder.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L107) total Security Token balance of the Tokenholder -___ - -### canBuyFromSto +### canBuyFromSto -• **canBuyFromSto**: *boolean* +• **canBuyFromSto**: _boolean_ -*Defined in [src/entities/Tokenholder.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L102)* +_Defined in_ [_src/entities/Tokenholder.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L102) whether the Tokenholder can purchase from an STO or not -___ - -### canReceiveAfter +### canReceiveAfter -• **canReceiveAfter**: *Date* +• **canReceiveAfter**: _Date_ -*Defined in [src/entities/Tokenholder.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L87)* +_Defined in_ [_src/entities/Tokenholder.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L87) date after which a Tokenholder can transfer tokens to their address -___ +### canSendAfter -### canSendAfter +• **canSendAfter**: _Date_ -• **canSendAfter**: *Date* - -*Defined in [src/entities/Tokenholder.ts:82](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L82)* +_Defined in_ [_src/entities/Tokenholder.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L82) date after which a Tokenholder can transfer tokens from their address -___ - -### isAccredited +### isAccredited -• **isAccredited**: *boolean* +• **isAccredited**: _boolean_ -*Defined in [src/entities/Tokenholder.ts:97](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L97)* +_Defined in_ [_src/entities/Tokenholder.ts:97_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L97) whether the Tokenholder is accredited or not -___ - -### kycExpiry +### kycExpiry -• **kycExpiry**: *Date* +• **kycExpiry**: _Date_ -*Defined in [src/entities/Tokenholder.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L92)* +_Defined in_ [_src/entities/Tokenholder.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L92) date when the Tokenholder's KYC will expire -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/Tokenholder.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L77) -*Defined in [src/entities/Tokenholder.ts:77](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L77)* +### securityTokenSymbol -___ +• **securityTokenSymbol**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/Tokenholder.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L75) -• **securityTokenSymbol**: *string* +### uid -*Defined in [src/entities/Tokenholder.ts:75](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L75)* +• **uid**: _string_ -___ +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -### uid - -• **uid**: *string* - -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* - -*Defined in [src/entities/Tokenholder.ts:73](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L73)* +_Defined in_ [_src/entities/Tokenholder.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L73) unique generated id for a Tokenholder ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Tokenholder.ts:195](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L195)* +_Defined in_ [_src/entities/Tokenholder.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L195) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | -**Returns:** *void* +**Returns:** _void_ -___ +### isRevoked -### isRevoked +▸ **isRevoked**\(\): _boolean_ -▸ **isRevoked**(): *boolean* - -*Defined in [src/entities/Tokenholder.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L150)* +_Defined in_ [_src/entities/Tokenholder.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L150) Checks if this Tokenholder's KYC has been manually revoked -**Returns:** *boolean* - -___ - -### toPojo +**Returns:** _boolean_ -▸ **toPojo**(): *object* +### toPojo -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +▸ **toPojo**\(\): _object_ -*Defined in [src/entities/Tokenholder.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L164)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -Convert entity to a POJO (Plain Old Javascript Object) +_Defined in_ [_src/entities/Tokenholder.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L164) -**Returns:** *object* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **address**: *string* +**Returns:** _object_ -* **balance**: *BigNumber* - -* **canBuyFromSto**: *boolean* - -* **canReceiveAfter**: *Date* - -* **canSendAfter**: *Date* - -* **isAccredited**: *boolean* - -* **kycExpiry**: *Date* - -* **securityTokenId**: *string* - -* **securityTokenSymbol**: *string* - -* **uid**: *string* - -___ +* **address**: _string_ +* **balance**: _BigNumber_ +* **canBuyFromSto**: _boolean_ +* **canReceiveAfter**: _Date_ +* **canSendAfter**: _Date_ +* **isAccredited**: _boolean_ +* **kycExpiry**: _Date_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/Tokenholder.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L45)* +_Defined in_ [_src/entities/Tokenholder.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L45) Generate the Tokenholder's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`address` | string | -`securityTokenId` | string | +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) -*Defined in [src/entities/Tokenholder.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L57)* +_Defined in_ [_src/entities/Tokenholder.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L57) Unserialize a serialized Tokenholder entity **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`serialized` | string | string with Tokenholder entity information | +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with Tokenholder entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_entities_transactionqueue_.transactionqueue.md b/docs/api/classes/_entities_transactionqueue_.transactionqueue.md index eb9b35e..a72589a 100644 --- a/docs/api/classes/_entities_transactionqueue_.transactionqueue.md +++ b/docs/api/classes/_entities_transactionqueue_.transactionqueue.md @@ -1,12 +1,12 @@ -# Class: TransactionQueue <**Args, ReturnType**> +# TransactionQueue Class to manage procedural transaction queues ## Type parameters -▪ **Args**: *any* +▪ **Args**: _any_ -▪ **ReturnType**: *any* +▪ **ReturnType**: _any_ ## Hierarchy @@ -33,7 +33,7 @@ Class to manage procedural transaction queues ### Methods -* [_refresh](_entities_transactionqueue_.transactionqueue.md#_refresh) +* [\_refresh](_entities_transactionqueue_.transactionqueue.md#_refresh) * [onStatusChange](_entities_transactionqueue_.transactionqueue.md#onstatuschange) * [onTransactionStatusChange](_entities_transactionqueue_.transactionqueue.md#ontransactionstatuschange) * [run](_entities_transactionqueue_.transactionqueue.md#run) @@ -42,225 +42,197 @@ Class to manage procedural transaction queues ## Constructors -### constructor +### constructor -\+ **new TransactionQueue**(`transactions`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)[], `fees`: [Fees](../interfaces/_types_index_.fees.md), `returnValue`: [MaybeResolver](../modules/_types_index_.md#mayberesolver)‹ReturnType›, `args`: Args, `procedureType`: [ProcedureType](../enums/_types_index_.proceduretype.md)): *[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)* ++ **new TransactionQueue**\(`transactions`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)\[\], `fees`: [Fees](../interfaces/_types_index_.fees.md), `returnValue`: [MaybeResolver](../external-modules/_types_index_.md#mayberesolver)‹ReturnType›, `args`: Args, `procedureType`: [ProcedureType](../enums/_types_index_.proceduretype.md)\): [_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md) -*Defined in [src/entities/TransactionQueue.ts:95](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L95)* +_Defined in_ [_src/entities/TransactionQueue.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L95) Create a transaction queue **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transactions` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)[] | - | list of transactions to be run in this queue | -`fees` | [Fees](../interfaces/_types_index_.fees.md) | - | - | -`returnValue` | [MaybeResolver](../modules/_types_index_.md#mayberesolver)‹ReturnType› | - | value that will be returned by the queue after it is run. It can be a Post Transaction Resolver | -`args` | Args | - | arguments with which the Procedure that generated this queue was instanced | -`procedureType` | [ProcedureType](../enums/_types_index_.proceduretype.md) | ProcedureType.UnnamedProcedure | - | +| Name | Type | Default | Description | +| :--- | :--- | :--- | :--- | +| `transactions` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)\[\] | - | list of transactions to be run in this queue | +| `fees` | [Fees](../interfaces/_types_index_.fees.md) | - | - | +| `returnValue` | [MaybeResolver](../external-modules/_types_index_.md#mayberesolver)‹ReturnType› | - | value that will be returned by the queue after it is run. It can be a Post Transaction Resolver | +| `args` | Args | - | arguments with which the Procedure that generated this queue was instanced | +| `procedureType` | [ProcedureType](../enums/_types_index_.proceduretype.md) | ProcedureType.UnnamedProcedure | - | -**Returns:** *[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)* +**Returns:** [_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md) ## Properties -### args +### args -• **args**: *Args* +• **args**: _Args_ -*Defined in [src/entities/TransactionQueue.ts:65](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L65)* +_Defined in_ [_src/entities/TransactionQueue.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L65) arguments provided to the transaction queue -___ +### entityType -### entityType +• **entityType**: _string_ = "transactionQueue" -• **entityType**: *string* = "transactionQueue" - -*Defined in [src/entities/TransactionQueue.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L40)* +_Defined in_ [_src/entities/TransactionQueue.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L40) type of entity -___ - ### `Optional` error -• **error**? : *[Error](_polymatherror_.polymatherror.md#static-error)* +• **error**? : [_Error_](_polymatherror_.polymatherror.md#static-error) -*Defined in [src/entities/TransactionQueue.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L70)* +_Defined in_ [_src/entities/TransactionQueue.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L70) optional error information -___ - -### fees +### fees -• **fees**: *[Fees](../interfaces/_types_index_.fees.md)* +• **fees**: [_Fees_](../interfaces/_types_index_.fees.md) -*Defined in [src/entities/TransactionQueue.ts:75](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L75)* +_Defined in_ [_src/entities/TransactionQueue.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L75) total cost of running the transactions in the queue. This does not include gas -___ +### procedureType -### procedureType +• **procedureType**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) -• **procedureType**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* - -*Defined in [src/entities/TransactionQueue.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L45)* +_Defined in_ [_src/entities/TransactionQueue.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L45) type of procedure being run -___ - -### status +### status -• **status**: *TransactionQueueStatus* = TransactionQueueStatus.Idle +• **status**: _TransactionQueueStatus_ = TransactionQueueStatus.Idle -*Defined in [src/entities/TransactionQueue.ts:60](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L60)* +_Defined in_ [_src/entities/TransactionQueue.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L60) status of the transaction queue -___ +### transactions -### transactions +• **transactions**: [_PolyTransaction_](_entities_polytransaction_.polytransaction.md)_\[\]_ -• **transactions**: *[PolyTransaction](_entities_polytransaction_.polytransaction.md)[]* - -*Defined in [src/entities/TransactionQueue.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L55)* +_Defined in_ [_src/entities/TransactionQueue.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L55) array of poly transactions -___ - -### uid +### uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/TransactionQueue.ts:50](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L50)* +_Defined in_ [_src/entities/TransactionQueue.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L50) generated transaction queue unique identifier ## Methods -### _refresh +### \_refresh -▸ **_refresh**(): *void* +▸ **\_refresh**\(\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/TransactionQueue.ts:269](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L269)* +_Defined in_ [_src/entities/TransactionQueue.ts:269_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L269) Hydrate the entity -**Returns:** *void* +**Returns:** _void_ -___ +### onStatusChange -### onStatusChange +▸ **onStatusChange**\(`listener`: function\): _\(Anonymous function\)_ -▸ **onStatusChange**(`listener`: function): *(Anonymous function)* - -*Defined in [src/entities/TransactionQueue.ts:188](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L188)* +_Defined in_ [_src/entities/TransactionQueue.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L188) Subscribe to status changes on the Transaction Queue **Parameters:** -▪ **listener**: *function* +▪ **listener**: _function_ callback function that will be called whenever the Transaction Queue's status changes -▸ (`transactionQueue`: this): *void* +▸ \(`transactionQueue`: this\): _void_ **Parameters:** -Name | Type | ------- | ------ | -`transactionQueue` | this | +| Name | Type | +| :--- | :--- | +| `transactionQueue` | this | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ unsubscribe function -___ - -### onTransactionStatusChange +### onTransactionStatusChange -▸ **onTransactionStatusChange**(`listener`: function): *(Anonymous function)* +▸ **onTransactionStatusChange**\(`listener`: function\): _\(Anonymous function\)_ -*Defined in [src/entities/TransactionQueue.ts:203](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L203)* +_Defined in_ [_src/entities/TransactionQueue.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L203) Subscribe to status changes on individual transactions **Parameters:** -▪ **listener**: *function* +▪ **listener**: _function_ callback function that will be called whenever the individual transaction's status changes -▸ (`transaction`: [PolyTransaction](_entities_polytransaction_.polytransaction.md), `transactionQueue`: this): *void* +▸ \(`transaction`: [PolyTransaction](_entities_polytransaction_.polytransaction.md), `transactionQueue`: this\): _void_ **Parameters:** -Name | Type | ------- | ------ | -`transaction` | [PolyTransaction](_entities_polytransaction_.polytransaction.md) | -`transactionQueue` | this | +| Name | Type | +| :--- | :--- | +| `transaction` | [PolyTransaction](_entities_polytransaction_.polytransaction.md) | +| `transactionQueue` | this | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ unsubscribe function -___ +### run -### run +▸ **run**\(\): _Promise‹ReturnType›_ -▸ **run**(): *Promise‹ReturnType›* - -*Defined in [src/entities/TransactionQueue.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L155)* +_Defined in_ [_src/entities/TransactionQueue.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L155) Run the transactions in the queue -**Returns:** *Promise‹ReturnType›* - -___ - -### toPojo - -▸ **toPojo**(): *object* - -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +**Returns:** _Promise‹ReturnType›_ -*Defined in [src/entities/TransactionQueue.ts:139](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L139)* +### toPojo -Convert entity to a POJO (Plain Old Javascript Object) +▸ **toPojo**\(\): _object_ -**Returns:** *object* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -* **args**: *Args* +_Defined in_ [_src/entities/TransactionQueue.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L139) -* **fees**: *[Fees](../interfaces/_types_index_.fees.md)* +Convert entity to a POJO \(Plain Old Javascript Object\) -* **procedureType**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* +**Returns:** _object_ -* **status**: *TransactionQueueStatus* - -* **transactions**: *object[]* = transactions.map(transaction => transaction.toPojo()) - -* **uid**: *string* - -___ +* **args**: _Args_ +* **fees**: [_Fees_](../interfaces/_types_index_.fees.md) +* **procedureType**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) +* **status**: _TransactionQueueStatus_ +* **transactions**: _object\[\]_ = transactions.map\(transaction => transaction.toPojo\(\)\) +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(): *string* +▸ **generateId**\(\): _string_ -*Defined in [src/entities/TransactionQueue.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L31)* +_Defined in_ [_src/entities/TransactionQueue.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L31) Generate UUID for this Transaction Queue -**Returns:** *string* +**Returns:** _string_ + diff --git a/docs/api/classes/_entities_wallet_.wallet.md b/docs/api/classes/_entities_wallet_.wallet.md index 3981835..8f9fbc1 100644 --- a/docs/api/classes/_entities_wallet_.wallet.md +++ b/docs/api/classes/_entities_wallet_.wallet.md @@ -1,4 +1,4 @@ -# Class: Wallet +# Wallet Used to manage a wallet @@ -22,7 +22,7 @@ Used to manage a wallet ### Methods -* [_refresh](_entities_wallet_.wallet.md#_refresh) +* [\_refresh](_entities_wallet_.wallet.md#_refresh) * [getErc20Balance](_entities_wallet_.wallet.md#geterc20balance) * [getEthBalance](_entities_wallet_.wallet.md#getethbalance) * [getPolyBalance](_entities_wallet_.wallet.md#getpolybalance) @@ -32,169 +32,153 @@ Used to manage a wallet ## Constructors -### constructor +### constructor -\+ **new Wallet**(`params`: [Params](../interfaces/_entities_wallet_.params.md), `context`: [Context](_context_.context.md)): *[Wallet](_entities_wallet_.wallet.md)* ++ **new Wallet**\(`params`: [Params](../interfaces/_entities_wallet_.params.md), `context`: [Context](_context_.context.md)\): [_Wallet_](_entities_wallet_.wallet.md) -*Defined in [src/entities/Wallet.ts:71](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71)* +_Defined in_ [_src/entities/Wallet.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71) Create a wallet entity **Parameters:** -Name | Type | ------- | ------ | -`params` | [Params](../interfaces/_entities_wallet_.params.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_wallet_.params.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[Wallet](_entities_wallet_.wallet.md)* +**Returns:** [_Wallet_](_entities_wallet_.wallet.md) ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Wallet.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L69)* +_Defined in_ [_src/entities/Wallet.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L69) wallet address -___ - ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Defined in [src/entities/Wallet.ts:71](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71)* +• **context**: [_Context_](_context_.context.md) -___ +_Defined in_ [_src/entities/Wallet.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71) -### uid +### uid -• **uid**: *string* +• **uid**: _string_ -*Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_uid_](_entities_entity_.entity.md#abstract-uid) -*Defined in [src/entities/Wallet.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L64)* +_Defined in_ [_src/entities/Wallet.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L64) unique generated wallet id ## Methods -### _refresh +### \_refresh -▸ **_refresh**(`params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›): *void* +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›\): _void_ -*Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_\_refresh_](_entities_entity_.entity.md#abstract-_refresh) -*Defined in [src/entities/Wallet.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L103)* +_Defined in_ [_src/entities/Wallet.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L103) Hydrate the entity **Parameters:** -Name | Type | ------- | ------ | -`params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | -___ +**Returns:** _void_ -### getErc20Balance +### getErc20Balance -▸ **getErc20Balance**(`args`: object): *Promise‹BigNumber›* +▸ **getErc20Balance**\(`args`: object\): _Promise‹BigNumber›_ -*Defined in [src/entities/Wallet.ts:132](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L132)* +_Defined in_ [_src/entities/Wallet.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L132) Retrieve the ERC20 balance of this particular wallet address **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`tokenAddress` | string | +| Name | Type | +| :--- | :--- | +| `tokenAddress` | string | -**Returns:** *Promise‹BigNumber›* +**Returns:** _Promise‹BigNumber›_ -___ +### getEthBalance -### getEthBalance +▸ **getEthBalance**\(\): _Promise‹BigNumber›_ -▸ **getEthBalance**(): *Promise‹BigNumber›* - -*Defined in [src/entities/Wallet.ts:122](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L122)* +_Defined in_ [_src/entities/Wallet.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L122) Retrieve the ETH balance of this particular wallet address -**Returns:** *Promise‹BigNumber›* - -___ +**Returns:** _Promise‹BigNumber›_ -### getPolyBalance +### getPolyBalance -▸ **getPolyBalance**(): *Promise‹BigNumber›* +▸ **getPolyBalance**\(\): _Promise‹BigNumber›_ -*Defined in [src/entities/Wallet.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L114)* +_Defined in_ [_src/entities/Wallet.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L114) Retrieve the POLY balance of this particular wallet address -**Returns:** *Promise‹BigNumber›* +**Returns:** _Promise‹BigNumber›_ -___ +### toPojo -### toPojo +▸ **toPojo**\(\): _object_ -▸ **toPojo**(): *object* +_Overrides_ [_Entity_](_entities_entity_.entity.md)_._[_toPojo_](_entities_entity_.entity.md#abstract-topojo) -*Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)* +_Defined in_ [_src/entities/Wallet.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L91) -*Defined in [src/entities/Wallet.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L91)* +Convert entity to a POJO \(Plain Old Javascript Object\) -Convert entity to a POJO (Plain Old Javascript Object) +**Returns:** _object_ -**Returns:** *object* - -* **address**: *string* - -* **uid**: *string* - -___ +* **address**: _string_ +* **uid**: _string_ ### `Static` generateId -▸ **generateId**(`__namedParameters`: object): *string* +▸ **generateId**\(`__namedParameters`: object\): _string_ -*Defined in [src/entities/Wallet.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L37)* +_Defined in_ [_src/entities/Wallet.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L37) Generate the Wallet's UUID from its identifying properties **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`address` | string | +| Name | Type | +| :--- | :--- | +| `address` | string | -**Returns:** *string* - -___ +**Returns:** _string_ ### `Static` unserialize -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md)* +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md) -*Defined in [src/entities/Wallet.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L48)* +_Defined in_ [_src/entities/Wallet.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L48) Unserialize a serialized entity **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`serialized` | string | string with entity information | +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md) -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md)* diff --git a/docs/api/classes/_polymath_.polymath.md b/docs/api/classes/_polymath_.polymath.md index 9ceb527..9f7b21a 100644 --- a/docs/api/classes/_polymath_.polymath.md +++ b/docs/api/classes/_polymath_.polymath.md @@ -1,4 +1,4 @@ -# Class: Polymath +# Polymath Main entry point of the Polymath SDK @@ -34,264 +34,233 @@ Main entry point of the Polymath SDK ### `Private` context -• **context**: *[Context](_context_.context.md)* = {} as Context +• **context**: [_Context_](_context_.context.md) = {} as Context -*Defined in [src/Polymath.ts:98](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L98)* +_Defined in_ [_src/Polymath.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L98) -___ +### isConnected -### isConnected +• **isConnected**: _boolean_ = false -• **isConnected**: *boolean* = false +_Defined in_ [_src/Polymath.ts:96_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L96) -*Defined in [src/Polymath.ts:96](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L96)* +### isUnsupported -___ +• **isUnsupported**: _boolean_ = false -### isUnsupported - -• **isUnsupported**: *boolean* = false - -*Defined in [src/Polymath.ts:94](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L94)* +_Defined in_ [_src/Polymath.ts:94_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L94) ## Methods -### connect +### connect -▸ **connect**(`__namedParameters`: object): *Promise‹this›* +▸ **connect**\(`__namedParameters`: object\): _Promise‹this›_ -*Defined in [src/Polymath.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L103)* +_Defined in_ [_src/Polymath.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L103) Connects the client to an Ethereum node **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_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](../enums/_types_index_.transactionspeed.md) | TransactionSpeed.Fast | desired transaction speed. More gas is spent if a faster speed is chosen | +| 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](../enums/_types_index_.transactionspeed.md) | TransactionSpeed.Fast | desired transaction speed. More gas is spent if a faster speed is chosen | -**Returns:** *Promise‹this›* +**Returns:** _Promise‹this›_ -___ +### getCurrentAddress -### getCurrentAddress +▸ **getCurrentAddress**\(\): _Promise‹string›_ -▸ **getCurrentAddress**(): *Promise‹string›* - -*Defined in [src/Polymath.ts:451](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L451)* +_Defined in_ [_src/Polymath.ts:451_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L451) Returns the wallet address of the current user -**Returns:** *Promise‹string›* - -___ +**Returns:** _Promise‹string›_ -### getLatestProtocolVersion +### getLatestProtocolVersion -▸ **getLatestProtocolVersion**(): *Promise‹string›* +▸ **getLatestProtocolVersion**\(\): _Promise‹string›_ -*Defined in [src/Polymath.ts:430](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L430)* +_Defined in_ [_src/Polymath.ts:430_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L430) Get the current version of the Polymath Protocol -**Returns:** *Promise‹string›* +**Returns:** _Promise‹string›_ -version string (i.e. 3.0.0) +version string \(i.e. 3.0.0\) -___ +### getPolyTokenAddress -### getPolyTokenAddress +▸ **getPolyTokenAddress**\(\): _Promise‹string›_ -▸ **getPolyTokenAddress**(): *Promise‹string›* - -*Defined in [src/Polymath.ts:442](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L442)* +_Defined in_ [_src/Polymath.ts:442_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L442) Get the address of the POLY token -**Returns:** *Promise‹string›* - -___ +**Returns:** _Promise‹string›_ -### getSecurityToken +### getSecurityToken -▸ **getSecurityToken**(`args`: object | object | string): *Promise‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)›* +▸ **getSecurityToken**\(`args`: object \| object \| string\): _Promise‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -*Defined in [src/Polymath.ts:320](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L320)* +_Defined in_ [_src/Polymath.ts:320_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L320) Retrieve a security token by symbol, address or UUID **Parameters:** -Name | Type | ------- | ------ | -`args` | object | object | string | +| Name | Type | +| :--- | :--- | +| `args` | object \| object \| string | -**Returns:** *Promise‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)›* +**Returns:** _Promise‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -___ +### getSecurityTokenReservation -### getSecurityTokenReservation +▸ **getSecurityTokenReservation**\(`args`: object \| string\): _Promise‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_›_ -▸ **getSecurityTokenReservation**(`args`: object | string): *Promise‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)›* - -*Defined in [src/Polymath.ts:220](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L220)* +_Defined in_ [_src/Polymath.ts:220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L220) Retrieve a Security Token Reservation by symbol or UUID **Parameters:** -Name | Type | ------- | ------ | -`args` | object | string | - -**Returns:** *Promise‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)›* +| Name | Type | +| :--- | :--- | +| `args` | object \| string | -___ +**Returns:** _Promise‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_›_ -### getSecurityTokenReservations +### getSecurityTokenReservations -▸ **getSecurityTokenReservations**(`args?`: undefined | object): *Promise‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)[]›* +▸ **getSecurityTokenReservations**\(`args?`: undefined \| object\): _Promise‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_\[\]›_ -*Defined in [src/Polymath.ts:188](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L188)* +_Defined in_ [_src/Polymath.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L188) -Retrieve all Security Token Reservations currently owned by an issuer. This includes -Security Tokens that have already been launched +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 | +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | -**Returns:** *Promise‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)[]›* +**Returns:** _Promise‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_\[\]›_ -___ +### getSecurityTokenSymbols -### getSecurityTokenSymbols +▸ **getSecurityTokenSymbols**\(`args?`: undefined \| object\): _Promise‹string\[\]›_ -▸ **getSecurityTokenSymbols**(`args?`: undefined | object): *Promise‹string[]›* +_Defined in_ [_src/Polymath.ts:286_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L286) -*Defined in [src/Polymath.ts:286](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L286)* - -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 +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[]›* +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | -___ +**Returns:** _Promise‹string\[\]›_ -### getSecurityTokens +### getSecurityTokens -▸ **getSecurityTokens**(`args?`: undefined | object): *Promise‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)[]›* +▸ **getSecurityTokens**\(`args?`: undefined \| object\): _Promise‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_\[\]›_ -*Defined in [src/Polymath.ts:244](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L244)* +_Defined in_ [_src/Polymath.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L244) -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 +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](_polymath_.polymath.md#getsecuritytokensymbols) +NOTE: This method is extremely slow if the wallet in question owns more than 20 tokens. If that is your case, use [getSecurityTokenSymbols](_polymath_.polymath.md#getsecuritytokensymbols) **Parameters:** -Name | Type | ------- | ------ | -`args?` | undefined | object | +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | -**Returns:** *Promise‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md)[]›* +**Returns:** _Promise‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_\[\]›_ -___ +### getWallet -### getWallet +▸ **getWallet**\(`args`: object\): [_Wallet_](_entities_wallet_.wallet.md) -▸ **getWallet**(`args`: object): *[Wallet](_entities_wallet_.wallet.md)* - -*Defined in [src/Polymath.ts:419](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L419)* +_Defined in_ [_src/Polymath.ts:419_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L419) Retrieve a Wallet by address **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`address` | string | +▪ **args**: _object_ -**Returns:** *[Wallet](_entities_wallet_.wallet.md)* +| Name | Type | +| :--- | :--- | +| `address` | string | -___ +**Returns:** [_Wallet_](_entities_wallet_.wallet.md) -### isSymbolAvailable +### isSymbolAvailable -▸ **isSymbolAvailable**(`args`: object): *Promise‹boolean›* +▸ **isSymbolAvailable**\(`args`: object\): _Promise‹boolean›_ -*Defined in [src/Polymath.ts:394](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L394)* +_Defined in_ [_src/Polymath.ts:394_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L394) -Check if a token symbol (ticker) is available for reservation +Check if a token symbol \(ticker\) is available for reservation **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`symbol` | string | +| Name | Type | +| :--- | :--- | +| `symbol` | string | -**Returns:** *Promise‹boolean›* +**Returns:** _Promise‹boolean›_ -___ +### isValidErc20 -### isValidErc20 +▸ **isValidErc20**\(`args`: object\): _Promise‹void›_ -▸ **isValidErc20**(`args`: object): *Promise‹void›* - -*Defined in [src/Polymath.ts:405](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L405)* +_Defined in_ [_src/Polymath.ts:405_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L405) Check if a token follows the ERC20 standard **Parameters:** -▪ **args**: *object* - -Name | Type | ------- | ------ | -`address` | string | +▪ **args**: _object_ -**Returns:** *Promise‹void›* +| Name | Type | +| :--- | :--- | +| `address` | string | -___ +**Returns:** _Promise‹void›_ -### reserveSecurityToken +### reserveSecurityToken -▸ **reserveSecurityToken**(`args`: object): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), [SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)››* +▸ **reserveSecurityToken**\(`args`: object\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md)_,_ [_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_››_ -*Defined in [src/Polymath.ts:176](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L176)* +_Defined in_ [_src/Polymath.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L176) Reserve a Security Token **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `owner?` | undefined \| string | +| `symbol` | string | -Name | Type | ------- | ------ | -`owner?` | undefined | string | -`symbol` | string | +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹_[_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md)_,_ [_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹[ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), [SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md)››* diff --git a/docs/api/classes/_polymathbase_.polymathbase.md b/docs/api/classes/_polymathbase_.polymathbase.md index 2a646f4..8588899 100644 --- a/docs/api/classes/_polymathbase_.polymathbase.md +++ b/docs/api/classes/_polymathbase_.polymathbase.md @@ -1,4 +1,4 @@ -# Class: PolymathBase +# PolymathBase Class that wraps the polymathnetwork/contract-wrappers library to add utility functions @@ -48,58 +48,53 @@ Class that wraps the polymathnetwork/contract-wrappers library to add utility fu ## Constructors -### constructor +### constructor -\+ **new PolymathBase**(`params`: ApiConstructorParams): *[PolymathBase](_polymathbase_.polymathbase.md)* ++ **new PolymathBase**\(`params`: ApiConstructorParams\): [_PolymathBase_](_polymathbase_.polymathbase.md) -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79 Instantiates a new PolymathAPI instance. **Parameters:** -Name | Type | ------- | ------ | -`params` | ApiConstructorParams | +| Name | Type | +| :--- | :--- | +| `params` | ApiConstructorParams | -**Returns:** *[PolymathBase](_polymathbase_.polymathbase.md)* +**Returns:** [_PolymathBase_](_polymathbase_.polymathbase.md) An instance of the PolymathAPI class. ## Properties -### contractFactory +### contractFactory -• **contractFactory**: *ContractFactory* +• **contractFactory**: _ContractFactory_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:79 -___ +### featureRegistry -### featureRegistry +• **featureRegistry**: _FeatureRegistryWrapper_ -• **featureRegistry**: *FeatureRegistryWrapper* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:62 -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. -An instance of the FeatureRegistryWrapper class containing methods -for interacting with FeatureRegistry smart contract. +### getAccount -___ +• **getAccount**: _function_ -### getAccount +_Inherited from void_ -• **getAccount**: *function* - -*Inherited from void* - -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:95 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:95 Get the account currently used by PolymathAPI @@ -107,17 +102,15 @@ Get the account currently used by PolymathAPI #### Type declaration: -▸ (): *Promise‹string›* +▸ \(\): _Promise‹string›_ -___ +### getBalance -### getBalance +• **getBalance**: _function_ -• **getBalance**: *function* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:100 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:100 Get the ETH balance @@ -125,23 +118,21 @@ Get the ETH balance #### Type declaration: -▸ (`params`: GetBalanceParams): *Promise‹BigNumber›* +▸ \(`params`: GetBalanceParams\): _Promise‹BigNumber›_ **Parameters:** -Name | Type | ------- | ------ | -`params` | GetBalanceParams | - -___ +| Name | Type | +| :--- | :--- | +| `params` | GetBalanceParams | -### getERC20TokenWrapper +### getERC20TokenWrapper -• **getERC20TokenWrapper**: *function* +• **getERC20TokenWrapper**: _function_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:90 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:90 Get a wrapped token from an address @@ -149,374 +140,328 @@ Get a wrapped token from an address #### Type declaration: -▸ (`params`: GetERC20WrapperParams): *Promise‹ERC20›* +▸ \(`params`: GetERC20WrapperParams\): _Promise‹ERC20›_ **Parameters:** -Name | Type | ------- | ------ | -`params` | GetERC20WrapperParams | +| Name | Type | +| :--- | :--- | +| `params` | GetERC20WrapperParams | -___ +### getPolyTokens -### getPolyTokens +• **getPolyTokens**: _function_ -• **getPolyTokens**: *function* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:85 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:85 #### Type declaration: -▸ (`params`: GetTokensParams): *Promise‹PolyResponse›* +▸ \(`params`: GetTokensParams\): _Promise‹PolyResponse›_ **Parameters:** -Name | Type | ------- | ------ | -`params` | GetTokensParams | - -___ +| Name | Type | +| :--- | :--- | +| `params` | GetTokensParams | -### isTestnet +### isTestnet -• **isTestnet**: *function* +• **isTestnet**: _function_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:104 +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 - -___ +▸ \(\): _Promise‹boolean›_ -### moduleRegistry +### moduleFactory -• **moduleRegistry**: *ModuleRegistryWrapper* +• **moduleFactory**: _ModuleWrapperFactory_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:57 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:72 -An instance of the ModuleRegistryWrapper class containing methods -for interacting with ModuleRegistry smart contract. +An instance of the ModuleWrapperFactory class to get different module wrapper instances to interact with SecurityToken smart contracts -___ +### moduleRegistry -### polyToken +• **moduleRegistry**: _ModuleRegistryWrapper_ -• **polyToken**: *PolyTokenWrapper* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:57 -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:52 +An instance of the ModuleRegistryWrapper class containing methods for interacting with ModuleRegistry smart contract. -An instance of the PolyTokenWrapper class containing methods -for interacting with PolyToken smart contract. +### polyToken -___ +• **polyToken**: _PolyTokenWrapper_ -### polyTokenFaucet +_Inherited from void_ -• **polyTokenFaucet**: *PolyTokenFaucetWrapper* +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:52 -*Inherited from void* +An instance of the PolyTokenWrapper class containing methods for interacting with PolyToken smart contract. -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:77 +### polyTokenFaucet -An instance of the PolyTokenFaucetWrapper class containing methods -for interacting with PolyTokenFaucet smart contract. +• **polyTokenFaucet**: _PolyTokenFaucetWrapper_ -___ +_Inherited from void_ -### polymathRegistry +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:77 -• **polymathRegistry**: *PolymathRegistryWrapper* +An instance of the PolyTokenFaucetWrapper class containing methods for interacting with PolyTokenFaucet smart contract. -*Inherited from void* +### polymathRegistry -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:42 +• **polymathRegistry**: _PolymathRegistryWrapper_ -An instance of the PolymathRegistryWrapper class containing methods -for interacting with PolymathRegistry smart contract. +_Inherited from void_ -___ +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:42 -### securityTokenRegistry +An instance of the PolymathRegistryWrapper class containing methods for interacting with PolymathRegistry smart contract. -• **securityTokenRegistry**: *SecurityTokenRegistryWrapper* +### securityTokenRegistry -*Inherited from void* +• **securityTokenRegistry**: _SecurityTokenRegistryWrapper_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:47 +_Inherited from void_ -An instance of the SecurityTokenRegistryWrapper class containing methods -for interacting with SecurityTokenRegistry smart contract. +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 -• **tokenFactory**: *TokenWrapperFactory* +• **tokenFactory**: _TokenWrapperFactory_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:67 +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 +An instance of the TokenWrapperFactory class to get TokenWrapper instances to interact with SecurityToken or ERC20 smart contracts -___ +### web3Wrapper -### web3Wrapper +• **web3Wrapper**: _Web3Wrapper_ -• **web3Wrapper**: *Web3Wrapper* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:78 +Defined in node\_modules/@polymathnetwork/contract-wrappers/lib/PolymathAPI.d.ts:78 ## Methods -### getAllDividends +### getAllDividends -▸ **getAllDividends**(`__namedParameters`: object): *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* +▸ **getAllDividends**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -*Defined in [src/PolymathBase.ts:888](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L888)* +_Defined in_ [_src/PolymathBase.ts:888_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L888) 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 | +▪ **\_\_namedParameters**: _object_ -**Returns:** *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `checkpointId` | undefined \| number | checkpoint UUID | +| `securityTokenSymbol` | string | symbol of the Security Token | -___ +**Returns:** _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -### getAttachedModules +### getAttachedModules -▸ **getAttachedModules**(`__namedParameters`: object, `opts?`: [GetAttachedModulesOpts](../interfaces/_polymathbase_.getattachedmodulesopts.md)): *Promise‹any[]›* +▸ **getAttachedModules**\(`__namedParameters`: object, `opts?`: [GetAttachedModulesOpts](../interfaces/_polymathbase_.getattachedmodulesopts.md)\): _Promise‹any\[\]›_ -*Defined in [src/PolymathBase.ts:523](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L523)* +_Defined in_ [_src/PolymathBase.ts:523_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L523) 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 | +▪ **\_\_namedParameters**: _object_ -▪`Optional` **opts**: *[GetAttachedModulesOpts](../interfaces/_polymathbase_.getattachedmodulesopts.md)* +| Name | Type | Description | +| :--- | :--- | :--- | +| `moduleName` | ModuleName | name of the Module | +| `symbol` | string | symbol of the Security Token | -**Returns:** *Promise‹any[]›* +▪`Optional` **opts**: [_GetAttachedModulesOpts_](../interfaces/_polymathbase_.getattachedmodulesopts.md) -___ +**Returns:** _Promise‹any\[\]›_ -### getCheckpoint +### getCheckpoint -▸ **getCheckpoint**(`__namedParameters`: object): *Promise‹[BaseCheckpoint](../interfaces/_polymathbase_.basecheckpoint.md)›* +▸ **getCheckpoint**\(`__namedParameters`: object\): _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_›_ -*Defined in [src/PolymathBase.ts:697](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L697)* +_Defined in_ [_src/PolymathBase.ts:697_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L697) Get data associated to a Checkpoint **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | Description | ------- | ------ | ------ | -`checkpointId` | number | checkpoint UUID | -`securityToken` | SecurityToken_3_0_0 | instance of the Security Token | +| Name | Type | Description | +| :--- | :--- | :--- | +| `checkpointId` | number | checkpoint UUID | +| `securityToken` | SecurityToken\_3\_0\_0 | instance of the Security Token | -**Returns:** *Promise‹[BaseCheckpoint](../interfaces/_polymathbase_.basecheckpoint.md)›* +**Returns:** _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_›_ -___ +### getCheckpoints -### getCheckpoints +▸ **getCheckpoints**\(`__namedParameters`: object\): _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_\[\]›_ -▸ **getCheckpoints**(`__namedParameters`: object): *Promise‹[BaseCheckpoint](../interfaces/_polymathbase_.basecheckpoint.md)[]›* - -*Defined in [src/PolymathBase.ts:722](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L722)* +_Defined in_ [_src/PolymathBase.ts:722_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L722) Get all Checkpoints of a Security Token **Parameters:** -▪ **__namedParameters**: *object* - -Name | Type | Description | ------- | ------ | ------ | -`securityToken` | SecurityToken_3_0_0 | instance of the Security Token | +▪ **\_\_namedParameters**: _object_ -**Returns:** *Promise‹[BaseCheckpoint](../interfaces/_polymathbase_.basecheckpoint.md)[]›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `securityToken` | SecurityToken\_3\_0\_0 | instance of the Security Token | -___ +**Returns:** _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_\[\]›_ -### getDividend +### getDividend -▸ **getDividend**(`__namedParameters`: object): *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)›* +▸ **getDividend**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_›_ -*Defined in [src/PolymathBase.ts:783](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L783)* +_Defined in_ [_src/PolymathBase.ts:783_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L783) 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 | - | +▪ **\_\_namedParameters**: _object_ -**Returns:** *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `dividendIndex` | number | index of the Dividend | +| `dividendsModule` | ERC20DividendCheckpoint\_3\_0\_0 | - | -___ +**Returns:** _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_›_ -### getDividends +### getDividends -▸ **getDividends**(`__namedParameters`: object): *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* +▸ **getDividends**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -*Defined in [src/PolymathBase.ts:868](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L868)* +_Defined in_ [_src/PolymathBase.ts:868_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L868) **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`dividendsModule` | ERC20DividendCheckpoint_3_0_0 | +| Name | Type | +| :--- | :--- | +| `dividendsModule` | ERC20DividendCheckpoint\_3\_0\_0 | -**Returns:** *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* +**Returns:** _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -___ +### getDividendsByCheckpoint -### getDividendsByCheckpoint +▸ **getDividendsByCheckpoint**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -▸ **getDividendsByCheckpoint**(`__namedParameters`: object): *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* - -*Defined in [src/PolymathBase.ts:849](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L849)* +_Defined in_ [_src/PolymathBase.ts:849_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L849) Fetch list of all Dividends at a certain Checkpoint **Parameters:** -▪ **__namedParameters**: *object* - -Name | Type | Description | ------- | ------ | ------ | -`checkpointId` | number | checkpoint UUID | -`dividendsModule` | ERC20DividendCheckpoint_3_0_0 | - | +▪ **\_\_namedParameters**: _object_ -**Returns:** *Promise‹[BaseDividend](../interfaces/_polymathbase_.basedividend.md)[]›* +| Name | Type | Description | +| :--- | :--- | :--- | +| `checkpointId` | number | checkpoint UUID | +| `dividendsModule` | ERC20DividendCheckpoint\_3\_0\_0 | - | -___ +**Returns:** _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ -### getModuleAddressesByName +### getModuleAddressesByName -▸ **getModuleAddressesByName**(`__namedParameters`: object, `opts?`: [GetModuleAddressesByNameOpts](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md)): *Promise‹string[]›* +▸ **getModuleAddressesByName**\(`__namedParameters`: object, `opts?`: [GetModuleAddressesByNameOpts](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md)\): _Promise‹string\[\]›_ -*Defined in [src/PolymathBase.ts:485](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L485)* +_Defined in_ [_src/PolymathBase.ts:485_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L485) 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 | +▪ **\_\_namedParameters**: _object_ -▪`Optional` **opts**: *[GetModuleAddressesByNameOpts](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md)* +| Name | Type | Description | +| :--- | :--- | :--- | +| `moduleName` | ModuleName | name of the Module | +| `symbol` | string | symbol of the Security Token | -**Returns:** *Promise‹string[]›* +▪`Optional` **opts**: [_GetModuleAddressesByNameOpts_](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md) -___ +**Returns:** _Promise‹string\[\]›_ -### getModuleFactoryAddress +### getModuleFactoryAddress -▸ **getModuleFactoryAddress**(`__namedParameters`: object): *Promise‹string›* +▸ **getModuleFactoryAddress**\(`__namedParameters`: object\): _Promise‹string›_ -*Defined in [src/PolymathBase.ts:362](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L362)* +_Defined in_ [_src/PolymathBase.ts:362_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L362) Fetch the address of a specified Module Factory **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | Description | ------- | ------ | ------ | -`moduleName` | ModuleName | name of the Module corresponding to the Module Factory | -`tokenAddress` | string | address of the Security Token | +| Name | Type | Description | +| :--- | :--- | :--- | +| `moduleName` | ModuleName | name of the Module corresponding to the Module Factory | +| `tokenAddress` | string | address of the Security Token | -**Returns:** *Promise‹string›* +**Returns:** _Promise‹string›_ -___ +### getTreasuryWallet -### getTreasuryWallet +▸ **getTreasuryWallet**\(`__namedParameters`: object\): _Promise‹string›_ -▸ **getTreasuryWallet**(`__namedParameters`: object): *Promise‹string›* - -*Defined in [src/PolymathBase.ts:425](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L425)* +_Defined in_ [_src/PolymathBase.ts:425_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L425) 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 | +▪ **\_\_namedParameters**: _object_ -**Returns:** *Promise‹string›* +| 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 -▸ **roleToPermission**(`__namedParameters`: object): *Promise‹object›* +▸ **roleToPermission**\(`__namedParameters`: object\): _Promise‹object›_ -*Defined in [src/PolymathBase.ts:923](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L923)* +_Defined in_ [_src/PolymathBase.ts:923_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L923) **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | -Name | Type | ------- | ------ | -`role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | +**Returns:** _Promise‹object›_ -**Returns:** *Promise‹object›* diff --git a/docs/api/classes/_polymatherror_.polymatherror.md b/docs/api/classes/_polymatherror_.polymatherror.md index 36da5fd..c097aa1 100644 --- a/docs/api/classes/_polymatherror_.polymatherror.md +++ b/docs/api/classes/_polymatherror_.polymatherror.md @@ -1,4 +1,4 @@ -# Class: PolymathError +# PolymathError Wraps an error to give more information about it's type @@ -24,67 +24,60 @@ Wraps an error to give more information about it's type ## Constructors -### constructor +### constructor -\+ **new PolymathError**(`__namedParameters`: object): *[PolymathError](_polymatherror_.polymatherror.md)* ++ **new PolymathError**\(`__namedParameters`: object\): [_PolymathError_](_polymatherror_.polymatherror.md) -*Defined in [src/PolymathError.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24)* +_Defined in_ [_src/PolymathError.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24) **Parameters:** -▪ **__namedParameters**: *object* +▪ **\_\_namedParameters**: _object_ -Name | Type | ------- | ------ | -`code` | [ErrorCode](../enums/_types_index_.errorcode.md) | -`message` | undefined | string | +| Name | Type | +| :--- | :--- | +| `code` | [ErrorCode](../enums/_types_index_.errorcode.md) | +| `message` | undefined \| string | -**Returns:** *[PolymathError](_polymatherror_.polymatherror.md)* +**Returns:** [_PolymathError_](_polymatherror_.polymatherror.md) ## Properties -### code +### code -• **code**: *[ErrorCode](../enums/_types_index_.errorcode.md)* +• **code**: [_ErrorCode_](../enums/_types_index_.errorcode.md) -*Defined in [src/PolymathError.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24)* +_Defined in_ [_src/PolymathError.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24) -___ +### message -### message +• **message**: _string_ -• **message**: *string* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.es5.d.ts:964 -Defined in node_modules/typescript/lib/lib.es5.d.ts:964 +### name -___ +• **name**: _string_ -### name +_Inherited from void_ -• **name**: *string* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.es5.d.ts:963 - -___ +Defined in node\_modules/typescript/lib/lib.es5.d.ts:963 ### `Optional` stack -• **stack**? : *undefined | string* +• **stack**? : _undefined \| string_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.es5.d.ts:965 - -___ +Defined in node\_modules/typescript/lib/lib.es5.d.ts:965 ### `Static` Error -▪ **Error**: *ErrorConstructor* +▪ **Error**: _ErrorConstructor_ + +Defined in node\_modules/typescript/lib/lib.es5.d.ts:974 -Defined in node_modules/typescript/lib/lib.es5.d.ts:974 diff --git a/docs/api/classes/_procedures_approveerc20_.approveerc20.md b/docs/api/classes/_procedures_approveerc20_.approveerc20.md index e2f0fba..80ac528 100644 --- a/docs/api/classes/_procedures_approveerc20_.approveerc20.md +++ b/docs/api/classes/_procedures_approveerc20_.approveerc20.md @@ -1,4 +1,4 @@ -# Class: ApproveErc20 <**ReturnType**> +# ApproveErc20 Procedure to approve spending funds on an ERC20 token. If no token address is specified, it defaults to POLY @@ -34,94 +34,86 @@ Procedure to approve spending funds on an ERC20 token. If no token address is sp ## Constructors -### constructor +### constructor -\+ **new ApproveErc20**(`args`: [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md), `context`: [Context](_context_.context.md)): *[ApproveErc20](_procedures_approveerc20_.approveerc20.md)* ++ **new ApproveErc20**\(`args`: [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md), `context`: [Context](_context_.context.md)\): [_ApproveErc20_](_procedures_approveerc20_.approveerc20.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ApproveErc20](_procedures_approveerc20_.approveerc20.md)* +**Returns:** [_ApproveErc20_](_procedures_approveerc20_.approveerc20.md) ## Properties ### `Protected` args -• **args**: *[ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md)* +• **args**: [_ApproveErc20ProcedureArgs_](../interfaces/_types_index_.approveerc20procedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ApproveErc20 +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ApproveErc20 -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ApproveErc20.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L10)* +_Defined in_ [_src/procedures/ApproveErc20.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L10) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,86 +121,75 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ApproveErc20.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L21)* +_Defined in_ [_src/procedures/ApproveErc20.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L21) Approve spend of an ERC20 token by another wallet. The token in question defaults to POLY if no address is supplied Note that if the amount has already been approved, the spending approval transaction will not be added to the queue and the procedure will return -Note that the procedure will fail if the owner's token balance is less than the amount being approved. -The only exception to this is when approving a POLY spend on a testnet. -If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet +Note that the procedure will fail if the owner's token balance is less than the amount being approved. The only exception to this is when approving a POLY spend on a testnet. If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md b/docs/api/classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md index 1970cdb..b338e6e 100644 --- a/docs/api/classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md +++ b/docs/api/classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md @@ -1,7 +1,6 @@ -# Class: AssignSecurityTokenRole <**ReturnType**> +# AssignSecurityTokenRole -Procedure that assigns a Security Token Role to a delegate address. -Roles grant said delegate permissions over certain Security Token Features +Procedure that assigns a Security Token Role to a delegate address. Roles grant said delegate permissions over certain Security Token Features ## Type parameters @@ -35,94 +34,86 @@ Roles grant said delegate permissions over certain Security Token Features ## Constructors -### constructor +### constructor -\+ **new AssignSecurityTokenRole**(`args`: [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), `context`: [Context](_context_.context.md)): *[AssignSecurityTokenRole](_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md)* ++ **new AssignSecurityTokenRole**\(`args`: [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), `context`: [Context](_context_.context.md)\): [_AssignSecurityTokenRole_](_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[AssignSecurityTokenRole](_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md)* +**Returns:** [_AssignSecurityTokenRole_](_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) ## Properties ### `Protected` args -• **args**: *[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)* +• **args**: [_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.AssignSecurityTokenRole +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.AssignSecurityTokenRole -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/AssignSecurityTokenRole.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L17)* +_Defined in_ [_src/procedures/AssignSecurityTokenRole.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L17) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -130,86 +121,78 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/AssignSecurityTokenRole.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L28) -*Overrides void* +* If the delegate does not exist, the delegate address will be added +* The specified Role will be assigned/revoked to/from the delegate -*Defined in [src/procedures/AssignSecurityTokenRole.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L28)* +Note this procedure will fail if: -- If the delegate does not exist, the delegate address will be added -- The specified Role will be assigned/revoked to/from the delegate +* You attempt to assign a Role related to a Feature that hasn't been enabled +* The Permissions Feature hasn't been enabled on the Security Token +* You attempt to assign/revoke a Role that has already been assigned/revoked -Note this procedure will fail if: -- You attempt to assign a Role related to a Feature that hasn't been enabled -- The Permissions Feature hasn't been enabled on the Security Token -- You attempt to assign/revoke a Role that has already been assigned/revoked +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_assignstorole_.assignstorole.md b/docs/api/classes/_procedures_assignstorole_.assignstorole.md index 2ef8779..5f167fb 100644 --- a/docs/api/classes/_procedures_assignstorole_.assignstorole.md +++ b/docs/api/classes/_procedures_assignstorole_.assignstorole.md @@ -1,4 +1,4 @@ -# Class: AssignStoRole <**ReturnType**> +# AssignStoRole Procedure to assign an STO Role to a delegate @@ -34,94 +34,86 @@ Procedure to assign an STO Role to a delegate ## Constructors -### constructor +### constructor -\+ **new AssignStoRole**(`args`: [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), `context`: [Context](_context_.context.md)): *[AssignStoRole](_procedures_assignstorole_.assignstorole.md)* ++ **new AssignStoRole**\(`args`: [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), `context`: [Context](_context_.context.md)\): [_AssignStoRole_](_procedures_assignstorole_.assignstorole.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[AssignStoRole](_procedures_assignstorole_.assignstorole.md)* +**Returns:** [_AssignStoRole_](_procedures_assignstorole_.assignstorole.md) ## Properties ### `Protected` args -• **args**: *[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md)* +• **args**: [_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.AssignStoRole +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.AssignStoRole -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/AssignStoRole.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L17)* +_Defined in_ [_src/procedures/AssignStoRole.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L17) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/AssignStoRole.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L27) -*Overrides void* +* If the delegate does not exist, the delegate address will be added +* The specified Role will be assigned/revoked to/from the delegate -*Defined in [src/procedures/AssignStoRole.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L27)* +Note this procedure will fail if: -- If the delegate does not exist, the delegate address will be added -- The specified Role will be assigned/revoked to/from the delegate +* The Permissions Feature hasn't been enabled on the Security Token +* You attempt to assign/revoke a Role that has already been assigned/revoked -Note this procedure will fail if: -- The Permissions Feature hasn't been enabled on the Security Token -- You attempt to assign/revoke a Role that has already been assigned/revoked +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_controllerredeem_.controllerredeem.md b/docs/api/classes/_procedures_controllerredeem_.controllerredeem.md index fb441c6..e983377 100644 --- a/docs/api/classes/_procedures_controllerredeem_.controllerredeem.md +++ b/docs/api/classes/_procedures_controllerredeem_.controllerredeem.md @@ -1,7 +1,6 @@ -# Class: ControllerRedeem <**ReturnType**> +# ControllerRedeem -Procedure that redeems (burns) Security Tokens from an account. -Can only be executed by the Security Token's Controller +Procedure that redeems \(burns\) Security Tokens from an account. Can only be executed by the Security Token's Controller ## Type parameters @@ -35,94 +34,86 @@ Can only be executed by the Security Token's Controller ## Constructors -### constructor +### constructor -\+ **new ControllerRedeem**(`args`: [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md), `context`: [Context](_context_.context.md)): *[ControllerRedeem](_procedures_controllerredeem_.controllerredeem.md)* ++ **new ControllerRedeem**\(`args`: [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ControllerRedeem_](_procedures_controllerredeem_.controllerredeem.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ControllerRedeem](_procedures_controllerredeem_.controllerredeem.md)* +**Returns:** [_ControllerRedeem_](_procedures_controllerredeem_.controllerredeem.md) ## Properties ### `Protected` args -• **args**: *[ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md)* +• **args**: [_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ControllerRedeem +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ControllerRedeem -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ControllerRedeem.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L44)* +_Defined in_ [_src/procedures/ControllerRedeem.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L44) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -130,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ControllerRedeem.ts:54](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L54)* +_Defined in_ [_src/procedures/ControllerRedeem.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L54) Redeem tokens from a specific address, optionally providing a reason or extra data for the action Note this procedure will fail if: -- The "from" address is invalid -- Attempting to redeem an amount of tokens greater than the account's balance -- The current wallet address is not the Security Token controller address -**Returns:** *Promise‹void›* +* The "from" address is invalid +* Attempting to redeem an amount of tokens greater than the account's balance +* The current wallet address is not the Security Token controller address + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_controllertransfer_.controllertransfer.md b/docs/api/classes/_procedures_controllertransfer_.controllertransfer.md index 0b566dc..aa08186 100644 --- a/docs/api/classes/_procedures_controllertransfer_.controllertransfer.md +++ b/docs/api/classes/_procedures_controllertransfer_.controllertransfer.md @@ -1,7 +1,6 @@ -# Class: ControllerTransfer <**ReturnType**> +# ControllerTransfer -Procedure that forcefully transfers Security Tokens from one account to another. -Can only be executed by the Security Token's Controller +Procedure that forcefully transfers Security Tokens from one account to another. Can only be executed by the Security Token's Controller ## Type parameters @@ -35,94 +34,86 @@ Can only be executed by the Security Token's Controller ## Constructors -### constructor +### constructor -\+ **new ControllerTransfer**(`args`: [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md), `context`: [Context](_context_.context.md)): *[ControllerTransfer](_procedures_controllertransfer_.controllertransfer.md)* ++ **new ControllerTransfer**\(`args`: [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ControllerTransfer_](_procedures_controllertransfer_.controllertransfer.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ControllerTransfer](_procedures_controllertransfer_.controllertransfer.md)* +**Returns:** [_ControllerTransfer_](_procedures_controllertransfer_.controllertransfer.md) ## Properties ### `Protected` args -• **args**: *[ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md)* +• **args**: [_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ControllerTransfer +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ControllerTransfer -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ControllerTransfer.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L44)* +_Defined in_ [_src/procedures/ControllerTransfer.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L44) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -130,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ControllerTransfer.ts:54](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L54)* +_Defined in_ [_src/procedures/ControllerTransfer.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L54) Forcefully transfer tokens from one address to another Note this procedure will fail if: -- Any of the addresses are invalid -- The sender's ("from" address) balance is less than the amount being transferred -- The current wallet address is not the Security Token controller address -**Returns:** *Promise‹void›* +* Any of the addresses are invalid +* The sender's \("from" address\) balance is less than the amount being transferred +* The current wallet address is not the Security Token controller address + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_createcheckpoint_.createcheckpoint.md b/docs/api/classes/_procedures_createcheckpoint_.createcheckpoint.md index a28db04..d85dcae 100644 --- a/docs/api/classes/_procedures_createcheckpoint_.createcheckpoint.md +++ b/docs/api/classes/_procedures_createcheckpoint_.createcheckpoint.md @@ -1,4 +1,4 @@ -# Class: CreateCheckpoint +# CreateCheckpoint Procedure to create a Checkpoint on a Security Token @@ -30,94 +30,86 @@ Procedure to create a Checkpoint on a Security Token ## Constructors -### constructor +### constructor -\+ **new CreateCheckpoint**(`args`: [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), `context`: [Context](_context_.context.md)): *[CreateCheckpoint](_procedures_createcheckpoint_.createcheckpoint.md)* ++ **new CreateCheckpoint**\(`args`: [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), `context`: [Context](_context_.context.md)\): [_CreateCheckpoint_](_procedures_createcheckpoint_.createcheckpoint.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[CreateCheckpoint](_procedures_createcheckpoint_.createcheckpoint.md)* +**Returns:** [_CreateCheckpoint_](_procedures_createcheckpoint_.createcheckpoint.md) ## Properties ### `Protected` args -• **args**: *[CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md)* +• **args**: [_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.CreateCheckpoint +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateCheckpoint -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/CreateCheckpoint.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L27)* +_Defined in_ [_src/procedures/CreateCheckpoint.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L27) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,80 +117,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[Checkpoint](_entities_checkpoint_.checkpoint.md), TransactionReceiptWithDecodedLogs››* - -*Overrides void* - -*Defined in [src/procedures/CreateCheckpoint.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L32)* +_Defined in_ [_src/procedures/CreateCheckpoint.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L32) Create a Checkpoint on the Security Token and return it -**Returns:** *Promise‹PostTransactionResolver‹[Checkpoint](_entities_checkpoint_.checkpoint.md), TransactionReceiptWithDecodedLogs››* +**Returns:** _Promise‹PostTransactionResolver‹_[_Checkpoint_](_entities_checkpoint_.checkpoint.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/classes/_procedures_createdividenddistribution_.createdividenddistribution.md b/docs/api/classes/_procedures_createdividenddistribution_.createdividenddistribution.md index 749e37e..58c2a25 100644 --- a/docs/api/classes/_procedures_createdividenddistribution_.createdividenddistribution.md +++ b/docs/api/classes/_procedures_createdividenddistribution_.createdividenddistribution.md @@ -1,7 +1,6 @@ -# Class: CreateDividendDistribution +# CreateDividendDistribution -Procedure to create a Dividend Distribution on a Security Token. -The funds to be distributed as dividends will come from the current user's wallet +Procedure to create a Dividend Distribution on a Security Token. The funds to be distributed as dividends will come from the current user's wallet ## Hierarchy @@ -31,94 +30,86 @@ The funds to be distributed as dividends will come from the current user's walle ## Constructors -### constructor +### constructor -\+ **new CreateDividendDistribution**(`args`: [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), `context`: [Context](_context_.context.md)): *[CreateDividendDistribution](_procedures_createdividenddistribution_.createdividenddistribution.md)* ++ **new CreateDividendDistribution**\(`args`: [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), `context`: [Context](_context_.context.md)\): [_CreateDividendDistribution_](_procedures_createdividenddistribution_.createdividenddistribution.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[CreateDividendDistribution](_procedures_createdividenddistribution_.createdividenddistribution.md)* +**Returns:** [_CreateDividendDistribution_](_procedures_createdividenddistribution_.createdividenddistribution.md) ## Properties ### `Protected` args -• **args**: *[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)* +• **args**: [_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.CreateDividendDistribution +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateDividendDistribution -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/CreateDividendDistribution.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L27)* +_Defined in_ [_src/procedures/CreateDividendDistribution.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L27) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -126,85 +117,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md), TransactionReceiptWithDecodedLogs››* +_Defined in_ [_src/procedures/CreateDividendDistribution.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L37) -*Overrides void* - -*Defined in [src/procedures/CreateDividendDistribution.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L37)* - -- Approve spend of the amount that will be distributed -- Create a Dividend Distribution for said amount -- Set tax withholding percentages (if supplied) -- Return the newly created Dividend Distribution +* Approve spend of the amount that will be distributed +* Create a Dividend Distribution for said amount +* Set tax withholding percentages \(if supplied\) +* Return the newly created Dividend Distribution Note that this procedure will fail if the ERC20 Dividends Feature has not been enabled -**Returns:** *Promise‹PostTransactionResolver‹[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md), TransactionReceiptWithDecodedLogs››* +**Returns:** _Promise‹PostTransactionResolver‹_[_DividendDistribution_](_entities_dividenddistribution_.dividenddistribution.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/classes/_procedures_createsecuritytoken_.createsecuritytoken.md b/docs/api/classes/_procedures_createsecuritytoken_.createsecuritytoken.md index 5277ddc..bb3ab7c 100644 --- a/docs/api/classes/_procedures_createsecuritytoken_.createsecuritytoken.md +++ b/docs/api/classes/_procedures_createsecuritytoken_.createsecuritytoken.md @@ -1,4 +1,4 @@ -# Class: CreateSecurityToken +# CreateSecurityToken Procedure that creates a new Security Token on the Polymath ecosystem @@ -30,94 +30,86 @@ Procedure that creates a new Security Token on the Polymath ecosystem ## Constructors -### constructor +### constructor -\+ **new CreateSecurityToken**(`args`: [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), `context`: [Context](_context_.context.md)): *[CreateSecurityToken](_procedures_createsecuritytoken_.createsecuritytoken.md)* ++ **new CreateSecurityToken**\(`args`: [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), `context`: [Context](_context_.context.md)\): [_CreateSecurityToken_](_procedures_createsecuritytoken_.createsecuritytoken.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[CreateSecurityToken](_procedures_createsecuritytoken_.createsecuritytoken.md)* +**Returns:** [_CreateSecurityToken_](_procedures_createsecuritytoken_.createsecuritytoken.md) ## Properties ### `Protected` args -• **args**: *[CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md)* +• **args**: [_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.CreateSecurityToken +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateSecurityToken -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/CreateSecurityToken.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L20)* +_Defined in_ [_src/procedures/CreateSecurityToken.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L20) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,86 +117,78 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), TransactionReceiptWithDecodedLogs››* +_Defined in_ [_src/procedures/CreateSecurityToken.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L31) -*Overrides void* +* Approve spending the required POLY to pay the Security Token launch fee +* Create the new Security Token -*Defined in [src/procedures/CreateSecurityToken.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L31)* +Note that this procedure will fail if: -- Approve spending the required POLY to pay the Security Token launch fee -- Create the new Security Token +* The Security Token symbol hasn't been reserved +* The Security Token symbol has already been reserved by another issuer +* The Security Token already been launched -Note that this procedure will fail if: -- The Security Token symbol hasn't been reserved -- The Security Token symbol has already been reserved by another issuer -- The Security Token already been launched +**Returns:** _Promise‹PostTransactionResolver‹_[_SecurityToken_](_entities_securitytoken_securitytoken_.securitytoken.md)_, TransactionReceiptWithDecodedLogs››_ -**Returns:** *Promise‹PostTransactionResolver‹[SecurityToken](_entities_securitytoken_securitytoken_.securitytoken.md), TransactionReceiptWithDecodedLogs››* diff --git a/docs/api/classes/_procedures_disablecontroller_.disablecontroller.md b/docs/api/classes/_procedures_disablecontroller_.disablecontroller.md index 22cfe40..bbf7d6b 100644 --- a/docs/api/classes/_procedures_disablecontroller_.disablecontroller.md +++ b/docs/api/classes/_procedures_disablecontroller_.disablecontroller.md @@ -1,4 +1,4 @@ -# Class: DisableController <**ReturnType**> +# DisableController Procedure that permanently disables a Security Token's controller functionality. This requires the Security Token's owner to send signed data in acknowledgement @@ -34,94 +34,86 @@ Procedure that permanently disables a Security Token's controller functionality. ## Constructors -### constructor +### constructor -\+ **new DisableController**(`args`: [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md), `context`: [Context](_context_.context.md)): *[DisableController](_procedures_disablecontroller_.disablecontroller.md)* ++ **new DisableController**\(`args`: [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_DisableController_](_procedures_disablecontroller_.disablecontroller.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[DisableController](_procedures_disablecontroller_.disablecontroller.md)* +**Returns:** [_DisableController_](_procedures_disablecontroller_.disablecontroller.md) ## Properties ### `Protected` args -• **args**: *[DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md)* +• **args**: [_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.DisableController +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.DisableController -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/DisableController.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L14)* +_Defined in_ [_src/procedures/DisableController.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L14) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/DisableController.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L24) -*Overrides void* +* If no signature acknowledgement data \(optional\) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key +* Disable the Security Token's controller functionality -*Defined in [src/procedures/DisableController.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L24)* +Note that this procedure will fail if: -- If no signature acknowledgement data (optional) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key -- Disable the Security Token's controller functionality +* The current user is not the owner of the Security Token +* The controller has already been previously disabled -Note that this procedure will fail if: -- The current user is not the owner of the Security Token -- The controller has already been previously disabled +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_disablefeature_.disablefeature.md b/docs/api/classes/_procedures_disablefeature_.disablefeature.md index 0e186a3..1cd1a06 100644 --- a/docs/api/classes/_procedures_disablefeature_.disablefeature.md +++ b/docs/api/classes/_procedures_disablefeature_.disablefeature.md @@ -1,4 +1,4 @@ -# Class: DisableFeature <**ReturnType**> +# DisableFeature Procedure to disable a Feature on a Security Token @@ -34,94 +34,86 @@ Procedure to disable a Feature on a Security Token ## Constructors -### constructor +### constructor -\+ **new DisableFeature**(`args`: [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md), `context`: [Context](_context_.context.md)): *[DisableFeature](_procedures_disablefeature_.disablefeature.md)* ++ **new DisableFeature**\(`args`: [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md), `context`: [Context](_context_.context.md)\): [_DisableFeature_](_procedures_disablefeature_.disablefeature.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[DisableFeature](_procedures_disablefeature_.disablefeature.md)* +**Returns:** [_DisableFeature_](_procedures_disablefeature_.disablefeature.md) ## Properties ### `Protected` args -• **args**: *[DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md)* +• **args**: [_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.DisableFeature +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.DisableFeature -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/DisableFeature.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L15)* +_Defined in_ [_src/procedures/DisableFeature.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/DisableFeature.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L20)* +_Defined in_ [_src/procedures/DisableFeature.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L20) Disable the Feature by archiving the attached module that corresponds to that Feature -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md b/docs/api/classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md index 0d244e4..06119da 100644 --- a/docs/api/classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md +++ b/docs/api/classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md @@ -1,4 +1,4 @@ -# Class: EnableCountTransferManager <**ReturnType**> +# EnableCountTransferManager Procedure that enables Count Restrictions on a Security Token. This allows setting a number of maximum token holders. Any token transfer that would result in the amount of token holders to exceed this maximum will fail @@ -34,94 +34,86 @@ Procedure that enables Count Restrictions on a Security Token. This allows setti ## Constructors -### constructor +### constructor -\+ **new EnableCountTransferManager**(`args`: [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)): *[EnableCountTransferManager](_procedures_enablecounttransfermanager_.enablecounttransfermanager.md)* ++ **new EnableCountTransferManager**\(`args`: [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_EnableCountTransferManager_](_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[EnableCountTransferManager](_procedures_enablecounttransfermanager_.enablecounttransfermanager.md)* +**Returns:** [_EnableCountTransferManager_](_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) ## Properties ### `Protected` args -• **args**: *[EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md)* +• **args**: [_EnableCountTransferManagerProcedureArgs_](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.EnableCountTransferManager +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableCountTransferManager -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/EnableCountTransferManager.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L15)* +_Defined in_ [_src/procedures/EnableCountTransferManager.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/EnableCountTransferManager.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L20)* +_Defined in_ [_src/procedures/EnableCountTransferManager.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L20) Enable Count Restrictions on the Security Token and set the supplied max holder count -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_enabledividendmanager_.enabledividendmanager.md b/docs/api/classes/_procedures_enabledividendmanager_.enabledividendmanager.md index 7880a1a..fe9ed9b 100644 --- a/docs/api/classes/_procedures_enabledividendmanager_.enabledividendmanager.md +++ b/docs/api/classes/_procedures_enabledividendmanager_.enabledividendmanager.md @@ -1,4 +1,4 @@ -# Class: EnableDividendManager <**ReturnType**> +# EnableDividendManager Procedure that enables Dividends on a Security Token @@ -34,94 +34,86 @@ Procedure that enables Dividends on a Security Token ## Constructors -### constructor +### constructor -\+ **new EnableDividendManager**(`args`: [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md), `context`: [Context](_context_.context.md)): *[EnableDividendManager](_procedures_enabledividendmanager_.enabledividendmanager.md)* ++ **new EnableDividendManager**\(`args`: [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_EnableDividendManager_](_procedures_enabledividendmanager_.enabledividendmanager.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[EnableDividendManager](_procedures_enabledividendmanager_.enabledividendmanager.md)* +**Returns:** [_EnableDividendManager_](_procedures_enabledividendmanager_.enabledividendmanager.md) ## Properties ### `Protected` args -• **args**: *[EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md)* +• **args**: [_EnableDividendManagerProcedureArgs_](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.EnableDividendManager +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableDividendManager -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/EnableDividendManager.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L15)* +_Defined in_ [_src/procedures/EnableDividendManager.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/EnableDividendManager.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L20)* +_Defined in_ [_src/procedures/EnableDividendManager.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L20) Enable Dividends on the Security Token and set a wallet address where reclaimed dividends and withheld tax will be stored -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md b/docs/api/classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md index 2eeed09..1bfb853 100644 --- a/docs/api/classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md +++ b/docs/api/classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md @@ -1,4 +1,4 @@ -# Class: EnableGeneralPermissionManager <**ReturnType**> +# EnableGeneralPermissionManager Procedure that enables Permissions on a Security Token @@ -34,94 +34,86 @@ Procedure that enables Permissions on a Security Token ## Constructors -### constructor +### constructor -\+ **new EnableGeneralPermissionManager**(`args`: [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md), `context`: [Context](_context_.context.md)): *[EnableGeneralPermissionManager](_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md)* ++ **new EnableGeneralPermissionManager**\(`args`: [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_EnableGeneralPermissionManager_](_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[EnableGeneralPermissionManager](_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md)* +**Returns:** [_EnableGeneralPermissionManager_](_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) ## Properties ### `Protected` args -• **args**: *[EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md)* +• **args**: [_EnableGeneralPermissionManagerProcedureArgs_](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.EnableGeneralPermissionManager +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableGeneralPermissionManager -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/EnableGeneralPermissionManager.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L17)* +_Defined in_ [_src/procedures/EnableGeneralPermissionManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L17) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/EnableGeneralPermissionManager.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L22)* +_Defined in_ [_src/procedures/EnableGeneralPermissionManager.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L22) Enable Permissions on the Security Token -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md b/docs/api/classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md index 4192568..a106574 100644 --- a/docs/api/classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md +++ b/docs/api/classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md @@ -1,6 +1,6 @@ -# Class: EnableGeneralTransferManager <**ReturnType**> +# EnableGeneralTransferManager -Procedure that enables Tokenholders (specifically the KYC whitelist) on a Security Token. This comes enabled by default +Procedure that enables Tokenholders \(specifically the KYC whitelist\) on a Security Token. This comes enabled by default ## Type parameters @@ -34,94 +34,86 @@ Procedure that enables Tokenholders (specifically the KYC whitelist) on a Securi ## Constructors -### constructor +### constructor -\+ **new EnableGeneralTransferManager**(`args`: [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)): *[EnableGeneralTransferManager](_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md)* ++ **new EnableGeneralTransferManager**\(`args`: [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_EnableGeneralTransferManager_](_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[EnableGeneralTransferManager](_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md)* +**Returns:** [_EnableGeneralTransferManager_](_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) ## Properties ### `Protected` args -• **args**: *[EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md)* +• **args**: [_EnableGeneralTransferManagerProcedureArgs_](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.EnableGeneralTransferManager +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableGeneralTransferManager -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/EnableGeneralTransferManager.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L17)* +_Defined in_ [_src/procedures/EnableGeneralTransferManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L17) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/EnableGeneralTransferManager.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L22)* +_Defined in_ [_src/procedures/EnableGeneralTransferManager.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L22) Enable Tokenholders on the Security Token -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md b/docs/api/classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md index b0af471..1381487 100644 --- a/docs/api/classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md +++ b/docs/api/classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md @@ -1,4 +1,4 @@ -# Class: EnablePercentageTransferManager <**ReturnType**> +# EnablePercentageTransferManager Procedure that enables Percentage Ownership Restictions on a Security Token. This allows setting a maximum percentage of the total supply that a single tokenholder can own. Any token transfer that would result in a single tokenholder owning more than the allowed percentage will fail @@ -34,94 +34,86 @@ Procedure that enables Percentage Ownership Restictions on a Security Token. Thi ## Constructors -### constructor +### constructor -\+ **new EnablePercentageTransferManager**(`args`: [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)): *[EnablePercentageTransferManager](_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md)* ++ **new EnablePercentageTransferManager**\(`args`: [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_EnablePercentageTransferManager_](_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[EnablePercentageTransferManager](_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md)* +**Returns:** [_EnablePercentageTransferManager_](_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) ## Properties ### `Protected` args -• **args**: *[EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md)* +• **args**: [_EnablePercentageTransferManagerProcedureArgs_](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.EnablePercentageTransferManager +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnablePercentageTransferManager -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/EnablePercentageTransferManager.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L17)* +_Defined in_ [_src/procedures/EnablePercentageTransferManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L17) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,82 +121,73 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/EnablePercentageTransferManager.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L24)* +_Defined in_ [_src/procedures/EnablePercentageTransferManager.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L24) Enable Percentage Ownership restrictions and set the max ownership percentage and whether primary issuance is exempted from said restrictions Note: Primary issuance exemption is disallowed by default unless otherwise specified -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_finalizesto_.finalizesto.md b/docs/api/classes/_procedures_finalizesto_.finalizesto.md index e500f34..3e63df7 100644 --- a/docs/api/classes/_procedures_finalizesto_.finalizesto.md +++ b/docs/api/classes/_procedures_finalizesto_.finalizesto.md @@ -1,4 +1,4 @@ -# Class: FinalizeSto <**ReturnType**> +# FinalizeSto Procedure that finalizes an STO @@ -34,94 +34,86 @@ Procedure that finalizes an STO ## Constructors -### constructor +### constructor -\+ **new FinalizeSto**(`args`: [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), `context`: [Context](_context_.context.md)): *[FinalizeSto](_procedures_finalizesto_.finalizesto.md)* ++ **new FinalizeSto**\(`args`: [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), `context`: [Context](_context_.context.md)\): [_FinalizeSto_](_procedures_finalizesto_.finalizesto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[FinalizeSto](_procedures_finalizesto_.finalizesto.md)* +**Returns:** [_FinalizeSto_](_procedures_finalizesto_.finalizesto.md) ## Properties ### `Protected` args -• **args**: *[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md)* +• **args**: [_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.FinalizeSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.FinalizeSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/FinalizeSto.ts:60](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L60)* +_Defined in_ [_src/procedures/FinalizeSto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L60) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,88 +121,80 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ - -### prepare +### prepare -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -Mandatory method that builds a list of transactions that will be -run +Mandatory method that builds a list of transactions that will be run -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -___ +### prepareTransactions -### prepareTransactions +▸ **prepareTransactions**\(\): _Promise‹void›_ -▸ **prepareTransactions**(): *Promise‹void›* +_Overrides void_ -*Overrides void* - -*Defined in [src/procedures/FinalizeSto.ts:95](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L95)* +_Defined in_ [_src/procedures/FinalizeSto.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L95) Finalize the STO Note this procedure will fail if: -- The specified STO address is invalid -- The STO has not been launched or the module has been archived -- Attempting to finalize a Simple STO with version 3.0.0 or less -- The specified STO type is invalid -- The STO has already been finalized -- The STO's treasury wallet does not clear all transfer restrictions - -**Returns:** *Promise‹void›* + +* The specified STO address is invalid +* The STO has not been launched or the module has been archived +* Attempting to finalize a Simple STO with version 3.0.0 or less +* The specified STO type is invalid +* The STO has already been finalized +* The STO's treasury wallet does not clear all transfer restrictions + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_freezeissuance_.freezeissuance.md b/docs/api/classes/_procedures_freezeissuance_.freezeissuance.md index a379ca3..bbb80e3 100644 --- a/docs/api/classes/_procedures_freezeissuance_.freezeissuance.md +++ b/docs/api/classes/_procedures_freezeissuance_.freezeissuance.md @@ -1,4 +1,4 @@ -# Class: FreezeIssuance <**ReturnType**> +# FreezeIssuance Procedure that permanently freezes issuance of a Security Token. This requires the Security Token's owner to send signed data in acknowledgement @@ -34,94 +34,86 @@ Procedure that permanently freezes issuance of a Security Token. This requires t ## Constructors -### constructor +### constructor -\+ **new FreezeIssuance**(`args`: [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md), `context`: [Context](_context_.context.md)): *[FreezeIssuance](_procedures_freezeissuance_.freezeissuance.md)* ++ **new FreezeIssuance**\(`args`: [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md), `context`: [Context](_context_.context.md)\): [_FreezeIssuance_](_procedures_freezeissuance_.freezeissuance.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[FreezeIssuance](_procedures_freezeissuance_.freezeissuance.md)* +**Returns:** [_FreezeIssuance_](_procedures_freezeissuance_.freezeissuance.md) ## Properties ### `Protected` args -• **args**: *[FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md)* +• **args**: [_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.FreezeIssuance +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.FreezeIssuance -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/FreezeIssuance.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L14)* +_Defined in_ [_src/procedures/FreezeIssuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L14) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/FreezeIssuance.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L24) -*Overrides void* +* If no signature acknowledgement data \(optional\) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key +* Freeze the issuance of the Security Token -*Defined in [src/procedures/FreezeIssuance.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L24)* +Note this procedure will fail if: -- If no signature acknowledgement data (optional) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key -- Freeze the issuance of the Security Token +* The current user is not the owner of the Security Token +* Issuance has already been frozen -Note this procedure will fail if: -- The current user is not the owner of the Security Token -- Issuance has already been frozen +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_investinsimplesto_.investinsimplesto.md b/docs/api/classes/_procedures_investinsimplesto_.investinsimplesto.md index ad245d4..54d217c 100644 --- a/docs/api/classes/_procedures_investinsimplesto_.investinsimplesto.md +++ b/docs/api/classes/_procedures_investinsimplesto_.investinsimplesto.md @@ -1,4 +1,4 @@ -# Class: InvestInSimpleSto <**ReturnType**> +# InvestInSimpleSto Procedure that invests in a Simple STO @@ -34,94 +34,86 @@ Procedure that invests in a Simple STO ## Constructors -### constructor +### constructor -\+ **new InvestInSimpleSto**(`args`: [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md), `context`: [Context](_context_.context.md)): *[InvestInSimpleSto](_procedures_investinsimplesto_.investinsimplesto.md)* ++ **new InvestInSimpleSto**\(`args`: [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md), `context`: [Context](_context_.context.md)\): [_InvestInSimpleSto_](_procedures_investinsimplesto_.investinsimplesto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[InvestInSimpleSto](_procedures_investinsimplesto_.investinsimplesto.md)* +**Returns:** [_InvestInSimpleSto_](_procedures_investinsimplesto_.investinsimplesto.md) ## Properties ### `Protected` args -• **args**: *[InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md)* +• **args**: [_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.InvestInSimpleSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.InvestInSimpleSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/InvestInSimpleSto.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L41)* +_Defined in_ [_src/procedures/InvestInSimpleSto.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L41) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,90 +121,82 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ - -### prepare +### prepare -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -Mandatory method that builds a list of transactions that will be -run +Mandatory method that builds a list of transactions that will be run -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -___ +### prepareTransactions -### prepareTransactions +▸ **prepareTransactions**\(\): _Promise‹void›_ -▸ **prepareTransactions**(): *Promise‹void›* +_Overrides void_ -*Overrides void* - -*Defined in [src/procedures/InvestInSimpleSto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L56)* +_Defined in_ [_src/procedures/InvestInSimpleSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L56) Buy Security Tokens from the STO Note that this procedure will fail if: -- The Security Token doesn't exist -- The STO address is invalid -- The STO is either archived or hasn't been launched -- The STO hasn't started yet -- The STO is paused -- The STO has already been finalized -- Attempting to invest on behalf of another address when beneficial investments aren't allowed for the STO -- The STO doesn't support investments in the selected currency - -**Returns:** *Promise‹void›* + +* The Security Token doesn't exist +* The STO address is invalid +* The STO is either archived or hasn't been launched +* The STO hasn't started yet +* The STO is paused +* The STO has already been finalized +* Attempting to invest on behalf of another address when beneficial investments aren't allowed for the STO +* The STO doesn't support investments in the selected currency + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_investintieredsto_.investintieredsto.md b/docs/api/classes/_procedures_investintieredsto_.investintieredsto.md index 07e26ad..1a6c231 100644 --- a/docs/api/classes/_procedures_investintieredsto_.investintieredsto.md +++ b/docs/api/classes/_procedures_investintieredsto_.investintieredsto.md @@ -1,4 +1,4 @@ -# Class: InvestInTieredSto <**ReturnType**> +# InvestInTieredSto Procedure that invests in a Tiered STO @@ -8,7 +8,7 @@ Procedure that invests in a Tiered STO ## Hierarchy -* Procedure‹[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)› +* Procedure‹[InvestInTieredStoProcedureArgs](../external-modules/_types_index_.md#investintieredstoprocedureargs)› ↳ **InvestInTieredSto** @@ -34,94 +34,86 @@ Procedure that invests in a Tiered STO ## Constructors -### constructor +### constructor -\+ **new InvestInTieredSto**(`args`: [InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs), `context`: [Context](_context_.context.md)): *[InvestInTieredSto](_procedures_investintieredsto_.investintieredsto.md)* ++ **new InvestInTieredSto**\(`args`: [InvestInTieredStoProcedureArgs](../external-modules/_types_index_.md#investintieredstoprocedureargs), `context`: [Context](_context_.context.md)\): [_InvestInTieredSto_](_procedures_investintieredsto_.investintieredsto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [InvestInTieredStoProcedureArgs](../external-modules/_types_index_.md#investintieredstoprocedureargs) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[InvestInTieredSto](_procedures_investintieredsto_.investintieredsto.md)* +**Returns:** [_InvestInTieredSto_](_procedures_investintieredsto_.investintieredsto.md) ## Properties ### `Protected` args -• **args**: *[InvestInTieredStoProcedureArgs](../modules/_types_index_.md#investintieredstoprocedureargs)* +• **args**: [_InvestInTieredStoProcedureArgs_](../external-modules/_types_index_.md#investintieredstoprocedureargs) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.InvestInTieredSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.InvestInTieredSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/InvestInTieredSto.ts:42](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L42)* +_Defined in_ [_src/procedures/InvestInTieredSto.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L42) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,89 +121,81 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ - -### prepare +### prepare -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -Mandatory method that builds a list of transactions that will be -run +Mandatory method that builds a list of transactions that will be run -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -___ +### prepareTransactions -### prepareTransactions +▸ **prepareTransactions**\(\): _Promise‹void›_ -▸ **prepareTransactions**(): *Promise‹void›* +_Overrides void_ -*Overrides void* - -*Defined in [src/procedures/InvestInTieredSto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L56)* +_Defined in_ [_src/procedures/InvestInTieredSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L56) Invest the specified amount in the STO Note that this procedure will fail if: -- The Security Token doesn't exist -- The STO address is invalid -- The STO is either archived or hasn't been launched -- The STO hasn't started yet -- The STO is paused -- Trying to invest on behalf of someone else if the STO doesn't allow beneficial investments -- The STO doesn't support investments in the selected currency - -**Returns:** *Promise‹void›* + +* The Security Token doesn't exist +* The STO address is invalid +* The STO is either archived or hasn't been launched +* The STO hasn't started yet +* The STO is paused +* Trying to invest on behalf of someone else if the STO doesn't allow beneficial investments +* The STO doesn't support investments in the selected currency + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_issuetokens_.issuetokens.md b/docs/api/classes/_procedures_issuetokens_.issuetokens.md index a1c06dd..3ce3062 100644 --- a/docs/api/classes/_procedures_issuetokens_.issuetokens.md +++ b/docs/api/classes/_procedures_issuetokens_.issuetokens.md @@ -1,10 +1,10 @@ -# Class: IssueTokens +# IssueTokens Procedure that issues tokens to the specified addresses. KYC data for those addresses must already exist or otherwise be provided in this procedure ## Hierarchy -* Procedure‹[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]› +* Procedure‹[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)\[\]› ↳ **IssueTokens** @@ -30,94 +30,86 @@ Procedure that issues tokens to the specified addresses. KYC data for those addr ## Constructors -### constructor +### constructor -\+ **new IssueTokens**(`args`: [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), `context`: [Context](_context_.context.md)): *[IssueTokens](_procedures_issuetokens_.issuetokens.md)* ++ **new IssueTokens**\(`args`: [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), `context`: [Context](_context_.context.md)\): [_IssueTokens_](_procedures_issuetokens_.issuetokens.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[IssueTokens](_procedures_issuetokens_.issuetokens.md)* +**Returns:** [_IssueTokens_](_procedures_issuetokens_.issuetokens.md) ## Properties ### `Protected` args -• **args**: *[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md)* +• **args**: [_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.IssueTokens +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.IssueTokens -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/IssueTokens.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L36)* +_Defined in_ [_src/procedures/IssueTokens.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L36) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,86 +117,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* +_Defined in_ [_src/procedures/IssueTokens.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L47) -*Overrides void* +Issue the specified amounts to the corresponding addresses If KYC data is provided, transfer restrictions will not be checked before submitting the issuing transaction This means that if one of the wallets on the list doesn't clear transfer restrictions, the transaction will revert -*Defined in [src/procedures/IssueTokens.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L47)* +Note that this procedure will fail if: -Issue the specified amounts to the corresponding addresses -If KYC data is provided, transfer restrictions will not be checked before submitting the issuing transaction -This means that if one of the wallets on the list doesn't clear transfer restrictions, the transaction will revert +* The Security Token doesn't exist +* At least one wallet address doesn't clear transfer restrictions. This check is bypassed if new KYC data is provided -Note that this procedure will fail if: -- The Security Token doesn't exist -- At least one wallet address doesn't clear transfer restrictions. This check is bypassed if new KYC data is provided +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ -**Returns:** *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* diff --git a/docs/api/classes/_procedures_launchsimplesto_.launchsimplesto.md b/docs/api/classes/_procedures_launchsimplesto_.launchsimplesto.md index 64a910c..63c1b08 100644 --- a/docs/api/classes/_procedures_launchsimplesto_.launchsimplesto.md +++ b/docs/api/classes/_procedures_launchsimplesto_.launchsimplesto.md @@ -1,4 +1,4 @@ -# Class: LaunchSimpleSto +# LaunchSimpleSto Procedure that launches a Simple STO @@ -30,94 +30,86 @@ Procedure that launches a Simple STO ## Constructors -### constructor +### constructor -\+ **new LaunchSimpleSto**(`args`: [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), `context`: [Context](_context_.context.md)): *[LaunchSimpleSto](_procedures_launchsimplesto_.launchsimplesto.md)* ++ **new LaunchSimpleSto**\(`args`: [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), `context`: [Context](_context_.context.md)\): [_LaunchSimpleSto_](_procedures_launchsimplesto_.launchsimplesto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[LaunchSimpleSto](_procedures_launchsimplesto_.launchsimplesto.md)* +**Returns:** [_LaunchSimpleSto_](_procedures_launchsimplesto_.launchsimplesto.md) ## Properties ### `Protected` args -• **args**: *[LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md)* +• **args**: [_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.LaunchSimpleSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.LaunchSimpleSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/LaunchSimpleSto.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L27)* +_Defined in_ [_src/procedures/LaunchSimpleSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L27) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,87 +117,79 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SimpleSto_](_entities_simplesto_.simplesto.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[SimpleSto](_entities_simplesto_.simplesto.md), TransactionReceiptWithDecodedLogs››* +_Defined in_ [_src/procedures/LaunchSimpleSto.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L39) -*Overrides void* +* Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee +* Launch the Simple STO +* Allow pre-issuing \(if applicable\) +* Return the newly created STO -*Defined in [src/procedures/LaunchSimpleSto.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L39)* +Notes: -- Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee -- Launch the Simple STO -- Allow pre-issuing (if applicable) -- Return the newly created STO +* Pre-issuing defaults to false +* Pre-issuing can only be enabled on a version 3.1 \(or greater\) Simple STO. Attempting to do so in versions 3.0 or lower will cause the procedure to fail -Notes: -- Pre-issuing defaults to false -- Pre-issuing can only be enabled on a version 3.1 (or greater) Simple STO. Attempting to do so in versions 3.0 or lower will cause the procedure to fail +**Returns:** _Promise‹PostTransactionResolver‹_[_SimpleSto_](_entities_simplesto_.simplesto.md)_, TransactionReceiptWithDecodedLogs››_ -**Returns:** *Promise‹PostTransactionResolver‹[SimpleSto](_entities_simplesto_.simplesto.md), TransactionReceiptWithDecodedLogs››* diff --git a/docs/api/classes/_procedures_launchtieredsto_.launchtieredsto.md b/docs/api/classes/_procedures_launchtieredsto_.launchtieredsto.md index de242b7..ca53f2f 100644 --- a/docs/api/classes/_procedures_launchtieredsto_.launchtieredsto.md +++ b/docs/api/classes/_procedures_launchtieredsto_.launchtieredsto.md @@ -1,4 +1,4 @@ -# Class: LaunchTieredSto +# LaunchTieredSto Procedure that launches a Tiered STO @@ -30,94 +30,86 @@ Procedure that launches a Tiered STO ## Constructors -### constructor +### constructor -\+ **new LaunchTieredSto**(`args`: [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md), `context`: [Context](_context_.context.md)): *[LaunchTieredSto](_procedures_launchtieredsto_.launchtieredsto.md)* ++ **new LaunchTieredSto**\(`args`: [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md), `context`: [Context](_context_.context.md)\): [_LaunchTieredSto_](_procedures_launchtieredsto_.launchtieredsto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[LaunchTieredSto](_procedures_launchtieredsto_.launchtieredsto.md)* +**Returns:** [_LaunchTieredSto_](_procedures_launchtieredsto_.launchtieredsto.md) ## Properties ### `Protected` args -• **args**: *[LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md)* +• **args**: [_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.LaunchTieredSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.LaunchTieredSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/LaunchTieredSto.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L27)* +_Defined in_ [_src/procedures/LaunchTieredSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L27) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,88 +117,80 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_TieredSto_](_entities_tieredsto_.tieredsto.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[TieredSto](_entities_tieredsto_.tieredsto.md), TransactionReceiptWithDecodedLogs››* +_Defined in_ [_src/procedures/LaunchTieredSto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L40) -*Overrides void* +* Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee +* Launch the Tiered STO +* Allow pre-issuing \(if applicable, defaults to false\) +* Return the newly created STO -*Defined in [src/procedures/LaunchTieredSto.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L40)* +Note that this procedure will fail if: -- Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee -- Launch the Tiered STO -- Allow pre-issuing (if applicable, defaults to false) -- Return the newly created STO +* The supplied custom currency oracle addresses corresponding to the selected fund raise currencies are invalid +* Raising in Stable Coin and not providing stable coin addresses +* Attempting to allow pre-issuing on a version 3.0 STO -Note that this procedure will fail if: -- The supplied custom currency oracle addresses corresponding to the selected fund raise currencies are invalid -- Raising in Stable Coin and not providing stable coin addresses -- Attempting to allow pre-issuing on a version 3.0 STO +**Returns:** _Promise‹PostTransactionResolver‹_[_TieredSto_](_entities_tieredsto_.tieredsto.md)_, TransactionReceiptWithDecodedLogs››_ -**Returns:** *Promise‹PostTransactionResolver‹[TieredSto](_entities_tieredsto_.tieredsto.md), TransactionReceiptWithDecodedLogs››* diff --git a/docs/api/classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md b/docs/api/classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md index 158a27b..5d4edcf 100644 --- a/docs/api/classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md +++ b/docs/api/classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md @@ -1,4 +1,4 @@ -# Class: ModifyDividendsDefaultExclusionList <**ReturnType**> +# ModifyDividendsDefaultExclusionList Procedure that modifies the list of tokenholders which are excluded from receiving dividend payments @@ -34,94 +34,86 @@ Procedure that modifies the list of tokenholders which are excluded from receivi ## Constructors -### constructor +### constructor -\+ **new ModifyDividendsDefaultExclusionList**(`args`: [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyDividendsDefaultExclusionList](_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md)* ++ **new ModifyDividendsDefaultExclusionList**\(`args`: [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyDividendsDefaultExclusionList_](_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyDividendsDefaultExclusionList](_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md)* +**Returns:** [_ModifyDividendsDefaultExclusionList_](_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) ## Properties ### `Protected` args -• **args**: *[ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)* +• **args**: [_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyDividendsDefaultExclusionList +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyDividendsDefaultExclusionList -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyDividendsDefaultExclusionList.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L21)* +_Defined in_ [_src/procedures/ModifyDividendsDefaultExclusionList.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L21) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,82 +121,73 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ModifyDividendsDefaultExclusionList.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L28)* +_Defined in_ [_src/procedures/ModifyDividendsDefaultExclusionList.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L28) Set the default exclusion list for dividend distributions Note that this procedure will fail if the Dividends Feature is not enabled -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md b/docs/api/classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md index eba1f97..01fe373 100644 --- a/docs/api/classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md +++ b/docs/api/classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md @@ -1,4 +1,4 @@ -# Class: ModifyMaxHolderCount <**ReturnType**> +# ModifyMaxHolderCount Procedure that modifies the maximum amount of holders for the security token @@ -34,94 +34,86 @@ Procedure that modifies the maximum amount of holders for the security token ## Constructors -### constructor +### constructor -\+ **new ModifyMaxHolderCount**(`args`: [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyMaxHolderCount](_procedures_modifymaxholdercount_.modifymaxholdercount.md)* ++ **new ModifyMaxHolderCount**\(`args`: [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyMaxHolderCount_](_procedures_modifymaxholdercount_.modifymaxholdercount.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyMaxHolderCount](_procedures_modifymaxholdercount_.modifymaxholdercount.md)* +**Returns:** [_ModifyMaxHolderCount_](_procedures_modifymaxholdercount_.modifymaxholdercount.md) ## Properties ### `Protected` args -• **args**: *[ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)* +• **args**: [_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyMaxHolderCount +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyMaxHolderCount -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyMaxHolderCount.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L15)* +_Defined in_ [_src/procedures/ModifyMaxHolderCount.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,83 +121,73 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ModifyMaxHolderCount.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L23)* +_Defined in_ [_src/procedures/ModifyMaxHolderCount.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L23) Sets the maximum amount of holders for the security token -Note that this procedure will fail if the security token symbol doesn't exist -Note that this procedure will fail if the security token has disabled the TokenholderCountRestrictions feature +Note that this procedure will fail if the security token symbol doesn't exist Note that this procedure will fail if the security token has disabled the TokenholderCountRestrictions feature + +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md b/docs/api/classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md index e91a57b..7215c75 100644 --- a/docs/api/classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md +++ b/docs/api/classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md @@ -1,4 +1,4 @@ -# Class: ModifyMaxHolderPercentage <**ReturnType**> +# ModifyMaxHolderPercentage Procedure that modifies the maximum percentage that an individual token holder can hold @@ -34,94 +34,86 @@ Procedure that modifies the maximum percentage that an individual token holder c ## Constructors -### constructor +### constructor -\+ **new ModifyMaxHolderPercentage**(`args`: [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyMaxHolderPercentage](_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md)* ++ **new ModifyMaxHolderPercentage**\(`args`: [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyMaxHolderPercentage_](_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyMaxHolderPercentage](_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md)* +**Returns:** [_ModifyMaxHolderPercentage_](_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) ## Properties ### `Protected` args -• **args**: *[ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)* +• **args**: [_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyMaxHolderPercentage +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyMaxHolderPercentage -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyMaxHolderPercentage.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L15)* +_Defined in_ [_src/procedures/ModifyMaxHolderPercentage.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/ModifyMaxHolderPercentage.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L24) -*Overrides void* +Modify the number of security tokens \(expressed in percentage\) that an investor can hold as maximum -*Defined in [src/procedures/ModifyMaxHolderPercentage.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L24)* +Note that this procedure will fail if: -Modify the number of security tokens (expressed in percentage) that an investor can hold as maximum +* The security token symbol doesn't exist +* The security token has disabled the PercentageOwnershipRestrictions feature -Note that this procedure will fail if: -- The security token symbol doesn't exist -- The security token has disabled the PercentageOwnershipRestrictions feature +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md b/docs/api/classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md index 7eccfd8..00b6b43 100644 --- a/docs/api/classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md +++ b/docs/api/classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md @@ -1,4 +1,4 @@ -# Class: ModifyPercentageExemptions <**ReturnType**> +# ModifyPercentageExemptions Procedure responsible for modifying any exemption related to percentage restrictions @@ -34,94 +34,86 @@ Procedure responsible for modifying any exemption related to percentage restrict ## Constructors -### constructor +### constructor -\+ **new ModifyPercentageExemptions**(`args`: [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyPercentageExemptions](_procedures_modifypercentageexemptions_.modifypercentageexemptions.md)* ++ **new ModifyPercentageExemptions**\(`args`: [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyPercentageExemptions_](_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyPercentageExemptions](_procedures_modifypercentageexemptions_.modifypercentageexemptions.md)* +**Returns:** [_ModifyPercentageExemptions_](_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) ## Properties ### `Protected` args -• **args**: *[ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)* +• **args**: [_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyPercentageExemptions +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyPercentageExemptions -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyPercentageExemptions.ts:16](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L16)* +_Defined in_ [_src/procedures/ModifyPercentageExemptions.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L16) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,86 +121,78 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/ModifyPercentageExemptions.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L27) -*Overrides void* +* Update the list of addresses that are exempt from percentage restrictions \(if supplied\) +* Modify whether primary issuance is exempt from percentage restrictions \(if supplied\) -*Defined in [src/procedures/ModifyPercentageExemptions.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L27)* +Note that this procedure will fail if: -- Update the list of addresses that are exempt from percentage restrictions (if supplied) -- Modify whether primary issuance is exempt from percentage restrictions (if supplied) +* The data supplied to it is no different to the data in the contract +* The Security Token doesn't exist +* The Percentage Ownership Restrictions feature isn't enabled -Note that this procedure will fail if: -- The data supplied to it is no different to the data in the contract -- The Security Token doesn't exist -- The Percentage Ownership Restrictions feature isn't enabled +**Returns:** _Promise‹void›_ -**Returns:** *Promise‹void›* diff --git a/docs/api/classes/_procedures_modifytieredstodata_.modifytieredstodata.md b/docs/api/classes/_procedures_modifytieredstodata_.modifytieredstodata.md index bd5b7a8..04eeb50 100644 --- a/docs/api/classes/_procedures_modifytieredstodata_.modifytieredstodata.md +++ b/docs/api/classes/_procedures_modifytieredstodata_.modifytieredstodata.md @@ -1,4 +1,4 @@ -# Class: ModifyTieredStoData <**ReturnType**> +# ModifyTieredStoData Procedure that modifies the configuration parameters of a Tiered STO @@ -34,94 +34,86 @@ Procedure that modifies the configuration parameters of a Tiered STO ## Constructors -### constructor +### constructor -\+ **new ModifyTieredStoData**(`args`: [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyTieredStoData](_procedures_modifytieredstodata_.modifytieredstodata.md)* ++ **new ModifyTieredStoData**\(`args`: [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyTieredStoData_](_procedures_modifytieredstodata_.modifytieredstodata.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyTieredStoData](_procedures_modifytieredstodata_.modifytieredstodata.md)* +**Returns:** [_ModifyTieredStoData_](_procedures_modifytieredstodata_.modifytieredstodata.md) ## Properties ### `Protected` args -• **args**: *[ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)* +• **args**: [_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyTieredStoData +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyTieredStoData -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyTieredStoData.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L43)* +_Defined in_ [_src/procedures/ModifyTieredStoData.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L43) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,93 +121,85 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/ModifyTieredStoData.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L61) -*Overrides void* - -*Defined in [src/procedures/ModifyTieredStoData.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L61)* - -- Modify the start and end date of the STO -- Modify the fundraise types of the STO -- Modify the custom currency symbol and the oracles used to convert POLY and ETH to said currency -- Modify the STO's tiers (rates, tokens per tier and discounts when buying with POLY) -- Modify investment limits (min investment, max invested for non-accredited investors) -- Modify treasury wallet, wallet for unsold tokens and stable coin addresses +* Modify the start and end date of the STO +* Modify the fundraise types of the STO +* Modify the custom currency symbol and the oracles used to convert POLY and ETH to said currency +* Modify the STO's tiers \(rates, tokens per tier and discounts when buying with POLY\) +* Modify investment limits \(min investment, max invested for non-accredited investors\) +* Modify treasury wallet, wallet for unsold tokens and stable coin addresses Only transactions that will effectively present changes will be submitted Note that this procedure will fail if: -- The STO has not been enabled or has been archived -- The STO has already started -- Attempting to use a custom currency on an STO with version 3.0.0 or lower -- The supplied parameters don't represent any changes in the STO -**Returns:** *Promise‹void›* +* The STO has not been enabled or has been archived +* The STO has already started +* Attempting to use a custom currency on an STO with version 3.0.0 or lower +* The supplied parameters don't represent any changes in the STO + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md b/docs/api/classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md index 9b8d1e8..842f7b0 100644 --- a/docs/api/classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md +++ b/docs/api/classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md @@ -1,14 +1,14 @@ -# Class: ModifyTokenholderData +# ModifyTokenholderData -Procedure that modifies data for a list of (potential) tokenholders. The data that can be modified is: +Procedure that modifies data for a list of \(potential\) tokenholders. The data that can be modified is: -- KYC data (sale/buy lockup dates and KYC expiry) -- Whether the tokenholder is accredited -- Whether the tokenholder can buy from an STO +* KYC data \(sale/buy lockup dates and KYC expiry\) +* Whether the tokenholder is accredited +* Whether the tokenholder can buy from an STO ## Hierarchy -* Procedure‹[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]› +* Procedure‹[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)\[\]› ↳ **ModifyTokenholderData** @@ -34,94 +34,86 @@ Procedure that modifies data for a list of (potential) tokenholders. The data th ## Constructors -### constructor +### constructor -\+ **new ModifyTokenholderData**(`args`: [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), `context`: [Context](_context_.context.md)): *[ModifyTokenholderData](_procedures_modifytokenholderdata_.modifytokenholderdata.md)* ++ **new ModifyTokenholderData**\(`args`: [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ModifyTokenholderData_](_procedures_modifytokenholderdata_.modifytokenholderdata.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ModifyTokenholderData](_procedures_modifytokenholderdata_.modifytokenholderdata.md)* +**Returns:** [_ModifyTokenholderData_](_procedures_modifytokenholderdata_.modifytokenholderdata.md) ## Properties ### `Protected` args -• **args**: *[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md)* +• **args**: [_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ModifyTokenholderData +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyTokenholderData -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ModifyTokenholderData.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L31)* +_Defined in_ [_src/procedures/ModifyTokenholderData.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L31) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* - -*Overrides void* - -*Defined in [src/procedures/ModifyTokenholderData.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L41)* +_Defined in_ [_src/procedures/ModifyTokenholderData.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L41) Update tokenholder data for a subset of addresses Note that this procedure will fail if: -- You're trying to set the dates to 0 (there is a special "RevokeKyc" procedure for that) -- The Security Token doesn't exist -- There is no difference between the "new" data and the data already present in the contract -**Returns:** *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* +* You're trying to set the dates to 0 \(there is a special "RevokeKyc" procedure for that\) +* The Security Token doesn't exist +* There is no difference between the "new" data and the data already present in the contract + +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/classes/_procedures_pulldividendpayment_.pulldividendpayment.md b/docs/api/classes/_procedures_pulldividendpayment_.pulldividendpayment.md index e380741..49776cb 100644 --- a/docs/api/classes/_procedures_pulldividendpayment_.pulldividendpayment.md +++ b/docs/api/classes/_procedures_pulldividendpayment_.pulldividendpayment.md @@ -1,4 +1,4 @@ -# Class: PullDividendPayment <**ReturnType**> +# PullDividendPayment Procedure that allows a tokenholder to pull their dividend payments from a Dividend Distribution @@ -34,94 +34,86 @@ Procedure that allows a tokenholder to pull their dividend payments from a Divid ## Constructors -### constructor +### constructor -\+ **new PullDividendPayment**(`args`: [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md), `context`: [Context](_context_.context.md)): *[PullDividendPayment](_procedures_pulldividendpayment_.pulldividendpayment.md)* ++ **new PullDividendPayment**\(`args`: [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md), `context`: [Context](_context_.context.md)\): [_PullDividendPayment_](_procedures_pulldividendpayment_.pulldividendpayment.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[PullDividendPayment](_procedures_pulldividendpayment_.pulldividendpayment.md)* +**Returns:** [_PullDividendPayment_](_procedures_pulldividendpayment_.pulldividendpayment.md) ## Properties ### `Protected` args -• **args**: *[PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)* +• **args**: [_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.PullDividendPayment +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.PullDividendPayment -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/PullDividendPayment.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L33)* +_Defined in_ [_src/procedures/PullDividendPayment.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L33) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,86 +121,78 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/PullDividendPayment.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L44)* +_Defined in_ [_src/procedures/PullDividendPayment.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L44) Pull dividend payments from the Dividend Distribution Note this procedure will fail if: -- The Dividends Feature is not enabled -- The current wallet address is not a tokenholder -- The current wallet address has already received payment for this Dividend Distribution -- The current wallet address is on the exclusion list -**Returns:** *Promise‹void›* +* The Dividends Feature is not enabled +* The current wallet address is not a tokenholder +* The current wallet address has already received payment for this Dividend Distribution +* The current wallet address is on the exclusion list + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_pushdividendpayment_.pushdividendpayment.md b/docs/api/classes/_procedures_pushdividendpayment_.pushdividendpayment.md index 0ff1cd8..379ac79 100644 --- a/docs/api/classes/_procedures_pushdividendpayment_.pushdividendpayment.md +++ b/docs/api/classes/_procedures_pushdividendpayment_.pushdividendpayment.md @@ -1,4 +1,4 @@ -# Class: PushDividendPayment <**ReturnType**> +# PushDividendPayment Procedure that forwards a Dividend Distribution's payments to tokenholders @@ -34,94 +34,86 @@ Procedure that forwards a Dividend Distribution's payments to tokenholders ## Constructors -### constructor +### constructor -\+ **new PushDividendPayment**(`args`: [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md), `context`: [Context](_context_.context.md)): *[PushDividendPayment](_procedures_pushdividendpayment_.pushdividendpayment.md)* ++ **new PushDividendPayment**\(`args`: [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md), `context`: [Context](_context_.context.md)\): [_PushDividendPayment_](_procedures_pushdividendpayment_.pushdividendpayment.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[PushDividendPayment](_procedures_pushdividendpayment_.pushdividendpayment.md)* +**Returns:** [_PushDividendPayment_](_procedures_pushdividendpayment_.pushdividendpayment.md) ## Properties ### `Protected` args -• **args**: *[PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)* +• **args**: [_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.PushDividendPayment +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.PushDividendPayment -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/PushDividendPayment.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L37)* +_Defined in_ [_src/procedures/PushDividendPayment.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L37) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/PushDividendPayment.ts:46](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L46)* +_Defined in_ [_src/procedures/PushDividendPayment.ts:46_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L46) Push dividends to provided tokenholder addresses Note that this procedure will fail if: -- The Security Token doesn't exist -- The Dividends Feature hasn't been enabled -**Returns:** *Promise‹void›* +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_reclaimfunds_.reclaimfunds.md b/docs/api/classes/_procedures_reclaimfunds_.reclaimfunds.md index 6da096a..bfe680e 100644 --- a/docs/api/classes/_procedures_reclaimfunds_.reclaimfunds.md +++ b/docs/api/classes/_procedures_reclaimfunds_.reclaimfunds.md @@ -1,4 +1,4 @@ -# Class: ReclaimFunds <**ReturnType**> +# ReclaimFunds Procedure that allows the issuer to reclaim dividends after they expire without being claimed by tokenholders @@ -34,94 +34,86 @@ Procedure that allows the issuer to reclaim dividends after they expire without ## Constructors -### constructor +### constructor -\+ **new ReclaimFunds**(`args`: [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md), `context`: [Context](_context_.context.md)): *[ReclaimFunds](_procedures_reclaimfunds_.reclaimfunds.md)* ++ **new ReclaimFunds**\(`args`: [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ReclaimFunds_](_procedures_reclaimfunds_.reclaimfunds.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ReclaimFunds](_procedures_reclaimfunds_.reclaimfunds.md)* +**Returns:** [_ReclaimFunds_](_procedures_reclaimfunds_.reclaimfunds.md) ## Properties ### `Protected` args -• **args**: *[ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md)* +• **args**: [_ReclaimFundsProcedureArgs_](../interfaces/_types_index_.reclaimfundsprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ReclaimFunds +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ReclaimFunds -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ReclaimFunds.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L28)* +_Defined in_ [_src/procedures/ReclaimFunds.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L28) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ReclaimFunds.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L37)* +_Defined in_ [_src/procedures/ReclaimFunds.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L37) Reclaim funds Note that this procedure will fail if: -- The Security Token doesn't exist -- The Dividends Feature hasn't been enabled -**Returns:** *Promise‹void›* +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_removedocument_.removedocument.md b/docs/api/classes/_procedures_removedocument_.removedocument.md index 9ff2b34..45f19a4 100644 --- a/docs/api/classes/_procedures_removedocument_.removedocument.md +++ b/docs/api/classes/_procedures_removedocument_.removedocument.md @@ -1,4 +1,4 @@ -# Class: RemoveDocument <**ReturnType**> +# RemoveDocument Procedure that removes a document from a Security Token @@ -34,94 +34,86 @@ Procedure that removes a document from a Security Token ## Constructors -### constructor +### constructor -\+ **new RemoveDocument**(`args`: [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md), `context`: [Context](_context_.context.md)): *[RemoveDocument](_procedures_removedocument_.removedocument.md)* ++ **new RemoveDocument**\(`args`: [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md), `context`: [Context](_context_.context.md)\): [_RemoveDocument_](_procedures_removedocument_.removedocument.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[RemoveDocument](_procedures_removedocument_.removedocument.md)* +**Returns:** [_RemoveDocument_](_procedures_removedocument_.removedocument.md) ## Properties ### `Protected` args -• **args**: *[RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md)* +• **args**: [_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.RemoveDocument +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.RemoveDocument -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/RemoveDocument.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L15)* +_Defined in_ [_src/procedures/RemoveDocument.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/RemoveDocument.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L25)* +_Defined in_ [_src/procedures/RemoveDocument.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L25) Remove a document from the Security Token Note that this procedure will fail if: -- The current wallet is not the Security Token owner -- The name of the document is less than 1 or more than 32 characters long -- The document doesn't exist in the Security Token -**Returns:** *Promise‹void›* +* The current wallet is not the Security Token owner +* The name of the document is less than 1 or more than 32 characters long +* The document doesn't exist in the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md b/docs/api/classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md index 1149b75..7238090 100644 --- a/docs/api/classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md +++ b/docs/api/classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md @@ -1,8 +1,8 @@ -# Class: ReserveSecurityToken +# ReserveSecurityToken -Procedure that reserves a token ticker (symbol) to be used later on to launch a Security Token +Procedure that reserves a token ticker \(symbol\) to be used later on to launch a Security Token -***Note if the Reservation expires and the corresponding Security Token hasn't been launched yet, another issuer can reserve the same ticker*** +_**Note if the Reservation expires and the corresponding Security Token hasn't been launched yet, another issuer can reserve the same ticker**_ ## Hierarchy @@ -32,94 +32,86 @@ Procedure that reserves a token ticker (symbol) to be used later on to launch a ## Constructors -### constructor +### constructor -\+ **new ReserveSecurityToken**(`args`: [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), `context`: [Context](_context_.context.md)): *[ReserveSecurityToken](_procedures_reservesecuritytoken_.reservesecuritytoken.md)* ++ **new ReserveSecurityToken**\(`args`: [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ReserveSecurityToken_](_procedures_reservesecuritytoken_.reservesecuritytoken.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ReserveSecurityToken](_procedures_reservesecuritytoken_.reservesecuritytoken.md)* +**Returns:** [_ReserveSecurityToken_](_procedures_reservesecuritytoken_.reservesecuritytoken.md) ## Properties ### `Protected` args -• **args**: *[ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md)* +• **args**: [_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ReserveSecurityToken +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ReserveSecurityToken -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ReserveSecurityToken.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L30)* +_Defined in_ [_src/procedures/ReserveSecurityToken.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L30) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -127,82 +119,73 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_, TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md), TransactionReceiptWithDecodedLogs››* - -*Overrides void* - -*Defined in [src/procedures/ReserveSecurityToken.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L37)* +_Defined in_ [_src/procedures/ReserveSecurityToken.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L37) Reserve a new ticker Note that this procedure will fail if ticker has already been registered -**Returns:** *Promise‹PostTransactionResolver‹[SecurityTokenReservation](_entities_securitytokenreservation_.securitytokenreservation.md), TransactionReceiptWithDecodedLogs››* +**Returns:** _Promise‹PostTransactionResolver‹_[_SecurityTokenReservation_](_entities_securitytokenreservation_.securitytokenreservation.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/classes/_procedures_revokekyc_.revokekyc.md b/docs/api/classes/_procedures_revokekyc_.revokekyc.md index 75e4f22..49bd11b 100644 --- a/docs/api/classes/_procedures_revokekyc_.revokekyc.md +++ b/docs/api/classes/_procedures_revokekyc_.revokekyc.md @@ -1,10 +1,10 @@ -# Class: RevokeKyc +# RevokeKyc Procedure that revokes KYC for a list of investors ## Hierarchy -* Procedure‹[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)[]› +* Procedure‹[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), [Tokenholder](_entities_tokenholder_.tokenholder.md)\[\]› ↳ **RevokeKyc** @@ -30,94 +30,86 @@ Procedure that revokes KYC for a list of investors ## Constructors -### constructor +### constructor -\+ **new RevokeKyc**(`args`: [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), `context`: [Context](_context_.context.md)): *[RevokeKyc](_procedures_revokekyc_.revokekyc.md)* ++ **new RevokeKyc**\(`args`: [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), `context`: [Context](_context_.context.md)\): [_RevokeKyc_](_procedures_revokekyc_.revokekyc.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[RevokeKyc](_procedures_revokekyc_.revokekyc.md)* +**Returns:** [_RevokeKyc_](_procedures_revokekyc_.revokekyc.md) ## Properties ### `Protected` args -• **args**: *[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md)* +• **args**: [_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.RevokeKyc +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.RevokeKyc -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/RevokeKyc.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L12)* +_Defined in_ [_src/procedures/RevokeKyc.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L12) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -125,86 +117,78 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* - -*Overrides void* - -*Defined in [src/procedures/RevokeKyc.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L23)* +_Defined in_ [_src/procedures/RevokeKyc.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L23) Sets all KYC dates for a tokenholder to epoch. This effectively makes them unable to send or receive Security Tokens Note that this procedure will fail if: -- The tokenholder address array is empty -- The Security Token doesn't exist -- KYC is already revoked for at least one of the addresses in the list -- Tokenholders Feature isn't enabled -**Returns:** *Promise‹PostTransactionResolver‹[Tokenholder](_entities_tokenholder_.tokenholder.md)[], TransactionReceiptWithDecodedLogs››* +* The tokenholder address array is empty +* The Security Token doesn't exist +* KYC is already revoked for at least one of the addresses in the list +* Tokenholders Feature isn't enabled + +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/classes/_procedures_setcontroller_.setcontroller.md b/docs/api/classes/_procedures_setcontroller_.setcontroller.md index d4f438c..68f3ed1 100644 --- a/docs/api/classes/_procedures_setcontroller_.setcontroller.md +++ b/docs/api/classes/_procedures_setcontroller_.setcontroller.md @@ -1,7 +1,6 @@ -# Class: SetController <**ReturnType**> +# SetController -Procedure that sets the Controller of a Security Token. -A Security Token's Controller can perform special functions reserved solely for them, such as forced transfers and redeeming (burning) tokens +Procedure that sets the Controller of a Security Token. A Security Token's Controller can perform special functions reserved solely for them, such as forced transfers and redeeming \(burning\) tokens ## Type parameters @@ -35,94 +34,86 @@ A Security Token's Controller can perform special functions reserved solely for ## Constructors -### constructor +### constructor -\+ **new SetController**(`args`: [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md), `context`: [Context](_context_.context.md)): *[SetController](_procedures_setcontroller_.setcontroller.md)* ++ **new SetController**\(`args`: [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SetController_](_procedures_setcontroller_.setcontroller.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SetController](_procedures_setcontroller_.setcontroller.md)* +**Returns:** [_SetController_](_procedures_setcontroller_.setcontroller.md) ## Properties ### `Protected` args -• **args**: *[SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md)* +• **args**: [_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SetController +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetController -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SetController.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L11)* +_Defined in_ [_src/procedures/SetController.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L11) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -130,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SetController.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L20)* +_Defined in_ [_src/procedures/SetController.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L20) Set the Controller address of the Security Token Note this procedure will fail if: -- The supplied address is invalid -- The current wallet address is not the owner of the Security Token -**Returns:** *Promise‹void›* +* The supplied address is invalid +* The current wallet address is not the owner of the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_setdividendswallet_.setdividendswallet.md b/docs/api/classes/_procedures_setdividendswallet_.setdividendswallet.md index f620b2c..c6ec0fa 100644 --- a/docs/api/classes/_procedures_setdividendswallet_.setdividendswallet.md +++ b/docs/api/classes/_procedures_setdividendswallet_.setdividendswallet.md @@ -1,4 +1,4 @@ -# Class: SetDividendsWallet <**ReturnType**> +# SetDividendsWallet Procedure that modifies the wallet address where reclaimed dividends and withheld taxes are kept @@ -34,94 +34,86 @@ Procedure that modifies the wallet address where reclaimed dividends and withhel ## Constructors -### constructor +### constructor -\+ **new SetDividendsWallet**(`args`: [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md), `context`: [Context](_context_.context.md)): *[SetDividendsWallet](_procedures_setdividendswallet_.setdividendswallet.md)* ++ **new SetDividendsWallet**\(`args`: [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SetDividendsWallet_](_procedures_setdividendswallet_.setdividendswallet.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SetDividendsWallet](_procedures_setdividendswallet_.setdividendswallet.md)* +**Returns:** [_SetDividendsWallet_](_procedures_setdividendswallet_.setdividendswallet.md) ## Properties ### `Protected` args -• **args**: *[SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md)* +• **args**: [_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SetDividendsWallet +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetDividendsWallet -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SetDividendsWallet.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L15)* +_Defined in_ [_src/procedures/SetDividendsWallet.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L15) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SetDividendsWallet.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L24)* +_Defined in_ [_src/procedures/SetDividendsWallet.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L24) Change the dividends storage wallet address Note that this procedure will fail if: -- The Security Token doesn't exist -- The Dividends Feature hasn't been enabled -**Returns:** *Promise‹void›* +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_setdocument_.setdocument.md b/docs/api/classes/_procedures_setdocument_.setdocument.md index f73f199..343bb96 100644 --- a/docs/api/classes/_procedures_setdocument_.setdocument.md +++ b/docs/api/classes/_procedures_setdocument_.setdocument.md @@ -1,4 +1,4 @@ -# Class: SetDocument <**ReturnType**> +# SetDocument Procedure that adds a document to a Security Token @@ -34,94 +34,86 @@ Procedure that adds a document to a Security Token ## Constructors -### constructor +### constructor -\+ **new SetDocument**(`args`: [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md), `context`: [Context](_context_.context.md)): *[SetDocument](_procedures_setdocument_.setdocument.md)* ++ **new SetDocument**\(`args`: [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SetDocument_](_procedures_setdocument_.setdocument.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SetDocument](_procedures_setdocument_.setdocument.md)* +**Returns:** [_SetDocument_](_procedures_setdocument_.setdocument.md) ## Properties ### `Protected` args -• **args**: *[SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md)* +• **args**: [_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SetDocument +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetDocument -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SetDocument.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L10)* +_Defined in_ [_src/procedures/SetDocument.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L10) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SetDocument.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L20)* +_Defined in_ [_src/procedures/SetDocument.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L20) Set a document on the Security Token Note that this procedure will fail if: -- The current wallet is not the Security Token owner -- The name of the document is less than 1 or more than 32 characters long -- The document hash is less than 1 or more than 32 characters long -**Returns:** *Promise‹void›* +* The current wallet is not the Security Token owner +* The name of the document is less than 1 or more than 32 characters long +* The document hash is less than 1 or more than 32 characters long + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md b/docs/api/classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md index 87da1ea..9886de5 100644 --- a/docs/api/classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md +++ b/docs/api/classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md @@ -1,4 +1,4 @@ -# Class: SignDisableControllerAck <**ReturnType**> +# SignDisableControllerAck Procedure that signs an acknowledgement to permanently disable a Security Token's Controller functionality @@ -34,94 +34,86 @@ Procedure that signs an acknowledgement to permanently disable a Security Token' ## Constructors -### constructor +### constructor -\+ **new SignDisableControllerAck**(`args`: [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md), `context`: [Context](_context_.context.md)): *[SignDisableControllerAck](_procedures_signdisablecontrollerack_.signdisablecontrollerack.md)* ++ **new SignDisableControllerAck**\(`args`: [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SignDisableControllerAck_](_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SignDisableControllerAck](_procedures_signdisablecontrollerack_.signdisablecontrollerack.md)* +**Returns:** [_SignDisableControllerAck_](_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) ## Properties ### `Protected` args -• **args**: *[SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)* +• **args**: [_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SignDisableControllerAck +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignDisableControllerAck -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SignDisableControllerAck.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L9)* +_Defined in_ [_src/procedures/SignDisableControllerAck.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L9) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SignDisableControllerAck.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L14)* +_Defined in_ [_src/procedures/SignDisableControllerAck.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L14) Sign data to confirm the intent of permanently disabling the Security Token's Controller functionality -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md b/docs/api/classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md index 46b6d3f..cda5570 100644 --- a/docs/api/classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md +++ b/docs/api/classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md @@ -1,4 +1,4 @@ -# Class: SignFreezeIssuanceAck <**ReturnType**> +# SignFreezeIssuanceAck Procedure that signs an acknowledgement to permanently freeze issuance of a Security Token @@ -34,94 +34,86 @@ Procedure that signs an acknowledgement to permanently freeze issuance of a Secu ## Constructors -### constructor +### constructor -\+ **new SignFreezeIssuanceAck**(`args`: [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md), `context`: [Context](_context_.context.md)): *[SignFreezeIssuanceAck](_procedures_signfreezeissuanceack_.signfreezeissuanceack.md)* ++ **new SignFreezeIssuanceAck**\(`args`: [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SignFreezeIssuanceAck_](_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SignFreezeIssuanceAck](_procedures_signfreezeissuanceack_.signfreezeissuanceack.md)* +**Returns:** [_SignFreezeIssuanceAck_](_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) ## Properties ### `Protected` args -• **args**: *[SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)* +• **args**: [_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SignFreezeIssuanceAck +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignFreezeIssuanceAck -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SignFreezeIssuanceAck.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L9)* +_Defined in_ [_src/procedures/SignFreezeIssuanceAck.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L9) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,80 +121,71 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SignFreezeIssuanceAck.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L14)* +_Defined in_ [_src/procedures/SignFreezeIssuanceAck.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L14) Sign data to confirm the intent of permanently disabling issuance of the Security Token -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_signtransferdata_.signtransferdata.md b/docs/api/classes/_procedures_signtransferdata_.signtransferdata.md index 1158dbb..08762a1 100644 --- a/docs/api/classes/_procedures_signtransferdata_.signtransferdata.md +++ b/docs/api/classes/_procedures_signtransferdata_.signtransferdata.md @@ -1,8 +1,6 @@ -# Class: SignTransferData <**ReturnType**> +# SignTransferData -Procedure that signs KYC data for transfers. -This signature can be used to simulate updates to KYC data when checking if a transfer can be made or to actually modify said data at the moment of performing a transfer without having to do it in a separate transaction. -The signature has a period of validity which is specified by the parameters passed to the procedure +Procedure that signs KYC data for transfers. This signature can be used to simulate updates to KYC data when checking if a transfer can be made or to actually modify said data at the moment of performing a transfer without having to do it in a separate transaction. The signature has a period of validity which is specified by the parameters passed to the procedure ## Type parameters @@ -36,94 +34,86 @@ The signature has a period of validity which is specified by the parameters pass ## Constructors -### constructor +### constructor -\+ **new SignTransferData**(`args`: [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md), `context`: [Context](_context_.context.md)): *[SignTransferData](_procedures_signtransferdata_.signtransferdata.md)* ++ **new SignTransferData**\(`args`: [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md), `context`: [Context](_context_.context.md)\): [_SignTransferData_](_procedures_signtransferdata_.signtransferdata.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[SignTransferData](_procedures_signtransferdata_.signtransferdata.md)* +**Returns:** [_SignTransferData_](_procedures_signtransferdata_.signtransferdata.md) ## Properties ### `Protected` args -• **args**: *[SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md)* +• **args**: [_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.SignTransferData +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignTransferData -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/SignTransferData.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L11)* +_Defined in_ [_src/procedures/SignTransferData.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L11) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -131,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/SignTransferData.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L20)* +_Defined in_ [_src/procedures/SignTransferData.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L20) Sign KYC data, passing the valid dates and extra kyc data Note this procedure will fail if: -- The signature validity period starting date (validFrom) is later than the end date (validTo) -- The validity period end date (validTo) is in the past -**Returns:** *Promise‹void›* +* The signature validity period starting date \(validFrom\) is later than the end date \(validTo\) +* The validity period end date \(validTo\) is in the past + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md b/docs/api/classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md index ccbff26..ad957d0 100644 --- a/docs/api/classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md +++ b/docs/api/classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md @@ -1,4 +1,4 @@ -# Class: ToggleAllowBeneficialInvestments <**ReturnType**> +# ToggleAllowBeneficialInvestments Procedure that toggles whether beneficial investments are allowed or not in an STO @@ -34,94 +34,86 @@ Procedure that toggles whether beneficial investments are allowed or not in an S ## Constructors -### constructor +### constructor -\+ **new ToggleAllowBeneficialInvestments**(`args`: [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), `context`: [Context](_context_.context.md)): *[ToggleAllowBeneficialInvestments](_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md)* ++ **new ToggleAllowBeneficialInvestments**\(`args`: [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ToggleAllowBeneficialInvestments_](_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ToggleAllowBeneficialInvestments](_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md)* +**Returns:** [_ToggleAllowBeneficialInvestments_](_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) ## Properties ### `Protected` args -• **args**: *[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)* +• **args**: [_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ToggleAllowBeneficialInvestments +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleAllowBeneficialInvestments -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ToggleAllowBeneficialInvestments.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L57)* +_Defined in_ [_src/procedures/ToggleAllowBeneficialInvestments.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L57) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,87 +121,79 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ToggleAllowBeneficialInvestments.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L69)* +_Defined in_ [_src/procedures/ToggleAllowBeneficialInvestments.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L69) Toggle to allow or disallow beneficial investments in the STO Note this procedure will fail if: -- Trying to allow beneficial investments when they are already allowed -- Trying to disallow beneficial investments when they are already disallowed -- The specified STO address is invalid -- The specified STO type is invalid -- The STO has not been launched, or the module has been archived -**Returns:** *Promise‹void›* +* Trying to allow beneficial investments when they are already allowed +* Trying to disallow beneficial investments when they are already disallowed +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md b/docs/api/classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md index 5c3f566..31166f4 100644 --- a/docs/api/classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md +++ b/docs/api/classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md @@ -1,4 +1,4 @@ -# Class: ToggleAllowPreIssuing <**ReturnType**> +# ToggleAllowPreIssuing Procedure that toggles whether pre-issuing of tokens is allowed or not in an STO @@ -34,94 +34,86 @@ Procedure that toggles whether pre-issuing of tokens is allowed or not in an STO ## Constructors -### constructor +### constructor -\+ **new ToggleAllowPreIssuing**(`args`: [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), `context`: [Context](_context_.context.md)): *[ToggleAllowPreIssuing](_procedures_toggleallowpreissuing_.toggleallowpreissuing.md)* ++ **new ToggleAllowPreIssuing**\(`args`: [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ToggleAllowPreIssuing_](_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ToggleAllowPreIssuing](_procedures_toggleallowpreissuing_.toggleallowpreissuing.md)* +**Returns:** [_ToggleAllowPreIssuing_](_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) ## Properties ### `Protected` args -• **args**: *[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)* +• **args**: [_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ToggleAllowPreIssuing +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleAllowPreIssuing -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ToggleAllowPreIssuing.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L59)* +_Defined in_ [_src/procedures/ToggleAllowPreIssuing.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L59) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,88 +121,80 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ - -### prepare +### prepare -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -Mandatory method that builds a list of transactions that will be -run +Mandatory method that builds a list of transactions that will be run -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -___ +### prepareTransactions -### prepareTransactions +▸ **prepareTransactions**\(\): _Promise‹void›_ -▸ **prepareTransactions**(): *Promise‹void›* +_Overrides void_ -*Overrides void* - -*Defined in [src/procedures/ToggleAllowPreIssuing.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L72)* +_Defined in_ [_src/procedures/ToggleAllowPreIssuing.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L72) Allow or disallow pre-issuing in the STO Note this procedure will fail if: -- Trying to allow pre issuing when it is already allowed -- Trying to disallow pre issuing when it is already disallowed -- Trying to execute this procedure on an STO with version 3.0.0 or lower -- The specified STO address is invalid -- The specified STO type is invalid -- The STO has not been launched, or the module has been archived - -**Returns:** *Promise‹void›* + +* Trying to allow pre issuing when it is already allowed +* Trying to disallow pre issuing when it is already disallowed +* Trying to execute this procedure on an STO with version 3.0.0 or lower +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md b/docs/api/classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md index ddbc362..d82afc8 100644 --- a/docs/api/classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md +++ b/docs/api/classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md @@ -1,4 +1,4 @@ -# Class: ToggleFreezeTransfers <**ReturnType**> +# ToggleFreezeTransfers Procedure that toggles whether transfers of a Security Token are frozen or no @@ -34,94 +34,86 @@ Procedure that toggles whether transfers of a Security Token are frozen or no ## Constructors -### constructor +### constructor -\+ **new ToggleFreezeTransfers**(`args`: [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), `context`: [Context](_context_.context.md)): *[ToggleFreezeTransfers](_procedures_togglefreezetransfers_.togglefreezetransfers.md)* ++ **new ToggleFreezeTransfers**\(`args`: [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), `context`: [Context](_context_.context.md)\): [_ToggleFreezeTransfers_](_procedures_togglefreezetransfers_.togglefreezetransfers.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[ToggleFreezeTransfers](_procedures_togglefreezetransfers_.togglefreezetransfers.md)* +**Returns:** [_ToggleFreezeTransfers_](_procedures_togglefreezetransfers_.togglefreezetransfers.md) ## Properties ### `Protected` args -• **args**: *[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)* +• **args**: [_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.ToggleFreezeTransfers +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleFreezeTransfers -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/ToggleFreezeTransfers.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L26)* +_Defined in_ [_src/procedures/ToggleFreezeTransfers.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L26) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/ToggleFreezeTransfers.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L35)* +_Defined in_ [_src/procedures/ToggleFreezeTransfers.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L35) Freeze or unfreeze Security Token transfers Note this procedure will fail if: -- The current wallet address is not the owner -- Trying to freeze/unfreeze a security token that is already frozen/unfrozen -**Returns:** *Promise‹void›* +* The current wallet address is not the owner +* Trying to freeze/unfreeze a security token that is already frozen/unfrozen + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_togglepausesto_.togglepausesto.md b/docs/api/classes/_procedures_togglepausesto_.togglepausesto.md index 2db8447..b4d1300 100644 --- a/docs/api/classes/_procedures_togglepausesto_.togglepausesto.md +++ b/docs/api/classes/_procedures_togglepausesto_.togglepausesto.md @@ -1,4 +1,4 @@ -# Class: TogglePauseSto <**ReturnType**> +# TogglePauseSto Procedure to pause or unpause an STO @@ -34,94 +34,86 @@ Procedure to pause or unpause an STO ## Constructors -### constructor +### constructor -\+ **new TogglePauseSto**(`args`: [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), `context`: [Context](_context_.context.md)): *[TogglePauseSto](_procedures_togglepausesto_.togglepausesto.md)* ++ **new TogglePauseSto**\(`args`: [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), `context`: [Context](_context_.context.md)\): [_TogglePauseSto_](_procedures_togglepausesto_.togglepausesto.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TogglePauseSto](_procedures_togglepausesto_.togglepausesto.md)* +**Returns:** [_TogglePauseSto_](_procedures_togglepausesto_.togglepausesto.md) ## Properties ### `Protected` args -• **args**: *[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md)* +• **args**: [_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.TogglePauseSto +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TogglePauseSto -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/TogglePauseSto.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L55)* +_Defined in_ [_src/procedures/TogglePauseSto.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L55) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/TogglePauseSto.ts:65](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L65)* +_Defined in_ [_src/procedures/TogglePauseSto.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L65) Pause or unpause the STO Note this procedure will fail if: -- The specified STO address is invalid -- The specified STO type is invalid -- The STO has not been launched, or the module has been archived -**Returns:** *Promise‹void›* +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_transfererc20_.transfererc20.md b/docs/api/classes/_procedures_transfererc20_.transfererc20.md index 7c849aa..d6a78ff 100644 --- a/docs/api/classes/_procedures_transfererc20_.transfererc20.md +++ b/docs/api/classes/_procedures_transfererc20_.transfererc20.md @@ -1,4 +1,4 @@ -# Class: TransferErc20 <**ReturnType**> +# TransferErc20 Procedure to transfer funds of an ERC20 token. If no token address is specified, it defaults to POLY @@ -34,94 +34,86 @@ Procedure to transfer funds of an ERC20 token. If no token address is specified, ## Constructors -### constructor +### constructor -\+ **new TransferErc20**(`args`: [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md), `context`: [Context](_context_.context.md)): *[TransferErc20](_procedures_transfererc20_.transfererc20.md)* ++ **new TransferErc20**\(`args`: [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md), `context`: [Context](_context_.context.md)\): [_TransferErc20_](_procedures_transfererc20_.transfererc20.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TransferErc20](_procedures_transfererc20_.transfererc20.md)* +**Returns:** [_TransferErc20_](_procedures_transfererc20_.transfererc20.md) ## Properties ### `Protected` args -• **args**: *[TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md)* +• **args**: [_TransferErc20ProcedureArgs_](../interfaces/_types_index_.transfererc20procedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.TransferErc20 +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferErc20 -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/TransferErc20.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L28)* +_Defined in_ [_src/procedures/TransferErc20.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L28) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ - -### addSignatureRequest +### addSignatureRequest -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,79 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ +### addTransaction -### addTransaction +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* - -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ - -### prepare +### prepare -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -Mandatory method that builds a list of transactions that will be -run +Mandatory method that builds a list of transactions that will be run -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -___ +### prepareTransactions -### prepareTransactions +▸ **prepareTransactions**\(\): _Promise‹void›_ -▸ **prepareTransactions**(): *Promise‹void›* +_Overrides void_ -*Overrides void* - -*Defined in [src/procedures/TransferErc20.ts:38](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L38)* +_Defined in_ [_src/procedures/TransferErc20.ts:38_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L38) Transfer an ERC20 token to another wallet. The token in question defaults to POLY if no address is supplied Note that the procedure will fail if: -- The owner's token balance is less than the amount being transferred. The only exception to this is when transferring POLY on a testnet. -If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet -- The token being transferred is a Security Token. In that case, the corresponding Security Token transfer procedures should be used -**Returns:** *Promise‹void›* +* The owner's token balance is less than the amount being transferred. The only exception to this is when transferring POLY on a testnet. + + If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet + +* The token being transferred is a Security Token. In that case, the corresponding Security Token transfer procedures should be used + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_transferownership_.transferownership.md b/docs/api/classes/_procedures_transferownership_.transferownership.md index 8e6232f..cef0de0 100644 --- a/docs/api/classes/_procedures_transferownership_.transferownership.md +++ b/docs/api/classes/_procedures_transferownership_.transferownership.md @@ -1,4 +1,4 @@ -# Class: TransferOwnership <**ReturnType**> +# TransferOwnership Procedure that will transfer the ownership of a Security Token to a different wallet @@ -34,94 +34,86 @@ Procedure that will transfer the ownership of a Security Token to a different wa ## Constructors -### constructor +### constructor -\+ **new TransferOwnership**(`args`: [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md), `context`: [Context](_context_.context.md)): *[TransferOwnership](_procedures_transferownership_.transferownership.md)* ++ **new TransferOwnership**\(`args`: [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md), `context`: [Context](_context_.context.md)\): [_TransferOwnership_](_procedures_transferownership_.transferownership.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TransferOwnership](_procedures_transferownership_.transferownership.md)* +**Returns:** [_TransferOwnership_](_procedures_transferownership_.transferownership.md) ## Properties ### `Protected` args -• **args**: *[TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md)* +• **args**: [_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.TransferOwnership +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferOwnership -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/TransferOwnership.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L27)* +_Defined in_ [_src/procedures/TransferOwnership.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L27) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/TransferOwnership.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L36)* +_Defined in_ [_src/procedures/TransferOwnership.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L36) Transfer ownership of a Security Token to another wallet Note this procedure will fail if: -- Trying to call the procedure from a wallet that is not the current owner of the Security Token -- Transferring the ownership to the current owner, as there is no change -**Returns:** *Promise‹void›* +* Trying to call the procedure from a wallet that is not the current owner of the Security Token +* Transferring the ownership to the current owner, as there is no change + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_transferreservationownership_.transferreservationownership.md b/docs/api/classes/_procedures_transferreservationownership_.transferreservationownership.md index 68fdab4..264e32e 100644 --- a/docs/api/classes/_procedures_transferreservationownership_.transferreservationownership.md +++ b/docs/api/classes/_procedures_transferreservationownership_.transferreservationownership.md @@ -1,4 +1,4 @@ -# Class: TransferReservationOwnership <**ReturnType**> +# TransferReservationOwnership Procedure that transfers ownership of a Security Token Reservation @@ -34,94 +34,86 @@ Procedure that transfers ownership of a Security Token Reservation ## Constructors -### constructor +### constructor -\+ **new TransferReservationOwnership**(`args`: [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md), `context`: [Context](_context_.context.md)): *[TransferReservationOwnership](_procedures_transferreservationownership_.transferreservationownership.md)* ++ **new TransferReservationOwnership**\(`args`: [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md), `context`: [Context](_context_.context.md)\): [_TransferReservationOwnership_](_procedures_transferreservationownership_.transferreservationownership.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TransferReservationOwnership](_procedures_transferreservationownership_.transferreservationownership.md)* +**Returns:** [_TransferReservationOwnership_](_procedures_transferreservationownership_.transferreservationownership.md) ## Properties ### `Protected` args -• **args**: *[TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)* +• **args**: [_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.TransferReservationOwnership +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferReservationOwnership -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/TransferReservationOwnership.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L30)* +_Defined in_ [_src/procedures/TransferReservationOwnership.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L30) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,85 +121,77 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/TransferReservationOwnership.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L40)* +_Defined in_ [_src/procedures/TransferReservationOwnership.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L40) Transfer the ownership of a Security Token Reservation to the supplied address Note this procedure will fail if: -- A Security Token has already been launched with this symbol -- The current wallet address is not the owner of the Reservation -- Attempting to transfer ownership to the current owner -**Returns:** *Promise‹void›* +* A Security Token has already been launched with this symbol +* The current wallet address is not the owner of the Reservation +* Attempting to transfer ownership to the current owner + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md b/docs/api/classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md index fa57182..b34c591 100644 --- a/docs/api/classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md +++ b/docs/api/classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md @@ -1,4 +1,4 @@ -# Class: TransferSecurityTokens <**ReturnType**> +# TransferSecurityTokens Procedure that transfer security tokens @@ -34,94 +34,86 @@ Procedure that transfer security tokens ## Constructors -### constructor +### constructor -\+ **new TransferSecurityTokens**(`args`: [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md), `context`: [Context](_context_.context.md)): *[TransferSecurityTokens](_procedures_transfersecuritytokens_.transfersecuritytokens.md)* ++ **new TransferSecurityTokens**\(`args`: [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md), `context`: [Context](_context_.context.md)\): [_TransferSecurityTokens_](_procedures_transfersecuritytokens_.transfersecuritytokens.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[TransferSecurityTokens](_procedures_transfersecuritytokens_.transfersecuritytokens.md)* +**Returns:** [_TransferSecurityTokens_](_procedures_transfersecuritytokens_.transfersecuritytokens.md) ## Properties ### `Protected` args -• **args**: *[TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)* +• **args**: [_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.TransferSecurityTokens +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferSecurityTokens -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/TransferSecurityTokens.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L43)* +_Defined in_ [_src/procedures/TransferSecurityTokens.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L43) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,83 +121,73 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* +_Defined in_ [_src/procedures/TransferSecurityTokens.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L70) -*Overrides void* - -*Defined in [src/procedures/TransferSecurityTokens.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L70)* - -Transfer security tokens from a wallet address to another -***If from argument is not provided, the current SDK user address will be taken as it*** +Transfer security tokens from a wallet address to another _**If from argument is not provided, the current SDK user address will be taken as it**_ Note that this procedure will fail if the security token symbol doesn't exist -**Returns:** *Promise‹void›* +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md b/docs/api/classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md index 67feae8..f3bc583 100644 --- a/docs/api/classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md +++ b/docs/api/classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md @@ -1,4 +1,4 @@ -# Class: UpdateDividendsTaxWithholdingList <**ReturnType**> +# UpdateDividendsTaxWithholdingList Procedure that modifies dividend tax withholding percentages for holders of the Security Token @@ -34,94 +34,86 @@ Procedure that modifies dividend tax withholding percentages for holders of the ## Constructors -### constructor +### constructor -\+ **new UpdateDividendsTaxWithholdingList**(`args`: [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md), `context`: [Context](_context_.context.md)): *[UpdateDividendsTaxWithholdingList](_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md)* ++ **new UpdateDividendsTaxWithholdingList**\(`args`: [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md), `context`: [Context](_context_.context.md)\): [_UpdateDividendsTaxWithholdingList_](_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[UpdateDividendsTaxWithholdingList](_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md)* +**Returns:** [_UpdateDividendsTaxWithholdingList_](_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) ## Properties ### `Protected` args -• **args**: *[UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)* +• **args**: [_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.UpdateDividendsTaxWithholdingList +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.UpdateDividendsTaxWithholdingList -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/UpdateDividendsTaxWithholdingList.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L45)* +_Defined in_ [_src/procedures/UpdateDividendsTaxWithholdingList.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L45) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/UpdateDividendsTaxWithholdingList.ts:54](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L54)* +_Defined in_ [_src/procedures/UpdateDividendsTaxWithholdingList.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L54) Modify tax withholding percentage for tokenholders Note that this procedure will fail if: -- The Security Token doesn't exist -- The Dividends Feature hasn't been enabled -**Returns:** *Promise‹void›* +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/classes/_procedures_withdrawtaxes_.withdrawtaxes.md b/docs/api/classes/_procedures_withdrawtaxes_.withdrawtaxes.md index 710c611..52e5c38 100644 --- a/docs/api/classes/_procedures_withdrawtaxes_.withdrawtaxes.md +++ b/docs/api/classes/_procedures_withdrawtaxes_.withdrawtaxes.md @@ -1,4 +1,4 @@ -# Class: WithdrawTaxes <**ReturnType**> +# WithdrawTaxes Procedure that allows an issuer to withdraw withheld tax from a Dividend Distribution @@ -34,94 +34,86 @@ Procedure that allows an issuer to withdraw withheld tax from a Dividend Distrib ## Constructors -### constructor +### constructor -\+ **new WithdrawTaxes**(`args`: [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md), `context`: [Context](_context_.context.md)): *[WithdrawTaxes](_procedures_withdrawtaxes_.withdrawtaxes.md)* ++ **new WithdrawTaxes**\(`args`: [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md), `context`: [Context](_context_.context.md)\): [_WithdrawTaxes_](_procedures_withdrawtaxes_.withdrawtaxes.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)* +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) **Parameters:** -Name | Type | ------- | ------ | -`args` | [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md) | -`context` | [Context](_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md) | +| `context` | [Context](_context_.context.md) | -**Returns:** *[WithdrawTaxes](_procedures_withdrawtaxes_.withdrawtaxes.md)* +**Returns:** [_WithdrawTaxes_](_procedures_withdrawtaxes_.withdrawtaxes.md) ## Properties ### `Protected` args -• **args**: *[WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)* +• **args**: [_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md) -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)* - -___ +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) ### `Protected` context -• **context**: *[Context](_context_.context.md)* - -*Inherited from void* +• **context**: [_Context_](_context_.context.md) -*Defined in [src/procedures/Procedure.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)* +_Inherited from void_ -___ +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) -### type +### type -• **type**: *[ProcedureType](../enums/_types_index_.proceduretype.md)* = ProcedureType.WithdrawTaxes +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.WithdrawTaxes -*Overrides void* +_Overrides void_ -*Defined in [src/procedures/WithdrawTaxes.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L28)* +_Defined in_ [_src/procedures/WithdrawTaxes.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L28) ## Methods -### addProcedure +### addProcedure -▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›): *(Anonymous function)* +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)* +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) -Appends a Procedure into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any* +▪ **R**: _any_ **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ whichever value is returned by the Procedure -___ +### addSignatureRequest -### addSignatureRequest +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ -▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A›): *(Anonymous function)* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) -*Defined in [src/procedures/Procedure.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)* - -Appends a signature request into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** @@ -129,84 +121,76 @@ what will be run by the TransactionQueue when it is started. **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](../external-modules/_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the signed data -___ - -### addTransaction +### addTransaction -▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object): *(Anonymous function)* +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](../external-modules/_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ -*Inherited from void* +_Inherited from void_ -*Defined in [src/procedures/Procedure.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)* +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) -Appends a method or future method into the TransactionQueue's queue. This defines -what will be run by the TransactionQueue when it is started. +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. **Type parameters:** ▪ **A** -▪ **R**: *any[]* +▪ **R**: _any\[\]_ -▪ **V**: *any* +▪ **V**: _any_ **Parameters:** -▪ **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›* +▪ **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ -A method (or future method) that will be run in the Procedure's TransactionQueue. -A future method is a transaction that doesn't exist at prepare time -(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run) +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) -▪`Default value` **__namedParameters**: *object*= {} +▪`Default value` **\_\_namedParameters**: _object_= {} -Name | Type | Default | ------- | ------ | ------ | -`fees` | undefined | [Fees](../interfaces/_types_index_.fees.md) | - | -`resolvers` | object | ([] as unknown) as ResolverArray | -`tag` | undefined | [Any](../enums/_types_index_.polytransactiontag.md#any) | [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) | [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) | [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) | [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) | [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) | [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) | [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) | [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) | [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) | [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) | [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) | [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) | [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) | [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) | [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) | [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) | [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) | [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) | [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) | [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) | [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) | [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) | [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) | [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) | [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) | [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) | [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) | [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) | [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) | [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) | [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) | [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) | [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) | [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) | [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) | [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) | [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) | [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) | [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) | [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) | [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) | [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) | [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) | [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) | [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) | [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) | [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) | [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) | [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) | [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) | [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) | [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) | [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) | [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) | [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) | [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) | [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) | [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) | [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) | [Signature](../enums/_types_index_.polytransactiontag.md#signature) | [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) | [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | -**Returns:** *(Anonymous function)* +**Returns:** _\(Anonymous function\)_ a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed -___ +### prepare -### prepare +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -▸ **prepare**(): *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +_Inherited from void_ -*Inherited from void* +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) -*Defined in [src/procedures/Procedure.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)* +Mandatory method that builds a list of transactions that will be run -Mandatory method that builds a list of transactions that will be -run +**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ -**Returns:** *Promise‹[TransactionQueue](_entities_transactionqueue_.transactionqueue.md)‹Args, ReturnType››* +### prepareTransactions -___ +▸ **prepareTransactions**\(\): _Promise‹void›_ -### prepareTransactions +_Overrides void_ -▸ **prepareTransactions**(): *Promise‹void›* - -*Overrides void* - -*Defined in [src/procedures/WithdrawTaxes.ts:37](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L37)* +_Defined in_ [_src/procedures/WithdrawTaxes.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L37) Withdraw Tax Withholdings Note that this procedure will fail if: -- The security token doesn't exist -- The Dividends Feature hasn't been enabled -**Returns:** *Promise‹void›* +* The security token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/enums/README.md b/docs/api/enums/README.md new file mode 100644 index 0000000..abe85cc --- /dev/null +++ b/docs/api/enums/README.md @@ -0,0 +1,2 @@ +# Enums + diff --git a/docs/api/enums/_browserutils_.browsersupport.md b/docs/api/enums/_browserutils_.browsersupport.md index 0c9cba6..a11545e 100644 --- a/docs/api/enums/_browserutils_.browsersupport.md +++ b/docs/api/enums/_browserutils_.browsersupport.md @@ -1,4 +1,4 @@ -# Enumeration: BrowserSupport +# BrowserSupport ## Index @@ -11,32 +11,27 @@ ## Enumeration members -### MetamaskLegacy +### MetamaskLegacy • **MetamaskLegacy**: = "MetamaskLegacy" -*Defined in [src/browserUtils.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L8)* +_Defined in_ [_src/browserUtils.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L8) -___ - -### MetamaskModern +### MetamaskModern • **MetamaskModern**: = "MetamaskModern" -*Defined in [src/browserUtils.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L9)* - -___ +_Defined in_ [_src/browserUtils.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L9) -### NoMetamask +### NoMetamask • **NoMetamask**: = "NoMetamask" -*Defined in [src/browserUtils.ts:7](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L7)* +_Defined in_ [_src/browserUtils.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L7) -___ - -### None +### None • **None**: = "None" -*Defined in [src/browserUtils.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L10)* +_Defined in_ [_src/browserUtils.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L10) + diff --git a/docs/api/enums/_entities_polytransaction_.event.md b/docs/api/enums/_entities_polytransaction_.event.md index 1ddda74..ec8bcae 100644 --- a/docs/api/enums/_entities_polytransaction_.event.md +++ b/docs/api/enums/_entities_polytransaction_.event.md @@ -1,4 +1,4 @@ -# Enumeration: Event +# Event ## Index @@ -8,8 +8,9 @@ ## Enumeration members -### StatusChange +### StatusChange • **StatusChange**: = "StatusChange" -*Defined in [src/entities/PolyTransaction.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L19)* +_Defined in_ [_src/entities/PolyTransaction.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L19) + diff --git a/docs/api/enums/_entities_transactionqueue_.events.md b/docs/api/enums/_entities_transactionqueue_.events.md index 944c5a2..720d52b 100644 --- a/docs/api/enums/_entities_transactionqueue_.events.md +++ b/docs/api/enums/_entities_transactionqueue_.events.md @@ -1,4 +1,4 @@ -# Enumeration: Events +# Events ## Index @@ -9,16 +9,15 @@ ## Enumeration members -### StatusChange +### StatusChange • **StatusChange**: = "StatusChange" -*Defined in [src/entities/TransactionQueue.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L18)* +_Defined in_ [_src/entities/TransactionQueue.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L18) -___ - -### TransactionStatusChange +### TransactionStatusChange • **TransactionStatusChange**: = "TransactionStatusChange" -*Defined in [src/entities/TransactionQueue.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L19)* +_Defined in_ [_src/entities/TransactionQueue.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L19) + diff --git a/docs/api/enums/_types_index_.errorcode.md b/docs/api/enums/_types_index_.errorcode.md index b39d23e..2304135 100644 --- a/docs/api/enums/_types_index_.errorcode.md +++ b/docs/api/enums/_types_index_.errorcode.md @@ -1,4 +1,4 @@ -# Enumeration: ErrorCode +# ErrorCode Specifies possible types of errors in the SDK @@ -27,144 +27,111 @@ Specifies possible types of errors in the SDK ## Enumeration members -### FatalError +### FatalError • **FatalError**: = "FatalError" -*Defined in [src/types/index.ts:108](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L108)* +_Defined in_ [_src/types/index.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L108) -___ - -### FeatureNotEnabled +### FeatureNotEnabled • **FeatureNotEnabled**: = "FeatureNotEnabled" -*Defined in [src/types/index.ts:99](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L99)* - -___ +_Defined in_ [_src/types/index.ts:99_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L99) -### FetcherValidationError +### FetcherValidationError • **FetcherValidationError**: = "FetcherValidationError" -*Defined in [src/types/index.ts:105](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L105)* - -___ +_Defined in_ [_src/types/index.ts:105_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L105) -### IncompatibleBrowser +### IncompatibleBrowser • **IncompatibleBrowser**: = "IncompatibleBrowser" -*Defined in [src/types/index.ts:98](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L98)* +_Defined in_ [_src/types/index.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L98) -___ - -### IncorrectVersion +### IncorrectVersion • **IncorrectVersion**: = "IncorrectVersion" -*Defined in [src/types/index.ts:115](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L115)* - -___ +_Defined in_ [_src/types/index.ts:115_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L115) -### InexistentModule +### InexistentModule • **InexistentModule**: = "InexistentModule" -*Defined in [src/types/index.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L114)* +_Defined in_ [_src/types/index.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L114) -___ - -### InsufficientBalance +### InsufficientBalance • **InsufficientBalance**: = "InsufficientBalance" -*Defined in [src/types/index.ts:113](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L113)* - -___ +_Defined in_ [_src/types/index.ts:113_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L113) -### InvalidAddress +### InvalidAddress • **InvalidAddress**: = "InvalidAddress" -*Defined in [src/types/index.ts:112](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L112)* +_Defined in_ [_src/types/index.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L112) -___ - -### InvalidUuid +### InvalidUuid • **InvalidUuid**: = "InvalidUuid" -*Defined in [src/types/index.ts:111](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L111)* - -___ +_Defined in_ [_src/types/index.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L111) -### MetamaskNotInstalled +### MetamaskNotInstalled • **MetamaskNotInstalled**: = "MetamaskNotInstalled" -*Defined in [src/types/index.ts:101](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L101)* +_Defined in_ [_src/types/index.ts:101_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L101) -___ - -### NonBrowserEnvironment +### NonBrowserEnvironment • **NonBrowserEnvironment**: = "NonBrowserEnvironment" -*Defined in [src/types/index.ts:100](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L100)* - -___ +_Defined in_ [_src/types/index.ts:100_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L100) -### ProcedureValidationError +### ProcedureValidationError • **ProcedureValidationError**: = "ProcedureValidationError" -*Defined in [src/types/index.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L104)* - -___ +_Defined in_ [_src/types/index.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L104) -### TransactionRejectedByUser +### TransactionRejectedByUser • **TransactionRejectedByUser**: = "TransactionRejectedByUser" -*Defined in [src/types/index.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L106)* +_Defined in_ [_src/types/index.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L106) -___ - -### TransactionReverted +### TransactionReverted • **TransactionReverted**: = "TransactionReverted" -*Defined in [src/types/index.ts:107](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L107)* - -___ +_Defined in_ [_src/types/index.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L107) -### UnexpectedEventLogs +### UnexpectedEventLogs • **UnexpectedEventLogs**: = "UnexpectedEventLogs" -*Defined in [src/types/index.ts:110](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L110)* +_Defined in_ [_src/types/index.ts:110_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L110) -___ - -### UnexpectedReturnData +### UnexpectedReturnData • **UnexpectedReturnData**: = "UnexpectedReturnData" -*Defined in [src/types/index.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L109)* - -___ +_Defined in_ [_src/types/index.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L109) -### UserDeniedAccess +### UserDeniedAccess • **UserDeniedAccess**: = "UserDeniedAccess" -*Defined in [src/types/index.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L102)* +_Defined in_ [_src/types/index.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L102) -___ - -### WalletIsLocked +### WalletIsLocked • **WalletIsLocked**: = "WalletIsLocked" -*Defined in [src/types/index.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L103)* +_Defined in_ [_src/types/index.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L103) + diff --git a/docs/api/enums/_types_index_.feature.md b/docs/api/enums/_types_index_.feature.md index a4d9ba9..06ca9d5 100644 --- a/docs/api/enums/_types_index_.feature.md +++ b/docs/api/enums/_types_index_.feature.md @@ -1,4 +1,4 @@ -# Enumeration: Feature +# Feature ## Index @@ -12,40 +12,33 @@ ## Enumeration members -### Dividends +### Dividends • **Dividends**: = "Dividends" -*Defined in [src/types/index.ts:1451](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1451)* +_Defined in_ [_src/types/index.ts:1451_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1451) -___ - -### PercentageOwnershipRestrictions +### PercentageOwnershipRestrictions • **PercentageOwnershipRestrictions**: = "PercentageOwnershipRestrictions" -*Defined in [src/types/index.ts:1453](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1453)* - -___ +_Defined in_ [_src/types/index.ts:1453_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1453) -### Permissions +### Permissions • **Permissions**: = "Permissions" -*Defined in [src/types/index.ts:1449](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1449)* - -___ +_Defined in_ [_src/types/index.ts:1449_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1449) -### TokenholderCountRestrictions +### TokenholderCountRestrictions • **TokenholderCountRestrictions**: = "TokenholderCountRestrictions" -*Defined in [src/types/index.ts:1452](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1452)* +_Defined in_ [_src/types/index.ts:1452_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1452) -___ - -### Tokenholders +### Tokenholders • **Tokenholders**: = "Tokenholders" -*Defined in [src/types/index.ts:1450](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1450)* +_Defined in_ [_src/types/index.ts:1450_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1450) + diff --git a/docs/api/enums/_types_index_.polytransactiontag.md b/docs/api/enums/_types_index_.polytransactiontag.md index 987e20e..32eaec1 100644 --- a/docs/api/enums/_types_index_.polytransactiontag.md +++ b/docs/api/enums/_types_index_.polytransactiontag.md @@ -1,4 +1,4 @@ -# Enumeration: PolyTransactionTag +# PolyTransactionTag Tag to distinguish transactions for display purposes @@ -72,504 +72,381 @@ Tag to distinguish transactions for display purposes ## Enumeration members -### AddDelegate +### AddDelegate • **AddDelegate**: = "AddDelegate" -*Defined in [src/types/index.ts:219](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L219)* +_Defined in_ [_src/types/index.ts:219_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L219) -___ - -### AllowPreMinting +### AllowPreMinting • **AllowPreMinting**: = "AllowPreMinting" -*Defined in [src/types/index.ts:232](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L232)* - -___ +_Defined in_ [_src/types/index.ts:232_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L232) -### Any +### Any • **Any**: = "Any" -*Defined in [src/types/index.ts:193](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L193)* +_Defined in_ [_src/types/index.ts:193_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L193) -___ - -### ApproveErc20 +### ApproveErc20 • **ApproveErc20**: = "ApproveErc20" -*Defined in [src/types/index.ts:195](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L195)* - -___ +_Defined in_ [_src/types/index.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L195) -### BuyTokens +### BuyTokens • **BuyTokens**: = "BuyTokens" -*Defined in [src/types/index.ts:244](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L244)* +_Defined in_ [_src/types/index.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L244) -___ - -### BuyTokensWithPoly +### BuyTokensWithPoly • **BuyTokensWithPoly**: = "BuyTokensWithPoly" -*Defined in [src/types/index.ts:245](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L245)* - -___ +_Defined in_ [_src/types/index.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L245) -### BuyWithEthRateLimited +### BuyWithEthRateLimited • **BuyWithEthRateLimited**: = "BuyWithEthRateLimited" -*Defined in [src/types/index.ts:243](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L243)* +_Defined in_ [_src/types/index.ts:243_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L243) -___ - -### BuyWithPolyRateLimited +### BuyWithPolyRateLimited • **BuyWithPolyRateLimited**: = "BuyWithPolyRateLimited" -*Defined in [src/types/index.ts:242](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L242)* - -___ +_Defined in_ [_src/types/index.ts:242_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L242) -### BuyWithScRateLimited +### BuyWithScRateLimited • **BuyWithScRateLimited**: = "BuyWithScRateLimited" -*Defined in [src/types/index.ts:241](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L241)* +_Defined in_ [_src/types/index.ts:241_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L241) -___ - -### ChangeAllowBeneficialInvestments +### ChangeAllowBeneficialInvestments • **ChangeAllowBeneficialInvestments**: = "ChangeAllowBeneficialInvestments" -*Defined in [src/types/index.ts:234](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L234)* - -___ +_Defined in_ [_src/types/index.ts:234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L234) -### ChangeHolderCount +### ChangeHolderCount • **ChangeHolderCount**: = "ChangeHolderCount" -*Defined in [src/types/index.ts:246](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L246)* +_Defined in_ [_src/types/index.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L246) -___ - -### ChangeHolderPercentage +### ChangeHolderPercentage • **ChangeHolderPercentage**: = "ChangeHolderPercentage" -*Defined in [src/types/index.ts:247](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L247)* - -___ +_Defined in_ [_src/types/index.ts:247_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L247) -### ChangePermission +### ChangePermission • **ChangePermission**: = "ChangePermission" -*Defined in [src/types/index.ts:220](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L220)* +_Defined in_ [_src/types/index.ts:220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L220) -___ - -### ControllerRedeem +### ControllerRedeem • **ControllerRedeem**: = "ControllerRedeem" -*Defined in [src/types/index.ts:222](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L222)* - -___ +_Defined in_ [_src/types/index.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L222) -### ControllerTransfer +### ControllerTransfer • **ControllerTransfer**: = "ControllerTransfer" -*Defined in [src/types/index.ts:221](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L221)* +_Defined in_ [_src/types/index.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L221) -___ - -### CreateCheckpoint +### CreateCheckpoint • **CreateCheckpoint**: = "CreateCheckpoint" -*Defined in [src/types/index.ts:199](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L199)* - -___ +_Defined in_ [_src/types/index.ts:199_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L199) -### CreateErc20DividendDistribution +### CreateErc20DividendDistribution • **CreateErc20DividendDistribution**: = "CreateErc20DividendDistribution" -*Defined in [src/types/index.ts:200](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L200)* +_Defined in_ [_src/types/index.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L200) -___ - -### CreateSecurityToken +### CreateSecurityToken • **CreateSecurityToken**: = "CreateSecurityToken" -*Defined in [src/types/index.ts:198](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L198)* - -___ +_Defined in_ [_src/types/index.ts:198_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L198) -### DisableController +### DisableController • **DisableController**: = "DisableController" -*Defined in [src/types/index.ts:211](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L211)* +_Defined in_ [_src/types/index.ts:211_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L211) -___ - -### DisableFeature +### DisableFeature • **DisableFeature**: = "DisableFeature" -*Defined in [src/types/index.ts:213](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L213)* - -___ +_Defined in_ [_src/types/index.ts:213_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L213) -### EnableCappedSto +### EnableCappedSto • **EnableCappedSto**: = "EnableCappedSto" -*Defined in [src/types/index.ts:205](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L205)* +_Defined in_ [_src/types/index.ts:205_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L205) -___ - -### EnableCountTransferManager +### EnableCountTransferManager • **EnableCountTransferManager**: = "EnableCountTransferManager" -*Defined in [src/types/index.ts:209](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L209)* - -___ +_Defined in_ [_src/types/index.ts:209_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L209) -### EnableDividends +### EnableDividends • **EnableDividends**: = "EnableDividends" -*Defined in [src/types/index.ts:204](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L204)* +_Defined in_ [_src/types/index.ts:204_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L204) -___ - -### EnableGeneralPermissionManager +### EnableGeneralPermissionManager • **EnableGeneralPermissionManager**: = "EnableGeneralPermissionManager" -*Defined in [src/types/index.ts:207](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L207)* - -___ +_Defined in_ [_src/types/index.ts:207_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L207) -### EnableGeneralTransferManager +### EnableGeneralTransferManager • **EnableGeneralTransferManager**: = "EnableGeneralTransferManager" -*Defined in [src/types/index.ts:208](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L208)* +_Defined in_ [_src/types/index.ts:208_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L208) -___ - -### EnablePercentageTransferManager +### EnablePercentageTransferManager • **EnablePercentageTransferManager**: = "EnablePercentageTransferManager" -*Defined in [src/types/index.ts:210](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L210)* - -___ +_Defined in_ [_src/types/index.ts:210_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L210) -### EnableTieredSto +### EnableTieredSto • **EnableTieredSto**: = "EnableTieredSto" -*Defined in [src/types/index.ts:206](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L206)* +_Defined in_ [_src/types/index.ts:206_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L206) -___ - -### FinalizeSto +### FinalizeSto • **FinalizeSto**: = "FinalizeSto" -*Defined in [src/types/index.ts:225](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L225)* - -___ +_Defined in_ [_src/types/index.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L225) -### FreezeIssuance +### FreezeIssuance • **FreezeIssuance**: = "FreezeIssuance" -*Defined in [src/types/index.ts:212](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L212)* +_Defined in_ [_src/types/index.ts:212_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L212) -___ - -### FreezeTransfers +### FreezeTransfers • **FreezeTransfers**: = "FreezeTransfers" -*Defined in [src/types/index.ts:252](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L252)* - -___ +_Defined in_ [_src/types/index.ts:252_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L252) -### GetTokens +### GetTokens • **GetTokens**: = "GetTokens" -*Defined in [src/types/index.ts:194](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L194)* +_Defined in_ [_src/types/index.ts:194_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L194) -___ - -### IssueMulti +### IssueMulti • **IssueMulti**: = "IssueMulti" -*Defined in [src/types/index.ts:231](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L231)* - -___ +_Defined in_ [_src/types/index.ts:231_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L231) -### ModifyAddresses +### ModifyAddresses • **ModifyAddresses**: = "ModifyAddresses" -*Defined in [src/types/index.ts:237](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L237)* +_Defined in_ [_src/types/index.ts:237_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L237) -___ - -### ModifyFunding +### ModifyFunding • **ModifyFunding**: = "ModifyFunding" -*Defined in [src/types/index.ts:236](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L236)* - -___ +_Defined in_ [_src/types/index.ts:236_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L236) -### ModifyInvestorFlagMulti +### ModifyInvestorFlagMulti • **ModifyInvestorFlagMulti**: = "ModifyInvestorFlagMulti" -*Defined in [src/types/index.ts:230](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L230)* +_Defined in_ [_src/types/index.ts:230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L230) -___ - -### ModifyKycDataMulti +### ModifyKycDataMulti • **ModifyKycDataMulti**: = "ModifyKycDataMulti" -*Defined in [src/types/index.ts:229](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L229)* - -___ +_Defined in_ [_src/types/index.ts:229_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L229) -### ModifyLimits +### ModifyLimits • **ModifyLimits**: = "ModifyLimits" -*Defined in [src/types/index.ts:239](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L239)* +_Defined in_ [_src/types/index.ts:239_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L239) -___ - -### ModifyOracles +### ModifyOracles • **ModifyOracles**: = "ModifyOracles" -*Defined in [src/types/index.ts:240](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L240)* - -___ +_Defined in_ [_src/types/index.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L240) -### ModifyTiers +### ModifyTiers • **ModifyTiers**: = "ModifiyTiers" -*Defined in [src/types/index.ts:238](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L238)* +_Defined in_ [_src/types/index.ts:238_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L238) -___ - -### ModifyTimes +### ModifyTimes • **ModifyTimes**: = "ModifyTimes" -*Defined in [src/types/index.ts:235](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L235)* - -___ +_Defined in_ [_src/types/index.ts:235_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L235) -### ModifyWhitelistMulti +### ModifyWhitelistMulti • **ModifyWhitelistMulti**: = "ModifyWhitelistMulti" -*Defined in [src/types/index.ts:248](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L248)* +_Defined in_ [_src/types/index.ts:248_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L248) -___ - -### PauseSto +### PauseSto • **PauseSto**: = "PauseSto" -*Defined in [src/types/index.ts:223](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L223)* - -___ +_Defined in_ [_src/types/index.ts:223_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L223) -### PullDividendPayment +### PullDividendPayment • **PullDividendPayment**: = "PullDividendPayment" -*Defined in [src/types/index.ts:217](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L217)* +_Defined in_ [_src/types/index.ts:217_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L217) -___ - -### PushDividendPayment +### PushDividendPayment • **PushDividendPayment**: = "PushDividendPayment" -*Defined in [src/types/index.ts:216](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L216)* - -___ +_Defined in_ [_src/types/index.ts:216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L216) -### ReclaimDividendFunds +### ReclaimDividendFunds • **ReclaimDividendFunds**: = "ReclaimDividendFunds" -*Defined in [src/types/index.ts:214](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L214)* +_Defined in_ [_src/types/index.ts:214_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L214) -___ - -### RemoveDocument +### RemoveDocument • **RemoveDocument**: = "RemoveDocument" -*Defined in [src/types/index.ts:228](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L228)* - -___ +_Defined in_ [_src/types/index.ts:228_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L228) -### ReserveSecurityToken +### ReserveSecurityToken • **ReserveSecurityToken**: = "ReserveSecurityToken" -*Defined in [src/types/index.ts:197](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L197)* +_Defined in_ [_src/types/index.ts:197_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L197) -___ - -### RevokePreMinting +### RevokePreMinting • **RevokePreMinting**: = "RevokePreMinting" -*Defined in [src/types/index.ts:233](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L233)* - -___ +_Defined in_ [_src/types/index.ts:233_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L233) -### SetAllowPrimaryIssuance +### SetAllowPrimaryIssuance • **SetAllowPrimaryIssuance**: = "SetAllowPrimaryIssuance" -*Defined in [src/types/index.ts:249](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L249)* +_Defined in_ [_src/types/index.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L249) -___ - -### SetController +### SetController • **SetController**: = "SetController" -*Defined in [src/types/index.ts:226](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L226)* - -___ +_Defined in_ [_src/types/index.ts:226_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L226) -### SetDefaultExcluded +### SetDefaultExcluded • **SetDefaultExcluded**: = "SetDefaultExcluded" -*Defined in [src/types/index.ts:203](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L203)* +_Defined in_ [_src/types/index.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L203) -___ - -### SetDividendsWallet +### SetDividendsWallet • **SetDividendsWallet**: = "SetDividendsWallet" -*Defined in [src/types/index.ts:218](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L218)* - -___ +_Defined in_ [_src/types/index.ts:218_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L218) -### SetDocument +### SetDocument • **SetDocument**: = "SetDocument" -*Defined in [src/types/index.ts:227](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L227)* +_Defined in_ [_src/types/index.ts:227_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L227) -___ - -### SetErc20TaxWithholding +### SetErc20TaxWithholding • **SetErc20TaxWithholding**: = "SetErc20TaxWithholding" -*Defined in [src/types/index.ts:201](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L201)* - -___ +_Defined in_ [_src/types/index.ts:201_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L201) -### SetEtherTaxWithholding +### SetEtherTaxWithholding • **SetEtherTaxWithholding**: = "SetEtherTaxWithholding" -*Defined in [src/types/index.ts:202](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L202)* +_Defined in_ [_src/types/index.ts:202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L202) -___ - -### Signature +### Signature • **Signature**: = "Signature" -*Defined in [src/types/index.ts:253](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L253)* - -___ +_Defined in_ [_src/types/index.ts:253_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L253) -### TransferErc20 +### TransferErc20 • **TransferErc20**: = "TransferErc20" -*Defined in [src/types/index.ts:196](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L196)* +_Defined in_ [_src/types/index.ts:196_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L196) -___ - -### TransferOwnership +### TransferOwnership • **TransferOwnership**: = "TransferOwnership" -*Defined in [src/types/index.ts:255](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L255)* - -___ +_Defined in_ [_src/types/index.ts:255_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L255) -### TransferReservationOwnership +### TransferReservationOwnership • **TransferReservationOwnership**: = "TransferReservationOwnership" -*Defined in [src/types/index.ts:254](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L254)* +_Defined in_ [_src/types/index.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L254) -___ - -### TransferSecurityTokens +### TransferSecurityTokens • **TransferSecurityTokens**: = "TransferSecurityTokens" -*Defined in [src/types/index.ts:250](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L250)* - -___ +_Defined in_ [_src/types/index.ts:250_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L250) -### UnfreezeTransfers +### UnfreezeTransfers • **UnfreezeTransfers**: = "UnfreezeTransfers" -*Defined in [src/types/index.ts:251](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L251)* +_Defined in_ [_src/types/index.ts:251_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L251) -___ - -### UnpauseSto +### UnpauseSto • **UnpauseSto**: = "UnpauseSto" -*Defined in [src/types/index.ts:224](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L224)* - -___ +_Defined in_ [_src/types/index.ts:224_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L224) -### WithdrawTaxWithholdings +### WithdrawTaxWithholdings • **WithdrawTaxWithholdings**: = "WithdrawTaxWithholdings" -*Defined in [src/types/index.ts:215](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L215)* +_Defined in_ [_src/types/index.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L215) + diff --git a/docs/api/enums/_types_index_.proceduretype.md b/docs/api/enums/_types_index_.proceduretype.md index f3476e3..ea0351f 100644 --- a/docs/api/enums/_types_index_.proceduretype.md +++ b/docs/api/enums/_types_index_.proceduretype.md @@ -1,4 +1,4 @@ -# Enumeration: ProcedureType +# ProcedureType Types of Procedures available in the SDK @@ -60,408 +60,309 @@ Types of Procedures available in the SDK ## Enumeration members -### ApproveErc20 +### ApproveErc20 • **ApproveErc20**: = "ApproveErc20" -*Defined in [src/types/index.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L137)* +_Defined in_ [_src/types/index.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L137) -___ - -### AssignSecurityTokenRole +### AssignSecurityTokenRole • **AssignSecurityTokenRole**: = "AssignSecurityTokenRole" -*Defined in [src/types/index.ts:159](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L159)* - -___ +_Defined in_ [_src/types/index.ts:159_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L159) -### AssignStoRole +### AssignStoRole • **AssignStoRole**: = "AssignStoRole" -*Defined in [src/types/index.ts:160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L160)* +_Defined in_ [_src/types/index.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L160) -___ - -### ControllerRedeem +### ControllerRedeem • **ControllerRedeem**: = "ControllerRedeem" -*Defined in [src/types/index.ts:162](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L162)* - -___ +_Defined in_ [_src/types/index.ts:162_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L162) -### ControllerTransfer +### ControllerTransfer • **ControllerTransfer**: = "ControllerTransfer" -*Defined in [src/types/index.ts:161](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L161)* +_Defined in_ [_src/types/index.ts:161_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L161) -___ - -### CreateCheckpoint +### CreateCheckpoint • **CreateCheckpoint**: = "CreateCheckpoint" -*Defined in [src/types/index.ts:139](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L139)* - -___ +_Defined in_ [_src/types/index.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L139) -### CreateDividendDistribution +### CreateDividendDistribution • **CreateDividendDistribution**: = "CreateDividendDistribution" -*Defined in [src/types/index.ts:147](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L147)* - -___ +_Defined in_ [_src/types/index.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L147) -### CreateSecurityToken +### CreateSecurityToken • **CreateSecurityToken**: = "CreateSecurityToken" -*Defined in [src/types/index.ts:148](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L148)* +_Defined in_ [_src/types/index.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L148) -___ - -### DisableController +### DisableController • **DisableController**: = "DisableController" -*Defined in [src/types/index.ts:168](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L168)* - -___ +_Defined in_ [_src/types/index.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L168) -### DisableFeature +### DisableFeature • **DisableFeature**: = "DisableFeature" -*Defined in [src/types/index.ts:149](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L149)* - -___ +_Defined in_ [_src/types/index.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L149) -### EnableCountTransferManager +### EnableCountTransferManager • **EnableCountTransferManager**: = "EnableCountTransferManager" -*Defined in [src/types/index.ts:143](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L143)* +_Defined in_ [_src/types/index.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L143) -___ - -### EnableDividendManager +### EnableDividendManager • **EnableDividendManager**: = "EnableDividendManager" -*Defined in [src/types/index.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L140)* - -___ +_Defined in_ [_src/types/index.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L140) -### EnableGeneralPermissionManager +### EnableGeneralPermissionManager • **EnableGeneralPermissionManager**: = "EnableGeneralPermissionManager" -*Defined in [src/types/index.ts:141](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L141)* - -___ +_Defined in_ [_src/types/index.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L141) -### EnableGeneralTransferManager +### EnableGeneralTransferManager • **EnableGeneralTransferManager**: = "EnableGeneralTransferManager" -*Defined in [src/types/index.ts:142](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L142)* +_Defined in_ [_src/types/index.ts:142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L142) -___ - -### EnablePercentageTransferManager +### EnablePercentageTransferManager • **EnablePercentageTransferManager**: = "EnablePercentageTransferManager" -*Defined in [src/types/index.ts:144](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L144)* - -___ +_Defined in_ [_src/types/index.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L144) -### FinalizeSto +### FinalizeSto • **FinalizeSto**: = "FinalizeSto" -*Defined in [src/types/index.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L164)* +_Defined in_ [_src/types/index.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L164) -___ - -### FreezeIssuance +### FreezeIssuance • **FreezeIssuance**: = "FreezeIssuance" -*Defined in [src/types/index.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L150)* - -___ +_Defined in_ [_src/types/index.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L150) -### InvestInSimpleSto +### InvestInSimpleSto • **InvestInSimpleSto**: = "InvestInSimpleSto" -*Defined in [src/types/index.ts:176](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L176)* +_Defined in_ [_src/types/index.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L176) -___ - -### InvestInTieredSto +### InvestInTieredSto • **InvestInTieredSto**: = "InvestInTieredSto" -*Defined in [src/types/index.ts:175](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L175)* - -___ +_Defined in_ [_src/types/index.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L175) -### IssueTokens +### IssueTokens • **IssueTokens**: = "IssueTokens" -*Defined in [src/types/index.ts:171](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L171)* - -___ +_Defined in_ [_src/types/index.ts:171_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L171) -### LaunchSimpleSto +### LaunchSimpleSto • **LaunchSimpleSto**: = "LaunchSimpleSto" -*Defined in [src/types/index.ts:145](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L145)* +_Defined in_ [_src/types/index.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L145) -___ - -### LaunchTieredSto +### LaunchTieredSto • **LaunchTieredSto**: = "LaunchTieredSto" -*Defined in [src/types/index.ts:146](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L146)* - -___ +_Defined in_ [_src/types/index.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L146) -### ModifyDividendsDefaultExclusionList +### ModifyDividendsDefaultExclusionList • **ModifyDividendsDefaultExclusionList**: = "ModifyDividendsDefaultExclusionList" -*Defined in [src/types/index.ts:158](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L158)* - -___ +_Defined in_ [_src/types/index.ts:158_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L158) -### ModifyMaxHolderCount +### ModifyMaxHolderCount • **ModifyMaxHolderCount**: = "ModifyMaxHolderCount" -*Defined in [src/types/index.ts:177](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L177)* +_Defined in_ [_src/types/index.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L177) -___ - -### ModifyMaxHolderPercentage +### ModifyMaxHolderPercentage • **ModifyMaxHolderPercentage**: = "ModifyMaxHolderPercentage" -*Defined in [src/types/index.ts:178](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L178)* - -___ +_Defined in_ [_src/types/index.ts:178_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L178) -### ModifyPercentageExemptions +### ModifyPercentageExemptions • **ModifyPercentageExemptions**: = "ModifyPercentageExemptions" -*Defined in [src/types/index.ts:179](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L179)* - -___ +_Defined in_ [_src/types/index.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L179) -### ModifyTieredStoData +### ModifyTieredStoData • **ModifyTieredStoData**: = "ModifyTieredStoData" -*Defined in [src/types/index.ts:174](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L174)* +_Defined in_ [_src/types/index.ts:174_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L174) -___ - -### ModifyTokenholderData +### ModifyTokenholderData • **ModifyTokenholderData**: = "ModifyTokenholderData" -*Defined in [src/types/index.ts:169](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L169)* - -___ +_Defined in_ [_src/types/index.ts:169_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L169) -### PullDividendPayment +### PullDividendPayment • **PullDividendPayment**: = "PullDividendPayment" -*Defined in [src/types/index.ts:157](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L157)* +_Defined in_ [_src/types/index.ts:157_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L157) -___ - -### PushDividendPayment +### PushDividendPayment • **PushDividendPayment**: = "PushDividendPayment" -*Defined in [src/types/index.ts:156](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L156)* - -___ +_Defined in_ [_src/types/index.ts:156_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L156) -### ReclaimFunds +### ReclaimFunds • **ReclaimFunds**: = "ReclaimFunds" -*Defined in [src/types/index.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L151)* +_Defined in_ [_src/types/index.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L151) -___ - -### RemoveDocument +### RemoveDocument • **RemoveDocument**: = "RemoveDocument" -*Defined in [src/types/index.ts:167](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L167)* - -___ +_Defined in_ [_src/types/index.ts:167_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L167) -### ReserveSecurityToken +### ReserveSecurityToken • **ReserveSecurityToken**: = "ReserveSecurityToken" -*Defined in [src/types/index.ts:152](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L152)* - -___ +_Defined in_ [_src/types/index.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L152) -### RevokeKyc +### RevokeKyc • **RevokeKyc**: = "RevokeKyc" -*Defined in [src/types/index.ts:170](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L170)* +_Defined in_ [_src/types/index.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L170) -___ - -### SetController +### SetController • **SetController**: = "SetController" -*Defined in [src/types/index.ts:165](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L165)* - -___ +_Defined in_ [_src/types/index.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L165) -### SetDividendsWallet +### SetDividendsWallet • **SetDividendsWallet**: = "SetDividendsWallet" -*Defined in [src/types/index.ts:155](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L155)* - -___ +_Defined in_ [_src/types/index.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L155) -### SetDocument +### SetDocument • **SetDocument**: = "SetDocument" -*Defined in [src/types/index.ts:166](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L166)* +_Defined in_ [_src/types/index.ts:166_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L166) -___ - -### SignDisableControllerAck +### SignDisableControllerAck • **SignDisableControllerAck**: = "SignDisableControllerAck" -*Defined in [src/types/index.ts:183](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L183)* - -___ +_Defined in_ [_src/types/index.ts:183_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L183) -### SignFreezeIssuanceAck +### SignFreezeIssuanceAck • **SignFreezeIssuanceAck**: = "SignFreezeIssuanceAck" -*Defined in [src/types/index.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L184)* - -___ +_Defined in_ [_src/types/index.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L184) -### SignTransferData +### SignTransferData • **SignTransferData**: = "SignTransferData" -*Defined in [src/types/index.ts:182](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L182)* +_Defined in_ [_src/types/index.ts:182_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L182) -___ - -### ToggleAllowBeneficialInvestments +### ToggleAllowBeneficialInvestments • **ToggleAllowBeneficialInvestments**: = "ToggleAllowBeneficialInvestments" -*Defined in [src/types/index.ts:173](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L173)* - -___ +_Defined in_ [_src/types/index.ts:173_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L173) -### ToggleAllowPreIssuing +### ToggleAllowPreIssuing • **ToggleAllowPreIssuing**: = "ToggleAllowPreIssuing" -*Defined in [src/types/index.ts:172](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L172)* - -___ +_Defined in_ [_src/types/index.ts:172_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L172) -### ToggleFreezeTransfers +### ToggleFreezeTransfers • **ToggleFreezeTransfers**: = "ToggleFreezeTransfers" -*Defined in [src/types/index.ts:181](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L181)* +_Defined in_ [_src/types/index.ts:181_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L181) -___ - -### TogglePauseSto +### TogglePauseSto • **TogglePauseSto**: = "PauseSto" -*Defined in [src/types/index.ts:163](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L163)* - -___ +_Defined in_ [_src/types/index.ts:163_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L163) -### TransferErc20 +### TransferErc20 • **TransferErc20**: = "TransferErc20" -*Defined in [src/types/index.ts:138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L138)* - -___ +_Defined in_ [_src/types/index.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L138) -### TransferOwnership +### TransferOwnership • **TransferOwnership**: = "TransferOwnership" -*Defined in [src/types/index.ts:185](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L185)* +_Defined in_ [_src/types/index.ts:185_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L185) -___ - -### TransferReservationOwnership +### TransferReservationOwnership • **TransferReservationOwnership**: = "TransferReservationOwnership" -*Defined in [src/types/index.ts:186](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L186)* - -___ +_Defined in_ [_src/types/index.ts:186_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L186) -### TransferSecurityTokens +### TransferSecurityTokens • **TransferSecurityTokens**: = "TransferSecurityTokens" -*Defined in [src/types/index.ts:180](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L180)* - -___ +_Defined in_ [_src/types/index.ts:180_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L180) -### UnnamedProcedure +### UnnamedProcedure • **UnnamedProcedure**: = "UnnamedProcedure" -*Defined in [src/types/index.ts:136](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L136)* +_Defined in_ [_src/types/index.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L136) -___ - -### UpdateDividendsTaxWithholdingList +### UpdateDividendsTaxWithholdingList • **UpdateDividendsTaxWithholdingList**: = "UpdateDividendsTaxWithholdingList" -*Defined in [src/types/index.ts:154](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L154)* - -___ +_Defined in_ [_src/types/index.ts:154_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L154) -### WithdrawTaxes +### WithdrawTaxes • **WithdrawTaxes**: = "WithdrawTaxes" -*Defined in [src/types/index.ts:153](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L153)* +_Defined in_ [_src/types/index.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L153) + diff --git a/docs/api/enums/_types_index_.securitytokenrole.md b/docs/api/enums/_types_index_.securitytokenrole.md index 061e465..7024a60 100644 --- a/docs/api/enums/_types_index_.securitytokenrole.md +++ b/docs/api/enums/_types_index_.securitytokenrole.md @@ -1,4 +1,4 @@ -# Enumeration: SecurityTokenRole +# SecurityTokenRole ## Index @@ -13,48 +13,39 @@ ## Enumeration members -### DividendsAdministrator +### DividendsAdministrator • **DividendsAdministrator**: = "DividendsAdministrator" -*Defined in [src/types/index.ts:1459](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1459)* +_Defined in_ [_src/types/index.ts:1459_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1459) -___ - -### DividendsOperator +### DividendsOperator • **DividendsOperator**: = "DividendsOperator" -*Defined in [src/types/index.ts:1458](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1458)* - -___ +_Defined in_ [_src/types/index.ts:1458_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1458) -### PercentageOwnershipRestrictionsAdministrator +### PercentageOwnershipRestrictionsAdministrator • **PercentageOwnershipRestrictionsAdministrator**: = "PercentageOwnershipRestrictionsAdministrator" -*Defined in [src/types/index.ts:1462](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1462)* - -___ +_Defined in_ [_src/types/index.ts:1462_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1462) -### PermissionsAdministrator +### PermissionsAdministrator • **PermissionsAdministrator**: = "PermissionsAdministrator" -*Defined in [src/types/index.ts:1457](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1457)* +_Defined in_ [_src/types/index.ts:1457_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1457) -___ - -### TokenholderCountRestrictionsAdministrator +### TokenholderCountRestrictionsAdministrator • **TokenholderCountRestrictionsAdministrator**: = "TokenholderCountRestrictionsAdministrator" -*Defined in [src/types/index.ts:1461](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1461)* - -___ +_Defined in_ [_src/types/index.ts:1461_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1461) -### TokenholdersAdministrator +### TokenholdersAdministrator • **TokenholdersAdministrator**: = "TokenholdersAdministrator" -*Defined in [src/types/index.ts:1460](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1460)* +_Defined in_ [_src/types/index.ts:1460_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1460) + diff --git a/docs/api/enums/_types_index_.storole.md b/docs/api/enums/_types_index_.storole.md index ea69eca..ea16963 100644 --- a/docs/api/enums/_types_index_.storole.md +++ b/docs/api/enums/_types_index_.storole.md @@ -1,4 +1,4 @@ -# Enumeration: StoRole +# StoRole ## Index @@ -9,16 +9,15 @@ ## Enumeration members -### StoAdministrator +### StoAdministrator • **StoAdministrator**: = "StoAdministrator" -*Defined in [src/types/index.ts:1467](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1467)* +_Defined in_ [_src/types/index.ts:1467_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1467) -___ - -### StoOperator +### StoOperator • **StoOperator**: = "StoOperator" -*Defined in [src/types/index.ts:1466](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1466)* +_Defined in_ [_src/types/index.ts:1466_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1466) + diff --git a/docs/api/enums/_types_index_.stotype.md b/docs/api/enums/_types_index_.stotype.md index a91c29f..e581f72 100644 --- a/docs/api/enums/_types_index_.stotype.md +++ b/docs/api/enums/_types_index_.stotype.md @@ -1,4 +1,4 @@ -# Enumeration: StoType +# StoType ## Index @@ -9,16 +9,15 @@ ## Enumeration members -### Simple +### Simple • **Simple**: = "Simple" -*Defined in [src/types/index.ts:51](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L51)* +_Defined in_ [_src/types/index.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L51) -___ - -### Tiered +### Tiered • **Tiered**: = "Tiered" -*Defined in [src/types/index.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L52)* +_Defined in_ [_src/types/index.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L52) + diff --git a/docs/api/enums/_types_index_.transactionspeed.md b/docs/api/enums/_types_index_.transactionspeed.md index fb642de..9a8197e 100644 --- a/docs/api/enums/_types_index_.transactionspeed.md +++ b/docs/api/enums/_types_index_.transactionspeed.md @@ -1,4 +1,4 @@ -# Enumeration: TransactionSpeed +# TransactionSpeed ## Index @@ -11,32 +11,27 @@ ## Enumeration members -### Fast +### Fast • **Fast**: = "Fast" -*Defined in [src/types/index.ts:1444](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1444)* +_Defined in_ [_src/types/index.ts:1444_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1444) -___ - -### Fastest +### Fastest • **Fastest**: = "Fastest" -*Defined in [src/types/index.ts:1445](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1445)* - -___ +_Defined in_ [_src/types/index.ts:1445_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1445) -### Medium +### Medium • **Medium**: = "Medium" -*Defined in [src/types/index.ts:1443](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1443)* +_Defined in_ [_src/types/index.ts:1443_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1443) -___ - -### Slow +### Slow • **Slow**: = "Slow" -*Defined in [src/types/index.ts:1442](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1442)* +_Defined in_ [_src/types/index.ts:1442_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1442) + diff --git a/docs/api/enums/_types_index_.transactionstatus.md b/docs/api/enums/_types_index_.transactionstatus.md index 31896db..f27095b 100644 --- a/docs/api/enums/_types_index_.transactionstatus.md +++ b/docs/api/enums/_types_index_.transactionstatus.md @@ -1,4 +1,4 @@ -# Enumeration: TransactionStatus +# TransactionStatus ## Index @@ -13,48 +13,39 @@ ## Enumeration members -### Failed +### Failed • **Failed**: = "Failed" -*Defined in [src/types/index.ts:1385](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1385)* +_Defined in_ [_src/types/index.ts:1385_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1385) -___ - -### Idle +### Idle • **Idle**: = "Idle" -*Defined in [src/types/index.ts:1380](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1380)* - -___ +_Defined in_ [_src/types/index.ts:1380_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1380) -### Rejected +### Rejected • **Rejected**: = "Rejected" -*Defined in [src/types/index.ts:1383](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1383)* - -___ +_Defined in_ [_src/types/index.ts:1383_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1383) -### Running +### Running • **Running**: = "Running" -*Defined in [src/types/index.ts:1382](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1382)* +_Defined in_ [_src/types/index.ts:1382_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1382) -___ - -### Succeeded +### Succeeded • **Succeeded**: = "Succeeded" -*Defined in [src/types/index.ts:1384](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1384)* - -___ +_Defined in_ [_src/types/index.ts:1384_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1384) -### Unapproved +### Unapproved • **Unapproved**: = "Unapproved" -*Defined in [src/types/index.ts:1381](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1381)* +_Defined in_ [_src/types/index.ts:1381_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1381) + diff --git a/docs/api/enums/_types_index_.transferstatuscode.md b/docs/api/enums/_types_index_.transferstatuscode.md index deadb3e..0d134bd 100644 --- a/docs/api/enums/_types_index_.transferstatuscode.md +++ b/docs/api/enums/_types_index_.transferstatuscode.md @@ -1,4 +1,4 @@ -# Enumeration: TransferStatusCode +# TransferStatusCode ## Index @@ -16,72 +16,57 @@ ## Enumeration members -### FundsLocked +### FundsLocked • **FundsLocked**: = "FundsLocked" -*Defined in [src/types/index.ts:1476](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1476)* +_Defined in_ [_src/types/index.ts:1476_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1476) -___ - -### InsufficientAllowance +### InsufficientAllowance • **InsufficientAllowance**: = "InsufficientAllowance" -*Defined in [src/types/index.ts:1474](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1474)* - -___ +_Defined in_ [_src/types/index.ts:1474_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1474) -### InsufficientBalance +### InsufficientBalance • **InsufficientBalance**: = "InsufficientBalance" -*Defined in [src/types/index.ts:1473](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1473)* - -___ +_Defined in_ [_src/types/index.ts:1473_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1473) -### InvalidOperator +### InvalidOperator • **InvalidOperator**: = "InvalidOperator" -*Defined in [src/types/index.ts:1479](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1479)* +_Defined in_ [_src/types/index.ts:1479_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1479) -___ - -### InvalidReceiver +### InvalidReceiver • **InvalidReceiver**: = "InvalidReceiver" -*Defined in [src/types/index.ts:1478](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1478)* - -___ +_Defined in_ [_src/types/index.ts:1478_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1478) -### InvalidSender +### InvalidSender • **InvalidSender**: = "InvalidSender" -*Defined in [src/types/index.ts:1477](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1477)* +_Defined in_ [_src/types/index.ts:1477_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1477) -___ - -### TransferFailure +### TransferFailure • **TransferFailure**: = "TransferFailure" -*Defined in [src/types/index.ts:1471](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1471)* - -___ +_Defined in_ [_src/types/index.ts:1471_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1471) -### TransferSuccess +### TransferSuccess • **TransferSuccess**: = "TransferSuccess" -*Defined in [src/types/index.ts:1472](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1472)* +_Defined in_ [_src/types/index.ts:1472_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1472) -___ - -### TransfersHalted +### TransfersHalted • **TransfersHalted**: = "TransfersHalted" -*Defined in [src/types/index.ts:1475](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1475)* +_Defined in_ [_src/types/index.ts:1475_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1475) + diff --git a/docs/api/external-modules/README.md b/docs/api/external-modules/README.md new file mode 100644 index 0000000..1df2574 --- /dev/null +++ b/docs/api/external-modules/README.md @@ -0,0 +1,2 @@ +# External Modules + diff --git a/docs/api/external-modules/_browserutils_.browsersupport.md b/docs/api/external-modules/_browserutils_.browsersupport.md new file mode 100644 index 0000000..b5e7b9f --- /dev/null +++ b/docs/api/external-modules/_browserutils_.browsersupport.md @@ -0,0 +1,37 @@ +# BrowserSupport + +## Index + +### Enumeration members + +* [MetamaskLegacy](../enums/_browserutils_.browsersupport.md#metamasklegacy) +* [MetamaskModern](../enums/_browserutils_.browsersupport.md#metamaskmodern) +* [NoMetamask](../enums/_browserutils_.browsersupport.md#nometamask) +* [None](../enums/_browserutils_.browsersupport.md#none) + +## Enumeration members + +### MetamaskLegacy + +• **MetamaskLegacy**: = "MetamaskLegacy" + +_Defined in_ [_src/browserUtils.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L8) + +### MetamaskModern + +• **MetamaskModern**: = "MetamaskModern" + +_Defined in_ [_src/browserUtils.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L9) + +### NoMetamask + +• **NoMetamask**: = "NoMetamask" + +_Defined in_ [_src/browserUtils.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L7) + +### None + +• **None**: = "None" + +_Defined in_ [_src/browserUtils.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L10) + diff --git a/docs/api/external-modules/_browserutils_.ethereum.md b/docs/api/external-modules/_browserutils_.ethereum.md new file mode 100644 index 0000000..8cca229 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.ethereum.md @@ -0,0 +1,61 @@ +# Ethereum + +## Hierarchy + +* Provider + + ↳ **Ethereum** + +## Index + +### Properties + +* [\_metamask](../interfaces/_browserutils_.ethereum.md#optional-_metamask) +* [networkVersion](../interfaces/_browserutils_.ethereum.md#networkversion) + +### Methods + +* [enable](../interfaces/_browserutils_.ethereum.md#enable) +* [sendAsync](../interfaces/_browserutils_.ethereum.md#sendasync) + +## Properties + +### `Optional` \_metamask + +• **\_metamask**? : _undefined \| object_ + +_Defined in_ [_src/browserUtils.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L15) + +### networkVersion + +• **networkVersion**: _string_ + +_Defined in_ [_src/browserUtils.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L14) + +## Methods + +### enable + +▸ **enable**\(\): _Promise‹any›_ + +_Defined in_ [_src/browserUtils.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L18) + +**Returns:** _Promise‹any›_ + +### sendAsync + +▸ **sendAsync**\(`payload`: JSONRPCRequestPayload, `callback`: JSONRPCErrorCallback\): _void_ + +_Inherited from void_ + +Defined in node\_modules/ethereum-types/lib/index.d.ts:13 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `payload` | JSONRPCRequestPayload | +| `callback` | JSONRPCErrorCallback | + +**Returns:** _void_ + diff --git a/docs/api/external-modules/_browserutils_.extendedwindow.md b/docs/api/external-modules/_browserutils_.extendedwindow.md new file mode 100644 index 0000000..59e48d5 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.extendedwindow.md @@ -0,0 +1,2819 @@ +# ExtendedWindow + +## Hierarchy + +* Window + + ↳ **ExtendedWindow** + + ↳ [WindowWithEthereum](../interfaces/_browserutils_.windowwithethereum.md) + + ↳ [WindowWithWeb3](../interfaces/_browserutils_.windowwithweb3.md) + +## Index + +### Properties + +* [Blob](../interfaces/_browserutils_.extendedwindow.md#blob) +* [URL](../interfaces/_browserutils_.extendedwindow.md#url) +* [URLSearchParams](../interfaces/_browserutils_.extendedwindow.md#urlsearchparams) +* [Window](../interfaces/_browserutils_.extendedwindow.md#window) +* [applicationCache](../interfaces/_browserutils_.extendedwindow.md#applicationcache) +* [caches](../interfaces/_browserutils_.extendedwindow.md#caches) +* [clientInformation](../interfaces/_browserutils_.extendedwindow.md#clientinformation) +* [closed](../interfaces/_browserutils_.extendedwindow.md#closed) +* [console](../interfaces/_browserutils_.extendedwindow.md#console) +* [crypto](../interfaces/_browserutils_.extendedwindow.md#crypto) +* [customElements](../interfaces/_browserutils_.extendedwindow.md#customelements) +* [defaultStatus](../interfaces/_browserutils_.extendedwindow.md#defaultstatus) +* [devicePixelRatio](../interfaces/_browserutils_.extendedwindow.md#devicepixelratio) +* [doNotTrack](../interfaces/_browserutils_.extendedwindow.md#donottrack) +* [document](../interfaces/_browserutils_.extendedwindow.md#document) +* [ethereum](../interfaces/_browserutils_.extendedwindow.md#optional-ethereum) +* [event](../interfaces/_browserutils_.extendedwindow.md#event) +* [external](../interfaces/_browserutils_.extendedwindow.md#external) +* [frameElement](../interfaces/_browserutils_.extendedwindow.md#frameelement) +* [frames](../interfaces/_browserutils_.extendedwindow.md#frames) +* [history](../interfaces/_browserutils_.extendedwindow.md#history) +* [indexedDB](../interfaces/_browserutils_.extendedwindow.md#indexeddb) +* [innerHeight](../interfaces/_browserutils_.extendedwindow.md#innerheight) +* [innerWidth](../interfaces/_browserutils_.extendedwindow.md#innerwidth) +* [isSecureContext](../interfaces/_browserutils_.extendedwindow.md#issecurecontext) +* [length](../interfaces/_browserutils_.extendedwindow.md#length) +* [localStorage](../interfaces/_browserutils_.extendedwindow.md#localstorage) +* [location](../interfaces/_browserutils_.extendedwindow.md#location) +* [locationbar](../interfaces/_browserutils_.extendedwindow.md#locationbar) +* [menubar](../interfaces/_browserutils_.extendedwindow.md#menubar) +* [msContentScript](../interfaces/_browserutils_.extendedwindow.md#mscontentscript) +* [name](../interfaces/_browserutils_.extendedwindow.md#name) +* [navigator](../interfaces/_browserutils_.extendedwindow.md#navigator) +* [offscreenBuffering](../interfaces/_browserutils_.extendedwindow.md#offscreenbuffering) +* [onabort](../interfaces/_browserutils_.extendedwindow.md#onabort) +* [onafterprint](../interfaces/_browserutils_.extendedwindow.md#onafterprint) +* [onanimationcancel](../interfaces/_browserutils_.extendedwindow.md#onanimationcancel) +* [onanimationend](../interfaces/_browserutils_.extendedwindow.md#onanimationend) +* [onanimationiteration](../interfaces/_browserutils_.extendedwindow.md#onanimationiteration) +* [onanimationstart](../interfaces/_browserutils_.extendedwindow.md#onanimationstart) +* [onauxclick](../interfaces/_browserutils_.extendedwindow.md#onauxclick) +* [onbeforeprint](../interfaces/_browserutils_.extendedwindow.md#onbeforeprint) +* [onbeforeunload](../interfaces/_browserutils_.extendedwindow.md#onbeforeunload) +* [onblur](../interfaces/_browserutils_.extendedwindow.md#onblur) +* [oncancel](../interfaces/_browserutils_.extendedwindow.md#oncancel) +* [oncanplay](../interfaces/_browserutils_.extendedwindow.md#oncanplay) +* [oncanplaythrough](../interfaces/_browserutils_.extendedwindow.md#oncanplaythrough) +* [onchange](../interfaces/_browserutils_.extendedwindow.md#onchange) +* [onclick](../interfaces/_browserutils_.extendedwindow.md#onclick) +* [onclose](../interfaces/_browserutils_.extendedwindow.md#onclose) +* [oncompassneedscalibration](../interfaces/_browserutils_.extendedwindow.md#oncompassneedscalibration) +* [oncontextmenu](../interfaces/_browserutils_.extendedwindow.md#oncontextmenu) +* [oncuechange](../interfaces/_browserutils_.extendedwindow.md#oncuechange) +* [ondblclick](../interfaces/_browserutils_.extendedwindow.md#ondblclick) +* [ondevicelight](../interfaces/_browserutils_.extendedwindow.md#ondevicelight) +* [ondevicemotion](../interfaces/_browserutils_.extendedwindow.md#ondevicemotion) +* [ondeviceorientation](../interfaces/_browserutils_.extendedwindow.md#ondeviceorientation) +* [ondrag](../interfaces/_browserutils_.extendedwindow.md#ondrag) +* [ondragend](../interfaces/_browserutils_.extendedwindow.md#ondragend) +* [ondragenter](../interfaces/_browserutils_.extendedwindow.md#ondragenter) +* [ondragexit](../interfaces/_browserutils_.extendedwindow.md#ondragexit) +* [ondragleave](../interfaces/_browserutils_.extendedwindow.md#ondragleave) +* [ondragover](../interfaces/_browserutils_.extendedwindow.md#ondragover) +* [ondragstart](../interfaces/_browserutils_.extendedwindow.md#ondragstart) +* [ondrop](../interfaces/_browserutils_.extendedwindow.md#ondrop) +* [ondurationchange](../interfaces/_browserutils_.extendedwindow.md#ondurationchange) +* [onemptied](../interfaces/_browserutils_.extendedwindow.md#onemptied) +* [onended](../interfaces/_browserutils_.extendedwindow.md#onended) +* [onerror](../interfaces/_browserutils_.extendedwindow.md#onerror) +* [onfocus](../interfaces/_browserutils_.extendedwindow.md#onfocus) +* [ongotpointercapture](../interfaces/_browserutils_.extendedwindow.md#ongotpointercapture) +* [onhashchange](../interfaces/_browserutils_.extendedwindow.md#onhashchange) +* [oninput](../interfaces/_browserutils_.extendedwindow.md#oninput) +* [oninvalid](../interfaces/_browserutils_.extendedwindow.md#oninvalid) +* [onkeydown](../interfaces/_browserutils_.extendedwindow.md#onkeydown) +* [onkeypress](../interfaces/_browserutils_.extendedwindow.md#onkeypress) +* [onkeyup](../interfaces/_browserutils_.extendedwindow.md#onkeyup) +* [onlanguagechange](../interfaces/_browserutils_.extendedwindow.md#onlanguagechange) +* [onload](../interfaces/_browserutils_.extendedwindow.md#onload) +* [onloadeddata](../interfaces/_browserutils_.extendedwindow.md#onloadeddata) +* [onloadedmetadata](../interfaces/_browserutils_.extendedwindow.md#onloadedmetadata) +* [onloadend](../interfaces/_browserutils_.extendedwindow.md#onloadend) +* [onloadstart](../interfaces/_browserutils_.extendedwindow.md#onloadstart) +* [onlostpointercapture](../interfaces/_browserutils_.extendedwindow.md#onlostpointercapture) +* [onmessage](../interfaces/_browserutils_.extendedwindow.md#onmessage) +* [onmessageerror](../interfaces/_browserutils_.extendedwindow.md#onmessageerror) +* [onmousedown](../interfaces/_browserutils_.extendedwindow.md#onmousedown) +* [onmouseenter](../interfaces/_browserutils_.extendedwindow.md#onmouseenter) +* [onmouseleave](../interfaces/_browserutils_.extendedwindow.md#onmouseleave) +* [onmousemove](../interfaces/_browserutils_.extendedwindow.md#onmousemove) +* [onmouseout](../interfaces/_browserutils_.extendedwindow.md#onmouseout) +* [onmouseover](../interfaces/_browserutils_.extendedwindow.md#onmouseover) +* [onmouseup](../interfaces/_browserutils_.extendedwindow.md#onmouseup) +* [onmousewheel](../interfaces/_browserutils_.extendedwindow.md#onmousewheel) +* [onmsgesturechange](../interfaces/_browserutils_.extendedwindow.md#onmsgesturechange) +* [onmsgesturedoubletap](../interfaces/_browserutils_.extendedwindow.md#onmsgesturedoubletap) +* [onmsgestureend](../interfaces/_browserutils_.extendedwindow.md#onmsgestureend) +* [onmsgesturehold](../interfaces/_browserutils_.extendedwindow.md#onmsgesturehold) +* [onmsgesturestart](../interfaces/_browserutils_.extendedwindow.md#onmsgesturestart) +* [onmsgesturetap](../interfaces/_browserutils_.extendedwindow.md#onmsgesturetap) +* [onmsinertiastart](../interfaces/_browserutils_.extendedwindow.md#onmsinertiastart) +* [onmspointercancel](../interfaces/_browserutils_.extendedwindow.md#onmspointercancel) +* [onmspointerdown](../interfaces/_browserutils_.extendedwindow.md#onmspointerdown) +* [onmspointerenter](../interfaces/_browserutils_.extendedwindow.md#onmspointerenter) +* [onmspointerleave](../interfaces/_browserutils_.extendedwindow.md#onmspointerleave) +* [onmspointermove](../interfaces/_browserutils_.extendedwindow.md#onmspointermove) +* [onmspointerout](../interfaces/_browserutils_.extendedwindow.md#onmspointerout) +* [onmspointerover](../interfaces/_browserutils_.extendedwindow.md#onmspointerover) +* [onmspointerup](../interfaces/_browserutils_.extendedwindow.md#onmspointerup) +* [onoffline](../interfaces/_browserutils_.extendedwindow.md#onoffline) +* [ononline](../interfaces/_browserutils_.extendedwindow.md#ononline) +* [onorientationchange](../interfaces/_browserutils_.extendedwindow.md#onorientationchange) +* [onpagehide](../interfaces/_browserutils_.extendedwindow.md#onpagehide) +* [onpageshow](../interfaces/_browserutils_.extendedwindow.md#onpageshow) +* [onpause](../interfaces/_browserutils_.extendedwindow.md#onpause) +* [onplay](../interfaces/_browserutils_.extendedwindow.md#onplay) +* [onplaying](../interfaces/_browserutils_.extendedwindow.md#onplaying) +* [onpointercancel](../interfaces/_browserutils_.extendedwindow.md#onpointercancel) +* [onpointerdown](../interfaces/_browserutils_.extendedwindow.md#onpointerdown) +* [onpointerenter](../interfaces/_browserutils_.extendedwindow.md#onpointerenter) +* [onpointerleave](../interfaces/_browserutils_.extendedwindow.md#onpointerleave) +* [onpointermove](../interfaces/_browserutils_.extendedwindow.md#onpointermove) +* [onpointerout](../interfaces/_browserutils_.extendedwindow.md#onpointerout) +* [onpointerover](../interfaces/_browserutils_.extendedwindow.md#onpointerover) +* [onpointerup](../interfaces/_browserutils_.extendedwindow.md#onpointerup) +* [onpopstate](../interfaces/_browserutils_.extendedwindow.md#onpopstate) +* [onprogress](../interfaces/_browserutils_.extendedwindow.md#onprogress) +* [onratechange](../interfaces/_browserutils_.extendedwindow.md#onratechange) +* [onreadystatechange](../interfaces/_browserutils_.extendedwindow.md#onreadystatechange) +* [onrejectionhandled](../interfaces/_browserutils_.extendedwindow.md#onrejectionhandled) +* [onreset](../interfaces/_browserutils_.extendedwindow.md#onreset) +* [onresize](../interfaces/_browserutils_.extendedwindow.md#onresize) +* [onscroll](../interfaces/_browserutils_.extendedwindow.md#onscroll) +* [onsecuritypolicyviolation](../interfaces/_browserutils_.extendedwindow.md#onsecuritypolicyviolation) +* [onseeked](../interfaces/_browserutils_.extendedwindow.md#onseeked) +* [onseeking](../interfaces/_browserutils_.extendedwindow.md#onseeking) +* [onselect](../interfaces/_browserutils_.extendedwindow.md#onselect) +* [onstalled](../interfaces/_browserutils_.extendedwindow.md#onstalled) +* [onstorage](../interfaces/_browserutils_.extendedwindow.md#onstorage) +* [onsubmit](../interfaces/_browserutils_.extendedwindow.md#onsubmit) +* [onsuspend](../interfaces/_browserutils_.extendedwindow.md#onsuspend) +* [ontimeupdate](../interfaces/_browserutils_.extendedwindow.md#ontimeupdate) +* [ontoggle](../interfaces/_browserutils_.extendedwindow.md#ontoggle) +* [ontouchcancel](../interfaces/_browserutils_.extendedwindow.md#ontouchcancel) +* [ontouchend](../interfaces/_browserutils_.extendedwindow.md#ontouchend) +* [ontouchmove](../interfaces/_browserutils_.extendedwindow.md#ontouchmove) +* [ontouchstart](../interfaces/_browserutils_.extendedwindow.md#ontouchstart) +* [ontransitioncancel](../interfaces/_browserutils_.extendedwindow.md#ontransitioncancel) +* [ontransitionend](../interfaces/_browserutils_.extendedwindow.md#ontransitionend) +* [ontransitionrun](../interfaces/_browserutils_.extendedwindow.md#ontransitionrun) +* [ontransitionstart](../interfaces/_browserutils_.extendedwindow.md#ontransitionstart) +* [onunhandledrejection](../interfaces/_browserutils_.extendedwindow.md#onunhandledrejection) +* [onunload](../interfaces/_browserutils_.extendedwindow.md#onunload) +* [onvolumechange](../interfaces/_browserutils_.extendedwindow.md#onvolumechange) +* [onvrdisplayactivate](../interfaces/_browserutils_.extendedwindow.md#onvrdisplayactivate) +* [onvrdisplayblur](../interfaces/_browserutils_.extendedwindow.md#onvrdisplayblur) +* [onvrdisplayconnect](../interfaces/_browserutils_.extendedwindow.md#onvrdisplayconnect) +* [onvrdisplaydeactivate](../interfaces/_browserutils_.extendedwindow.md#onvrdisplaydeactivate) +* [onvrdisplaydisconnect](../interfaces/_browserutils_.extendedwindow.md#onvrdisplaydisconnect) +* [onvrdisplayfocus](../interfaces/_browserutils_.extendedwindow.md#onvrdisplayfocus) +* [onvrdisplaypointerrestricted](../interfaces/_browserutils_.extendedwindow.md#onvrdisplaypointerrestricted) +* [onvrdisplaypointerunrestricted](../interfaces/_browserutils_.extendedwindow.md#onvrdisplaypointerunrestricted) +* [onvrdisplaypresentchange](../interfaces/_browserutils_.extendedwindow.md#onvrdisplaypresentchange) +* [onwaiting](../interfaces/_browserutils_.extendedwindow.md#onwaiting) +* [onwheel](../interfaces/_browserutils_.extendedwindow.md#onwheel) +* [opener](../interfaces/_browserutils_.extendedwindow.md#opener) +* [orientation](../interfaces/_browserutils_.extendedwindow.md#orientation) +* [origin](../interfaces/_browserutils_.extendedwindow.md#origin) +* [outerHeight](../interfaces/_browserutils_.extendedwindow.md#outerheight) +* [outerWidth](../interfaces/_browserutils_.extendedwindow.md#outerwidth) +* [pageXOffset](../interfaces/_browserutils_.extendedwindow.md#pagexoffset) +* [pageYOffset](../interfaces/_browserutils_.extendedwindow.md#pageyoffset) +* [parent](../interfaces/_browserutils_.extendedwindow.md#parent) +* [performance](../interfaces/_browserutils_.extendedwindow.md#performance) +* [personalbar](../interfaces/_browserutils_.extendedwindow.md#personalbar) +* [screen](../interfaces/_browserutils_.extendedwindow.md#screen) +* [screenLeft](../interfaces/_browserutils_.extendedwindow.md#screenleft) +* [screenTop](../interfaces/_browserutils_.extendedwindow.md#screentop) +* [screenX](../interfaces/_browserutils_.extendedwindow.md#screenx) +* [screenY](../interfaces/_browserutils_.extendedwindow.md#screeny) +* [scrollX](../interfaces/_browserutils_.extendedwindow.md#scrollx) +* [scrollY](../interfaces/_browserutils_.extendedwindow.md#scrolly) +* [scrollbars](../interfaces/_browserutils_.extendedwindow.md#scrollbars) +* [self](../interfaces/_browserutils_.extendedwindow.md#self) +* [sessionStorage](../interfaces/_browserutils_.extendedwindow.md#sessionstorage) +* [speechSynthesis](../interfaces/_browserutils_.extendedwindow.md#speechsynthesis) +* [status](../interfaces/_browserutils_.extendedwindow.md#status) +* [statusbar](../interfaces/_browserutils_.extendedwindow.md#statusbar) +* [styleMedia](../interfaces/_browserutils_.extendedwindow.md#stylemedia) +* [toolbar](../interfaces/_browserutils_.extendedwindow.md#toolbar) +* [top](../interfaces/_browserutils_.extendedwindow.md#top) +* [web3](../interfaces/_browserutils_.extendedwindow.md#optional-web3) +* [window](../interfaces/_browserutils_.extendedwindow.md#window) + +### Methods + +* [addEventListener](../interfaces/_browserutils_.extendedwindow.md#addeventlistener) +* [alert](../interfaces/_browserutils_.extendedwindow.md#alert) +* [atob](../interfaces/_browserutils_.extendedwindow.md#atob) +* [blur](../interfaces/_browserutils_.extendedwindow.md#blur) +* [btoa](../interfaces/_browserutils_.extendedwindow.md#btoa) +* [cancelAnimationFrame](../interfaces/_browserutils_.extendedwindow.md#cancelanimationframe) +* [captureEvents](../interfaces/_browserutils_.extendedwindow.md#captureevents) +* [clearInterval](../interfaces/_browserutils_.extendedwindow.md#clearinterval) +* [clearTimeout](../interfaces/_browserutils_.extendedwindow.md#cleartimeout) +* [close](../interfaces/_browserutils_.extendedwindow.md#close) +* [confirm](../interfaces/_browserutils_.extendedwindow.md#confirm) +* [createImageBitmap](../interfaces/_browserutils_.extendedwindow.md#createimagebitmap) +* [departFocus](../interfaces/_browserutils_.extendedwindow.md#departfocus) +* [dispatchEvent](../interfaces/_browserutils_.extendedwindow.md#dispatchevent) +* [fetch](../interfaces/_browserutils_.extendedwindow.md#fetch) +* [focus](../interfaces/_browserutils_.extendedwindow.md#focus) +* [getComputedStyle](../interfaces/_browserutils_.extendedwindow.md#getcomputedstyle) +* [getMatchedCSSRules](../interfaces/_browserutils_.extendedwindow.md#getmatchedcssrules) +* [getSelection](../interfaces/_browserutils_.extendedwindow.md#getselection) +* [matchMedia](../interfaces/_browserutils_.extendedwindow.md#matchmedia) +* [moveBy](../interfaces/_browserutils_.extendedwindow.md#moveby) +* [moveTo](../interfaces/_browserutils_.extendedwindow.md#moveto) +* [msWriteProfilerMark](../interfaces/_browserutils_.extendedwindow.md#mswriteprofilermark) +* [open](../interfaces/_browserutils_.extendedwindow.md#open) +* [postMessage](../interfaces/_browserutils_.extendedwindow.md#postmessage) +* [print](../interfaces/_browserutils_.extendedwindow.md#print) +* [prompt](../interfaces/_browserutils_.extendedwindow.md#prompt) +* [queueMicrotask](../interfaces/_browserutils_.extendedwindow.md#queuemicrotask) +* [releaseEvents](../interfaces/_browserutils_.extendedwindow.md#releaseevents) +* [removeEventListener](../interfaces/_browserutils_.extendedwindow.md#removeeventlistener) +* [requestAnimationFrame](../interfaces/_browserutils_.extendedwindow.md#requestanimationframe) +* [resizeBy](../interfaces/_browserutils_.extendedwindow.md#resizeby) +* [resizeTo](../interfaces/_browserutils_.extendedwindow.md#resizeto) +* [scroll](../interfaces/_browserutils_.extendedwindow.md#scroll) +* [scrollBy](../interfaces/_browserutils_.extendedwindow.md#scrollby) +* [scrollTo](../interfaces/_browserutils_.extendedwindow.md#scrollto) +* [setInterval](../interfaces/_browserutils_.extendedwindow.md#setinterval) +* [setTimeout](../interfaces/_browserutils_.extendedwindow.md#settimeout) +* [stop](../interfaces/_browserutils_.extendedwindow.md#stop) +* [webkitCancelAnimationFrame](../interfaces/_browserutils_.extendedwindow.md#webkitcancelanimationframe) +* [webkitConvertPointFromNodeToPage](../interfaces/_browserutils_.extendedwindow.md#webkitconvertpointfromnodetopage) +* [webkitConvertPointFromPageToNode](../interfaces/_browserutils_.extendedwindow.md#webkitconvertpointfrompagetonode) +* [webkitRequestAnimationFrame](../interfaces/_browserutils_.extendedwindow.md#webkitrequestanimationframe) + +## Properties + +### Blob + +• **Blob**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 + +#### Type declaration: + +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ + +### URL + +• **URL**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 + +#### Type declaration: + +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ + +### URLSearchParams + +• **URLSearchParams**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 + +#### Type declaration: + +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ + +### Window + +• **Window**: _object_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16644 + +#### Type declaration: + +* **new \_\_type**\(\): _Window_ +* **prototype**: _Window_ + +### applicationCache + +• **applicationCache**: _ApplicationCache_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 + +### caches + +• **caches**: _CacheStorage_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 + +### clientInformation + +• **clientInformation**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 + +### closed + +• **closed**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 + +### console + +• **console**: _Console_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 + +### crypto + +• **crypto**: _Crypto_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 + +### customElements + +• **customElements**: _CustomElementRegistry_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 + +### defaultStatus + +• **defaultStatus**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 + +### devicePixelRatio + +• **devicePixelRatio**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 + +### doNotTrack + +• **doNotTrack**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 + +### document + +• **document**: _Document_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 + +### `Optional` ethereum + +• **ethereum**? : [_Ethereum_](../interfaces/_browserutils_.ethereum.md) + +_Defined in_ [_src/browserUtils.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31) + +### event + +• **event**: _Event \| undefined_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 + +### external + +• **external**: _External_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 + +**`deprecated`** + +### frameElement + +• **frameElement**: _Element_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 + +### frames + +• **frames**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 + +### history + +• **history**: _History_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 + +### indexedDB + +• **indexedDB**: _IDBFactory_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 + +### innerHeight + +• **innerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 + +### innerWidth + +• **innerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 + +### isSecureContext + +• **isSecureContext**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 + +### length + +• **length**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 + +### localStorage + +• **localStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 + +### location + +• **location**: _Location_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 + +### locationbar + +• **locationbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 + +### menubar + +• **menubar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 + +### msContentScript + +• **msContentScript**: _ExtensionScriptApis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 + +### name + +• **name**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 + +### navigator + +• **navigator**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 + +### offscreenBuffering + +• **offscreenBuffering**: _string \| boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 + +### onabort + +• **onabort**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 + +Fires when the user aborts the download. + +**`param`** The event. + +### onafterprint + +• **onafterprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 + +### onanimationcancel + +• **onanimationcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 + +### onanimationend + +• **onanimationend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 + +### onanimationiteration + +• **onanimationiteration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 + +### onanimationstart + +• **onanimationstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 + +### onauxclick + +• **onauxclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 + +### onbeforeprint + +• **onbeforeprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 + +### onbeforeunload + +• **onbeforeunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 + +### onblur + +• **onblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 + +Fires when the object loses the input focus. + +**`param`** The focus event. + +### oncancel + +• **oncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 + +### oncanplay + +• **oncanplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 + +Occurs when playback is possible, but would require further buffering. + +**`param`** The event. + +### oncanplaythrough + +• **oncanplaythrough**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 + +### onchange + +• **onchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 + +Fires when the contents of the object or selection have changed. + +**`param`** The event. + +### onclick + +• **onclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 + +Fires when the user clicks the left mouse button on the object + +**`param`** The mouse event. + +### onclose + +• **onclose**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 + +### oncompassneedscalibration + +• **oncompassneedscalibration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 + +### oncontextmenu + +• **oncontextmenu**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 + +Fires when the user clicks the right mouse button in the client area, opening the context menu. + +**`param`** The mouse event. + +### oncuechange + +• **oncuechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 + +### ondblclick + +• **ondblclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 + +Fires when the user double-clicks the object. + +**`param`** The mouse event. + +### ondevicelight + +• **ondevicelight**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 + +### ondevicemotion + +• **ondevicemotion**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 + +### ondeviceorientation + +• **ondeviceorientation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 + +### ondrag + +• **ondrag**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 + +Fires on the source object continuously during a drag operation. + +**`param`** The event. + +### ondragend + +• **ondragend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 + +Fires on the source object when the user releases the mouse at the close of a drag operation. + +**`param`** The event. + +### ondragenter + +• **ondragenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 + +Fires on the target element when the user drags the object to a valid drop target. + +**`param`** The drag event. + +### ondragexit + +• **ondragexit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 + +### ondragleave + +• **ondragleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 + +Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. + +**`param`** The drag event. + +### ondragover + +• **ondragover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 + +Fires on the target element continuously while the user drags the object over a valid drop target. + +**`param`** The event. + +### ondragstart + +• **ondragstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 + +Fires on the source object when the user starts to drag a text selection or selected object. + +**`param`** The event. + +### ondrop + +• **ondrop**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 + +### ondurationchange + +• **ondurationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 + +Occurs when the duration attribute is updated. + +**`param`** The event. + +### onemptied + +• **onemptied**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 + +Occurs when the media element is reset to its initial state. + +**`param`** The event. + +### onended + +• **onended**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 + +Occurs when the end of playback is reached. + +**`param`** The event + +### onerror + +• **onerror**: _ErrorEventHandler_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 + +Fires when an error occurs during object loading. + +**`param`** The event. + +### onfocus + +• **onfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 + +Fires when the object receives focus. + +**`param`** The event. + +### ongotpointercapture + +• **ongotpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 + +### onhashchange + +• **onhashchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 + +### oninput + +• **oninput**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 + +### oninvalid + +• **oninvalid**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 + +### onkeydown + +• **onkeydown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 + +Fires when the user presses a key. + +**`param`** The keyboard event + +### onkeypress + +• **onkeypress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 + +Fires when the user presses an alphanumeric key. + +**`param`** The event. + +### onkeyup + +• **onkeyup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 + +Fires when the user releases a key. + +**`param`** The keyboard event + +### onlanguagechange + +• **onlanguagechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 + +### onload + +• **onload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 + +Fires immediately after the browser loads the object. + +**`param`** The event. + +### onloadeddata + +• **onloadeddata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 + +Occurs when media data is loaded at the current playback position. + +**`param`** The event. + +### onloadedmetadata + +• **onloadedmetadata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 + +Occurs when the duration and dimensions of the media have been determined. + +**`param`** The event. + +### onloadend + +• **onloadend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 + +### onloadstart + +• **onloadstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 + +Occurs when Internet Explorer begins looking for media data. + +**`param`** The event. + +### onlostpointercapture + +• **onlostpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 + +### onmessage + +• **onmessage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 + +### onmessageerror + +• **onmessageerror**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 + +### onmousedown + +• **onmousedown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 + +Fires when the user clicks the object with either mouse button. + +**`param`** The mouse event. + +### onmouseenter + +• **onmouseenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 + +### onmouseleave + +• **onmouseleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 + +### onmousemove + +• **onmousemove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 + +Fires when the user moves the mouse over the object. + +**`param`** The mouse event. + +### onmouseout + +• **onmouseout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 + +Fires when the user moves the mouse pointer outside the boundaries of the object. + +**`param`** The mouse event. + +### onmouseover + +• **onmouseover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 + +Fires when the user moves the mouse pointer into the object. + +**`param`** The mouse event. + +### onmouseup + +• **onmouseup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 + +Fires when the user releases a mouse button while the mouse is over the object. + +**`param`** The mouse event. + +### onmousewheel + +• **onmousewheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 + +### onmsgesturechange + +• **onmsgesturechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 + +### onmsgesturedoubletap + +• **onmsgesturedoubletap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 + +### onmsgestureend + +• **onmsgestureend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 + +### onmsgesturehold + +• **onmsgesturehold**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 + +### onmsgesturestart + +• **onmsgesturestart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 + +### onmsgesturetap + +• **onmsgesturetap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 + +### onmsinertiastart + +• **onmsinertiastart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 + +### onmspointercancel + +• **onmspointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 + +### onmspointerdown + +• **onmspointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 + +### onmspointerenter + +• **onmspointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 + +### onmspointerleave + +• **onmspointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 + +### onmspointermove + +• **onmspointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 + +### onmspointerout + +• **onmspointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 + +### onmspointerover + +• **onmspointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 + +### onmspointerup + +• **onmspointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 + +### onoffline + +• **onoffline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 + +### ononline + +• **ononline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 + +### onorientationchange + +• **onorientationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 + +**`deprecated`** + +### onpagehide + +• **onpagehide**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 + +### onpageshow + +• **onpageshow**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 + +### onpause + +• **onpause**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 + +Occurs when playback is paused. + +**`param`** The event. + +### onplay + +• **onplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 + +Occurs when the play method is requested. + +**`param`** The event. + +### onplaying + +• **onplaying**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 + +Occurs when the audio or video has started playing. + +**`param`** The event. + +### onpointercancel + +• **onpointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 + +### onpointerdown + +• **onpointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 + +### onpointerenter + +• **onpointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 + +### onpointerleave + +• **onpointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 + +### onpointermove + +• **onpointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 + +### onpointerout + +• **onpointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 + +### onpointerover + +• **onpointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 + +### onpointerup + +• **onpointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 + +### onpopstate + +• **onpopstate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 + +### onprogress + +• **onprogress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 + +Occurs to indicate progress while downloading media data. + +**`param`** The event. + +### onratechange + +• **onratechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 + +Occurs when the playback rate is increased or decreased. + +**`param`** The event. + +### onreadystatechange + +• **onreadystatechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 + +### onrejectionhandled + +• **onrejectionhandled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 + +### onreset + +• **onreset**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 + +Fires when the user resets a form. + +**`param`** The event. + +### onresize + +• **onresize**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 + +### onscroll + +• **onscroll**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 + +Fires when the user repositions the scroll box in the scroll bar on the object. + +**`param`** The event. + +### onsecuritypolicyviolation + +• **onsecuritypolicyviolation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 + +### onseeked + +• **onseeked**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 + +Occurs when the seek operation ends. + +**`param`** The event. + +### onseeking + +• **onseeking**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 + +Occurs when the current playback position is moved. + +**`param`** The event. + +### onselect + +• **onselect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 + +Fires when the current selection changes. + +**`param`** The event. + +### onstalled + +• **onstalled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 + +Occurs when the download has stopped. + +**`param`** The event. + +### onstorage + +• **onstorage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 + +### onsubmit + +• **onsubmit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 + +### onsuspend + +• **onsuspend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 + +Occurs if the load operation has been intentionally halted. + +**`param`** The event. + +### ontimeupdate + +• **ontimeupdate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 + +Occurs to indicate the current playback position. + +**`param`** The event. + +### ontoggle + +• **ontoggle**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 + +### ontouchcancel + +• **ontouchcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 + +### ontouchend + +• **ontouchend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 + +### ontouchmove + +• **ontouchmove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 + +### ontouchstart + +• **ontouchstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 + +### ontransitioncancel + +• **ontransitioncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 + +### ontransitionend + +• **ontransitionend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 + +### ontransitionrun + +• **ontransitionrun**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 + +### ontransitionstart + +• **ontransitionstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 + +### onunhandledrejection + +• **onunhandledrejection**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 + +### onunload + +• **onunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 + +### onvolumechange + +• **onvolumechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 + +Occurs when the volume is changed, or playback is muted or unmuted. + +**`param`** The event. + +### onvrdisplayactivate + +• **onvrdisplayactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 + +### onvrdisplayblur + +• **onvrdisplayblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 + +### onvrdisplayconnect + +• **onvrdisplayconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 + +### onvrdisplaydeactivate + +• **onvrdisplaydeactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 + +### onvrdisplaydisconnect + +• **onvrdisplaydisconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 + +### onvrdisplayfocus + +• **onvrdisplayfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 + +### onvrdisplaypointerrestricted + +• **onvrdisplaypointerrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 + +### onvrdisplaypointerunrestricted + +• **onvrdisplaypointerunrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 + +### onvrdisplaypresentchange + +• **onvrdisplaypresentchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 + +### onwaiting + +• **onwaiting**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 + +Occurs when playback stops because the next frame of a video resource is not available. + +**`param`** The event. + +### onwheel + +• **onwheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 + +### opener + +• **opener**: _any_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 + +### orientation + +• **orientation**: _string \| number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 + +**`deprecated`** + +### origin + +• **origin**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 + +### outerHeight + +• **outerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 + +### outerWidth + +• **outerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 + +### pageXOffset + +• **pageXOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 + +### pageYOffset + +• **pageYOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 + +### parent + +• **parent**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 + +### performance + +• **performance**: _Performance_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 + +### personalbar + +• **personalbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 + +### screen + +• **screen**: _Screen_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 + +### screenLeft + +• **screenLeft**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 + +### screenTop + +• **screenTop**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 + +### screenX + +• **screenX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 + +### screenY + +• **screenY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 + +### scrollX + +• **scrollX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 + +### scrollY + +• **scrollY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 + +### scrollbars + +• **scrollbars**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 + +### self + +• **self**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 + +### sessionStorage + +• **sessionStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 + +### speechSynthesis + +• **speechSynthesis**: _SpeechSynthesis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 + +### status + +• **status**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 + +### statusbar + +• **statusbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 + +### styleMedia + +• **styleMedia**: _StyleMedia_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 + +### toolbar + +• **toolbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 + +### top + +• **top**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 + +### `Optional` web3 + +• **web3**? : [_InjectedWeb3_](../interfaces/_browserutils_.injectedweb3.md) + +_Defined in_ [_src/browserUtils.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32) + +### window + +• **window**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 + +## Methods + +### addEventListener + +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ + +**Returns:** _void_ + +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | + +**Returns:** _void_ + +### alert + +▸ **alert**\(`message?`: any\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | any | + +**Returns:** _void_ + +### atob + +▸ **atob**\(`encodedString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `encodedString` | string | + +**Returns:** _string_ + +### blur + +▸ **blur**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 + +**Returns:** _void_ + +### btoa + +▸ **btoa**\(`rawString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `rawString` | string | + +**Returns:** _string_ + +### cancelAnimationFrame + +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### captureEvents + +▸ **captureEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 + +**`deprecated`** + +**Returns:** _void_ + +### clearInterval + +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### clearTimeout + +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### close + +▸ **close**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 + +**Returns:** _void_ + +### confirm + +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | + +**Returns:** _boolean_ + +### createImageBitmap + +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | + +**Returns:** _Promise‹ImageBitmap›_ + +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | + +**Returns:** _Promise‹ImageBitmap›_ + +### departFocus + +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | + +**Returns:** _void_ + +### dispatchEvent + +▸ **dispatchEvent**\(`event`: Event\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 + +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `event` | Event | + +**Returns:** _boolean_ + +### fetch + +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | + +**Returns:** _Promise‹Response›_ + +### focus + +▸ **focus**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 + +**Returns:** _void_ + +### getComputedStyle + +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSStyleDeclaration_ + +### getMatchedCSSRules + +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSRuleList_ + +### getSelection + +▸ **getSelection**\(\): _Selection_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 + +**Returns:** _Selection_ + +### matchMedia + +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `query` | string | + +**Returns:** _MediaQueryList_ + +### moveBy + +▸ **moveBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### moveTo + +▸ **moveTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### msWriteProfilerMark + +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | + +**Returns:** _void_ + +### open + +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | + +**Returns:** _Window \| null_ + +### postMessage + +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | + +**Returns:** _void_ + +### print + +▸ **print**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 + +**Returns:** _void_ + +### prompt + +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | + +**Returns:** _string \| null_ + +### queueMicrotask + +▸ **queueMicrotask**\(`callback`: Function\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | Function | + +**Returns:** _void_ + +### releaseEvents + +▸ **releaseEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 + +**`deprecated`** + +**Returns:** _void_ + +### removeEventListener + +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| EventListenerOptions_ + +**Returns:** _void_ + +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | + +**Returns:** _void_ + +### requestAnimationFrame + +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + +### resizeBy + +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### resizeTo + +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scroll + +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scroll**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollBy + +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollTo + +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### setInterval + +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### setTimeout + +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### stop + +▸ **stop**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 + +**Returns:** _void_ + +### webkitCancelAnimationFrame + +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### webkitConvertPointFromNodeToPage + +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitConvertPointFromPageToNode + +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitRequestAnimationFrame + +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + diff --git a/docs/api/external-modules/_browserutils_.injectedweb3.md b/docs/api/external-modules/_browserutils_.injectedweb3.md new file mode 100644 index 0000000..f4dcfe6 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.injectedweb3.md @@ -0,0 +1,27 @@ +# InjectedWeb3 + +## Hierarchy + +* **InjectedWeb3** + +## Index + +### Properties + +* [currentProvider](../interfaces/_browserutils_.injectedweb3.md#currentprovider) +* [version](../interfaces/_browserutils_.injectedweb3.md#version) + +## Properties + +### currentProvider + +• **currentProvider**: _Provider_ + +_Defined in_ [_src/browserUtils.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L26) + +### version + +• **version**: [_Web3VersionAPI_](../interfaces/_browserutils_.web3versionapi.md) + +_Defined in_ [_src/browserUtils.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L27) + diff --git a/docs/api/external-modules/_browserutils_.md b/docs/api/external-modules/_browserutils_.md new file mode 100644 index 0000000..d5fac5a --- /dev/null +++ b/docs/api/external-modules/_browserutils_.md @@ -0,0 +1,89 @@ +# browserUtils + +## Index + +### Enumerations + +* [BrowserSupport](../enums/_browserutils_.browsersupport.md) + +### Interfaces + +* [Ethereum](../interfaces/_browserutils_.ethereum.md) +* [ExtendedWindow](../interfaces/_browserutils_.extendedwindow.md) +* [InjectedWeb3](../interfaces/_browserutils_.injectedweb3.md) +* [Web3VersionAPI](../interfaces/_browserutils_.web3versionapi.md) +* [WindowWithEthereum](../interfaces/_browserutils_.windowwithethereum.md) +* [WindowWithWeb3](../interfaces/_browserutils_.windowwithweb3.md) + +### Functions + +* [getBrowserSupport](_browserutils_.md#getbrowsersupport) +* [onAddressChange](_browserutils_.md#onaddresschange) +* [onNetworkChange](_browserutils_.md#onnetworkchange) + +## Functions + +### getBrowserSupport + +▸ **getBrowserSupport**\(\): [_NoMetamask_](../enums/_browserutils_.browsersupport.md#nometamask) _\|_ [_MetamaskLegacy_](../enums/_browserutils_.browsersupport.md#metamasklegacy) _\|_ [_MetamaskModern_](../enums/_browserutils_.browsersupport.md#metamaskmodern) _\|_ [_None_](../enums/_browserutils_.browsersupport.md#none) + +_Defined in_ [_src/browserUtils.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L45) + +Returns the browser support for Ethereum + +**Returns:** [_NoMetamask_](../enums/_browserutils_.browsersupport.md#nometamask) _\|_ [_MetamaskLegacy_](../enums/_browserutils_.browsersupport.md#metamasklegacy) _\|_ [_MetamaskModern_](../enums/_browserutils_.browsersupport.md#metamaskmodern) _\|_ [_None_](../enums/_browserutils_.browsersupport.md#none) + +### onAddressChange + +▸ **onAddressChange**\(`cb`: function\): _\(Anonymous function\)_ + +_Defined in_ [_src/browserUtils.ts:189_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L189) + +Runs the callback anytime the wallet address changes in the browser + +**Parameters:** + +▪ **cb**: _function_ + +callback that receives the new address and the previous one + +▸ \(`newAddress`: string, `previousAddress?`: undefined \| string\): _void_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `newAddress` | string | +| `previousAddress?` | undefined \| string | + +**Returns:** _\(Anonymous function\)_ + +an unsubscribe function + +### onNetworkChange + +▸ **onNetworkChange**\(`cb`: function\): _\(Anonymous function\)_ + +_Defined in_ [_src/browserUtils.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L225) + +Runs the callback anytime the current network changes in the browser + +**Parameters:** + +▪ **cb**: _function_ + +callback that receives the new network id and the previous one + +▸ \(`newNetwork`: number, `previousNetwork?`: undefined \| number\): _void_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `newNetwork` | number | +| `previousNetwork?` | undefined \| number | + +**Returns:** _\(Anonymous function\)_ + +an unsubscribe function + diff --git a/docs/api/external-modules/_browserutils_.web3versionapi.md b/docs/api/external-modules/_browserutils_.web3versionapi.md new file mode 100644 index 0000000..fd562f0 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.web3versionapi.md @@ -0,0 +1,20 @@ +# Web3VersionAPI + +## Hierarchy + +* **Web3VersionAPI** + +## Index + +### Properties + +* [network](../interfaces/_browserutils_.web3versionapi.md#optional-network) + +## Properties + +### `Optional` network + +• **network**? : _undefined \| string_ + +_Defined in_ [_src/browserUtils.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L22) + diff --git a/docs/api/external-modules/_browserutils_.windowwithethereum.md b/docs/api/external-modules/_browserutils_.windowwithethereum.md new file mode 100644 index 0000000..547bb46 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.windowwithethereum.md @@ -0,0 +1,2807 @@ +# WindowWithEthereum + +## Hierarchy + +↳ [ExtendedWindow](../interfaces/_browserutils_.extendedwindow.md) + +↳ **WindowWithEthereum** + +## Index + +### Properties + +* [Blob](../interfaces/_browserutils_.windowwithethereum.md#blob) +* [URL](../interfaces/_browserutils_.windowwithethereum.md#url) +* [URLSearchParams](../interfaces/_browserutils_.windowwithethereum.md#urlsearchparams) +* [applicationCache](../interfaces/_browserutils_.windowwithethereum.md#applicationcache) +* [caches](../interfaces/_browserutils_.windowwithethereum.md#caches) +* [clientInformation](../interfaces/_browserutils_.windowwithethereum.md#clientinformation) +* [closed](../interfaces/_browserutils_.windowwithethereum.md#closed) +* [console](../interfaces/_browserutils_.windowwithethereum.md#console) +* [crypto](../interfaces/_browserutils_.windowwithethereum.md#crypto) +* [customElements](../interfaces/_browserutils_.windowwithethereum.md#customelements) +* [defaultStatus](../interfaces/_browserutils_.windowwithethereum.md#defaultstatus) +* [devicePixelRatio](../interfaces/_browserutils_.windowwithethereum.md#devicepixelratio) +* [doNotTrack](../interfaces/_browserutils_.windowwithethereum.md#donottrack) +* [document](../interfaces/_browserutils_.windowwithethereum.md#document) +* [ethereum](../interfaces/_browserutils_.windowwithethereum.md#ethereum) +* [event](../interfaces/_browserutils_.windowwithethereum.md#event) +* [external](../interfaces/_browserutils_.windowwithethereum.md#external) +* [frameElement](../interfaces/_browserutils_.windowwithethereum.md#frameelement) +* [frames](../interfaces/_browserutils_.windowwithethereum.md#frames) +* [history](../interfaces/_browserutils_.windowwithethereum.md#history) +* [indexedDB](../interfaces/_browserutils_.windowwithethereum.md#indexeddb) +* [innerHeight](../interfaces/_browserutils_.windowwithethereum.md#innerheight) +* [innerWidth](../interfaces/_browserutils_.windowwithethereum.md#innerwidth) +* [isSecureContext](../interfaces/_browserutils_.windowwithethereum.md#issecurecontext) +* [length](../interfaces/_browserutils_.windowwithethereum.md#length) +* [localStorage](../interfaces/_browserutils_.windowwithethereum.md#localstorage) +* [location](../interfaces/_browserutils_.windowwithethereum.md#location) +* [locationbar](../interfaces/_browserutils_.windowwithethereum.md#locationbar) +* [menubar](../interfaces/_browserutils_.windowwithethereum.md#menubar) +* [msContentScript](../interfaces/_browserutils_.windowwithethereum.md#mscontentscript) +* [name](../interfaces/_browserutils_.windowwithethereum.md#name) +* [navigator](../interfaces/_browserutils_.windowwithethereum.md#navigator) +* [offscreenBuffering](../interfaces/_browserutils_.windowwithethereum.md#offscreenbuffering) +* [onabort](../interfaces/_browserutils_.windowwithethereum.md#onabort) +* [onafterprint](../interfaces/_browserutils_.windowwithethereum.md#onafterprint) +* [onanimationcancel](../interfaces/_browserutils_.windowwithethereum.md#onanimationcancel) +* [onanimationend](../interfaces/_browserutils_.windowwithethereum.md#onanimationend) +* [onanimationiteration](../interfaces/_browserutils_.windowwithethereum.md#onanimationiteration) +* [onanimationstart](../interfaces/_browserutils_.windowwithethereum.md#onanimationstart) +* [onauxclick](../interfaces/_browserutils_.windowwithethereum.md#onauxclick) +* [onbeforeprint](../interfaces/_browserutils_.windowwithethereum.md#onbeforeprint) +* [onbeforeunload](../interfaces/_browserutils_.windowwithethereum.md#onbeforeunload) +* [onblur](../interfaces/_browserutils_.windowwithethereum.md#onblur) +* [oncancel](../interfaces/_browserutils_.windowwithethereum.md#oncancel) +* [oncanplay](../interfaces/_browserutils_.windowwithethereum.md#oncanplay) +* [oncanplaythrough](../interfaces/_browserutils_.windowwithethereum.md#oncanplaythrough) +* [onchange](../interfaces/_browserutils_.windowwithethereum.md#onchange) +* [onclick](../interfaces/_browserutils_.windowwithethereum.md#onclick) +* [onclose](../interfaces/_browserutils_.windowwithethereum.md#onclose) +* [oncompassneedscalibration](../interfaces/_browserutils_.windowwithethereum.md#oncompassneedscalibration) +* [oncontextmenu](../interfaces/_browserutils_.windowwithethereum.md#oncontextmenu) +* [oncuechange](../interfaces/_browserutils_.windowwithethereum.md#oncuechange) +* [ondblclick](../interfaces/_browserutils_.windowwithethereum.md#ondblclick) +* [ondevicelight](../interfaces/_browserutils_.windowwithethereum.md#ondevicelight) +* [ondevicemotion](../interfaces/_browserutils_.windowwithethereum.md#ondevicemotion) +* [ondeviceorientation](../interfaces/_browserutils_.windowwithethereum.md#ondeviceorientation) +* [ondrag](../interfaces/_browserutils_.windowwithethereum.md#ondrag) +* [ondragend](../interfaces/_browserutils_.windowwithethereum.md#ondragend) +* [ondragenter](../interfaces/_browserutils_.windowwithethereum.md#ondragenter) +* [ondragexit](../interfaces/_browserutils_.windowwithethereum.md#ondragexit) +* [ondragleave](../interfaces/_browserutils_.windowwithethereum.md#ondragleave) +* [ondragover](../interfaces/_browserutils_.windowwithethereum.md#ondragover) +* [ondragstart](../interfaces/_browserutils_.windowwithethereum.md#ondragstart) +* [ondrop](../interfaces/_browserutils_.windowwithethereum.md#ondrop) +* [ondurationchange](../interfaces/_browserutils_.windowwithethereum.md#ondurationchange) +* [onemptied](../interfaces/_browserutils_.windowwithethereum.md#onemptied) +* [onended](../interfaces/_browserutils_.windowwithethereum.md#onended) +* [onerror](../interfaces/_browserutils_.windowwithethereum.md#onerror) +* [onfocus](../interfaces/_browserutils_.windowwithethereum.md#onfocus) +* [ongotpointercapture](../interfaces/_browserutils_.windowwithethereum.md#ongotpointercapture) +* [onhashchange](../interfaces/_browserutils_.windowwithethereum.md#onhashchange) +* [oninput](../interfaces/_browserutils_.windowwithethereum.md#oninput) +* [oninvalid](../interfaces/_browserutils_.windowwithethereum.md#oninvalid) +* [onkeydown](../interfaces/_browserutils_.windowwithethereum.md#onkeydown) +* [onkeypress](../interfaces/_browserutils_.windowwithethereum.md#onkeypress) +* [onkeyup](../interfaces/_browserutils_.windowwithethereum.md#onkeyup) +* [onlanguagechange](../interfaces/_browserutils_.windowwithethereum.md#onlanguagechange) +* [onload](../interfaces/_browserutils_.windowwithethereum.md#onload) +* [onloadeddata](../interfaces/_browserutils_.windowwithethereum.md#onloadeddata) +* [onloadedmetadata](../interfaces/_browserutils_.windowwithethereum.md#onloadedmetadata) +* [onloadend](../interfaces/_browserutils_.windowwithethereum.md#onloadend) +* [onloadstart](../interfaces/_browserutils_.windowwithethereum.md#onloadstart) +* [onlostpointercapture](../interfaces/_browserutils_.windowwithethereum.md#onlostpointercapture) +* [onmessage](../interfaces/_browserutils_.windowwithethereum.md#onmessage) +* [onmessageerror](../interfaces/_browserutils_.windowwithethereum.md#onmessageerror) +* [onmousedown](../interfaces/_browserutils_.windowwithethereum.md#onmousedown) +* [onmouseenter](../interfaces/_browserutils_.windowwithethereum.md#onmouseenter) +* [onmouseleave](../interfaces/_browserutils_.windowwithethereum.md#onmouseleave) +* [onmousemove](../interfaces/_browserutils_.windowwithethereum.md#onmousemove) +* [onmouseout](../interfaces/_browserutils_.windowwithethereum.md#onmouseout) +* [onmouseover](../interfaces/_browserutils_.windowwithethereum.md#onmouseover) +* [onmouseup](../interfaces/_browserutils_.windowwithethereum.md#onmouseup) +* [onmousewheel](../interfaces/_browserutils_.windowwithethereum.md#onmousewheel) +* [onmsgesturechange](../interfaces/_browserutils_.windowwithethereum.md#onmsgesturechange) +* [onmsgesturedoubletap](../interfaces/_browserutils_.windowwithethereum.md#onmsgesturedoubletap) +* [onmsgestureend](../interfaces/_browserutils_.windowwithethereum.md#onmsgestureend) +* [onmsgesturehold](../interfaces/_browserutils_.windowwithethereum.md#onmsgesturehold) +* [onmsgesturestart](../interfaces/_browserutils_.windowwithethereum.md#onmsgesturestart) +* [onmsgesturetap](../interfaces/_browserutils_.windowwithethereum.md#onmsgesturetap) +* [onmsinertiastart](../interfaces/_browserutils_.windowwithethereum.md#onmsinertiastart) +* [onmspointercancel](../interfaces/_browserutils_.windowwithethereum.md#onmspointercancel) +* [onmspointerdown](../interfaces/_browserutils_.windowwithethereum.md#onmspointerdown) +* [onmspointerenter](../interfaces/_browserutils_.windowwithethereum.md#onmspointerenter) +* [onmspointerleave](../interfaces/_browserutils_.windowwithethereum.md#onmspointerleave) +* [onmspointermove](../interfaces/_browserutils_.windowwithethereum.md#onmspointermove) +* [onmspointerout](../interfaces/_browserutils_.windowwithethereum.md#onmspointerout) +* [onmspointerover](../interfaces/_browserutils_.windowwithethereum.md#onmspointerover) +* [onmspointerup](../interfaces/_browserutils_.windowwithethereum.md#onmspointerup) +* [onoffline](../interfaces/_browserutils_.windowwithethereum.md#onoffline) +* [ononline](../interfaces/_browserutils_.windowwithethereum.md#ononline) +* [onorientationchange](../interfaces/_browserutils_.windowwithethereum.md#onorientationchange) +* [onpagehide](../interfaces/_browserutils_.windowwithethereum.md#onpagehide) +* [onpageshow](../interfaces/_browserutils_.windowwithethereum.md#onpageshow) +* [onpause](../interfaces/_browserutils_.windowwithethereum.md#onpause) +* [onplay](../interfaces/_browserutils_.windowwithethereum.md#onplay) +* [onplaying](../interfaces/_browserutils_.windowwithethereum.md#onplaying) +* [onpointercancel](../interfaces/_browserutils_.windowwithethereum.md#onpointercancel) +* [onpointerdown](../interfaces/_browserutils_.windowwithethereum.md#onpointerdown) +* [onpointerenter](../interfaces/_browserutils_.windowwithethereum.md#onpointerenter) +* [onpointerleave](../interfaces/_browserutils_.windowwithethereum.md#onpointerleave) +* [onpointermove](../interfaces/_browserutils_.windowwithethereum.md#onpointermove) +* [onpointerout](../interfaces/_browserutils_.windowwithethereum.md#onpointerout) +* [onpointerover](../interfaces/_browserutils_.windowwithethereum.md#onpointerover) +* [onpointerup](../interfaces/_browserutils_.windowwithethereum.md#onpointerup) +* [onpopstate](../interfaces/_browserutils_.windowwithethereum.md#onpopstate) +* [onprogress](../interfaces/_browserutils_.windowwithethereum.md#onprogress) +* [onratechange](../interfaces/_browserutils_.windowwithethereum.md#onratechange) +* [onreadystatechange](../interfaces/_browserutils_.windowwithethereum.md#onreadystatechange) +* [onrejectionhandled](../interfaces/_browserutils_.windowwithethereum.md#onrejectionhandled) +* [onreset](../interfaces/_browserutils_.windowwithethereum.md#onreset) +* [onresize](../interfaces/_browserutils_.windowwithethereum.md#onresize) +* [onscroll](../interfaces/_browserutils_.windowwithethereum.md#onscroll) +* [onsecuritypolicyviolation](../interfaces/_browserutils_.windowwithethereum.md#onsecuritypolicyviolation) +* [onseeked](../interfaces/_browserutils_.windowwithethereum.md#onseeked) +* [onseeking](../interfaces/_browserutils_.windowwithethereum.md#onseeking) +* [onselect](../interfaces/_browserutils_.windowwithethereum.md#onselect) +* [onstalled](../interfaces/_browserutils_.windowwithethereum.md#onstalled) +* [onstorage](../interfaces/_browserutils_.windowwithethereum.md#onstorage) +* [onsubmit](../interfaces/_browserutils_.windowwithethereum.md#onsubmit) +* [onsuspend](../interfaces/_browserutils_.windowwithethereum.md#onsuspend) +* [ontimeupdate](../interfaces/_browserutils_.windowwithethereum.md#ontimeupdate) +* [ontoggle](../interfaces/_browserutils_.windowwithethereum.md#ontoggle) +* [ontouchcancel](../interfaces/_browserutils_.windowwithethereum.md#ontouchcancel) +* [ontouchend](../interfaces/_browserutils_.windowwithethereum.md#ontouchend) +* [ontouchmove](../interfaces/_browserutils_.windowwithethereum.md#ontouchmove) +* [ontouchstart](../interfaces/_browserutils_.windowwithethereum.md#ontouchstart) +* [ontransitioncancel](../interfaces/_browserutils_.windowwithethereum.md#ontransitioncancel) +* [ontransitionend](../interfaces/_browserutils_.windowwithethereum.md#ontransitionend) +* [ontransitionrun](../interfaces/_browserutils_.windowwithethereum.md#ontransitionrun) +* [ontransitionstart](../interfaces/_browserutils_.windowwithethereum.md#ontransitionstart) +* [onunhandledrejection](../interfaces/_browserutils_.windowwithethereum.md#onunhandledrejection) +* [onunload](../interfaces/_browserutils_.windowwithethereum.md#onunload) +* [onvolumechange](../interfaces/_browserutils_.windowwithethereum.md#onvolumechange) +* [onvrdisplayactivate](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplayactivate) +* [onvrdisplayblur](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplayblur) +* [onvrdisplayconnect](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplayconnect) +* [onvrdisplaydeactivate](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplaydeactivate) +* [onvrdisplaydisconnect](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplaydisconnect) +* [onvrdisplayfocus](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplayfocus) +* [onvrdisplaypointerrestricted](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplaypointerrestricted) +* [onvrdisplaypointerunrestricted](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplaypointerunrestricted) +* [onvrdisplaypresentchange](../interfaces/_browserutils_.windowwithethereum.md#onvrdisplaypresentchange) +* [onwaiting](../interfaces/_browserutils_.windowwithethereum.md#onwaiting) +* [onwheel](../interfaces/_browserutils_.windowwithethereum.md#onwheel) +* [opener](../interfaces/_browserutils_.windowwithethereum.md#opener) +* [orientation](../interfaces/_browserutils_.windowwithethereum.md#orientation) +* [origin](../interfaces/_browserutils_.windowwithethereum.md#origin) +* [outerHeight](../interfaces/_browserutils_.windowwithethereum.md#outerheight) +* [outerWidth](../interfaces/_browserutils_.windowwithethereum.md#outerwidth) +* [pageXOffset](../interfaces/_browserutils_.windowwithethereum.md#pagexoffset) +* [pageYOffset](../interfaces/_browserutils_.windowwithethereum.md#pageyoffset) +* [parent](../interfaces/_browserutils_.windowwithethereum.md#parent) +* [performance](../interfaces/_browserutils_.windowwithethereum.md#performance) +* [personalbar](../interfaces/_browserutils_.windowwithethereum.md#personalbar) +* [screen](../interfaces/_browserutils_.windowwithethereum.md#screen) +* [screenLeft](../interfaces/_browserutils_.windowwithethereum.md#screenleft) +* [screenTop](../interfaces/_browserutils_.windowwithethereum.md#screentop) +* [screenX](../interfaces/_browserutils_.windowwithethereum.md#screenx) +* [screenY](../interfaces/_browserutils_.windowwithethereum.md#screeny) +* [scrollX](../interfaces/_browserutils_.windowwithethereum.md#scrollx) +* [scrollY](../interfaces/_browserutils_.windowwithethereum.md#scrolly) +* [scrollbars](../interfaces/_browserutils_.windowwithethereum.md#scrollbars) +* [self](../interfaces/_browserutils_.windowwithethereum.md#self) +* [sessionStorage](../interfaces/_browserutils_.windowwithethereum.md#sessionstorage) +* [speechSynthesis](../interfaces/_browserutils_.windowwithethereum.md#speechsynthesis) +* [status](../interfaces/_browserutils_.windowwithethereum.md#status) +* [statusbar](../interfaces/_browserutils_.windowwithethereum.md#statusbar) +* [styleMedia](../interfaces/_browserutils_.windowwithethereum.md#stylemedia) +* [toolbar](../interfaces/_browserutils_.windowwithethereum.md#toolbar) +* [top](../interfaces/_browserutils_.windowwithethereum.md#top) +* [web3](../interfaces/_browserutils_.windowwithethereum.md#optional-web3) +* [window](../interfaces/_browserutils_.windowwithethereum.md#window) + +### Methods + +* [addEventListener](../interfaces/_browserutils_.windowwithethereum.md#addeventlistener) +* [alert](../interfaces/_browserutils_.windowwithethereum.md#alert) +* [atob](../interfaces/_browserutils_.windowwithethereum.md#atob) +* [blur](../interfaces/_browserutils_.windowwithethereum.md#blur) +* [btoa](../interfaces/_browserutils_.windowwithethereum.md#btoa) +* [cancelAnimationFrame](../interfaces/_browserutils_.windowwithethereum.md#cancelanimationframe) +* [captureEvents](../interfaces/_browserutils_.windowwithethereum.md#captureevents) +* [clearInterval](../interfaces/_browserutils_.windowwithethereum.md#clearinterval) +* [clearTimeout](../interfaces/_browserutils_.windowwithethereum.md#cleartimeout) +* [close](../interfaces/_browserutils_.windowwithethereum.md#close) +* [confirm](../interfaces/_browserutils_.windowwithethereum.md#confirm) +* [createImageBitmap](../interfaces/_browserutils_.windowwithethereum.md#createimagebitmap) +* [departFocus](../interfaces/_browserutils_.windowwithethereum.md#departfocus) +* [dispatchEvent](../interfaces/_browserutils_.windowwithethereum.md#dispatchevent) +* [fetch](../interfaces/_browserutils_.windowwithethereum.md#fetch) +* [focus](../interfaces/_browserutils_.windowwithethereum.md#focus) +* [getComputedStyle](../interfaces/_browserutils_.windowwithethereum.md#getcomputedstyle) +* [getMatchedCSSRules](../interfaces/_browserutils_.windowwithethereum.md#getmatchedcssrules) +* [getSelection](../interfaces/_browserutils_.windowwithethereum.md#getselection) +* [matchMedia](../interfaces/_browserutils_.windowwithethereum.md#matchmedia) +* [moveBy](../interfaces/_browserutils_.windowwithethereum.md#moveby) +* [moveTo](../interfaces/_browserutils_.windowwithethereum.md#moveto) +* [msWriteProfilerMark](../interfaces/_browserutils_.windowwithethereum.md#mswriteprofilermark) +* [open](../interfaces/_browserutils_.windowwithethereum.md#open) +* [postMessage](../interfaces/_browserutils_.windowwithethereum.md#postmessage) +* [print](../interfaces/_browserutils_.windowwithethereum.md#print) +* [prompt](../interfaces/_browserutils_.windowwithethereum.md#prompt) +* [queueMicrotask](../interfaces/_browserutils_.windowwithethereum.md#queuemicrotask) +* [releaseEvents](../interfaces/_browserutils_.windowwithethereum.md#releaseevents) +* [removeEventListener](../interfaces/_browserutils_.windowwithethereum.md#removeeventlistener) +* [requestAnimationFrame](../interfaces/_browserutils_.windowwithethereum.md#requestanimationframe) +* [resizeBy](../interfaces/_browserutils_.windowwithethereum.md#resizeby) +* [resizeTo](../interfaces/_browserutils_.windowwithethereum.md#resizeto) +* [scroll](../interfaces/_browserutils_.windowwithethereum.md#scroll) +* [scrollBy](../interfaces/_browserutils_.windowwithethereum.md#scrollby) +* [scrollTo](../interfaces/_browserutils_.windowwithethereum.md#scrollto) +* [setInterval](../interfaces/_browserutils_.windowwithethereum.md#setinterval) +* [setTimeout](../interfaces/_browserutils_.windowwithethereum.md#settimeout) +* [stop](../interfaces/_browserutils_.windowwithethereum.md#stop) +* [webkitCancelAnimationFrame](../interfaces/_browserutils_.windowwithethereum.md#webkitcancelanimationframe) +* [webkitConvertPointFromNodeToPage](../interfaces/_browserutils_.windowwithethereum.md#webkitconvertpointfromnodetopage) +* [webkitConvertPointFromPageToNode](../interfaces/_browserutils_.windowwithethereum.md#webkitconvertpointfrompagetonode) +* [webkitRequestAnimationFrame](../interfaces/_browserutils_.windowwithethereum.md#webkitrequestanimationframe) + +## Properties + +### Blob + +• **Blob**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 + +#### Type declaration: + +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ + +### URL + +• **URL**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 + +#### Type declaration: + +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ + +### URLSearchParams + +• **URLSearchParams**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 + +#### Type declaration: + +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ + +### applicationCache + +• **applicationCache**: _ApplicationCache_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 + +### caches + +• **caches**: _CacheStorage_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 + +### clientInformation + +• **clientInformation**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 + +### closed + +• **closed**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 + +### console + +• **console**: _Console_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 + +### crypto + +• **crypto**: _Crypto_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 + +### customElements + +• **customElements**: _CustomElementRegistry_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 + +### defaultStatus + +• **defaultStatus**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 + +### devicePixelRatio + +• **devicePixelRatio**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 + +### doNotTrack + +• **doNotTrack**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 + +### document + +• **document**: _Document_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 + +### ethereum + +• **ethereum**: [_Ethereum_](../interfaces/_browserutils_.ethereum.md) + +_Overrides_ [_ExtendedWindow_](../interfaces/_browserutils_.extendedwindow.md)_._[_ethereum_](../interfaces/_browserutils_.extendedwindow.md#optional-ethereum) + +_Defined in_ [_src/browserUtils.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L36) + +### event + +• **event**: _Event \| undefined_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 + +### external + +• **external**: _External_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 + +**`deprecated`** + +### frameElement + +• **frameElement**: _Element_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 + +### frames + +• **frames**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 + +### history + +• **history**: _History_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 + +### indexedDB + +• **indexedDB**: _IDBFactory_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 + +### innerHeight + +• **innerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 + +### innerWidth + +• **innerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 + +### isSecureContext + +• **isSecureContext**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 + +### length + +• **length**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 + +### localStorage + +• **localStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 + +### location + +• **location**: _Location_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 + +### locationbar + +• **locationbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 + +### menubar + +• **menubar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 + +### msContentScript + +• **msContentScript**: _ExtensionScriptApis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 + +### name + +• **name**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 + +### navigator + +• **navigator**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 + +### offscreenBuffering + +• **offscreenBuffering**: _string \| boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 + +### onabort + +• **onabort**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 + +Fires when the user aborts the download. + +**`param`** The event. + +### onafterprint + +• **onafterprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 + +### onanimationcancel + +• **onanimationcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 + +### onanimationend + +• **onanimationend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 + +### onanimationiteration + +• **onanimationiteration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 + +### onanimationstart + +• **onanimationstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 + +### onauxclick + +• **onauxclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 + +### onbeforeprint + +• **onbeforeprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 + +### onbeforeunload + +• **onbeforeunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 + +### onblur + +• **onblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 + +Fires when the object loses the input focus. + +**`param`** The focus event. + +### oncancel + +• **oncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 + +### oncanplay + +• **oncanplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 + +Occurs when playback is possible, but would require further buffering. + +**`param`** The event. + +### oncanplaythrough + +• **oncanplaythrough**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 + +### onchange + +• **onchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 + +Fires when the contents of the object or selection have changed. + +**`param`** The event. + +### onclick + +• **onclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 + +Fires when the user clicks the left mouse button on the object + +**`param`** The mouse event. + +### onclose + +• **onclose**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 + +### oncompassneedscalibration + +• **oncompassneedscalibration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 + +### oncontextmenu + +• **oncontextmenu**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 + +Fires when the user clicks the right mouse button in the client area, opening the context menu. + +**`param`** The mouse event. + +### oncuechange + +• **oncuechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 + +### ondblclick + +• **ondblclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 + +Fires when the user double-clicks the object. + +**`param`** The mouse event. + +### ondevicelight + +• **ondevicelight**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 + +### ondevicemotion + +• **ondevicemotion**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 + +### ondeviceorientation + +• **ondeviceorientation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 + +### ondrag + +• **ondrag**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 + +Fires on the source object continuously during a drag operation. + +**`param`** The event. + +### ondragend + +• **ondragend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 + +Fires on the source object when the user releases the mouse at the close of a drag operation. + +**`param`** The event. + +### ondragenter + +• **ondragenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 + +Fires on the target element when the user drags the object to a valid drop target. + +**`param`** The drag event. + +### ondragexit + +• **ondragexit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 + +### ondragleave + +• **ondragleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 + +Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. + +**`param`** The drag event. + +### ondragover + +• **ondragover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 + +Fires on the target element continuously while the user drags the object over a valid drop target. + +**`param`** The event. + +### ondragstart + +• **ondragstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 + +Fires on the source object when the user starts to drag a text selection or selected object. + +**`param`** The event. + +### ondrop + +• **ondrop**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 + +### ondurationchange + +• **ondurationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 + +Occurs when the duration attribute is updated. + +**`param`** The event. + +### onemptied + +• **onemptied**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 + +Occurs when the media element is reset to its initial state. + +**`param`** The event. + +### onended + +• **onended**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 + +Occurs when the end of playback is reached. + +**`param`** The event + +### onerror + +• **onerror**: _ErrorEventHandler_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 + +Fires when an error occurs during object loading. + +**`param`** The event. + +### onfocus + +• **onfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 + +Fires when the object receives focus. + +**`param`** The event. + +### ongotpointercapture + +• **ongotpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 + +### onhashchange + +• **onhashchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 + +### oninput + +• **oninput**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 + +### oninvalid + +• **oninvalid**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 + +### onkeydown + +• **onkeydown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 + +Fires when the user presses a key. + +**`param`** The keyboard event + +### onkeypress + +• **onkeypress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 + +Fires when the user presses an alphanumeric key. + +**`param`** The event. + +### onkeyup + +• **onkeyup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 + +Fires when the user releases a key. + +**`param`** The keyboard event + +### onlanguagechange + +• **onlanguagechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 + +### onload + +• **onload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 + +Fires immediately after the browser loads the object. + +**`param`** The event. + +### onloadeddata + +• **onloadeddata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 + +Occurs when media data is loaded at the current playback position. + +**`param`** The event. + +### onloadedmetadata + +• **onloadedmetadata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 + +Occurs when the duration and dimensions of the media have been determined. + +**`param`** The event. + +### onloadend + +• **onloadend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 + +### onloadstart + +• **onloadstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 + +Occurs when Internet Explorer begins looking for media data. + +**`param`** The event. + +### onlostpointercapture + +• **onlostpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 + +### onmessage + +• **onmessage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 + +### onmessageerror + +• **onmessageerror**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 + +### onmousedown + +• **onmousedown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 + +Fires when the user clicks the object with either mouse button. + +**`param`** The mouse event. + +### onmouseenter + +• **onmouseenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 + +### onmouseleave + +• **onmouseleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 + +### onmousemove + +• **onmousemove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 + +Fires when the user moves the mouse over the object. + +**`param`** The mouse event. + +### onmouseout + +• **onmouseout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 + +Fires when the user moves the mouse pointer outside the boundaries of the object. + +**`param`** The mouse event. + +### onmouseover + +• **onmouseover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 + +Fires when the user moves the mouse pointer into the object. + +**`param`** The mouse event. + +### onmouseup + +• **onmouseup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 + +Fires when the user releases a mouse button while the mouse is over the object. + +**`param`** The mouse event. + +### onmousewheel + +• **onmousewheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 + +### onmsgesturechange + +• **onmsgesturechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 + +### onmsgesturedoubletap + +• **onmsgesturedoubletap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 + +### onmsgestureend + +• **onmsgestureend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 + +### onmsgesturehold + +• **onmsgesturehold**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 + +### onmsgesturestart + +• **onmsgesturestart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 + +### onmsgesturetap + +• **onmsgesturetap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 + +### onmsinertiastart + +• **onmsinertiastart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 + +### onmspointercancel + +• **onmspointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 + +### onmspointerdown + +• **onmspointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 + +### onmspointerenter + +• **onmspointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 + +### onmspointerleave + +• **onmspointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 + +### onmspointermove + +• **onmspointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 + +### onmspointerout + +• **onmspointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 + +### onmspointerover + +• **onmspointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 + +### onmspointerup + +• **onmspointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 + +### onoffline + +• **onoffline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 + +### ononline + +• **ononline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 + +### onorientationchange + +• **onorientationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 + +**`deprecated`** + +### onpagehide + +• **onpagehide**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 + +### onpageshow + +• **onpageshow**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 + +### onpause + +• **onpause**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 + +Occurs when playback is paused. + +**`param`** The event. + +### onplay + +• **onplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 + +Occurs when the play method is requested. + +**`param`** The event. + +### onplaying + +• **onplaying**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 + +Occurs when the audio or video has started playing. + +**`param`** The event. + +### onpointercancel + +• **onpointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 + +### onpointerdown + +• **onpointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 + +### onpointerenter + +• **onpointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 + +### onpointerleave + +• **onpointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 + +### onpointermove + +• **onpointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 + +### onpointerout + +• **onpointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 + +### onpointerover + +• **onpointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 + +### onpointerup + +• **onpointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 + +### onpopstate + +• **onpopstate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 + +### onprogress + +• **onprogress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 + +Occurs to indicate progress while downloading media data. + +**`param`** The event. + +### onratechange + +• **onratechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 + +Occurs when the playback rate is increased or decreased. + +**`param`** The event. + +### onreadystatechange + +• **onreadystatechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 + +### onrejectionhandled + +• **onrejectionhandled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 + +### onreset + +• **onreset**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 + +Fires when the user resets a form. + +**`param`** The event. + +### onresize + +• **onresize**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 + +### onscroll + +• **onscroll**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 + +Fires when the user repositions the scroll box in the scroll bar on the object. + +**`param`** The event. + +### onsecuritypolicyviolation + +• **onsecuritypolicyviolation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 + +### onseeked + +• **onseeked**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 + +Occurs when the seek operation ends. + +**`param`** The event. + +### onseeking + +• **onseeking**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 + +Occurs when the current playback position is moved. + +**`param`** The event. + +### onselect + +• **onselect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 + +Fires when the current selection changes. + +**`param`** The event. + +### onstalled + +• **onstalled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 + +Occurs when the download has stopped. + +**`param`** The event. + +### onstorage + +• **onstorage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 + +### onsubmit + +• **onsubmit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 + +### onsuspend + +• **onsuspend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 + +Occurs if the load operation has been intentionally halted. + +**`param`** The event. + +### ontimeupdate + +• **ontimeupdate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 + +Occurs to indicate the current playback position. + +**`param`** The event. + +### ontoggle + +• **ontoggle**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 + +### ontouchcancel + +• **ontouchcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 + +### ontouchend + +• **ontouchend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 + +### ontouchmove + +• **ontouchmove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 + +### ontouchstart + +• **ontouchstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 + +### ontransitioncancel + +• **ontransitioncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 + +### ontransitionend + +• **ontransitionend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 + +### ontransitionrun + +• **ontransitionrun**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 + +### ontransitionstart + +• **ontransitionstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 + +### onunhandledrejection + +• **onunhandledrejection**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 + +### onunload + +• **onunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 + +### onvolumechange + +• **onvolumechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 + +Occurs when the volume is changed, or playback is muted or unmuted. + +**`param`** The event. + +### onvrdisplayactivate + +• **onvrdisplayactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 + +### onvrdisplayblur + +• **onvrdisplayblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 + +### onvrdisplayconnect + +• **onvrdisplayconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 + +### onvrdisplaydeactivate + +• **onvrdisplaydeactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 + +### onvrdisplaydisconnect + +• **onvrdisplaydisconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 + +### onvrdisplayfocus + +• **onvrdisplayfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 + +### onvrdisplaypointerrestricted + +• **onvrdisplaypointerrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 + +### onvrdisplaypointerunrestricted + +• **onvrdisplaypointerunrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 + +### onvrdisplaypresentchange + +• **onvrdisplaypresentchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 + +### onwaiting + +• **onwaiting**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 + +Occurs when playback stops because the next frame of a video resource is not available. + +**`param`** The event. + +### onwheel + +• **onwheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 + +### opener + +• **opener**: _any_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 + +### orientation + +• **orientation**: _string \| number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 + +**`deprecated`** + +### origin + +• **origin**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 + +### outerHeight + +• **outerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 + +### outerWidth + +• **outerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 + +### pageXOffset + +• **pageXOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 + +### pageYOffset + +• **pageYOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 + +### parent + +• **parent**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 + +### performance + +• **performance**: _Performance_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 + +### personalbar + +• **personalbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 + +### screen + +• **screen**: _Screen_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 + +### screenLeft + +• **screenLeft**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 + +### screenTop + +• **screenTop**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 + +### screenX + +• **screenX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 + +### screenY + +• **screenY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 + +### scrollX + +• **scrollX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 + +### scrollY + +• **scrollY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 + +### scrollbars + +• **scrollbars**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 + +### self + +• **self**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 + +### sessionStorage + +• **sessionStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 + +### speechSynthesis + +• **speechSynthesis**: _SpeechSynthesis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 + +### status + +• **status**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 + +### statusbar + +• **statusbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 + +### styleMedia + +• **styleMedia**: _StyleMedia_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 + +### toolbar + +• **toolbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 + +### top + +• **top**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 + +### `Optional` web3 + +• **web3**? : [_InjectedWeb3_](../interfaces/_browserutils_.injectedweb3.md) + +_Inherited from_ [_ExtendedWindow_](../interfaces/_browserutils_.extendedwindow.md)_._[_web3_](../interfaces/_browserutils_.extendedwindow.md#optional-web3) + +_Defined in_ [_src/browserUtils.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32) + +### window + +• **window**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 + +## Methods + +### addEventListener + +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ + +**Returns:** _void_ + +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | + +**Returns:** _void_ + +### alert + +▸ **alert**\(`message?`: any\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | any | + +**Returns:** _void_ + +### atob + +▸ **atob**\(`encodedString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `encodedString` | string | + +**Returns:** _string_ + +### blur + +▸ **blur**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 + +**Returns:** _void_ + +### btoa + +▸ **btoa**\(`rawString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `rawString` | string | + +**Returns:** _string_ + +### cancelAnimationFrame + +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### captureEvents + +▸ **captureEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 + +**`deprecated`** + +**Returns:** _void_ + +### clearInterval + +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### clearTimeout + +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### close + +▸ **close**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 + +**Returns:** _void_ + +### confirm + +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | + +**Returns:** _boolean_ + +### createImageBitmap + +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | + +**Returns:** _Promise‹ImageBitmap›_ + +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | + +**Returns:** _Promise‹ImageBitmap›_ + +### departFocus + +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | + +**Returns:** _void_ + +### dispatchEvent + +▸ **dispatchEvent**\(`event`: Event\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 + +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `event` | Event | + +**Returns:** _boolean_ + +### fetch + +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | + +**Returns:** _Promise‹Response›_ + +### focus + +▸ **focus**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 + +**Returns:** _void_ + +### getComputedStyle + +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSStyleDeclaration_ + +### getMatchedCSSRules + +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSRuleList_ + +### getSelection + +▸ **getSelection**\(\): _Selection_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 + +**Returns:** _Selection_ + +### matchMedia + +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `query` | string | + +**Returns:** _MediaQueryList_ + +### moveBy + +▸ **moveBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### moveTo + +▸ **moveTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### msWriteProfilerMark + +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | + +**Returns:** _void_ + +### open + +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | + +**Returns:** _Window \| null_ + +### postMessage + +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | + +**Returns:** _void_ + +### print + +▸ **print**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 + +**Returns:** _void_ + +### prompt + +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | + +**Returns:** _string \| null_ + +### queueMicrotask + +▸ **queueMicrotask**\(`callback`: Function\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | Function | + +**Returns:** _void_ + +### releaseEvents + +▸ **releaseEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 + +**`deprecated`** + +**Returns:** _void_ + +### removeEventListener + +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| EventListenerOptions_ + +**Returns:** _void_ + +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | + +**Returns:** _void_ + +### requestAnimationFrame + +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + +### resizeBy + +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### resizeTo + +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scroll + +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scroll**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollBy + +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollTo + +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### setInterval + +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### setTimeout + +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### stop + +▸ **stop**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 + +**Returns:** _void_ + +### webkitCancelAnimationFrame + +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### webkitConvertPointFromNodeToPage + +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitConvertPointFromPageToNode + +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitRequestAnimationFrame + +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + diff --git a/docs/api/external-modules/_browserutils_.windowwithweb3.md b/docs/api/external-modules/_browserutils_.windowwithweb3.md new file mode 100644 index 0000000..aaa6fc8 --- /dev/null +++ b/docs/api/external-modules/_browserutils_.windowwithweb3.md @@ -0,0 +1,2807 @@ +# WindowWithWeb3 + +## Hierarchy + +↳ [ExtendedWindow](../interfaces/_browserutils_.extendedwindow.md) + +↳ **WindowWithWeb3** + +## Index + +### Properties + +* [Blob](../interfaces/_browserutils_.windowwithweb3.md#blob) +* [URL](../interfaces/_browserutils_.windowwithweb3.md#url) +* [URLSearchParams](../interfaces/_browserutils_.windowwithweb3.md#urlsearchparams) +* [applicationCache](../interfaces/_browserutils_.windowwithweb3.md#applicationcache) +* [caches](../interfaces/_browserutils_.windowwithweb3.md#caches) +* [clientInformation](../interfaces/_browserutils_.windowwithweb3.md#clientinformation) +* [closed](../interfaces/_browserutils_.windowwithweb3.md#closed) +* [console](../interfaces/_browserutils_.windowwithweb3.md#console) +* [crypto](../interfaces/_browserutils_.windowwithweb3.md#crypto) +* [customElements](../interfaces/_browserutils_.windowwithweb3.md#customelements) +* [defaultStatus](../interfaces/_browserutils_.windowwithweb3.md#defaultstatus) +* [devicePixelRatio](../interfaces/_browserutils_.windowwithweb3.md#devicepixelratio) +* [doNotTrack](../interfaces/_browserutils_.windowwithweb3.md#donottrack) +* [document](../interfaces/_browserutils_.windowwithweb3.md#document) +* [ethereum](../interfaces/_browserutils_.windowwithweb3.md#optional-ethereum) +* [event](../interfaces/_browserutils_.windowwithweb3.md#event) +* [external](../interfaces/_browserutils_.windowwithweb3.md#external) +* [frameElement](../interfaces/_browserutils_.windowwithweb3.md#frameelement) +* [frames](../interfaces/_browserutils_.windowwithweb3.md#frames) +* [history](../interfaces/_browserutils_.windowwithweb3.md#history) +* [indexedDB](../interfaces/_browserutils_.windowwithweb3.md#indexeddb) +* [innerHeight](../interfaces/_browserutils_.windowwithweb3.md#innerheight) +* [innerWidth](../interfaces/_browserutils_.windowwithweb3.md#innerwidth) +* [isSecureContext](../interfaces/_browserutils_.windowwithweb3.md#issecurecontext) +* [length](../interfaces/_browserutils_.windowwithweb3.md#length) +* [localStorage](../interfaces/_browserutils_.windowwithweb3.md#localstorage) +* [location](../interfaces/_browserutils_.windowwithweb3.md#location) +* [locationbar](../interfaces/_browserutils_.windowwithweb3.md#locationbar) +* [menubar](../interfaces/_browserutils_.windowwithweb3.md#menubar) +* [msContentScript](../interfaces/_browserutils_.windowwithweb3.md#mscontentscript) +* [name](../interfaces/_browserutils_.windowwithweb3.md#name) +* [navigator](../interfaces/_browserutils_.windowwithweb3.md#navigator) +* [offscreenBuffering](../interfaces/_browserutils_.windowwithweb3.md#offscreenbuffering) +* [onabort](../interfaces/_browserutils_.windowwithweb3.md#onabort) +* [onafterprint](../interfaces/_browserutils_.windowwithweb3.md#onafterprint) +* [onanimationcancel](../interfaces/_browserutils_.windowwithweb3.md#onanimationcancel) +* [onanimationend](../interfaces/_browserutils_.windowwithweb3.md#onanimationend) +* [onanimationiteration](../interfaces/_browserutils_.windowwithweb3.md#onanimationiteration) +* [onanimationstart](../interfaces/_browserutils_.windowwithweb3.md#onanimationstart) +* [onauxclick](../interfaces/_browserutils_.windowwithweb3.md#onauxclick) +* [onbeforeprint](../interfaces/_browserutils_.windowwithweb3.md#onbeforeprint) +* [onbeforeunload](../interfaces/_browserutils_.windowwithweb3.md#onbeforeunload) +* [onblur](../interfaces/_browserutils_.windowwithweb3.md#onblur) +* [oncancel](../interfaces/_browserutils_.windowwithweb3.md#oncancel) +* [oncanplay](../interfaces/_browserutils_.windowwithweb3.md#oncanplay) +* [oncanplaythrough](../interfaces/_browserutils_.windowwithweb3.md#oncanplaythrough) +* [onchange](../interfaces/_browserutils_.windowwithweb3.md#onchange) +* [onclick](../interfaces/_browserutils_.windowwithweb3.md#onclick) +* [onclose](../interfaces/_browserutils_.windowwithweb3.md#onclose) +* [oncompassneedscalibration](../interfaces/_browserutils_.windowwithweb3.md#oncompassneedscalibration) +* [oncontextmenu](../interfaces/_browserutils_.windowwithweb3.md#oncontextmenu) +* [oncuechange](../interfaces/_browserutils_.windowwithweb3.md#oncuechange) +* [ondblclick](../interfaces/_browserutils_.windowwithweb3.md#ondblclick) +* [ondevicelight](../interfaces/_browserutils_.windowwithweb3.md#ondevicelight) +* [ondevicemotion](../interfaces/_browserutils_.windowwithweb3.md#ondevicemotion) +* [ondeviceorientation](../interfaces/_browserutils_.windowwithweb3.md#ondeviceorientation) +* [ondrag](../interfaces/_browserutils_.windowwithweb3.md#ondrag) +* [ondragend](../interfaces/_browserutils_.windowwithweb3.md#ondragend) +* [ondragenter](../interfaces/_browserutils_.windowwithweb3.md#ondragenter) +* [ondragexit](../interfaces/_browserutils_.windowwithweb3.md#ondragexit) +* [ondragleave](../interfaces/_browserutils_.windowwithweb3.md#ondragleave) +* [ondragover](../interfaces/_browserutils_.windowwithweb3.md#ondragover) +* [ondragstart](../interfaces/_browserutils_.windowwithweb3.md#ondragstart) +* [ondrop](../interfaces/_browserutils_.windowwithweb3.md#ondrop) +* [ondurationchange](../interfaces/_browserutils_.windowwithweb3.md#ondurationchange) +* [onemptied](../interfaces/_browserutils_.windowwithweb3.md#onemptied) +* [onended](../interfaces/_browserutils_.windowwithweb3.md#onended) +* [onerror](../interfaces/_browserutils_.windowwithweb3.md#onerror) +* [onfocus](../interfaces/_browserutils_.windowwithweb3.md#onfocus) +* [ongotpointercapture](../interfaces/_browserutils_.windowwithweb3.md#ongotpointercapture) +* [onhashchange](../interfaces/_browserutils_.windowwithweb3.md#onhashchange) +* [oninput](../interfaces/_browserutils_.windowwithweb3.md#oninput) +* [oninvalid](../interfaces/_browserutils_.windowwithweb3.md#oninvalid) +* [onkeydown](../interfaces/_browserutils_.windowwithweb3.md#onkeydown) +* [onkeypress](../interfaces/_browserutils_.windowwithweb3.md#onkeypress) +* [onkeyup](../interfaces/_browserutils_.windowwithweb3.md#onkeyup) +* [onlanguagechange](../interfaces/_browserutils_.windowwithweb3.md#onlanguagechange) +* [onload](../interfaces/_browserutils_.windowwithweb3.md#onload) +* [onloadeddata](../interfaces/_browserutils_.windowwithweb3.md#onloadeddata) +* [onloadedmetadata](../interfaces/_browserutils_.windowwithweb3.md#onloadedmetadata) +* [onloadend](../interfaces/_browserutils_.windowwithweb3.md#onloadend) +* [onloadstart](../interfaces/_browserutils_.windowwithweb3.md#onloadstart) +* [onlostpointercapture](../interfaces/_browserutils_.windowwithweb3.md#onlostpointercapture) +* [onmessage](../interfaces/_browserutils_.windowwithweb3.md#onmessage) +* [onmessageerror](../interfaces/_browserutils_.windowwithweb3.md#onmessageerror) +* [onmousedown](../interfaces/_browserutils_.windowwithweb3.md#onmousedown) +* [onmouseenter](../interfaces/_browserutils_.windowwithweb3.md#onmouseenter) +* [onmouseleave](../interfaces/_browserutils_.windowwithweb3.md#onmouseleave) +* [onmousemove](../interfaces/_browserutils_.windowwithweb3.md#onmousemove) +* [onmouseout](../interfaces/_browserutils_.windowwithweb3.md#onmouseout) +* [onmouseover](../interfaces/_browserutils_.windowwithweb3.md#onmouseover) +* [onmouseup](../interfaces/_browserutils_.windowwithweb3.md#onmouseup) +* [onmousewheel](../interfaces/_browserutils_.windowwithweb3.md#onmousewheel) +* [onmsgesturechange](../interfaces/_browserutils_.windowwithweb3.md#onmsgesturechange) +* [onmsgesturedoubletap](../interfaces/_browserutils_.windowwithweb3.md#onmsgesturedoubletap) +* [onmsgestureend](../interfaces/_browserutils_.windowwithweb3.md#onmsgestureend) +* [onmsgesturehold](../interfaces/_browserutils_.windowwithweb3.md#onmsgesturehold) +* [onmsgesturestart](../interfaces/_browserutils_.windowwithweb3.md#onmsgesturestart) +* [onmsgesturetap](../interfaces/_browserutils_.windowwithweb3.md#onmsgesturetap) +* [onmsinertiastart](../interfaces/_browserutils_.windowwithweb3.md#onmsinertiastart) +* [onmspointercancel](../interfaces/_browserutils_.windowwithweb3.md#onmspointercancel) +* [onmspointerdown](../interfaces/_browserutils_.windowwithweb3.md#onmspointerdown) +* [onmspointerenter](../interfaces/_browserutils_.windowwithweb3.md#onmspointerenter) +* [onmspointerleave](../interfaces/_browserutils_.windowwithweb3.md#onmspointerleave) +* [onmspointermove](../interfaces/_browserutils_.windowwithweb3.md#onmspointermove) +* [onmspointerout](../interfaces/_browserutils_.windowwithweb3.md#onmspointerout) +* [onmspointerover](../interfaces/_browserutils_.windowwithweb3.md#onmspointerover) +* [onmspointerup](../interfaces/_browserutils_.windowwithweb3.md#onmspointerup) +* [onoffline](../interfaces/_browserutils_.windowwithweb3.md#onoffline) +* [ononline](../interfaces/_browserutils_.windowwithweb3.md#ononline) +* [onorientationchange](../interfaces/_browserutils_.windowwithweb3.md#onorientationchange) +* [onpagehide](../interfaces/_browserutils_.windowwithweb3.md#onpagehide) +* [onpageshow](../interfaces/_browserutils_.windowwithweb3.md#onpageshow) +* [onpause](../interfaces/_browserutils_.windowwithweb3.md#onpause) +* [onplay](../interfaces/_browserutils_.windowwithweb3.md#onplay) +* [onplaying](../interfaces/_browserutils_.windowwithweb3.md#onplaying) +* [onpointercancel](../interfaces/_browserutils_.windowwithweb3.md#onpointercancel) +* [onpointerdown](../interfaces/_browserutils_.windowwithweb3.md#onpointerdown) +* [onpointerenter](../interfaces/_browserutils_.windowwithweb3.md#onpointerenter) +* [onpointerleave](../interfaces/_browserutils_.windowwithweb3.md#onpointerleave) +* [onpointermove](../interfaces/_browserutils_.windowwithweb3.md#onpointermove) +* [onpointerout](../interfaces/_browserutils_.windowwithweb3.md#onpointerout) +* [onpointerover](../interfaces/_browserutils_.windowwithweb3.md#onpointerover) +* [onpointerup](../interfaces/_browserutils_.windowwithweb3.md#onpointerup) +* [onpopstate](../interfaces/_browserutils_.windowwithweb3.md#onpopstate) +* [onprogress](../interfaces/_browserutils_.windowwithweb3.md#onprogress) +* [onratechange](../interfaces/_browserutils_.windowwithweb3.md#onratechange) +* [onreadystatechange](../interfaces/_browserutils_.windowwithweb3.md#onreadystatechange) +* [onrejectionhandled](../interfaces/_browserutils_.windowwithweb3.md#onrejectionhandled) +* [onreset](../interfaces/_browserutils_.windowwithweb3.md#onreset) +* [onresize](../interfaces/_browserutils_.windowwithweb3.md#onresize) +* [onscroll](../interfaces/_browserutils_.windowwithweb3.md#onscroll) +* [onsecuritypolicyviolation](../interfaces/_browserutils_.windowwithweb3.md#onsecuritypolicyviolation) +* [onseeked](../interfaces/_browserutils_.windowwithweb3.md#onseeked) +* [onseeking](../interfaces/_browserutils_.windowwithweb3.md#onseeking) +* [onselect](../interfaces/_browserutils_.windowwithweb3.md#onselect) +* [onstalled](../interfaces/_browserutils_.windowwithweb3.md#onstalled) +* [onstorage](../interfaces/_browserutils_.windowwithweb3.md#onstorage) +* [onsubmit](../interfaces/_browserutils_.windowwithweb3.md#onsubmit) +* [onsuspend](../interfaces/_browserutils_.windowwithweb3.md#onsuspend) +* [ontimeupdate](../interfaces/_browserutils_.windowwithweb3.md#ontimeupdate) +* [ontoggle](../interfaces/_browserutils_.windowwithweb3.md#ontoggle) +* [ontouchcancel](../interfaces/_browserutils_.windowwithweb3.md#ontouchcancel) +* [ontouchend](../interfaces/_browserutils_.windowwithweb3.md#ontouchend) +* [ontouchmove](../interfaces/_browserutils_.windowwithweb3.md#ontouchmove) +* [ontouchstart](../interfaces/_browserutils_.windowwithweb3.md#ontouchstart) +* [ontransitioncancel](../interfaces/_browserutils_.windowwithweb3.md#ontransitioncancel) +* [ontransitionend](../interfaces/_browserutils_.windowwithweb3.md#ontransitionend) +* [ontransitionrun](../interfaces/_browserutils_.windowwithweb3.md#ontransitionrun) +* [ontransitionstart](../interfaces/_browserutils_.windowwithweb3.md#ontransitionstart) +* [onunhandledrejection](../interfaces/_browserutils_.windowwithweb3.md#onunhandledrejection) +* [onunload](../interfaces/_browserutils_.windowwithweb3.md#onunload) +* [onvolumechange](../interfaces/_browserutils_.windowwithweb3.md#onvolumechange) +* [onvrdisplayactivate](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplayactivate) +* [onvrdisplayblur](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplayblur) +* [onvrdisplayconnect](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplayconnect) +* [onvrdisplaydeactivate](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplaydeactivate) +* [onvrdisplaydisconnect](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplaydisconnect) +* [onvrdisplayfocus](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplayfocus) +* [onvrdisplaypointerrestricted](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplaypointerrestricted) +* [onvrdisplaypointerunrestricted](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplaypointerunrestricted) +* [onvrdisplaypresentchange](../interfaces/_browserutils_.windowwithweb3.md#onvrdisplaypresentchange) +* [onwaiting](../interfaces/_browserutils_.windowwithweb3.md#onwaiting) +* [onwheel](../interfaces/_browserutils_.windowwithweb3.md#onwheel) +* [opener](../interfaces/_browserutils_.windowwithweb3.md#opener) +* [orientation](../interfaces/_browserutils_.windowwithweb3.md#orientation) +* [origin](../interfaces/_browserutils_.windowwithweb3.md#origin) +* [outerHeight](../interfaces/_browserutils_.windowwithweb3.md#outerheight) +* [outerWidth](../interfaces/_browserutils_.windowwithweb3.md#outerwidth) +* [pageXOffset](../interfaces/_browserutils_.windowwithweb3.md#pagexoffset) +* [pageYOffset](../interfaces/_browserutils_.windowwithweb3.md#pageyoffset) +* [parent](../interfaces/_browserutils_.windowwithweb3.md#parent) +* [performance](../interfaces/_browserutils_.windowwithweb3.md#performance) +* [personalbar](../interfaces/_browserutils_.windowwithweb3.md#personalbar) +* [screen](../interfaces/_browserutils_.windowwithweb3.md#screen) +* [screenLeft](../interfaces/_browserutils_.windowwithweb3.md#screenleft) +* [screenTop](../interfaces/_browserutils_.windowwithweb3.md#screentop) +* [screenX](../interfaces/_browserutils_.windowwithweb3.md#screenx) +* [screenY](../interfaces/_browserutils_.windowwithweb3.md#screeny) +* [scrollX](../interfaces/_browserutils_.windowwithweb3.md#scrollx) +* [scrollY](../interfaces/_browserutils_.windowwithweb3.md#scrolly) +* [scrollbars](../interfaces/_browserutils_.windowwithweb3.md#scrollbars) +* [self](../interfaces/_browserutils_.windowwithweb3.md#self) +* [sessionStorage](../interfaces/_browserutils_.windowwithweb3.md#sessionstorage) +* [speechSynthesis](../interfaces/_browserutils_.windowwithweb3.md#speechsynthesis) +* [status](../interfaces/_browserutils_.windowwithweb3.md#status) +* [statusbar](../interfaces/_browserutils_.windowwithweb3.md#statusbar) +* [styleMedia](../interfaces/_browserutils_.windowwithweb3.md#stylemedia) +* [toolbar](../interfaces/_browserutils_.windowwithweb3.md#toolbar) +* [top](../interfaces/_browserutils_.windowwithweb3.md#top) +* [web3](../interfaces/_browserutils_.windowwithweb3.md#web3) +* [window](../interfaces/_browserutils_.windowwithweb3.md#window) + +### Methods + +* [addEventListener](../interfaces/_browserutils_.windowwithweb3.md#addeventlistener) +* [alert](../interfaces/_browserutils_.windowwithweb3.md#alert) +* [atob](../interfaces/_browserutils_.windowwithweb3.md#atob) +* [blur](../interfaces/_browserutils_.windowwithweb3.md#blur) +* [btoa](../interfaces/_browserutils_.windowwithweb3.md#btoa) +* [cancelAnimationFrame](../interfaces/_browserutils_.windowwithweb3.md#cancelanimationframe) +* [captureEvents](../interfaces/_browserutils_.windowwithweb3.md#captureevents) +* [clearInterval](../interfaces/_browserutils_.windowwithweb3.md#clearinterval) +* [clearTimeout](../interfaces/_browserutils_.windowwithweb3.md#cleartimeout) +* [close](../interfaces/_browserutils_.windowwithweb3.md#close) +* [confirm](../interfaces/_browserutils_.windowwithweb3.md#confirm) +* [createImageBitmap](../interfaces/_browserutils_.windowwithweb3.md#createimagebitmap) +* [departFocus](../interfaces/_browserutils_.windowwithweb3.md#departfocus) +* [dispatchEvent](../interfaces/_browserutils_.windowwithweb3.md#dispatchevent) +* [fetch](../interfaces/_browserutils_.windowwithweb3.md#fetch) +* [focus](../interfaces/_browserutils_.windowwithweb3.md#focus) +* [getComputedStyle](../interfaces/_browserutils_.windowwithweb3.md#getcomputedstyle) +* [getMatchedCSSRules](../interfaces/_browserutils_.windowwithweb3.md#getmatchedcssrules) +* [getSelection](../interfaces/_browserutils_.windowwithweb3.md#getselection) +* [matchMedia](../interfaces/_browserutils_.windowwithweb3.md#matchmedia) +* [moveBy](../interfaces/_browserutils_.windowwithweb3.md#moveby) +* [moveTo](../interfaces/_browserutils_.windowwithweb3.md#moveto) +* [msWriteProfilerMark](../interfaces/_browserutils_.windowwithweb3.md#mswriteprofilermark) +* [open](../interfaces/_browserutils_.windowwithweb3.md#open) +* [postMessage](../interfaces/_browserutils_.windowwithweb3.md#postmessage) +* [print](../interfaces/_browserutils_.windowwithweb3.md#print) +* [prompt](../interfaces/_browserutils_.windowwithweb3.md#prompt) +* [queueMicrotask](../interfaces/_browserutils_.windowwithweb3.md#queuemicrotask) +* [releaseEvents](../interfaces/_browserutils_.windowwithweb3.md#releaseevents) +* [removeEventListener](../interfaces/_browserutils_.windowwithweb3.md#removeeventlistener) +* [requestAnimationFrame](../interfaces/_browserutils_.windowwithweb3.md#requestanimationframe) +* [resizeBy](../interfaces/_browserutils_.windowwithweb3.md#resizeby) +* [resizeTo](../interfaces/_browserutils_.windowwithweb3.md#resizeto) +* [scroll](../interfaces/_browserutils_.windowwithweb3.md#scroll) +* [scrollBy](../interfaces/_browserutils_.windowwithweb3.md#scrollby) +* [scrollTo](../interfaces/_browserutils_.windowwithweb3.md#scrollto) +* [setInterval](../interfaces/_browserutils_.windowwithweb3.md#setinterval) +* [setTimeout](../interfaces/_browserutils_.windowwithweb3.md#settimeout) +* [stop](../interfaces/_browserutils_.windowwithweb3.md#stop) +* [webkitCancelAnimationFrame](../interfaces/_browserutils_.windowwithweb3.md#webkitcancelanimationframe) +* [webkitConvertPointFromNodeToPage](../interfaces/_browserutils_.windowwithweb3.md#webkitconvertpointfromnodetopage) +* [webkitConvertPointFromPageToNode](../interfaces/_browserutils_.windowwithweb3.md#webkitconvertpointfrompagetonode) +* [webkitRequestAnimationFrame](../interfaces/_browserutils_.windowwithweb3.md#webkitrequestanimationframe) + +## Properties + +### Blob + +• **Blob**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 + +#### Type declaration: + +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ + +### URL + +• **URL**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 + +#### Type declaration: + +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ + +### URLSearchParams + +• **URLSearchParams**: _object_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 + +#### Type declaration: + +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ + +### applicationCache + +• **applicationCache**: _ApplicationCache_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 + +### caches + +• **caches**: _CacheStorage_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 + +### clientInformation + +• **clientInformation**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 + +### closed + +• **closed**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 + +### console + +• **console**: _Console_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 + +### crypto + +• **crypto**: _Crypto_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 + +### customElements + +• **customElements**: _CustomElementRegistry_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 + +### defaultStatus + +• **defaultStatus**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 + +### devicePixelRatio + +• **devicePixelRatio**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 + +### doNotTrack + +• **doNotTrack**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 + +### document + +• **document**: _Document_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 + +### `Optional` ethereum + +• **ethereum**? : [_Ethereum_](../interfaces/_browserutils_.ethereum.md) + +_Inherited from_ [_ExtendedWindow_](../interfaces/_browserutils_.extendedwindow.md)_._[_ethereum_](../interfaces/_browserutils_.extendedwindow.md#optional-ethereum) + +_Defined in_ [_src/browserUtils.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31) + +### event + +• **event**: _Event \| undefined_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 + +### external + +• **external**: _External_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 + +**`deprecated`** + +### frameElement + +• **frameElement**: _Element_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 + +### frames + +• **frames**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 + +### history + +• **history**: _History_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 + +### indexedDB + +• **indexedDB**: _IDBFactory_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 + +### innerHeight + +• **innerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 + +### innerWidth + +• **innerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 + +### isSecureContext + +• **isSecureContext**: _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 + +### length + +• **length**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 + +### localStorage + +• **localStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 + +### location + +• **location**: _Location_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 + +### locationbar + +• **locationbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 + +### menubar + +• **menubar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 + +### msContentScript + +• **msContentScript**: _ExtensionScriptApis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 + +### name + +• **name**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 + +### navigator + +• **navigator**: _Navigator_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 + +### offscreenBuffering + +• **offscreenBuffering**: _string \| boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 + +### onabort + +• **onabort**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 + +Fires when the user aborts the download. + +**`param`** The event. + +### onafterprint + +• **onafterprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 + +### onanimationcancel + +• **onanimationcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 + +### onanimationend + +• **onanimationend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 + +### onanimationiteration + +• **onanimationiteration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 + +### onanimationstart + +• **onanimationstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 + +### onauxclick + +• **onauxclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 + +### onbeforeprint + +• **onbeforeprint**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 + +### onbeforeunload + +• **onbeforeunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 + +### onblur + +• **onblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 + +Fires when the object loses the input focus. + +**`param`** The focus event. + +### oncancel + +• **oncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 + +### oncanplay + +• **oncanplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 + +Occurs when playback is possible, but would require further buffering. + +**`param`** The event. + +### oncanplaythrough + +• **oncanplaythrough**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 + +### onchange + +• **onchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 + +Fires when the contents of the object or selection have changed. + +**`param`** The event. + +### onclick + +• **onclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 + +Fires when the user clicks the left mouse button on the object + +**`param`** The mouse event. + +### onclose + +• **onclose**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 + +### oncompassneedscalibration + +• **oncompassneedscalibration**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 + +### oncontextmenu + +• **oncontextmenu**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 + +Fires when the user clicks the right mouse button in the client area, opening the context menu. + +**`param`** The mouse event. + +### oncuechange + +• **oncuechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 + +### ondblclick + +• **ondblclick**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 + +Fires when the user double-clicks the object. + +**`param`** The mouse event. + +### ondevicelight + +• **ondevicelight**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 + +### ondevicemotion + +• **ondevicemotion**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 + +### ondeviceorientation + +• **ondeviceorientation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 + +### ondrag + +• **ondrag**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 + +Fires on the source object continuously during a drag operation. + +**`param`** The event. + +### ondragend + +• **ondragend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 + +Fires on the source object when the user releases the mouse at the close of a drag operation. + +**`param`** The event. + +### ondragenter + +• **ondragenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 + +Fires on the target element when the user drags the object to a valid drop target. + +**`param`** The drag event. + +### ondragexit + +• **ondragexit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 + +### ondragleave + +• **ondragleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 + +Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. + +**`param`** The drag event. + +### ondragover + +• **ondragover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 + +Fires on the target element continuously while the user drags the object over a valid drop target. + +**`param`** The event. + +### ondragstart + +• **ondragstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 + +Fires on the source object when the user starts to drag a text selection or selected object. + +**`param`** The event. + +### ondrop + +• **ondrop**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 + +### ondurationchange + +• **ondurationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 + +Occurs when the duration attribute is updated. + +**`param`** The event. + +### onemptied + +• **onemptied**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 + +Occurs when the media element is reset to its initial state. + +**`param`** The event. + +### onended + +• **onended**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 + +Occurs when the end of playback is reached. + +**`param`** The event + +### onerror + +• **onerror**: _ErrorEventHandler_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 + +Fires when an error occurs during object loading. + +**`param`** The event. + +### onfocus + +• **onfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 + +Fires when the object receives focus. + +**`param`** The event. + +### ongotpointercapture + +• **ongotpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 + +### onhashchange + +• **onhashchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 + +### oninput + +• **oninput**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 + +### oninvalid + +• **oninvalid**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 + +### onkeydown + +• **onkeydown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 + +Fires when the user presses a key. + +**`param`** The keyboard event + +### onkeypress + +• **onkeypress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 + +Fires when the user presses an alphanumeric key. + +**`param`** The event. + +### onkeyup + +• **onkeyup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 + +Fires when the user releases a key. + +**`param`** The keyboard event + +### onlanguagechange + +• **onlanguagechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 + +### onload + +• **onload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 + +Fires immediately after the browser loads the object. + +**`param`** The event. + +### onloadeddata + +• **onloadeddata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 + +Occurs when media data is loaded at the current playback position. + +**`param`** The event. + +### onloadedmetadata + +• **onloadedmetadata**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 + +Occurs when the duration and dimensions of the media have been determined. + +**`param`** The event. + +### onloadend + +• **onloadend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 + +### onloadstart + +• **onloadstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 + +Occurs when Internet Explorer begins looking for media data. + +**`param`** The event. + +### onlostpointercapture + +• **onlostpointercapture**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 + +### onmessage + +• **onmessage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 + +### onmessageerror + +• **onmessageerror**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 + +### onmousedown + +• **onmousedown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 + +Fires when the user clicks the object with either mouse button. + +**`param`** The mouse event. + +### onmouseenter + +• **onmouseenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 + +### onmouseleave + +• **onmouseleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 + +### onmousemove + +• **onmousemove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 + +Fires when the user moves the mouse over the object. + +**`param`** The mouse event. + +### onmouseout + +• **onmouseout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 + +Fires when the user moves the mouse pointer outside the boundaries of the object. + +**`param`** The mouse event. + +### onmouseover + +• **onmouseover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 + +Fires when the user moves the mouse pointer into the object. + +**`param`** The mouse event. + +### onmouseup + +• **onmouseup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 + +Fires when the user releases a mouse button while the mouse is over the object. + +**`param`** The mouse event. + +### onmousewheel + +• **onmousewheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 + +### onmsgesturechange + +• **onmsgesturechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 + +### onmsgesturedoubletap + +• **onmsgesturedoubletap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 + +### onmsgestureend + +• **onmsgestureend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 + +### onmsgesturehold + +• **onmsgesturehold**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 + +### onmsgesturestart + +• **onmsgesturestart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 + +### onmsgesturetap + +• **onmsgesturetap**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 + +### onmsinertiastart + +• **onmsinertiastart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 + +### onmspointercancel + +• **onmspointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 + +### onmspointerdown + +• **onmspointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 + +### onmspointerenter + +• **onmspointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 + +### onmspointerleave + +• **onmspointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 + +### onmspointermove + +• **onmspointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 + +### onmspointerout + +• **onmspointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 + +### onmspointerover + +• **onmspointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 + +### onmspointerup + +• **onmspointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 + +### onoffline + +• **onoffline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 + +### ononline + +• **ononline**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 + +### onorientationchange + +• **onorientationchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 + +**`deprecated`** + +### onpagehide + +• **onpagehide**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 + +### onpageshow + +• **onpageshow**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 + +### onpause + +• **onpause**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 + +Occurs when playback is paused. + +**`param`** The event. + +### onplay + +• **onplay**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 + +Occurs when the play method is requested. + +**`param`** The event. + +### onplaying + +• **onplaying**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 + +Occurs when the audio or video has started playing. + +**`param`** The event. + +### onpointercancel + +• **onpointercancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 + +### onpointerdown + +• **onpointerdown**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 + +### onpointerenter + +• **onpointerenter**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 + +### onpointerleave + +• **onpointerleave**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 + +### onpointermove + +• **onpointermove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 + +### onpointerout + +• **onpointerout**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 + +### onpointerover + +• **onpointerover**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 + +### onpointerup + +• **onpointerup**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 + +### onpopstate + +• **onpopstate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 + +### onprogress + +• **onprogress**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 + +Occurs to indicate progress while downloading media data. + +**`param`** The event. + +### onratechange + +• **onratechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 + +Occurs when the playback rate is increased or decreased. + +**`param`** The event. + +### onreadystatechange + +• **onreadystatechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 + +### onrejectionhandled + +• **onrejectionhandled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 + +### onreset + +• **onreset**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 + +Fires when the user resets a form. + +**`param`** The event. + +### onresize + +• **onresize**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 + +### onscroll + +• **onscroll**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 + +Fires when the user repositions the scroll box in the scroll bar on the object. + +**`param`** The event. + +### onsecuritypolicyviolation + +• **onsecuritypolicyviolation**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 + +### onseeked + +• **onseeked**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 + +Occurs when the seek operation ends. + +**`param`** The event. + +### onseeking + +• **onseeking**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 + +Occurs when the current playback position is moved. + +**`param`** The event. + +### onselect + +• **onselect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 + +Fires when the current selection changes. + +**`param`** The event. + +### onstalled + +• **onstalled**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 + +Occurs when the download has stopped. + +**`param`** The event. + +### onstorage + +• **onstorage**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 + +### onsubmit + +• **onsubmit**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 + +### onsuspend + +• **onsuspend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 + +Occurs if the load operation has been intentionally halted. + +**`param`** The event. + +### ontimeupdate + +• **ontimeupdate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 + +Occurs to indicate the current playback position. + +**`param`** The event. + +### ontoggle + +• **ontoggle**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 + +### ontouchcancel + +• **ontouchcancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 + +### ontouchend + +• **ontouchend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 + +### ontouchmove + +• **ontouchmove**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 + +### ontouchstart + +• **ontouchstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 + +### ontransitioncancel + +• **ontransitioncancel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 + +### ontransitionend + +• **ontransitionend**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 + +### ontransitionrun + +• **ontransitionrun**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 + +### ontransitionstart + +• **ontransitionstart**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 + +### onunhandledrejection + +• **onunhandledrejection**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 + +### onunload + +• **onunload**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 + +### onvolumechange + +• **onvolumechange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 + +Occurs when the volume is changed, or playback is muted or unmuted. + +**`param`** The event. + +### onvrdisplayactivate + +• **onvrdisplayactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 + +### onvrdisplayblur + +• **onvrdisplayblur**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 + +### onvrdisplayconnect + +• **onvrdisplayconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 + +### onvrdisplaydeactivate + +• **onvrdisplaydeactivate**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 + +### onvrdisplaydisconnect + +• **onvrdisplaydisconnect**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 + +### onvrdisplayfocus + +• **onvrdisplayfocus**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 + +### onvrdisplaypointerrestricted + +• **onvrdisplaypointerrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 + +### onvrdisplaypointerunrestricted + +• **onvrdisplaypointerunrestricted**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 + +### onvrdisplaypresentchange + +• **onvrdisplaypresentchange**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 + +### onwaiting + +• **onwaiting**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 + +Occurs when playback stops because the next frame of a video resource is not available. + +**`param`** The event. + +### onwheel + +• **onwheel**: _function \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 + +### opener + +• **opener**: _any_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 + +### orientation + +• **orientation**: _string \| number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 + +**`deprecated`** + +### origin + +• **origin**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 + +### outerHeight + +• **outerHeight**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 + +### outerWidth + +• **outerWidth**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 + +### pageXOffset + +• **pageXOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 + +### pageYOffset + +• **pageYOffset**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 + +### parent + +• **parent**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 + +### performance + +• **performance**: _Performance_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 + +### personalbar + +• **personalbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 + +### screen + +• **screen**: _Screen_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 + +### screenLeft + +• **screenLeft**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 + +### screenTop + +• **screenTop**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 + +### screenX + +• **screenX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 + +### screenY + +• **screenY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 + +### scrollX + +• **scrollX**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 + +### scrollY + +• **scrollY**: _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 + +### scrollbars + +• **scrollbars**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 + +### self + +• **self**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 + +### sessionStorage + +• **sessionStorage**: _Storage_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 + +### speechSynthesis + +• **speechSynthesis**: _SpeechSynthesis_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 + +### status + +• **status**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 + +### statusbar + +• **statusbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 + +### styleMedia + +• **styleMedia**: _StyleMedia_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 + +### toolbar + +• **toolbar**: _BarProp_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 + +### top + +• **top**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 + +### web3 + +• **web3**: [_InjectedWeb3_](../interfaces/_browserutils_.injectedweb3.md) + +_Overrides_ [_ExtendedWindow_](../interfaces/_browserutils_.extendedwindow.md)_._[_web3_](../interfaces/_browserutils_.extendedwindow.md#optional-web3) + +_Defined in_ [_src/browserUtils.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L39) + +### window + +• **window**: _Window_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 + +## Methods + +### addEventListener + +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ + +**Returns:** _void_ + +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | + +**Returns:** _void_ + +### alert + +▸ **alert**\(`message?`: any\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | any | + +**Returns:** _void_ + +### atob + +▸ **atob**\(`encodedString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `encodedString` | string | + +**Returns:** _string_ + +### blur + +▸ **blur**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 + +**Returns:** _void_ + +### btoa + +▸ **btoa**\(`rawString`: string\): _string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `rawString` | string | + +**Returns:** _string_ + +### cancelAnimationFrame + +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### captureEvents + +▸ **captureEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 + +**`deprecated`** + +**Returns:** _void_ + +### clearInterval + +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### clearTimeout + +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | + +**Returns:** _void_ + +### close + +▸ **close**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 + +**Returns:** _void_ + +### confirm + +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | + +**Returns:** _boolean_ + +### createImageBitmap + +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | + +**Returns:** _Promise‹ImageBitmap›_ + +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | + +**Returns:** _Promise‹ImageBitmap›_ + +### departFocus + +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | + +**Returns:** _void_ + +### dispatchEvent + +▸ **dispatchEvent**\(`event`: Event\): _boolean_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 + +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `event` | Event | + +**Returns:** _boolean_ + +### fetch + +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | + +**Returns:** _Promise‹Response›_ + +### focus + +▸ **focus**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 + +**Returns:** _void_ + +### getComputedStyle + +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSStyleDeclaration_ + +### getMatchedCSSRules + +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | + +**Returns:** _CSSRuleList_ + +### getSelection + +▸ **getSelection**\(\): _Selection_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 + +**Returns:** _Selection_ + +### matchMedia + +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `query` | string | + +**Returns:** _MediaQueryList_ + +### moveBy + +▸ **moveBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### moveTo + +▸ **moveTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### msWriteProfilerMark + +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | + +**Returns:** _void_ + +### open + +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | + +**Returns:** _Window \| null_ + +### postMessage + +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | + +**Returns:** _void_ + +### print + +▸ **print**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 + +**Returns:** _void_ + +### prompt + +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | + +**Returns:** _string \| null_ + +### queueMicrotask + +▸ **queueMicrotask**\(`callback`: Function\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | Function | + +**Returns:** _void_ + +### releaseEvents + +▸ **releaseEvents**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 + +**`deprecated`** + +**Returns:** _void_ + +### removeEventListener + +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 + +**Type parameters:** + +▪ **K**: _keyof WindowEventMap_ + +**Parameters:** + +▪ **type**: _K_ + +▪ **listener**: _function_ + +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | + +▪`Optional` **options**: _boolean \| EventListenerOptions_ + +**Returns:** _void_ + +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | + +**Returns:** _void_ + +### requestAnimationFrame + +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + +### resizeBy + +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### resizeTo + +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scroll + +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scroll**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollBy + +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### scrollTo + +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | + +**Returns:** _void_ + +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | + +**Returns:** _void_ + +### setInterval + +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### setTimeout + +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | + +**Returns:** _number_ + +### stop + +▸ **stop**\(\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 + +**Returns:** _void_ + +### webkitCancelAnimationFrame + +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `handle` | number | + +**Returns:** _void_ + +### webkitConvertPointFromNodeToPage + +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitConvertPointFromPageToNode + +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | + +**Returns:** _WebKitPoint_ + +### webkitRequestAnimationFrame + +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ + diff --git a/docs/api/external-modules/_context_.constructorparams.md b/docs/api/external-modules/_context_.constructorparams.md new file mode 100644 index 0000000..963f2f5 --- /dev/null +++ b/docs/api/external-modules/_context_.constructorparams.md @@ -0,0 +1,20 @@ +# ConstructorParams + +## Hierarchy + +* **ConstructorParams** + +## Index + +### Properties + +* [contractWrappers](../interfaces/_context_.constructorparams.md#contractwrappers) + +## Properties + +### contractWrappers + +• **contractWrappers**: [_PolymathBase_](../classes/_polymathbase_.polymathbase.md) + +_Defined in_ [_src/Context.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L17) + diff --git a/docs/api/external-modules/_context_.context.md b/docs/api/external-modules/_context_.context.md new file mode 100644 index 0000000..1b3588b --- /dev/null +++ b/docs/api/external-modules/_context_.context.md @@ -0,0 +1,60 @@ +# Context + +Context in which the SDK is being used + +* Holds the current instance of the contract wrappers +* Holds the current wallet +* Holds the factories that create and cache entities + +## Hierarchy + +* **Context** + +## Index + +### Constructors + +* [constructor](../classes/_context_.context.md#constructor) + +### Properties + +* [contractWrappers](../classes/_context_.context.md#contractwrappers) +* [currentWallet](../classes/_context_.context.md#currentwallet) +* [factories](../classes/_context_.context.md#factories) + +## Constructors + +### constructor + ++ **new Context**\(`params`: [ConstructorParams](../interfaces/_context_.constructorparams.md)\): [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/Context.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [ConstructorParams](../interfaces/_context_.constructorparams.md) | + +**Returns:** [_Context_](../classes/_context_.context.md) + +## Properties + +### contractWrappers + +• **contractWrappers**: [_PolymathBase_](../classes/_polymathbase_.polymathbase.md) + +_Defined in_ [_src/Context.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L41) + +### currentWallet + +• **currentWallet**: _Wallet_ + +_Defined in_ [_src/Context.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L43) + +### factories + +• **factories**: [_Factories_](../interfaces/_context_.factories.md) + +_Defined in_ [_src/Context.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L45) + diff --git a/docs/api/external-modules/_context_.factories.md b/docs/api/external-modules/_context_.factories.md new file mode 100644 index 0000000..eb549a3 --- /dev/null +++ b/docs/api/external-modules/_context_.factories.md @@ -0,0 +1,83 @@ +# Factories + +## Hierarchy + +* **Factories** + +## Index + +### Properties + +* [checkpointFactory](../interfaces/_context_.factories.md#checkpointfactory) +* [dividendDistributionFactory](../interfaces/_context_.factories.md#dividenddistributionfactory) +* [erc20TokenBalanceFactory](../interfaces/_context_.factories.md#erc20tokenbalancefactory) +* [investmentFactory](../interfaces/_context_.factories.md#investmentfactory) +* [securityTokenFactory](../interfaces/_context_.factories.md#securitytokenfactory) +* [securityTokenReservationFactory](../interfaces/_context_.factories.md#securitytokenreservationfactory) +* [simpleStoFactory](../interfaces/_context_.factories.md#simplestofactory) +* [taxWithholdingFactory](../interfaces/_context_.factories.md#taxwithholdingfactory) +* [tieredStoFactory](../interfaces/_context_.factories.md#tieredstofactory) +* [tokenholderFactory](../interfaces/_context_.factories.md#tokenholderfactory) + +## Properties + +### checkpointFactory + +• **checkpointFactory**: _CheckpointFactory_ + +_Defined in_ [_src/Context.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L28) + +### dividendDistributionFactory + +• **dividendDistributionFactory**: _DividendDistributionFactory_ + +_Defined in_ [_src/Context.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L27) + +### erc20TokenBalanceFactory + +• **erc20TokenBalanceFactory**: [_Erc20TokenBalanceFactory_](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + +_Defined in_ [_src/Context.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L23) + +### investmentFactory + +• **investmentFactory**: [_InvestmentFactory_](../classes/_entities_factories_investmentfactory_.investmentfactory.md) + +_Defined in_ [_src/Context.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L24) + +### securityTokenFactory + +• **securityTokenFactory**: _SecurityTokenFactory_ + +_Defined in_ [_src/Context.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L21) + +### securityTokenReservationFactory + +• **securityTokenReservationFactory**: _SecurityTokenReservationFactory_ + +_Defined in_ [_src/Context.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L22) + +### simpleStoFactory + +• **simpleStoFactory**: [_SimpleStoFactory_](../classes/_entities_factories_simplestofactory_.simplestofactory.md) + +_Defined in_ [_src/Context.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L25) + +### taxWithholdingFactory + +• **taxWithholdingFactory**: [_TaxWithholdingFactory_](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + +_Defined in_ [_src/Context.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L30) + +### tieredStoFactory + +• **tieredStoFactory**: [_TieredStoFactory_](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) + +_Defined in_ [_src/Context.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L26) + +### tokenholderFactory + +• **tokenholderFactory**: [_TokenholderFactory_](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + +_Defined in_ [_src/Context.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L29) + diff --git a/docs/api/modules/_context_.md b/docs/api/external-modules/_context_.md similarity index 87% rename from docs/api/modules/_context_.md rename to docs/api/external-modules/_context_.md index 3f1eca5..ec92e5c 100644 --- a/docs/api/modules/_context_.md +++ b/docs/api/external-modules/_context_.md @@ -1,4 +1,4 @@ -# External module: "Context" +# Context ## Index @@ -10,3 +10,4 @@ * [ConstructorParams](../interfaces/_context_.constructorparams.md) * [Factories](../interfaces/_context_.factories.md) + diff --git a/docs/api/external-modules/_entities_checkpoint_.checkpoint.md b/docs/api/external-modules/_entities_checkpoint_.checkpoint.md new file mode 100644 index 0000000..a57671e --- /dev/null +++ b/docs/api/external-modules/_entities_checkpoint_.checkpoint.md @@ -0,0 +1,186 @@ +# Checkpoint + +Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_checkpoint_.params.md)› + + ↳ **Checkpoint** + +## Index + +### Constructors + +* [constructor](../classes/_entities_checkpoint_.checkpoint.md#constructor) + +### Properties + +* [createdAt](../classes/_entities_checkpoint_.checkpoint.md#createdat) +* [dividendDistributions](../classes/_entities_checkpoint_.checkpoint.md#dividenddistributions) +* [index](../classes/_entities_checkpoint_.checkpoint.md#index) +* [securityTokenId](../classes/_entities_checkpoint_.checkpoint.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_checkpoint_.checkpoint.md#securitytokensymbol) +* [tokenholderBalances](../classes/_entities_checkpoint_.checkpoint.md#tokenholderbalances) +* [totalSupply](../classes/_entities_checkpoint_.checkpoint.md#totalsupply) +* [uid](../classes/_entities_checkpoint_.checkpoint.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_checkpoint_.checkpoint.md#_refresh) +* [toPojo](../classes/_entities_checkpoint_.checkpoint.md#topojo) +* [generateId](../classes/_entities_checkpoint_.checkpoint.md#static-generateid) +* [unserialize](../classes/_entities_checkpoint_.checkpoint.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Checkpoint**\(`params`: [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)\): [_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md) + +_Defined in_ [_src/entities/Checkpoint.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106) + +Create a new Chekpoint instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) | + +**Returns:** [_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md) + +## Properties + +### createdAt + +• **createdAt**: _Date_ + +_Defined in_ [_src/entities/Checkpoint.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106) + +### dividendDistributions + +• **dividendDistributions**: [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_\[\]_ + +_Defined in_ [_src/entities/Checkpoint.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L88) + +dividend distributions associated to this snapshot + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/Checkpoint.ts:97_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L97) + +numerical index of the checkpoint associated to this snapshot + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Checkpoint.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L92) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Checkpoint.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L90) + +### tokenholderBalances + +• **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ + +_Defined in_ [_src/entities/Checkpoint.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L102) + +tokenholder balances at this specific checkpoint + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/Checkpoint.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L104) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Checkpoint.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L83) + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Checkpoint.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L164) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_checkpoint_.params.md)› | + +**Returns:** _void_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Checkpoint.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L137) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **createdAt**: _Date_ +* **dividendDistributions**: _object\[\]_ = dividendDistributions.map\(distribution => distribution.toPojo\(\)\) +* **index**: _number_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ +* **totalSupply**: _BigNumber_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/Checkpoint.ts:58_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L58) + +Generate the Checkpoint's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Checkpoint.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L70) + +Unserialize string to Checkpoint object + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_checkpoint_.md b/docs/api/external-modules/_entities_checkpoint_.md similarity index 55% rename from docs/api/modules/_entities_checkpoint_.md rename to docs/api/external-modules/_entities_checkpoint_.md index 1664caa..280791d 100644 --- a/docs/api/modules/_entities_checkpoint_.md +++ b/docs/api/external-modules/_entities_checkpoint_.md @@ -1,4 +1,4 @@ -# External module: "entities/Checkpoint" +# entities/Checkpoint ## Index @@ -17,18 +17,19 @@ ## Functions -### isUniqueIdentifiers +### isUniqueIdentifiers -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ -*Defined in [src/entities/Checkpoint.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L25)* +_Defined in_ [_src/entities/Checkpoint.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L25) Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md) **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | any | +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ -**Returns:** *identifiers is UniqueIdentifiers* diff --git a/docs/api/external-modules/_entities_checkpoint_.params.md b/docs/api/external-modules/_entities_checkpoint_.params.md new file mode 100644 index 0000000..27e75c1 --- /dev/null +++ b/docs/api/external-modules/_entities_checkpoint_.params.md @@ -0,0 +1,56 @@ +# Params + +Checkpoint constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [createdAt](../interfaces/_entities_checkpoint_.params.md#createdat) +* [dividendDistributions](../interfaces/_entities_checkpoint_.params.md#dividenddistributions) +* [securityTokenSymbol](../interfaces/_entities_checkpoint_.params.md#securitytokensymbol) +* [tokenholderBalances](../interfaces/_entities_checkpoint_.params.md#tokenholderbalances) +* [totalSupply](../interfaces/_entities_checkpoint_.params.md#totalsupply) + +## Properties + +### createdAt + +• **createdAt**: _Date_ + +_Defined in_ [_src/entities/Checkpoint.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L48) + +### dividendDistributions + +• **dividendDistributions**: [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_\[\]_ + +_Defined in_ [_src/entities/Checkpoint.ts:38_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L38) + +dividend distributions associated to this checkpoint + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Checkpoint.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L42) + +symbol of the security token + +### tokenholderBalances + +• **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ + +_Defined in_ [_src/entities/Checkpoint.ts:46_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L46) + +tokenholder balances at this specific Checkpoint + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/Checkpoint.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L47) + diff --git a/docs/api/external-modules/_entities_checkpoint_.uniqueidentifiers.md b/docs/api/external-modules/_entities_checkpoint_.uniqueidentifiers.md new file mode 100644 index 0000000..5083404 --- /dev/null +++ b/docs/api/external-modules/_entities_checkpoint_.uniqueidentifiers.md @@ -0,0 +1,33 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Checkpoint + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [index](../interfaces/_entities_checkpoint_.uniqueidentifiers.md#index) +* [securityTokenId](../interfaces/_entities_checkpoint_.uniqueidentifiers.md#securitytokenid) + +## Properties + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/Checkpoint.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L19) + +numerical index of the checkpoint. The higher the index, the more recent the checkpoint + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Checkpoint.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L15) + +security token UUID + diff --git a/docs/api/external-modules/_entities_dividenddistribution_.dividenddistribution.md b/docs/api/external-modules/_entities_dividenddistribution_.dividenddistribution.md new file mode 100644 index 0000000..8b6b315 --- /dev/null +++ b/docs/api/external-modules/_entities_dividenddistribution_.dividenddistribution.md @@ -0,0 +1,293 @@ +# DividendDistribution + +Class used to manage the dividend distribution functionality + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_dividenddistribution_.params.md)› + + ↳ **DividendDistribution** + +## Index + +### Constructors + +* [constructor](../classes/_entities_dividenddistribution_.dividenddistribution.md#constructor) + +### Properties + +* [amount](../classes/_entities_dividenddistribution_.dividenddistribution.md#amount) +* [checkpointId](../classes/_entities_dividenddistribution_.dividenddistribution.md#checkpointid) +* [claimedAmount](../classes/_entities_dividenddistribution_.dividenddistribution.md#claimedamount) +* [context](../classes/_entities_dividenddistribution_.dividenddistribution.md#protected-context) +* [created](../classes/_entities_dividenddistribution_.dividenddistribution.md#created) +* [currency](../classes/_entities_dividenddistribution_.dividenddistribution.md#currency) +* [expiry](../classes/_entities_dividenddistribution_.dividenddistribution.md#expiry) +* [index](../classes/_entities_dividenddistribution_.dividenddistribution.md#index) +* [maturity](../classes/_entities_dividenddistribution_.dividenddistribution.md#maturity) +* [name](../classes/_entities_dividenddistribution_.dividenddistribution.md#name) +* [reclaimed](../classes/_entities_dividenddistribution_.dividenddistribution.md#reclaimed) +* [securityTokenId](../classes/_entities_dividenddistribution_.dividenddistribution.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_dividenddistribution_.dividenddistribution.md#securitytokensymbol) +* [tokenholders](../classes/_entities_dividenddistribution_.dividenddistribution.md#tokenholders) +* [totalSupply](../classes/_entities_dividenddistribution_.dividenddistribution.md#totalsupply) +* [totalWithheld](../classes/_entities_dividenddistribution_.dividenddistribution.md#totalwithheld) +* [totalWithheldWithdrawn](../classes/_entities_dividenddistribution_.dividenddistribution.md#totalwithheldwithdrawn) +* [uid](../classes/_entities_dividenddistribution_.dividenddistribution.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_dividenddistribution_.dividenddistribution.md#_refresh) +* [pullPayment](../classes/_entities_dividenddistribution_.dividenddistribution.md#pullpayment) +* [pushPayment](../classes/_entities_dividenddistribution_.dividenddistribution.md#pushpayment) +* [toPojo](../classes/_entities_dividenddistribution_.dividenddistribution.md#topojo) +* [withdrawTaxes](../classes/_entities_dividenddistribution_.dividenddistribution.md#withdrawtaxes) +* [generateId](../classes/_entities_dividenddistribution_.dividenddistribution.md#static-generateid) +* [unserialize](../classes/_entities_dividenddistribution_.dividenddistribution.md#static-unserialize) + +## Constructors + +### constructor + ++ **new DividendDistribution**\(`params`: [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md) + +_Defined in_ [_src/entities/DividendDistribution.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146) + +Create a new Dividend Distribution instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_dividenddistribution_.params.md) & [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L128) + +### checkpointId + +• **checkpointId**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L116) + +### claimedAmount + +• **claimedAmount**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L130) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/DividendDistribution.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L146) + +### created + +• **created**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L122) + +### currency + +• **currency**: _string \| null_ + +_Defined in_ [_src/entities/DividendDistribution.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L144) + +### expiry + +• **expiry**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L126) + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/DividendDistribution.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L114) + +### maturity + +• **maturity**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:124_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L124) + +### name + +• **name**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L142) + +### reclaimed + +• **reclaimed**: _boolean_ + +_Defined in_ [_src/entities/DividendDistribution.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L134) + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L120) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L118) + +### tokenholders + +• **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ + +_Defined in_ [_src/entities/DividendDistribution.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L140) + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L132) + +### totalWithheld + +• **totalWithheld**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L136) + +### totalWithheldWithdrawn + +• **totalWithheldWithdrawn**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L138) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/DividendDistribution.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L112) + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/DividendDistribution.ts:290_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L290) + +Hydrate the Dividend Distribution entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_dividenddistribution_.params.md)› | + +**Returns:** _void_ + +### pullPayment + +▸ **pullPayment**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/DividendDistribution.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L215) + +Pull payment from this dividend distribution to the current address + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)_, void››_ + +### pushPayment + +▸ **pushPayment**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/DividendDistribution.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L200) + +Push payment for this dividend distribution + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)_, void››_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/DividendDistribution.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L245) + +Convert entity to POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **amount**: _BigNumber_ +* **checkpointId**: _string_ +* **claimedAmount**: _BigNumber_ +* **created**: _Date_ +* **currency**: _null \| string_ +* **expiry**: _Date_ +* **index**: _number_ +* **maturity**: _Date_ +* **name**: _string_ +* **reclaimed**: _boolean_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ +* **totalSupply**: _BigNumber_ +* **totalWithheld**: _BigNumber_ +* **totalWithheldWithdrawn**: _BigNumber_ +* **uid**: _string_ + +### withdrawTaxes + +▸ **withdrawTaxes**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/DividendDistribution.ts:230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L230) + +Withdraw collected taxes from this dividend distribution + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)_, void››_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L87) + +Generate the Dividend Distribution's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/DividendDistribution.ts:99_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L99) + +Unserialize string to a Dividend Distribution object representation + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_dividenddistribution_.md b/docs/api/external-modules/_entities_dividenddistribution_.md similarity index 56% rename from docs/api/modules/_entities_dividenddistribution_.md rename to docs/api/external-modules/_entities_dividenddistribution_.md index 640a284..f9c57ca 100644 --- a/docs/api/modules/_entities_dividenddistribution_.md +++ b/docs/api/external-modules/_entities_dividenddistribution_.md @@ -1,4 +1,4 @@ -# External module: "entities/DividendDistribution" +# entities/DividendDistribution ## Index @@ -17,18 +17,19 @@ ## Functions -### isUniqueIdentifiers +### isUniqueIdentifiers -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ -*Defined in [src/entities/DividendDistribution.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L26)* +_Defined in_ [_src/entities/DividendDistribution.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L26) Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md) **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | any | +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ -**Returns:** *identifiers is UniqueIdentifiers* diff --git a/docs/api/external-modules/_entities_dividenddistribution_.params.md b/docs/api/external-modules/_entities_dividenddistribution_.params.md new file mode 100644 index 0000000..7f2bc22 --- /dev/null +++ b/docs/api/external-modules/_entities_dividenddistribution_.params.md @@ -0,0 +1,129 @@ +# Params + +Dividend Distribution constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [amount](../interfaces/_entities_dividenddistribution_.params.md#amount) +* [checkpointId](../interfaces/_entities_dividenddistribution_.params.md#checkpointid) +* [claimedAmount](../interfaces/_entities_dividenddistribution_.params.md#claimedamount) +* [created](../interfaces/_entities_dividenddistribution_.params.md#created) +* [currency](../interfaces/_entities_dividenddistribution_.params.md#currency) +* [expiry](../interfaces/_entities_dividenddistribution_.params.md#expiry) +* [maturity](../interfaces/_entities_dividenddistribution_.params.md#maturity) +* [name](../interfaces/_entities_dividenddistribution_.params.md#name) +* [reclaimed](../interfaces/_entities_dividenddistribution_.params.md#reclaimed) +* [securityTokenSymbol](../interfaces/_entities_dividenddistribution_.params.md#securitytokensymbol) +* [tokenholders](../interfaces/_entities_dividenddistribution_.params.md#tokenholders) +* [totalSupply](../interfaces/_entities_dividenddistribution_.params.md#totalsupply) +* [totalWithheld](../interfaces/_entities_dividenddistribution_.params.md#totalwithheld) +* [totalWithheldWithdrawn](../interfaces/_entities_dividenddistribution_.params.md#totalwithheldwithdrawn) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L57) + +dividend amount + +### checkpointId + +• **checkpointId**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L41) + +### claimedAmount + +• **claimedAmount**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L61) + +amount of dividend claimed so far + +### created + +• **created**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L45) + +date at which the dividend was created + +### currency + +• **currency**: _string \| null_ + +_Defined in_ [_src/entities/DividendDistribution.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L77) + +symbol of the currency in which this dividend distribution is being paid + +### expiry + +• **expiry**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L53) + +date until which dividend can be claimed + +### maturity + +• **maturity**: _Date_ + +_Defined in_ [_src/entities/DividendDistribution.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L49) + +date after which dividend can be claimed + +### name + +• **name**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L73) + +### reclaimed + +• **reclaimed**: _boolean_ + +_Defined in_ [_src/entities/DividendDistribution.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L69) + +true if expiry has passed and issuer has reclaimed remaining dividend + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L40) + +### tokenholders + +• **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ + +_Defined in_ [_src/entities/DividendDistribution.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L72) + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L65) + +total supply at the associated checkpoint + +### totalWithheld + +• **totalWithheld**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L70) + +### totalWithheldWithdrawn + +• **totalWithheldWithdrawn**: _BigNumber_ + +_Defined in_ [_src/entities/DividendDistribution.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L71) + diff --git a/docs/api/external-modules/_entities_dividenddistribution_.uniqueidentifiers.md b/docs/api/external-modules/_entities_dividenddistribution_.uniqueidentifiers.md new file mode 100644 index 0000000..a300d13 --- /dev/null +++ b/docs/api/external-modules/_entities_dividenddistribution_.uniqueidentifiers.md @@ -0,0 +1,33 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Dividend Distribution + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [index](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md#index) +* [securityTokenId](../interfaces/_entities_dividenddistribution_.uniqueidentifiers.md#securitytokenid) + +## Properties + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/DividendDistribution.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L20) + +ordered index of the distribution + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/DividendDistribution.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L16) + +security token UUID + diff --git a/docs/api/external-modules/_entities_entity_.entity.md b/docs/api/external-modules/_entities_entity_.entity.md new file mode 100644 index 0000000..213d28d --- /dev/null +++ b/docs/api/external-modules/_entities_entity_.entity.md @@ -0,0 +1,79 @@ +# Entity + +Represents an object or resource in the Polymath Ecosystem with its own set of properties and functionality + +## Type parameters + +▪ **Params** + +## Hierarchy + +* **Entity** + + ↳ [PolyTransaction](../classes/_entities_polytransaction_.polytransaction.md) + + ↳ [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md) + + ↳ [SecurityTokenReservation](../classes/_entities_securitytokenreservation_.securitytokenreservation.md) + + ↳ [DividendDistribution](../classes/_entities_dividenddistribution_.dividenddistribution.md) + + ↳ [Checkpoint](../classes/_entities_checkpoint_.checkpoint.md) + + ↳ [TaxWithholding](../classes/_entities_taxwithholding_.taxwithholding.md) + + ↳ [Erc20TokenBalance](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) + + ↳ [Sto](../classes/_entities_sto_.sto.md) + + ↳ [Investment](../classes/_entities_investment_.investment.md) + + ↳ [Tokenholder](../classes/_entities_tokenholder_.tokenholder.md) + + ↳ [Wallet](../classes/_entities_wallet_.wallet.md) + + ↳ [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +## Index + +### Properties + +* [uid](../classes/_entities_entity_.entity.md#abstract-uid) + +### Methods + +* [\_refresh](../classes/_entities_entity_.entity.md#abstract-_refresh) +* [toPojo](../classes/_entities_entity_.entity.md#abstract-topojo) + +## Properties + +### `Abstract` uid + +• **uid**: _string_ + +_Defined in_ [_src/entities/Entity.ts:5_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L5) + +## Methods + +### `Abstract` \_refresh + +▸ **\_refresh**\(`params`: Partial‹Params›\): _void_ + +_Defined in_ [_src/entities/Entity.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L9) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹Params› | + +**Returns:** _void_ + +### `Abstract` toPojo + +▸ **toPojo**\(\): _any_ + +_Defined in_ [_src/entities/Entity.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Entity.ts#L7) + +**Returns:** _any_ + diff --git a/docs/api/modules/_entities_entity_.md b/docs/api/external-modules/_entities_entity_.md similarity index 66% rename from docs/api/modules/_entities_entity_.md rename to docs/api/external-modules/_entities_entity_.md index 25a70b9..0c908aa 100644 --- a/docs/api/modules/_entities_entity_.md +++ b/docs/api/external-modules/_entities_entity_.md @@ -1,7 +1,8 @@ -# External module: "entities/Entity" +# entities/Entity ## Index ### Classes * [Entity](../classes/_entities_entity_.entity.md) + diff --git a/docs/api/external-modules/_entities_erc20tokenbalance_.erc20tokenbalance.md b/docs/api/external-modules/_entities_erc20tokenbalance_.erc20tokenbalance.md new file mode 100644 index 0000000..acbc984 --- /dev/null +++ b/docs/api/external-modules/_entities_erc20tokenbalance_.erc20tokenbalance.md @@ -0,0 +1,164 @@ +# Erc20TokenBalance + +Used to manage a ERC20 token balance + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› + + ↳ **Erc20TokenBalance** + +## Index + +### Constructors + +* [constructor](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#constructor) + +### Properties + +* [balance](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#balance) +* [tokenAddress](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#tokenaddress) +* [tokenSymbol](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#tokensymbol) +* [uid](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#uid) +* [walletAddress](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#walletaddress) + +### Methods + +* [\_refresh](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#_refresh) +* [toPojo](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#topojo) +* [generateId](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#static-generateid) +* [unserialize](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Erc20TokenBalance**\(`params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)\): [_Erc20TokenBalance_](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84) + +Create an ERC20 Token balance instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) & [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) | + +**Returns:** [_Erc20TokenBalance_](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) + +## Properties + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L84) + +total number of tokens belonging to token holder + +### tokenAddress + +• **tokenAddress**: _string_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L74) + +address of the ERC20 token + +### tokenSymbol + +• **tokenSymbol**: _string \| null_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L69) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:67_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L67) + +unique generated identifier for an ERC20 token balance + +### walletAddress + +• **walletAddress**: _string_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L79) + +wallet address of the token holder + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L122) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | + +**Returns:** _void_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L107) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **balance**: _BigNumber_ +* **tokenAddress**: _string_ +* **tokenSymbol**: _null \| string_ +* **uid**: _string_ +* **walletAddress**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L39) + +Generate the ERC20 Token Balance's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenAddress` | string | +| `walletAddress` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: any\): [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L51) + +Unserialize a serialized erc20 token balance + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | any | string with erc20 token balance entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_erc20tokenbalance_.md b/docs/api/external-modules/_entities_erc20tokenbalance_.md similarity index 55% rename from docs/api/modules/_entities_erc20tokenbalance_.md rename to docs/api/external-modules/_entities_erc20tokenbalance_.md index beddcc6..4aecffa 100644 --- a/docs/api/modules/_entities_erc20tokenbalance_.md +++ b/docs/api/external-modules/_entities_erc20tokenbalance_.md @@ -1,4 +1,4 @@ -# External module: "entities/Erc20TokenBalance" +# entities/Erc20TokenBalance ## Index @@ -17,18 +17,19 @@ ## Functions -### isUniqueIdentifiers +### isUniqueIdentifiers -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ -*Defined in [src/entities/Erc20TokenBalance.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L18)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L18) Check if a value is of type [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md) **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | any | +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ -**Returns:** *identifiers is UniqueIdentifiers* diff --git a/docs/api/external-modules/_entities_erc20tokenbalance_.params.md b/docs/api/external-modules/_entities_erc20tokenbalance_.params.md new file mode 100644 index 0000000..9440621 --- /dev/null +++ b/docs/api/external-modules/_entities_erc20tokenbalance_.params.md @@ -0,0 +1,29 @@ +# Params + +Constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [balance](../interfaces/_entities_erc20tokenbalance_.params.md#balance) +* [tokenSymbol](../interfaces/_entities_erc20tokenbalance_.params.md#tokensymbol) + +## Properties + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L29) + +### tokenSymbol + +• **tokenSymbol**: _string \| null_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L28) + diff --git a/docs/api/external-modules/_entities_erc20tokenbalance_.uniqueidentifiers.md b/docs/api/external-modules/_entities_erc20tokenbalance_.uniqueidentifiers.md new file mode 100644 index 0000000..b64e4b0 --- /dev/null +++ b/docs/api/external-modules/_entities_erc20tokenbalance_.uniqueidentifiers.md @@ -0,0 +1,29 @@ +# UniqueIdentifiers + +Properties that uniquely identify an ERC20 token balance + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [tokenAddress](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md#tokenaddress) +* [walletAddress](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md#walletaddress) + +## Properties + +### tokenAddress + +• **tokenAddress**: _string_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L11) + +### walletAddress + +• **walletAddress**: _string_ + +_Defined in_ [_src/entities/Erc20TokenBalance.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L12) + diff --git a/docs/api/external-modules/_entities_factories_checkpointfactory_.md b/docs/api/external-modules/_entities_factories_checkpointfactory_.md new file mode 100644 index 0000000..ccf57d2 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_checkpointfactory_.md @@ -0,0 +1,2 @@ +# entities/factories/CheckpointFactory + diff --git a/docs/api/external-modules/_entities_factories_dividenddistributionfactory_.md b/docs/api/external-modules/_entities_factories_dividenddistributionfactory_.md new file mode 100644 index 0000000..63422f1 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_dividenddistributionfactory_.md @@ -0,0 +1,2 @@ +# entities/factories/DividendDistributionFactory + diff --git a/docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md b/docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md new file mode 100644 index 0000000..8e95ef4 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md @@ -0,0 +1,157 @@ +# Erc20TokenBalanceFactory + +Factory generates information for an ERC20 Token Balance + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[Erc20TokenBalance](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md), [Params](../interfaces/_entities_erc20tokenbalance_.params.md), [UniqueIdentifiers](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)› + + ↳ **Erc20TokenBalanceFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#entity) +* [cache](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#cache) +* [context](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#create) +* [fetch](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#fetch) +* [refresh](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#refresh) +* [update](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md#update) + +## Constructors + +### constructor + ++ **new Erc20TokenBalanceFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_Erc20TokenBalanceFactory_](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/Erc20TokenBalanceFactory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Erc20TokenBalanceFactory.ts#L28) + +Create an instance of the ERC20 Token Balance Factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Erc20TokenBalanceFactory_](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_erc20tokenbalance_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [Erc20TokenBalance](../classes/_entities_erc20tokenbalance_.erc20tokenbalance.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_erc20tokenbalance_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_erc20tokenbalance_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_erc20tokenbalance_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_erc20tokenbalancefactory_.md b/docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.md similarity index 68% rename from docs/api/modules/_entities_factories_erc20tokenbalancefactory_.md rename to docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.md index 849ddb9..4aed44c 100644 --- a/docs/api/modules/_entities_factories_erc20tokenbalancefactory_.md +++ b/docs/api/external-modules/_entities_factories_erc20tokenbalancefactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/Erc20TokenBalanceFactory" +# entities/factories/Erc20TokenBalanceFactory ## Index ### Classes * [Erc20TokenBalanceFactory](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + diff --git a/docs/api/external-modules/_entities_factories_factory_.entityclass.md b/docs/api/external-modules/_entities_factories_factory_.entityclass.md new file mode 100644 index 0000000..9ab9843 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_factory_.entityclass.md @@ -0,0 +1,76 @@ +# EntityClass + +Represents an entity + +## Type parameters + +▪ **T** + +▪ **U** + +## Hierarchy + +* **EntityClass** + +## Index + +### Constructors + +* [constructor](../interfaces/_entities_factories_factory_.entityclass.md#constructor) + +### Methods + +* [generateId](../interfaces/_entities_factories_factory_.entityclass.md#generateid) +* [unserialize](../interfaces/_entities_factories_factory_.entityclass.md#unserialize) + +## Constructors + +### constructor + ++ **new EntityClass**\(`params`: T & U, `context`: [Context](../classes/_context_.context.md)\): [_Entity_](../classes/_entities_entity_.entity.md)_‹T›_ + +_Defined in_ [_src/entities/factories/Factory.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L8) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | T & U | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Entity_](../classes/_entities_entity_.entity.md)_‹T›_ + +## Methods + +### generateId + +▸ **generateId**\(`identifiers`: U\): _string_ + +_Defined in_ [_src/entities/factories/Factory.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L19) + +generate a unique identifier for an entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `identifiers` | U | + +**Returns:** _string_ + +### unserialize + +▸ **unserialize**\(`uid`: string\): _U_ + +_Defined in_ [_src/entities/factories/Factory.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L14) + +unserialize serialized entity information + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `uid` | string | + +**Returns:** _U_ + diff --git a/docs/api/external-modules/_entities_factories_factory_.factory.md b/docs/api/external-modules/_entities_factories_factory_.factory.md new file mode 100644 index 0000000..fa8da70 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_factory_.factory.md @@ -0,0 +1,162 @@ +# Factory + +Factories are tasked with creating instances of their corresponding Entity and managing the internal cache for that Entity type. So, for example, the Security Token Factory is tasked with fetching necessary data to instance a Security Token, as well as fetching/refreshing the internal Security Token cache + +## Type parameters + +▪ **EntityType**: [_Entity_](../classes/_entities_entity_.entity.md)_‹T›_ + +▪ **T**: _any_ + +▪ **U**: _any_ + +## Hierarchy + +* **Factory** + + ↳ [Erc20TokenBalanceFactory](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) + + ↳ [InvestmentFactory](../classes/_entities_factories_investmentfactory_.investmentfactory.md) + + ↳ [SimpleStoFactory](../classes/_entities_factories_simplestofactory_.simplestofactory.md) + + ↳ [TieredStoFactory](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) + + ↳ [TokenholderFactory](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + + ↳ [TaxWithholdingFactory](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + + ↳ [WalletFactory](../classes/_entities_factories_walletfactory_.walletfactory.md) + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_factory_.factory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_factory_.factory.md#entity) +* [cache](../classes/_entities_factories_factory_.factory.md#cache) +* [context](../classes/_entities_factories_factory_.factory.md#context) + +### Methods + +* [create](../classes/_entities_factories_factory_.factory.md#create) +* [fetch](../classes/_entities_factories_factory_.factory.md#fetch) +* [refresh](../classes/_entities_factories_factory_.factory.md#refresh) +* [update](../classes/_entities_factories_factory_.factory.md#update) + +## Constructors + +### constructor + ++ **new Factory**\(`eClass`: [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U›, `context`: [Context](../classes/_context_.context.md)\): [_Factory_](../classes/_entities_factories_factory_.factory.md) + +_Defined in_ [_src/entities/factories/Factory.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L42) + +Create a factory that can generate an entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `eClass` | [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md)‹T, U› | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Factory_](../classes/_entities_factories_factory_.factory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹T, U›_ + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: EntityType \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: T\): _EntityType_ + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | T | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹T›\): _Promise‹void›_ + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹T› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_factory_.md b/docs/api/external-modules/_entities_factories_factory_.md similarity index 78% rename from docs/api/modules/_entities_factories_factory_.md rename to docs/api/external-modules/_entities_factories_factory_.md index 9f4161b..4f80d68 100644 --- a/docs/api/modules/_entities_factories_factory_.md +++ b/docs/api/external-modules/_entities_factories_factory_.md @@ -1,4 +1,4 @@ -# External module: "entities/factories/Factory" +# entities/factories/Factory ## Index @@ -9,3 +9,4 @@ ### Interfaces * [EntityClass](../interfaces/_entities_factories_factory_.entityclass.md) + diff --git a/docs/api/external-modules/_entities_factories_index_.md b/docs/api/external-modules/_entities_factories_index_.md new file mode 100644 index 0000000..c6b5633 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_index_.md @@ -0,0 +1,2 @@ +# entities/factories/index + diff --git a/docs/api/external-modules/_entities_factories_investmentfactory_.investmentfactory.md b/docs/api/external-modules/_entities_factories_investmentfactory_.investmentfactory.md new file mode 100644 index 0000000..d4b095a --- /dev/null +++ b/docs/api/external-modules/_entities_factories_investmentfactory_.investmentfactory.md @@ -0,0 +1,157 @@ +# InvestmentFactory + +Factory generates information for an Investment entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[Investment](../classes/_entities_investment_.investment.md), [Params](../interfaces/_entities_investment_.params.md), [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)› + + ↳ **InvestmentFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_investmentfactory_.investmentfactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_investmentfactory_.investmentfactory.md#entity) +* [cache](../classes/_entities_factories_investmentfactory_.investmentfactory.md#cache) +* [context](../classes/_entities_factories_investmentfactory_.investmentfactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_investmentfactory_.investmentfactory.md#create) +* [fetch](../classes/_entities_factories_investmentfactory_.investmentfactory.md#fetch) +* [refresh](../classes/_entities_factories_investmentfactory_.investmentfactory.md#refresh) +* [update](../classes/_entities_factories_investmentfactory_.investmentfactory.md#update) + +## Constructors + +### constructor + ++ **new InvestmentFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_InvestmentFactory_](../classes/_entities_factories_investmentfactory_.investmentfactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/InvestmentFactory.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/InvestmentFactory.ts#L106) + +Create an instance of the Investment Factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_InvestmentFactory_](../classes/_entities_factories_investmentfactory_.investmentfactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_investment_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [Investment](../classes/_entities_investment_.investment.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_investment_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_investment_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_entities_factories_investmentfactory_.md b/docs/api/external-modules/_entities_factories_investmentfactory_.md new file mode 100644 index 0000000..9dc7fde --- /dev/null +++ b/docs/api/external-modules/_entities_factories_investmentfactory_.md @@ -0,0 +1,20 @@ +# entities/factories/InvestmentFactory + +## Index + +### Classes + +* [InvestmentFactory](../classes/_entities_factories_investmentfactory_.investmentfactory.md) + +### Variables + +* [weiToValue](_entities_factories_investmentfactory_.md#weitovalue) + +## Variables + +### weiToValue + +• **weiToValue**: _weiToValue_ + +_Defined in_ [_src/entities/factories/InvestmentFactory.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/InvestmentFactory.ts#L17) + diff --git a/docs/api/external-modules/_entities_factories_securitytokenfactory_.md b/docs/api/external-modules/_entities_factories_securitytokenfactory_.md new file mode 100644 index 0000000..87aefbb --- /dev/null +++ b/docs/api/external-modules/_entities_factories_securitytokenfactory_.md @@ -0,0 +1,2 @@ +# entities/factories/SecurityTokenFactory + diff --git a/docs/api/external-modules/_entities_factories_securitytokenreservationfactory_.md b/docs/api/external-modules/_entities_factories_securitytokenreservationfactory_.md new file mode 100644 index 0000000..b5a41b5 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_securitytokenreservationfactory_.md @@ -0,0 +1,2 @@ +# entities/factories/SecurityTokenReservationFactory + diff --git a/docs/api/modules/_entities_factories_simplestofactory_.md b/docs/api/external-modules/_entities_factories_simplestofactory_.md similarity index 66% rename from docs/api/modules/_entities_factories_simplestofactory_.md rename to docs/api/external-modules/_entities_factories_simplestofactory_.md index d201b2f..bc54045 100644 --- a/docs/api/modules/_entities_factories_simplestofactory_.md +++ b/docs/api/external-modules/_entities_factories_simplestofactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/SimpleStoFactory" +# entities/factories/SimpleStoFactory ## Index ### Classes * [SimpleStoFactory](../classes/_entities_factories_simplestofactory_.simplestofactory.md) + diff --git a/docs/api/external-modules/_entities_factories_simplestofactory_.simplestofactory.md b/docs/api/external-modules/_entities_factories_simplestofactory_.simplestofactory.md new file mode 100644 index 0000000..6b36166 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_simplestofactory_.simplestofactory.md @@ -0,0 +1,174 @@ +# SimpleStoFactory + +Factory generates information for a simple sto entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[SimpleSto](../classes/_entities_simplesto_.simplesto.md), [Params](../interfaces/_entities_simplesto_.params.md), [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)› + + ↳ **SimpleStoFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_simplestofactory_.simplestofactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_simplestofactory_.simplestofactory.md#entity) +* [cache](../classes/_entities_factories_simplestofactory_.simplestofactory.md#cache) +* [context](../classes/_entities_factories_simplestofactory_.simplestofactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_simplestofactory_.simplestofactory.md#create) +* [fetch](../classes/_entities_factories_simplestofactory_.simplestofactory.md#fetch) +* [generateProperties](../classes/_entities_factories_simplestofactory_.simplestofactory.md#protected-generateproperties) +* [refresh](../classes/_entities_factories_simplestofactory_.simplestofactory.md#refresh) +* [update](../classes/_entities_factories_simplestofactory_.simplestofactory.md#update) + +## Constructors + +### constructor + ++ **new SimpleStoFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_SimpleStoFactory_](../classes/_entities_factories_simplestofactory_.simplestofactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/SimpleStoFactory.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L79) + +Create an instance of the simple sto factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SimpleStoFactory_](../classes/_entities_factories_simplestofactory_.simplestofactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_simplesto_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [SimpleSto](../classes/_entities_simplesto_.simplesto.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_simplesto_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_simplesto_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### `Protected` generateProperties + +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ + +_Overrides void_ + +_Defined in_ [_src/entities/factories/SimpleStoFactory.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/SimpleStoFactory.ts#L12) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `uid` | string | + +**Returns:** _Promise‹object›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_taxwithholdingfactory_.md b/docs/api/external-modules/_entities_factories_taxwithholdingfactory_.md similarity index 67% rename from docs/api/modules/_entities_factories_taxwithholdingfactory_.md rename to docs/api/external-modules/_entities_factories_taxwithholdingfactory_.md index e2b1452..71dfdd6 100644 --- a/docs/api/modules/_entities_factories_taxwithholdingfactory_.md +++ b/docs/api/external-modules/_entities_factories_taxwithholdingfactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/TaxWithholdingFactory" +# entities/factories/TaxWithholdingFactory ## Index ### Classes * [TaxWithholdingFactory](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + diff --git a/docs/api/external-modules/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md b/docs/api/external-modules/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md new file mode 100644 index 0000000..fccc997 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md @@ -0,0 +1,157 @@ +# TaxWithholdingFactory + +Factory generates information for a Tax Withholding entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[TaxWithholding](../classes/_entities_taxwithholding_.taxwithholding.md), [Params](../interfaces/_entities_taxwithholding_.params.md), [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)› + + ↳ **TaxWithholdingFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#entity) +* [cache](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#cache) +* [context](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#create) +* [fetch](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#fetch) +* [refresh](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#refresh) +* [update](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md#update) + +## Constructors + +### constructor + ++ **new TaxWithholdingFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_TaxWithholdingFactory_](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/TaxWithholdingFactory.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TaxWithholdingFactory.ts#L71) + +Create an instance of the Tax Withholding Factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TaxWithholdingFactory_](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_taxwithholding_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [TaxWithholding](../classes/_entities_taxwithholding_.taxwithholding.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_taxwithholding_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_taxwithholding_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_tieredstofactory_.md b/docs/api/external-modules/_entities_factories_tieredstofactory_.md similarity index 66% rename from docs/api/modules/_entities_factories_tieredstofactory_.md rename to docs/api/external-modules/_entities_factories_tieredstofactory_.md index ca2d909..608a213 100644 --- a/docs/api/modules/_entities_factories_tieredstofactory_.md +++ b/docs/api/external-modules/_entities_factories_tieredstofactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/TieredStoFactory" +# entities/factories/TieredStoFactory ## Index ### Classes * [TieredStoFactory](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) + diff --git a/docs/api/external-modules/_entities_factories_tieredstofactory_.tieredstofactory.md b/docs/api/external-modules/_entities_factories_tieredstofactory_.tieredstofactory.md new file mode 100644 index 0000000..285eb40 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_tieredstofactory_.tieredstofactory.md @@ -0,0 +1,174 @@ +# TieredStoFactory + +Factory generates information for a tiered sto entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[TieredSto](../classes/_entities_tieredsto_.tieredsto.md), [Params](../interfaces/_entities_tieredsto_.params.md), [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md)› + + ↳ **TieredStoFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#entity) +* [cache](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#cache) +* [context](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#create) +* [fetch](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#fetch) +* [generateProperties](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#protected-generateproperties) +* [refresh](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#refresh) +* [update](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md#update) + +## Constructors + +### constructor + ++ **new TieredStoFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_TieredStoFactory_](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/TieredStoFactory.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L148) + +Create an instance of the tiered sto factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TieredStoFactory_](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_tieredsto_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [TieredSto](../classes/_entities_tieredsto_.tieredsto.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_tieredsto_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_tieredsto_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### `Protected` generateProperties + +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ + +_Overrides void_ + +_Defined in_ [_src/entities/factories/TieredStoFactory.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TieredStoFactory.ts#L13) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `uid` | string | + +**Returns:** _Promise‹object›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_tokenholderfactory_.md b/docs/api/external-modules/_entities_factories_tokenholderfactory_.md similarity index 67% rename from docs/api/modules/_entities_factories_tokenholderfactory_.md rename to docs/api/external-modules/_entities_factories_tokenholderfactory_.md index 6e13389..93759ef 100644 --- a/docs/api/modules/_entities_factories_tokenholderfactory_.md +++ b/docs/api/external-modules/_entities_factories_tokenholderfactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/TokenholderFactory" +# entities/factories/TokenholderFactory ## Index ### Classes * [TokenholderFactory](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + diff --git a/docs/api/external-modules/_entities_factories_tokenholderfactory_.tokenholderfactory.md b/docs/api/external-modules/_entities_factories_tokenholderfactory_.tokenholderfactory.md new file mode 100644 index 0000000..d975025 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_tokenholderfactory_.tokenholderfactory.md @@ -0,0 +1,157 @@ +# TokenholderFactory + +Factory generates information for a Tokenholder entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[Tokenholder](../classes/_entities_tokenholder_.tokenholder.md), [Params](../interfaces/_entities_tokenholder_.params.md), [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)› + + ↳ **TokenholderFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#entity) +* [cache](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#cache) +* [context](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#create) +* [fetch](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#fetch) +* [refresh](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#refresh) +* [update](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md#update) + +## Constructors + +### constructor + ++ **new TokenholderFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_TokenholderFactory_](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/TokenholderFactory.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/TokenholderFactory.ts#L61) + +Create an instance of the Tokenholder Factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TokenholderFactory_](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_tokenholder_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [Tokenholder](../classes/_entities_tokenholder_.tokenholder.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_tokenholder_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_tokenholder_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_entities_factories_walletfactory_.md b/docs/api/external-modules/_entities_factories_walletfactory_.md similarity index 66% rename from docs/api/modules/_entities_factories_walletfactory_.md rename to docs/api/external-modules/_entities_factories_walletfactory_.md index 07d8485..5d339a8 100644 --- a/docs/api/modules/_entities_factories_walletfactory_.md +++ b/docs/api/external-modules/_entities_factories_walletfactory_.md @@ -1,7 +1,8 @@ -# External module: "entities/factories/WalletFactory" +# entities/factories/WalletFactory ## Index ### Classes * [WalletFactory](../classes/_entities_factories_walletfactory_.walletfactory.md) + diff --git a/docs/api/external-modules/_entities_factories_walletfactory_.walletfactory.md b/docs/api/external-modules/_entities_factories_walletfactory_.walletfactory.md new file mode 100644 index 0000000..a24c279 --- /dev/null +++ b/docs/api/external-modules/_entities_factories_walletfactory_.walletfactory.md @@ -0,0 +1,174 @@ +# WalletFactory + +Factory to generate properties for a wallet entity + +## Hierarchy + +* [Factory](../classes/_entities_factories_factory_.factory.md)‹[Wallet](../classes/_entities_wallet_.wallet.md), [Params](../interfaces/_entities_wallet_.params.md), [UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md)› + + ↳ **WalletFactory** + +## Index + +### Constructors + +* [constructor](../classes/_entities_factories_walletfactory_.walletfactory.md#constructor) + +### Properties + +* [Entity](../classes/_entities_factories_walletfactory_.walletfactory.md#entity) +* [cache](../classes/_entities_factories_walletfactory_.walletfactory.md#cache) +* [context](../classes/_entities_factories_walletfactory_.walletfactory.md#context) + +### Methods + +* [create](../classes/_entities_factories_walletfactory_.walletfactory.md#create) +* [fetch](../classes/_entities_factories_walletfactory_.walletfactory.md#fetch) +* [generateProperties](../classes/_entities_factories_walletfactory_.walletfactory.md#protected-generateproperties) +* [refresh](../classes/_entities_factories_walletfactory_.walletfactory.md#refresh) +* [update](../classes/_entities_factories_walletfactory_.walletfactory.md#update) + +## Constructors + +### constructor + ++ **new WalletFactory**\(`context`: [Context](../classes/_context_.context.md)\): [_WalletFactory_](../classes/_entities_factories_walletfactory_.walletfactory.md) + +_Overrides_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_constructor_](../classes/_entities_factories_factory_.factory.md#constructor) + +_Defined in_ [_src/entities/factories/WalletFactory.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L15) + +Create a wallet factory + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_WalletFactory_](../classes/_entities_factories_walletfactory_.walletfactory.md) + +## Properties + +### Entity + +• **Entity**: [_EntityClass_](../interfaces/_entities_factories_factory_.entityclass.md)_‹_[_Params_](../interfaces/_entities_wallet_.params.md)_,_ [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md)_›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_Entity_](../classes/_entities_factories_factory_.factory.md#entity) + +_Defined in_ [_src/entities/factories/Factory.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L37) + +entity class that this Factory is in charge of generating and caching + +### cache + +• **cache**: _object_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_cache_](../classes/_entities_factories_factory_.factory.md#cache) + +_Defined in_ [_src/entities/factories/Factory.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L28) + +#### Type declaration: + +* \[ **key**: _string_\]: [Wallet](../classes/_entities_wallet_.wallet.md) \| undefined + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_context_](../classes/_entities_factories_factory_.factory.md#context) + +_Defined in_ [_src/entities/factories/Factory.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L32) + +## Methods + +### create + +▸ **create**\(`uid`: string, `params`: [Params](../interfaces/_entities_wallet_.params.md)\): _EntityType_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_create_](../classes/_entities_factories_factory_.factory.md#create) + +_Defined in_ [_src/entities/factories/Factory.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L87) + +Get an entity from the cache. Creates it if it isn't cached, updates it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | [Params](../interfaces/_entities_wallet_.params.md) | constructor data for the entity | + +**Returns:** _EntityType_ + +### fetch + +▸ **fetch**\(`uid`: string\): _Promise‹EntityType›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_fetch_](../classes/_entities_factories_factory_.factory.md#fetch) + +_Defined in_ [_src/entities/factories/Factory.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L57) + +Get an entity from the cache. Fetches the necessary data to create it if it isn't cached, refreshes it if it is + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹EntityType›_ + +### `Protected` generateProperties + +▸ **generateProperties**\(`uid`: string\): _Promise‹object›_ + +_Overrides void_ + +_Defined in_ [_src/entities/factories/WalletFactory.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/WalletFactory.ts#L9) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `uid` | string | + +**Returns:** _Promise‹object›_ + +### refresh + +▸ **refresh**\(`uid`: string\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_refresh_](../classes/_entities_factories_factory_.factory.md#refresh) + +_Defined in_ [_src/entities/factories/Factory.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L108) + +Fetch the data for an entity and updates its properties + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | + +**Returns:** _Promise‹void›_ + +### update + +▸ **update**\(`uid`: string, `params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›\): _Promise‹void›_ + +_Inherited from_ [_Factory_](../classes/_entities_factories_factory_.factory.md)_._[_update_](../classes/_entities_factories_factory_.factory.md#update) + +_Defined in_ [_src/entities/factories/Factory.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L126) + +Update an entity's properties in place + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `uid` | string | unique identifier for the entity | +| `params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | properties that should be updated | + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_entities_index_.md b/docs/api/external-modules/_entities_index_.md new file mode 100644 index 0000000..6627b26 --- /dev/null +++ b/docs/api/external-modules/_entities_index_.md @@ -0,0 +1,2 @@ +# entities/index + diff --git a/docs/api/external-modules/_entities_investment_.investment.md b/docs/api/external-modules/_entities_investment_.investment.md new file mode 100644 index 0000000..527cb9a --- /dev/null +++ b/docs/api/external-modules/_entities_investment_.investment.md @@ -0,0 +1,193 @@ +# Investment + +Used to manage an Investment in a Security Token Offering + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_investment_.params.md)› + + ↳ **Investment** + +## Index + +### Constructors + +* [constructor](../classes/_entities_investment_.investment.md#constructor) + +### Properties + +* [address](../classes/_entities_investment_.investment.md#address) +* [index](../classes/_entities_investment_.investment.md#index) +* [investedFunds](../classes/_entities_investment_.investment.md#investedfunds) +* [securityTokenId](../classes/_entities_investment_.investment.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_investment_.investment.md#securitytokensymbol) +* [stoId](../classes/_entities_investment_.investment.md#stoid) +* [tokenAmount](../classes/_entities_investment_.investment.md#tokenamount) +* [uid](../classes/_entities_investment_.investment.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_investment_.investment.md#_refresh) +* [toPojo](../classes/_entities_investment_.investment.md#topojo) +* [generateId](../classes/_entities_investment_.investment.md#static-generateid) +* [unserialize](../classes/_entities_investment_.investment.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Investment**\(`params`: [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md)\): [_Investment_](../classes/_entities_investment_.investment.md) + +_Defined in_ [_src/entities/Investment.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103) + +Create an Investment instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_investment_.params.md) & [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md) | + +**Returns:** [_Investment_](../classes/_entities_investment_.investment.md) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Investment.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L88) + +wallet address of token holder + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/Investment.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L93) + +index of the Investment + +### investedFunds + +• **investedFunds**: _BigNumber_ + +_Defined in_ [_src/entities/Investment.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L103) + +amount of funds used to make Investment + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Investment.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L76) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Investment.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L83) + +### stoId + +• **stoId**: _string_ + +_Defined in_ [_src/entities/Investment.ts:81_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L81) + +unique ID for the Investment + +### tokenAmount + +• **tokenAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Investment.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L98) + +total amount of tokens involved in the Investment + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Investment.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L74) + +unique generated identifier for an Investment + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_investment_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Investment.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L165) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_investment_.params.md)› | + +**Returns:** _void_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Investment.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L138) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **address**: _string_ +* **index**: _number_ +* **investedFunds**: _BigNumber_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **stoId**: _string_ +* **tokenAmount**: _BigNumber_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/Investment.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L45) + +Generate the Investment's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `index` | number | +| `securityTokenId` | string | +| `stoId` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Investment.ts:58_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L58) + +Unserialize a serialized Investment entity + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with Investment entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_investment_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_investment_.md b/docs/api/external-modules/_entities_investment_.md similarity index 85% rename from docs/api/modules/_entities_investment_.md rename to docs/api/external-modules/_entities_investment_.md index f6243ca..bf8ea6d 100644 --- a/docs/api/modules/_entities_investment_.md +++ b/docs/api/external-modules/_entities_investment_.md @@ -1,4 +1,4 @@ -# External module: "entities/Investment" +# entities/Investment ## Index @@ -10,3 +10,4 @@ * [Params](../interfaces/_entities_investment_.params.md) * [UniqueIdentifiers](../interfaces/_entities_investment_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_investment_.params.md b/docs/api/external-modules/_entities_investment_.params.md new file mode 100644 index 0000000..d174a1d --- /dev/null +++ b/docs/api/external-modules/_entities_investment_.params.md @@ -0,0 +1,43 @@ +# Params + +Constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [address](../interfaces/_entities_investment_.params.md#address) +* [investedFunds](../interfaces/_entities_investment_.params.md#investedfunds) +* [securityTokenSymbol](../interfaces/_entities_investment_.params.md#securitytokensymbol) +* [tokenAmount](../interfaces/_entities_investment_.params.md#tokenamount) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Investment.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L33) + +### investedFunds + +• **investedFunds**: _BigNumber_ + +_Defined in_ [_src/entities/Investment.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L35) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Investment.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L32) + +### tokenAmount + +• **tokenAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Investment.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L34) + diff --git a/docs/api/external-modules/_entities_investment_.uniqueidentifiers.md b/docs/api/external-modules/_entities_investment_.uniqueidentifiers.md new file mode 100644 index 0000000..1ccaacf --- /dev/null +++ b/docs/api/external-modules/_entities_investment_.uniqueidentifiers.md @@ -0,0 +1,36 @@ +# UniqueIdentifiers + +Properties that uniquely identify an Investment + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [index](../interfaces/_entities_investment_.uniqueidentifiers.md#index) +* [securityTokenId](../interfaces/_entities_investment_.uniqueidentifiers.md#securitytokenid) +* [stoId](../interfaces/_entities_investment_.uniqueidentifiers.md#stoid) + +## Properties + +### index + +• **index**: _number_ + +_Defined in_ [_src/entities/Investment.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L13) + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Investment.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L11) + +### stoId + +• **stoId**: _string_ + +_Defined in_ [_src/entities/Investment.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L12) + diff --git a/docs/api/external-modules/_entities_polytransaction_.event.md b/docs/api/external-modules/_entities_polytransaction_.event.md new file mode 100644 index 0000000..96758ff --- /dev/null +++ b/docs/api/external-modules/_entities_polytransaction_.event.md @@ -0,0 +1,16 @@ +# Event + +## Index + +### Enumeration members + +* [StatusChange](../enums/_entities_polytransaction_.event.md#statuschange) + +## Enumeration members + +### StatusChange + +• **StatusChange**: = "StatusChange" + +_Defined in_ [_src/entities/PolyTransaction.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L19) + diff --git a/docs/api/modules/_entities_polytransaction_.md b/docs/api/external-modules/_entities_polytransaction_.md similarity index 79% rename from docs/api/modules/_entities_polytransaction_.md rename to docs/api/external-modules/_entities_polytransaction_.md index 57f127d..830920d 100644 --- a/docs/api/modules/_entities_polytransaction_.md +++ b/docs/api/external-modules/_entities_polytransaction_.md @@ -1,4 +1,4 @@ -# External module: "entities/PolyTransaction" +# entities/PolyTransaction ## Index @@ -9,3 +9,4 @@ ### Classes * [PolyTransaction](../classes/_entities_polytransaction_.polytransaction.md) + diff --git a/docs/api/external-modules/_entities_polytransaction_.polytransaction.md b/docs/api/external-modules/_entities_polytransaction_.polytransaction.md new file mode 100644 index 0000000..61c089e --- /dev/null +++ b/docs/api/external-modules/_entities_polytransaction_.polytransaction.md @@ -0,0 +1,218 @@ +# PolyTransaction + +Wrapper class for a Polymath Transaction + +## Type parameters + +▪ **Args** + +▪ **Values**: _any\[\]_ + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹void› + + ↳ **PolyTransaction** + +## Index + +### Constructors + +* [constructor](../classes/_entities_polytransaction_.polytransaction.md#constructor) + +### Properties + +* [args](../classes/_entities_polytransaction_.polytransaction.md#args) +* [error](../classes/_entities_polytransaction_.polytransaction.md#optional-error) +* [promise](../classes/_entities_polytransaction_.polytransaction.md#promise) +* [receipt](../classes/_entities_polytransaction_.polytransaction.md#optional-receipt) +* [status](../classes/_entities_polytransaction_.polytransaction.md#status) +* [tag](../classes/_entities_polytransaction_.polytransaction.md#tag) +* [transactionQueue](../classes/_entities_polytransaction_.polytransaction.md#transactionqueue) +* [txHash](../classes/_entities_polytransaction_.polytransaction.md#optional-txhash) +* [uid](../classes/_entities_polytransaction_.polytransaction.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_polytransaction_.polytransaction.md#_refresh) +* [onStatusChange](../classes/_entities_polytransaction_.polytransaction.md#onstatuschange) +* [run](../classes/_entities_polytransaction_.polytransaction.md#run) +* [toPojo](../classes/_entities_polytransaction_.polytransaction.md#topojo) +* [generateId](../classes/_entities_polytransaction_.polytransaction.md#static-generateid) + +## Constructors + +### constructor + ++ **new PolyTransaction**\(`transaction`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs \| string›, `transactionQueue`: [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹any, any›\): [_PolyTransaction_](../classes/_entities_polytransaction_.polytransaction.md) + +_Defined in_ [_src/entities/PolyTransaction.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L114) + +Creates a poly transaction + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `transaction` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)‹Args, Values, TransactionReceiptWithDecodedLogs \| string› | +| `transactionQueue` | [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹any, any› | + +**Returns:** [_PolyTransaction_](../classes/_entities_polytransaction_.polytransaction.md) + +## Properties + +### args + +• **args**: _TransactionSpec\["args"\]_ + +_Defined in_ [_src/entities/PolyTransaction.ts:89_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L89) + +arguments with which the transaction will be called + +### `Optional` error + +• **error**? : [_PolymathError_](../classes/_polymatherror_.polymatherror.md) + +_Defined in_ [_src/entities/PolyTransaction.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L69) + +stores errors thrown while running the transaction \(if any\) + +### promise + +• **promise**: _Promise‹any›_ + +_Defined in_ [_src/entities/PolyTransaction.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L64) + +internal promise that resolves when the transaction has finished running + +### `Optional` receipt + +• **receipt**? : _TransactionReceiptWithDecodedLogs \| string_ + +_Defined in_ [_src/entities/PolyTransaction.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L74) + +stores the transaction receipt \(if successful\) + +### status + +• **status**: [_TransactionStatus_](../enums/_types_index_.transactionstatus.md) = TransactionStatus.Idle + +_Defined in_ [_src/entities/PolyTransaction.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L54) + +current status of the transaction + +### tag + +• **tag**: [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) + +_Defined in_ [_src/entities/PolyTransaction.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L79) + +type of transaction represented by this instance for display purposes + +### transactionQueue + +• **transactionQueue**: [_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md) + +_Defined in_ [_src/entities/PolyTransaction.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L59) + +transaction queue to which this transaction belongs + +### `Optional` txHash + +• **txHash**? : _undefined \| string_ + +_Defined in_ [_src/entities/PolyTransaction.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L84) + +transaction hash \(available after running\) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/PolyTransaction.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L49) + +unique generated identifier of the poly transaction + +## Methods + +### \_refresh + +▸ **\_refresh**\(\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/PolyTransaction.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L330) + +Hydrate the entity + +**Returns:** _void_ + +### onStatusChange + +▸ **onStatusChange**\(`listener`: function\): _\(Anonymous function\)_ + +_Defined in_ [_src/entities/PolyTransaction.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L203) + +Subscribe to status changes + +**Parameters:** + +▪ **listener**: _function_ + +callback function that will be called whenever the status changes + +▸ \(`transaction`: this\): _void_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `transaction` | this | + +**Returns:** _\(Anonymous function\)_ + +unsubscribe function + +### run + +▸ **run**\(\): _Promise‹void›_ + +_Defined in_ [_src/entities/PolyTransaction.ts:171_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L171) + +Run the poly transaction and update the transaction status + +**Returns:** _Promise‹void›_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/PolyTransaction.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L144) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **args**: _any_ = filteredArgs as any +* **error**: _undefined \|_ [_PolymathError_](../classes/_polymatherror_.polymatherror.md) +* **receipt**: _undefined \| string \| TransactionReceiptWithDecodedLogs_ +* **status**: [_TransactionStatus_](../enums/_types_index_.transactionstatus.md) +* **tag**: [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) +* **transactionQueueUid**: _string_ +* **txHash**: _undefined \| string_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(\): _string_ + +_Defined in_ [_src/entities/PolyTransaction.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/PolyTransaction.ts#L40) + +Generate the Poly Transaction's UUID from its identifying properties + +**Returns:** _string_ + diff --git a/docs/api/external-modules/_entities_securitytoken_controller_.controller.md b/docs/api/external-modules/_entities_securitytoken_controller_.controller.md new file mode 100644 index 0000000..ec6a917 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_controller_.controller.md @@ -0,0 +1,159 @@ +# Controller + +Namespace that handles all Controller related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Controller** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_controller_.controller.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_controller_.controller.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_controller_.controller.md#protected-securitytoken) + +### Methods + +* [disable](../classes/_entities_securitytoken_controller_.controller.md#disable) +* [modifyController](../classes/_entities_securitytoken_controller_.controller.md#modifycontroller) +* [redeem](../classes/_entities_securitytoken_controller_.controller.md#redeem) +* [signDisableAck](../classes/_entities_securitytoken_controller_.controller.md#signdisableack) +* [transfer](../classes/_entities_securitytoken_controller_.controller.md#transfer) + +## Constructors + +### constructor + ++ **new Controller**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Controller_](../classes/_entities_securitytoken_controller_.controller.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Controller_](../classes/_entities_securitytoken_controller_.controller.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### disable + +▸ **disable**\(`args?`: undefined \| object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Controller.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L33) + +Permanently disable controller functionality + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md)_, void››_ + +### modifyController + +▸ **modifyController**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Controller.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L20) + +Set the address of the Security Token's Controller. The controller may perform forced transfers + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `controller` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md)_, void››_ + +### redeem + +▸ **redeem**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Controller.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L77) + +Redeem \(burn\) an amount of tokens from a token holder. Only the Security Token's controller can call this This operation is subject to transfer restrictions and the amount is limited by the token holder's balance. `balanceOf(tokenHolder)` tokens\) and potentially also need to respect other transfer restrictions. + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from` | string | +| `reason?` | undefined \| string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md)_, void››_ + +### signDisableAck + +▸ **signDisableAck**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Controller.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L95) + +Generate a signature string that can be used to permanently disable the Security Token's controller functionality + +**Note that only the owner's signature is valid for this operation** + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)_, void››_ + +### transfer + +▸ **transfer**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Controller.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Controller.ts#L49) + +Perform a forced transfer of tokens from one address to another. You must be the Security Token's controller to do this + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from` | string | +| `reason?` | undefined \| string | +| `to` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md)_, void››_ + diff --git a/docs/api/modules/_entities_securitytoken_controller_.md b/docs/api/external-modules/_entities_securitytoken_controller_.md similarity index 64% rename from docs/api/modules/_entities_securitytoken_controller_.md rename to docs/api/external-modules/_entities_securitytoken_controller_.md index 6b7d472..483a34e 100644 --- a/docs/api/modules/_entities_securitytoken_controller_.md +++ b/docs/api/external-modules/_entities_securitytoken_controller_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Controller" +# entities/SecurityToken/Controller ## Index ### Classes * [Controller](../classes/_entities_securitytoken_controller_.controller.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_dividends_.dividends.md b/docs/api/external-modules/_entities_securitytoken_dividends_.dividends.md new file mode 100644 index 0000000..5cc9e6b --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_dividends_.dividends.md @@ -0,0 +1,231 @@ +# Dividends + +Namespace that handles all Dividend related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Dividends** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_dividends_.dividends.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_dividends_.dividends.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_dividends_.dividends.md#protected-securitytoken) + +### Methods + +* [createErc20Distribution](../classes/_entities_securitytoken_dividends_.dividends.md#createerc20distribution) +* [createPolyDistribution](../classes/_entities_securitytoken_dividends_.dividends.md#createpolydistribution) +* [getDefaultExclusionList](../classes/_entities_securitytoken_dividends_.dividends.md#getdefaultexclusionlist) +* [getDistribution](../classes/_entities_securitytoken_dividends_.dividends.md#getdistribution) +* [getDistributions](../classes/_entities_securitytoken_dividends_.dividends.md#getdistributions) +* [getTaxWithholdingList](../classes/_entities_securitytoken_dividends_.dividends.md#gettaxwithholdinglist) +* [modifyDefaultExclusionList](../classes/_entities_securitytoken_dividends_.dividends.md#modifydefaultexclusionlist) +* [modifyStorageWallet](../classes/_entities_securitytoken_dividends_.dividends.md#modifystoragewallet) +* [modifyTaxWithholdingList](../classes/_entities_securitytoken_dividends_.dividends.md#modifytaxwithholdinglist) + +## Constructors + +### constructor + ++ **new Dividends**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Dividends_](../classes/_entities_securitytoken_dividends_.dividends.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Dividends_](../classes/_entities_securitytoken_dividends_.dividends.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### createErc20Distribution + +▸ **createErc20Distribution**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L79) + +Distribute dividends in a specified ERC20 token + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `checkpointId` | string | +| `erc20Address` | string | +| `excludedAddresses?` | string\[\] | +| `expiryDate` | Date | +| `maturityDate` | Date | +| `name` | string | +| `taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_››_ + +### createPolyDistribution + +▸ **createPolyDistribution**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L40) + +Distribute dividends in POLY + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `checkpointId` | string | +| `excludedAddresses?` | string\[\] | +| `expiryDate` | Date | +| `maturityDate` | Date | +| `name` | string | +| `taxWithholdings?` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md)_,_ [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_››_ + +### getDefaultExclusionList + +▸ **getDefaultExclusionList**\(\): _Promise‹string\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:278_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L278) + +Retrieve the list of addresses which are excluded from receiving dividend payments by default + +**Returns:** _Promise‹string\[\]›_ + +### getDistribution + +▸ **getDistribution**\(`args`: [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) \| string\): _Promise‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L254) + +Retrieve a particular dividend distribution by type and index or UUID + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) \| string | dividend uuid or object containing its index | + +**Returns:** _Promise‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_›_ + +### getDistributions + +▸ **getDistributions**\(`args`: object\): _Promise‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L222) + +Retrieve all dividend distributions at a certain checkpoint + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `checkpointId` | string | + +**Returns:** _Promise‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_\[\]›_ + +### getTaxWithholdingList + +▸ **getTaxWithholdingList**\(\): _Promise‹_[_TaxWithholding_](../classes/_entities_taxwithholding_.taxwithholding.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:169_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L169) + +Retrieve a list of investor addresses and their corresponding tax withholding percentages + +**Returns:** _Promise‹_[_TaxWithholding_](../classes/_entities_taxwithholding_.taxwithholding.md)_\[\]›_ + +### modifyDefaultExclusionList + +▸ **modifyDefaultExclusionList**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L152) + +Set default exclusion list for a type of dividends. Addresses on this list won't be considered for dividend distribution. This operation overrides the previous default exclusion list + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenholderAddresses` | string\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)_, void››_ + +### modifyStorageWallet + +▸ **modifyStorageWallet**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L135) + +Change dividends storage wallet address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md)_, void››_ + +### modifyTaxWithholdingList + +▸ **modifyTaxWithholdingList**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L109) + +Set default tax withtholding list for a type of dividends + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `taxWithholdings` | [TaxWithholdingEntry](../interfaces/_types_index_.taxwithholdingentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)_, void››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_dividends_.getdistributionparams.md b/docs/api/external-modules/_entities_securitytoken_dividends_.getdistributionparams.md new file mode 100644 index 0000000..abc5b1b --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_dividends_.getdistributionparams.md @@ -0,0 +1,24 @@ +# GetDistributionParams + +Parameters of the [getDistribution](../classes/_entities_securitytoken_dividends_.dividends.md#getdistribution) function + +## Hierarchy + +* **GetDistributionParams** + +## Index + +### Properties + +* [dividendIndex](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md#dividendindex) + +## Properties + +### dividendIndex + +• **dividendIndex**: _number_ + +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L22) + +dividend distribution representation + diff --git a/docs/api/modules/_entities_securitytoken_dividends_.md b/docs/api/external-modules/_entities_securitytoken_dividends_.md similarity index 80% rename from docs/api/modules/_entities_securitytoken_dividends_.md rename to docs/api/external-modules/_entities_securitytoken_dividends_.md index 610f00d..858828e 100644 --- a/docs/api/modules/_entities_securitytoken_dividends_.md +++ b/docs/api/external-modules/_entities_securitytoken_dividends_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Dividends" +# entities/SecurityToken/Dividends ## Index @@ -9,3 +9,4 @@ ### Interfaces * [GetDistributionParams](../interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_documents_.document.md b/docs/api/external-modules/_entities_securitytoken_documents_.document.md new file mode 100644 index 0000000..415882b --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_documents_.document.md @@ -0,0 +1,49 @@ +# Document + +Represents a single Document attached to a Security Token + +## Hierarchy + +* **Document** + +## Index + +### Properties + +* [documentHash](../interfaces/_entities_securitytoken_documents_.document.md#documenthash) +* [documentUri](../interfaces/_entities_securitytoken_documents_.document.md#documenturi) +* [name](../interfaces/_entities_securitytoken_documents_.document.md#name) +* [updatedAt](../interfaces/_entities_securitytoken_documents_.document.md#updatedat) + +## Properties + +### documentHash + +• **documentHash**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L22) + +hash of the document's contents + +### documentUri + +• **documentUri**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L18) + +off-chain uri of the document from where it is accessible to investors/advisors to read + +### name + +• **name**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L14) + +name of the document. It should always be unique + +### updatedAt + +• **updatedAt**: _Date_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L23) + diff --git a/docs/api/external-modules/_entities_securitytoken_documents_.documents.md b/docs/api/external-modules/_entities_securitytoken_documents_.documents.md new file mode 100644 index 0000000..a92b6af --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_documents_.documents.md @@ -0,0 +1,135 @@ +# Documents + +Namespace that handles all document Related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Documents** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_documents_.documents.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_documents_.documents.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_documents_.documents.md#protected-securitytoken) + +### Methods + +* [getAllDocuments](../classes/_entities_securitytoken_documents_.documents.md#getalldocuments) +* [getDocument](../classes/_entities_securitytoken_documents_.documents.md#getdocument) +* [remove](../classes/_entities_securitytoken_documents_.documents.md#remove) +* [set](../classes/_entities_securitytoken_documents_.documents.md#set) + +## Constructors + +### constructor + ++ **new Documents**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Documents_](../classes/_entities_securitytoken_documents_.documents.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Documents_](../classes/_entities_securitytoken_documents_.documents.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### getAllDocuments + +▸ **getAllDocuments**\(\): _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L90) + +Retrieve an array of all the documents attached to the security token + +**Returns:** _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_\[\]›_ + +### getDocument + +▸ **getDocument**\(`args`: object\): _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L61) + +Retrieve a specific document's data by name + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `name` | string | + +**Returns:** _Promise‹_[_Document_](../interfaces/_entities_securitytoken_documents_.document.md)_›_ + +### remove + +▸ **remove**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L50) + +Remove an existing document from the Security Token + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | Description | +| :--- | :--- | :--- | +| `name` | string | should always be unique | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md)_, void››_ + +### set + +▸ **set**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Documents.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L37) + +Attach a new document to the contract, or update the URI or hash of an existing attached document + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | Description | +| :--- | :--- | :--- | +| `documentHash` | string | hash of the document's contents | +| `name` | string | should always be unique | +| `uri` | string | off-chain uri of the document from where it is accessible to investors/advisors to read | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md)_, void››_ + diff --git a/docs/api/modules/_entities_securitytoken_documents_.md b/docs/api/external-modules/_entities_securitytoken_documents_.md similarity index 77% rename from docs/api/modules/_entities_securitytoken_documents_.md rename to docs/api/external-modules/_entities_securitytoken_documents_.md index b44bd8f..a8166e8 100644 --- a/docs/api/modules/_entities_securitytoken_documents_.md +++ b/docs/api/external-modules/_entities_securitytoken_documents_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Documents" +# entities/SecurityToken/Documents ## Index @@ -9,3 +9,4 @@ ### Interfaces * [Document](../interfaces/_entities_securitytoken_documents_.document.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.enable.md b/docs/api/external-modules/_entities_securitytoken_features_.enable.md new file mode 100644 index 0000000..1e9bd9a --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.enable.md @@ -0,0 +1,84 @@ +# Enable + +## Hierarchy + +* **Enable** + +## Callable + +▸ \(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralPermissionManagerProcedureArgs_](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L53) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Permissions](../enums/_types_index_.feature.md#permissions) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralPermissionManagerProcedureArgs_](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md)_››_ + +▸ \(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralTransferManagerProcedureArgs_](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L56) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Tokenholders](../enums/_types_index_.feature.md#tokenholders) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralTransferManagerProcedureArgs_](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md)_››_ + +▸ \(`args`: object, `opts`: [EnableErc20DividendsOpts](../interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableDividendManagerProcedureArgs_](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L59) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Dividends](../enums/_types_index_.feature.md#dividends) | + +▪ **opts**: [_EnableErc20DividendsOpts_](../interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md) + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableDividendManagerProcedureArgs_](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md)_››_ + +▸ \(`args`: object, `opts`: [EnableTokenholderCountRestrictionsOpts](../interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableCountTransferManagerProcedureArgs_](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L62) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [TokenholderCountRestrictions](../enums/_types_index_.feature.md#tokenholdercountrestrictions) | + +▪ **opts**: [_EnableTokenholderCountRestrictionsOpts_](../interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableCountTransferManagerProcedureArgs_](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md)_››_ + +▸ \(`args`: object, `opts`: [EnablePercentageOwnershipRestrictionsOpts](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnablePercentageTransferManagerProcedureArgs_](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:66_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L66) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [PercentageOwnershipRestrictions](../enums/_types_index_.feature.md#percentageownershiprestrictions) | + +▪ **opts**: [_EnablePercentageOwnershipRestrictionsOpts_](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md) + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnablePercentageTransferManagerProcedureArgs_](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md)_››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.enableerc20dividendsopts.md b/docs/api/external-modules/_entities_securitytoken_features_.enableerc20dividendsopts.md new file mode 100644 index 0000000..2263a40 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.enableerc20dividendsopts.md @@ -0,0 +1,20 @@ +# EnableErc20DividendsOpts + +## Hierarchy + +* **EnableErc20DividendsOpts** + +## Index + +### Properties + +* [storageWalletAddress](../interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md#storagewalletaddress) + +## Properties + +### storageWalletAddress + +• **storageWalletAddress**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L41) + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md b/docs/api/external-modules/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md new file mode 100644 index 0000000..02c5aab --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md @@ -0,0 +1,27 @@ +# EnablePercentageOwnershipRestrictionsOpts + +## Hierarchy + +* **EnablePercentageOwnershipRestrictionsOpts** + +## Index + +### Properties + +* [allowPrimaryIssuance](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md#optional-allowprimaryissuance) +* [maxHolderPercentage](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md#maxholderpercentage) + +## Properties + +### `Optional` allowPrimaryIssuance + +• **allowPrimaryIssuance**? : _undefined \| false \| true_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L50) + +### maxHolderPercentage + +• **maxHolderPercentage**: _BigNumber_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L49) + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md b/docs/api/external-modules/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md new file mode 100644 index 0000000..a31f8ec --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md @@ -0,0 +1,20 @@ +# EnableTokenholderCountRestrictionsOpts + +## Hierarchy + +* **EnableTokenholderCountRestrictionsOpts** + +## Index + +### Properties + +* [maxHolderCount](../interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md#maxholdercount) + +## Properties + +### maxHolderCount + +• **maxHolderCount**: _number_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L45) + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.features.md b/docs/api/external-modules/_entities_securitytoken_features_.features.md new file mode 100644 index 0000000..9395fcd --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.features.md @@ -0,0 +1,159 @@ +# Features + +Namespace that handles all Feature related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Features** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_features_.features.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_features_.features.md#protected-context) +* [list](../classes/_entities_securitytoken_features_.features.md#list) +* [securityToken](../classes/_entities_securitytoken_features_.features.md#protected-securitytoken) + +### Methods + +* [disable](../classes/_entities_securitytoken_features_.features.md#disable) +* [enable](../classes/_entities_securitytoken_features_.features.md#enable) +* [getModuleNameFromFeature](../classes/_entities_securitytoken_features_.features.md#private-getmodulenamefromfeature) +* [getStatus](../classes/_entities_securitytoken_features_.features.md#getstatus) +* [isEnabled](../classes/_entities_securitytoken_features_.features.md#isenabled) + +## Constructors + +### constructor + ++ **new Features**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Features_](../classes/_entities_securitytoken_features_.features.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Features_](../classes/_entities_securitytoken_features_.features.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### list + +• **list**: [_Feature_](../enums/_types_index_.feature.md)_\[\]_ = \[ Feature.Permissions, Feature.Tokenholders, Feature.Dividends, Feature.TokenholderCountRestrictions, Feature.PercentageOwnershipRestrictions, \] + +_Defined in_ [_src/entities/SecurityToken/Features.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L80) + +List of all existing features + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### disable + +▸ **disable**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:213_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L213) + +Disable a feature + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md)_››_ + +### enable + +▸ **enable**\(`args`: object, `opts?`: [EnableOpts](_entities_securitytoken_features_.md#enableopts)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L138) + +Enable a feature + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | + +▪`Optional` **opts**: [_EnableOpts_](_entities_securitytoken_features_.md#enableopts) + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_›_ + +### `Private` getModuleNameFromFeature + +▸ **getModuleNameFromFeature**\(`feature`: [Feature](../enums/_types_index_.feature.md)\): _ModuleName_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L240) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | + +**Returns:** _ModuleName_ + +### getStatus + +▸ **getStatus**\(\): _Promise‹_[_FeatureStatuses_](../interfaces/_entities_securitytoken_features_.featurestatuses.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L111) + +Gets the status on all Security Token features \(true = enabled, false = not enabled/disabled\) + +**Returns:** _Promise‹_[_FeatureStatuses_](../interfaces/_entities_securitytoken_features_.featurestatuses.md)_›_ + +### isEnabled + +▸ **isEnabled**\(`args`: object\): _Promise‹boolean›_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L93) + +Returns whether a particular feature has been enabled or not + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `feature` | [Feature](../enums/_types_index_.feature.md) | + +**Returns:** _Promise‹boolean›_ + diff --git a/docs/api/external-modules/_entities_securitytoken_features_.featurestatuses.md b/docs/api/external-modules/_entities_securitytoken_features_.featurestatuses.md new file mode 100644 index 0000000..8138b49 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_features_.featurestatuses.md @@ -0,0 +1,50 @@ +# FeatureStatuses + +Current status \(enabled/disabled\) of all Security Token Features + +## Hierarchy + +* **FeatureStatuses** + +## Index + +### Properties + +* [\[Feature.Dividends\]](../interfaces/_entities_securitytoken_features_.featurestatuses.md#[feature.dividends]) +* [\[Feature.PercentageOwnershipRestrictions\]](../interfaces/_entities_securitytoken_features_.featurestatuses.md#[feature.percentageownershiprestrictions]) +* [\[Feature.Permissions\]](../interfaces/_entities_securitytoken_features_.featurestatuses.md#[feature.permissions]) +* [\[Feature.TokenholderCountRestrictions\]](../interfaces/_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholdercountrestrictions]) +* [\[Feature.Tokenholders\]](../interfaces/_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholders]) + +## Properties + +### \[Feature.Dividends\] + +• **\[Feature.Dividends\]**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L30) + +### \[Feature.PercentageOwnershipRestrictions\] + +• **\[Feature.PercentageOwnershipRestrictions\]**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L32) + +### \[Feature.Permissions\] + +• **\[Feature.Permissions\]**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L28) + +### \[Feature.TokenholderCountRestrictions\] + +• **\[Feature.TokenholderCountRestrictions\]**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L31) + +### \[Feature.Tokenholders\] + +• **\[Feature.Tokenholders\]**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L29) + diff --git a/docs/api/modules/_entities_securitytoken_features_.md b/docs/api/external-modules/_entities_securitytoken_features_.md similarity index 54% rename from docs/api/modules/_entities_securitytoken_features_.md rename to docs/api/external-modules/_entities_securitytoken_features_.md index c5b21d7..25e0286 100644 --- a/docs/api/modules/_entities_securitytoken_features_.md +++ b/docs/api/external-modules/_entities_securitytoken_features_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Features" +# entities/SecurityToken/Features ## Index @@ -20,8 +20,9 @@ ## Type aliases -### EnableOpts +### EnableOpts -Ƭ **EnableOpts**: *[EnableErc20DividendsOpts](../interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md) | [EnableTokenholderCountRestrictionsOpts](../interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) | [EnablePercentageOwnershipRestrictionsOpts](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md)* +Ƭ **EnableOpts**: [_EnableErc20DividendsOpts_](../interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md) _\|_ [_EnableTokenholderCountRestrictionsOpts_](../interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) _\|_ [_EnablePercentageOwnershipRestrictionsOpts_](../interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md) + +_Defined in_ [_src/entities/SecurityToken/Features.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L35) -*Defined in [src/entities/SecurityToken/Features.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L35)* diff --git a/docs/api/external-modules/_entities_securitytoken_index_.md b/docs/api/external-modules/_entities_securitytoken_index_.md new file mode 100644 index 0000000..91614e2 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_index_.md @@ -0,0 +1,2 @@ +# entities/SecurityToken/index + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_index_.md b/docs/api/external-modules/_entities_securitytoken_issuance_index_.md new file mode 100644 index 0000000..b08e877 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_index_.md @@ -0,0 +1,2 @@ +# entities/SecurityToken/Issuance/index + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_issuance_.issuance.md b/docs/api/external-modules/_entities_securitytoken_issuance_issuance_.issuance.md new file mode 100644 index 0000000..67f85bd --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_issuance_.issuance.md @@ -0,0 +1,132 @@ +# Issuance + +Namespace that handles all Issuance related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Issuance** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#protected-context) +* [offerings](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#offerings) +* [securityToken](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#protected-securitytoken) + +### Methods + +* [allowed](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#allowed) +* [freeze](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#freeze) +* [issue](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#issue) +* [signFreezeAck](../classes/_entities_securitytoken_issuance_issuance_.issuance.md#signfreezeack) + +## Constructors + +### constructor + ++ **new Issuance**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Issuance_](../classes/_entities_securitytoken_issuance_issuance_.issuance.md) + +_Overrides_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14) + +Create a new Issuance instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Issuance_](../classes/_entities_securitytoken_issuance_issuance_.issuance.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### offerings + +• **offerings**: [_Offerings_](../classes/_entities_securitytoken_issuance_offerings_.offerings.md) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L14) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### allowed + +▸ **allowed**\(\): _Promise‹Boolean›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L73) + +Retrieve whether the issuance of tokens is allowed or not Can be permanently frozen with `freeze` + +**Returns:** _Promise‹Boolean›_ + +### freeze + +▸ **freeze**\(`args?`: undefined \| object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L48) + +Permanently freeze issuance of the security token + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md)_, void››_ + +### issue + +▸ **issue**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L32) + +Issue a certain amount of tokens to an address. The address must already have been added via `modifyData`. Otherwise, the corresponding tokenholder data for that address must be supplied to this method **NOTE: If tokenholder data is supplied, client-side validations to verify if the transfer is possible won't be performed** + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `issuanceData` | [IssuanceDataEntry](../interfaces/_types_index_.issuancedataentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + +### signFreezeAck + +▸ **signFreezeAck**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Issuance.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Issuance.ts#L61) + +Generate a signature string that can be used to permanently freeze issuance of the Security Token + +**Note that only the owner's signature is valid for this operation** + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)_, void››_ + diff --git a/docs/api/modules/_entities_securitytoken_issuance_issuance_.md b/docs/api/external-modules/_entities_securitytoken_issuance_issuance_.md similarity index 62% rename from docs/api/modules/_entities_securitytoken_issuance_issuance_.md rename to docs/api/external-modules/_entities_securitytoken_issuance_issuance_.md index 1b20862..7d790e8 100644 --- a/docs/api/modules/_entities_securitytoken_issuance_issuance_.md +++ b/docs/api/external-modules/_entities_securitytoken_issuance_issuance_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Issuance/Issuance" +# entities/SecurityToken/Issuance/Issuance ## Index ### Classes * [Issuance](../classes/_entities_securitytoken_issuance_issuance_.issuance.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstomethod.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstomethod.md new file mode 100644 index 0000000..eb3017e --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstomethod.md @@ -0,0 +1,50 @@ +# GetStoMethod + +## Hierarchy + +* **GetStoMethod** + +## Callable + +▸ \(`args`: object\): _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L149) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | +| `stoType` | [Simple](../enums/_types_index_.stotype.md#simple) | + +**Returns:** _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_›_ + +▸ \(`args`: object\): _Promise‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L150) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | +| `stoType` | [Tiered](../enums/_types_index_.stotype.md#tiered) | + +**Returns:** _Promise‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ + +▸ \(`args`: string\): _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L151) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | string | + +**Returns:** _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstoparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstoparams.md new file mode 100644 index 0000000..e647643 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.getstoparams.md @@ -0,0 +1,29 @@ +# GetStoParams + +Params for [getSto](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#getsto) + +## Hierarchy + +* **GetStoParams** + +## Index + +### Properties + +* [address](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md#address) +* [stoType](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md#stotype) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L52) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L51) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md new file mode 100644 index 0000000..d0feece --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md @@ -0,0 +1,35 @@ +# LaunchTieredStoCustomCurrencyBothNoStableCoinParams + +## Hierarchy + +* object + + ↳ **LaunchTieredStoCustomCurrencyBothNoStableCoinParams** + +## Index + +### Properties + +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md#customcurrency) + +## Properties + +### currencies + +• **currencies**: [_EthAndPoly_](_entities_securitytoken_issuance_offerings_.md#ethandpoly) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L114) + +### customCurrency + +• **customCurrency**: _object_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:115_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L115) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ +* **polyOracleAddress**: _string_ + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md new file mode 100644 index 0000000..0d19d7f --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md @@ -0,0 +1,120 @@ +# LaunchTieredStoCustomCurrencyBothParams + +## Hierarchy + +* [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) + + ↳ **LaunchTieredStoCustomCurrencyBothParams** + +## Index + +### Properties + +* [allowPreIssuance](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#optional-allowpreissuance) +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#customcurrency) +* [endDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#enddate) +* [minimumInvestment](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#nonaccreditedinvestmentlimit) +* [raisedFundsWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#raisedfundswallet) +* [stableCoinAddresses](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#stablecoinaddresses) +* [startDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#startdate) +* [tiers](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#tiers) +* [unsoldTokensWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuance + +• **allowPreIssuance**? : _undefined \| false \| true_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) + +### currencies + +• **currencies**: [_AllCurrencies_](_entities_securitytoken_issuance_offerings_.md#allcurrencies) + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L103) + +### customCurrency + +• **customCurrency**: _object_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L104) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ +* **polyOracleAddress**: _string_ + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L109) + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) + +### tiers + +• **tiers**: [_StoTier_](../interfaces/_types_index_.stotier.md)_\[\]_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md new file mode 100644 index 0000000..5b8370d --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md @@ -0,0 +1,34 @@ +# LaunchTieredStoCustomCurrencyEthNoStableCoinParams + +## Hierarchy + +* object + + ↳ **LaunchTieredStoCustomCurrencyEthNoStableCoinParams** + +## Index + +### Properties + +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md#customcurrency) + +## Properties + +### currencies + +• **currencies**: [_OnlyEth_](_entities_securitytoken_issuance_offerings_.md#onlyeth) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L77) + +### customCurrency + +• **customCurrency**: _object_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:78_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L78) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md new file mode 100644 index 0000000..39a7280 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md @@ -0,0 +1,119 @@ +# LaunchTieredStoCustomCurrencyEthParams + +## Hierarchy + +* [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) + + ↳ **LaunchTieredStoCustomCurrencyEthParams** + +## Index + +### Properties + +* [allowPreIssuance](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#optional-allowpreissuance) +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#customcurrency) +* [endDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#enddate) +* [minimumInvestment](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#nonaccreditedinvestmentlimit) +* [raisedFundsWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#raisedfundswallet) +* [stableCoinAddresses](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#stablecoinaddresses) +* [startDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#startdate) +* [tiers](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#tiers) +* [unsoldTokensWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuance + +• **allowPreIssuance**? : _undefined \| false \| true_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) + +### currencies + +• **currencies**: [_OnlyEth_](_entities_securitytoken_issuance_offerings_.md#onlyeth) _\|_ [_EthAndStableCoin_](_entities_securitytoken_issuance_offerings_.md#ethandstablecoin) + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:67_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L67) + +### customCurrency + +• **customCurrency**: _object_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L68) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L72) + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) + +### tiers + +• **tiers**: [_StoTier_](../interfaces/_types_index_.stotier.md)_\[\]_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md new file mode 100644 index 0000000..eb5d0b3 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md @@ -0,0 +1,34 @@ +# LaunchTieredStoCustomCurrencyPolyNoStableCoinParams + +## Hierarchy + +* object + + ↳ **LaunchTieredStoCustomCurrencyPolyNoStableCoinParams** + +## Index + +### Properties + +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md#customcurrency) + +## Properties + +### currencies + +• **currencies**: [_OnlyPoly_](_entities_securitytoken_issuance_offerings_.md#onlypoly) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L95) + +### customCurrency + +• **customCurrency**: _object_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:96_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L96) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **polyOracleAddress**: _string_ + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md new file mode 100644 index 0000000..70fe2bc --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md @@ -0,0 +1,119 @@ +# LaunchTieredStoCustomCurrencyPolyParams + +## Hierarchy + +* [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) + + ↳ **LaunchTieredStoCustomCurrencyPolyParams** + +## Index + +### Properties + +* [allowPreIssuance](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#optional-allowpreissuance) +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#customcurrency) +* [endDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#enddate) +* [minimumInvestment](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#nonaccreditedinvestmentlimit) +* [raisedFundsWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#raisedfundswallet) +* [stableCoinAddresses](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#stablecoinaddresses) +* [startDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#startdate) +* [tiers](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#tiers) +* [unsoldTokensWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuance + +• **allowPreIssuance**? : _undefined \| false \| true_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) + +### currencies + +• **currencies**: [_OnlyPoly_](_entities_securitytoken_issuance_offerings_.md#onlypoly) _\|_ [_PolyAndStableCoin_](_entities_securitytoken_issuance_offerings_.md#polyandstablecoin) + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:85_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L85) + +### customCurrency + +• **customCurrency**: _object_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:86_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L86) + +#### Type declaration: + +* **currencySymbol**? : _undefined \| string_ +* **polyOracleAddress**: _string_ + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Overrides_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L90) + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) + +### tiers + +• **tiers**: [_StoTier_](../interfaces/_types_index_.stotier.md)_\[\]_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_LaunchTieredStoParams_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md new file mode 100644 index 0000000..a47e71d --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md @@ -0,0 +1,104 @@ +# LaunchTieredStoMethod + +## Hierarchy + +* **LaunchTieredStoMethod** + +## Callable + +▸ \(`args`: [LaunchTieredStoNoCustomCurrencyParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L122) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoNoCustomCurrencyParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L125) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyEthParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L128) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyEthParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:131_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L131) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyPolyParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L134) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyPolyParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L137) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyBothParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L140) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyBothParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +▸ \(`args`: [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L143) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md new file mode 100644 index 0000000..6841215 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md @@ -0,0 +1,22 @@ +# LaunchTieredStoNoCustomCurrencyNoStableCoinParams + +## Hierarchy + +* object + + ↳ **LaunchTieredStoNoCustomCurrencyNoStableCoinParams** + +## Index + +### Properties + +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md#currencies) + +## Properties + +### currencies + +• **currencies**: [_OnlyEth_](_entities_securitytoken_issuance_offerings_.md#onlyeth) _\|_ [_OnlyPoly_](_entities_securitytoken_issuance_offerings_.md#onlypoly) _\|_ [_EthAndPoly_](_entities_securitytoken_issuance_offerings_.md#ethandpoly) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L57) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md new file mode 100644 index 0000000..f236781 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md @@ -0,0 +1,29 @@ +# LaunchTieredStoNoCustomCurrencyParams + +## Hierarchy + +* object + + ↳ **LaunchTieredStoNoCustomCurrencyParams** + +## Index + +### Properties + +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md#currencies) +* [stableCoinAddresses](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md#stablecoinaddresses) + +## Properties + +### currencies + +• **currencies**: [_EthAndStableCoin_](_entities_securitytoken_issuance_offerings_.md#ethandstablecoin) _\|_ [_PolyAndStableCoin_](_entities_securitytoken_issuance_offerings_.md#polyandstablecoin) _\|_ [_AllCurrencies_](_entities_securitytoken_issuance_offerings_.md#allcurrencies) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L62) + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:63_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L63) + diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md new file mode 100644 index 0000000..6601047 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md @@ -0,0 +1,96 @@ +# LaunchTieredStoParams + +## Hierarchy + +* **LaunchTieredStoParams** + + ↳ [LaunchTieredStoCustomCurrencyEthParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) + + ↳ [LaunchTieredStoCustomCurrencyPolyParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) + + ↳ [LaunchTieredStoCustomCurrencyBothParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) + +## Index + +### Properties + +* [allowPreIssuance](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) +* [currencies](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) +* [customCurrency](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) +* [endDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) +* [minimumInvestment](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) +* [raisedFundsWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) +* [stableCoinAddresses](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) +* [startDate](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) +* [tiers](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) +* [unsoldTokensWallet](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuance + +• **allowPreIssuance**? : _undefined \| false \| true_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) + +### currencies + +• **currencies**: _Currency\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L24) + +### `Optional` customCurrency + +• **customCurrency**? : _Partial‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L28) + +### endDate + +• **endDate**: _Date_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) + +### `Optional` stableCoinAddresses + +• **stableCoinAddresses**? : _string\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L27) + +### startDate + +• **startDate**: _Date_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) + +### tiers + +• **tiers**: [_StoTier_](../interfaces/_types_index_.stotier.md)_\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) + diff --git a/docs/api/modules/_entities_securitytoken_issuance_offerings_.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.md similarity index 54% rename from docs/api/modules/_entities_securitytoken_issuance_offerings_.md rename to docs/api/external-modules/_entities_securitytoken_issuance_offerings_.md index 8feeadc..a139283 100644 --- a/docs/api/modules/_entities_securitytoken_issuance_offerings_.md +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Issuance/Offerings" +# entities/SecurityToken/Issuance/Offerings ## Index @@ -32,48 +32,39 @@ ## Type aliases -### AllCurrencies +### AllCurrencies -Ƭ **AllCurrencies**: *[Currency.StableCoin, Currency.ETH, Currency.POLY] | [Currency.ETH, Currency.StableCoin, Currency.POLY] | [Currency.ETH, Currency.POLY, Currency.StableCoin] | [Currency.StableCoin, Currency.POLY, Currency.ETH] | [Currency.POLY, Currency.StableCoin, Currency.ETH] | [Currency.POLY, Currency.ETH, Currency.StableCoin]* +Ƭ **AllCurrencies**: _\[Currency.StableCoin, Currency.ETH, Currency.POLY\] \| \[Currency.ETH, Currency.StableCoin, Currency.POLY\] \| \[Currency.ETH, Currency.POLY, Currency.StableCoin\] \| \[Currency.StableCoin, Currency.POLY, Currency.ETH\] \| \[Currency.POLY, Currency.StableCoin, Currency.ETH\] \| \[Currency.POLY, Currency.ETH, Currency.StableCoin\]_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L39)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L39) -___ +### EthAndPoly -### EthAndPoly +Ƭ **EthAndPoly**: _\[Currency.ETH, Currency.POLY\] \| \[Currency.POLY, Currency.ETH\]_ -Ƭ **EthAndPoly**: *[Currency.ETH, Currency.POLY] | [Currency.POLY, Currency.ETH]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:38_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L38) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:38](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L38)* +### EthAndStableCoin -___ +Ƭ **EthAndStableCoin**: _\[Currency.StableCoin, Currency.ETH\] \| \[Currency.ETH, Currency.StableCoin\]_ -### EthAndStableCoin +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L33) -Ƭ **EthAndStableCoin**: *[Currency.StableCoin, Currency.ETH] | [Currency.ETH, Currency.StableCoin]* +### OnlyEth -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L33)* +Ƭ **OnlyEth**: _\[Currency.ETH\]_ -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L32) -### OnlyEth +### OnlyPoly -Ƭ **OnlyEth**: *[Currency.ETH]* +Ƭ **OnlyPoly**: _\[Currency.POLY\]_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L32)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L34) -___ +### PolyAndStableCoin -### OnlyPoly +Ƭ **PolyAndStableCoin**: _\[Currency.StableCoin, Currency.POLY\] \| \[Currency.POLY, Currency.StableCoin\]_ -Ƭ **OnlyPoly**: *[Currency.POLY]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L35) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L34)* - -___ - -### PolyAndStableCoin - -Ƭ **PolyAndStableCoin**: *[Currency.StableCoin, Currency.POLY] | [Currency.POLY, Currency.StableCoin]* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L35)* diff --git a/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.offerings.md b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.offerings.md new file mode 100644 index 0000000..536c860 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_issuance_offerings_.offerings.md @@ -0,0 +1,144 @@ +# Offerings + +Namespace that handles all Offering related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Offerings** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#protected-securitytoken) + +### Methods + +* [getSto](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#getsto) +* [getStos](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#getstos) +* [launchSimpleSto](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#launchsimplesto) +* [launchTieredSto](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#launchtieredsto) + +## Constructors + +### constructor + ++ **new Offerings**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Offerings_](../classes/_entities_securitytoken_issuance_offerings_.offerings.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Offerings_](../classes/_entities_securitytoken_issuance_offerings_.offerings.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### getSto + +▸ **getSto**\(`args`: [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) \| string\): _Promise‹any›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:223_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L223) + +Retrieve an STO by type and address or UUID + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) \| string | STO uuid or object containing its type and address | + +**Returns:** _Promise‹any›_ + +### getStos + +▸ **getStos**\(`opts`: object\): _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L260) + +Retrieve all STOs attached to a security token + +**Parameters:** + +▪`Default value` **opts**: _object_= { stoTypes: \[StoType.Simple, StoType.Tiered\], } + +| Name | Type | +| :--- | :--- | +| `stoTypes` | [StoType](../enums/_types_index_.stotype.md)\[\] | + +**Returns:** _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_\[\]›_ + +### launchSimpleSto + +▸ **launchSimpleSto**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md)_,_ [_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L168) + +Launch a Simple STO + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `allowPreIssuance?` | undefined \| false \| true | +| `currency` | Currency.ETH \| Currency.POLY | +| `endDate` | Date | +| `raisedFundsWallet` | string | +| `rate` | BigNumber | +| `startDate` | Date | +| `tokensOnSale` | BigNumber | +| `unsoldTokensWallet` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md)_,_ [_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_››_ + +### launchTieredSto + +▸ **launchTieredSto**\(`args`: [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)\): _Promise‹any›_ + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L203) + +Launch a Tiered STO + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoParams](../interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) | + +**Returns:** _Promise‹any›_ + diff --git a/docs/api/modules/_entities_securitytoken_permissions_.md b/docs/api/external-modules/_entities_securitytoken_permissions_.md similarity index 65% rename from docs/api/modules/_entities_securitytoken_permissions_.md rename to docs/api/external-modules/_entities_securitytoken_permissions_.md index a4ba89b..7abe0e0 100644 --- a/docs/api/modules/_entities_securitytoken_permissions_.md +++ b/docs/api/external-modules/_entities_securitytoken_permissions_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Permissions" +# entities/SecurityToken/Permissions ## Index ### Classes * [Permissions](../classes/_entities_securitytoken_permissions_.permissions.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_permissions_.permissions.md b/docs/api/external-modules/_entities_securitytoken_permissions_.permissions.md new file mode 100644 index 0000000..5a9ca5c --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_permissions_.permissions.md @@ -0,0 +1,238 @@ +# Permissions + +Namespace that handles all Permissions related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Permissions** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_permissions_.permissions.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_permissions_.permissions.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_permissions_.permissions.md#protected-securitytoken) + +### Methods + +* [assignRole](../classes/_entities_securitytoken_permissions_.permissions.md#assignrole) +* [getAllDelegates](../classes/_entities_securitytoken_permissions_.permissions.md#getalldelegates) +* [getAssignedRoles](../classes/_entities_securitytoken_permissions_.permissions.md#getassignedroles) +* [getAvailableRoles](../classes/_entities_securitytoken_permissions_.permissions.md#getavailableroles) +* [getDelegatesForRole](../classes/_entities_securitytoken_permissions_.permissions.md#getdelegatesforrole) +* [getFeatureFromRole](../classes/_entities_securitytoken_permissions_.permissions.md#getfeaturefromrole) +* [isRoleAvailable](../classes/_entities_securitytoken_permissions_.permissions.md#isroleavailable) +* [revokeRole](../classes/_entities_securitytoken_permissions_.permissions.md#revokerole) + +### Object literals + +* [rolesPerFeature](../classes/_entities_securitytoken_permissions_.permissions.md#rolesperfeature) + +## Constructors + +### constructor + ++ **new Permissions**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Permissions_](../classes/_entities_securitytoken_permissions_.permissions.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Permissions_](../classes/_entities_securitytoken_permissions_.permissions.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### assignRole + +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L95) + +Assign a role on the Security Token to a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description` | string | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ + +### getAllDelegates + +▸ **getAllDelegates**\(\): _Promise‹object\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:242_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L242) + +Return a list of all delegates with their respective details and roles + +**Returns:** _Promise‹object\[\]›_ + +### getAssignedRoles + +▸ **getAssignedRoles**\(`args`: object\): _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L136) + +Return the list of roles assigned to a delegate address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | + +**Returns:** _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ + +### getAvailableRoles + +▸ **getAvailableRoles**\(\): _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L25) + +Get a list of all available roles. The returned roles depend on which features are enabled, as per: + +| Feature | Roles | +| :--- | :--- | +| Permissions | Permissions Administrator | +| Tokenholders | Tokenholders Administrator | +| Dividends | Dividends Administrator, Dividends Operator | +| TokenholderCountRestrictions | Tokenholder Count Restrictions Administrator | +| PercentageOwnershipRestrictions | Percentage Ownership Restrictions Administrator | + +**Returns:** _Promise‹_[_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]›_ + +### getDelegatesForRole + +▸ **getDelegatesForRole**\(`args`: object\): _Promise‹object\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L184) + +Return the list of delegate addresses and details that hold a specific role + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹object\[\]›_ + +### getFeatureFromRole + +▸ **getFeatureFromRole**\(`args`: object\): _Promise‹_[_Feature_](../enums/_types_index_.feature.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L65) + +Return which feature is associated with the supplied role + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹_[_Feature_](../enums/_types_index_.feature.md)_›_ + +### isRoleAvailable + +▸ **isRoleAvailable**\(`args`: object\): _Promise‹boolean›_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L55) + +Return whether a certain role is available to be assigned to delegates + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹boolean›_ + +### revokeRole + +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:117_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L117) + +Remove a role from a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)_, void››_ + +## Object literals + +### rolesPerFeature + +### ▪ **rolesPerFeature**: _object_ + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:279_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L279) + +### \_\_computed + +• **\_\_computed**: [_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md)_\[\]_ = \[ SecurityTokenRole.PercentageOwnershipRestrictionsAdministrator, \] + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:280_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L280) + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:281_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L281) + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:282_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L282) + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:286_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L286) + +_Defined in_ [_src/entities/SecurityToken/Permissions.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Permissions.ts#L289) + diff --git a/docs/api/external-modules/_entities_securitytoken_securitytoken_.md b/docs/api/external-modules/_entities_securitytoken_securitytoken_.md new file mode 100644 index 0000000..d44156c --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_securitytoken_.md @@ -0,0 +1,52 @@ +# entities/SecurityToken/SecurityToken + +## Index + +### Classes + +* [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +### Interfaces + +* [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) +* [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) + +### Functions + +* [isUniqueIdentifiers](_entities_securitytoken_securitytoken_.md#isuniqueidentifiers) +* [unserialize](_entities_securitytoken_securitytoken_.md#const-unserialize) + +## Functions + +### isUniqueIdentifiers + +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L30) + +Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ + +### `Const` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L72) + +Unserialize string to a Security Token object representation + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | Security Token's serialized representation | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_securitytoken_.params.md b/docs/api/external-modules/_entities_securitytoken_securitytoken_.params.md new file mode 100644 index 0000000..19ed82e --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_securitytoken_.params.md @@ -0,0 +1,88 @@ +# Params + +Security Token constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [address](../interfaces/_entities_securitytoken_securitytoken_.params.md#address) +* [currentCheckpoint](../interfaces/_entities_securitytoken_securitytoken_.params.md#currentcheckpoint) +* [granularity](../interfaces/_entities_securitytoken_securitytoken_.params.md#granularity) +* [name](../interfaces/_entities_securitytoken_securitytoken_.params.md#name) +* [owner](../interfaces/_entities_securitytoken_securitytoken_.params.md#owner) +* [tokenDetails](../interfaces/_entities_securitytoken_securitytoken_.params.md#tokendetails) +* [totalSupply](../interfaces/_entities_securitytoken_securitytoken_.params.md#totalsupply) +* [treasuryWallet](../interfaces/_entities_securitytoken_securitytoken_.params.md#treasurywallet) +* [version](../interfaces/_entities_securitytoken_securitytoken_.params.md#version) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L44) + +address of the Security Token contract + +### currentCheckpoint + +• **currentCheckpoint**: _number_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L59) + +index of the current checkpoint + +### granularity + +• **granularity**: _number_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L54) + +### name + +• **name**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L40) + +### owner + +• **owner**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L48) + +address that owns the Security Token + +### tokenDetails + +• **tokenDetails**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L52) + +URL pointing to off-chain data associated with the Security Token + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L55) + +### treasuryWallet + +• **treasuryWallet**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L64) + +default treasury wallet used by some features. _**For example, if an STO reaches its end date \(or is finalized before that\), remaining unsold tokens get transferred to this wallet unless otherwise specified by the STO itself**_ + +### version + +• **version**: _Version_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L53) + diff --git a/docs/api/external-modules/_entities_securitytoken_securitytoken_.securitytoken.md b/docs/api/external-modules/_entities_securitytoken_securitytoken_.securitytoken.md new file mode 100644 index 0000000..47e3a3c --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_securitytoken_.securitytoken.md @@ -0,0 +1,286 @@ +# SecurityToken + +Class used to manage all the Security Token functionality + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)› + + ↳ **SecurityToken** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#constructor) + +### Properties + +* [address](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#address) +* [context](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#context) +* [controller](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#controller) +* [currentCheckpoint](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#currentcheckpoint) +* [dividends](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#dividends) +* [documents](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#documents) +* [features](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#features) +* [granularity](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#granularity) +* [issuance](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#issuance) +* [name](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#name) +* [owner](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#owner) +* [permissions](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#permissions) +* [symbol](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#symbol) +* [tokenDetails](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#tokendetails) +* [tokenholders](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#tokenholders) +* [totalSupply](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#totalsupply) +* [transfers](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#transfers) +* [treasuryWallet](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#treasurywallet) +* [uid](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#uid) +* [version](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#version) +* [unserialize](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#static-unserialize) + +### Methods + +* [\_refresh](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#_refresh) +* [toPojo](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#topojo) +* [transferOwnership](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#transferownership) +* [generateId](../classes/_entities_securitytoken_securitytoken_.securitytoken.md#static-generateid) + +## Constructors + +### constructor + ++ **new SecurityToken**\(`params`: [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153) + +Create a new SecurityToken instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L114) + +address that owns the Security Token + +### context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L153) + +### controller + +• **controller**: [_Controller_](../classes/_entities_securitytoken_controller_.controller.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L147) + +### currentCheckpoint + +• **currentCheckpoint**: _number_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L130) + +index of the current checkpoint + +### dividends + +• **dividends**: [_Dividends_](../classes/_entities_securitytoken_dividends_.dividends.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L141) + +### documents + +• **documents**: [_Documents_](../classes/_entities_securitytoken_documents_.documents.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L151) + +### features + +• **features**: [_Features_](../classes/_entities_securitytoken_features_.features.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L137) + +### granularity + +• **granularity**: _number_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:123_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L123) + +### issuance + +• **issuance**: [_Issuance_](../classes/_entities_securitytoken_issuance_issuance_.issuance.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L143) + +### name + +• **name**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L104) + +### owner + +• **owner**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L109) + +address of the Security Token contract + +### permissions + +• **permissions**: [_Permissions_](../classes/_entities_securitytoken_permissions_.permissions.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L145) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L102) + +### tokenDetails + +• **tokenDetails**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:119_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L119) + +URL pointing to off-chain data associated with the Security Token + +### tokenholders + +• **tokenholders**: [_Tokenholders_](../classes/_entities_securitytoken_tokenholders_.tokenholders.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L139) + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L125) + +### transfers + +• **transfers**: [_Transfers_](../classes/_entities_securitytoken_transfers_transfers_.transfers.md) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L149) + +### treasuryWallet + +• **treasuryWallet**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L135) + +treasury wallet used by some features + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:100_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L100) + +### version + +• **version**: _Version_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:121_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L121) + +### `Static` unserialize + +▪ **unserialize**: _unserialize_ = unserialize + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L98) + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L249) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_securitytoken_securitytoken_.params.md)› | + +**Returns:** _void_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L216) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **address**: _string_ +* **currentCheckpoint**: _number_ +* **granularity**: _number_ +* **name**: _string_ +* **owner**: _string_ +* **symbol**: _string_ +* **tokenDetails**: _string_ +* **totalSupply**: _BigNumber_ +* **treasuryWallet**: _string_ +* **uid**: _string_ +* **version**: _ContractVersion_ + +### transferOwnership + +▸ **transferOwnership**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L202) + +Transfers ownership of the Security Token to a different wallet address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `newOwner` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md)_, void››_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L92) + +Generate the Security Token's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `symbol` | string | + +**Returns:** _string_ + diff --git a/docs/api/external-modules/_entities_securitytoken_securitytoken_.uniqueidentifiers.md b/docs/api/external-modules/_entities_securitytoken_securitytoken_.uniqueidentifiers.md new file mode 100644 index 0000000..1ac87a3 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_securitytoken_.uniqueidentifiers.md @@ -0,0 +1,24 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Security Token + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [symbol](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L24) + +symbol of the security token + diff --git a/docs/api/modules/_entities_securitytoken_submodule_.md b/docs/api/external-modules/_entities_securitytoken_submodule_.md similarity index 64% rename from docs/api/modules/_entities_securitytoken_submodule_.md rename to docs/api/external-modules/_entities_securitytoken_submodule_.md index 9df8398..dba3b8f 100644 --- a/docs/api/modules/_entities_securitytoken_submodule_.md +++ b/docs/api/external-modules/_entities_securitytoken_submodule_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/SubModule" +# entities/SecurityToken/SubModule ## Index ### Classes * [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_submodule_.submodule.md b/docs/api/external-modules/_entities_securitytoken_submodule_.submodule.md new file mode 100644 index 0000000..2bb5a58 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_submodule_.submodule.md @@ -0,0 +1,76 @@ +# SubModule + +Represents a namespace inside the Security Token that handles a set of related functionality + +## Hierarchy + +* **SubModule** + + ↳ [Features](../classes/_entities_securitytoken_features_.features.md) + + ↳ [Tokenholders](../classes/_entities_securitytoken_tokenholders_.tokenholders.md) + + ↳ [Dividends](../classes/_entities_securitytoken_dividends_.dividends.md) + + ↳ [Offerings](../classes/_entities_securitytoken_issuance_offerings_.offerings.md) + + ↳ [Issuance](../classes/_entities_securitytoken_issuance_issuance_.issuance.md) + + ↳ [Permissions](../classes/_entities_securitytoken_permissions_.permissions.md) + + ↳ [CountRestrictions](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + + ↳ [PercentageRestrictions](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) + + ↳ [Restrictions](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + + ↳ [Transfers](../classes/_entities_securitytoken_transfers_transfers_.transfers.md) + + ↳ [Documents](../classes/_entities_securitytoken_documents_.documents.md) + + ↳ [Controller](../classes/_entities_securitytoken_controller_.controller.md) + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +## Constructors + +### constructor + ++ **new SubModule**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + diff --git a/docs/api/external-modules/_entities_securitytoken_tokenholders_.getcheckpointparams.md b/docs/api/external-modules/_entities_securitytoken_tokenholders_.getcheckpointparams.md new file mode 100644 index 0000000..3a6182d --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_tokenholders_.getcheckpointparams.md @@ -0,0 +1,22 @@ +# GetCheckpointParams + +Parameters for [getCheckpoint](../classes/_polymathbase_.polymathbase.md#getcheckpoint) + +## Hierarchy + +* **GetCheckpointParams** + +## Index + +### Properties + +* [checkpointIndex](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md#checkpointindex) + +## Properties + +### checkpointIndex + +• **checkpointIndex**: _number_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L18) + diff --git a/docs/api/modules/_entities_securitytoken_tokenholders_.md b/docs/api/external-modules/_entities_securitytoken_tokenholders_.md similarity index 79% rename from docs/api/modules/_entities_securitytoken_tokenholders_.md rename to docs/api/external-modules/_entities_securitytoken_tokenholders_.md index bd45212..10096fb 100644 --- a/docs/api/modules/_entities_securitytoken_tokenholders_.md +++ b/docs/api/external-modules/_entities_securitytoken_tokenholders_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Tokenholders" +# entities/SecurityToken/Tokenholders ## Index @@ -9,3 +9,4 @@ ### Interfaces * [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_tokenholders_.tokenholders.md b/docs/api/external-modules/_entities_securitytoken_tokenholders_.tokenholders.md new file mode 100644 index 0000000..6f9636f --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_tokenholders_.tokenholders.md @@ -0,0 +1,175 @@ +# Tokenholders + +Namespace that handles all Tokenholder related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Tokenholders** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#protected-securitytoken) + +### Methods + +* [allTimeInvestorCount](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#alltimeinvestorcount) +* [createCheckpoint](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#createcheckpoint) +* [getCheckpoint](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#getcheckpoint) +* [getCheckpoints](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#getcheckpoints) +* [getTokenholders](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#gettokenholders) +* [holderCount](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#holdercount) +* [modifyData](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#modifydata) +* [revokeKyc](../classes/_entities_securitytoken_tokenholders_.tokenholders.md#revokekyc) + +## Constructors + +### constructor + ++ **new Tokenholders**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Tokenholders_](../classes/_entities_securitytoken_tokenholders_.tokenholders.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Tokenholders_](../classes/_entities_securitytoken_tokenholders_.tokenholders.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### allTimeInvestorCount + +▸ **allTimeInvestorCount**\(\): _Promise‹number›_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L221) + +Retrieve the amount of wallets that ever held tokens or have any KYC data + +**Returns:** _Promise‹number›_ + +### createCheckpoint + +▸ **createCheckpoint**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md)_,_ [_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L59) + +Create a snapshot of the balances of every tokenholder at the current date + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md)_,_ [_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_››_ + +### getCheckpoint + +▸ **getCheckpoint**\(`args`: [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) \| string\): _Promise‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_›_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:133_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L133) + +Retrieve a checkpoint from the security token by index or UUID + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `args` | [GetCheckpointParams](../interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md) \| string | checkpoint uuid or object containing its index | + +**Returns:** _Promise‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_›_ + +### getCheckpoints + +▸ **getCheckpoints**\(\): _Promise‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:74_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L74) + +Retrieve list of checkpoints and their corresponding dividend distributions of every type + +**Returns:** _Promise‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_\[\]›_ + +### getTokenholders + +▸ **getTokenholders**\(\): _Promise‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]›_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L155) + +Get data for all tokenholders associated to the Security Token + +**Returns:** _Promise‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]›_ + +### holderCount + +▸ **holderCount**\(\): _Promise‹number›_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:247_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L247) + +Retrieve the amount of wallets that currently hold tokens + +**Returns:** _Promise‹number›_ + +### modifyData + +▸ **modifyData**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L31) + +Add/modify investor data. For an investor to be able to hold, sell or purchase tokens, his address \(and other KYC data\) must be added/modified via this method + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenholderData` | [TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + +### revokeKyc + +▸ **revokeKyc**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L45) + +Revoke KYC for a group of tokenholder addresses. Supplied addresses must have valid KYC + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenholderAddresses` | string\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md)_,_ [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\]››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_index_.md b/docs/api/external-modules/_entities_securitytoken_transfers_index_.md new file mode 100644 index 0000000..a98dc50 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_index_.md @@ -0,0 +1,2 @@ +# entities/SecurityToken/Transfers/index + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md new file mode 100644 index 0000000..418e965 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md @@ -0,0 +1,95 @@ +# CountRestrictions + +Namespace that handles all Count Restriction related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **CountRestrictions** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md#protected-securitytoken) + +### Methods + +* [getMaxHolderCount](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md#getmaxholdercount) +* [modifyMaxHolderCount](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md#modifymaxholdercount) + +## Constructors + +### constructor + ++ **new CountRestrictions**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_CountRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_CountRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### getMaxHolderCount + +▸ **getMaxHolderCount**\(\): _Promise‹number›_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L31) + +Retrieve the maximum amonut of tokenholders allowed to hold the token at once Can be modified with `modifyMaxHolderCount` + +**Returns:** _Promise‹number›_ + +### modifyMaxHolderCount + +▸ **modifyMaxHolderCount**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts#L16) + +Modify the maximum amount of tokenholders allowed to hold the token at once + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `maxHolderCount` | number | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)_, void››_ + diff --git a/docs/api/modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md similarity index 63% rename from docs/api/modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md rename to docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md index 50bc9c0..433a6e2 100644 --- a/docs/api/modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Transfers/Restrictions/CountRestrictions" +# entities/SecurityToken/Transfers/Restrictions/CountRestrictions ## Index ### Classes * [CountRestrictions](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_index_.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_index_.md new file mode 100644 index 0000000..74a57ce --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_index_.md @@ -0,0 +1,2 @@ +# entities/SecurityToken/Transfers/Restrictions/index + diff --git a/docs/api/modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md similarity index 87% rename from docs/api/modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md rename to docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md index 237a84f..b5d731c 100644 --- a/docs/api/modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions" +# entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions ## Index @@ -11,3 +11,4 @@ * [ModifyExemptionsMethod](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md) * [PercentageIssuanceParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) * [PercentageWhitelistParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md new file mode 100644 index 0000000..5a798ce --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md @@ -0,0 +1,32 @@ +# ModifyExemptionsMethod + +## Hierarchy + +* **ModifyExemptionsMethod** + +## Callable + +▸ \(`params`: [PercentageWhitelistParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L25) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [PercentageWhitelistParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ + +▸ \(`params`: [PercentageIssuanceParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L28) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [PercentageIssuanceParams](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md new file mode 100644 index 0000000..3c6088e --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md @@ -0,0 +1,20 @@ +# PercentageIssuanceParams + +## Hierarchy + +* **PercentageIssuanceParams** + +## Index + +### Properties + +* [allowPrimaryIssuance](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md#allowprimaryissuance) + +## Properties + +### allowPrimaryIssuance + +• **allowPrimaryIssuance**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L22) + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md new file mode 100644 index 0000000..b4645b7 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md @@ -0,0 +1,131 @@ +# PercentageRestrictions + +Namespace that handles all Percentage Restriction related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **PercentageRestrictions** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#protected-context) +* [securityToken](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#protected-securitytoken) + +### Methods + +* [getExemptions](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#getexemptions) +* [getMaxHolderPercentage](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#getmaxholderpercentage) +* [modifyExemptions](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#modifyexemptions) +* [modifyMaxHolderPercentage](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md#modifymaxholderpercentage) + +## Constructors + +### constructor + ++ **new PercentageRestrictions**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_PercentageRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +Create a new SubModule instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_PercentageRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### getExemptions + +▸ **getExemptions**\(\): _Promise‹object›_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:66_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L66) + +Retrieve all exemptions that currently apply to percentage restrictions. That includes the whitelist and whether primary issuance \(minting\) is allowed to bypass percentage ownership restrictions + +Can be modified with `modifyPercentageExemptions` + +**Returns:** _Promise‹object›_ + +### getMaxHolderPercentage + +▸ **getMaxHolderPercentage**\(\): _Promise‹BigNumber›_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L139) + +Retrieve the maximum percentage of the total supply that a single tokenholder can own Can be modified with `modifyMaxHolderPercentage` + +**Returns:** _Promise‹BigNumber›_ + +### modifyExemptions + +▸ **modifyExemptions**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L47) + +Modify the conditions for exemption from percentage ownership restrictions. There are two \(independent\) methods of exemption: + +* Whitelisting: an address can be whitelisted and thus percentage ownership restrictions will not apply to it +* Primary issuance: if enabled, issuing tokens to an address will bypass percentage ownership restrictions \(for example, if issuing tokens to a particular address would leave that address with a higher percentage than the limit, having this option set to `true` will allow that issuance operation\) + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `allowPrimaryIssuance?` | undefined \| false \| true | +| `whitelistEntries?` | [PercentageWhitelistEntry](../interfaces/_types_index_.percentagewhitelistentry.md)\[\] | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)_, void››_ + +### modifyMaxHolderPercentage + +▸ **modifyMaxHolderPercentage**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:124_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L124) + +Modify the maximum percentage of the total supply that a single tokenholder can own at a given time + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `maxHolderPercentage` | BigNumber | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)_, void››_ + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md new file mode 100644 index 0000000..fbfafe6 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md @@ -0,0 +1,20 @@ +# PercentageWhitelistParams + +## Hierarchy + +* **PercentageWhitelistParams** + +## Index + +### Properties + +* [whitelistEntries](../interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md#whitelistentries) + +## Properties + +### whitelistEntries + +• **whitelistEntries**: [_PercentageWhitelistEntry_](../interfaces/_types_index_.percentagewhitelistentry.md)_\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L18) + diff --git a/docs/api/modules/_entities_securitytoken_transfers_restrictions_restrictions_.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.md similarity index 61% rename from docs/api/modules/_entities_securitytoken_transfers_restrictions_restrictions_.md rename to docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.md index 8887a8a..f7fb1d4 100644 --- a/docs/api/modules/_entities_securitytoken_transfers_restrictions_restrictions_.md +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Transfers/Restrictions/Restrictions" +# entities/SecurityToken/Transfers/Restrictions/Restrictions ## Index ### Classes * [Restrictions](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md new file mode 100644 index 0000000..3d591ed --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md @@ -0,0 +1,74 @@ +# Restrictions + +Namespace that handles all Transfer Restriction related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Restrictions** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md#protected-context) +* [count](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md#count) +* [percentage](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md#percentage) +* [securityToken](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md#protected-securitytoken) + +## Constructors + +### constructor + ++ **new Restrictions**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Restrictions_](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + +_Overrides_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13) + +Create a new Restrictions instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Restrictions_](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### count + +• **count**: [_CountRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_countrestrictions_.countrestrictions.md) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L11) + +### percentage + +• **percentage**: [_PercentageRestrictions_](../classes/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagerestrictions.md) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/Restrictions.ts#L13) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + diff --git a/docs/api/modules/_entities_securitytoken_transfers_transfers_.md b/docs/api/external-modules/_entities_securitytoken_transfers_transfers_.md similarity index 62% rename from docs/api/modules/_entities_securitytoken_transfers_transfers_.md rename to docs/api/external-modules/_entities_securitytoken_transfers_transfers_.md index c1790b5..084cbf4 100644 --- a/docs/api/modules/_entities_securitytoken_transfers_transfers_.md +++ b/docs/api/external-modules/_entities_securitytoken_transfers_transfers_.md @@ -1,7 +1,8 @@ -# External module: "entities/SecurityToken/Transfers/Transfers" +# entities/SecurityToken/Transfers/Transfers ## Index ### Classes * [Transfers](../classes/_entities_securitytoken_transfers_transfers_.transfers.md) + diff --git a/docs/api/external-modules/_entities_securitytoken_transfers_transfers_.transfers.md b/docs/api/external-modules/_entities_securitytoken_transfers_transfers_.transfers.md new file mode 100644 index 0000000..210af54 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytoken_transfers_transfers_.transfers.md @@ -0,0 +1,192 @@ +# Transfers + +Namespace that handles all Transfer related functionality + +## Hierarchy + +* [SubModule](../classes/_entities_securitytoken_submodule_.submodule.md) + + ↳ **Transfers** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#protected-context) +* [restrictions](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#restrictions) +* [securityToken](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#protected-securitytoken) + +### Methods + +* [canTransfer](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#cantransfer) +* [freeze](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#freeze) +* [frozen](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#frozen) +* [getStatusCode](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#private-getstatuscode) +* [signKycData](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#signkycdata) +* [transfer](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#transfer) +* [unfreeze](../classes/_entities_securitytoken_transfers_transfers_.transfers.md#unfreeze) + +## Constructors + +### constructor + ++ **new Transfers**\(`securityToken`: [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](../classes/_context_.context.md)\): [_Transfers_](../classes/_entities_securitytoken_transfers_transfers_.transfers.md) + +_Overrides_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_constructor_](../classes/_entities_securitytoken_submodule_.submodule.md#constructor) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21) + +Create a new Transfers instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `securityToken` | [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Transfers_](../classes/_entities_securitytoken_transfers_transfers_.transfers.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_context_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-context) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10) + +### restrictions + +• **restrictions**: [_Restrictions_](../classes/_entities_securitytoken_transfers_restrictions_restrictions_.restrictions.md) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L21) + +### `Protected` securityToken + +• **securityToken**: [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) + +_Inherited from_ [_SubModule_](../classes/_entities_securitytoken_submodule_.submodule.md)_._[_securityToken_](../classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken) + +_Defined in_ [_src/entities/SecurityToken/SubModule.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8) + +## Methods + +### canTransfer + +▸ **canTransfer**\(`args`: object\): _Promise‹object›_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L130) + +Validate if a transfer of Security Tokens can be performed. This takes all present transfer restrictions into account + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `data?` | undefined \| string | +| `from?` | undefined \| string | +| `to` | string | +| `value` | BigNumber | + +**Returns:** _Promise‹object›_ + +### freeze + +▸ **freeze**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L114) + +Freeze transfers of the security token + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ + +### frozen + +▸ **frozen**\(\): _Promise‹boolean›_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:89_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L89) + +Retrieve whether the transfer of tokens is frozen or not Can be modified with `freeze` and `unfreeze` + +**Returns:** _Promise‹boolean›_ + +### `Private` getStatusCode + +▸ **getStatusCode**\(`statusCode`: RawTransferStatusCode\): [_TransferStatusCode_](../enums/_types_index_.transferstatuscode.md) + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L168) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `statusCode` | RawTransferStatusCode | + +**Returns:** [_TransferStatusCode_](../enums/_types_index_.transferstatuscode.md) + +### signKycData + +▸ **signKycData**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L47) + +Generate a signature string based on dynamic KYC data. This data can be used to: + +* Check if a transfer can be made \(using `canTransfer`\) with different KYC data than is currently present +* Actually make a transfer \(using `transfer`\) with different KYC data than is currently present \(in this case, the existing KYC data will be overwritten\) + +The signature can be generated by a third party other than the issuer. The signing wallet should have permission to modify KYC data \(via the Tokenholders Administrator role\) Otherwise, the new data will be disregarded + +**Note that, when supplying KYC data for signing, ALL investor entries should be supplied \(even those that remain the same\)** + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `kycData` | [Omit](_types_index_.md#omit)‹[Omit](_types_index_.md#omit)‹[TokenholderDataEntry](../interfaces/_types_index_.tokenholderdataentry.md), "canBuyFromSto"›, "isAccredited"›\[\] | +| `validFrom` | Date | +| `validTo` | Date | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md)_, void››_ + +### transfer + +▸ **transfer**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L72) + +Transfer an amount of Security Tokens to a specified address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `amount` | BigNumber | +| `data?` | undefined \| string | +| `from?` | undefined \| string | +| `to` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)_, void››_ + +### unfreeze + +▸ **unfreeze**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Transfers.ts:201_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Transfers.ts#L201) + +Unfreeze transfers of the security token + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)_, void››_ + diff --git a/docs/api/modules/_entities_securitytokenreservation_.md b/docs/api/external-modules/_entities_securitytokenreservation_.md similarity index 57% rename from docs/api/modules/_entities_securitytokenreservation_.md rename to docs/api/external-modules/_entities_securitytokenreservation_.md index 4397699..9e52382 100644 --- a/docs/api/modules/_entities_securitytokenreservation_.md +++ b/docs/api/external-modules/_entities_securitytokenreservation_.md @@ -1,4 +1,4 @@ -# External module: "entities/SecurityTokenReservation" +# entities/SecurityTokenReservation ## Index @@ -17,18 +17,19 @@ ## Functions -### isUniqueIdentifiers +### isUniqueIdentifiers -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ -*Defined in [src/entities/SecurityTokenReservation.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L18)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L18) Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | any | +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ -**Returns:** *identifiers is UniqueIdentifiers* diff --git a/docs/api/external-modules/_entities_securitytokenreservation_.params.md b/docs/api/external-modules/_entities_securitytokenreservation_.params.md new file mode 100644 index 0000000..c543bad --- /dev/null +++ b/docs/api/external-modules/_entities_securitytokenreservation_.params.md @@ -0,0 +1,45 @@ +# Params + +Constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [expiry](../interfaces/_entities_securitytokenreservation_.params.md#expiry) +* [ownerAddress](../interfaces/_entities_securitytokenreservation_.params.md#owneraddress) +* [reservedAt](../interfaces/_entities_securitytokenreservation_.params.md#reservedat) +* [securityTokenAddress](../interfaces/_entities_securitytokenreservation_.params.md#optional-securitytokenaddress) + +## Properties + +### expiry + +• **expiry**: _Date_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L31) + +expiry date for the ticker reservation + +### ownerAddress + +• **ownerAddress**: _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L33) + +### reservedAt + +• **reservedAt**: _Date_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L32) + +### `Optional` securityTokenAddress + +• **securityTokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L34) + diff --git a/docs/api/external-modules/_entities_securitytokenreservation_.securitytokenreservation.md b/docs/api/external-modules/_entities_securitytokenreservation_.securitytokenreservation.md new file mode 100644 index 0000000..318c657 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytokenreservation_.securitytokenreservation.md @@ -0,0 +1,231 @@ +# SecurityTokenReservation + +Class used to manage all the Security Token Reservation functionality + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)› + + ↳ **SecurityTokenReservation** + +## Index + +### Constructors + +* [constructor](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#constructor) + +### Properties + +* [context](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#protected-context) +* [expiry](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#expiry) +* [ownerAddress](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#owneraddress) +* [reservedAt](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#reservedat) +* [securityTokenAddress](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#optional-securitytokenaddress) +* [symbol](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#symbol) +* [uid](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#_refresh) +* [createSecurityToken](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#createsecuritytoken) +* [isLaunched](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#islaunched) +* [toPojo](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#topojo) +* [transferOwnership](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#transferownership) +* [generateId](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#static-generateid) +* [unserialize](../classes/_entities_securitytokenreservation_.securitytokenreservation.md#static-unserialize) + +## Constructors + +### constructor + ++ **new SecurityTokenReservation**\(`params`: [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92) + +Create a new SecurityTokenReservation instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_securitytokenreservation_.params.md) & [UniqueIdentifiers](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md) + +## Properties + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L92) + +### expiry + +• **expiry**: _Date_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L75) + +Date at which this reservation expires + +### ownerAddress + +• **ownerAddress**: _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:85_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L85) + +Address of the owner of the reservation + +### reservedAt + +• **reservedAt**: _Date_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L80) + +Date when the Security Token was reserved + +### `Optional` securityTokenAddress + +• **securityTokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L90) + +Address of the Security Token if it has already been launched, undefined if not + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L70) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L68) + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:167_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L167) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_securitytokenreservation_.params.md)› | + +**Returns:** _void_ + +### createSecurityToken + +▸ **createSecurityToken**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md)_,_ [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_››_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:119_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L119) + +Creates a security token with the reserved symbol + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `detailsUrl?` | undefined \| string | +| `divisible` | boolean | +| `name` | string | +| `treasuryWallet?` | undefined \| string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md)_,_ [_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_››_ + +### isLaunched + +▸ **isLaunched**\(\): _Promise‹boolean›_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L138) + +Returns true if the Security Token associated to this reservation has already been launched + +**Returns:** _Promise‹boolean›_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:158_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L158) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **expiry**: _Date_ +* **ownerAddress**: _string_ +* **reservedAt**: _Date_ +* **securityTokenAddress**: _undefined \| string_ +* **symbol**: _string_ +* **uid**: _string_ + +### transferOwnership + +▸ **transferOwnership**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L147) + +Transfer the ownership of the ticker + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `newOwner` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)_, void››_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L44) + +Generate the Security Token Reservation's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `symbol` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L55) + +Unserialize string to a Security Token Reservation object representation + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_securitytokenreservation_.uniqueidentifiers.md b/docs/api/external-modules/_entities_securitytokenreservation_.uniqueidentifiers.md new file mode 100644 index 0000000..f9ff4c5 --- /dev/null +++ b/docs/api/external-modules/_entities_securitytokenreservation_.uniqueidentifiers.md @@ -0,0 +1,22 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Security Token Reservation + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [symbol](../interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L12) + diff --git a/docs/api/modules/_entities_simplesto_.md b/docs/api/external-modules/_entities_simplesto_.md similarity index 51% rename from docs/api/modules/_entities_simplesto_.md rename to docs/api/external-modules/_entities_simplesto_.md index 16f37cf..db1fc2c 100644 --- a/docs/api/modules/_entities_simplesto_.md +++ b/docs/api/external-modules/_entities_simplesto_.md @@ -1,4 +1,4 @@ -# External module: "entities/SimpleSto" +# entities/SimpleSto ## Index @@ -16,8 +16,9 @@ ## Variables -### weiToValue +### weiToValue -• **weiToValue**: *weiToValue* +• **weiToValue**: _weiToValue_ + +_Defined in_ [_src/entities/SimpleSto.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L15) -*Defined in [src/entities/SimpleSto.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L15)* diff --git a/docs/api/external-modules/_entities_simplesto_.params.md b/docs/api/external-modules/_entities_simplesto_.params.md new file mode 100644 index 0000000..6e68507 --- /dev/null +++ b/docs/api/external-modules/_entities_simplesto_.params.md @@ -0,0 +1,189 @@ +# Params + +Properties that uniquely identify a simple sto + +## Hierarchy + +* [Params](../interfaces/_entities_sto_.params.md) + + ↳ **Params** + +## Index + +### Properties + +* [beneficialInvestmentsAllowed](../interfaces/_entities_simplesto_.params.md#beneficialinvestmentsallowed) +* [cap](../interfaces/_entities_simplesto_.params.md#cap) +* [capReached](../interfaces/_entities_simplesto_.params.md#capreached) +* [endDate](../interfaces/_entities_simplesto_.params.md#enddate) +* [fundraiseCurrencies](../interfaces/_entities_simplesto_.params.md#fundraisecurrencies) +* [investorCount](../interfaces/_entities_simplesto_.params.md#investorcount) +* [isFinalized](../interfaces/_entities_simplesto_.params.md#isfinalized) +* [isPaused](../interfaces/_entities_simplesto_.params.md#ispaused) +* [preIssueAllowed](../interfaces/_entities_simplesto_.params.md#preissueallowed) +* [raisedAmount](../interfaces/_entities_simplesto_.params.md#raisedamount) +* [raisedFundsWallet](../interfaces/_entities_simplesto_.params.md#raisedfundswallet) +* [rate](../interfaces/_entities_simplesto_.params.md#rate) +* [securityTokenSymbol](../interfaces/_entities_simplesto_.params.md#securitytokensymbol) +* [soldTokensAmount](../interfaces/_entities_simplesto_.params.md#soldtokensamount) +* [startDate](../interfaces/_entities_simplesto_.params.md#startdate) +* [unsoldTokensWallet](../interfaces/_entities_simplesto_.params.md#unsoldtokenswallet) + +## Properties + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_beneficialInvestmentsAllowed_](../interfaces/_entities_sto_.params.md#beneficialinvestmentsallowed) + +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) + +whether or not investments can be made on behalf of a beneficiary in the sto + +### cap + +• **cap**: _BigNumber_ + +_Defined in_ [_src/entities/SimpleSto.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L24) + +cap for how many tokens can be sold + +### capReached + +• **capReached**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_capReached_](../interfaces/_entities_sto_.params.md#capreached) + +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) + +whether or not the cap has been reached for the sto + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_endDate_](../interfaces/_entities_sto_.params.md#enddate) + +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) + +expiry date of the sto + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_fundraiseCurrencies_](../interfaces/_entities_sto_.params.md#fundraisecurrencies) + +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) + +currencies that can be used to fundraise in this sto + +### investorCount + +• **investorCount**: _number_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_investorCount_](../interfaces/_entities_sto_.params.md#investorcount) + +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) + +number of investors in the sto + +### isFinalized + +• **isFinalized**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_isFinalized_](../interfaces/_entities_sto_.params.md#isfinalized) + +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) + +whether or not the sto has been finalized + +### isPaused + +• **isPaused**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_isPaused_](../interfaces/_entities_sto_.params.md#ispaused) + +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) + +whether or not the sto is currently paused + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_preIssueAllowed_](../interfaces/_entities_sto_.params.md#preissueallowed) + +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) + +whether or not pre issuance is allowed for the sto + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_raisedAmount_](../interfaces/_entities_sto_.params.md#raisedamount) + +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) + +funds that have been raised to this date + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_raisedFundsWallet_](../interfaces/_entities_sto_.params.md#raisedfundswallet) + +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) + +wallet address where raised funds will be stored + +### rate + +• **rate**: _BigNumber_ + +_Defined in_ [_src/entities/SimpleSto.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L28) + +rate at which tokens will be sold + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_securityTokenSymbol_](../interfaces/_entities_sto_.params.md#securitytokensymbol) + +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) + +symbol of security token + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_soldTokensAmount_](../interfaces/_entities_sto_.params.md#soldtokensamount) + +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) + +amount of tokens that have been sold + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_startDate_](../interfaces/_entities_sto_.params.md#startdate) + +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) + +start date of the sto + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_unsoldTokensWallet_](../interfaces/_entities_sto_.params.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) + +wallet address where unsold tokens will be returned to + diff --git a/docs/api/external-modules/_entities_simplesto_.simplesto.md b/docs/api/external-modules/_entities_simplesto_.simplesto.md new file mode 100644 index 0000000..c6f5c7e --- /dev/null +++ b/docs/api/external-modules/_entities_simplesto_.simplesto.md @@ -0,0 +1,506 @@ +# SimpleSto + +Class used to manage a simple sto + +## Hierarchy + +↳ [Sto](../classes/_entities_sto_.sto.md)‹[Params](../interfaces/_entities_simplesto_.params.md)› + +↳ **SimpleSto** + +## Index + +### Constructors + +* [constructor](../classes/_entities_simplesto_.simplesto.md#constructor) + +### Properties + +* [address](../classes/_entities_simplesto_.simplesto.md#address) +* [beneficialInvestmentsAllowed](../classes/_entities_simplesto_.simplesto.md#beneficialinvestmentsallowed) +* [cap](../classes/_entities_simplesto_.simplesto.md#cap) +* [capReached](../classes/_entities_simplesto_.simplesto.md#capreached) +* [context](../classes/_entities_simplesto_.simplesto.md#protected-context) +* [endDate](../classes/_entities_simplesto_.simplesto.md#enddate) +* [fundraiseCurrencies](../classes/_entities_simplesto_.simplesto.md#fundraisecurrencies) +* [investorCount](../classes/_entities_simplesto_.simplesto.md#investorcount) +* [isFinalized](../classes/_entities_simplesto_.simplesto.md#isfinalized) +* [isPaused](../classes/_entities_simplesto_.simplesto.md#ispaused) +* [preIssueAllowed](../classes/_entities_simplesto_.simplesto.md#preissueallowed) +* [raisedAmount](../classes/_entities_simplesto_.simplesto.md#raisedamount) +* [raisedFundsWallet](../classes/_entities_simplesto_.simplesto.md#raisedfundswallet) +* [rate](../classes/_entities_simplesto_.simplesto.md#rate) +* [securityTokenId](../classes/_entities_simplesto_.simplesto.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_simplesto_.simplesto.md#securitytokensymbol) +* [soldTokensAmount](../classes/_entities_simplesto_.simplesto.md#soldtokensamount) +* [startDate](../classes/_entities_simplesto_.simplesto.md#startdate) +* [stoType](../classes/_entities_simplesto_.simplesto.md#stotype) +* [uid](../classes/_entities_simplesto_.simplesto.md#uid) +* [unsoldTokensWallet](../classes/_entities_simplesto_.simplesto.md#unsoldtokenswallet) + +### Methods + +* [\_refresh](../classes/_entities_simplesto_.simplesto.md#_refresh) +* [allowBeneficialInvestments](../classes/_entities_simplesto_.simplesto.md#allowbeneficialinvestments) +* [allowPreIssuing](../classes/_entities_simplesto_.simplesto.md#allowpreissuing) +* [assignRole](../classes/_entities_simplesto_.simplesto.md#assignrole) +* [disallowBeneficialInvestments](../classes/_entities_simplesto_.simplesto.md#disallowbeneficialinvestments) +* [disallowPreIssuing](../classes/_entities_simplesto_.simplesto.md#disallowpreissuing) +* [finalize](../classes/_entities_simplesto_.simplesto.md#finalize) +* [getInvestments](../classes/_entities_simplesto_.simplesto.md#getinvestments) +* [invest](../classes/_entities_simplesto_.simplesto.md#invest) +* [pause](../classes/_entities_simplesto_.simplesto.md#pause) +* [revokeRole](../classes/_entities_simplesto_.simplesto.md#revokerole) +* [toPojo](../classes/_entities_simplesto_.simplesto.md#topojo) +* [unpause](../classes/_entities_simplesto_.simplesto.md#unpause) +* [generateId](../classes/_entities_simplesto_.simplesto.md#static-generateid) +* [unserialize](../classes/_entities_simplesto_.simplesto.md#static-unserialize) + +## Constructors + +### constructor + ++ **new SimpleSto**\(`params`: [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_constructor_](../classes/_entities_sto_.sto.md#constructor) + +_Defined in_ [_src/entities/SimpleSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61) + +Create a new simple sto instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_simplesto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) + +## Properties + +### address + +• **address**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_address_](../classes/_entities_sto_.sto.md#address) + +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) + +ethereum address for the STO + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_beneficialInvestmentsAllowed_](../classes/_entities_sto_.sto.md#beneficialinvestmentsallowed) + +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) + +whether investments can be made on behalf of a beneficiary or not + +### cap + +• **cap**: _BigNumber_ + +_Defined in_ [_src/entities/SimpleSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L56) + +cap of total tokens that can be sold in sto + +### capReached + +• **capReached**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_capReached_](../classes/_entities_sto_.sto.md#capreached) + +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) + +whether the STO cap has been reached or not + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_context_](../classes/_entities_sto_.sto.md#protected-context) + +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_endDate_](../classes/_entities_sto_.sto.md#enddate) + +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_fundraiseCurrencies_](../classes/_entities_sto_.sto.md#fundraisecurrencies) + +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) + +types of currency in which funds can be raised + +### investorCount + +• **investorCount**: _number_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_investorCount_](../classes/_entities_sto_.sto.md#investorcount) + +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) + +number of investors that have purchased tokens in the STO + +### isFinalized + +• **isFinalized**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_isFinalized_](../classes/_entities_sto_.sto.md#isfinalized) + +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) + +whether the STO has been finalized or not + +### isPaused + +• **isPaused**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_isPaused_](../classes/_entities_sto_.sto.md#ispaused) + +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) + +whether the STO is currently paused or not + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_preIssueAllowed_](../classes/_entities_sto_.sto.md#preissueallowed) + +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) + +whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_raisedAmount_](../classes/_entities_sto_.sto.md#raisedamount) + +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) + +amount of funds that have been raised so far + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_raisedFundsWallet_](../classes/_entities_sto_.sto.md#raisedfundswallet) + +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) + +wallet where raised funds will be forwarded to + +### rate + +• **rate**: _BigNumber_ + +_Defined in_ [_src/entities/SimpleSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L61) + +rate at which the tokens will be sold in sto + +### securityTokenId + +• **securityTokenId**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_securityTokenId_](../classes/_entities_sto_.sto.md#securitytokenid) + +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_securityTokenSymbol_](../classes/_entities_sto_.sto.md#securitytokensymbol) + +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_soldTokensAmount_](../classes/_entities_sto_.sto.md#soldtokensamount) + +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) + +total number of tokens that have been sold so far + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_startDate_](../classes/_entities_sto_.sto.md#startdate) + +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_stoType_](../classes/_entities_sto_.sto.md#stotype) + +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) + +type of STO setup + +### uid + +• **uid**: _string_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_uid_](../classes/_entities_sto_.sto.md#abstract-uid) + +_Defined in_ [_src/entities/SimpleSto.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L51) + +unique generated Tiered STO id + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_unsoldTokensWallet_](../classes/_entities_sto_.sto.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) + +wallet where unsold tokens will be returned to + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_simplesto_.params.md)›\): _void_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_\_refresh_](../classes/_entities_sto_.sto.md#_refresh) + +_Defined in_ [_src/entities/SimpleSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L151) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_simplesto_.params.md)› | + +**Returns:** _void_ + +### allowBeneficialInvestments + +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) + +Enable a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### allowPreIssuing + +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) + +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### assignRole + +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) + +Assign a role on the STO to a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### disallowBeneficialInvestments + +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) + +Disable the possibility for a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### disallowPreIssuing + +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) + +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### finalize + +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) + +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +### getInvestments + +▸ **getInvestments**\(\): _Promise‹_[_Investment_](../classes/_entities_investment_.investment.md)_\[\]›_ + +_Defined in_ [_src/entities/SimpleSto.ts:81_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L81) + +Retrieve all investments that have been made on this STO + +**Returns:** _Promise‹_[_Investment_](../classes/_entities_investment_.investment.md)_\[\]›_ + +### invest + +▸ **invest**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/SimpleSto.ts:126_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L126) + +Invest in the STO + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | Description | +| :--- | :--- | :--- | +| `amount` | BigNumber | amount to spend | +| `beneficiary?` | undefined \| string | address that will receive the purchased tokens \(defaults to current wallet, will fail if beneficial investments are not allowed for the STO, only applicable if the STO currency is ETH\) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md)_, void››_ + +### pause + +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) + +Pause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### revokeRole + +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) + +Remove a role from a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_toPojo_](../classes/_entities_sto_.sto.md#topojo) + +_Defined in_ [_src/entities/SimpleSto.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L137) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **cap**: _BigNumber_ +* **rate**: _BigNumber_ + +### unpause + +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) + +Unpause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/SimpleSto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L40) + +Generate the Simple STO's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | +| `stoType` | [StoType](../enums/_types_index_.stotype.md) | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_unserialize_](../classes/_entities_sto_.sto.md#static-unserialize) + +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) + +Unserialize string to a Security Token Offering object representation + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_sto_.md b/docs/api/external-modules/_entities_sto_.md similarity index 53% rename from docs/api/modules/_entities_sto_.md rename to docs/api/external-modules/_entities_sto_.md index 8454b23..c26b850 100644 --- a/docs/api/modules/_entities_sto_.md +++ b/docs/api/external-modules/_entities_sto_.md @@ -1,4 +1,4 @@ -# External module: "entities/Sto" +# entities/Sto ## Index @@ -17,18 +17,19 @@ ## Functions -### isUniqueIdentifiers +### isUniqueIdentifiers -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* +▸ **isUniqueIdentifiers**\(`identifiers`: any\): _identifiers is UniqueIdentifiers_ -*Defined in [src/entities/Sto.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L27)* +_Defined in_ [_src/entities/Sto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L27) Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | any | +| Name | Type | +| :--- | :--- | +| `identifiers` | any | + +**Returns:** _identifiers is UniqueIdentifiers_ -**Returns:** *identifiers is UniqueIdentifiers* diff --git a/docs/api/external-modules/_entities_sto_.params.md b/docs/api/external-modules/_entities_sto_.params.md new file mode 100644 index 0000000..d1fe9f4 --- /dev/null +++ b/docs/api/external-modules/_entities_sto_.params.md @@ -0,0 +1,145 @@ +# Params + +STO constructor parameters + +## Hierarchy + +* **Params** + + ↳ [Params](../interfaces/_entities_simplesto_.params.md) + + ↳ [Params](../interfaces/_entities_tieredsto_.params.md) + +## Index + +### Properties + +* [beneficialInvestmentsAllowed](../interfaces/_entities_sto_.params.md#beneficialinvestmentsallowed) +* [capReached](../interfaces/_entities_sto_.params.md#capreached) +* [endDate](../interfaces/_entities_sto_.params.md#enddate) +* [fundraiseCurrencies](../interfaces/_entities_sto_.params.md#fundraisecurrencies) +* [investorCount](../interfaces/_entities_sto_.params.md#investorcount) +* [isFinalized](../interfaces/_entities_sto_.params.md#isfinalized) +* [isPaused](../interfaces/_entities_sto_.params.md#ispaused) +* [preIssueAllowed](../interfaces/_entities_sto_.params.md#preissueallowed) +* [raisedAmount](../interfaces/_entities_sto_.params.md#raisedamount) +* [raisedFundsWallet](../interfaces/_entities_sto_.params.md#raisedfundswallet) +* [securityTokenSymbol](../interfaces/_entities_sto_.params.md#securitytokensymbol) +* [soldTokensAmount](../interfaces/_entities_sto_.params.md#soldtokensamount) +* [startDate](../interfaces/_entities_sto_.params.md#startdate) +* [unsoldTokensWallet](../interfaces/_entities_sto_.params.md#unsoldtokenswallet) + +## Properties + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) + +whether or not investments can be made on behalf of a beneficiary in the sto + +### capReached + +• **capReached**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) + +whether or not the cap has been reached for the sto + +### endDate + +• **endDate**: _Date_ + +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) + +expiry date of the sto + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) + +currencies that can be used to fundraise in this sto + +### investorCount + +• **investorCount**: _number_ + +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) + +number of investors in the sto + +### isFinalized + +• **isFinalized**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) + +whether or not the sto has been finalized + +### isPaused + +• **isPaused**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) + +whether or not the sto is currently paused + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) + +whether or not pre issuance is allowed for the sto + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) + +funds that have been raised to this date + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) + +wallet address where raised funds will be stored + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) + +symbol of security token + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) + +amount of tokens that have been sold + +### startDate + +• **startDate**: _Date_ + +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) + +start date of the sto + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) + +wallet address where unsold tokens will be returned to + diff --git a/docs/api/external-modules/_entities_sto_.sto.md b/docs/api/external-modules/_entities_sto_.sto.md new file mode 100644 index 0000000..f5984d8 --- /dev/null +++ b/docs/api/external-modules/_entities_sto_.sto.md @@ -0,0 +1,401 @@ +# Sto + +Abstract class used as a base to manage sto functionalities + +## Type parameters + +▪ **P** + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹P› + + ↳ **Sto** + + ↳ [SimpleSto](../classes/_entities_simplesto_.simplesto.md) + + ↳ [TieredSto](../classes/_entities_tieredsto_.tieredsto.md) + +## Index + +### Constructors + +* [constructor](../classes/_entities_sto_.sto.md#constructor) + +### Properties + +* [address](../classes/_entities_sto_.sto.md#address) +* [beneficialInvestmentsAllowed](../classes/_entities_sto_.sto.md#beneficialinvestmentsallowed) +* [capReached](../classes/_entities_sto_.sto.md#capreached) +* [context](../classes/_entities_sto_.sto.md#protected-context) +* [endDate](../classes/_entities_sto_.sto.md#enddate) +* [fundraiseCurrencies](../classes/_entities_sto_.sto.md#fundraisecurrencies) +* [investorCount](../classes/_entities_sto_.sto.md#investorcount) +* [isFinalized](../classes/_entities_sto_.sto.md#isfinalized) +* [isPaused](../classes/_entities_sto_.sto.md#ispaused) +* [preIssueAllowed](../classes/_entities_sto_.sto.md#preissueallowed) +* [raisedAmount](../classes/_entities_sto_.sto.md#raisedamount) +* [raisedFundsWallet](../classes/_entities_sto_.sto.md#raisedfundswallet) +* [securityTokenId](../classes/_entities_sto_.sto.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_sto_.sto.md#securitytokensymbol) +* [soldTokensAmount](../classes/_entities_sto_.sto.md#soldtokensamount) +* [startDate](../classes/_entities_sto_.sto.md#startdate) +* [stoType](../classes/_entities_sto_.sto.md#stotype) +* [uid](../classes/_entities_sto_.sto.md#abstract-uid) +* [unsoldTokensWallet](../classes/_entities_sto_.sto.md#unsoldtokenswallet) + +### Methods + +* [\_refresh](../classes/_entities_sto_.sto.md#_refresh) +* [allowBeneficialInvestments](../classes/_entities_sto_.sto.md#allowbeneficialinvestments) +* [allowPreIssuing](../classes/_entities_sto_.sto.md#allowpreissuing) +* [assignRole](../classes/_entities_sto_.sto.md#assignrole) +* [disallowBeneficialInvestments](../classes/_entities_sto_.sto.md#disallowbeneficialinvestments) +* [disallowPreIssuing](../classes/_entities_sto_.sto.md#disallowpreissuing) +* [finalize](../classes/_entities_sto_.sto.md#finalize) +* [pause](../classes/_entities_sto_.sto.md#pause) +* [revokeRole](../classes/_entities_sto_.sto.md#revokerole) +* [toPojo](../classes/_entities_sto_.sto.md#topojo) +* [unpause](../classes/_entities_sto_.sto.md#unpause) +* [unserialize](../classes/_entities_sto_.sto.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Sto**\(`params`: [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L195) + +Create a new sto instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_sto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Sto_](../classes/_entities_sto_.sto.md) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) + +ethereum address for the STO + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) + +whether investments can be made on behalf of a beneficiary or not + +### capReached + +• **capReached**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) + +whether the STO cap has been reached or not + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) + +### endDate + +• **endDate**: _Date_ + +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) + +types of currency in which funds can be raised + +### investorCount + +• **investorCount**: _number_ + +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) + +number of investors that have purchased tokens in the STO + +### isFinalized + +• **isFinalized**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) + +whether the STO has been finalized or not + +### isPaused + +• **isPaused**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) + +whether the STO is currently paused or not + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) + +whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) + +amount of funds that have been raised so far + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) + +wallet where raised funds will be forwarded to + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) + +total number of tokens that have been sold so far + +### startDate + +• **startDate**: _Date_ + +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) + +type of STO setup + +### `Abstract` uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Sto.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L102) + +Uniquely generated id for the STO + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) + +wallet where unsold tokens will be returned to + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_sto_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Sto.ts:438_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L438) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_sto_.params.md)› | + +**Returns:** _void_ + +### allowBeneficialInvestments + +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) + +Enable a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### allowPreIssuing + +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) + +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### assignRole + +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) + +Assign a role on the STO to a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### disallowBeneficialInvestments + +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) + +Disable the possibility for a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### disallowPreIssuing + +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) + +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### finalize + +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) + +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +### pause + +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) + +Pause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### revokeRole + +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) + +Remove a role from a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Sto.ts:393_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L393) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **address**: _string_ +* **beneficialInvestmentsAllowed**: _boolean_ +* **capReached**: _boolean_ +* **endDate**: _Date_ +* **fundraiseCurrencies**: _FundRaiseType\[\]_ +* **investorCount**: _number_ +* **isFinalized**: _boolean_ +* **isPaused**: _boolean_ +* **preIssueAllowed**: _boolean_ +* **raisedAmount**: _BigNumber_ +* **raisedFundsWallet**: _string_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **soldTokensAmount**: _BigNumber_ +* **startDate**: _Date_ +* **uid**: _string_ +* **unsoldTokensWallet**: _string_ + +### unpause + +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) + +Unpause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) + +Unserialize string to a Security Token Offering object representation + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_sto_.uniqueidentifiers.md b/docs/api/external-modules/_entities_sto_.uniqueidentifiers.md new file mode 100644 index 0000000..a04baa9 --- /dev/null +++ b/docs/api/external-modules/_entities_sto_.uniqueidentifiers.md @@ -0,0 +1,36 @@ +# UniqueIdentifiers + +Properties that uniquely identify an STO + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [address](../interfaces/_entities_sto_.uniqueidentifiers.md#address) +* [securityTokenId](../interfaces/_entities_sto_.uniqueidentifiers.md#securitytokenid) +* [stoType](../interfaces/_entities_sto_.uniqueidentifiers.md#stotype) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Sto.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L21) + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Sto.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L19) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/entities/Sto.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L20) + diff --git a/docs/api/modules/_entities_taxwithholding_.md b/docs/api/external-modules/_entities_taxwithholding_.md similarity index 85% rename from docs/api/modules/_entities_taxwithholding_.md rename to docs/api/external-modules/_entities_taxwithholding_.md index d128745..8533369 100644 --- a/docs/api/modules/_entities_taxwithholding_.md +++ b/docs/api/external-modules/_entities_taxwithholding_.md @@ -1,4 +1,4 @@ -# External module: "entities/TaxWithholding" +# entities/TaxWithholding ## Index @@ -10,3 +10,4 @@ * [Params](../interfaces/_entities_taxwithholding_.params.md) * [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_taxwithholding_.params.md b/docs/api/external-modules/_entities_taxwithholding_.params.md new file mode 100644 index 0000000..a9e2e99 --- /dev/null +++ b/docs/api/external-modules/_entities_taxwithholding_.params.md @@ -0,0 +1,29 @@ +# Params + +Constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [percentage](../interfaces/_entities_taxwithholding_.params.md#percentage) +* [securityTokenSymbol](../interfaces/_entities_taxwithholding_.params.md#securitytokensymbol) + +## Properties + +### percentage + +• **percentage**: _number_ + +_Defined in_ [_src/entities/TaxWithholding.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L33) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L32) + diff --git a/docs/api/external-modules/_entities_taxwithholding_.taxwithholding.md b/docs/api/external-modules/_entities_taxwithholding_.taxwithholding.md new file mode 100644 index 0000000..d007297 --- /dev/null +++ b/docs/api/external-modules/_entities_taxwithholding_.taxwithholding.md @@ -0,0 +1,160 @@ +# TaxWithholding + +Represents the percentage that should be withheld from a Tokenholder's dividend payment for tax purposes + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_taxwithholding_.params.md)› + + ↳ **TaxWithholding** + +## Index + +### Constructors + +* [constructor](../classes/_entities_taxwithholding_.taxwithholding.md#constructor) + +### Properties + +* [percentage](../classes/_entities_taxwithholding_.taxwithholding.md#percentage) +* [securityTokenId](../classes/_entities_taxwithholding_.taxwithholding.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_taxwithholding_.taxwithholding.md#securitytokensymbol) +* [tokenholderAddress](../classes/_entities_taxwithholding_.taxwithholding.md#tokenholderaddress) +* [uid](../classes/_entities_taxwithholding_.taxwithholding.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_taxwithholding_.taxwithholding.md#_refresh) +* [toPojo](../classes/_entities_taxwithholding_.taxwithholding.md#topojo) +* [generateId](../classes/_entities_taxwithholding_.taxwithholding.md#static-generateid) +* [unserialize](../classes/_entities_taxwithholding_.taxwithholding.md#static-unserialize) + +## Constructors + +### constructor + ++ **new TaxWithholding**\(`params`: [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md)\): [_TaxWithholding_](../classes/_entities_taxwithholding_.taxwithholding.md) + +_Defined in_ [_src/entities/TaxWithholding.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82) + +Create a new tax withholding instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_taxwithholding_.params.md) & [UniqueIdentifiers](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) | + +**Returns:** [_TaxWithholding_](../classes/_entities_taxwithholding_.taxwithholding.md) + +## Properties + +### percentage + +• **percentage**: _number_ + +_Defined in_ [_src/entities/TaxWithholding.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L82) + +percentage of tax to be withheld \(0 to 1\) + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L75) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L73) + +### tokenholderAddress + +• **tokenholderAddress**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L77) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/TaxWithholding.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L71) + +unique generated identifer for tax withholding entity + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/TaxWithholding.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L120) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_taxwithholding_.params.md)› | + +**Returns:** _void_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/TaxWithholding.ts:105_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L105) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **percentage**: _number_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **tokenholderAddress**: _string_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L43) + +Generate the Tax Withholding's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `securityTokenId` | string | +| `tokenholderAddress` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/TaxWithholding.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L55) + +Unserialize a serialized entity of tax withholding information + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with tax withholding information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_taxwithholding_.uniqueidentifiers.md b/docs/api/external-modules/_entities_taxwithholding_.uniqueidentifiers.md new file mode 100644 index 0000000..909722b --- /dev/null +++ b/docs/api/external-modules/_entities_taxwithholding_.uniqueidentifiers.md @@ -0,0 +1,29 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Tax Withholding percentage + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [securityTokenId](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md#securitytokenid) +* [tokenholderAddress](../interfaces/_entities_taxwithholding_.uniqueidentifiers.md#tokenholderaddress) + +## Properties + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L10) + +### tokenholderAddress + +• **tokenholderAddress**: _string_ + +_Defined in_ [_src/entities/TaxWithholding.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L11) + diff --git a/docs/api/modules/_entities_tieredsto_.md b/docs/api/external-modules/_entities_tieredsto_.md similarity index 56% rename from docs/api/modules/_entities_tieredsto_.md rename to docs/api/external-modules/_entities_tieredsto_.md index 4609dd2..e21e0d7 100644 --- a/docs/api/modules/_entities_tieredsto_.md +++ b/docs/api/external-modules/_entities_tieredsto_.md @@ -1,4 +1,4 @@ -# External module: "entities/TieredSto" +# entities/TieredSto ## Index @@ -17,8 +17,9 @@ ## Variables -### weiToValue +### weiToValue -• **weiToValue**: *weiToValue* +• **weiToValue**: _weiToValue_ + +_Defined in_ [_src/entities/TieredSto.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L19) -*Defined in [src/entities/TieredSto.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L19)* diff --git a/docs/api/external-modules/_entities_tieredsto_.params.md b/docs/api/external-modules/_entities_tieredsto_.params.md new file mode 100644 index 0000000..f001fae --- /dev/null +++ b/docs/api/external-modules/_entities_tieredsto_.params.md @@ -0,0 +1,210 @@ +# Params + +Represents a Tiered STO + +## Hierarchy + +* [Params](../interfaces/_entities_sto_.params.md) + + ↳ **Params** + +## Index + +### Properties + +* [beneficialInvestmentsAllowed](../interfaces/_entities_tieredsto_.params.md#beneficialinvestmentsallowed) +* [capReached](../interfaces/_entities_tieredsto_.params.md#capreached) +* [currentTier](../interfaces/_entities_tieredsto_.params.md#currenttier) +* [endDate](../interfaces/_entities_tieredsto_.params.md#enddate) +* [fundraiseCurrencies](../interfaces/_entities_tieredsto_.params.md#fundraisecurrencies) +* [investorCount](../interfaces/_entities_tieredsto_.params.md#investorcount) +* [isFinalized](../interfaces/_entities_tieredsto_.params.md#isfinalized) +* [isPaused](../interfaces/_entities_tieredsto_.params.md#ispaused) +* [minimumInvestment](../interfaces/_entities_tieredsto_.params.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_entities_tieredsto_.params.md#nonaccreditedinvestmentlimit) +* [preIssueAllowed](../interfaces/_entities_tieredsto_.params.md#preissueallowed) +* [raisedAmount](../interfaces/_entities_tieredsto_.params.md#raisedamount) +* [raisedFundsWallet](../interfaces/_entities_tieredsto_.params.md#raisedfundswallet) +* [securityTokenSymbol](../interfaces/_entities_tieredsto_.params.md#securitytokensymbol) +* [soldTokensAmount](../interfaces/_entities_tieredsto_.params.md#soldtokensamount) +* [stableCoinAddresses](../interfaces/_entities_tieredsto_.params.md#stablecoinaddresses) +* [startDate](../interfaces/_entities_tieredsto_.params.md#startdate) +* [tiers](../interfaces/_entities_tieredsto_.params.md#tiers) +* [unsoldTokensWallet](../interfaces/_entities_tieredsto_.params.md#unsoldtokenswallet) + +## Properties + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_beneficialInvestmentsAllowed_](../interfaces/_entities_sto_.params.md#beneficialinvestmentsallowed) + +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) + +whether or not investments can be made on behalf of a beneficiary in the sto + +### capReached + +• **capReached**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_capReached_](../interfaces/_entities_sto_.params.md#capreached) + +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) + +whether or not the cap has been reached for the sto + +### currentTier + +• **currentTier**: _number_ + +_Defined in_ [_src/entities/TieredSto.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L57) + +numerical identifier for the current tier index + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_endDate_](../interfaces/_entities_sto_.params.md#enddate) + +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) + +expiry date of the sto + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_fundraiseCurrencies_](../interfaces/_entities_sto_.params.md#fundraisecurrencies) + +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) + +currencies that can be used to fundraise in this sto + +### investorCount + +• **investorCount**: _number_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_investorCount_](../interfaces/_entities_sto_.params.md#investorcount) + +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) + +number of investors in the sto + +### isFinalized + +• **isFinalized**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_isFinalized_](../interfaces/_entities_sto_.params.md#isfinalized) + +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) + +whether or not the sto has been finalized + +### isPaused + +• **isPaused**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_isPaused_](../interfaces/_entities_sto_.params.md#ispaused) + +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) + +whether or not the sto is currently paused + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:63_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L63) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L62) + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_preIssueAllowed_](../interfaces/_entities_sto_.params.md#preissueallowed) + +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) + +whether or not pre issuance is allowed for the sto + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_raisedAmount_](../interfaces/_entities_sto_.params.md#raisedamount) + +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) + +funds that have been raised to this date + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_raisedFundsWallet_](../interfaces/_entities_sto_.params.md#raisedfundswallet) + +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) + +wallet address where raised funds will be stored + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_securityTokenSymbol_](../interfaces/_entities_sto_.params.md#securitytokensymbol) + +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) + +symbol of security token + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_soldTokensAmount_](../interfaces/_entities_sto_.params.md#soldtokensamount) + +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) + +amount of tokens that have been sold + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Defined in_ [_src/entities/TieredSto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L64) + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_startDate_](../interfaces/_entities_sto_.params.md#startdate) + +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) + +start date of the sto + +### tiers + +• **tiers**: [_Tier_](../interfaces/_entities_tieredsto_.tier.md)_\[\]_ + +_Defined in_ [_src/entities/TieredSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L61) + +array of tier information + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_Params_](../interfaces/_entities_sto_.params.md)_._[_unsoldTokensWallet_](../interfaces/_entities_sto_.params.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) + +wallet address where unsold tokens will be returned to + diff --git a/docs/api/external-modules/_entities_tieredsto_.tier.md b/docs/api/external-modules/_entities_tieredsto_.tier.md new file mode 100644 index 0000000..66af09c --- /dev/null +++ b/docs/api/external-modules/_entities_tieredsto_.tier.md @@ -0,0 +1,67 @@ +# Tier + +## Hierarchy + +* **Tier** + +## Index + +### Properties + +* [discountedPrice](../interfaces/_entities_tieredsto_.tier.md#discountedprice) +* [price](../interfaces/_entities_tieredsto_.tier.md#price) +* [tokensOnSale](../interfaces/_entities_tieredsto_.tier.md#tokensonsale) +* [tokensSold](../interfaces/_entities_tieredsto_.tier.md#tokenssold) +* [tokensSoldAtDiscount](../interfaces/_entities_tieredsto_.tier.md#tokenssoldatdiscount) +* [tokensWithDiscount](../interfaces/_entities_tieredsto_.tier.md#tokenswithdiscount) + +## Properties + +### discountedPrice + +• **discountedPrice**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L47) + +discounted price at which tokens will be sold + +### price + +• **price**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L35) + +price at which tokens will be sold within the tier + +### tokensOnSale + +• **tokensOnSale**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L27) + +total number of tokens that are available in the tier + +### tokensSold + +• **tokensSold**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L31) + +total number of tokens that have been sold + +### tokensSoldAtDiscount + +• **tokensSoldAtDiscount**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L43) + +total number of tokens that have been sold at a discount + +### tokensWithDiscount + +• **tokensWithDiscount**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L39) + +total number of tokens that are available to be sold at a discount when paid in POLY + diff --git a/docs/api/external-modules/_entities_tieredsto_.tieredsto.md b/docs/api/external-modules/_entities_tieredsto_.tieredsto.md new file mode 100644 index 0000000..8f0e384 --- /dev/null +++ b/docs/api/external-modules/_entities_tieredsto_.tieredsto.md @@ -0,0 +1,581 @@ +# TieredSto + +Used to manage a tiered sto + +## Hierarchy + +↳ [Sto](../classes/_entities_sto_.sto.md)‹[Params](../interfaces/_entities_tieredsto_.params.md)› + +↳ **TieredSto** + +## Index + +### Constructors + +* [constructor](../classes/_entities_tieredsto_.tieredsto.md#constructor) + +### Properties + +* [address](../classes/_entities_tieredsto_.tieredsto.md#address) +* [beneficialInvestmentsAllowed](../classes/_entities_tieredsto_.tieredsto.md#beneficialinvestmentsallowed) +* [capReached](../classes/_entities_tieredsto_.tieredsto.md#capreached) +* [context](../classes/_entities_tieredsto_.tieredsto.md#protected-context) +* [currentTier](../classes/_entities_tieredsto_.tieredsto.md#currenttier) +* [endDate](../classes/_entities_tieredsto_.tieredsto.md#enddate) +* [fundraiseCurrencies](../classes/_entities_tieredsto_.tieredsto.md#fundraisecurrencies) +* [investorCount](../classes/_entities_tieredsto_.tieredsto.md#investorcount) +* [isFinalized](../classes/_entities_tieredsto_.tieredsto.md#isfinalized) +* [isPaused](../classes/_entities_tieredsto_.tieredsto.md#ispaused) +* [minimumInvestment](../classes/_entities_tieredsto_.tieredsto.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../classes/_entities_tieredsto_.tieredsto.md#nonaccreditedinvestmentlimit) +* [preIssueAllowed](../classes/_entities_tieredsto_.tieredsto.md#preissueallowed) +* [raisedAmount](../classes/_entities_tieredsto_.tieredsto.md#raisedamount) +* [raisedFundsWallet](../classes/_entities_tieredsto_.tieredsto.md#raisedfundswallet) +* [securityTokenId](../classes/_entities_tieredsto_.tieredsto.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_tieredsto_.tieredsto.md#securitytokensymbol) +* [soldTokensAmount](../classes/_entities_tieredsto_.tieredsto.md#soldtokensamount) +* [stableCoinAddresses](../classes/_entities_tieredsto_.tieredsto.md#stablecoinaddresses) +* [startDate](../classes/_entities_tieredsto_.tieredsto.md#startdate) +* [stoType](../classes/_entities_tieredsto_.tieredsto.md#stotype) +* [tiers](../classes/_entities_tieredsto_.tieredsto.md#tiers) +* [uid](../classes/_entities_tieredsto_.tieredsto.md#uid) +* [unsoldTokensWallet](../classes/_entities_tieredsto_.tieredsto.md#unsoldtokenswallet) + +### Methods + +* [\_refresh](../classes/_entities_tieredsto_.tieredsto.md#_refresh) +* [allowBeneficialInvestments](../classes/_entities_tieredsto_.tieredsto.md#allowbeneficialinvestments) +* [allowPreIssuing](../classes/_entities_tieredsto_.tieredsto.md#allowpreissuing) +* [assignRole](../classes/_entities_tieredsto_.tieredsto.md#assignrole) +* [disallowBeneficialInvestments](../classes/_entities_tieredsto_.tieredsto.md#disallowbeneficialinvestments) +* [disallowPreIssuing](../classes/_entities_tieredsto_.tieredsto.md#disallowpreissuing) +* [finalize](../classes/_entities_tieredsto_.tieredsto.md#finalize) +* [getCurrency](../classes/_entities_tieredsto_.tieredsto.md#getcurrency) +* [getInvestments](../classes/_entities_tieredsto_.tieredsto.md#getinvestments) +* [invest](../classes/_entities_tieredsto_.tieredsto.md#invest) +* [modifyData](../classes/_entities_tieredsto_.tieredsto.md#modifydata) +* [pause](../classes/_entities_tieredsto_.tieredsto.md#pause) +* [revokeRole](../classes/_entities_tieredsto_.tieredsto.md#revokerole) +* [toPojo](../classes/_entities_tieredsto_.tieredsto.md#topojo) +* [unpause](../classes/_entities_tieredsto_.tieredsto.md#unpause) +* [generateId](../classes/_entities_tieredsto_.tieredsto.md#static-generateid) +* [unserialize](../classes/_entities_tieredsto_.tieredsto.md#static-unserialize) + +## Constructors + +### constructor + ++ **new TieredSto**\(`params`: [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md), `context`: [Context](../classes/_context_.context.md)\): [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md) + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_constructor_](../classes/_entities_sto_.sto.md#constructor) + +_Defined in_ [_src/entities/TieredSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151) + +Create a new tiered sto instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_tieredsto_.params.md) & [UniqueIdentifiers](../interfaces/_entities_sto_.uniqueidentifiers.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md) + +## Properties + +### address + +• **address**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_address_](../classes/_entities_sto_.sto.md#address) + +_Defined in_ [_src/entities/Sto.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L107) + +ethereum address for the STO + +### beneficialInvestmentsAllowed + +• **beneficialInvestmentsAllowed**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_beneficialInvestmentsAllowed_](../classes/_entities_sto_.sto.md#beneficialinvestmentsallowed) + +_Defined in_ [_src/entities/Sto.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L175) + +whether investments can be made on behalf of a beneficiary or not + +### capReached + +• **capReached**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_capReached_](../classes/_entities_sto_.sto.md#capreached) + +_Defined in_ [_src/entities/Sto.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L160) + +whether the STO cap has been reached or not + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_context_](../classes/_entities_sto_.sto.md#protected-context) + +_Defined in_ [_src/entities/Sto.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L177) + +### currentTier + +• **currentTier**: _number_ + +_Defined in_ [_src/entities/TieredSto.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L134) + +index of the current active tier + +### endDate + +• **endDate**: _Date_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_endDate_](../classes/_entities_sto_.sto.md#enddate) + +_Defined in_ [_src/entities/Sto.ts:120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L120) + +### fundraiseCurrencies + +• **fundraiseCurrencies**: _Currency\[\]_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_fundraiseCurrencies_](../classes/_entities_sto_.sto.md#fundraisecurrencies) + +_Defined in_ [_src/entities/Sto.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L150) + +types of currency in which funds can be raised + +### investorCount + +• **investorCount**: _number_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_investorCount_](../classes/_entities_sto_.sto.md#investorcount) + +_Defined in_ [_src/entities/Sto.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L145) + +number of investors that have purchased tokens in the STO + +### isFinalized + +• **isFinalized**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_isFinalized_](../classes/_entities_sto_.sto.md#isfinalized) + +_Defined in_ [_src/entities/Sto.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L165) + +whether the STO has been finalized or not + +### isPaused + +• **isPaused**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_isPaused_](../classes/_entities_sto_.sto.md#ispaused) + +_Defined in_ [_src/entities/Sto.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L155) + +whether the STO is currently paused or not + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L141) + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Defined in_ [_src/entities/TieredSto.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L139) + +maximum investment allowed for non-accredited investors + +### preIssueAllowed + +• **preIssueAllowed**: _boolean_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_preIssueAllowed_](../classes/_entities_sto_.sto.md#preissueallowed) + +_Defined in_ [_src/entities/Sto.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L170) + +whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made + +### raisedAmount + +• **raisedAmount**: _BigNumber_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_raisedAmount_](../classes/_entities_sto_.sto.md#raisedamount) + +_Defined in_ [_src/entities/Sto.ts:135_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L135) + +amount of funds that have been raised so far + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_raisedFundsWallet_](../classes/_entities_sto_.sto.md#raisedfundswallet) + +_Defined in_ [_src/entities/Sto.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L125) + +wallet where raised funds will be forwarded to + +### securityTokenId + +• **securityTokenId**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_securityTokenId_](../classes/_entities_sto_.sto.md#securitytokenid) + +_Defined in_ [_src/entities/Sto.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L111) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_securityTokenSymbol_](../classes/_entities_sto_.sto.md#securitytokensymbol) + +_Defined in_ [_src/entities/Sto.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L109) + +### soldTokensAmount + +• **soldTokensAmount**: _BigNumber_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_soldTokensAmount_](../classes/_entities_sto_.sto.md#soldtokensamount) + +_Defined in_ [_src/entities/Sto.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L140) + +total number of tokens that have been sold so far + +### stableCoinAddresses + +• **stableCoinAddresses**: _string\[\]_ + +_Defined in_ [_src/entities/TieredSto.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L146) + +array of Stable Coin ERC20 tokens that can be used to purchase tokens in this Offering + +### startDate + +• **startDate**: _Date_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_startDate_](../classes/_entities_sto_.sto.md#startdate) + +_Defined in_ [_src/entities/Sto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L118) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_stoType_](../classes/_entities_sto_.sto.md#stotype) + +_Defined in_ [_src/entities/Sto.ts:116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L116) + +type of STO setup + +### tiers + +• **tiers**: [_Tier_](../interfaces/_entities_tieredsto_.tier.md)_\[\]_ + +_Defined in_ [_src/entities/TieredSto.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L151) + +array of tier information + +### uid + +• **uid**: _string_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_uid_](../classes/_entities_sto_.sto.md#abstract-uid) + +_Defined in_ [_src/entities/TieredSto.ts:129_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L129) + +unique generated Tiered STO id + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_unsoldTokensWallet_](../classes/_entities_sto_.sto.md#unsoldtokenswallet) + +_Defined in_ [_src/entities/Sto.ts:130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L130) + +wallet where unsold tokens will be returned to + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)›\): _void_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_\_refresh_](../classes/_entities_sto_.sto.md#_refresh) + +_Defined in_ [_src/entities/TieredSto.ts:349_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L349) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_tieredsto_.params.md)› | + +**Returns:** _void_ + +### allowBeneficialInvestments + +▸ **allowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:316_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L316) + +Enable a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### allowPreIssuing + +▸ **allowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:287_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L287) + +Enable all offered tokens to be issued instantly at STO start \(default behavior is to issue on purchase\) Can be disabled _BEFORE_ the STO starts by calling disallowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### assignRole + +▸ **assignRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:348_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L348) + +Assign a role on the STO to a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `description?` | undefined \| string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### disallowBeneficialInvestments + +▸ **disallowBeneficialInvestments**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:330_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L330) + +Disable the possibility for a party to invest in the STO on behalf of another party + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)_, void››_ + +### disallowPreIssuing + +▸ **disallowPreIssuing**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:302_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L302) + +Disable pre-issuing of offered tokens at STO start \(goes back to default behavior, which is to issue on purchase\) Can be re-enabled _BEFORE_ the STO starts by calling allowPreIssuing + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)_, void››_ + +### finalize + +▸ **finalize**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L275) + +Finalize the offering. The offering's treasury wallet \(or the Security Token's treasury wallet if one was not specified for the offering\) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md)_, void››_ + +### getCurrency + +▸ **getCurrency**\(\): _Promise‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ + +_Defined in_ [_src/entities/TieredSto.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L225) + +Retrieve the denomination in which the tokens are priced in this STO + +**Returns:** _Promise‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ + +### getInvestments + +▸ **getInvestments**\(\): _Promise‹_[_Investment_](../classes/_entities_investment_.investment.md)_\[\]›_ + +_Defined in_ [_src/entities/TieredSto.ts:181_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L181) + +Retrieve all investments that have been made on this STO + +**Returns:** _Promise‹_[_Investment_](../classes/_entities_investment_.investment.md)_\[\]›_ + +### invest + +▸ **invest**\(`params`: InvestInStableCoinParams\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](_types_index_.md#investintieredstoprocedureargs)_››_ + +_Defined in_ [_src/entities/TieredSto.ts:296_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L296) + +Invest in the STO + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | InvestInStableCoinParams | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](_types_index_.md#investintieredstoprocedureargs)_››_ + +▸ **invest**\(`params`: InvestInOtherParams\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](_types_index_.md#investintieredstoprocedureargs)_››_ + +_Defined in_ [_src/entities/TieredSto.ts:301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L301) + +Invest in the STO + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | InvestInOtherParams | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_InvestInTieredStoProcedureArgs_](_types_index_.md#investintieredstoprocedureargs)_››_ + +### modifyData + +▸ **modifyData**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)_, void››_ + +_Defined in_ [_src/entities/TieredSto.ts:277_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L277) + +Modify STO parameters. Must be done before the STO starts + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | Description | +| :--- | :--- | :--- | +| `customCurrency?` | Partial‹[CustomCurrency](../interfaces/_types_index_.customcurrency.md)› | custom currency data. Allows the STO to raise funds pegged to a different currency. Optional, defaults to USD | +| `endDate?` | Date | date when the STO should end | +| `fundariseCurrencies?` | Currency\[\] | - | +| `minimumInvestment?` | BigNumber | minimum investment amount | +| `nonAccreditedInvestmentLimit?` | BigNumber | maximum investment for non-accredited investors | +| `raisedFundsWallet?` | undefined \| string | wallet address that will receive the funds that are being raised | +| `stableCoinAddresses?` | string\[\] | addresses of supported stablecoins | +| `startDate?` | Date | date when the STO should start | +| `tiers?` | [StoTier](../interfaces/_types_index_.stotier.md)\[\] | tier information | +| `unsoldTokensWallet?` | undefined \| string | wallet address that will receive unsold tokens when the end date is reached | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)_, void››_ + +### pause + +▸ **pause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L246) + +Pause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### revokeRole + +▸ **revokeRole**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L374) + +Remove a role from a delegate + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `delegateAddress` | string | +| `role` | [StoRole](../enums/_types_index_.storole.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md)_, void››_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_toPojo_](../classes/_entities_sto_.sto.md#topojo) + +_Defined in_ [_src/entities/TieredSto.ts:335_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L335) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **currentTier**: _number_ +* **tiers**: [_Tier_](../interfaces/_entities_tieredsto_.tier.md)_\[\]_ + +### unpause + +▸ **unpause**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md) + +_Defined in_ [_src/entities/Sto.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L260) + +Unpause the offering + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md)_, void››_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/TieredSto.ts:118_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L118) + +Generate the Tiered STO's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | +| `stoType` | [StoType](../enums/_types_index_.stotype.md) | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + +_Inherited from_ [_Sto_](../classes/_entities_sto_.sto.md)_._[_unserialize_](../classes/_entities_sto_.sto.md#static-unserialize) + +_Defined in_ [_src/entities/Sto.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L184) + +Unserialize string to a Security Token Offering object representation + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `serialized` | string | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_sto_.uniqueidentifiers.md) + diff --git a/docs/api/modules/_entities_tokenholder_.md b/docs/api/external-modules/_entities_tokenholder_.md similarity index 85% rename from docs/api/modules/_entities_tokenholder_.md rename to docs/api/external-modules/_entities_tokenholder_.md index 03b8e37..5eed4b2 100644 --- a/docs/api/modules/_entities_tokenholder_.md +++ b/docs/api/external-modules/_entities_tokenholder_.md @@ -1,4 +1,4 @@ -# External module: "entities/Tokenholder" +# entities/Tokenholder ## Index @@ -10,3 +10,4 @@ * [Params](../interfaces/_entities_tokenholder_.params.md) * [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_tokenholder_.params.md b/docs/api/external-modules/_entities_tokenholder_.params.md new file mode 100644 index 0000000..57cecc7 --- /dev/null +++ b/docs/api/external-modules/_entities_tokenholder_.params.md @@ -0,0 +1,64 @@ +# Params + +Constructor parameters + +## Hierarchy + +* **Params** + +## Index + +### Properties + +* [balance](../interfaces/_entities_tokenholder_.params.md#balance) +* [canBuyFromSto](../interfaces/_entities_tokenholder_.params.md#canbuyfromsto) +* [canReceiveAfter](../interfaces/_entities_tokenholder_.params.md#canreceiveafter) +* [canSendAfter](../interfaces/_entities_tokenholder_.params.md#cansendafter) +* [isAccredited](../interfaces/_entities_tokenholder_.params.md#isaccredited) +* [kycExpiry](../interfaces/_entities_tokenholder_.params.md#kycexpiry) +* [securityTokenSymbol](../interfaces/_entities_tokenholder_.params.md#securitytokensymbol) + +## Properties + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/entities/Tokenholder.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L35) + +### canBuyFromSto + +• **canBuyFromSto**: _boolean_ + +_Defined in_ [_src/entities/Tokenholder.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L34) + +### canReceiveAfter + +• **canReceiveAfter**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L31) + +### canSendAfter + +• **canSendAfter**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L30) + +### isAccredited + +• **isAccredited**: _boolean_ + +_Defined in_ [_src/entities/Tokenholder.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L33) + +### kycExpiry + +• **kycExpiry**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L32) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L29) + diff --git a/docs/api/external-modules/_entities_tokenholder_.tokenholder.md b/docs/api/external-modules/_entities_tokenholder_.tokenholder.md new file mode 100644 index 0000000..a09f57c --- /dev/null +++ b/docs/api/external-modules/_entities_tokenholder_.tokenholder.md @@ -0,0 +1,223 @@ +# Tokenholder + +Used to manage a Tokenholder + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_tokenholder_.params.md)› + + ↳ **Tokenholder** + +## Index + +### Constructors + +* [constructor](../classes/_entities_tokenholder_.tokenholder.md#constructor) + +### Properties + +* [address](../classes/_entities_tokenholder_.tokenholder.md#address) +* [balance](../classes/_entities_tokenholder_.tokenholder.md#balance) +* [canBuyFromSto](../classes/_entities_tokenholder_.tokenholder.md#canbuyfromsto) +* [canReceiveAfter](../classes/_entities_tokenholder_.tokenholder.md#canreceiveafter) +* [canSendAfter](../classes/_entities_tokenholder_.tokenholder.md#cansendafter) +* [isAccredited](../classes/_entities_tokenholder_.tokenholder.md#isaccredited) +* [kycExpiry](../classes/_entities_tokenholder_.tokenholder.md#kycexpiry) +* [securityTokenId](../classes/_entities_tokenholder_.tokenholder.md#securitytokenid) +* [securityTokenSymbol](../classes/_entities_tokenholder_.tokenholder.md#securitytokensymbol) +* [uid](../classes/_entities_tokenholder_.tokenholder.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_tokenholder_.tokenholder.md#_refresh) +* [isRevoked](../classes/_entities_tokenholder_.tokenholder.md#isrevoked) +* [toPojo](../classes/_entities_tokenholder_.tokenholder.md#topojo) +* [generateId](../classes/_entities_tokenholder_.tokenholder.md#static-generateid) +* [unserialize](../classes/_entities_tokenholder_.tokenholder.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Tokenholder**\(`params`: [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md)\): [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md) + +_Defined in_ [_src/entities/Tokenholder.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112) + +Create a new Tokenholder instance + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_tokenholder_.params.md) & [UniqueIdentifiers](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) | + +**Returns:** [_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L112) + +wallet address + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/entities/Tokenholder.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L107) + +total Security Token balance of the Tokenholder + +### canBuyFromSto + +• **canBuyFromSto**: _boolean_ + +_Defined in_ [_src/entities/Tokenholder.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L102) + +whether the Tokenholder can purchase from an STO or not + +### canReceiveAfter + +• **canReceiveAfter**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L87) + +date after which a Tokenholder can transfer tokens to their address + +### canSendAfter + +• **canSendAfter**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:82_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L82) + +date after which a Tokenholder can transfer tokens from their address + +### isAccredited + +• **isAccredited**: _boolean_ + +_Defined in_ [_src/entities/Tokenholder.ts:97_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L97) + +whether the Tokenholder is accredited or not + +### kycExpiry + +• **kycExpiry**: _Date_ + +_Defined in_ [_src/entities/Tokenholder.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L92) + +date when the Tokenholder's KYC will expire + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L77) + +### securityTokenSymbol + +• **securityTokenSymbol**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L75) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Tokenholder.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L73) + +unique generated id for a Tokenholder + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Tokenholder.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L195) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_tokenholder_.params.md)› | + +**Returns:** _void_ + +### isRevoked + +▸ **isRevoked**\(\): _boolean_ + +_Defined in_ [_src/entities/Tokenholder.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L150) + +Checks if this Tokenholder's KYC has been manually revoked + +**Returns:** _boolean_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Tokenholder.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L164) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **address**: _string_ +* **balance**: _BigNumber_ +* **canBuyFromSto**: _boolean_ +* **canReceiveAfter**: _Date_ +* **canSendAfter**: _Date_ +* **isAccredited**: _boolean_ +* **kycExpiry**: _Date_ +* **securityTokenId**: _string_ +* **securityTokenSymbol**: _string_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L45) + +Generate the Tokenholder's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | +| `securityTokenId` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Tokenholder.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L57) + +Unserialize a serialized Tokenholder entity + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with Tokenholder entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_tokenholder_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_tokenholder_.uniqueidentifiers.md b/docs/api/external-modules/_entities_tokenholder_.uniqueidentifiers.md new file mode 100644 index 0000000..bae7c1e --- /dev/null +++ b/docs/api/external-modules/_entities_tokenholder_.uniqueidentifiers.md @@ -0,0 +1,29 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Tokenholder of a specific Security Token + +## Hierarchy + +* **UniqueIdentifiers** + +## Index + +### Properties + +* [address](../interfaces/_entities_tokenholder_.uniqueidentifiers.md#address) +* [securityTokenId](../interfaces/_entities_tokenholder_.uniqueidentifiers.md#securitytokenid) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L12) + +### securityTokenId + +• **securityTokenId**: _string_ + +_Defined in_ [_src/entities/Tokenholder.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L11) + diff --git a/docs/api/external-modules/_entities_transactionqueue_.events.md b/docs/api/external-modules/_entities_transactionqueue_.events.md new file mode 100644 index 0000000..d802525 --- /dev/null +++ b/docs/api/external-modules/_entities_transactionqueue_.events.md @@ -0,0 +1,23 @@ +# Events + +## Index + +### Enumeration members + +* [StatusChange](../enums/_entities_transactionqueue_.events.md#statuschange) +* [TransactionStatusChange](../enums/_entities_transactionqueue_.events.md#transactionstatuschange) + +## Enumeration members + +### StatusChange + +• **StatusChange**: = "StatusChange" + +_Defined in_ [_src/entities/TransactionQueue.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L18) + +### TransactionStatusChange + +• **TransactionStatusChange**: = "TransactionStatusChange" + +_Defined in_ [_src/entities/TransactionQueue.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L19) + diff --git a/docs/api/modules/_entities_transactionqueue_.md b/docs/api/external-modules/_entities_transactionqueue_.md similarity index 79% rename from docs/api/modules/_entities_transactionqueue_.md rename to docs/api/external-modules/_entities_transactionqueue_.md index 0586ec5..e5faab6 100644 --- a/docs/api/modules/_entities_transactionqueue_.md +++ b/docs/api/external-modules/_entities_transactionqueue_.md @@ -1,4 +1,4 @@ -# External module: "entities/TransactionQueue" +# entities/TransactionQueue ## Index @@ -9,3 +9,4 @@ ### Classes * [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md) + diff --git a/docs/api/external-modules/_entities_transactionqueue_.transactionqueue.md b/docs/api/external-modules/_entities_transactionqueue_.transactionqueue.md new file mode 100644 index 0000000..9227406 --- /dev/null +++ b/docs/api/external-modules/_entities_transactionqueue_.transactionqueue.md @@ -0,0 +1,238 @@ +# TransactionQueue + +Class to manage procedural transaction queues + +## Type parameters + +▪ **Args**: _any_ + +▪ **ReturnType**: _any_ + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹void› + + ↳ **TransactionQueue** + +## Index + +### Constructors + +* [constructor](../classes/_entities_transactionqueue_.transactionqueue.md#constructor) + +### Properties + +* [args](../classes/_entities_transactionqueue_.transactionqueue.md#args) +* [entityType](../classes/_entities_transactionqueue_.transactionqueue.md#entitytype) +* [error](../classes/_entities_transactionqueue_.transactionqueue.md#optional-error) +* [fees](../classes/_entities_transactionqueue_.transactionqueue.md#fees) +* [procedureType](../classes/_entities_transactionqueue_.transactionqueue.md#proceduretype) +* [status](../classes/_entities_transactionqueue_.transactionqueue.md#status) +* [transactions](../classes/_entities_transactionqueue_.transactionqueue.md#transactions) +* [uid](../classes/_entities_transactionqueue_.transactionqueue.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_transactionqueue_.transactionqueue.md#_refresh) +* [onStatusChange](../classes/_entities_transactionqueue_.transactionqueue.md#onstatuschange) +* [onTransactionStatusChange](../classes/_entities_transactionqueue_.transactionqueue.md#ontransactionstatuschange) +* [run](../classes/_entities_transactionqueue_.transactionqueue.md#run) +* [toPojo](../classes/_entities_transactionqueue_.transactionqueue.md#topojo) +* [generateId](../classes/_entities_transactionqueue_.transactionqueue.md#static-generateid) + +## Constructors + +### constructor + ++ **new TransactionQueue**\(`transactions`: [TransactionSpec](../interfaces/_types_index_.transactionspec.md)\[\], `fees`: [Fees](../interfaces/_types_index_.fees.md), `returnValue`: [MaybeResolver](_types_index_.md#mayberesolver)‹ReturnType›, `args`: Args, `procedureType`: [ProcedureType](../enums/_types_index_.proceduretype.md)\): [_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md) + +_Defined in_ [_src/entities/TransactionQueue.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L95) + +Create a transaction queue + +**Parameters:** + +| Name | Type | Default | Description | +| :--- | :--- | :--- | :--- | +| `transactions` | [TransactionSpec](../interfaces/_types_index_.transactionspec.md)\[\] | - | list of transactions to be run in this queue | +| `fees` | [Fees](../interfaces/_types_index_.fees.md) | - | - | +| `returnValue` | [MaybeResolver](_types_index_.md#mayberesolver)‹ReturnType› | - | value that will be returned by the queue after it is run. It can be a Post Transaction Resolver | +| `args` | Args | - | arguments with which the Procedure that generated this queue was instanced | +| `procedureType` | [ProcedureType](../enums/_types_index_.proceduretype.md) | ProcedureType.UnnamedProcedure | - | + +**Returns:** [_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md) + +## Properties + +### args + +• **args**: _Args_ + +_Defined in_ [_src/entities/TransactionQueue.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L65) + +arguments provided to the transaction queue + +### entityType + +• **entityType**: _string_ = "transactionQueue" + +_Defined in_ [_src/entities/TransactionQueue.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L40) + +type of entity + +### `Optional` error + +• **error**? : [_Error_](../classes/_polymatherror_.polymatherror.md#static-error) + +_Defined in_ [_src/entities/TransactionQueue.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L70) + +optional error information + +### fees + +• **fees**: [_Fees_](../interfaces/_types_index_.fees.md) + +_Defined in_ [_src/entities/TransactionQueue.ts:75_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L75) + +total cost of running the transactions in the queue. This does not include gas + +### procedureType + +• **procedureType**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) + +_Defined in_ [_src/entities/TransactionQueue.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L45) + +type of procedure being run + +### status + +• **status**: _TransactionQueueStatus_ = TransactionQueueStatus.Idle + +_Defined in_ [_src/entities/TransactionQueue.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L60) + +status of the transaction queue + +### transactions + +• **transactions**: [_PolyTransaction_](../classes/_entities_polytransaction_.polytransaction.md)_\[\]_ + +_Defined in_ [_src/entities/TransactionQueue.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L55) + +array of poly transactions + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/TransactionQueue.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L50) + +generated transaction queue unique identifier + +## Methods + +### \_refresh + +▸ **\_refresh**\(\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/TransactionQueue.ts:269_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L269) + +Hydrate the entity + +**Returns:** _void_ + +### onStatusChange + +▸ **onStatusChange**\(`listener`: function\): _\(Anonymous function\)_ + +_Defined in_ [_src/entities/TransactionQueue.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L188) + +Subscribe to status changes on the Transaction Queue + +**Parameters:** + +▪ **listener**: _function_ + +callback function that will be called whenever the Transaction Queue's status changes + +▸ \(`transactionQueue`: this\): _void_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `transactionQueue` | this | + +**Returns:** _\(Anonymous function\)_ + +unsubscribe function + +### onTransactionStatusChange + +▸ **onTransactionStatusChange**\(`listener`: function\): _\(Anonymous function\)_ + +_Defined in_ [_src/entities/TransactionQueue.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L203) + +Subscribe to status changes on individual transactions + +**Parameters:** + +▪ **listener**: _function_ + +callback function that will be called whenever the individual transaction's status changes + +▸ \(`transaction`: [PolyTransaction](../classes/_entities_polytransaction_.polytransaction.md), `transactionQueue`: this\): _void_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `transaction` | [PolyTransaction](../classes/_entities_polytransaction_.polytransaction.md) | +| `transactionQueue` | this | + +**Returns:** _\(Anonymous function\)_ + +unsubscribe function + +### run + +▸ **run**\(\): _Promise‹ReturnType›_ + +_Defined in_ [_src/entities/TransactionQueue.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L155) + +Run the transactions in the queue + +**Returns:** _Promise‹ReturnType›_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/TransactionQueue.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L139) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **args**: _Args_ +* **fees**: [_Fees_](../interfaces/_types_index_.fees.md) +* **procedureType**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) +* **status**: _TransactionQueueStatus_ +* **transactions**: _object\[\]_ = transactions.map\(transaction => transaction.toPojo\(\)\) +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(\): _string_ + +_Defined in_ [_src/entities/TransactionQueue.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TransactionQueue.ts#L31) + +Generate UUID for this Transaction Queue + +**Returns:** _string_ + diff --git a/docs/api/modules/_entities_wallet_.md b/docs/api/external-modules/_entities_wallet_.md similarity index 85% rename from docs/api/modules/_entities_wallet_.md rename to docs/api/external-modules/_entities_wallet_.md index ced934e..c6ed69d 100644 --- a/docs/api/modules/_entities_wallet_.md +++ b/docs/api/external-modules/_entities_wallet_.md @@ -1,4 +1,4 @@ -# External module: "entities/Wallet" +# entities/Wallet ## Index @@ -10,3 +10,4 @@ * [Params](../interfaces/_entities_wallet_.params.md) * [UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_entities_wallet_.params.md b/docs/api/external-modules/_entities_wallet_.params.md new file mode 100644 index 0000000..25500fb --- /dev/null +++ b/docs/api/external-modules/_entities_wallet_.params.md @@ -0,0 +1,26 @@ +# Params + +Constructor parameters + +## Hierarchy + +* [UniqueIdentifiers](../interfaces/_entities_wallet_.uniqueidentifiers.md) + + ↳ **Params** + +## Index + +### Properties + +* [address](../interfaces/_entities_wallet_.params.md#address) + +## Properties + +### address + +• **address**: _string_ + +_Inherited from_ [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md)_._[_address_](../interfaces/_entities_wallet_.uniqueidentifiers.md#address) + +_Defined in_ [_src/entities/Wallet.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12) + diff --git a/docs/api/external-modules/_entities_wallet_.uniqueidentifiers.md b/docs/api/external-modules/_entities_wallet_.uniqueidentifiers.md new file mode 100644 index 0000000..a7fa6ea --- /dev/null +++ b/docs/api/external-modules/_entities_wallet_.uniqueidentifiers.md @@ -0,0 +1,24 @@ +# UniqueIdentifiers + +Properties that uniquely identify a Wallet + +## Hierarchy + +* **UniqueIdentifiers** + + ↳ [Params](../interfaces/_entities_wallet_.params.md) + +## Index + +### Properties + +* [address](../interfaces/_entities_wallet_.uniqueidentifiers.md#address) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Wallet.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12) + diff --git a/docs/api/external-modules/_entities_wallet_.wallet.md b/docs/api/external-modules/_entities_wallet_.wallet.md new file mode 100644 index 0000000..7d4ef76 --- /dev/null +++ b/docs/api/external-modules/_entities_wallet_.wallet.md @@ -0,0 +1,184 @@ +# Wallet + +Used to manage a wallet + +## Hierarchy + +* [Entity](../classes/_entities_entity_.entity.md)‹[Params](../interfaces/_entities_wallet_.params.md)› + + ↳ **Wallet** + +## Index + +### Constructors + +* [constructor](../classes/_entities_wallet_.wallet.md#constructor) + +### Properties + +* [address](../classes/_entities_wallet_.wallet.md#address) +* [context](../classes/_entities_wallet_.wallet.md#protected-context) +* [uid](../classes/_entities_wallet_.wallet.md#uid) + +### Methods + +* [\_refresh](../classes/_entities_wallet_.wallet.md#_refresh) +* [getErc20Balance](../classes/_entities_wallet_.wallet.md#geterc20balance) +* [getEthBalance](../classes/_entities_wallet_.wallet.md#getethbalance) +* [getPolyBalance](../classes/_entities_wallet_.wallet.md#getpolybalance) +* [toPojo](../classes/_entities_wallet_.wallet.md#topojo) +* [generateId](../classes/_entities_wallet_.wallet.md#static-generateid) +* [unserialize](../classes/_entities_wallet_.wallet.md#static-unserialize) + +## Constructors + +### constructor + ++ **new Wallet**\(`params`: [Params](../interfaces/_entities_wallet_.params.md), `context`: [Context](../classes/_context_.context.md)\): [_Wallet_](../classes/_entities_wallet_.wallet.md) + +_Defined in_ [_src/entities/Wallet.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71) + +Create a wallet entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [Params](../interfaces/_entities_wallet_.params.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_Wallet_](../classes/_entities_wallet_.wallet.md) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/entities/Wallet.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L69) + +wallet address + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Defined in_ [_src/entities/Wallet.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L71) + +### uid + +• **uid**: _string_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_uid_](../classes/_entities_entity_.entity.md#abstract-uid) + +_Defined in_ [_src/entities/Wallet.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L64) + +unique generated wallet id + +## Methods + +### \_refresh + +▸ **\_refresh**\(`params`: Partial‹[Params](../interfaces/_entities_wallet_.params.md)›\): _void_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_\_refresh_](../classes/_entities_entity_.entity.md#abstract-_refresh) + +_Defined in_ [_src/entities/Wallet.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L103) + +Hydrate the entity + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | Partial‹[Params](../interfaces/_entities_wallet_.params.md)› | + +**Returns:** _void_ + +### getErc20Balance + +▸ **getErc20Balance**\(`args`: object\): _Promise‹BigNumber›_ + +_Defined in_ [_src/entities/Wallet.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L132) + +Retrieve the ERC20 balance of this particular wallet address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `tokenAddress` | string | + +**Returns:** _Promise‹BigNumber›_ + +### getEthBalance + +▸ **getEthBalance**\(\): _Promise‹BigNumber›_ + +_Defined in_ [_src/entities/Wallet.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L122) + +Retrieve the ETH balance of this particular wallet address + +**Returns:** _Promise‹BigNumber›_ + +### getPolyBalance + +▸ **getPolyBalance**\(\): _Promise‹BigNumber›_ + +_Defined in_ [_src/entities/Wallet.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L114) + +Retrieve the POLY balance of this particular wallet address + +**Returns:** _Promise‹BigNumber›_ + +### toPojo + +▸ **toPojo**\(\): _object_ + +_Overrides_ [_Entity_](../classes/_entities_entity_.entity.md)_._[_toPojo_](../classes/_entities_entity_.entity.md#abstract-topojo) + +_Defined in_ [_src/entities/Wallet.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L91) + +Convert entity to a POJO \(Plain Old Javascript Object\) + +**Returns:** _object_ + +* **address**: _string_ +* **uid**: _string_ + +### `Static` generateId + +▸ **generateId**\(`__namedParameters`: object\): _string_ + +_Defined in_ [_src/entities/Wallet.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L37) + +Generate the Wallet's UUID from its identifying properties + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | + +**Returns:** _string_ + +### `Static` unserialize + +▸ **unserialize**\(`serialized`: string\): [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md) + +_Defined in_ [_src/entities/Wallet.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L48) + +Unserialize a serialized entity + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `serialized` | string | string with entity information | + +**Returns:** [_UniqueIdentifiers_](../interfaces/_entities_wallet_.uniqueidentifiers.md) + diff --git a/docs/api/external-modules/_index_.md b/docs/api/external-modules/_index_.md new file mode 100644 index 0000000..fedd6e1 --- /dev/null +++ b/docs/api/external-modules/_index_.md @@ -0,0 +1,23 @@ +# index + +## Index + +### Variables + +* [browserUtils](_index_.md#const-browserutils) +* [isNode](_index_.md#const-isnode) + +## Variables + +### `Const` browserUtils + +• **browserUtils**: _any_ = isNode ? null : require\('./browserUtils'\) + +_Defined in_ [_src/index.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/index.ts#L9) + +### `Const` isNode + +• **isNode**: _boolean_ = typeof window === 'undefined' + +_Defined in_ [_src/index.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/index.ts#L7) + diff --git a/docs/api/external-modules/_polymath_.addressparams.md b/docs/api/external-modules/_polymath_.addressparams.md new file mode 100644 index 0000000..787d5fb --- /dev/null +++ b/docs/api/external-modules/_polymath_.addressparams.md @@ -0,0 +1,20 @@ +# AddressParams + +## Hierarchy + +* **AddressParams** + +## Index + +### Properties + +* [address](../interfaces/_polymath_.addressparams.md#address) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/Polymath.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L45) + diff --git a/docs/api/external-modules/_polymath_.connect.md b/docs/api/external-modules/_polymath_.connect.md new file mode 100644 index 0000000..906c72f --- /dev/null +++ b/docs/api/external-modules/_polymath_.connect.md @@ -0,0 +1,32 @@ +# Connect + +## Hierarchy + +* **Connect** + +## Callable + +▸ \(`params`: [PolymathNetworkParams](../interfaces/_polymath_.polymathnetworkparams.md)\): _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ + +_Defined in_ [_src/Polymath.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L35) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [PolymathNetworkParams](../interfaces/_polymath_.polymathnetworkparams.md) | + +**Returns:** _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ + +▸ \(`params`: [PolymathNetworkNodeParams](../interfaces/_polymath_.polymathnetworknodeparams.md)\): _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ + +_Defined in_ [_src/Polymath.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L36) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [PolymathNetworkNodeParams](../interfaces/_polymath_.polymathnetworknodeparams.md) | + +**Returns:** _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ + diff --git a/docs/api/external-modules/_polymath_.connectparams.md b/docs/api/external-modules/_polymath_.connectparams.md new file mode 100644 index 0000000..c865270 --- /dev/null +++ b/docs/api/external-modules/_polymath_.connectparams.md @@ -0,0 +1,47 @@ +# ConnectParams + +## Hierarchy + +* [PolymathNetworkParams](../interfaces/_polymath_.polymathnetworkparams.md) + + ↳ **ConnectParams** + +## Index + +### Properties + +* [polymathRegistryAddress](../interfaces/_polymath_.connectparams.md#optional-polymathregistryaddress) +* [privateKey](../interfaces/_polymath_.connectparams.md#optional-privatekey) +* [providerUrl](../interfaces/_polymath_.connectparams.md#optional-providerurl) +* [speed](../interfaces/_polymath_.connectparams.md#optional-speed) + +## Properties + +### `Optional` polymathRegistryAddress + +• **polymathRegistryAddress**? : _undefined \| string_ + +_Inherited from_ [_PolymathNetworkParams_](../interfaces/_polymath_.polymathnetworkparams.md)_._[_polymathRegistryAddress_](../interfaces/_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress) + +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) + +### `Optional` privateKey + +• **privateKey**? : _undefined \| string_ + +_Defined in_ [_src/Polymath.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L32) + +### `Optional` providerUrl + +• **providerUrl**? : _undefined \| string_ + +_Defined in_ [_src/Polymath.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L31) + +### `Optional` speed + +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Inherited from_ [_PolymathNetworkParams_](../interfaces/_polymath_.polymathnetworkparams.md)_._[_speed_](../interfaces/_polymath_.polymathnetworkparams.md#optional-speed) + +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) + diff --git a/docs/api/external-modules/_polymath_.getsecuritytoken.md b/docs/api/external-modules/_polymath_.getsecuritytoken.md new file mode 100644 index 0000000..a4d5688 --- /dev/null +++ b/docs/api/external-modules/_polymath_.getsecuritytoken.md @@ -0,0 +1,44 @@ +# GetSecurityToken + +## Hierarchy + +* **GetSecurityToken** + +## Callable + +▸ \(`params`: [SymbolParams](../interfaces/_polymath_.symbolparams.md)\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +_Defined in_ [_src/Polymath.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L48) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [SymbolParams](../interfaces/_polymath_.symbolparams.md) | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +▸ \(`params`: [AddressParams](../interfaces/_polymath_.addressparams.md)\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +_Defined in_ [_src/Polymath.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L49) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [AddressParams](../interfaces/_polymath_.addressparams.md) | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +▸ \(`params`: string\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +_Defined in_ [_src/Polymath.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L50) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | string | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + diff --git a/docs/api/modules/_polymath_.md b/docs/api/external-modules/_polymath_.md similarity index 94% rename from docs/api/modules/_polymath_.md rename to docs/api/external-modules/_polymath_.md index cf3e3ee..4831368 100644 --- a/docs/api/modules/_polymath_.md +++ b/docs/api/external-modules/_polymath_.md @@ -1,4 +1,4 @@ -# External module: "Polymath" +# Polymath ## Index @@ -15,3 +15,4 @@ * [PolymathNetworkNodeParams](../interfaces/_polymath_.polymathnetworknodeparams.md) * [PolymathNetworkParams](../interfaces/_polymath_.polymathnetworkparams.md) * [SymbolParams](../interfaces/_polymath_.symbolparams.md) + diff --git a/docs/api/external-modules/_polymath_.polymath.md b/docs/api/external-modules/_polymath_.polymath.md new file mode 100644 index 0000000..8691710 --- /dev/null +++ b/docs/api/external-modules/_polymath_.polymath.md @@ -0,0 +1,266 @@ +# Polymath + +Main entry point of the Polymath SDK + +## Hierarchy + +* **Polymath** + +## Index + +### Properties + +* [context](../classes/_polymath_.polymath.md#private-context) +* [isConnected](../classes/_polymath_.polymath.md#isconnected) +* [isUnsupported](../classes/_polymath_.polymath.md#isunsupported) + +### Methods + +* [connect](../classes/_polymath_.polymath.md#connect) +* [getCurrentAddress](../classes/_polymath_.polymath.md#getcurrentaddress) +* [getLatestProtocolVersion](../classes/_polymath_.polymath.md#getlatestprotocolversion) +* [getPolyTokenAddress](../classes/_polymath_.polymath.md#getpolytokenaddress) +* [getSecurityToken](../classes/_polymath_.polymath.md#getsecuritytoken) +* [getSecurityTokenReservation](../classes/_polymath_.polymath.md#getsecuritytokenreservation) +* [getSecurityTokenReservations](../classes/_polymath_.polymath.md#getsecuritytokenreservations) +* [getSecurityTokenSymbols](../classes/_polymath_.polymath.md#getsecuritytokensymbols) +* [getSecurityTokens](../classes/_polymath_.polymath.md#getsecuritytokens) +* [getWallet](../classes/_polymath_.polymath.md#getwallet) +* [isSymbolAvailable](../classes/_polymath_.polymath.md#issymbolavailable) +* [isValidErc20](../classes/_polymath_.polymath.md#isvaliderc20) +* [reserveSecurityToken](../classes/_polymath_.polymath.md#reservesecuritytoken) + +## Properties + +### `Private` context + +• **context**: [_Context_](../classes/_context_.context.md) = {} as Context + +_Defined in_ [_src/Polymath.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L98) + +### isConnected + +• **isConnected**: _boolean_ = false + +_Defined in_ [_src/Polymath.ts:96_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L96) + +### isUnsupported + +• **isUnsupported**: _boolean_ = false + +_Defined in_ [_src/Polymath.ts:94_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L94) + +## Methods + +### connect + +▸ **connect**\(`__namedParameters`: object\): _Promise‹this›_ + +_Defined in_ [_src/Polymath.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L103) + +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](../enums/_types_index_.transactionspeed.md) | TransactionSpeed.Fast | desired transaction speed. More gas is spent if a faster speed is chosen | + +**Returns:** _Promise‹this›_ + +### getCurrentAddress + +▸ **getCurrentAddress**\(\): _Promise‹string›_ + +_Defined in_ [_src/Polymath.ts:451_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L451) + +Returns the wallet address of the current user + +**Returns:** _Promise‹string›_ + +### getLatestProtocolVersion + +▸ **getLatestProtocolVersion**\(\): _Promise‹string›_ + +_Defined in_ [_src/Polymath.ts:430_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L430) + +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_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L442) + +Get the address of the POLY token + +**Returns:** _Promise‹string›_ + +### getSecurityToken + +▸ **getSecurityToken**\(`args`: object \| object \| string\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +_Defined in_ [_src/Polymath.ts:320_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L320) + +Retrieve a security token by symbol, address or UUID + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | object \| object \| string | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ + +### getSecurityTokenReservation + +▸ **getSecurityTokenReservation**\(`args`: object \| string\): _Promise‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_›_ + +_Defined in_ [_src/Polymath.ts:220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L220) + +Retrieve a Security Token Reservation by symbol or UUID + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | object \| string | + +**Returns:** _Promise‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_›_ + +### getSecurityTokenReservations + +▸ **getSecurityTokenReservations**\(`args?`: undefined \| object\): _Promise‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_\[\]›_ + +_Defined in_ [_src/Polymath.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L188) + +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 | + +**Returns:** _Promise‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_\[\]›_ + +### getSecurityTokenSymbols + +▸ **getSecurityTokenSymbols**\(`args?`: undefined \| object\): _Promise‹string\[\]›_ + +_Defined in_ [_src/Polymath.ts:286_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L286) + +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\[\]›_ + +### getSecurityTokens + +▸ **getSecurityTokens**\(`args?`: undefined \| object\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_\[\]›_ + +_Defined in_ [_src/Polymath.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L244) + +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](../classes/_polymath_.polymath.md#getsecuritytokensymbols) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args?` | undefined \| object | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_\[\]›_ + +### getWallet + +▸ **getWallet**\(`args`: object\): [_Wallet_](../classes/_entities_wallet_.wallet.md) + +_Defined in_ [_src/Polymath.ts:419_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L419) + +Retrieve a Wallet by address + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | + +**Returns:** [_Wallet_](../classes/_entities_wallet_.wallet.md) + +### isSymbolAvailable + +▸ **isSymbolAvailable**\(`args`: object\): _Promise‹boolean›_ + +_Defined in_ [_src/Polymath.ts:394_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L394) + +Check if a token symbol \(ticker\) is available for reservation + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `symbol` | string | + +**Returns:** _Promise‹boolean›_ + +### isValidErc20 + +▸ **isValidErc20**\(`args`: object\): _Promise‹void›_ + +_Defined in_ [_src/Polymath.ts:405_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L405) + +Check if a token follows the ERC20 standard + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `address` | string | + +**Returns:** _Promise‹void›_ + +### reserveSecurityToken + +▸ **reserveSecurityToken**\(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md)_,_ [_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_››_ + +_Defined in_ [_src/Polymath.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L176) + +Reserve a Security Token + +**Parameters:** + +▪ **args**: _object_ + +| Name | Type | +| :--- | :--- | +| `owner?` | undefined \| string | +| `symbol` | string | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md)_,_ [_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_››_ + diff --git a/docs/api/external-modules/_polymath_.polymathnetworknodeparams.md b/docs/api/external-modules/_polymath_.polymathnetworknodeparams.md new file mode 100644 index 0000000..0465803 --- /dev/null +++ b/docs/api/external-modules/_polymath_.polymathnetworknodeparams.md @@ -0,0 +1,47 @@ +# PolymathNetworkNodeParams + +## Hierarchy + +* [PolymathNetworkParams](../interfaces/_polymath_.polymathnetworkparams.md) + + ↳ **PolymathNetworkNodeParams** + +## Index + +### Properties + +* [polymathRegistryAddress](../interfaces/_polymath_.polymathnetworknodeparams.md#optional-polymathregistryaddress) +* [privateKey](../interfaces/_polymath_.polymathnetworknodeparams.md#privatekey) +* [providerUrl](../interfaces/_polymath_.polymathnetworknodeparams.md#providerurl) +* [speed](../interfaces/_polymath_.polymathnetworknodeparams.md#optional-speed) + +## Properties + +### `Optional` polymathRegistryAddress + +• **polymathRegistryAddress**? : _undefined \| string_ + +_Inherited from_ [_PolymathNetworkParams_](../interfaces/_polymath_.polymathnetworkparams.md)_._[_polymathRegistryAddress_](../interfaces/_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress) + +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) + +### privateKey + +• **privateKey**: _string_ + +_Defined in_ [_src/Polymath.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L27) + +### providerUrl + +• **providerUrl**: _string_ + +_Defined in_ [_src/Polymath.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L26) + +### `Optional` speed + +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Inherited from_ [_PolymathNetworkParams_](../interfaces/_polymath_.polymathnetworkparams.md)_._[_speed_](../interfaces/_polymath_.polymathnetworkparams.md#optional-speed) + +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) + diff --git a/docs/api/external-modules/_polymath_.polymathnetworkparams.md b/docs/api/external-modules/_polymath_.polymathnetworkparams.md new file mode 100644 index 0000000..4eb59b1 --- /dev/null +++ b/docs/api/external-modules/_polymath_.polymathnetworkparams.md @@ -0,0 +1,31 @@ +# PolymathNetworkParams + +## Hierarchy + +* **PolymathNetworkParams** + + ↳ [PolymathNetworkNodeParams](../interfaces/_polymath_.polymathnetworknodeparams.md) + + ↳ [ConnectParams](../interfaces/_polymath_.connectparams.md) + +## Index + +### Properties + +* [polymathRegistryAddress](../interfaces/_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress) +* [speed](../interfaces/_polymath_.polymathnetworkparams.md#optional-speed) + +## Properties + +### `Optional` polymathRegistryAddress + +• **polymathRegistryAddress**? : _undefined \| string_ + +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) + +### `Optional` speed + +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) + diff --git a/docs/api/external-modules/_polymath_.symbolparams.md b/docs/api/external-modules/_polymath_.symbolparams.md new file mode 100644 index 0000000..a48f35d --- /dev/null +++ b/docs/api/external-modules/_polymath_.symbolparams.md @@ -0,0 +1,20 @@ +# SymbolParams + +## Hierarchy + +* **SymbolParams** + +## Index + +### Properties + +* [symbol](../interfaces/_polymath_.symbolparams.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/Polymath.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L41) + diff --git a/docs/api/external-modules/_polymathbase_.basecheckpoint.md b/docs/api/external-modules/_polymathbase_.basecheckpoint.md new file mode 100644 index 0000000..47c4574 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.basecheckpoint.md @@ -0,0 +1,51 @@ +# BaseCheckpoint + +Internal representation of a Checkpoint + +## Hierarchy + +* **BaseCheckpoint** + +## Index + +### Properties + +* [createdAt](../interfaces/_polymathbase_.basecheckpoint.md#createdat) +* [index](../interfaces/_polymathbase_.basecheckpoint.md#index) +* [tokenholderBalances](../interfaces/_polymathbase_.basecheckpoint.md#tokenholderbalances) +* [totalSupply](../interfaces/_polymathbase_.basecheckpoint.md#totalsupply) + +## Properties + +### createdAt + +• **createdAt**: _Date_ + +_Defined in_ [_src/PolymathBase.ts:271_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L271) + +date at which the Checkpoint was created + +### index + +• **index**: _number_ + +_Defined in_ [_src/PolymathBase.ts:259_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L259) + +index of the Checkpoint + +### tokenholderBalances + +• **tokenholderBalances**: [_TokenholderBalance_](../interfaces/_types_index_.tokenholderbalance.md)_\[\]_ + +_Defined in_ [_src/PolymathBase.ts:267_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L267) + +tokenholder balances at the Checkpoint + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:263_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L263) + +total supply of the Security Token at the Checkpoint + diff --git a/docs/api/external-modules/_polymathbase_.basedividend.md b/docs/api/external-modules/_polymathbase_.basedividend.md new file mode 100644 index 0000000..3e600c1 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.basedividend.md @@ -0,0 +1,141 @@ +# BaseDividend + +Internal representation of a Dividend Distribution + +## Hierarchy + +* **BaseDividend** + +## Index + +### Properties + +* [amount](../interfaces/_polymathbase_.basedividend.md#amount) +* [checkpointId](../interfaces/_polymathbase_.basedividend.md#checkpointid) +* [claimedAmount](../interfaces/_polymathbase_.basedividend.md#claimedamount) +* [created](../interfaces/_polymathbase_.basedividend.md#created) +* [currency](../interfaces/_polymathbase_.basedividend.md#currency) +* [expiry](../interfaces/_polymathbase_.basedividend.md#expiry) +* [index](../interfaces/_polymathbase_.basedividend.md#index) +* [maturity](../interfaces/_polymathbase_.basedividend.md#maturity) +* [name](../interfaces/_polymathbase_.basedividend.md#name) +* [reclaimed](../interfaces/_polymathbase_.basedividend.md#reclaimed) +* [tokenholders](../interfaces/_polymathbase_.basedividend.md#tokenholders) +* [totalSupply](../interfaces/_polymathbase_.basedividend.md#totalsupply) +* [totalWithheld](../interfaces/_polymathbase_.basedividend.md#totalwithheld) +* [totalWithheldWithdrawn](../interfaces/_polymathbase_.basedividend.md#totalwithheldwithdrawn) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L301) + +amount of tokens provided in the Dividend + +### checkpointId + +• **checkpointId**: _number_ + +_Defined in_ [_src/PolymathBase.ts:285_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L285) + +checkpoint UUID to which this Dividend Distribution is associated + +### claimedAmount + +• **claimedAmount**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:305_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L305) + +amount of tokens paid so far + +### created + +• **created**: _Date_ + +_Defined in_ [_src/PolymathBase.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L289) + +date at which the Dividend was created + +### currency + +• **currency**: _string \| null_ + +_Defined in_ [_src/PolymathBase.ts:329_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L329) + +symbol of the currency in which Dividends are being distributed + +### expiry + +• **expiry**: _Date_ + +_Defined in_ [_src/PolymathBase.ts:297_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L297) + +date at which the Dividend will expire + +### index + +• **index**: _number_ + +_Defined in_ [_src/PolymathBase.ts:281_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L281) + +index of the dividend + +### maturity + +• **maturity**: _Date_ + +_Defined in_ [_src/PolymathBase.ts:293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L293) + +date from which payments can be distributed + +### name + +• **name**: _string_ + +_Defined in_ [_src/PolymathBase.ts:325_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L325) + +name of the Dividend + +### reclaimed + +• **reclaimed**: _boolean_ + +_Defined in_ [_src/PolymathBase.ts:313_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L313) + +whether expired payments have been reclaimed + +### tokenholders + +• **tokenholders**: [_DividendTokenholderStatus_](../interfaces/_types_index_.dividendtokenholderstatus.md)_\[\]_ + +_Defined in_ [_src/PolymathBase.ts:333_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L333) + +dividend Tokenholders + +### totalSupply + +• **totalSupply**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:309_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L309) + +total supply of the Security Token + +### totalWithheld + +• **totalWithheld**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:317_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L317) + +total amount of tokens withheld as tax so far + +### totalWithheldWithdrawn + +• **totalWithheldWithdrawn**: _BigNumber_ + +_Defined in_ [_src/PolymathBase.ts:321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L321) + +total amount of withheld taxes already withdrawn from the storage wallet + diff --git a/docs/api/external-modules/_polymathbase_.getattachedmodulesopts.md b/docs/api/external-modules/_polymathbase_.getattachedmodulesopts.md new file mode 100644 index 0000000..7401dde --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.getattachedmodulesopts.md @@ -0,0 +1,24 @@ +# GetAttachedModulesOpts + +Options for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getattachedmodules) + +## Hierarchy + +* **GetAttachedModulesOpts** + +## Index + +### Properties + +* [unarchived](../interfaces/_polymathbase_.getattachedmodulesopts.md#unarchived) + +## Properties + +### unarchived + +• **unarchived**: _boolean_ + +_Defined in_ [_src/PolymathBase.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L93) + +whether to include unarchived modules in the search + diff --git a/docs/api/external-modules/_polymathbase_.getattachedmodulesparams.md b/docs/api/external-modules/_polymathbase_.getattachedmodulesparams.md new file mode 100644 index 0000000..6da4b08 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.getattachedmodulesparams.md @@ -0,0 +1,33 @@ +# GetAttachedModulesParams + +Arguments for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getattachedmodules) + +## Hierarchy + +* **GetAttachedModulesParams** + +## Index + +### Properties + +* [moduleName](../interfaces/_polymathbase_.getattachedmodulesparams.md#modulename) +* [symbol](../interfaces/_polymathbase_.getattachedmodulesparams.md#symbol) + +## Properties + +### moduleName + +• **moduleName**: _ModuleName_ + +_Defined in_ [_src/PolymathBase.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L83) + +name of the module + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/PolymathBase.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L79) + +Security Token symbol + diff --git a/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameopts.md b/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameopts.md new file mode 100644 index 0000000..58eda06 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameopts.md @@ -0,0 +1,24 @@ +# GetModuleAddressesByNameOpts + +Options for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md#getmoduleaddressesbyname) + +## Hierarchy + +* **GetModuleAddressesByNameOpts** + +## Index + +### Properties + +* [unarchived](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md#unarchived) + +## Properties + +### unarchived + +• **unarchived**: _boolean_ + +_Defined in_ [_src/PolymathBase.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L69) + +whether to include unarchived modules in the search + diff --git a/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameparams.md b/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameparams.md new file mode 100644 index 0000000..31b5a4f --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.getmoduleaddressesbynameparams.md @@ -0,0 +1,33 @@ +# GetModuleAddressesByNameParams + +Arguments for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md#getmoduleaddressesbyname) + +## Hierarchy + +* **GetModuleAddressesByNameParams** + +## Index + +### Properties + +* [moduleName](../interfaces/_polymathbase_.getmoduleaddressesbynameparams.md#modulename) +* [symbol](../interfaces/_polymathbase_.getmoduleaddressesbynameparams.md#symbol) + +## Properties + +### moduleName + +• **moduleName**: _ModuleName_ + +_Defined in_ [_src/PolymathBase.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L59) + +the name of the Security Token module + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/PolymathBase.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L55) + +Security Token symbol + diff --git a/docs/api/external-modules/_polymathbase_.getmodulefactoryaddressargs.md b/docs/api/external-modules/_polymathbase_.getmodulefactoryaddressargs.md new file mode 100644 index 0000000..7ec19f2 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.getmodulefactoryaddressargs.md @@ -0,0 +1,33 @@ +# GetModuleFactoryAddressArgs + +Arguments for [getModuleFactoryAddress](../classes/_polymathbase_.polymathbase.md#getmodulefactoryaddress) + +## Hierarchy + +* **GetModuleFactoryAddressArgs** + +## Index + +### Properties + +* [moduleName](../interfaces/_polymathbase_.getmodulefactoryaddressargs.md#modulename) +* [tokenAddress](../interfaces/_polymathbase_.getmodulefactoryaddressargs.md#tokenaddress) + +## Properties + +### moduleName + +• **moduleName**: _ModuleName_ + +_Defined in_ [_src/PolymathBase.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L245) + +name of Security Token module + +### tokenAddress + +• **tokenAddress**: _string_ + +_Defined in_ [_src/PolymathBase.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L249) + +ethereum address of Module Factory + diff --git a/docs/api/modules/_polymathbase_.md b/docs/api/external-modules/_polymathbase_.md similarity index 95% rename from docs/api/modules/_polymathbase_.md rename to docs/api/external-modules/_polymathbase_.md index e63c4b7..fb437e3 100644 --- a/docs/api/modules/_polymathbase_.md +++ b/docs/api/external-modules/_polymathbase_.md @@ -1,4 +1,4 @@ -# External module: "PolymathBase" +# PolymathBase ## Index @@ -15,3 +15,4 @@ * [GetModuleAddressesByNameOpts](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md) * [GetModuleAddressesByNameParams](../interfaces/_polymathbase_.getmoduleaddressesbynameparams.md) * [GetModuleFactoryAddressArgs](../interfaces/_polymathbase_.getmodulefactoryaddressargs.md) + diff --git a/docs/api/external-modules/_polymathbase_.polymathbase.md b/docs/api/external-modules/_polymathbase_.polymathbase.md new file mode 100644 index 0000000..afb9847 --- /dev/null +++ b/docs/api/external-modules/_polymathbase_.polymathbase.md @@ -0,0 +1,467 @@ +# PolymathBase + +Class that wraps the polymathnetwork/contract-wrappers library to add utility functions + +## Hierarchy + +* PolymathAPI + + ↳ **PolymathBase** + +## Index + +### Constructors + +* [constructor](../classes/_polymathbase_.polymathbase.md#constructor) + +### Properties + +* [contractFactory](../classes/_polymathbase_.polymathbase.md#contractfactory) +* [featureRegistry](../classes/_polymathbase_.polymathbase.md#featureregistry) +* [getAccount](../classes/_polymathbase_.polymathbase.md#getaccount) +* [getBalance](../classes/_polymathbase_.polymathbase.md#getbalance) +* [getERC20TokenWrapper](../classes/_polymathbase_.polymathbase.md#geterc20tokenwrapper) +* [getPolyTokens](../classes/_polymathbase_.polymathbase.md#getpolytokens) +* [isTestnet](../classes/_polymathbase_.polymathbase.md#istestnet) +* [moduleFactory](../classes/_polymathbase_.polymathbase.md#modulefactory) +* [moduleRegistry](../classes/_polymathbase_.polymathbase.md#moduleregistry) +* [polyToken](../classes/_polymathbase_.polymathbase.md#polytoken) +* [polyTokenFaucet](../classes/_polymathbase_.polymathbase.md#polytokenfaucet) +* [polymathRegistry](../classes/_polymathbase_.polymathbase.md#polymathregistry) +* [securityTokenRegistry](../classes/_polymathbase_.polymathbase.md#securitytokenregistry) +* [tokenFactory](../classes/_polymathbase_.polymathbase.md#tokenfactory) +* [web3Wrapper](../classes/_polymathbase_.polymathbase.md#web3wrapper) + +### Methods + +* [getAllDividends](../classes/_polymathbase_.polymathbase.md#getalldividends) +* [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getattachedmodules) +* [getCheckpoint](../classes/_polymathbase_.polymathbase.md#getcheckpoint) +* [getCheckpoints](../classes/_polymathbase_.polymathbase.md#getcheckpoints) +* [getDividend](../classes/_polymathbase_.polymathbase.md#getdividend) +* [getDividends](../classes/_polymathbase_.polymathbase.md#getdividends) +* [getDividendsByCheckpoint](../classes/_polymathbase_.polymathbase.md#getdividendsbycheckpoint) +* [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md#getmoduleaddressesbyname) +* [getModuleFactoryAddress](../classes/_polymathbase_.polymathbase.md#getmodulefactoryaddress) +* [getTreasuryWallet](../classes/_polymathbase_.polymathbase.md#gettreasurywallet) +* [roleToPermission](../classes/_polymathbase_.polymathbase.md#roletopermission) + +## Constructors + +### constructor + ++ **new PolymathBase**\(`params`: ApiConstructorParams\): [_PolymathBase_](../classes/_polymathbase_.polymathbase.md) + +_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_](../classes/_polymathbase_.polymathbase.md) + +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_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:888_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L888) + +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_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +### getAttachedModules + +▸ **getAttachedModules**\(`__namedParameters`: object, `opts?`: [GetAttachedModulesOpts](../interfaces/_polymathbase_.getattachedmodulesopts.md)\): _Promise‹any\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:523_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L523) + +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_](../interfaces/_polymathbase_.getattachedmodulesopts.md) + +**Returns:** _Promise‹any\[\]›_ + +### getCheckpoint + +▸ **getCheckpoint**\(`__namedParameters`: object\): _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_›_ + +_Defined in_ [_src/PolymathBase.ts:697_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L697) + +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_](../interfaces/_polymathbase_.basecheckpoint.md)_›_ + +### getCheckpoints + +▸ **getCheckpoints**\(`__namedParameters`: object\): _Promise‹_[_BaseCheckpoint_](../interfaces/_polymathbase_.basecheckpoint.md)_\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:722_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L722) + +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_](../interfaces/_polymathbase_.basecheckpoint.md)_\[\]›_ + +### getDividend + +▸ **getDividend**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_›_ + +_Defined in_ [_src/PolymathBase.ts:783_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L783) + +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_](../interfaces/_polymathbase_.basedividend.md)_›_ + +### getDividends + +▸ **getDividends**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:868_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L868) + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `dividendsModule` | ERC20DividendCheckpoint\_3\_0\_0 | + +**Returns:** _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +### getDividendsByCheckpoint + +▸ **getDividendsByCheckpoint**\(`__namedParameters`: object\): _Promise‹_[_BaseDividend_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:849_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L849) + +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_](../interfaces/_polymathbase_.basedividend.md)_\[\]›_ + +### getModuleAddressesByName + +▸ **getModuleAddressesByName**\(`__namedParameters`: object, `opts?`: [GetModuleAddressesByNameOpts](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md)\): _Promise‹string\[\]›_ + +_Defined in_ [_src/PolymathBase.ts:485_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L485) + +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_](../interfaces/_polymathbase_.getmoduleaddressesbynameopts.md) + +**Returns:** _Promise‹string\[\]›_ + +### getModuleFactoryAddress + +▸ **getModuleFactoryAddress**\(`__namedParameters`: object\): _Promise‹string›_ + +_Defined in_ [_src/PolymathBase.ts:362_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L362) + +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_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L425) + +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_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L923) + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `role` | [SecurityTokenRole](../enums/_types_index_.securitytokenrole.md) | + +**Returns:** _Promise‹object›_ + diff --git a/docs/api/external-modules/_polymatherror_.md b/docs/api/external-modules/_polymatherror_.md new file mode 100644 index 0000000..9e1ebd7 --- /dev/null +++ b/docs/api/external-modules/_polymatherror_.md @@ -0,0 +1,40 @@ +# PolymathError + +## Index + +### Classes + +* [PolymathError](../classes/_polymatherror_.polymatherror.md) + +### Object literals + +* [ErrorMessagesPerCode](_polymatherror_.md#const-errormessagespercode) + +## Object literals + +### `Const` ErrorMessagesPerCode + +### ▪ **ErrorMessagesPerCode**: _object_ + +_Defined in_ [_src/PolymathError.ts:3_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L3) + +### \_\_computed + +• **\_\_computed**: _string_ = "You must install the Metamask browser extension if attempting to use Polymath SDK from the browser" + +_Defined in_ [_src/PolymathError.ts:6_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L6) + +_Defined in_ [_src/PolymathError.ts:7_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L7) + +_Defined in_ [_src/PolymathError.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L9) + +_Defined in_ [_src/PolymathError.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L10) + +_Defined in_ [_src/PolymathError.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L11) + +_Defined in_ [_src/PolymathError.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L13) + +_Defined in_ [_src/PolymathError.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L14) + +_Defined in_ [_src/PolymathError.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L16) + diff --git a/docs/api/external-modules/_polymatherror_.polymatherror.md b/docs/api/external-modules/_polymatherror_.polymatherror.md new file mode 100644 index 0000000..1efa77f --- /dev/null +++ b/docs/api/external-modules/_polymatherror_.polymatherror.md @@ -0,0 +1,83 @@ +# PolymathError + +Wraps an error to give more information about it's type + +## Hierarchy + +* Error + + ↳ **PolymathError** + +## Index + +### Constructors + +* [constructor](../classes/_polymatherror_.polymatherror.md#constructor) + +### Properties + +* [code](../classes/_polymatherror_.polymatherror.md#code) +* [message](../classes/_polymatherror_.polymatherror.md#message) +* [name](../classes/_polymatherror_.polymatherror.md#name) +* [stack](../classes/_polymatherror_.polymatherror.md#optional-stack) +* [Error](../classes/_polymatherror_.polymatherror.md#static-error) + +## Constructors + +### constructor + ++ **new PolymathError**\(`__namedParameters`: object\): [_PolymathError_](../classes/_polymatherror_.polymatherror.md) + +_Defined in_ [_src/PolymathError.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24) + +**Parameters:** + +▪ **\_\_namedParameters**: _object_ + +| Name | Type | +| :--- | :--- | +| `code` | [ErrorCode](../enums/_types_index_.errorcode.md) | +| `message` | undefined \| string | + +**Returns:** [_PolymathError_](../classes/_polymatherror_.polymatherror.md) + +## Properties + +### code + +• **code**: [_ErrorCode_](../enums/_types_index_.errorcode.md) + +_Defined in_ [_src/PolymathError.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L24) + +### message + +• **message**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.es5.d.ts:964 + +### name + +• **name**: _string_ + +_Inherited from void_ + +Defined in node\_modules/typescript/lib/lib.es5.d.ts:963 + +### `Optional` stack + +• **stack**? : _undefined \| string_ + +_Inherited from void_ + +_Overrides void_ + +Defined in node\_modules/typescript/lib/lib.es5.d.ts:965 + +### `Static` Error + +▪ **Error**: _ErrorConstructor_ + +Defined in node\_modules/typescript/lib/lib.es5.d.ts:974 + diff --git a/docs/api/external-modules/_posttransactionresolver_.md b/docs/api/external-modules/_posttransactionresolver_.md new file mode 100644 index 0000000..887b160 --- /dev/null +++ b/docs/api/external-modules/_posttransactionresolver_.md @@ -0,0 +1,2 @@ +# PostTransactionResolver + diff --git a/docs/api/external-modules/_procedures_approveerc20_.approveerc20.md b/docs/api/external-modules/_procedures_approveerc20_.approveerc20.md new file mode 100644 index 0000000..0d412a3 --- /dev/null +++ b/docs/api/external-modules/_procedures_approveerc20_.approveerc20.md @@ -0,0 +1,195 @@ +# ApproveErc20 + +Procedure to approve spending funds on an ERC20 token. If no token address is specified, it defaults to POLY + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md)› + + ↳ **ApproveErc20** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_approveerc20_.approveerc20.md#constructor) + +### Properties + +* [args](../classes/_procedures_approveerc20_.approveerc20.md#protected-args) +* [context](../classes/_procedures_approveerc20_.approveerc20.md#protected-context) +* [type](../classes/_procedures_approveerc20_.approveerc20.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_approveerc20_.approveerc20.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_approveerc20_.approveerc20.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_approveerc20_.approveerc20.md#addtransaction) +* [prepare](../classes/_procedures_approveerc20_.approveerc20.md#prepare) +* [prepareTransactions](../classes/_procedures_approveerc20_.approveerc20.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ApproveErc20**\(`args`: [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ApproveErc20_](../classes/_procedures_approveerc20_.approveerc20.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ApproveErc20ProcedureArgs](../interfaces/_types_index_.approveerc20procedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ApproveErc20_](../classes/_procedures_approveerc20_.approveerc20.md) + +## Properties + +### `Protected` args + +• **args**: [_ApproveErc20ProcedureArgs_](../interfaces/_types_index_.approveerc20procedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ApproveErc20 + +_Overrides void_ + +_Defined in_ [_src/procedures/ApproveErc20.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L10) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ApproveErc20.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ApproveErc20.ts#L21) + +Approve spend of an ERC20 token by another wallet. The token in question defaults to POLY if no address is supplied + +Note that if the amount has already been approved, the spending approval transaction will not be added to the queue and the procedure will return + +Note that the procedure will fail if the owner's token balance is less than the amount being approved. The only exception to this is when approving a POLY spend on a testnet. If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_approveerc20_.md b/docs/api/external-modules/_procedures_approveerc20_.md similarity index 67% rename from docs/api/modules/_procedures_approveerc20_.md rename to docs/api/external-modules/_procedures_approveerc20_.md index d99cc4a..0d7e55b 100644 --- a/docs/api/modules/_procedures_approveerc20_.md +++ b/docs/api/external-modules/_procedures_approveerc20_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ApproveErc20" +# procedures/ApproveErc20 ## Index ### Classes * [ApproveErc20](../classes/_procedures_approveerc20_.approveerc20.md) + diff --git a/docs/api/external-modules/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md b/docs/api/external-modules/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md new file mode 100644 index 0000000..b6e17fb --- /dev/null +++ b/docs/api/external-modules/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md @@ -0,0 +1,198 @@ +# AssignSecurityTokenRole + +Procedure that assigns a Security Token Role to a delegate address. Roles grant said delegate permissions over certain Security Token Features + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md)› + + ↳ **AssignSecurityTokenRole** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#constructor) + +### Properties + +* [args](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#protected-args) +* [context](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#protected-context) +* [type](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#addtransaction) +* [prepare](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#prepare) +* [prepareTransactions](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md#preparetransactions) + +## Constructors + +### constructor + ++ **new AssignSecurityTokenRole**\(`args`: [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_AssignSecurityTokenRole_](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [AssignSecurityTokenRoleProcedureArgs](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_AssignSecurityTokenRole_](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) + +## Properties + +### `Protected` args + +• **args**: [_AssignSecurityTokenRoleProcedureArgs_](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.AssignSecurityTokenRole + +_Overrides void_ + +_Defined in_ [_src/procedures/AssignSecurityTokenRole.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L17) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/AssignSecurityTokenRole.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignSecurityTokenRole.ts#L28) + +* If the delegate does not exist, the delegate address will be added +* The specified Role will be assigned/revoked to/from the delegate + +Note this procedure will fail if: + +* You attempt to assign a Role related to a Feature that hasn't been enabled +* The Permissions Feature hasn't been enabled on the Security Token +* You attempt to assign/revoke a Role that has already been assigned/revoked + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_assignsecuritytokenrole_.md b/docs/api/external-modules/_procedures_assignsecuritytokenrole_.md similarity index 69% rename from docs/api/modules/_procedures_assignsecuritytokenrole_.md rename to docs/api/external-modules/_procedures_assignsecuritytokenrole_.md index d9aed54..f31315d 100644 --- a/docs/api/modules/_procedures_assignsecuritytokenrole_.md +++ b/docs/api/external-modules/_procedures_assignsecuritytokenrole_.md @@ -1,7 +1,8 @@ -# External module: "procedures/AssignSecurityTokenRole" +# procedures/AssignSecurityTokenRole ## Index ### Classes * [AssignSecurityTokenRole](../classes/_procedures_assignsecuritytokenrole_.assignsecuritytokenrole.md) + diff --git a/docs/api/external-modules/_procedures_assignstorole_.assignstorole.md b/docs/api/external-modules/_procedures_assignstorole_.assignstorole.md new file mode 100644 index 0000000..07c47f0 --- /dev/null +++ b/docs/api/external-modules/_procedures_assignstorole_.assignstorole.md @@ -0,0 +1,197 @@ +# AssignStoRole + +Procedure to assign an STO Role to a delegate + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md)› + + ↳ **AssignStoRole** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_assignstorole_.assignstorole.md#constructor) + +### Properties + +* [args](../classes/_procedures_assignstorole_.assignstorole.md#protected-args) +* [context](../classes/_procedures_assignstorole_.assignstorole.md#protected-context) +* [type](../classes/_procedures_assignstorole_.assignstorole.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_assignstorole_.assignstorole.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_assignstorole_.assignstorole.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_assignstorole_.assignstorole.md#addtransaction) +* [prepare](../classes/_procedures_assignstorole_.assignstorole.md#prepare) +* [prepareTransactions](../classes/_procedures_assignstorole_.assignstorole.md#preparetransactions) + +## Constructors + +### constructor + ++ **new AssignStoRole**\(`args`: [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_AssignStoRole_](../classes/_procedures_assignstorole_.assignstorole.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [AssignStoRoleProcedureArgs](../interfaces/_types_index_.assignstoroleprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_AssignStoRole_](../classes/_procedures_assignstorole_.assignstorole.md) + +## Properties + +### `Protected` args + +• **args**: [_AssignStoRoleProcedureArgs_](../interfaces/_types_index_.assignstoroleprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.AssignStoRole + +_Overrides void_ + +_Defined in_ [_src/procedures/AssignStoRole.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L17) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/AssignStoRole.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/AssignStoRole.ts#L27) + +* If the delegate does not exist, the delegate address will be added +* The specified Role will be assigned/revoked to/from the delegate + +Note this procedure will fail if: + +* The Permissions Feature hasn't been enabled on the Security Token +* You attempt to assign/revoke a Role that has already been assigned/revoked + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_assignstorole_.md b/docs/api/external-modules/_procedures_assignstorole_.md similarity index 68% rename from docs/api/modules/_procedures_assignstorole_.md rename to docs/api/external-modules/_procedures_assignstorole_.md index d499779..c081fc1 100644 --- a/docs/api/modules/_procedures_assignstorole_.md +++ b/docs/api/external-modules/_procedures_assignstorole_.md @@ -1,7 +1,8 @@ -# External module: "procedures/AssignStoRole" +# procedures/AssignStoRole ## Index ### Classes * [AssignStoRole](../classes/_procedures_assignstorole_.assignstorole.md) + diff --git a/docs/api/external-modules/_procedures_controllerredeem_.controllerredeem.md b/docs/api/external-modules/_procedures_controllerredeem_.controllerredeem.md new file mode 100644 index 0000000..c1612f1 --- /dev/null +++ b/docs/api/external-modules/_procedures_controllerredeem_.controllerredeem.md @@ -0,0 +1,197 @@ +# ControllerRedeem + +Procedure that redeems \(burns\) Security Tokens from an account. Can only be executed by the Security Token's Controller + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md)› + + ↳ **ControllerRedeem** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_controllerredeem_.controllerredeem.md#constructor) + +### Properties + +* [args](../classes/_procedures_controllerredeem_.controllerredeem.md#protected-args) +* [context](../classes/_procedures_controllerredeem_.controllerredeem.md#protected-context) +* [type](../classes/_procedures_controllerredeem_.controllerredeem.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_controllerredeem_.controllerredeem.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_controllerredeem_.controllerredeem.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_controllerredeem_.controllerredeem.md#addtransaction) +* [prepare](../classes/_procedures_controllerredeem_.controllerredeem.md#prepare) +* [prepareTransactions](../classes/_procedures_controllerredeem_.controllerredeem.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ControllerRedeem**\(`args`: [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ControllerRedeem_](../classes/_procedures_controllerredeem_.controllerredeem.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ControllerRedeemProcedureArgs](../interfaces/_types_index_.controllerredeemprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ControllerRedeem_](../classes/_procedures_controllerredeem_.controllerredeem.md) + +## Properties + +### `Protected` args + +• **args**: [_ControllerRedeemProcedureArgs_](../interfaces/_types_index_.controllerredeemprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ControllerRedeem + +_Overrides void_ + +_Defined in_ [_src/procedures/ControllerRedeem.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L44) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ControllerRedeem.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerRedeem.ts#L54) + +Redeem tokens from a specific address, optionally providing a reason or extra data for the action + +Note this procedure will fail if: + +* The "from" address is invalid +* Attempting to redeem an amount of tokens greater than the account's balance +* The current wallet address is not the Security Token controller address + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_controllerredeem_.md b/docs/api/external-modules/_procedures_controllerredeem_.md similarity index 68% rename from docs/api/modules/_procedures_controllerredeem_.md rename to docs/api/external-modules/_procedures_controllerredeem_.md index ddc438e..0a02964 100644 --- a/docs/api/modules/_procedures_controllerredeem_.md +++ b/docs/api/external-modules/_procedures_controllerredeem_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ControllerRedeem" +# procedures/ControllerRedeem ## Index ### Classes * [ControllerRedeem](../classes/_procedures_controllerredeem_.controllerredeem.md) + diff --git a/docs/api/external-modules/_procedures_controllertransfer_.controllertransfer.md b/docs/api/external-modules/_procedures_controllertransfer_.controllertransfer.md new file mode 100644 index 0000000..034b862 --- /dev/null +++ b/docs/api/external-modules/_procedures_controllertransfer_.controllertransfer.md @@ -0,0 +1,197 @@ +# ControllerTransfer + +Procedure that forcefully transfers Security Tokens from one account to another. Can only be executed by the Security Token's Controller + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md)› + + ↳ **ControllerTransfer** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_controllertransfer_.controllertransfer.md#constructor) + +### Properties + +* [args](../classes/_procedures_controllertransfer_.controllertransfer.md#protected-args) +* [context](../classes/_procedures_controllertransfer_.controllertransfer.md#protected-context) +* [type](../classes/_procedures_controllertransfer_.controllertransfer.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_controllertransfer_.controllertransfer.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_controllertransfer_.controllertransfer.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_controllertransfer_.controllertransfer.md#addtransaction) +* [prepare](../classes/_procedures_controllertransfer_.controllertransfer.md#prepare) +* [prepareTransactions](../classes/_procedures_controllertransfer_.controllertransfer.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ControllerTransfer**\(`args`: [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ControllerTransfer_](../classes/_procedures_controllertransfer_.controllertransfer.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ControllerTransferProcedureArgs](../interfaces/_types_index_.controllertransferprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ControllerTransfer_](../classes/_procedures_controllertransfer_.controllertransfer.md) + +## Properties + +### `Protected` args + +• **args**: [_ControllerTransferProcedureArgs_](../interfaces/_types_index_.controllertransferprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ControllerTransfer + +_Overrides void_ + +_Defined in_ [_src/procedures/ControllerTransfer.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L44) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ControllerTransfer.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ControllerTransfer.ts#L54) + +Forcefully transfer tokens from one address to another + +Note this procedure will fail if: + +* Any of the addresses are invalid +* The sender's \("from" address\) balance is less than the amount being transferred +* The current wallet address is not the Security Token controller address + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_controllertransfer_.md b/docs/api/external-modules/_procedures_controllertransfer_.md similarity index 68% rename from docs/api/modules/_procedures_controllertransfer_.md rename to docs/api/external-modules/_procedures_controllertransfer_.md index 4f39c3a..4204722 100644 --- a/docs/api/modules/_procedures_controllertransfer_.md +++ b/docs/api/external-modules/_procedures_controllertransfer_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ControllerTransfer" +# procedures/ControllerTransfer ## Index ### Classes * [ControllerTransfer](../classes/_procedures_controllertransfer_.controllertransfer.md) + diff --git a/docs/api/external-modules/_procedures_createcheckpoint_.createcheckpoint.md b/docs/api/external-modules/_procedures_createcheckpoint_.createcheckpoint.md new file mode 100644 index 0000000..83a3057 --- /dev/null +++ b/docs/api/external-modules/_procedures_createcheckpoint_.createcheckpoint.md @@ -0,0 +1,187 @@ +# CreateCheckpoint + +Procedure to create a Checkpoint on a Security Token + +## Hierarchy + +* Procedure‹[CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), [Checkpoint](../classes/_entities_checkpoint_.checkpoint.md)› + + ↳ **CreateCheckpoint** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_createcheckpoint_.createcheckpoint.md#constructor) + +### Properties + +* [args](../classes/_procedures_createcheckpoint_.createcheckpoint.md#protected-args) +* [context](../classes/_procedures_createcheckpoint_.createcheckpoint.md#protected-context) +* [type](../classes/_procedures_createcheckpoint_.createcheckpoint.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_createcheckpoint_.createcheckpoint.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_createcheckpoint_.createcheckpoint.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_createcheckpoint_.createcheckpoint.md#addtransaction) +* [prepare](../classes/_procedures_createcheckpoint_.createcheckpoint.md#prepare) +* [prepareTransactions](../classes/_procedures_createcheckpoint_.createcheckpoint.md#preparetransactions) + +## Constructors + +### constructor + ++ **new CreateCheckpoint**\(`args`: [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_CreateCheckpoint_](../classes/_procedures_createcheckpoint_.createcheckpoint.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [CreateCheckpointProcedureArgs](../interfaces/_types_index_.createcheckpointprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_CreateCheckpoint_](../classes/_procedures_createcheckpoint_.createcheckpoint.md) + +## Properties + +### `Protected` args + +• **args**: [_CreateCheckpointProcedureArgs_](../interfaces/_types_index_.createcheckpointprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateCheckpoint + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateCheckpoint.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L27) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateCheckpoint.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateCheckpoint.ts#L32) + +Create a Checkpoint on the Security Token and return it + +**Returns:** _Promise‹PostTransactionResolver‹_[_Checkpoint_](../classes/_entities_checkpoint_.checkpoint.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_createcheckpoint_.md b/docs/api/external-modules/_procedures_createcheckpoint_.md similarity index 68% rename from docs/api/modules/_procedures_createcheckpoint_.md rename to docs/api/external-modules/_procedures_createcheckpoint_.md index 7b23b54..5edc527 100644 --- a/docs/api/modules/_procedures_createcheckpoint_.md +++ b/docs/api/external-modules/_procedures_createcheckpoint_.md @@ -1,7 +1,8 @@ -# External module: "procedures/CreateCheckpoint" +# procedures/CreateCheckpoint ## Index ### Classes * [CreateCheckpoint](../classes/_procedures_createcheckpoint_.createcheckpoint.md) + diff --git a/docs/api/external-modules/_procedures_createdividenddistribution_.createdividenddistribution.md b/docs/api/external-modules/_procedures_createdividenddistribution_.createdividenddistribution.md new file mode 100644 index 0000000..dc86b4f --- /dev/null +++ b/docs/api/external-modules/_procedures_createdividenddistribution_.createdividenddistribution.md @@ -0,0 +1,192 @@ +# CreateDividendDistribution + +Procedure to create a Dividend Distribution on a Security Token. The funds to be distributed as dividends will come from the current user's wallet + +## Hierarchy + +* Procedure‹[CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), [DividendDistribution](../classes/_entities_dividenddistribution_.dividenddistribution.md)› + + ↳ **CreateDividendDistribution** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#constructor) + +### Properties + +* [args](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#protected-args) +* [context](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#protected-context) +* [type](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#addtransaction) +* [prepare](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#prepare) +* [prepareTransactions](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md#preparetransactions) + +## Constructors + +### constructor + ++ **new CreateDividendDistribution**\(`args`: [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_CreateDividendDistribution_](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [CreateDividendDistributionProcedureArgs](../interfaces/_types_index_.createdividenddistributionprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_CreateDividendDistribution_](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md) + +## Properties + +### `Protected` args + +• **args**: [_CreateDividendDistributionProcedureArgs_](../interfaces/_types_index_.createdividenddistributionprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateDividendDistribution + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateDividendDistribution.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L27) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateDividendDistribution.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateDividendDistribution.ts#L37) + +* Approve spend of the amount that will be distributed +* Create a Dividend Distribution for said amount +* Set tax withholding percentages \(if supplied\) +* Return the newly created Dividend Distribution + +Note that this procedure will fail if the ERC20 Dividends Feature has not been enabled + +**Returns:** _Promise‹PostTransactionResolver‹_[_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_createdividenddistribution_.md b/docs/api/external-modules/_procedures_createdividenddistribution_.md similarity index 69% rename from docs/api/modules/_procedures_createdividenddistribution_.md rename to docs/api/external-modules/_procedures_createdividenddistribution_.md index 55336dc..b8ff69d 100644 --- a/docs/api/modules/_procedures_createdividenddistribution_.md +++ b/docs/api/external-modules/_procedures_createdividenddistribution_.md @@ -1,7 +1,8 @@ -# External module: "procedures/CreateDividendDistribution" +# procedures/CreateDividendDistribution ## Index ### Classes * [CreateDividendDistribution](../classes/_procedures_createdividenddistribution_.createdividenddistribution.md) + diff --git a/docs/api/external-modules/_procedures_createsecuritytoken_.createsecuritytoken.md b/docs/api/external-modules/_procedures_createsecuritytoken_.createsecuritytoken.md new file mode 100644 index 0000000..76a7f2a --- /dev/null +++ b/docs/api/external-modules/_procedures_createsecuritytoken_.createsecuritytoken.md @@ -0,0 +1,194 @@ +# CreateSecurityToken + +Procedure that creates a new Security Token on the Polymath ecosystem + +## Hierarchy + +* Procedure‹[CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)› + + ↳ **CreateSecurityToken** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#constructor) + +### Properties + +* [args](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#protected-args) +* [context](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#protected-context) +* [type](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#addtransaction) +* [prepare](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#prepare) +* [prepareTransactions](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md#preparetransactions) + +## Constructors + +### constructor + ++ **new CreateSecurityToken**\(`args`: [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_CreateSecurityToken_](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [CreateSecurityTokenProcedureArgs](../interfaces/_types_index_.createsecuritytokenprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_CreateSecurityToken_](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md) + +## Properties + +### `Protected` args + +• **args**: [_CreateSecurityTokenProcedureArgs_](../interfaces/_types_index_.createsecuritytokenprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.CreateSecurityToken + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateSecurityToken.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L20) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/CreateSecurityToken.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/CreateSecurityToken.ts#L31) + +* Approve spending the required POLY to pay the Security Token launch fee +* Create the new Security Token + +Note that this procedure will fail if: + +* The Security Token symbol hasn't been reserved +* The Security Token symbol has already been reserved by another issuer +* The Security Token already been launched + +**Returns:** _Promise‹PostTransactionResolver‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_createsecuritytoken_.md b/docs/api/external-modules/_procedures_createsecuritytoken_.md similarity index 69% rename from docs/api/modules/_procedures_createsecuritytoken_.md rename to docs/api/external-modules/_procedures_createsecuritytoken_.md index a4b077a..777489b 100644 --- a/docs/api/modules/_procedures_createsecuritytoken_.md +++ b/docs/api/external-modules/_procedures_createsecuritytoken_.md @@ -1,7 +1,8 @@ -# External module: "procedures/CreateSecurityToken" +# procedures/CreateSecurityToken ## Index ### Classes * [CreateSecurityToken](../classes/_procedures_createsecuritytoken_.createsecuritytoken.md) + diff --git a/docs/api/external-modules/_procedures_disablecontroller_.disablecontroller.md b/docs/api/external-modules/_procedures_disablecontroller_.disablecontroller.md new file mode 100644 index 0000000..e0462d1 --- /dev/null +++ b/docs/api/external-modules/_procedures_disablecontroller_.disablecontroller.md @@ -0,0 +1,197 @@ +# DisableController + +Procedure that permanently disables a Security Token's controller functionality. This requires the Security Token's owner to send signed data in acknowledgement + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md)› + + ↳ **DisableController** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_disablecontroller_.disablecontroller.md#constructor) + +### Properties + +* [args](../classes/_procedures_disablecontroller_.disablecontroller.md#protected-args) +* [context](../classes/_procedures_disablecontroller_.disablecontroller.md#protected-context) +* [type](../classes/_procedures_disablecontroller_.disablecontroller.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_disablecontroller_.disablecontroller.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_disablecontroller_.disablecontroller.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_disablecontroller_.disablecontroller.md#addtransaction) +* [prepare](../classes/_procedures_disablecontroller_.disablecontroller.md#prepare) +* [prepareTransactions](../classes/_procedures_disablecontroller_.disablecontroller.md#preparetransactions) + +## Constructors + +### constructor + ++ **new DisableController**\(`args`: [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_DisableController_](../classes/_procedures_disablecontroller_.disablecontroller.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [DisableControllerProcedureArgs](../interfaces/_types_index_.disablecontrollerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_DisableController_](../classes/_procedures_disablecontroller_.disablecontroller.md) + +## Properties + +### `Protected` args + +• **args**: [_DisableControllerProcedureArgs_](../interfaces/_types_index_.disablecontrollerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.DisableController + +_Overrides void_ + +_Defined in_ [_src/procedures/DisableController.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L14) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/DisableController.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableController.ts#L24) + +* If no signature acknowledgement data \(optional\) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key +* Disable the Security Token's controller functionality + +Note that this procedure will fail if: + +* The current user is not the owner of the Security Token +* The controller has already been previously disabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_disablecontroller_.md b/docs/api/external-modules/_procedures_disablecontroller_.md similarity index 68% rename from docs/api/modules/_procedures_disablecontroller_.md rename to docs/api/external-modules/_procedures_disablecontroller_.md index 5a59933..bb52d5f 100644 --- a/docs/api/modules/_procedures_disablecontroller_.md +++ b/docs/api/external-modules/_procedures_disablecontroller_.md @@ -1,7 +1,8 @@ -# External module: "procedures/DisableController" +# procedures/DisableController ## Index ### Classes * [DisableController](../classes/_procedures_disablecontroller_.disablecontroller.md) + diff --git a/docs/api/external-modules/_procedures_disablefeature_.disablefeature.md b/docs/api/external-modules/_procedures_disablefeature_.disablefeature.md new file mode 100644 index 0000000..f310936 --- /dev/null +++ b/docs/api/external-modules/_procedures_disablefeature_.disablefeature.md @@ -0,0 +1,191 @@ +# DisableFeature + +Procedure to disable a Feature on a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md)› + + ↳ **DisableFeature** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_disablefeature_.disablefeature.md#constructor) + +### Properties + +* [args](../classes/_procedures_disablefeature_.disablefeature.md#protected-args) +* [context](../classes/_procedures_disablefeature_.disablefeature.md#protected-context) +* [type](../classes/_procedures_disablefeature_.disablefeature.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_disablefeature_.disablefeature.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_disablefeature_.disablefeature.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_disablefeature_.disablefeature.md#addtransaction) +* [prepare](../classes/_procedures_disablefeature_.disablefeature.md#prepare) +* [prepareTransactions](../classes/_procedures_disablefeature_.disablefeature.md#preparetransactions) + +## Constructors + +### constructor + ++ **new DisableFeature**\(`args`: [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_DisableFeature_](../classes/_procedures_disablefeature_.disablefeature.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [DisableFeatureProcedureArgs](../interfaces/_types_index_.disablefeatureprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_DisableFeature_](../classes/_procedures_disablefeature_.disablefeature.md) + +## Properties + +### `Protected` args + +• **args**: [_DisableFeatureProcedureArgs_](../interfaces/_types_index_.disablefeatureprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.DisableFeature + +_Overrides void_ + +_Defined in_ [_src/procedures/DisableFeature.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/DisableFeature.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/DisableFeature.ts#L20) + +Disable the Feature by archiving the attached module that corresponds to that Feature + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_disablefeature_.md b/docs/api/external-modules/_procedures_disablefeature_.md similarity index 68% rename from docs/api/modules/_procedures_disablefeature_.md rename to docs/api/external-modules/_procedures_disablefeature_.md index 8e6cd8f..d04844f 100644 --- a/docs/api/modules/_procedures_disablefeature_.md +++ b/docs/api/external-modules/_procedures_disablefeature_.md @@ -1,7 +1,8 @@ -# External module: "procedures/DisableFeature" +# procedures/DisableFeature ## Index ### Classes * [DisableFeature](../classes/_procedures_disablefeature_.disablefeature.md) + diff --git a/docs/api/external-modules/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md b/docs/api/external-modules/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md new file mode 100644 index 0000000..7ae8202 --- /dev/null +++ b/docs/api/external-modules/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md @@ -0,0 +1,191 @@ +# EnableCountTransferManager + +Procedure that enables Count Restrictions on a Security Token. This allows setting a number of maximum token holders. Any token transfer that would result in the amount of token holders to exceed this maximum will fail + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md)› + + ↳ **EnableCountTransferManager** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#constructor) + +### Properties + +* [args](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#protected-args) +* [context](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#protected-context) +* [type](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#addtransaction) +* [prepare](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#prepare) +* [prepareTransactions](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md#preparetransactions) + +## Constructors + +### constructor + ++ **new EnableCountTransferManager**\(`args`: [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_EnableCountTransferManager_](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [EnableCountTransferManagerProcedureArgs](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_EnableCountTransferManager_](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) + +## Properties + +### `Protected` args + +• **args**: [_EnableCountTransferManagerProcedureArgs_](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableCountTransferManager + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableCountTransferManager.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableCountTransferManager.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableCountTransferManager.ts#L20) + +Enable Count Restrictions on the Security Token and set the supplied max holder count + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_enablecounttransfermanager_.md b/docs/api/external-modules/_procedures_enablecounttransfermanager_.md similarity index 69% rename from docs/api/modules/_procedures_enablecounttransfermanager_.md rename to docs/api/external-modules/_procedures_enablecounttransfermanager_.md index 4f1d1c8..160cb7d 100644 --- a/docs/api/modules/_procedures_enablecounttransfermanager_.md +++ b/docs/api/external-modules/_procedures_enablecounttransfermanager_.md @@ -1,7 +1,8 @@ -# External module: "procedures/EnableCountTransferManager" +# procedures/EnableCountTransferManager ## Index ### Classes * [EnableCountTransferManager](../classes/_procedures_enablecounttransfermanager_.enablecounttransfermanager.md) + diff --git a/docs/api/external-modules/_procedures_enabledividendmanager_.enabledividendmanager.md b/docs/api/external-modules/_procedures_enabledividendmanager_.enabledividendmanager.md new file mode 100644 index 0000000..5ee2f7c --- /dev/null +++ b/docs/api/external-modules/_procedures_enabledividendmanager_.enabledividendmanager.md @@ -0,0 +1,191 @@ +# EnableDividendManager + +Procedure that enables Dividends on a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md)› + + ↳ **EnableDividendManager** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#constructor) + +### Properties + +* [args](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#protected-args) +* [context](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#protected-context) +* [type](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#addtransaction) +* [prepare](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#prepare) +* [prepareTransactions](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md#preparetransactions) + +## Constructors + +### constructor + ++ **new EnableDividendManager**\(`args`: [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_EnableDividendManager_](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [EnableDividendManagerProcedureArgs](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_EnableDividendManager_](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md) + +## Properties + +### `Protected` args + +• **args**: [_EnableDividendManagerProcedureArgs_](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableDividendManager + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableDividendManager.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableDividendManager.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableDividendManager.ts#L20) + +Enable Dividends on the Security Token and set a wallet address where reclaimed dividends and withheld tax will be stored + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_enabledividendmanager_.md b/docs/api/external-modules/_procedures_enabledividendmanager_.md similarity index 69% rename from docs/api/modules/_procedures_enabledividendmanager_.md rename to docs/api/external-modules/_procedures_enabledividendmanager_.md index 131d647..9904e2c 100644 --- a/docs/api/modules/_procedures_enabledividendmanager_.md +++ b/docs/api/external-modules/_procedures_enabledividendmanager_.md @@ -1,7 +1,8 @@ -# External module: "procedures/EnableDividendManager" +# procedures/EnableDividendManager ## Index ### Classes * [EnableDividendManager](../classes/_procedures_enabledividendmanager_.enabledividendmanager.md) + diff --git a/docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md b/docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md new file mode 100644 index 0000000..19a5068 --- /dev/null +++ b/docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md @@ -0,0 +1,191 @@ +# EnableGeneralPermissionManager + +Procedure that enables Permissions on a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md)› + + ↳ **EnableGeneralPermissionManager** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#constructor) + +### Properties + +* [args](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#protected-args) +* [context](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#protected-context) +* [type](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#addtransaction) +* [prepare](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#prepare) +* [prepareTransactions](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md#preparetransactions) + +## Constructors + +### constructor + ++ **new EnableGeneralPermissionManager**\(`args`: [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_EnableGeneralPermissionManager_](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [EnableGeneralPermissionManagerProcedureArgs](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_EnableGeneralPermissionManager_](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) + +## Properties + +### `Protected` args + +• **args**: [_EnableGeneralPermissionManagerProcedureArgs_](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableGeneralPermissionManager + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableGeneralPermissionManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L17) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableGeneralPermissionManager.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralPermissionManager.ts#L22) + +Enable Permissions on the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_enablegeneralpermissionmanager_.md b/docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.md similarity index 70% rename from docs/api/modules/_procedures_enablegeneralpermissionmanager_.md rename to docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.md index 961e259..0840473 100644 --- a/docs/api/modules/_procedures_enablegeneralpermissionmanager_.md +++ b/docs/api/external-modules/_procedures_enablegeneralpermissionmanager_.md @@ -1,7 +1,8 @@ -# External module: "procedures/EnableGeneralPermissionManager" +# procedures/EnableGeneralPermissionManager ## Index ### Classes * [EnableGeneralPermissionManager](../classes/_procedures_enablegeneralpermissionmanager_.enablegeneralpermissionmanager.md) + diff --git a/docs/api/external-modules/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md b/docs/api/external-modules/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md new file mode 100644 index 0000000..6e73f35 --- /dev/null +++ b/docs/api/external-modules/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md @@ -0,0 +1,191 @@ +# EnableGeneralTransferManager + +Procedure that enables Tokenholders \(specifically the KYC whitelist\) on a Security Token. This comes enabled by default + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md)› + + ↳ **EnableGeneralTransferManager** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#constructor) + +### Properties + +* [args](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#protected-args) +* [context](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#protected-context) +* [type](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#addtransaction) +* [prepare](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#prepare) +* [prepareTransactions](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md#preparetransactions) + +## Constructors + +### constructor + ++ **new EnableGeneralTransferManager**\(`args`: [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_EnableGeneralTransferManager_](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [EnableGeneralTransferManagerProcedureArgs](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_EnableGeneralTransferManager_](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) + +## Properties + +### `Protected` args + +• **args**: [_EnableGeneralTransferManagerProcedureArgs_](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnableGeneralTransferManager + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableGeneralTransferManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L17) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/EnableGeneralTransferManager.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnableGeneralTransferManager.ts#L22) + +Enable Tokenholders on the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_enablegeneraltransfermanager_.md b/docs/api/external-modules/_procedures_enablegeneraltransfermanager_.md similarity index 70% rename from docs/api/modules/_procedures_enablegeneraltransfermanager_.md rename to docs/api/external-modules/_procedures_enablegeneraltransfermanager_.md index 92867dd..0068c1d 100644 --- a/docs/api/modules/_procedures_enablegeneraltransfermanager_.md +++ b/docs/api/external-modules/_procedures_enablegeneraltransfermanager_.md @@ -1,7 +1,8 @@ -# External module: "procedures/EnableGeneralTransferManager" +# procedures/EnableGeneralTransferManager ## Index ### Classes * [EnableGeneralTransferManager](../classes/_procedures_enablegeneraltransfermanager_.enablegeneraltransfermanager.md) + diff --git a/docs/api/external-modules/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md b/docs/api/external-modules/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md new file mode 100644 index 0000000..bf1f976 --- /dev/null +++ b/docs/api/external-modules/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md @@ -0,0 +1,193 @@ +# EnablePercentageTransferManager + +Procedure that enables Percentage Ownership Restictions on a Security Token. This allows setting a maximum percentage of the total supply that a single tokenholder can own. Any token transfer that would result in a single tokenholder owning more than the allowed percentage will fail + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md)› + + ↳ **EnablePercentageTransferManager** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#constructor) + +### Properties + +* [args](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#protected-args) +* [context](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#protected-context) +* [type](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#addtransaction) +* [prepare](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#prepare) +* [prepareTransactions](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md#preparetransactions) + +## Constructors + +### constructor + ++ **new EnablePercentageTransferManager**\(`args`: [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_EnablePercentageTransferManager_](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [EnablePercentageTransferManagerProcedureArgs](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_EnablePercentageTransferManager_](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) + +## Properties + +### `Protected` args + +• **args**: [_EnablePercentageTransferManagerProcedureArgs_](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.EnablePercentageTransferManager + +_Overrides void_ + +_Defined in_ [_src/procedures/EnablePercentageTransferManager.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L17) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/EnablePercentageTransferManager.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/EnablePercentageTransferManager.ts#L24) + +Enable Percentage Ownership restrictions and set the max ownership percentage and whether primary issuance is exempted from said restrictions + +Note: Primary issuance exemption is disallowed by default unless otherwise specified + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_enablepercentagetransfermanager_.md b/docs/api/external-modules/_procedures_enablepercentagetransfermanager_.md similarity index 70% rename from docs/api/modules/_procedures_enablepercentagetransfermanager_.md rename to docs/api/external-modules/_procedures_enablepercentagetransfermanager_.md index 3a92bc0..f83d4db 100644 --- a/docs/api/modules/_procedures_enablepercentagetransfermanager_.md +++ b/docs/api/external-modules/_procedures_enablepercentagetransfermanager_.md @@ -1,7 +1,8 @@ -# External module: "procedures/EnablePercentageTransferManager" +# procedures/EnablePercentageTransferManager ## Index ### Classes * [EnablePercentageTransferManager](../classes/_procedures_enablepercentagetransfermanager_.enablepercentagetransfermanager.md) + diff --git a/docs/api/external-modules/_procedures_finalizesto_.finalizesto.md b/docs/api/external-modules/_procedures_finalizesto_.finalizesto.md new file mode 100644 index 0000000..daf077d --- /dev/null +++ b/docs/api/external-modules/_procedures_finalizesto_.finalizesto.md @@ -0,0 +1,200 @@ +# FinalizeSto + +Procedure that finalizes an STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md)› + + ↳ **FinalizeSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_finalizesto_.finalizesto.md#constructor) + +### Properties + +* [args](../classes/_procedures_finalizesto_.finalizesto.md#protected-args) +* [context](../classes/_procedures_finalizesto_.finalizesto.md#protected-context) +* [type](../classes/_procedures_finalizesto_.finalizesto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_finalizesto_.finalizesto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_finalizesto_.finalizesto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_finalizesto_.finalizesto.md#addtransaction) +* [prepare](../classes/_procedures_finalizesto_.finalizesto.md#prepare) +* [prepareTransactions](../classes/_procedures_finalizesto_.finalizesto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new FinalizeSto**\(`args`: [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_FinalizeSto_](../classes/_procedures_finalizesto_.finalizesto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [FinalizeStoProcedureArgs](../interfaces/_types_index_.finalizestoprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_FinalizeSto_](../classes/_procedures_finalizesto_.finalizesto.md) + +## Properties + +### `Protected` args + +• **args**: [_FinalizeStoProcedureArgs_](../interfaces/_types_index_.finalizestoprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.FinalizeSto + +_Overrides void_ + +_Defined in_ [_src/procedures/FinalizeSto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L60) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/FinalizeSto.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FinalizeSto.ts#L95) + +Finalize the STO + +Note this procedure will fail if: + +* The specified STO address is invalid +* The STO has not been launched or the module has been archived +* Attempting to finalize a Simple STO with version 3.0.0 or less +* The specified STO type is invalid +* The STO has already been finalized +* The STO's treasury wallet does not clear all transfer restrictions + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_finalizesto_.md b/docs/api/external-modules/_procedures_finalizesto_.md similarity index 67% rename from docs/api/modules/_procedures_finalizesto_.md rename to docs/api/external-modules/_procedures_finalizesto_.md index 260ca74..d95d00d 100644 --- a/docs/api/modules/_procedures_finalizesto_.md +++ b/docs/api/external-modules/_procedures_finalizesto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/FinalizeSto" +# procedures/FinalizeSto ## Index ### Classes * [FinalizeSto](../classes/_procedures_finalizesto_.finalizesto.md) + diff --git a/docs/api/external-modules/_procedures_freezeissuance_.freezeissuance.md b/docs/api/external-modules/_procedures_freezeissuance_.freezeissuance.md new file mode 100644 index 0000000..956da80 --- /dev/null +++ b/docs/api/external-modules/_procedures_freezeissuance_.freezeissuance.md @@ -0,0 +1,197 @@ +# FreezeIssuance + +Procedure that permanently freezes issuance of a Security Token. This requires the Security Token's owner to send signed data in acknowledgement + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md)› + + ↳ **FreezeIssuance** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_freezeissuance_.freezeissuance.md#constructor) + +### Properties + +* [args](../classes/_procedures_freezeissuance_.freezeissuance.md#protected-args) +* [context](../classes/_procedures_freezeissuance_.freezeissuance.md#protected-context) +* [type](../classes/_procedures_freezeissuance_.freezeissuance.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_freezeissuance_.freezeissuance.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_freezeissuance_.freezeissuance.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_freezeissuance_.freezeissuance.md#addtransaction) +* [prepare](../classes/_procedures_freezeissuance_.freezeissuance.md#prepare) +* [prepareTransactions](../classes/_procedures_freezeissuance_.freezeissuance.md#preparetransactions) + +## Constructors + +### constructor + ++ **new FreezeIssuance**\(`args`: [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_FreezeIssuance_](../classes/_procedures_freezeissuance_.freezeissuance.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [FreezeIssuanceProcedureArgs](../interfaces/_types_index_.freezeissuanceprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_FreezeIssuance_](../classes/_procedures_freezeissuance_.freezeissuance.md) + +## Properties + +### `Protected` args + +• **args**: [_FreezeIssuanceProcedureArgs_](../interfaces/_types_index_.freezeissuanceprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.FreezeIssuance + +_Overrides void_ + +_Defined in_ [_src/procedures/FreezeIssuance.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L14) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/FreezeIssuance.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/FreezeIssuance.ts#L24) + +* If no signature acknowledgement data \(optional\) is appended to the procedure arguments, the procedure itself will request the user's signature or sign the data in place if the client was instanced with a private key +* Freeze the issuance of the Security Token + +Note this procedure will fail if: + +* The current user is not the owner of the Security Token +* Issuance has already been frozen + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_freezeissuance_.md b/docs/api/external-modules/_procedures_freezeissuance_.md similarity index 68% rename from docs/api/modules/_procedures_freezeissuance_.md rename to docs/api/external-modules/_procedures_freezeissuance_.md index 1571159..524c722 100644 --- a/docs/api/modules/_procedures_freezeissuance_.md +++ b/docs/api/external-modules/_procedures_freezeissuance_.md @@ -1,7 +1,8 @@ -# External module: "procedures/FreezeIssuance" +# procedures/FreezeIssuance ## Index ### Classes * [FreezeIssuance](../classes/_procedures_freezeissuance_.freezeissuance.md) + diff --git a/docs/api/external-modules/_procedures_index_.md b/docs/api/external-modules/_procedures_index_.md new file mode 100644 index 0000000..113d927 --- /dev/null +++ b/docs/api/external-modules/_procedures_index_.md @@ -0,0 +1,2 @@ +# procedures/index + diff --git a/docs/api/external-modules/_procedures_investinsimplesto_.investinsimplesto.md b/docs/api/external-modules/_procedures_investinsimplesto_.investinsimplesto.md new file mode 100644 index 0000000..6286204 --- /dev/null +++ b/docs/api/external-modules/_procedures_investinsimplesto_.investinsimplesto.md @@ -0,0 +1,202 @@ +# InvestInSimpleSto + +Procedure that invests in a Simple STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md)› + + ↳ **InvestInSimpleSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_investinsimplesto_.investinsimplesto.md#constructor) + +### Properties + +* [args](../classes/_procedures_investinsimplesto_.investinsimplesto.md#protected-args) +* [context](../classes/_procedures_investinsimplesto_.investinsimplesto.md#protected-context) +* [type](../classes/_procedures_investinsimplesto_.investinsimplesto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_investinsimplesto_.investinsimplesto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_investinsimplesto_.investinsimplesto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_investinsimplesto_.investinsimplesto.md#addtransaction) +* [prepare](../classes/_procedures_investinsimplesto_.investinsimplesto.md#prepare) +* [prepareTransactions](../classes/_procedures_investinsimplesto_.investinsimplesto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new InvestInSimpleSto**\(`args`: [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_InvestInSimpleSto_](../classes/_procedures_investinsimplesto_.investinsimplesto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [InvestInSimpleStoProcedureArgs](../interfaces/_types_index_.investinsimplestoprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_InvestInSimpleSto_](../classes/_procedures_investinsimplesto_.investinsimplesto.md) + +## Properties + +### `Protected` args + +• **args**: [_InvestInSimpleStoProcedureArgs_](../interfaces/_types_index_.investinsimplestoprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.InvestInSimpleSto + +_Overrides void_ + +_Defined in_ [_src/procedures/InvestInSimpleSto.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L41) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/InvestInSimpleSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInSimpleSto.ts#L56) + +Buy Security Tokens from the STO + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The STO address is invalid +* The STO is either archived or hasn't been launched +* The STO hasn't started yet +* The STO is paused +* The STO has already been finalized +* Attempting to invest on behalf of another address when beneficial investments aren't allowed for the STO +* The STO doesn't support investments in the selected currency + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_investinsimplesto_.md b/docs/api/external-modules/_procedures_investinsimplesto_.md similarity index 68% rename from docs/api/modules/_procedures_investinsimplesto_.md rename to docs/api/external-modules/_procedures_investinsimplesto_.md index e2c896f..2c6da83 100644 --- a/docs/api/modules/_procedures_investinsimplesto_.md +++ b/docs/api/external-modules/_procedures_investinsimplesto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/InvestInSimpleSto" +# procedures/InvestInSimpleSto ## Index ### Classes * [InvestInSimpleSto](../classes/_procedures_investinsimplesto_.investinsimplesto.md) + diff --git a/docs/api/external-modules/_procedures_investintieredsto_.investintieredsto.md b/docs/api/external-modules/_procedures_investintieredsto_.investintieredsto.md new file mode 100644 index 0000000..3a7506f --- /dev/null +++ b/docs/api/external-modules/_procedures_investintieredsto_.investintieredsto.md @@ -0,0 +1,201 @@ +# InvestInTieredSto + +Procedure that invests in a Tiered STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[InvestInTieredStoProcedureArgs](_types_index_.md#investintieredstoprocedureargs)› + + ↳ **InvestInTieredSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_investintieredsto_.investintieredsto.md#constructor) + +### Properties + +* [args](../classes/_procedures_investintieredsto_.investintieredsto.md#protected-args) +* [context](../classes/_procedures_investintieredsto_.investintieredsto.md#protected-context) +* [type](../classes/_procedures_investintieredsto_.investintieredsto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_investintieredsto_.investintieredsto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_investintieredsto_.investintieredsto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_investintieredsto_.investintieredsto.md#addtransaction) +* [prepare](../classes/_procedures_investintieredsto_.investintieredsto.md#prepare) +* [prepareTransactions](../classes/_procedures_investintieredsto_.investintieredsto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new InvestInTieredSto**\(`args`: [InvestInTieredStoProcedureArgs](_types_index_.md#investintieredstoprocedureargs), `context`: [Context](../classes/_context_.context.md)\): [_InvestInTieredSto_](../classes/_procedures_investintieredsto_.investintieredsto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [InvestInTieredStoProcedureArgs](_types_index_.md#investintieredstoprocedureargs) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_InvestInTieredSto_](../classes/_procedures_investintieredsto_.investintieredsto.md) + +## Properties + +### `Protected` args + +• **args**: [_InvestInTieredStoProcedureArgs_](_types_index_.md#investintieredstoprocedureargs) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.InvestInTieredSto + +_Overrides void_ + +_Defined in_ [_src/procedures/InvestInTieredSto.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L42) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/InvestInTieredSto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/InvestInTieredSto.ts#L56) + +Invest the specified amount in the STO + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The STO address is invalid +* The STO is either archived or hasn't been launched +* The STO hasn't started yet +* The STO is paused +* Trying to invest on behalf of someone else if the STO doesn't allow beneficial investments +* The STO doesn't support investments in the selected currency + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_investintieredsto_.md b/docs/api/external-modules/_procedures_investintieredsto_.md similarity index 68% rename from docs/api/modules/_procedures_investintieredsto_.md rename to docs/api/external-modules/_procedures_investintieredsto_.md index b911c92..4f73105 100644 --- a/docs/api/modules/_procedures_investintieredsto_.md +++ b/docs/api/external-modules/_procedures_investintieredsto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/InvestInTieredSto" +# procedures/InvestInTieredSto ## Index ### Classes * [InvestInTieredSto](../classes/_procedures_investintieredsto_.investintieredsto.md) + diff --git a/docs/api/external-modules/_procedures_issuetokens_.issuetokens.md b/docs/api/external-modules/_procedures_issuetokens_.issuetokens.md new file mode 100644 index 0000000..fb4ea2c --- /dev/null +++ b/docs/api/external-modules/_procedures_issuetokens_.issuetokens.md @@ -0,0 +1,192 @@ +# IssueTokens + +Procedure that issues tokens to the specified addresses. KYC data for those addresses must already exist or otherwise be provided in this procedure + +## Hierarchy + +* Procedure‹[IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), [Tokenholder](../classes/_entities_tokenholder_.tokenholder.md)\[\]› + + ↳ **IssueTokens** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_issuetokens_.issuetokens.md#constructor) + +### Properties + +* [args](../classes/_procedures_issuetokens_.issuetokens.md#protected-args) +* [context](../classes/_procedures_issuetokens_.issuetokens.md#protected-context) +* [type](../classes/_procedures_issuetokens_.issuetokens.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_issuetokens_.issuetokens.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_issuetokens_.issuetokens.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_issuetokens_.issuetokens.md#addtransaction) +* [prepare](../classes/_procedures_issuetokens_.issuetokens.md#prepare) +* [prepareTransactions](../classes/_procedures_issuetokens_.issuetokens.md#preparetransactions) + +## Constructors + +### constructor + ++ **new IssueTokens**\(`args`: [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_IssueTokens_](../classes/_procedures_issuetokens_.issuetokens.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [IssueTokensProcedureArgs](../interfaces/_types_index_.issuetokensprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_IssueTokens_](../classes/_procedures_issuetokens_.issuetokens.md) + +## Properties + +### `Protected` args + +• **args**: [_IssueTokensProcedureArgs_](../interfaces/_types_index_.issuetokensprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.IssueTokens + +_Overrides void_ + +_Defined in_ [_src/procedures/IssueTokens.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L36) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/IssueTokens.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/IssueTokens.ts#L47) + +Issue the specified amounts to the corresponding addresses If KYC data is provided, transfer restrictions will not be checked before submitting the issuing transaction This means that if one of the wallets on the list doesn't clear transfer restrictions, the transaction will revert + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* At least one wallet address doesn't clear transfer restrictions. This check is bypassed if new KYC data is provided + +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_issuetokens_.md b/docs/api/external-modules/_procedures_issuetokens_.md similarity index 67% rename from docs/api/modules/_procedures_issuetokens_.md rename to docs/api/external-modules/_procedures_issuetokens_.md index 56be530..841570b 100644 --- a/docs/api/modules/_procedures_issuetokens_.md +++ b/docs/api/external-modules/_procedures_issuetokens_.md @@ -1,7 +1,8 @@ -# External module: "procedures/IssueTokens" +# procedures/IssueTokens ## Index ### Classes * [IssueTokens](../classes/_procedures_issuetokens_.issuetokens.md) + diff --git a/docs/api/external-modules/_procedures_launchsimplesto_.launchsimplesto.md b/docs/api/external-modules/_procedures_launchsimplesto_.launchsimplesto.md new file mode 100644 index 0000000..8847a1b --- /dev/null +++ b/docs/api/external-modules/_procedures_launchsimplesto_.launchsimplesto.md @@ -0,0 +1,195 @@ +# LaunchSimpleSto + +Procedure that launches a Simple STO + +## Hierarchy + +* Procedure‹[LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), [SimpleSto](../classes/_entities_simplesto_.simplesto.md)› + + ↳ **LaunchSimpleSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_launchsimplesto_.launchsimplesto.md#constructor) + +### Properties + +* [args](../classes/_procedures_launchsimplesto_.launchsimplesto.md#protected-args) +* [context](../classes/_procedures_launchsimplesto_.launchsimplesto.md#protected-context) +* [type](../classes/_procedures_launchsimplesto_.launchsimplesto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_launchsimplesto_.launchsimplesto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_launchsimplesto_.launchsimplesto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_launchsimplesto_.launchsimplesto.md#addtransaction) +* [prepare](../classes/_procedures_launchsimplesto_.launchsimplesto.md#prepare) +* [prepareTransactions](../classes/_procedures_launchsimplesto_.launchsimplesto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new LaunchSimpleSto**\(`args`: [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_LaunchSimpleSto_](../classes/_procedures_launchsimplesto_.launchsimplesto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchSimpleStoProcedureArgs](../interfaces/_types_index_.launchsimplestoprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_LaunchSimpleSto_](../classes/_procedures_launchsimplesto_.launchsimplesto.md) + +## Properties + +### `Protected` args + +• **args**: [_LaunchSimpleStoProcedureArgs_](../interfaces/_types_index_.launchsimplestoprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.LaunchSimpleSto + +_Overrides void_ + +_Defined in_ [_src/procedures/LaunchSimpleSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L27) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/LaunchSimpleSto.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchSimpleSto.ts#L39) + +* Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee +* Launch the Simple STO +* Allow pre-issuing \(if applicable\) +* Return the newly created STO + +Notes: + +* Pre-issuing defaults to false +* Pre-issuing can only be enabled on a version 3.1 \(or greater\) Simple STO. Attempting to do so in versions 3.0 or lower will cause the procedure to fail + +**Returns:** _Promise‹PostTransactionResolver‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_launchsimplesto_.md b/docs/api/external-modules/_procedures_launchsimplesto_.md similarity index 68% rename from docs/api/modules/_procedures_launchsimplesto_.md rename to docs/api/external-modules/_procedures_launchsimplesto_.md index 209708d..e4208ed 100644 --- a/docs/api/modules/_procedures_launchsimplesto_.md +++ b/docs/api/external-modules/_procedures_launchsimplesto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/LaunchSimpleSto" +# procedures/LaunchSimpleSto ## Index ### Classes * [LaunchSimpleSto](../classes/_procedures_launchsimplesto_.launchsimplesto.md) + diff --git a/docs/api/external-modules/_procedures_launchtieredsto_.launchtieredsto.md b/docs/api/external-modules/_procedures_launchtieredsto_.launchtieredsto.md new file mode 100644 index 0000000..1b3368f --- /dev/null +++ b/docs/api/external-modules/_procedures_launchtieredsto_.launchtieredsto.md @@ -0,0 +1,196 @@ +# LaunchTieredSto + +Procedure that launches a Tiered STO + +## Hierarchy + +* Procedure‹[LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)› + + ↳ **LaunchTieredSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_launchtieredsto_.launchtieredsto.md#constructor) + +### Properties + +* [args](../classes/_procedures_launchtieredsto_.launchtieredsto.md#protected-args) +* [context](../classes/_procedures_launchtieredsto_.launchtieredsto.md#protected-context) +* [type](../classes/_procedures_launchtieredsto_.launchtieredsto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_launchtieredsto_.launchtieredsto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_launchtieredsto_.launchtieredsto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_launchtieredsto_.launchtieredsto.md#addtransaction) +* [prepare](../classes/_procedures_launchtieredsto_.launchtieredsto.md#prepare) +* [prepareTransactions](../classes/_procedures_launchtieredsto_.launchtieredsto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new LaunchTieredSto**\(`args`: [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_LaunchTieredSto_](../classes/_procedures_launchtieredsto_.launchtieredsto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoProcedureArgs](../interfaces/_types_index_.launchtieredstoprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_LaunchTieredSto_](../classes/_procedures_launchtieredsto_.launchtieredsto.md) + +## Properties + +### `Protected` args + +• **args**: [_LaunchTieredStoProcedureArgs_](../interfaces/_types_index_.launchtieredstoprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.LaunchTieredSto + +_Overrides void_ + +_Defined in_ [_src/procedures/LaunchTieredSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L27) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/LaunchTieredSto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/LaunchTieredSto.ts#L40) + +* Transfer the necessary amount of POLY to the Security Token to cover the STO's setup fee +* Launch the Tiered STO +* Allow pre-issuing \(if applicable, defaults to false\) +* Return the newly created STO + +Note that this procedure will fail if: + +* The supplied custom currency oracle addresses corresponding to the selected fund raise currencies are invalid +* Raising in Stable Coin and not providing stable coin addresses +* Attempting to allow pre-issuing on a version 3.0 STO + +**Returns:** _Promise‹PostTransactionResolver‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_launchtieredsto_.md b/docs/api/external-modules/_procedures_launchtieredsto_.md similarity index 68% rename from docs/api/modules/_procedures_launchtieredsto_.md rename to docs/api/external-modules/_procedures_launchtieredsto_.md index b5f7523..1cc2c1f 100644 --- a/docs/api/modules/_procedures_launchtieredsto_.md +++ b/docs/api/external-modules/_procedures_launchtieredsto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/LaunchTieredSto" +# procedures/LaunchTieredSto ## Index ### Classes * [LaunchTieredSto](../classes/_procedures_launchtieredsto_.launchtieredsto.md) + diff --git a/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.md b/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.md new file mode 100644 index 0000000..3901c1e --- /dev/null +++ b/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.md @@ -0,0 +1,20 @@ +# procedures/ModifyDividendsDefaultExclusionList + +## Index + +### Classes + +* [ModifyDividendsDefaultExclusionList](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) + +### Variables + +* [CHUNK\_SIZE](_procedures_modifydividendsdefaultexclusionlist_.md#const-chunk_size) + +## Variables + +### `Const` CHUNK\_SIZE + +• **CHUNK\_SIZE**: _200_ = 200 + +_Defined in_ [_src/procedures/ModifyDividendsDefaultExclusionList.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L13) + diff --git a/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md b/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md new file mode 100644 index 0000000..b1fa241 --- /dev/null +++ b/docs/api/external-modules/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md @@ -0,0 +1,193 @@ +# ModifyDividendsDefaultExclusionList + +Procedure that modifies the list of tokenholders which are excluded from receiving dividend payments + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)› + + ↳ **ModifyDividendsDefaultExclusionList** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#protected-args) +* [context](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#protected-context) +* [type](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#addtransaction) +* [prepare](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#prepare) +* [prepareTransactions](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyDividendsDefaultExclusionList**\(`args`: [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyDividendsDefaultExclusionList_](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyDividendsDefaultExclusionListProcedureArgs](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyDividendsDefaultExclusionList_](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyDividendsDefaultExclusionListProcedureArgs_](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyDividendsDefaultExclusionList + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyDividendsDefaultExclusionList.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L21) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyDividendsDefaultExclusionList.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L28) + +Set the default exclusion list for dividend distributions + +Note that this procedure will fail if the Dividends Feature is not enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_modifymaxholdercount_.md b/docs/api/external-modules/_procedures_modifymaxholdercount_.md similarity index 69% rename from docs/api/modules/_procedures_modifymaxholdercount_.md rename to docs/api/external-modules/_procedures_modifymaxholdercount_.md index ef85028..d224fc9 100644 --- a/docs/api/modules/_procedures_modifymaxholdercount_.md +++ b/docs/api/external-modules/_procedures_modifymaxholdercount_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ModifyMaxHolderCount" +# procedures/ModifyMaxHolderCount ## Index ### Classes * [ModifyMaxHolderCount](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md) + diff --git a/docs/api/external-modules/_procedures_modifymaxholdercount_.modifymaxholdercount.md b/docs/api/external-modules/_procedures_modifymaxholdercount_.modifymaxholdercount.md new file mode 100644 index 0000000..4d73c55 --- /dev/null +++ b/docs/api/external-modules/_procedures_modifymaxholdercount_.modifymaxholdercount.md @@ -0,0 +1,193 @@ +# ModifyMaxHolderCount + +Procedure that modifies the maximum amount of holders for the security token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md)› + + ↳ **ModifyMaxHolderCount** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#protected-args) +* [context](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#protected-context) +* [type](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#addtransaction) +* [prepare](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#prepare) +* [prepareTransactions](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyMaxHolderCount**\(`args`: [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyMaxHolderCount_](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyMaxHolderCountProcedureArgs](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyMaxHolderCount_](../classes/_procedures_modifymaxholdercount_.modifymaxholdercount.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyMaxHolderCountProcedureArgs_](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyMaxHolderCount + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyMaxHolderCount.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyMaxHolderCount.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderCount.ts#L23) + +Sets the maximum amount of holders for the security token + +Note that this procedure will fail if the security token symbol doesn't exist Note that this procedure will fail if the security token has disabled the TokenholderCountRestrictions feature + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_modifymaxholderpercentage_.md b/docs/api/external-modules/_procedures_modifymaxholderpercentage_.md similarity index 69% rename from docs/api/modules/_procedures_modifymaxholderpercentage_.md rename to docs/api/external-modules/_procedures_modifymaxholderpercentage_.md index 78a76fd..5e705f0 100644 --- a/docs/api/modules/_procedures_modifymaxholderpercentage_.md +++ b/docs/api/external-modules/_procedures_modifymaxholderpercentage_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ModifyMaxHolderPercentage" +# procedures/ModifyMaxHolderPercentage ## Index ### Classes * [ModifyMaxHolderPercentage](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) + diff --git a/docs/api/external-modules/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md b/docs/api/external-modules/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md new file mode 100644 index 0000000..d0f024a --- /dev/null +++ b/docs/api/external-modules/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md @@ -0,0 +1,196 @@ +# ModifyMaxHolderPercentage + +Procedure that modifies the maximum percentage that an individual token holder can hold + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md)› + + ↳ **ModifyMaxHolderPercentage** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#protected-args) +* [context](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#protected-context) +* [type](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#addtransaction) +* [prepare](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#prepare) +* [prepareTransactions](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyMaxHolderPercentage**\(`args`: [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyMaxHolderPercentage_](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyMaxHolderPercentageProcedureArgs](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyMaxHolderPercentage_](../classes/_procedures_modifymaxholderpercentage_.modifymaxholderpercentage.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyMaxHolderPercentageProcedureArgs_](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyMaxHolderPercentage + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyMaxHolderPercentage.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyMaxHolderPercentage.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyMaxHolderPercentage.ts#L24) + +Modify the number of security tokens \(expressed in percentage\) that an investor can hold as maximum + +Note that this procedure will fail if: + +* The security token symbol doesn't exist +* The security token has disabled the PercentageOwnershipRestrictions feature + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_modifypercentageexemptions_.md b/docs/api/external-modules/_procedures_modifypercentageexemptions_.md similarity index 69% rename from docs/api/modules/_procedures_modifypercentageexemptions_.md rename to docs/api/external-modules/_procedures_modifypercentageexemptions_.md index b01376d..4e4b551 100644 --- a/docs/api/modules/_procedures_modifypercentageexemptions_.md +++ b/docs/api/external-modules/_procedures_modifypercentageexemptions_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ModifyPercentageExemptions" +# procedures/ModifyPercentageExemptions ## Index ### Classes * [ModifyPercentageExemptions](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) + diff --git a/docs/api/external-modules/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md b/docs/api/external-modules/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md new file mode 100644 index 0000000..6c54695 --- /dev/null +++ b/docs/api/external-modules/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md @@ -0,0 +1,198 @@ +# ModifyPercentageExemptions + +Procedure responsible for modifying any exemption related to percentage restrictions + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md)› + + ↳ **ModifyPercentageExemptions** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#protected-args) +* [context](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#protected-context) +* [type](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#addtransaction) +* [prepare](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#prepare) +* [prepareTransactions](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyPercentageExemptions**\(`args`: [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyPercentageExemptions_](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyPercentageExemptionsProcedureArgs](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyPercentageExemptions_](../classes/_procedures_modifypercentageexemptions_.modifypercentageexemptions.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyPercentageExemptionsProcedureArgs_](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyPercentageExemptions + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyPercentageExemptions.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L16) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyPercentageExemptions.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyPercentageExemptions.ts#L27) + +* Update the list of addresses that are exempt from percentage restrictions \(if supplied\) +* Modify whether primary issuance is exempt from percentage restrictions \(if supplied\) + +Note that this procedure will fail if: + +* The data supplied to it is no different to the data in the contract +* The Security Token doesn't exist +* The Percentage Ownership Restrictions feature isn't enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_modifytieredstodata_.md b/docs/api/external-modules/_procedures_modifytieredstodata_.md similarity index 69% rename from docs/api/modules/_procedures_modifytieredstodata_.md rename to docs/api/external-modules/_procedures_modifytieredstodata_.md index 68e5224..5e48627 100644 --- a/docs/api/modules/_procedures_modifytieredstodata_.md +++ b/docs/api/external-modules/_procedures_modifytieredstodata_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ModifyTieredStoData" +# procedures/ModifyTieredStoData ## Index ### Classes * [ModifyTieredStoData](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md) + diff --git a/docs/api/external-modules/_procedures_modifytieredstodata_.modifytieredstodata.md b/docs/api/external-modules/_procedures_modifytieredstodata_.modifytieredstodata.md new file mode 100644 index 0000000..6441c4a --- /dev/null +++ b/docs/api/external-modules/_procedures_modifytieredstodata_.modifytieredstodata.md @@ -0,0 +1,205 @@ +# ModifyTieredStoData + +Procedure that modifies the configuration parameters of a Tiered STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md)› + + ↳ **ModifyTieredStoData** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#protected-args) +* [context](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#protected-context) +* [type](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#addtransaction) +* [prepare](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#prepare) +* [prepareTransactions](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyTieredStoData**\(`args`: [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyTieredStoData_](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyTieredStoDataProcedureArgs](../interfaces/_types_index_.modifytieredstodataprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyTieredStoData_](../classes/_procedures_modifytieredstodata_.modifytieredstodata.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyTieredStoDataProcedureArgs_](../interfaces/_types_index_.modifytieredstodataprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyTieredStoData + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyTieredStoData.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L43) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyTieredStoData.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTieredStoData.ts#L61) + +* Modify the start and end date of the STO +* Modify the fundraise types of the STO +* Modify the custom currency symbol and the oracles used to convert POLY and ETH to said currency +* Modify the STO's tiers \(rates, tokens per tier and discounts when buying with POLY\) +* Modify investment limits \(min investment, max invested for non-accredited investors\) +* Modify treasury wallet, wallet for unsold tokens and stable coin addresses + +Only transactions that will effectively present changes will be submitted + +Note that this procedure will fail if: + +* The STO has not been enabled or has been archived +* The STO has already started +* Attempting to use a custom currency on an STO with version 3.0.0 or lower +* The supplied parameters don't represent any changes in the STO + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_procedures_modifytokenholderdata_.md b/docs/api/external-modules/_procedures_modifytokenholderdata_.md new file mode 100644 index 0000000..9971bac --- /dev/null +++ b/docs/api/external-modules/_procedures_modifytokenholderdata_.md @@ -0,0 +1,20 @@ +# procedures/ModifyTokenholderData + +## Index + +### Classes + +* [ModifyTokenholderData](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) + +### Variables + +* [dateToBigNumber](_procedures_modifytokenholderdata_.md#datetobignumber) + +## Variables + +### dateToBigNumber + +• **dateToBigNumber**: _dateToBigNumber_ + +_Defined in_ [_src/procedures/ModifyTokenholderData.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L18) + diff --git a/docs/api/external-modules/_procedures_modifytokenholderdata_.modifytokenholderdata.md b/docs/api/external-modules/_procedures_modifytokenholderdata_.modifytokenholderdata.md new file mode 100644 index 0000000..80d569e --- /dev/null +++ b/docs/api/external-modules/_procedures_modifytokenholderdata_.modifytokenholderdata.md @@ -0,0 +1,197 @@ +# ModifyTokenholderData + +Procedure that modifies data for a list of \(potential\) tokenholders. The data that can be modified is: + +* KYC data \(sale/buy lockup dates and KYC expiry\) +* Whether the tokenholder is accredited +* Whether the tokenholder can buy from an STO + +## Hierarchy + +* Procedure‹[ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), [Tokenholder](../classes/_entities_tokenholder_.tokenholder.md)\[\]› + + ↳ **ModifyTokenholderData** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#constructor) + +### Properties + +* [args](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#protected-args) +* [context](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#protected-context) +* [type](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#addtransaction) +* [prepare](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#prepare) +* [prepareTransactions](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ModifyTokenholderData**\(`args`: [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ModifyTokenholderData_](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ModifyTokenholderDataProcedureArgs](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ModifyTokenholderData_](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) + +## Properties + +### `Protected` args + +• **args**: [_ModifyTokenholderDataProcedureArgs_](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ModifyTokenholderData + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyTokenholderData.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L31) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ModifyTokenholderData.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L41) + +Update tokenholder data for a subset of addresses + +Note that this procedure will fail if: + +* You're trying to set the dates to 0 \(there is a special "RevokeKyc" procedure for that\) +* The Security Token doesn't exist +* There is no difference between the "new" data and the data already present in the contract + +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_procedure_.md b/docs/api/external-modules/_procedures_procedure_.md similarity index 70% rename from docs/api/modules/_procedures_procedure_.md rename to docs/api/external-modules/_procedures_procedure_.md index 812e6bb..a38eeb4 100644 --- a/docs/api/modules/_procedures_procedure_.md +++ b/docs/api/external-modules/_procedures_procedure_.md @@ -1,7 +1,8 @@ -# External module: "procedures/Procedure" +# procedures/Procedure ## Index ### Interfaces * [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md) + diff --git a/docs/api/external-modules/_procedures_procedure_.procedureclass.md b/docs/api/external-modules/_procedures_procedure_.procedureclass.md new file mode 100644 index 0000000..cc8ce60 --- /dev/null +++ b/docs/api/external-modules/_procedures_procedure_.procedureclass.md @@ -0,0 +1,35 @@ +# ProcedureClass + +## Type parameters + +▪ **Args** + +▪ **ReturnType**: _any_ + +## Hierarchy + +* **ProcedureClass** + +## Index + +### Constructors + +* [constructor](../interfaces/_procedures_procedure_.procedureclass.md#constructor) + +## Constructors + +### constructor + ++ **new ProcedureClass**\(`args`: Args, `context`: [Context](../classes/_context_.context.md)\): _Procedure‹Args, ReturnType›_ + +_Defined in_ [_src/procedures/Procedure.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L21) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | Args | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** _Procedure‹Args, ReturnType›_ + diff --git a/docs/api/modules/_procedures_pulldividendpayment_.md b/docs/api/external-modules/_procedures_pulldividendpayment_.md similarity index 69% rename from docs/api/modules/_procedures_pulldividendpayment_.md rename to docs/api/external-modules/_procedures_pulldividendpayment_.md index fbf44f3..bf856a9 100644 --- a/docs/api/modules/_procedures_pulldividendpayment_.md +++ b/docs/api/external-modules/_procedures_pulldividendpayment_.md @@ -1,7 +1,8 @@ -# External module: "procedures/PullDividendPayment" +# procedures/PullDividendPayment ## Index ### Classes * [PullDividendPayment](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md) + diff --git a/docs/api/external-modules/_procedures_pulldividendpayment_.pulldividendpayment.md b/docs/api/external-modules/_procedures_pulldividendpayment_.pulldividendpayment.md new file mode 100644 index 0000000..2d72917 --- /dev/null +++ b/docs/api/external-modules/_procedures_pulldividendpayment_.pulldividendpayment.md @@ -0,0 +1,198 @@ +# PullDividendPayment + +Procedure that allows a tokenholder to pull their dividend payments from a Dividend Distribution + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md)› + + ↳ **PullDividendPayment** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#constructor) + +### Properties + +* [args](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#protected-args) +* [context](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#protected-context) +* [type](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#addtransaction) +* [prepare](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#prepare) +* [prepareTransactions](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md#preparetransactions) + +## Constructors + +### constructor + ++ **new PullDividendPayment**\(`args`: [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_PullDividendPayment_](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [PullDividendPaymentProcedureArgs](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_PullDividendPayment_](../classes/_procedures_pulldividendpayment_.pulldividendpayment.md) + +## Properties + +### `Protected` args + +• **args**: [_PullDividendPaymentProcedureArgs_](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.PullDividendPayment + +_Overrides void_ + +_Defined in_ [_src/procedures/PullDividendPayment.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L33) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/PullDividendPayment.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PullDividendPayment.ts#L44) + +Pull dividend payments from the Dividend Distribution + +Note this procedure will fail if: + +* The Dividends Feature is not enabled +* The current wallet address is not a tokenholder +* The current wallet address has already received payment for this Dividend Distribution +* The current wallet address is on the exclusion list + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_procedures_pushdividendpayment_.md b/docs/api/external-modules/_procedures_pushdividendpayment_.md new file mode 100644 index 0000000..297c24a --- /dev/null +++ b/docs/api/external-modules/_procedures_pushdividendpayment_.md @@ -0,0 +1,20 @@ +# procedures/PushDividendPayment + +## Index + +### Classes + +* [PushDividendPayment](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md) + +### Variables + +* [CHUNK\_SIZE](_procedures_pushdividendpayment_.md#const-chunk_size) + +## Variables + +### `Const` CHUNK\_SIZE + +• **CHUNK\_SIZE**: _100_ = 100 + +_Defined in_ [_src/procedures/PushDividendPayment.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L15) + diff --git a/docs/api/external-modules/_procedures_pushdividendpayment_.pushdividendpayment.md b/docs/api/external-modules/_procedures_pushdividendpayment_.pushdividendpayment.md new file mode 100644 index 0000000..34bc8ce --- /dev/null +++ b/docs/api/external-modules/_procedures_pushdividendpayment_.pushdividendpayment.md @@ -0,0 +1,196 @@ +# PushDividendPayment + +Procedure that forwards a Dividend Distribution's payments to tokenholders + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md)› + + ↳ **PushDividendPayment** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#constructor) + +### Properties + +* [args](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#protected-args) +* [context](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#protected-context) +* [type](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#addtransaction) +* [prepare](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#prepare) +* [prepareTransactions](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md#preparetransactions) + +## Constructors + +### constructor + ++ **new PushDividendPayment**\(`args`: [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_PushDividendPayment_](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [PushDividendPaymentProcedureArgs](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_PushDividendPayment_](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md) + +## Properties + +### `Protected` args + +• **args**: [_PushDividendPaymentProcedureArgs_](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.PushDividendPayment + +_Overrides void_ + +_Defined in_ [_src/procedures/PushDividendPayment.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L37) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/PushDividendPayment.ts:46_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L46) + +Push dividends to provided tokenholder addresses + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_reclaimfunds_.md b/docs/api/external-modules/_procedures_reclaimfunds_.md similarity index 67% rename from docs/api/modules/_procedures_reclaimfunds_.md rename to docs/api/external-modules/_procedures_reclaimfunds_.md index 90ebc5b..0aa74b8 100644 --- a/docs/api/modules/_procedures_reclaimfunds_.md +++ b/docs/api/external-modules/_procedures_reclaimfunds_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ReclaimFunds" +# procedures/ReclaimFunds ## Index ### Classes * [ReclaimFunds](../classes/_procedures_reclaimfunds_.reclaimfunds.md) + diff --git a/docs/api/external-modules/_procedures_reclaimfunds_.reclaimfunds.md b/docs/api/external-modules/_procedures_reclaimfunds_.reclaimfunds.md new file mode 100644 index 0000000..4a65d59 --- /dev/null +++ b/docs/api/external-modules/_procedures_reclaimfunds_.reclaimfunds.md @@ -0,0 +1,196 @@ +# ReclaimFunds + +Procedure that allows the issuer to reclaim dividends after they expire without being claimed by tokenholders + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md)› + + ↳ **ReclaimFunds** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_reclaimfunds_.reclaimfunds.md#constructor) + +### Properties + +* [args](../classes/_procedures_reclaimfunds_.reclaimfunds.md#protected-args) +* [context](../classes/_procedures_reclaimfunds_.reclaimfunds.md#protected-context) +* [type](../classes/_procedures_reclaimfunds_.reclaimfunds.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_reclaimfunds_.reclaimfunds.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_reclaimfunds_.reclaimfunds.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_reclaimfunds_.reclaimfunds.md#addtransaction) +* [prepare](../classes/_procedures_reclaimfunds_.reclaimfunds.md#prepare) +* [prepareTransactions](../classes/_procedures_reclaimfunds_.reclaimfunds.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ReclaimFunds**\(`args`: [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ReclaimFunds_](../classes/_procedures_reclaimfunds_.reclaimfunds.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ReclaimFundsProcedureArgs](../interfaces/_types_index_.reclaimfundsprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ReclaimFunds_](../classes/_procedures_reclaimfunds_.reclaimfunds.md) + +## Properties + +### `Protected` args + +• **args**: [_ReclaimFundsProcedureArgs_](../interfaces/_types_index_.reclaimfundsprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ReclaimFunds + +_Overrides void_ + +_Defined in_ [_src/procedures/ReclaimFunds.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L28) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ReclaimFunds.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReclaimFunds.ts#L37) + +Reclaim funds + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_removedocument_.md b/docs/api/external-modules/_procedures_removedocument_.md similarity index 68% rename from docs/api/modules/_procedures_removedocument_.md rename to docs/api/external-modules/_procedures_removedocument_.md index 344b826..3bd5073 100644 --- a/docs/api/modules/_procedures_removedocument_.md +++ b/docs/api/external-modules/_procedures_removedocument_.md @@ -1,7 +1,8 @@ -# External module: "procedures/RemoveDocument" +# procedures/RemoveDocument ## Index ### Classes * [RemoveDocument](../classes/_procedures_removedocument_.removedocument.md) + diff --git a/docs/api/external-modules/_procedures_removedocument_.removedocument.md b/docs/api/external-modules/_procedures_removedocument_.removedocument.md new file mode 100644 index 0000000..2bec6de --- /dev/null +++ b/docs/api/external-modules/_procedures_removedocument_.removedocument.md @@ -0,0 +1,197 @@ +# RemoveDocument + +Procedure that removes a document from a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md)› + + ↳ **RemoveDocument** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_removedocument_.removedocument.md#constructor) + +### Properties + +* [args](../classes/_procedures_removedocument_.removedocument.md#protected-args) +* [context](../classes/_procedures_removedocument_.removedocument.md#protected-context) +* [type](../classes/_procedures_removedocument_.removedocument.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_removedocument_.removedocument.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_removedocument_.removedocument.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_removedocument_.removedocument.md#addtransaction) +* [prepare](../classes/_procedures_removedocument_.removedocument.md#prepare) +* [prepareTransactions](../classes/_procedures_removedocument_.removedocument.md#preparetransactions) + +## Constructors + +### constructor + ++ **new RemoveDocument**\(`args`: [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_RemoveDocument_](../classes/_procedures_removedocument_.removedocument.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_RemoveDocument_](../classes/_procedures_removedocument_.removedocument.md) + +## Properties + +### `Protected` args + +• **args**: [_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.RemoveDocument + +_Overrides void_ + +_Defined in_ [_src/procedures/RemoveDocument.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/RemoveDocument.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L25) + +Remove a document from the Security Token + +Note that this procedure will fail if: + +* The current wallet is not the Security Token owner +* The name of the document is less than 1 or more than 32 characters long +* The document doesn't exist in the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_procedures_reservesecuritytoken_.md b/docs/api/external-modules/_procedures_reservesecuritytoken_.md new file mode 100644 index 0000000..a15edae --- /dev/null +++ b/docs/api/external-modules/_procedures_reservesecuritytoken_.md @@ -0,0 +1,20 @@ +# procedures/ReserveSecurityToken + +## Index + +### Classes + +* [ReserveSecurityToken](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) + +### Variables + +* [bigNumberToDate](_procedures_reservesecuritytoken_.md#bignumbertodate) + +## Variables + +### bigNumberToDate + +• **bigNumberToDate**: _bigNumberToDate_ + +_Defined in_ [_src/procedures/ReserveSecurityToken.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L19) + diff --git a/docs/api/external-modules/_procedures_reservesecuritytoken_.reservesecuritytoken.md b/docs/api/external-modules/_procedures_reservesecuritytoken_.reservesecuritytoken.md new file mode 100644 index 0000000..f3eebfe --- /dev/null +++ b/docs/api/external-modules/_procedures_reservesecuritytoken_.reservesecuritytoken.md @@ -0,0 +1,191 @@ +# ReserveSecurityToken + +Procedure that reserves a token ticker \(symbol\) to be used later on to launch a Security Token + +_**Note if the Reservation expires and the corresponding Security Token hasn't been launched yet, another issuer can reserve the same ticker**_ + +## Hierarchy + +* Procedure‹[ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), [SecurityTokenReservation](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)› + + ↳ **ReserveSecurityToken** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#constructor) + +### Properties + +* [args](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#protected-args) +* [context](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#protected-context) +* [type](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#addtransaction) +* [prepare](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#prepare) +* [prepareTransactions](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ReserveSecurityToken**\(`args`: [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ReserveSecurityToken_](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ReserveSecurityTokenProcedureArgs](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ReserveSecurityToken_](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) + +## Properties + +### `Protected` args + +• **args**: [_ReserveSecurityTokenProcedureArgs_](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ReserveSecurityToken + +_Overrides void_ + +_Defined in_ [_src/procedures/ReserveSecurityToken.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L30) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_, TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ReserveSecurityToken.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L37) + +Reserve a new ticker + +Note that this procedure will fail if ticker has already been registered + +**Returns:** _Promise‹PostTransactionResolver‹_[_SecurityTokenReservation_](../classes/_entities_securitytokenreservation_.securitytokenreservation.md)_, TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_revokekyc_.md b/docs/api/external-modules/_procedures_revokekyc_.md similarity index 67% rename from docs/api/modules/_procedures_revokekyc_.md rename to docs/api/external-modules/_procedures_revokekyc_.md index ff85ce1..e28da1d 100644 --- a/docs/api/modules/_procedures_revokekyc_.md +++ b/docs/api/external-modules/_procedures_revokekyc_.md @@ -1,7 +1,8 @@ -# External module: "procedures/RevokeKyc" +# procedures/RevokeKyc ## Index ### Classes * [RevokeKyc](../classes/_procedures_revokekyc_.revokekyc.md) + diff --git a/docs/api/external-modules/_procedures_revokekyc_.revokekyc.md b/docs/api/external-modules/_procedures_revokekyc_.revokekyc.md new file mode 100644 index 0000000..bc13f30 --- /dev/null +++ b/docs/api/external-modules/_procedures_revokekyc_.revokekyc.md @@ -0,0 +1,194 @@ +# RevokeKyc + +Procedure that revokes KYC for a list of investors + +## Hierarchy + +* Procedure‹[RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), [Tokenholder](../classes/_entities_tokenholder_.tokenholder.md)\[\]› + + ↳ **RevokeKyc** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_revokekyc_.revokekyc.md#constructor) + +### Properties + +* [args](../classes/_procedures_revokekyc_.revokekyc.md#protected-args) +* [context](../classes/_procedures_revokekyc_.revokekyc.md#protected-context) +* [type](../classes/_procedures_revokekyc_.revokekyc.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_revokekyc_.revokekyc.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_revokekyc_.revokekyc.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_revokekyc_.revokekyc.md#addtransaction) +* [prepare](../classes/_procedures_revokekyc_.revokekyc.md#prepare) +* [prepareTransactions](../classes/_procedures_revokekyc_.revokekyc.md#preparetransactions) + +## Constructors + +### constructor + ++ **new RevokeKyc**\(`args`: [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_RevokeKyc_](../classes/_procedures_revokekyc_.revokekyc.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [RevokeKycProcedureArgs](../interfaces/_types_index_.revokekycprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_RevokeKyc_](../classes/_procedures_revokekyc_.revokekyc.md) + +## Properties + +### `Protected` args + +• **args**: [_RevokeKycProcedureArgs_](../interfaces/_types_index_.revokekycprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.RevokeKyc + +_Overrides void_ + +_Defined in_ [_src/procedures/RevokeKyc.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L12) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + +_Overrides void_ + +_Defined in_ [_src/procedures/RevokeKyc.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RevokeKyc.ts#L23) + +Sets all KYC dates for a tokenholder to epoch. This effectively makes them unable to send or receive Security Tokens + +Note that this procedure will fail if: + +* The tokenholder address array is empty +* The Security Token doesn't exist +* KYC is already revoked for at least one of the addresses in the list +* Tokenholders Feature isn't enabled + +**Returns:** _Promise‹PostTransactionResolver‹_[_Tokenholder_](../classes/_entities_tokenholder_.tokenholder.md)_\[\], TransactionReceiptWithDecodedLogs››_ + diff --git a/docs/api/modules/_procedures_setcontroller_.md b/docs/api/external-modules/_procedures_setcontroller_.md similarity index 68% rename from docs/api/modules/_procedures_setcontroller_.md rename to docs/api/external-modules/_procedures_setcontroller_.md index 82f5eac..088a31c 100644 --- a/docs/api/modules/_procedures_setcontroller_.md +++ b/docs/api/external-modules/_procedures_setcontroller_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SetController" +# procedures/SetController ## Index ### Classes * [SetController](../classes/_procedures_setcontroller_.setcontroller.md) + diff --git a/docs/api/external-modules/_procedures_setcontroller_.setcontroller.md b/docs/api/external-modules/_procedures_setcontroller_.setcontroller.md new file mode 100644 index 0000000..d7de639 --- /dev/null +++ b/docs/api/external-modules/_procedures_setcontroller_.setcontroller.md @@ -0,0 +1,196 @@ +# SetController + +Procedure that sets the Controller of a Security Token. A Security Token's Controller can perform special functions reserved solely for them, such as forced transfers and redeeming \(burning\) tokens + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md)› + + ↳ **SetController** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_setcontroller_.setcontroller.md#constructor) + +### Properties + +* [args](../classes/_procedures_setcontroller_.setcontroller.md#protected-args) +* [context](../classes/_procedures_setcontroller_.setcontroller.md#protected-context) +* [type](../classes/_procedures_setcontroller_.setcontroller.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_setcontroller_.setcontroller.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_setcontroller_.setcontroller.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_setcontroller_.setcontroller.md#addtransaction) +* [prepare](../classes/_procedures_setcontroller_.setcontroller.md#prepare) +* [prepareTransactions](../classes/_procedures_setcontroller_.setcontroller.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SetController**\(`args`: [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SetController_](../classes/_procedures_setcontroller_.setcontroller.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SetControllerProcedureArgs](../interfaces/_types_index_.setcontrollerprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SetController_](../classes/_procedures_setcontroller_.setcontroller.md) + +## Properties + +### `Protected` args + +• **args**: [_SetControllerProcedureArgs_](../interfaces/_types_index_.setcontrollerprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetController + +_Overrides void_ + +_Defined in_ [_src/procedures/SetController.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L11) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SetController.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetController.ts#L20) + +Set the Controller address of the Security Token + +Note this procedure will fail if: + +* The supplied address is invalid +* The current wallet address is not the owner of the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_setdividendswallet_.md b/docs/api/external-modules/_procedures_setdividendswallet_.md similarity index 68% rename from docs/api/modules/_procedures_setdividendswallet_.md rename to docs/api/external-modules/_procedures_setdividendswallet_.md index d83e9c0..3334856 100644 --- a/docs/api/modules/_procedures_setdividendswallet_.md +++ b/docs/api/external-modules/_procedures_setdividendswallet_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SetDividendsWallet" +# procedures/SetDividendsWallet ## Index ### Classes * [SetDividendsWallet](../classes/_procedures_setdividendswallet_.setdividendswallet.md) + diff --git a/docs/api/external-modules/_procedures_setdividendswallet_.setdividendswallet.md b/docs/api/external-modules/_procedures_setdividendswallet_.setdividendswallet.md new file mode 100644 index 0000000..ed6f14f --- /dev/null +++ b/docs/api/external-modules/_procedures_setdividendswallet_.setdividendswallet.md @@ -0,0 +1,196 @@ +# SetDividendsWallet + +Procedure that modifies the wallet address where reclaimed dividends and withheld taxes are kept + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md)› + + ↳ **SetDividendsWallet** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_setdividendswallet_.setdividendswallet.md#constructor) + +### Properties + +* [args](../classes/_procedures_setdividendswallet_.setdividendswallet.md#protected-args) +* [context](../classes/_procedures_setdividendswallet_.setdividendswallet.md#protected-context) +* [type](../classes/_procedures_setdividendswallet_.setdividendswallet.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_setdividendswallet_.setdividendswallet.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_setdividendswallet_.setdividendswallet.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_setdividendswallet_.setdividendswallet.md#addtransaction) +* [prepare](../classes/_procedures_setdividendswallet_.setdividendswallet.md#prepare) +* [prepareTransactions](../classes/_procedures_setdividendswallet_.setdividendswallet.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SetDividendsWallet**\(`args`: [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SetDividendsWallet_](../classes/_procedures_setdividendswallet_.setdividendswallet.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SetDividendsWalletProcedureArgs](../interfaces/_types_index_.setdividendswalletprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SetDividendsWallet_](../classes/_procedures_setdividendswallet_.setdividendswallet.md) + +## Properties + +### `Protected` args + +• **args**: [_SetDividendsWalletProcedureArgs_](../interfaces/_types_index_.setdividendswalletprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetDividendsWallet + +_Overrides void_ + +_Defined in_ [_src/procedures/SetDividendsWallet.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L15) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SetDividendsWallet.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDividendsWallet.ts#L24) + +Change the dividends storage wallet address + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_setdocument_.md b/docs/api/external-modules/_procedures_setdocument_.md similarity index 67% rename from docs/api/modules/_procedures_setdocument_.md rename to docs/api/external-modules/_procedures_setdocument_.md index 99242a1..640c45a 100644 --- a/docs/api/modules/_procedures_setdocument_.md +++ b/docs/api/external-modules/_procedures_setdocument_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SetDocument" +# procedures/SetDocument ## Index ### Classes * [SetDocument](../classes/_procedures_setdocument_.setdocument.md) + diff --git a/docs/api/external-modules/_procedures_setdocument_.setdocument.md b/docs/api/external-modules/_procedures_setdocument_.setdocument.md new file mode 100644 index 0000000..de64375 --- /dev/null +++ b/docs/api/external-modules/_procedures_setdocument_.setdocument.md @@ -0,0 +1,197 @@ +# SetDocument + +Procedure that adds a document to a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md)› + + ↳ **SetDocument** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_setdocument_.setdocument.md#constructor) + +### Properties + +* [args](../classes/_procedures_setdocument_.setdocument.md#protected-args) +* [context](../classes/_procedures_setdocument_.setdocument.md#protected-context) +* [type](../classes/_procedures_setdocument_.setdocument.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_setdocument_.setdocument.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_setdocument_.setdocument.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_setdocument_.setdocument.md#addtransaction) +* [prepare](../classes/_procedures_setdocument_.setdocument.md#prepare) +* [prepareTransactions](../classes/_procedures_setdocument_.setdocument.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SetDocument**\(`args`: [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SetDocument_](../classes/_procedures_setdocument_.setdocument.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SetDocumentProcedureArgs](../interfaces/_types_index_.setdocumentprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SetDocument_](../classes/_procedures_setdocument_.setdocument.md) + +## Properties + +### `Protected` args + +• **args**: [_SetDocumentProcedureArgs_](../interfaces/_types_index_.setdocumentprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SetDocument + +_Overrides void_ + +_Defined in_ [_src/procedures/SetDocument.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L10) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SetDocument.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SetDocument.ts#L20) + +Set a document on the Security Token + +Note that this procedure will fail if: + +* The current wallet is not the Security Token owner +* The name of the document is less than 1 or more than 32 characters long +* The document hash is less than 1 or more than 32 characters long + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_signdisablecontrollerack_.md b/docs/api/external-modules/_procedures_signdisablecontrollerack_.md similarity index 69% rename from docs/api/modules/_procedures_signdisablecontrollerack_.md rename to docs/api/external-modules/_procedures_signdisablecontrollerack_.md index 4e2eb72..cdb2ea6 100644 --- a/docs/api/modules/_procedures_signdisablecontrollerack_.md +++ b/docs/api/external-modules/_procedures_signdisablecontrollerack_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SignDisableControllerAck" +# procedures/SignDisableControllerAck ## Index ### Classes * [SignDisableControllerAck](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) + diff --git a/docs/api/external-modules/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md b/docs/api/external-modules/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md new file mode 100644 index 0000000..e980e79 --- /dev/null +++ b/docs/api/external-modules/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md @@ -0,0 +1,191 @@ +# SignDisableControllerAck + +Procedure that signs an acknowledgement to permanently disable a Security Token's Controller functionality + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md)› + + ↳ **SignDisableControllerAck** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#constructor) + +### Properties + +* [args](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#protected-args) +* [context](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#protected-context) +* [type](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#addtransaction) +* [prepare](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#prepare) +* [prepareTransactions](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SignDisableControllerAck**\(`args`: [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SignDisableControllerAck_](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SignDisableControllerAckProcedureArgs](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SignDisableControllerAck_](../classes/_procedures_signdisablecontrollerack_.signdisablecontrollerack.md) + +## Properties + +### `Protected` args + +• **args**: [_SignDisableControllerAckProcedureArgs_](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignDisableControllerAck + +_Overrides void_ + +_Defined in_ [_src/procedures/SignDisableControllerAck.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L9) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SignDisableControllerAck.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignDisableControllerAck.ts#L14) + +Sign data to confirm the intent of permanently disabling the Security Token's Controller functionality + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_signfreezeissuanceack_.md b/docs/api/external-modules/_procedures_signfreezeissuanceack_.md similarity index 69% rename from docs/api/modules/_procedures_signfreezeissuanceack_.md rename to docs/api/external-modules/_procedures_signfreezeissuanceack_.md index 773082d..594ec81 100644 --- a/docs/api/modules/_procedures_signfreezeissuanceack_.md +++ b/docs/api/external-modules/_procedures_signfreezeissuanceack_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SignFreezeIssuanceAck" +# procedures/SignFreezeIssuanceAck ## Index ### Classes * [SignFreezeIssuanceAck](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) + diff --git a/docs/api/external-modules/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md b/docs/api/external-modules/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md new file mode 100644 index 0000000..49e9036 --- /dev/null +++ b/docs/api/external-modules/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md @@ -0,0 +1,191 @@ +# SignFreezeIssuanceAck + +Procedure that signs an acknowledgement to permanently freeze issuance of a Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md)› + + ↳ **SignFreezeIssuanceAck** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#constructor) + +### Properties + +* [args](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#protected-args) +* [context](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#protected-context) +* [type](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#addtransaction) +* [prepare](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#prepare) +* [prepareTransactions](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SignFreezeIssuanceAck**\(`args`: [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SignFreezeIssuanceAck_](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SignFreezeIssuanceAckProcedureArgs](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SignFreezeIssuanceAck_](../classes/_procedures_signfreezeissuanceack_.signfreezeissuanceack.md) + +## Properties + +### `Protected` args + +• **args**: [_SignFreezeIssuanceAckProcedureArgs_](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignFreezeIssuanceAck + +_Overrides void_ + +_Defined in_ [_src/procedures/SignFreezeIssuanceAck.ts:9_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L9) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SignFreezeIssuanceAck.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignFreezeIssuanceAck.ts#L14) + +Sign data to confirm the intent of permanently disabling issuance of the Security Token + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_signtransferdata_.md b/docs/api/external-modules/_procedures_signtransferdata_.md similarity index 68% rename from docs/api/modules/_procedures_signtransferdata_.md rename to docs/api/external-modules/_procedures_signtransferdata_.md index 161e0a7..991963d 100644 --- a/docs/api/modules/_procedures_signtransferdata_.md +++ b/docs/api/external-modules/_procedures_signtransferdata_.md @@ -1,7 +1,8 @@ -# External module: "procedures/SignTransferData" +# procedures/SignTransferData ## Index ### Classes * [SignTransferData](../classes/_procedures_signtransferdata_.signtransferdata.md) + diff --git a/docs/api/external-modules/_procedures_signtransferdata_.signtransferdata.md b/docs/api/external-modules/_procedures_signtransferdata_.signtransferdata.md new file mode 100644 index 0000000..2752c04 --- /dev/null +++ b/docs/api/external-modules/_procedures_signtransferdata_.signtransferdata.md @@ -0,0 +1,196 @@ +# SignTransferData + +Procedure that signs KYC data for transfers. This signature can be used to simulate updates to KYC data when checking if a transfer can be made or to actually modify said data at the moment of performing a transfer without having to do it in a separate transaction. The signature has a period of validity which is specified by the parameters passed to the procedure + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md)› + + ↳ **SignTransferData** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_signtransferdata_.signtransferdata.md#constructor) + +### Properties + +* [args](../classes/_procedures_signtransferdata_.signtransferdata.md#protected-args) +* [context](../classes/_procedures_signtransferdata_.signtransferdata.md#protected-context) +* [type](../classes/_procedures_signtransferdata_.signtransferdata.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_signtransferdata_.signtransferdata.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_signtransferdata_.signtransferdata.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_signtransferdata_.signtransferdata.md#addtransaction) +* [prepare](../classes/_procedures_signtransferdata_.signtransferdata.md#prepare) +* [prepareTransactions](../classes/_procedures_signtransferdata_.signtransferdata.md#preparetransactions) + +## Constructors + +### constructor + ++ **new SignTransferData**\(`args`: [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_SignTransferData_](../classes/_procedures_signtransferdata_.signtransferdata.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [SignTransferDataProcedureArgs](../interfaces/_types_index_.signtransferdataprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_SignTransferData_](../classes/_procedures_signtransferdata_.signtransferdata.md) + +## Properties + +### `Protected` args + +• **args**: [_SignTransferDataProcedureArgs_](../interfaces/_types_index_.signtransferdataprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.SignTransferData + +_Overrides void_ + +_Defined in_ [_src/procedures/SignTransferData.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L11) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/SignTransferData.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/SignTransferData.ts#L20) + +Sign KYC data, passing the valid dates and extra kyc data + +Note this procedure will fail if: + +* The signature validity period starting date \(validFrom\) is later than the end date \(validTo\) +* The validity period end date \(validTo\) is in the past + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_toggleallowbeneficialinvestments_.md b/docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.md similarity index 70% rename from docs/api/modules/_procedures_toggleallowbeneficialinvestments_.md rename to docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.md index 426fcfc..679fff0 100644 --- a/docs/api/modules/_procedures_toggleallowbeneficialinvestments_.md +++ b/docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ToggleAllowBeneficialInvestments" +# procedures/ToggleAllowBeneficialInvestments ## Index ### Classes * [ToggleAllowBeneficialInvestments](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) + diff --git a/docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md b/docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md new file mode 100644 index 0000000..2972332 --- /dev/null +++ b/docs/api/external-modules/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md @@ -0,0 +1,199 @@ +# ToggleAllowBeneficialInvestments + +Procedure that toggles whether beneficial investments are allowed or not in an STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md)› + + ↳ **ToggleAllowBeneficialInvestments** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#constructor) + +### Properties + +* [args](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#protected-args) +* [context](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#protected-context) +* [type](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#addtransaction) +* [prepare](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#prepare) +* [prepareTransactions](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ToggleAllowBeneficialInvestments**\(`args`: [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ToggleAllowBeneficialInvestments_](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ToggleAllowBeneficialInvestmentsProcedureArgs](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ToggleAllowBeneficialInvestments_](../classes/_procedures_toggleallowbeneficialinvestments_.toggleallowbeneficialinvestments.md) + +## Properties + +### `Protected` args + +• **args**: [_ToggleAllowBeneficialInvestmentsProcedureArgs_](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleAllowBeneficialInvestments + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleAllowBeneficialInvestments.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L57) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleAllowBeneficialInvestments.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowBeneficialInvestments.ts#L69) + +Toggle to allow or disallow beneficial investments in the STO + +Note this procedure will fail if: + +* Trying to allow beneficial investments when they are already allowed +* Trying to disallow beneficial investments when they are already disallowed +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_toggleallowpreissuing_.md b/docs/api/external-modules/_procedures_toggleallowpreissuing_.md similarity index 69% rename from docs/api/modules/_procedures_toggleallowpreissuing_.md rename to docs/api/external-modules/_procedures_toggleallowpreissuing_.md index 769fc4f..04e7d6b 100644 --- a/docs/api/modules/_procedures_toggleallowpreissuing_.md +++ b/docs/api/external-modules/_procedures_toggleallowpreissuing_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ToggleAllowPreIssuing" +# procedures/ToggleAllowPreIssuing ## Index ### Classes * [ToggleAllowPreIssuing](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) + diff --git a/docs/api/external-modules/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md b/docs/api/external-modules/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md new file mode 100644 index 0000000..333107f --- /dev/null +++ b/docs/api/external-modules/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md @@ -0,0 +1,200 @@ +# ToggleAllowPreIssuing + +Procedure that toggles whether pre-issuing of tokens is allowed or not in an STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md)› + + ↳ **ToggleAllowPreIssuing** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#constructor) + +### Properties + +* [args](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#protected-args) +* [context](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#protected-context) +* [type](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#addtransaction) +* [prepare](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#prepare) +* [prepareTransactions](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ToggleAllowPreIssuing**\(`args`: [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ToggleAllowPreIssuing_](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ToggleAllowPreIssuingProcedureArgs](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ToggleAllowPreIssuing_](../classes/_procedures_toggleallowpreissuing_.toggleallowpreissuing.md) + +## Properties + +### `Protected` args + +• **args**: [_ToggleAllowPreIssuingProcedureArgs_](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleAllowPreIssuing + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleAllowPreIssuing.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L59) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleAllowPreIssuing.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleAllowPreIssuing.ts#L72) + +Allow or disallow pre-issuing in the STO + +Note this procedure will fail if: + +* Trying to allow pre issuing when it is already allowed +* Trying to disallow pre issuing when it is already disallowed +* Trying to execute this procedure on an STO with version 3.0.0 or lower +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_togglefreezetransfers_.md b/docs/api/external-modules/_procedures_togglefreezetransfers_.md similarity index 69% rename from docs/api/modules/_procedures_togglefreezetransfers_.md rename to docs/api/external-modules/_procedures_togglefreezetransfers_.md index 087bfb7..f1f5387 100644 --- a/docs/api/modules/_procedures_togglefreezetransfers_.md +++ b/docs/api/external-modules/_procedures_togglefreezetransfers_.md @@ -1,7 +1,8 @@ -# External module: "procedures/ToggleFreezeTransfers" +# procedures/ToggleFreezeTransfers ## Index ### Classes * [ToggleFreezeTransfers](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md) + diff --git a/docs/api/external-modules/_procedures_togglefreezetransfers_.togglefreezetransfers.md b/docs/api/external-modules/_procedures_togglefreezetransfers_.togglefreezetransfers.md new file mode 100644 index 0000000..67c49ff --- /dev/null +++ b/docs/api/external-modules/_procedures_togglefreezetransfers_.togglefreezetransfers.md @@ -0,0 +1,196 @@ +# ToggleFreezeTransfers + +Procedure that toggles whether transfers of a Security Token are frozen or no + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md)› + + ↳ **ToggleFreezeTransfers** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#constructor) + +### Properties + +* [args](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#protected-args) +* [context](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#protected-context) +* [type](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#addtransaction) +* [prepare](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#prepare) +* [prepareTransactions](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md#preparetransactions) + +## Constructors + +### constructor + ++ **new ToggleFreezeTransfers**\(`args`: [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_ToggleFreezeTransfers_](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [ToggleFreezeTransfersProcedureArgs](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_ToggleFreezeTransfers_](../classes/_procedures_togglefreezetransfers_.togglefreezetransfers.md) + +## Properties + +### `Protected` args + +• **args**: [_ToggleFreezeTransfersProcedureArgs_](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.ToggleFreezeTransfers + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleFreezeTransfers.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L26) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/ToggleFreezeTransfers.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ToggleFreezeTransfers.ts#L35) + +Freeze or unfreeze Security Token transfers + +Note this procedure will fail if: + +* The current wallet address is not the owner +* Trying to freeze/unfreeze a security token that is already frozen/unfrozen + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_togglepausesto_.md b/docs/api/external-modules/_procedures_togglepausesto_.md similarity index 68% rename from docs/api/modules/_procedures_togglepausesto_.md rename to docs/api/external-modules/_procedures_togglepausesto_.md index 6423675..8a65ffb 100644 --- a/docs/api/modules/_procedures_togglepausesto_.md +++ b/docs/api/external-modules/_procedures_togglepausesto_.md @@ -1,7 +1,8 @@ -# External module: "procedures/TogglePauseSto" +# procedures/TogglePauseSto ## Index ### Classes * [TogglePauseSto](../classes/_procedures_togglepausesto_.togglepausesto.md) + diff --git a/docs/api/external-modules/_procedures_togglepausesto_.togglepausesto.md b/docs/api/external-modules/_procedures_togglepausesto_.togglepausesto.md new file mode 100644 index 0000000..4a49378 --- /dev/null +++ b/docs/api/external-modules/_procedures_togglepausesto_.togglepausesto.md @@ -0,0 +1,197 @@ +# TogglePauseSto + +Procedure to pause or unpause an STO + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md)› + + ↳ **TogglePauseSto** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_togglepausesto_.togglepausesto.md#constructor) + +### Properties + +* [args](../classes/_procedures_togglepausesto_.togglepausesto.md#protected-args) +* [context](../classes/_procedures_togglepausesto_.togglepausesto.md#protected-context) +* [type](../classes/_procedures_togglepausesto_.togglepausesto.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_togglepausesto_.togglepausesto.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_togglepausesto_.togglepausesto.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_togglepausesto_.togglepausesto.md#addtransaction) +* [prepare](../classes/_procedures_togglepausesto_.togglepausesto.md#prepare) +* [prepareTransactions](../classes/_procedures_togglepausesto_.togglepausesto.md#preparetransactions) + +## Constructors + +### constructor + ++ **new TogglePauseSto**\(`args`: [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_TogglePauseSto_](../classes/_procedures_togglepausesto_.togglepausesto.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [TogglePauseStoProcedureArgs](../interfaces/_types_index_.togglepausestoprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TogglePauseSto_](../classes/_procedures_togglepausesto_.togglepausesto.md) + +## Properties + +### `Protected` args + +• **args**: [_TogglePauseStoProcedureArgs_](../interfaces/_types_index_.togglepausestoprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TogglePauseSto + +_Overrides void_ + +_Defined in_ [_src/procedures/TogglePauseSto.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L55) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/TogglePauseSto.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TogglePauseSto.ts#L65) + +Pause or unpause the STO + +Note this procedure will fail if: + +* The specified STO address is invalid +* The specified STO type is invalid +* The STO has not been launched, or the module has been archived + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_transfererc20_.md b/docs/api/external-modules/_procedures_transfererc20_.md similarity index 68% rename from docs/api/modules/_procedures_transfererc20_.md rename to docs/api/external-modules/_procedures_transfererc20_.md index 98d3545..f20947c 100644 --- a/docs/api/modules/_procedures_transfererc20_.md +++ b/docs/api/external-modules/_procedures_transfererc20_.md @@ -1,7 +1,8 @@ -# External module: "procedures/TransferErc20" +# procedures/TransferErc20 ## Index ### Classes * [TransferErc20](../classes/_procedures_transfererc20_.transfererc20.md) + diff --git a/docs/api/external-modules/_procedures_transfererc20_.transfererc20.md b/docs/api/external-modules/_procedures_transfererc20_.transfererc20.md new file mode 100644 index 0000000..5c11ee5 --- /dev/null +++ b/docs/api/external-modules/_procedures_transfererc20_.transfererc20.md @@ -0,0 +1,199 @@ +# TransferErc20 + +Procedure to transfer funds of an ERC20 token. If no token address is specified, it defaults to POLY + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md)› + + ↳ **TransferErc20** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_transfererc20_.transfererc20.md#constructor) + +### Properties + +* [args](../classes/_procedures_transfererc20_.transfererc20.md#protected-args) +* [context](../classes/_procedures_transfererc20_.transfererc20.md#protected-context) +* [type](../classes/_procedures_transfererc20_.transfererc20.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_transfererc20_.transfererc20.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_transfererc20_.transfererc20.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_transfererc20_.transfererc20.md#addtransaction) +* [prepare](../classes/_procedures_transfererc20_.transfererc20.md#prepare) +* [prepareTransactions](../classes/_procedures_transfererc20_.transfererc20.md#preparetransactions) + +## Constructors + +### constructor + ++ **new TransferErc20**\(`args`: [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_TransferErc20_](../classes/_procedures_transfererc20_.transfererc20.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [TransferErc20ProcedureArgs](../interfaces/_types_index_.transfererc20procedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TransferErc20_](../classes/_procedures_transfererc20_.transfererc20.md) + +## Properties + +### `Protected` args + +• **args**: [_TransferErc20ProcedureArgs_](../interfaces/_types_index_.transfererc20procedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferErc20 + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferErc20.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L28) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferErc20.ts:38_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferErc20.ts#L38) + +Transfer an ERC20 token to another wallet. The token in question defaults to POLY if no address is supplied + +Note that the procedure will fail if: + +* The owner's token balance is less than the amount being transferred. The only exception to this is when transferring POLY on a testnet. + + If that is the case, an extra transaction will be submitted to request the missing amount of tokens from the faucet + +* The token being transferred is a Security Token. In that case, the corresponding Security Token transfer procedures should be used + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_transferownership_.md b/docs/api/external-modules/_procedures_transferownership_.md similarity index 68% rename from docs/api/modules/_procedures_transferownership_.md rename to docs/api/external-modules/_procedures_transferownership_.md index 7bba35e..4c1d9aa 100644 --- a/docs/api/modules/_procedures_transferownership_.md +++ b/docs/api/external-modules/_procedures_transferownership_.md @@ -1,7 +1,8 @@ -# External module: "procedures/TransferOwnership" +# procedures/TransferOwnership ## Index ### Classes * [TransferOwnership](../classes/_procedures_transferownership_.transferownership.md) + diff --git a/docs/api/external-modules/_procedures_transferownership_.transferownership.md b/docs/api/external-modules/_procedures_transferownership_.transferownership.md new file mode 100644 index 0000000..7e2a9a7 --- /dev/null +++ b/docs/api/external-modules/_procedures_transferownership_.transferownership.md @@ -0,0 +1,196 @@ +# TransferOwnership + +Procedure that will transfer the ownership of a Security Token to a different wallet + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md)› + + ↳ **TransferOwnership** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_transferownership_.transferownership.md#constructor) + +### Properties + +* [args](../classes/_procedures_transferownership_.transferownership.md#protected-args) +* [context](../classes/_procedures_transferownership_.transferownership.md#protected-context) +* [type](../classes/_procedures_transferownership_.transferownership.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_transferownership_.transferownership.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_transferownership_.transferownership.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_transferownership_.transferownership.md#addtransaction) +* [prepare](../classes/_procedures_transferownership_.transferownership.md#prepare) +* [prepareTransactions](../classes/_procedures_transferownership_.transferownership.md#preparetransactions) + +## Constructors + +### constructor + ++ **new TransferOwnership**\(`args`: [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_TransferOwnership_](../classes/_procedures_transferownership_.transferownership.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [TransferOwnershipProcedureArgs](../interfaces/_types_index_.transferownershipprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TransferOwnership_](../classes/_procedures_transferownership_.transferownership.md) + +## Properties + +### `Protected` args + +• **args**: [_TransferOwnershipProcedureArgs_](../interfaces/_types_index_.transferownershipprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferOwnership + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferOwnership.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L27) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferOwnership.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferOwnership.ts#L36) + +Transfer ownership of a Security Token to another wallet + +Note this procedure will fail if: + +* Trying to call the procedure from a wallet that is not the current owner of the Security Token +* Transferring the ownership to the current owner, as there is no change + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_transferreservationownership_.md b/docs/api/external-modules/_procedures_transferreservationownership_.md similarity index 70% rename from docs/api/modules/_procedures_transferreservationownership_.md rename to docs/api/external-modules/_procedures_transferreservationownership_.md index 89e394a..402f903 100644 --- a/docs/api/modules/_procedures_transferreservationownership_.md +++ b/docs/api/external-modules/_procedures_transferreservationownership_.md @@ -1,7 +1,8 @@ -# External module: "procedures/TransferReservationOwnership" +# procedures/TransferReservationOwnership ## Index ### Classes * [TransferReservationOwnership](../classes/_procedures_transferreservationownership_.transferreservationownership.md) + diff --git a/docs/api/external-modules/_procedures_transferreservationownership_.transferreservationownership.md b/docs/api/external-modules/_procedures_transferreservationownership_.transferreservationownership.md new file mode 100644 index 0000000..f108be8 --- /dev/null +++ b/docs/api/external-modules/_procedures_transferreservationownership_.transferreservationownership.md @@ -0,0 +1,197 @@ +# TransferReservationOwnership + +Procedure that transfers ownership of a Security Token Reservation + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md)› + + ↳ **TransferReservationOwnership** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_transferreservationownership_.transferreservationownership.md#constructor) + +### Properties + +* [args](../classes/_procedures_transferreservationownership_.transferreservationownership.md#protected-args) +* [context](../classes/_procedures_transferreservationownership_.transferreservationownership.md#protected-context) +* [type](../classes/_procedures_transferreservationownership_.transferreservationownership.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_transferreservationownership_.transferreservationownership.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_transferreservationownership_.transferreservationownership.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_transferreservationownership_.transferreservationownership.md#addtransaction) +* [prepare](../classes/_procedures_transferreservationownership_.transferreservationownership.md#prepare) +* [prepareTransactions](../classes/_procedures_transferreservationownership_.transferreservationownership.md#preparetransactions) + +## Constructors + +### constructor + ++ **new TransferReservationOwnership**\(`args`: [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_TransferReservationOwnership_](../classes/_procedures_transferreservationownership_.transferreservationownership.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [TransferReservationOwnershipProcedureArgs](../interfaces/_types_index_.transferreservationownershipprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TransferReservationOwnership_](../classes/_procedures_transferreservationownership_.transferreservationownership.md) + +## Properties + +### `Protected` args + +• **args**: [_TransferReservationOwnershipProcedureArgs_](../interfaces/_types_index_.transferreservationownershipprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferReservationOwnership + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferReservationOwnership.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L30) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferReservationOwnership.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferReservationOwnership.ts#L40) + +Transfer the ownership of a Security Token Reservation to the supplied address + +Note this procedure will fail if: + +* A Security Token has already been launched with this symbol +* The current wallet address is not the owner of the Reservation +* Attempting to transfer ownership to the current owner + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_transfersecuritytokens_.md b/docs/api/external-modules/_procedures_transfersecuritytokens_.md similarity index 69% rename from docs/api/modules/_procedures_transfersecuritytokens_.md rename to docs/api/external-modules/_procedures_transfersecuritytokens_.md index cc961f2..e89a02f 100644 --- a/docs/api/modules/_procedures_transfersecuritytokens_.md +++ b/docs/api/external-modules/_procedures_transfersecuritytokens_.md @@ -1,7 +1,8 @@ -# External module: "procedures/TransferSecurityTokens" +# procedures/TransferSecurityTokens ## Index ### Classes * [TransferSecurityTokens](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md) + diff --git a/docs/api/external-modules/_procedures_transfersecuritytokens_.transfersecuritytokens.md b/docs/api/external-modules/_procedures_transfersecuritytokens_.transfersecuritytokens.md new file mode 100644 index 0000000..2b8c1ec --- /dev/null +++ b/docs/api/external-modules/_procedures_transfersecuritytokens_.transfersecuritytokens.md @@ -0,0 +1,193 @@ +# TransferSecurityTokens + +Procedure that transfer security tokens + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md)› + + ↳ **TransferSecurityTokens** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#constructor) + +### Properties + +* [args](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#protected-args) +* [context](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#protected-context) +* [type](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#addtransaction) +* [prepare](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#prepare) +* [prepareTransactions](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md#preparetransactions) + +## Constructors + +### constructor + ++ **new TransferSecurityTokens**\(`args`: [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_TransferSecurityTokens_](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [TransferSecurityTokensProcedureArgs](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_TransferSecurityTokens_](../classes/_procedures_transfersecuritytokens_.transfersecuritytokens.md) + +## Properties + +### `Protected` args + +• **args**: [_TransferSecurityTokensProcedureArgs_](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.TransferSecurityTokens + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferSecurityTokens.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L43) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/TransferSecurityTokens.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/TransferSecurityTokens.ts#L70) + +Transfer security tokens from a wallet address to another _**If from argument is not provided, the current SDK user address will be taken as it**_ + +Note that this procedure will fail if the security token symbol doesn't exist + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.md b/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.md new file mode 100644 index 0000000..5fa913b --- /dev/null +++ b/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.md @@ -0,0 +1,20 @@ +# procedures/UpdateDividendsTaxWithholdingList + +## Index + +### Classes + +* [UpdateDividendsTaxWithholdingList](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) + +### Variables + +* [CHUNK\_SIZE](_procedures_updatedividendstaxwithholdinglist_.md#const-chunk_size) + +## Variables + +### `Const` CHUNK\_SIZE + +• **CHUNK\_SIZE**: _200_ = 200 + +_Defined in_ [_src/procedures/UpdateDividendsTaxWithholdingList.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L15) + diff --git a/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md b/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md new file mode 100644 index 0000000..06da52b --- /dev/null +++ b/docs/api/external-modules/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md @@ -0,0 +1,196 @@ +# UpdateDividendsTaxWithholdingList + +Procedure that modifies dividend tax withholding percentages for holders of the Security Token + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)› + + ↳ **UpdateDividendsTaxWithholdingList** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#constructor) + +### Properties + +* [args](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#protected-args) +* [context](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#protected-context) +* [type](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#addtransaction) +* [prepare](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#prepare) +* [prepareTransactions](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md#preparetransactions) + +## Constructors + +### constructor + ++ **new UpdateDividendsTaxWithholdingList**\(`args`: [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_UpdateDividendsTaxWithholdingList_](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [UpdateDividendsTaxWithholdingListProcedureArgs](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_UpdateDividendsTaxWithholdingList_](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) + +## Properties + +### `Protected` args + +• **args**: [_UpdateDividendsTaxWithholdingListProcedureArgs_](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.UpdateDividendsTaxWithholdingList + +_Overrides void_ + +_Defined in_ [_src/procedures/UpdateDividendsTaxWithholdingList.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L45) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/UpdateDividendsTaxWithholdingList.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L54) + +Modify tax withholding percentage for tokenholders + +Note that this procedure will fail if: + +* The Security Token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/modules/_procedures_withdrawtaxes_.md b/docs/api/external-modules/_procedures_withdrawtaxes_.md similarity index 68% rename from docs/api/modules/_procedures_withdrawtaxes_.md rename to docs/api/external-modules/_procedures_withdrawtaxes_.md index f9e8682..bc1ca5e 100644 --- a/docs/api/modules/_procedures_withdrawtaxes_.md +++ b/docs/api/external-modules/_procedures_withdrawtaxes_.md @@ -1,7 +1,8 @@ -# External module: "procedures/WithdrawTaxes" +# procedures/WithdrawTaxes ## Index ### Classes * [WithdrawTaxes](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md) + diff --git a/docs/api/external-modules/_procedures_withdrawtaxes_.withdrawtaxes.md b/docs/api/external-modules/_procedures_withdrawtaxes_.withdrawtaxes.md new file mode 100644 index 0000000..3d3f8be --- /dev/null +++ b/docs/api/external-modules/_procedures_withdrawtaxes_.withdrawtaxes.md @@ -0,0 +1,196 @@ +# WithdrawTaxes + +Procedure that allows an issuer to withdraw withheld tax from a Dividend Distribution + +## Type parameters + +▪ **ReturnType** + +## Hierarchy + +* Procedure‹[WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md)› + + ↳ **WithdrawTaxes** + +## Index + +### Constructors + +* [constructor](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#constructor) + +### Properties + +* [args](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#protected-args) +* [context](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#protected-context) +* [type](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#type) + +### Methods + +* [addProcedure](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#addprocedure) +* [addSignatureRequest](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#addsignaturerequest) +* [addTransaction](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#addtransaction) +* [prepare](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#prepare) +* [prepareTransactions](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md#preparetransactions) + +## Constructors + +### constructor + ++ **new WithdrawTaxes**\(`args`: [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md), `context`: [Context](../classes/_context_.context.md)\): [_WithdrawTaxes_](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `args` | [WithdrawTaxesProcedureArgs](../interfaces/_types_index_.withdrawtaxesprocedureargs.md) | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** [_WithdrawTaxes_](../classes/_procedures_withdrawtaxes_.withdrawtaxes.md) + +## Properties + +### `Protected` args + +• **args**: [_WithdrawTaxesProcedureArgs_](../interfaces/_types_index_.withdrawtaxesprocedureargs.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34) + +### `Protected` context + +• **context**: [_Context_](../classes/_context_.context.md) + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36) + +### type + +• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype.md) = ProcedureType.WithdrawTaxes + +_Overrides void_ + +_Defined in_ [_src/procedures/WithdrawTaxes.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L28) + +## Methods + +### addProcedure + +▸ **addProcedure**<**A**, **R**>\(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91) + +Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any_ + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass.md)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +whichever value is returned by the Procedure + +### addSignatureRequest + +▸ **addSignatureRequest**<**A**>\(`request`: [SignatureRequest](_types_index_.md#signaturerequest)‹A›\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179) + +Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +**Parameters:** + +| Name | Type | Description | +| :--- | :--- | :--- | +| `request` | [SignatureRequest](_types_index_.md#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the signed data + +### addTransaction + +▸ **addTransaction**<**A**, **R**, **V**>\(`method`: [LowLevelMethod](_types_index_.md#lowlevelmethod)‹A› \| [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod.md)‹V, A›, `__namedParameters`: object\): _\(Anonymous function\)_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137) + +Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started. + +**Type parameters:** + +▪ **A** + +▪ **R**: _any\[\]_ + +▪ **V**: _any_ + +**Parameters:** + +▪ **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹A› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹V, A›_ + +A method \(or future method\) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time \(for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run\) + +▪`Default value` **\_\_namedParameters**: _object_= {} + +| Name | Type | Default | +| :--- | :--- | :--- | +| `fees` | undefined \| [Fees](../interfaces/_types_index_.fees.md) | - | +| `resolvers` | object | \(\[\] as unknown\) as ResolverArray | +| `tag` | undefined \| [Any](../enums/_types_index_.polytransactiontag.md#any) \| [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) \| [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) \| [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) \| [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) \| [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) \| [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) \| [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) \| [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) \| [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) \| [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) \| [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) \| [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) \| [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) \| [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) \| [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) \| [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) \| [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) \| [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) \| [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) \| [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) \| [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) \| [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) \| [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) \| [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) \| [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) \| [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) \| [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) \| [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) \| [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) \| [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) \| [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) \| [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) \| [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) \| [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) \| [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) \| [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) \| [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) \| [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) \| [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) \| [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) \| [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) \| [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) \| [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) \| [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) \| [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) \| [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) \| [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) \| [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) \| [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) \| [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) \| [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) \| [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) \| [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) \| [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) \| [Signature](../enums/_types_index_.polytransactiontag.md#signature) \| [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) \| [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) | - | + +**Returns:** _\(Anonymous function\)_ + +a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed + +### prepare + +▸ **prepare**\(\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +_Inherited from void_ + +_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52) + +Mandatory method that builds a list of transactions that will be run + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹Args, ReturnType››_ + +### prepareTransactions + +▸ **prepareTransactions**\(\): _Promise‹void›_ + +_Overrides void_ + +_Defined in_ [_src/procedures/WithdrawTaxes.ts:37_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/WithdrawTaxes.ts#L37) + +Withdraw Tax Withholdings + +Note that this procedure will fail if: + +* The security token doesn't exist +* The Dividends Feature hasn't been enabled + +**Returns:** _Promise‹void›_ + diff --git a/docs/api/external-modules/_types_index_.approveerc20procedureargs.md b/docs/api/external-modules/_types_index_.approveerc20procedureargs.md new file mode 100644 index 0000000..dac05b5 --- /dev/null +++ b/docs/api/external-modules/_types_index_.approveerc20procedureargs.md @@ -0,0 +1,42 @@ +# ApproveErc20ProcedureArgs + +Arguments for the [ApproveErc20](../enums/_types_index_.proceduretype.md#approveerc20) Procedure + +## Hierarchy + +* **ApproveErc20ProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.approveerc20procedureargs.md#amount) +* [spender](../interfaces/_types_index_.approveerc20procedureargs.md#spender) +* [tokenAddress](../interfaces/_types_index_.approveerc20procedureargs.md#optional-tokenaddress) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:285_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L285) + +amount of tokens to be approved + +### spender + +• **spender**: _string_ + +_Defined in_ [_src/types/index.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L289) + +the spender of the tokens being approved + +### `Optional` tokenAddress + +• **tokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L293) + +address of the ERC20 token \(defaults to POLY\) + diff --git a/docs/api/external-modules/_types_index_.assignsecuritytokenroleprocedureargs.md b/docs/api/external-modules/_types_index_.assignsecuritytokenroleprocedureargs.md new file mode 100644 index 0000000..a88ba6c --- /dev/null +++ b/docs/api/external-modules/_types_index_.assignsecuritytokenroleprocedureargs.md @@ -0,0 +1,60 @@ +# AssignSecurityTokenRoleProcedureArgs + +Arguments for the [AssignSecurityTokenRole](../enums/_types_index_.proceduretype.md#assignsecuritytokenrole) Procedure + +## Hierarchy + +* **AssignSecurityTokenRoleProcedureArgs** + +## Index + +### Properties + +* [assign](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md#assign) +* [delegateAddress](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md#delegateaddress) +* [description](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md#description) +* [role](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md#role) +* [symbol](../interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md#symbol) + +## Properties + +### assign + +• **assign**: _boolean_ + +_Defined in_ [_src/types/index.ts:896_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L896) + +whether to assign or revoke the role + +### delegateAddress + +• **delegateAddress**: _string_ + +_Defined in_ [_src/types/index.ts:888_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L888) + +wallet address of the delegate + +### description + +• **description**: _string_ + +_Defined in_ [_src/types/index.ts:900_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L900) + +description of the delegate \(i.e. "company accountant"\) + +### role + +• **role**: [_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md) + +_Defined in_ [_src/types/index.ts:892_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L892) + +role to assign/revoke to/from the delegate + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:884_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L884) + +the symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.assignstoroleprocedureargs.md b/docs/api/external-modules/_types_index_.assignstoroleprocedureargs.md new file mode 100644 index 0000000..239db01 --- /dev/null +++ b/docs/api/external-modules/_types_index_.assignstoroleprocedureargs.md @@ -0,0 +1,67 @@ +# AssignStoRoleProcedureArgs + +Arguments for the [AssignStoRole](../enums/_types_index_.proceduretype.md#assignstorole) Procedure + +## Hierarchy + +* **AssignStoRoleProcedureArgs** + +## Index + +### Properties + +* [assign](../interfaces/_types_index_.assignstoroleprocedureargs.md#assign) +* [delegateAddress](../interfaces/_types_index_.assignstoroleprocedureargs.md#delegateaddress) +* [description](../interfaces/_types_index_.assignstoroleprocedureargs.md#optional-description) +* [role](../interfaces/_types_index_.assignstoroleprocedureargs.md#role) +* [stoAddress](../interfaces/_types_index_.assignstoroleprocedureargs.md#stoaddress) +* [symbol](../interfaces/_types_index_.assignstoroleprocedureargs.md#symbol) + +## Properties + +### assign + +• **assign**: _boolean_ + +_Defined in_ [_src/types/index.ts:923_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L923) + +whether to assign or revoke the role + +### delegateAddress + +• **delegateAddress**: _string_ + +_Defined in_ [_src/types/index.ts:914_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L914) + +wallet address of the delegate + +### `Optional` description + +• **description**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:927_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L927) + +description of the delegate \(i.e. "company lawyer"\) + +### role + +• **role**: [_StoRole_](../enums/_types_index_.storole.md) + +_Defined in_ [_src/types/index.ts:919_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L919) + +role to assign/revoke to/from the delegate + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:915_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L915) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:910_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L910) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.controllerredeemprocedureargs.md b/docs/api/external-modules/_types_index_.controllerredeemprocedureargs.md new file mode 100644 index 0000000..5793ebf --- /dev/null +++ b/docs/api/external-modules/_types_index_.controllerredeemprocedureargs.md @@ -0,0 +1,60 @@ +# ControllerRedeemProcedureArgs + +Arguments for the [ControllerRedeem](../enums/_types_index_.proceduretype.md#controllerredeem) Procedure + +## Hierarchy + +* **ControllerRedeemProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.controllerredeemprocedureargs.md#amount) +* [data](../interfaces/_types_index_.controllerredeemprocedureargs.md#optional-data) +* [from](../interfaces/_types_index_.controllerredeemprocedureargs.md#from) +* [reason](../interfaces/_types_index_.controllerredeemprocedureargs.md#optional-reason) +* [symbol](../interfaces/_types_index_.controllerredeemprocedureargs.md#symbol) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:975_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L975) + +amount of tokens being redeemed \(burned\) + +### `Optional` data + +• **data**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:979_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L979) + +extra KYC transfer data + +### from + +• **from**: _string_ + +_Defined in_ [_src/types/index.ts:967_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L967) + +wallet address from which tokens will be redeemed \(burned\) + +### `Optional` reason + +• **reason**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:983_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L983) + +reason why tokens are being redeemed + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:971_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L971) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.controllertransferprocedureargs.md b/docs/api/external-modules/_types_index_.controllertransferprocedureargs.md new file mode 100644 index 0000000..6e95f03 --- /dev/null +++ b/docs/api/external-modules/_types_index_.controllertransferprocedureargs.md @@ -0,0 +1,69 @@ +# ControllerTransferProcedureArgs + +Arguments for the [ControllerTransfer](../enums/_types_index_.proceduretype.md#controllertransfer) Procedure + +## Hierarchy + +* **ControllerTransferProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.controllertransferprocedureargs.md#amount) +* [data](../interfaces/_types_index_.controllertransferprocedureargs.md#optional-data) +* [from](../interfaces/_types_index_.controllertransferprocedureargs.md#from) +* [log](../interfaces/_types_index_.controllertransferprocedureargs.md#optional-log) +* [symbol](../interfaces/_types_index_.controllertransferprocedureargs.md#symbol) +* [to](../interfaces/_types_index_.controllertransferprocedureargs.md#to) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:949_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L949) + +amount of tokens being forcefully transferred + +### `Optional` data + +• **data**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:953_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L953) + +extra KYC transfer data + +### from + +• **from**: _string_ + +_Defined in_ [_src/types/index.ts:937_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L937) + +sender's wallet address + +### `Optional` log + +• **log**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:957_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L957) + +extra log information + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:945_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L945) + +symbol of the Security Token + +### to + +• **to**: _string_ + +_Defined in_ [_src/types/index.ts:941_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L941) + +receiver's wallet address + diff --git a/docs/api/external-modules/_types_index_.createcheckpointprocedureargs.md b/docs/api/external-modules/_types_index_.createcheckpointprocedureargs.md new file mode 100644 index 0000000..db702a5 --- /dev/null +++ b/docs/api/external-modules/_types_index_.createcheckpointprocedureargs.md @@ -0,0 +1,24 @@ +# CreateCheckpointProcedureArgs + +Arguments for the [CreateCheckpoint](../enums/_types_index_.proceduretype.md#createcheckpoint) Procedure + +## Hierarchy + +* **CreateCheckpointProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.createcheckpointprocedureargs.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L321) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.createdividenddistributionprocedureargs.md b/docs/api/external-modules/_types_index_.createdividenddistributionprocedureargs.md new file mode 100644 index 0000000..2801626 --- /dev/null +++ b/docs/api/external-modules/_types_index_.createdividenddistributionprocedureargs.md @@ -0,0 +1,96 @@ +# CreateDividendDistributionProcedureArgs + +Arguments for the [CreateDividendDistribution](../enums/_types_index_.proceduretype.md#createdividenddistribution) Procedure + +## Hierarchy + +* **CreateDividendDistributionProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#amount) +* [checkpointIndex](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#checkpointindex) +* [erc20Address](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#erc20address) +* [excludedAddresses](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#optional-excludedaddresses) +* [expiryDate](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#expirydate) +* [maturityDate](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#maturitydate) +* [name](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#name) +* [symbol](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#symbol) +* [taxWithholdings](../interfaces/_types_index_.createdividenddistributionprocedureargs.md#optional-taxwithholdings) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:347_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L347) + +amount to be distributed as dividends + +### checkpointIndex + +• **checkpointIndex**: _number_ + +_Defined in_ [_src/types/index.ts:351_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L351) + +index of the Checkpoint in which the Dividend Distribution will be based + +### erc20Address + +• **erc20Address**: _string_ + +_Defined in_ [_src/types/index.ts:343_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L343) + +address of the ERC20 token + +### `Optional` excludedAddresses + +• **excludedAddresses**? : _string\[\]_ + +_Defined in_ [_src/types/index.ts:359_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L359) + +list of addresses that will be excluded from receiving payment + +### expiryDate + +• **expiryDate**: _Date_ + +_Defined in_ [_src/types/index.ts:339_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L339) + +date on which the Dividend will expire + +### maturityDate + +• **maturityDate**: _Date_ + +_Defined in_ [_src/types/index.ts:335_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L335) + +date from which Dividend payments can be pushed/claimed + +### name + +• **name**: _string_ + +_Defined in_ [_src/types/index.ts:355_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L355) + +name of the distribution + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:331_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L331) + +symbol of the Security Token + +### `Optional` taxWithholdings + +• **taxWithholdings**? : [_TaxWithholdingEntry_](../interfaces/_types_index_.taxwithholdingentry.md)_\[\]_ + +_Defined in_ [_src/types/index.ts:363_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L363) + +tax withholding list for the Dividend Distribution + diff --git a/docs/api/external-modules/_types_index_.createsecuritytokenprocedureargs.md b/docs/api/external-modules/_types_index_.createsecuritytokenprocedureargs.md new file mode 100644 index 0000000..74032f8 --- /dev/null +++ b/docs/api/external-modules/_types_index_.createsecuritytokenprocedureargs.md @@ -0,0 +1,60 @@ +# CreateSecurityTokenProcedureArgs + +Arguments for the [CreateSecurityToken](../enums/_types_index_.proceduretype.md#createsecuritytoken) Procedure + +## Hierarchy + +* **CreateSecurityTokenProcedureArgs** + +## Index + +### Properties + +* [detailsUrl](../interfaces/_types_index_.createsecuritytokenprocedureargs.md#optional-detailsurl) +* [divisible](../interfaces/_types_index_.createsecuritytokenprocedureargs.md#divisible) +* [name](../interfaces/_types_index_.createsecuritytokenprocedureargs.md#name) +* [symbol](../interfaces/_types_index_.createsecuritytokenprocedureargs.md#symbol) +* [treasuryWallet](../interfaces/_types_index_.createsecuritytokenprocedureargs.md#optional-treasurywallet) + +## Properties + +### `Optional` detailsUrl + +• **detailsUrl**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:407_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L407) + +url where Security Token details can be found + +### divisible + +• **divisible**: _boolean_ + +_Defined in_ [_src/types/index.ts:411_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L411) + +whether or not the Security Token is divisible + +### name + +• **name**: _string_ + +_Defined in_ [_src/types/index.ts:399_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L399) + +name of the Security Token + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:403_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L403) + +symbol of the Security Token + +### `Optional` treasuryWallet + +• **treasuryWallet**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:415_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L415) + +the Treasury Wallet address + diff --git a/docs/api/external-modules/_types_index_.customcurrency.md b/docs/api/external-modules/_types_index_.customcurrency.md new file mode 100644 index 0000000..852eac6 --- /dev/null +++ b/docs/api/external-modules/_types_index_.customcurrency.md @@ -0,0 +1,42 @@ +# CustomCurrency + +Custom currency in which a Tiered STO can raise funds + +## Hierarchy + +* **CustomCurrency** + +## Index + +### Properties + +* [currencySymbol](../interfaces/_types_index_.customcurrency.md#currencysymbol) +* [ethOracleAddress](../interfaces/_types_index_.customcurrency.md#ethoracleaddress) +* [polyOracleAddress](../interfaces/_types_index_.customcurrency.md#polyoracleaddress) + +## Properties + +### currencySymbol + +• **currencySymbol**: _string_ + +_Defined in_ [_src/types/index.ts:727_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L727) + +symbol of the custom currency \(USD, CAD, EUR, etc. Default is USD\) + +### ethOracleAddress + +• **ethOracleAddress**: _string_ + +_Defined in_ [_src/types/index.ts:731_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L731) + +address of the oracle that states the price of ETH in the custom currency. Only required if raising funds in ETH + +### polyOracleAddress + +• **polyOracleAddress**: _string_ + +_Defined in_ [_src/types/index.ts:735_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L735) + +address of the oracle that states the price of POLY in the custom currency. Only required if raising funds in POLY + diff --git a/docs/api/external-modules/_types_index_.disablecontrollerprocedureargs.md b/docs/api/external-modules/_types_index_.disablecontrollerprocedureargs.md new file mode 100644 index 0000000..e3f76b1 --- /dev/null +++ b/docs/api/external-modules/_types_index_.disablecontrollerprocedureargs.md @@ -0,0 +1,33 @@ +# DisableControllerProcedureArgs + +Arguments for the [DisableController](../enums/_types_index_.proceduretype.md#disablecontroller) Procedure + +## Hierarchy + +* **DisableControllerProcedureArgs** + +## Index + +### Properties + +* [signature](../interfaces/_types_index_.disablecontrollerprocedureargs.md#optional-signature) +* [symbol](../interfaces/_types_index_.disablecontrollerprocedureargs.md#symbol) + +## Properties + +### `Optional` signature + +• **signature**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:1092_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1092) + +acknowledgement signature + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1088_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1088) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.disablefeatureprocedureargs.md b/docs/api/external-modules/_types_index_.disablefeatureprocedureargs.md new file mode 100644 index 0000000..8846c05 --- /dev/null +++ b/docs/api/external-modules/_types_index_.disablefeatureprocedureargs.md @@ -0,0 +1,33 @@ +# DisableFeatureProcedureArgs + +Arguments for the [DisableFeature](../enums/_types_index_.proceduretype.md#disablefeature) Procedure + +## Hierarchy + +* **DisableFeatureProcedureArgs** + +## Index + +### Properties + +* [moduleName](../interfaces/_types_index_.disablefeatureprocedureargs.md#modulename) +* [symbol](../interfaces/_types_index_.disablefeatureprocedureargs.md#symbol) + +## Properties + +### moduleName + +• **moduleName**: _ModuleName_ + +_Defined in_ [_src/types/index.ts:496_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L496) + +name of the Module that will be disabled + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:492_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L492) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.dividendtokenholderstatus.md b/docs/api/external-modules/_types_index_.dividendtokenholderstatus.md new file mode 100644 index 0000000..8106f31 --- /dev/null +++ b/docs/api/external-modules/_types_index_.dividendtokenholderstatus.md @@ -0,0 +1,69 @@ +# DividendTokenholderStatus + +Status of a Tokenholder in regards to a Dividend Distribution + +## Hierarchy + +* **DividendTokenholderStatus** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.dividendtokenholderstatus.md#address) +* [amountReceived](../interfaces/_types_index_.dividendtokenholderstatus.md#amountreceived) +* [balance](../interfaces/_types_index_.dividendtokenholderstatus.md#balance) +* [excluded](../interfaces/_types_index_.dividendtokenholderstatus.md#excluded) +* [paymentReceived](../interfaces/_types_index_.dividendtokenholderstatus.md#paymentreceived) +* [withheldTax](../interfaces/_types_index_.dividendtokenholderstatus.md#withheldtax) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L27) + +wallet address of the Tokenholder + +### amountReceived + +• **amountReceived**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L43) + +the amount of tokens the Tokenholder has received as Dividend payment + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L47) + +the balance of the Tokenholder + +### excluded + +• **excluded**: _boolean_ + +_Defined in_ [_src/types/index.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L35) + +whether the Tokenholder is excluded from the Dividend distribution + +### paymentReceived + +• **paymentReceived**: _boolean_ + +_Defined in_ [_src/types/index.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L31) + +whether the Tokenholder has received payment + +### withheldTax + +• **withheldTax**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L39) + +amount of tokens withheld for tax purposes + diff --git a/docs/api/external-modules/_types_index_.enablecounttransfermanagerprocedureargs.md b/docs/api/external-modules/_types_index_.enablecounttransfermanagerprocedureargs.md new file mode 100644 index 0000000..8222d43 --- /dev/null +++ b/docs/api/external-modules/_types_index_.enablecounttransfermanagerprocedureargs.md @@ -0,0 +1,33 @@ +# EnableCountTransferManagerProcedureArgs + +Arguments for the [EnableCountTransferManager](../enums/_types_index_.proceduretype.md#enablecounttransfermanager) Procedure + +## Hierarchy + +* **EnableCountTransferManagerProcedureArgs** + +## Index + +### Properties + +* [maxHolderCount](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md#maxholdercount) +* [symbol](../interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md#symbol) + +## Properties + +### maxHolderCount + +• **maxHolderCount**: _number_ + +_Defined in_ [_src/types/index.ts:463_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L463) + +maximum number of simultaneous token holders + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:459_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L459) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.enabledividendmanagerprocedureargs.md b/docs/api/external-modules/_types_index_.enabledividendmanagerprocedureargs.md new file mode 100644 index 0000000..058da58 --- /dev/null +++ b/docs/api/external-modules/_types_index_.enabledividendmanagerprocedureargs.md @@ -0,0 +1,33 @@ +# EnableDividendManagerProcedureArgs + +Arguments for the [EnableDividendManager](../enums/_types_index_.proceduretype.md#enabledividendmanager) Procedure + +## Hierarchy + +* **EnableDividendManagerProcedureArgs** + +## Index + +### Properties + +* [storageWalletAddress](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md#storagewalletaddress) +* [symbol](../interfaces/_types_index_.enabledividendmanagerprocedureargs.md#symbol) + +## Properties + +### storageWalletAddress + +• **storageWalletAddress**: _string_ + +_Defined in_ [_src/types/index.ts:429_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L429) + +storage wallet where Dividends funds will be stored + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:425_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L425) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.enablegeneralpermissionmanagerprocedureargs.md b/docs/api/external-modules/_types_index_.enablegeneralpermissionmanagerprocedureargs.md new file mode 100644 index 0000000..50012e1 --- /dev/null +++ b/docs/api/external-modules/_types_index_.enablegeneralpermissionmanagerprocedureargs.md @@ -0,0 +1,24 @@ +# EnableGeneralPermissionManagerProcedureArgs + +Arguments for the [EnableGeneralPermissionManager](../enums/_types_index_.proceduretype.md#enablegeneralpermissionmanager) Procedure + +## Hierarchy + +* **EnableGeneralPermissionManagerProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:439_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L439) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.enablegeneraltransfermanagerprocedureargs.md b/docs/api/external-modules/_types_index_.enablegeneraltransfermanagerprocedureargs.md new file mode 100644 index 0000000..8c3f54c --- /dev/null +++ b/docs/api/external-modules/_types_index_.enablegeneraltransfermanagerprocedureargs.md @@ -0,0 +1,24 @@ +# EnableGeneralTransferManagerProcedureArgs + +Arguments for the [EnableGeneralTransferManager](../enums/_types_index_.proceduretype.md#enablegeneraltransfermanager) Procedure + +## Hierarchy + +* **EnableGeneralTransferManagerProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:449_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L449) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.enablepercentagetransfermanagerprocedureargs.md b/docs/api/external-modules/_types_index_.enablepercentagetransfermanagerprocedureargs.md new file mode 100644 index 0000000..0e721b1 --- /dev/null +++ b/docs/api/external-modules/_types_index_.enablepercentagetransfermanagerprocedureargs.md @@ -0,0 +1,42 @@ +# EnablePercentageTransferManagerProcedureArgs + +Arguments for the [EnablePercentageTransferManager](../enums/_types_index_.proceduretype.md#enablepercentagetransfermanager) Procedure + +## Hierarchy + +* **EnablePercentageTransferManagerProcedureArgs** + +## Index + +### Properties + +* [allowPrimaryIssuance](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md#optional-allowprimaryissuance) +* [maxHolderPercentage](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md#maxholderpercentage) +* [symbol](../interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md#symbol) + +## Properties + +### `Optional` allowPrimaryIssuance + +• **allowPrimaryIssuance**? : _undefined \| false \| true_ + +_Defined in_ [_src/types/index.ts:482_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L482) + +whether primary issuance is exempted from percentage restrictions. If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions + +### maxHolderPercentage + +• **maxHolderPercentage**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:477_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L477) + +maximum percentage of the total supply a single token holder can hold + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:473_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L473) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.errorcode.md b/docs/api/external-modules/_types_index_.errorcode.md new file mode 100644 index 0000000..c11fd7e --- /dev/null +++ b/docs/api/external-modules/_types_index_.errorcode.md @@ -0,0 +1,137 @@ +# ErrorCode + +Specifies possible types of errors in the SDK + +## Index + +### Enumeration members + +* [FatalError](../enums/_types_index_.errorcode.md#fatalerror) +* [FeatureNotEnabled](../enums/_types_index_.errorcode.md#featurenotenabled) +* [FetcherValidationError](../enums/_types_index_.errorcode.md#fetchervalidationerror) +* [IncompatibleBrowser](../enums/_types_index_.errorcode.md#incompatiblebrowser) +* [IncorrectVersion](../enums/_types_index_.errorcode.md#incorrectversion) +* [InexistentModule](../enums/_types_index_.errorcode.md#inexistentmodule) +* [InsufficientBalance](../enums/_types_index_.errorcode.md#insufficientbalance) +* [InvalidAddress](../enums/_types_index_.errorcode.md#invalidaddress) +* [InvalidUuid](../enums/_types_index_.errorcode.md#invaliduuid) +* [MetamaskNotInstalled](../enums/_types_index_.errorcode.md#metamasknotinstalled) +* [NonBrowserEnvironment](../enums/_types_index_.errorcode.md#nonbrowserenvironment) +* [ProcedureValidationError](../enums/_types_index_.errorcode.md#procedurevalidationerror) +* [TransactionRejectedByUser](../enums/_types_index_.errorcode.md#transactionrejectedbyuser) +* [TransactionReverted](../enums/_types_index_.errorcode.md#transactionreverted) +* [UnexpectedEventLogs](../enums/_types_index_.errorcode.md#unexpectedeventlogs) +* [UnexpectedReturnData](../enums/_types_index_.errorcode.md#unexpectedreturndata) +* [UserDeniedAccess](../enums/_types_index_.errorcode.md#userdeniedaccess) +* [WalletIsLocked](../enums/_types_index_.errorcode.md#walletislocked) + +## Enumeration members + +### FatalError + +• **FatalError**: = "FatalError" + +_Defined in_ [_src/types/index.ts:108_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L108) + +### FeatureNotEnabled + +• **FeatureNotEnabled**: = "FeatureNotEnabled" + +_Defined in_ [_src/types/index.ts:99_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L99) + +### FetcherValidationError + +• **FetcherValidationError**: = "FetcherValidationError" + +_Defined in_ [_src/types/index.ts:105_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L105) + +### IncompatibleBrowser + +• **IncompatibleBrowser**: = "IncompatibleBrowser" + +_Defined in_ [_src/types/index.ts:98_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L98) + +### IncorrectVersion + +• **IncorrectVersion**: = "IncorrectVersion" + +_Defined in_ [_src/types/index.ts:115_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L115) + +### InexistentModule + +• **InexistentModule**: = "InexistentModule" + +_Defined in_ [_src/types/index.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L114) + +### InsufficientBalance + +• **InsufficientBalance**: = "InsufficientBalance" + +_Defined in_ [_src/types/index.ts:113_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L113) + +### InvalidAddress + +• **InvalidAddress**: = "InvalidAddress" + +_Defined in_ [_src/types/index.ts:112_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L112) + +### InvalidUuid + +• **InvalidUuid**: = "InvalidUuid" + +_Defined in_ [_src/types/index.ts:111_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L111) + +### MetamaskNotInstalled + +• **MetamaskNotInstalled**: = "MetamaskNotInstalled" + +_Defined in_ [_src/types/index.ts:101_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L101) + +### NonBrowserEnvironment + +• **NonBrowserEnvironment**: = "NonBrowserEnvironment" + +_Defined in_ [_src/types/index.ts:100_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L100) + +### ProcedureValidationError + +• **ProcedureValidationError**: = "ProcedureValidationError" + +_Defined in_ [_src/types/index.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L104) + +### TransactionRejectedByUser + +• **TransactionRejectedByUser**: = "TransactionRejectedByUser" + +_Defined in_ [_src/types/index.ts:106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L106) + +### TransactionReverted + +• **TransactionReverted**: = "TransactionReverted" + +_Defined in_ [_src/types/index.ts:107_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L107) + +### UnexpectedEventLogs + +• **UnexpectedEventLogs**: = "UnexpectedEventLogs" + +_Defined in_ [_src/types/index.ts:110_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L110) + +### UnexpectedReturnData + +• **UnexpectedReturnData**: = "UnexpectedReturnData" + +_Defined in_ [_src/types/index.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L109) + +### UserDeniedAccess + +• **UserDeniedAccess**: = "UserDeniedAccess" + +_Defined in_ [_src/types/index.ts:102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L102) + +### WalletIsLocked + +• **WalletIsLocked**: = "WalletIsLocked" + +_Defined in_ [_src/types/index.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L103) + diff --git a/docs/api/external-modules/_types_index_.feature.md b/docs/api/external-modules/_types_index_.feature.md new file mode 100644 index 0000000..9dda6ec --- /dev/null +++ b/docs/api/external-modules/_types_index_.feature.md @@ -0,0 +1,44 @@ +# Feature + +## Index + +### Enumeration members + +* [Dividends](../enums/_types_index_.feature.md#dividends) +* [PercentageOwnershipRestrictions](../enums/_types_index_.feature.md#percentageownershiprestrictions) +* [Permissions](../enums/_types_index_.feature.md#permissions) +* [TokenholderCountRestrictions](../enums/_types_index_.feature.md#tokenholdercountrestrictions) +* [Tokenholders](../enums/_types_index_.feature.md#tokenholders) + +## Enumeration members + +### Dividends + +• **Dividends**: = "Dividends" + +_Defined in_ [_src/types/index.ts:1451_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1451) + +### PercentageOwnershipRestrictions + +• **PercentageOwnershipRestrictions**: = "PercentageOwnershipRestrictions" + +_Defined in_ [_src/types/index.ts:1453_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1453) + +### Permissions + +• **Permissions**: = "Permissions" + +_Defined in_ [_src/types/index.ts:1449_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1449) + +### TokenholderCountRestrictions + +• **TokenholderCountRestrictions**: = "TokenholderCountRestrictions" + +_Defined in_ [_src/types/index.ts:1452_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1452) + +### Tokenholders + +• **Tokenholders**: = "Tokenholders" + +_Defined in_ [_src/types/index.ts:1450_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1450) + diff --git a/docs/api/external-modules/_types_index_.fees.md b/docs/api/external-modules/_types_index_.fees.md new file mode 100644 index 0000000..32b9f51 --- /dev/null +++ b/docs/api/external-modules/_types_index_.fees.md @@ -0,0 +1,33 @@ +# Fees + +Fees associated with running a [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md) + +## Hierarchy + +* **Fees** + +## Index + +### Properties + +* [poly](../interfaces/_types_index_.fees.md#poly) +* [usd](../interfaces/_types_index_.fees.md#usd) + +## Properties + +### poly + +• **poly**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:1409_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1409) + +fees expressed in POLY + +### usd + +• **usd**: _BigNumber \| null_ + +_Defined in_ [_src/types/index.ts:1405_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1405) + +fees expressed in USD. Can be null if the Smart Contract doesn't specify one + diff --git a/docs/api/external-modules/_types_index_.finalizestoprocedureargs.md b/docs/api/external-modules/_types_index_.finalizestoprocedureargs.md new file mode 100644 index 0000000..93b0662 --- /dev/null +++ b/docs/api/external-modules/_types_index_.finalizestoprocedureargs.md @@ -0,0 +1,40 @@ +# FinalizeStoProcedureArgs + +Arguments for the [FinalizeSto](../enums/_types_index_.proceduretype.md#finalizesto) Procedure + +## Hierarchy + +* **FinalizeStoProcedureArgs** + +## Index + +### Properties + +* [stoAddress](../interfaces/_types_index_.finalizestoprocedureargs.md#stoaddress) +* [stoType](../interfaces/_types_index_.finalizestoprocedureargs.md#stotype) +* [symbol](../interfaces/_types_index_.finalizestoprocedureargs.md#symbol) + +## Properties + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:1013_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1013) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/types/index.ts:1017_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1017) + +type of the STO \(Simple, Tiered, etc\) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1012_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1012) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.freezeissuanceprocedureargs.md b/docs/api/external-modules/_types_index_.freezeissuanceprocedureargs.md new file mode 100644 index 0000000..b2283fb --- /dev/null +++ b/docs/api/external-modules/_types_index_.freezeissuanceprocedureargs.md @@ -0,0 +1,33 @@ +# FreezeIssuanceProcedureArgs + +Arguments for the [FreezeIssuance](../enums/_types_index_.proceduretype.md#freezeissuance) Procedure + +## Hierarchy + +* **FreezeIssuanceProcedureArgs** + +## Index + +### Properties + +* [signature](../interfaces/_types_index_.freezeissuanceprocedureargs.md#optional-signature) +* [symbol](../interfaces/_types_index_.freezeissuanceprocedureargs.md#symbol) + +## Properties + +### `Optional` signature + +• **signature**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:1078_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1078) + +acknowledgement signature + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1074_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1074) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.futurelowlevelmethod.md b/docs/api/external-modules/_types_index_.futurelowlevelmethod.md new file mode 100644 index 0000000..e848f23 --- /dev/null +++ b/docs/api/external-modules/_types_index_.futurelowlevelmethod.md @@ -0,0 +1,53 @@ +# FutureLowLevelMethod + +Represents a contract method that doesn't exist yet but will exist once a certain post transaction resolver is resolved + +## Type parameters + +▪ **T** + +type of the value that will be resolved by the post transaction resolver + +▪ **U** + +type of the arguments object that the future method will accept + +## Hierarchy + +* **FutureLowLevelMethod** + +## Index + +### Properties + +* [futureMethod](../interfaces/_types_index_.futurelowlevelmethod.md#futuremethod) +* [futureValue](../interfaces/_types_index_.futurelowlevelmethod.md#futurevalue) + +## Properties + +### futureMethod + +• **futureMethod**: _function_ + +_Defined in_ [_src/types/index.ts:1519_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1519) + +function that returns a low level method + +#### Type declaration: + +▸ \(`resolvedValue`: T\): _Promise‹_[_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹U››_ + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `resolvedValue` | T | + +### futureValue + +• **futureValue**: _PostTransactionResolver‹T›_ + +_Defined in_ [_src/types/index.ts:1523_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1523) + +post transaction resolver that resolves into the value that is passed to the future method + diff --git a/docs/api/external-modules/_types_index_.investinsimplestoprocedureargs.md b/docs/api/external-modules/_types_index_.investinsimplestoprocedureargs.md new file mode 100644 index 0000000..9678d9b --- /dev/null +++ b/docs/api/external-modules/_types_index_.investinsimplestoprocedureargs.md @@ -0,0 +1,51 @@ +# InvestInSimpleStoProcedureArgs + +Arguments for the [InvestInSimpleSto](../enums/_types_index_.proceduretype.md#investinsimplesto) Procedure + +## Hierarchy + +* **InvestInSimpleStoProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.investinsimplestoprocedureargs.md#amount) +* [beneficiary](../interfaces/_types_index_.investinsimplestoprocedureargs.md#optional-beneficiary) +* [stoAddress](../interfaces/_types_index_.investinsimplestoprocedureargs.md#stoaddress) +* [symbol](../interfaces/_types_index_.investinsimplestoprocedureargs.md#symbol) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:680_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L680) + +amount to invest + +### `Optional` beneficiary + +• **beneficiary**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:684_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L684) + +if specified, the investment will be made on behalf of this address + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:676_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L676) + +address of the STO + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:672_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L672) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.investintieredstobaseprocedureargs.md b/docs/api/external-modules/_types_index_.investintieredstobaseprocedureargs.md new file mode 100644 index 0000000..3e2c327 --- /dev/null +++ b/docs/api/external-modules/_types_index_.investintieredstobaseprocedureargs.md @@ -0,0 +1,69 @@ +# InvestInTieredStoBaseProcedureArgs + +## Hierarchy + +* **InvestInTieredStoBaseProcedureArgs** + + ↳ [InvestWithStableCoinArgs](../interfaces/_types_index_.investwithstablecoinargs.md) + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#amount) +* [beneficiary](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#optional-beneficiary) +* [currency](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#currency) +* [minTokens](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#optional-mintokens) +* [stoAddress](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#stoaddress) +* [symbol](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#symbol) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:628_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628) + +amount to invest + +### `Optional` beneficiary + +• **beneficiary**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:641_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641) + +if specified, the investment will be made on behalf of this address + +### currency + +• **currency**: _Currency_ + +_Defined in_ [_src/types/index.ts:632_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L632) + +currency type in which the investment is being made + +### `Optional` minTokens + +• **minTokens**? : _BigNumber_ + +_Defined in_ [_src/types/index.ts:637_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637) + +minimum amount of Security Tokens that should be bought. If, because of price fluctuations, a lower amount is being bought, the transaction will revert + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:624_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624) + +address of the STO + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:620_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.investwithstablecoinargs.md b/docs/api/external-modules/_types_index_.investwithstablecoinargs.md new file mode 100644 index 0000000..4f91014 --- /dev/null +++ b/docs/api/external-modules/_types_index_.investwithstablecoinargs.md @@ -0,0 +1,86 @@ +# InvestWithStableCoinArgs + +## Hierarchy + +* [InvestInTieredStoBaseProcedureArgs](../interfaces/_types_index_.investintieredstobaseprocedureargs.md) + + ↳ **InvestWithStableCoinArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.investwithstablecoinargs.md#amount) +* [beneficiary](../interfaces/_types_index_.investwithstablecoinargs.md#optional-beneficiary) +* [currency](../interfaces/_types_index_.investwithstablecoinargs.md#currency) +* [minTokens](../interfaces/_types_index_.investwithstablecoinargs.md#optional-mintokens) +* [stableCoinAddress](../interfaces/_types_index_.investwithstablecoinargs.md#stablecoinaddress) +* [stoAddress](../interfaces/_types_index_.investwithstablecoinargs.md#stoaddress) +* [symbol](../interfaces/_types_index_.investwithstablecoinargs.md#symbol) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_amount_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#amount) + +_Defined in_ [_src/types/index.ts:628_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628) + +amount to invest + +### `Optional` beneficiary + +• **beneficiary**? : _undefined \| string_ + +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_beneficiary_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#optional-beneficiary) + +_Defined in_ [_src/types/index.ts:641_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641) + +if specified, the investment will be made on behalf of this address + +### currency + +• **currency**: _Currency.StableCoin_ + +_Overrides_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_currency_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#currency) + +_Defined in_ [_src/types/index.ts:645_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L645) + +### `Optional` minTokens + +• **minTokens**? : _BigNumber_ + +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_minTokens_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#optional-mintokens) + +_Defined in_ [_src/types/index.ts:637_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637) + +minimum amount of Security Tokens that should be bought. If, because of price fluctuations, a lower amount is being bought, the transaction will revert + +### stableCoinAddress + +• **stableCoinAddress**: _string_ + +_Defined in_ [_src/types/index.ts:646_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L646) + +### stoAddress + +• **stoAddress**: _string_ + +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_stoAddress_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#stoaddress) + +_Defined in_ [_src/types/index.ts:624_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624) + +address of the STO + +### symbol + +• **symbol**: _string_ + +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md)_._[_symbol_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md#symbol) + +_Defined in_ [_src/types/index.ts:620_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.issuancedataentry.md b/docs/api/external-modules/_types_index_.issuancedataentry.md new file mode 100644 index 0000000..2aec931 --- /dev/null +++ b/docs/api/external-modules/_types_index_.issuancedataentry.md @@ -0,0 +1,42 @@ +# IssuanceDataEntry + +Specifies how many tokens to issue and who to issue them to + +## Hierarchy + +* **IssuanceDataEntry** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.issuancedataentry.md#address) +* [amount](../interfaces/_types_index_.issuancedataentry.md#amount) +* [tokenholderData](../interfaces/_types_index_.issuancedataentry.md#optional-tokenholderdata) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L83) + +wallet address where Tokens will be received + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L87) + +amount of tokens to be issued + +### `Optional` tokenholderData + +• **tokenholderData**? : [_Omit_](_types_index_.md#omit)_‹_[_TokenholderDataEntry_](../interfaces/_types_index_.tokenholderdataentry.md)_, "address"›_ + +_Defined in_ [_src/types/index.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L91) + +KYC data for the Tokenholder + diff --git a/docs/api/external-modules/_types_index_.issuetokensprocedureargs.md b/docs/api/external-modules/_types_index_.issuetokensprocedureargs.md new file mode 100644 index 0000000..2a38d95 --- /dev/null +++ b/docs/api/external-modules/_types_index_.issuetokensprocedureargs.md @@ -0,0 +1,33 @@ +# IssueTokensProcedureArgs + +Arguments for the [IssueTokens](../enums/_types_index_.proceduretype.md#issuetokens) Procedure + +## Hierarchy + +* **IssueTokensProcedureArgs** + +## Index + +### Properties + +* [issuanceData](../interfaces/_types_index_.issuetokensprocedureargs.md#issuancedata) +* [symbol](../interfaces/_types_index_.issuetokensprocedureargs.md#symbol) + +## Properties + +### issuanceData + +• **issuanceData**: [_IssuanceDataEntry_](../interfaces/_types_index_.issuancedataentry.md)_\[\]_ + +_Defined in_ [_src/types/index.ts:553_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L553) + +array of entries that specify who to issue tokens to and the amounts + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:549_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L549) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.launchsimplestoprocedureargs.md b/docs/api/external-modules/_types_index_.launchsimplestoprocedureargs.md new file mode 100644 index 0000000..75f5c58 --- /dev/null +++ b/docs/api/external-modules/_types_index_.launchsimplestoprocedureargs.md @@ -0,0 +1,96 @@ +# LaunchSimpleStoProcedureArgs + +Arguments for the [LaunchSimpleSto](../enums/_types_index_.proceduretype.md#launchsimplesto) Procedure + +## Hierarchy + +* **LaunchSimpleStoProcedureArgs** + +## Index + +### Properties + +* [allowPreIssuing](../interfaces/_types_index_.launchsimplestoprocedureargs.md#optional-allowpreissuing) +* [currency](../interfaces/_types_index_.launchsimplestoprocedureargs.md#currency) +* [endDate](../interfaces/_types_index_.launchsimplestoprocedureargs.md#enddate) +* [raisedFundsWallet](../interfaces/_types_index_.launchsimplestoprocedureargs.md#raisedfundswallet) +* [rate](../interfaces/_types_index_.launchsimplestoprocedureargs.md#rate) +* [startDate](../interfaces/_types_index_.launchsimplestoprocedureargs.md#startdate) +* [symbol](../interfaces/_types_index_.launchsimplestoprocedureargs.md#symbol) +* [tokensOnSale](../interfaces/_types_index_.launchsimplestoprocedureargs.md#tokensonsale) +* [unsoldTokensWallet](../interfaces/_types_index_.launchsimplestoprocedureargs.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuing + +• **allowPreIssuing**? : _undefined \| false \| true_ + +_Defined in_ [_src/types/index.ts:539_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L539) + +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false + +### currency + +• **currency**: _Currency.ETH \| Currency.POLY_ + +_Defined in_ [_src/types/index.ts:526_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L526) + +currency for the Simple STO fund raise + +### endDate + +• **endDate**: _Date_ + +_Defined in_ [_src/types/index.ts:514_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L514) + +end date of the STO + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Defined in_ [_src/types/index.ts:530_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L530) + +wallet to which raised funds will be sent + +### rate + +• **rate**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:522_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L522) + +amount of tokens sold per unit of currency + +### startDate + +• **startDate**: _Date_ + +_Defined in_ [_src/types/index.ts:510_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L510) + +start date of the STO + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:506_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L506) + +symbol of the Security Token + +### tokensOnSale + +• **tokensOnSale**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:518_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L518) + +number of tokens that will be sold + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Defined in_ [_src/types/index.ts:534_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L534) + +wallet to which unsold tokens will be sent if the STO expires + diff --git a/docs/api/external-modules/_types_index_.launchtieredstoprocedureargs.md b/docs/api/external-modules/_types_index_.launchtieredstoprocedureargs.md new file mode 100644 index 0000000..6c39ff2 --- /dev/null +++ b/docs/api/external-modules/_types_index_.launchtieredstoprocedureargs.md @@ -0,0 +1,123 @@ +# LaunchTieredStoProcedureArgs + +Arguments for the [LaunchTieredSto](../enums/_types_index_.proceduretype.md#launchtieredsto) Procedure + +## Hierarchy + +* **LaunchTieredStoProcedureArgs** + +## Index + +### Properties + +* [allowPreIssuing](../interfaces/_types_index_.launchtieredstoprocedureargs.md#optional-allowpreissuing) +* [currencies](../interfaces/_types_index_.launchtieredstoprocedureargs.md#currencies) +* [customCurrency](../interfaces/_types_index_.launchtieredstoprocedureargs.md#optional-customcurrency) +* [endDate](../interfaces/_types_index_.launchtieredstoprocedureargs.md#enddate) +* [minimumInvestment](../interfaces/_types_index_.launchtieredstoprocedureargs.md#minimuminvestment) +* [nonAccreditedInvestmentLimit](../interfaces/_types_index_.launchtieredstoprocedureargs.md#nonaccreditedinvestmentlimit) +* [raisedFundsWallet](../interfaces/_types_index_.launchtieredstoprocedureargs.md#raisedfundswallet) +* [stableCoinAddresses](../interfaces/_types_index_.launchtieredstoprocedureargs.md#optional-stablecoinaddresses) +* [startDate](../interfaces/_types_index_.launchtieredstoprocedureargs.md#startdate) +* [symbol](../interfaces/_types_index_.launchtieredstoprocedureargs.md#symbol) +* [tiers](../interfaces/_types_index_.launchtieredstoprocedureargs.md#tiers) +* [unsoldTokensWallet](../interfaces/_types_index_.launchtieredstoprocedureargs.md#unsoldtokenswallet) + +## Properties + +### `Optional` allowPreIssuing + +• **allowPreIssuing**? : _undefined \| false \| true_ + +_Defined in_ [_src/types/index.ts:791_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L791) + +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false + +### currencies + +• **currencies**: _Currency\[\]_ + +_Defined in_ [_src/types/index.ts:769_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L769) + +currencies with which Security Tokens can be purchased in the STO + +### `Optional` customCurrency + +• **customCurrency**? : _Partial‹_[_CustomCurrency_](../interfaces/_types_index_.customcurrency.md)_›_ + +_Defined in_ [_src/types/index.ts:786_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L786) + +if raising in Stable Coin, this parameter can be used to specify a currency different than USD for the STO to be pegged in + +### endDate + +• **endDate**: _Date_ + +_Defined in_ [_src/types/index.ts:753_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L753) + +end date of the STO + +### minimumInvestment + +• **minimumInvestment**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:765_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L765) + +minimum amount that can be invested by any investor + +### nonAccreditedInvestmentLimit + +• **nonAccreditedInvestmentLimit**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:761_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L761) + +maximum amount that can be invested by non accredited investors + +### raisedFundsWallet + +• **raisedFundsWallet**: _string_ + +_Defined in_ [_src/types/index.ts:773_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L773) + +wallet where raised funds will be sent + +### `Optional` stableCoinAddresses + +• **stableCoinAddresses**? : _string\[\]_ + +_Defined in_ [_src/types/index.ts:781_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L781) + +list of the addresses of the Stable Coins that can be used to purchase Security Tokens in the STO + +### startDate + +• **startDate**: _Date_ + +_Defined in_ [_src/types/index.ts:749_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L749) + +start date of the STO + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:745_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L745) + +symbol of the Security Token + +### tiers + +• **tiers**: [_StoTier_](../interfaces/_types_index_.stotier.md)_\[\]_ + +_Defined in_ [_src/types/index.ts:757_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L757) + +array of Tier information + +### unsoldTokensWallet + +• **unsoldTokensWallet**: _string_ + +_Defined in_ [_src/types/index.ts:777_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L777) + +wallet where unsold tokens will be sent if the STO expires + diff --git a/docs/api/modules/_types_index_.md b/docs/api/external-modules/_types_index_.md similarity index 74% rename from docs/api/modules/_types_index_.md rename to docs/api/external-modules/_types_index_.md index 397aaaa..c9baebd 100644 --- a/docs/api/modules/_types_index_.md +++ b/docs/api/external-modules/_types_index_.md @@ -1,4 +1,4 @@ -# External module: "types/index" +# types/index ## Index @@ -100,160 +100,143 @@ ## Type aliases -### InvestInTieredStoProcedureArgs +### InvestInTieredStoProcedureArgs -Ƭ **InvestInTieredStoProcedureArgs**: *[InvestInTieredStoBaseProcedureArgs](../interfaces/_types_index_.investintieredstobaseprocedureargs.md) & object | [InvestWithStableCoinArgs](../interfaces/_types_index_.investwithstablecoinargs.md)* +Ƭ **InvestInTieredStoProcedureArgs**: [_InvestInTieredStoBaseProcedureArgs_](../interfaces/_types_index_.investintieredstobaseprocedureargs.md) _& object \|_ [_InvestWithStableCoinArgs_](../interfaces/_types_index_.investwithstablecoinargs.md) -*Defined in [src/types/index.ts:652](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L652)* +_Defined in_ [_src/types/index.ts:652_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L652) Arguments for the [InvestInTieredSto](../enums/_types_index_.proceduretype.md#investintieredsto) Procedure -___ +### LowLevelMethod -### LowLevelMethod +Ƭ **LowLevelMethod**: _function_ -Ƭ **LowLevelMethod**: *function* - -*Defined in [src/types/index.ts:1499](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1499)* +_Defined in_ [_src/types/index.ts:1499_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1499) Transaction method from the contract-wrappers package #### Type declaration: -▸ (`args`: A): *Promise‹PolyResponse›* +▸ \(`args`: A\): _Promise‹PolyResponse›_ **Parameters:** -Name | Type | ------- | ------ | -`args` | A | - -___ +| Name | Type | +| :--- | :--- | +| `args` | A | -### MapMaybeResolver +### MapMaybeResolver -Ƭ **MapMaybeResolver**: *object* +Ƭ **MapMaybeResolver**: _object_ -*Defined in [src/types/index.ts:1550](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1550)* +_Defined in_ [_src/types/index.ts:1550_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1550) Apply the MaybeResolver type to a tuple of types #### Type declaration: -___ - -### MaybeResolver +### MaybeResolver -Ƭ **MaybeResolver**: *PostTransactionResolver‹T, any› | T* +Ƭ **MaybeResolver**: _PostTransactionResolver‹T, any› \| T_ -*Defined in [src/types/index.ts:1545](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1545)* +_Defined in_ [_src/types/index.ts:1545_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1545) Either a specific type or a Post Transaction Resolver that resolves to that type -___ +### Omit -### Omit +Ƭ **Omit**: _Pick‹T, Exclude‹keyof T, K››_ -Ƭ **Omit**: *Pick‹T, Exclude‹keyof T, K››* - -*Defined in [src/types/index.ts:1492](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1492)* +_Defined in_ [_src/types/index.ts:1492_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1492) Return the type that results from excluding a property from another type -___ - -### PostTransactionResolverArray +### PostTransactionResolverArray -Ƭ **PostTransactionResolverArray**: *object* +Ƭ **PostTransactionResolverArray**: _object_ -*Defined in [src/types/index.ts:1538](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1538)* +_Defined in_ [_src/types/index.ts:1538_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1538) Transforms a tuple of types into an array of Post Transaction Resolvers. For each type in the tuple, the corresponding Post Transaction Resolver resolves to that type #### Type declaration: -___ +### ResolverArray -### ResolverArray +Ƭ **ResolverArray**: _object_ -Ƭ **ResolverArray**: *object* - -*Defined in [src/types/index.ts:1529](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1529)* +_Defined in_ [_src/types/index.ts:1529_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1529) Transforms a tuple of types into an array of resolver functions. For each type in the tuple, the corresponding resolver function returns that type wrapped in a promise #### Type declaration: -___ - -### SignatureRequest +### SignatureRequest -Ƭ **SignatureRequest**: *function* +Ƭ **SignatureRequest**: _function_ -*Defined in [src/types/index.ts:1506](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1506)* +_Defined in_ [_src/types/index.ts:1506_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1506) Signature request method from the contract-wrappers package #### Type declaration: -▸ (`args`: A): *Promise‹string›* +▸ \(`args`: A\): _Promise‹string›_ **Parameters:** -Name | Type | ------- | ------ | -`args` | A | +| Name | Type | +| :--- | :--- | +| `args` | A | ## Functions -### isInvestWithStableCoinArgs +### isInvestWithStableCoinArgs -▸ **isInvestWithStableCoinArgs**(`args`: any): *args is InvestWithStableCoinArgs* +▸ **isInvestWithStableCoinArgs**\(`args`: any\): _args is InvestWithStableCoinArgs_ -*Defined in [src/types/index.ts:690](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L690)* +_Defined in_ [_src/types/index.ts:690_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L690) Check whether the arguments are of type [InvestWithStableCoinArgs](../interfaces/_types_index_.investwithstablecoinargs.md) **Parameters:** -Name | Type | ------- | ------ | -`args` | any | - -**Returns:** *args is InvestWithStableCoinArgs* +| Name | Type | +| :--- | :--- | +| `args` | any | -___ +**Returns:** _args is InvestWithStableCoinArgs_ -### isPojo +### isPojo -▸ **isPojo**(`pojo`: any): *pojo is Pojo* +▸ **isPojo**\(`pojo`: any\): _pojo is Pojo_ -*Defined in [src/types/index.ts:1427](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1427)* +_Defined in_ [_src/types/index.ts:1427_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1427) -Check to see if an object is a Plain Old Javascript Object (POJO) +Check to see if an object is a Plain Old Javascript Object \(POJO\) **Parameters:** -Name | Type | ------- | ------ | -`pojo` | any | +| Name | Type | +| :--- | :--- | +| `pojo` | any | -**Returns:** *pojo is Pojo* +**Returns:** _pojo is Pojo_ -___ +### isStoType -### isStoType +▸ **isStoType**\(`type`: any\): _type is StoType_ -▸ **isStoType**(`type`: any): *type is StoType* +_Defined in_ [_src/types/index.ts:58_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L58) -*Defined in [src/types/index.ts:58](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L58)* - -Check if the argument is of type [[STOType]] +Check if the argument is of type \[\[STOType\]\] **Parameters:** -Name | Type | ------- | ------ | -`type` | any | +| Name | Type | +| :--- | :--- | +| `type` | any | + +**Returns:** _type is StoType_ -**Returns:** *type is StoType* diff --git a/docs/api/external-modules/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md b/docs/api/external-modules/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md new file mode 100644 index 0000000..ceb1939 --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md @@ -0,0 +1,33 @@ +# ModifyDividendsDefaultExclusionListProcedureArgs + +Arguments for the [ModifyDividendsDefaultExclusionList](../enums/_types_index_.proceduretype.md#modifydividendsdefaultexclusionlist) Procedure + +## Hierarchy + +* **ModifyDividendsDefaultExclusionListProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md#symbol) +* [tokenholderAddresses](../interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md#tokenholderaddresses) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:869_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L869) + +the symbol of the Security Token + +### tokenholderAddresses + +• **tokenholderAddresses**: _string\[\]_ + +_Defined in_ [_src/types/index.ts:874_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L874) + +list of addresses to conform the new default exclusion list. Addresses in this list will not be considered for Dividend Distribution payments + diff --git a/docs/api/external-modules/_types_index_.modifymaxholdercountprocedureargs.md b/docs/api/external-modules/_types_index_.modifymaxholdercountprocedureargs.md new file mode 100644 index 0000000..4ad60e3 --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifymaxholdercountprocedureargs.md @@ -0,0 +1,33 @@ +# ModifyMaxHolderCountProcedureArgs + +Arguments for the [ModifyMaxHolderCount](../enums/_types_index_.proceduretype.md#modifymaxholdercount) Procedure + +## Hierarchy + +* **ModifyMaxHolderCountProcedureArgs** + +## Index + +### Properties + +* [maxHolderCount](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md#maxholdercount) +* [symbol](../interfaces/_types_index_.modifymaxholdercountprocedureargs.md#symbol) + +## Properties + +### maxHolderCount + +• **maxHolderCount**: _number_ + +_Defined in_ [_src/types/index.ts:1192_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1192) + +maximum number of simultaneous token holders + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1188) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.modifymaxholderpercentageprocedureargs.md b/docs/api/external-modules/_types_index_.modifymaxholderpercentageprocedureargs.md new file mode 100644 index 0000000..2276e97 --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifymaxholderpercentageprocedureargs.md @@ -0,0 +1,33 @@ +# ModifyMaxHolderPercentageProcedureArgs + +Arguments for the [ModifyMaxHolderPercentage](../enums/_types_index_.proceduretype.md#modifymaxholderpercentage) Procedure + +## Hierarchy + +* **ModifyMaxHolderPercentageProcedureArgs** + +## Index + +### Properties + +* [maxHolderPercentage](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md#maxholderpercentage) +* [symbol](../interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md#symbol) + +## Properties + +### maxHolderPercentage + +• **maxHolderPercentage**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:1206_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1206) + +maximum percentage of total tokens a single Tokenholder can hold + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1202) + +the symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.modifypercentageexemptionsprocedureargs.md b/docs/api/external-modules/_types_index_.modifypercentageexemptionsprocedureargs.md new file mode 100644 index 0000000..c29af70 --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifypercentageexemptionsprocedureargs.md @@ -0,0 +1,42 @@ +# ModifyPercentageExemptionsProcedureArgs + +Arguments for the [ModifyPercentageExemptions](../enums/_types_index_.proceduretype.md#modifypercentageexemptions) Procedure + +## Hierarchy + +* **ModifyPercentageExemptionsProcedureArgs** + +## Index + +### Properties + +* [allowPrimaryIssuance](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md#optional-allowprimaryissuance) +* [symbol](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md#symbol) +* [whitelistEntries](../interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md#optional-whitelistentries) + +## Properties + +### `Optional` allowPrimaryIssuance + +• **allowPrimaryIssuance**? : _undefined \| false \| true_ + +_Defined in_ [_src/types/index.ts:1239_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1239) + +whether primary issuance is exempted from percentage restrictions. If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1230) + +symbol of the Security Token + +### `Optional` whitelistEntries + +• **whitelistEntries**? : [_PercentageWhitelistEntry_](../interfaces/_types_index_.percentagewhitelistentry.md)_\[\]_ + +_Defined in_ [_src/types/index.ts:1234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1234) + +list of Tokenholders to add/remove to/from the whitelist + diff --git a/docs/api/external-modules/_types_index_.modifytieredstodataprocedureargs.md b/docs/api/external-modules/_types_index_.modifytieredstodataprocedureargs.md new file mode 100644 index 0000000..de7c9ac --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifytieredstodataprocedureargs.md @@ -0,0 +1,35 @@ +# ModifyTieredStoDataProcedureArgs + +Arguments for the [ModifyTieredStoData](../enums/_types_index_.proceduretype.md#modifytieredstodata) Procedure + +## Hierarchy + +* object + + ↳ **ModifyTieredStoDataProcedureArgs** + +## Index + +### Properties + +* [stoAddress](../interfaces/_types_index_.modifytieredstodataprocedureargs.md#stoaddress) +* [symbol](../interfaces/_types_index_.modifytieredstodataprocedureargs.md#symbol) + +## Properties + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:609_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L609) + +address of the STO + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:613_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L613) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.modifytokenholderdataprocedureargs.md b/docs/api/external-modules/_types_index_.modifytokenholderdataprocedureargs.md new file mode 100644 index 0000000..56ce0d3 --- /dev/null +++ b/docs/api/external-modules/_types_index_.modifytokenholderdataprocedureargs.md @@ -0,0 +1,33 @@ +# ModifyTokenholderDataProcedureArgs + +Arguments for the [ModifyTokenholderData](../enums/_types_index_.proceduretype.md#modifytokenholderdata) Procedure + +## Hierarchy + +* **ModifyTokenholderDataProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md#symbol) +* [tokenholderData](../interfaces/_types_index_.modifytokenholderdataprocedureargs.md#tokenholderdata) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1160) + +symbol of the Security Token + +### tokenholderData + +• **tokenholderData**: [_TokenholderDataEntry_](../interfaces/_types_index_.tokenholderdataentry.md)_\[\]_ + +_Defined in_ [_src/types/index.ts:1164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1164) + +tokenholder KYC data that will be added/modified + diff --git a/docs/api/external-modules/_types_index_.percentagewhitelistentry.md b/docs/api/external-modules/_types_index_.percentagewhitelistentry.md new file mode 100644 index 0000000..e757198 --- /dev/null +++ b/docs/api/external-modules/_types_index_.percentagewhitelistentry.md @@ -0,0 +1,33 @@ +# PercentageWhitelistEntry + +Entry that represents whether a Tokenholder is exempted from Percentage Restrictions + +## Hierarchy + +* **PercentageWhitelistEntry** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.percentagewhitelistentry.md#address) +* [whitelisted](../interfaces/_types_index_.percentagewhitelistentry.md#whitelisted) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:1216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1216) + +Tokenholder wallet address + +### whitelisted + +• **whitelisted**: _boolean_ + +_Defined in_ [_src/types/index.ts:1220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1220) + +whether the address is whitelisted or not + diff --git a/docs/api/external-modules/_types_index_.pojo.md b/docs/api/external-modules/_types_index_.pojo.md new file mode 100644 index 0000000..87a5156 --- /dev/null +++ b/docs/api/external-modules/_types_index_.pojo.md @@ -0,0 +1,10 @@ +# Pojo + +## Hierarchy + +* **Pojo** + +## Indexable + +* \[ **key**: _string_\]: string \| number \| boolean \| null \| [Pojo]() \| BigNumber \| Date \| null \| string \| number \| false \| true \| BigNumber \| Date \| [Pojo]()\[\] + diff --git a/docs/api/external-modules/_types_index_.polytransactiontag.md b/docs/api/external-modules/_types_index_.polytransactiontag.md new file mode 100644 index 0000000..044849c --- /dev/null +++ b/docs/api/external-modules/_types_index_.polytransactiontag.md @@ -0,0 +1,452 @@ +# PolyTransactionTag + +Tag to distinguish transactions for display purposes + +## Index + +### Enumeration members + +* [AddDelegate](../enums/_types_index_.polytransactiontag.md#adddelegate) +* [AllowPreMinting](../enums/_types_index_.polytransactiontag.md#allowpreminting) +* [Any](../enums/_types_index_.polytransactiontag.md#any) +* [ApproveErc20](../enums/_types_index_.polytransactiontag.md#approveerc20) +* [BuyTokens](../enums/_types_index_.polytransactiontag.md#buytokens) +* [BuyTokensWithPoly](../enums/_types_index_.polytransactiontag.md#buytokenswithpoly) +* [BuyWithEthRateLimited](../enums/_types_index_.polytransactiontag.md#buywithethratelimited) +* [BuyWithPolyRateLimited](../enums/_types_index_.polytransactiontag.md#buywithpolyratelimited) +* [BuyWithScRateLimited](../enums/_types_index_.polytransactiontag.md#buywithscratelimited) +* [ChangeAllowBeneficialInvestments](../enums/_types_index_.polytransactiontag.md#changeallowbeneficialinvestments) +* [ChangeHolderCount](../enums/_types_index_.polytransactiontag.md#changeholdercount) +* [ChangeHolderPercentage](../enums/_types_index_.polytransactiontag.md#changeholderpercentage) +* [ChangePermission](../enums/_types_index_.polytransactiontag.md#changepermission) +* [ControllerRedeem](../enums/_types_index_.polytransactiontag.md#controllerredeem) +* [ControllerTransfer](../enums/_types_index_.polytransactiontag.md#controllertransfer) +* [CreateCheckpoint](../enums/_types_index_.polytransactiontag.md#createcheckpoint) +* [CreateErc20DividendDistribution](../enums/_types_index_.polytransactiontag.md#createerc20dividenddistribution) +* [CreateSecurityToken](../enums/_types_index_.polytransactiontag.md#createsecuritytoken) +* [DisableController](../enums/_types_index_.polytransactiontag.md#disablecontroller) +* [DisableFeature](../enums/_types_index_.polytransactiontag.md#disablefeature) +* [EnableCappedSto](../enums/_types_index_.polytransactiontag.md#enablecappedsto) +* [EnableCountTransferManager](../enums/_types_index_.polytransactiontag.md#enablecounttransfermanager) +* [EnableDividends](../enums/_types_index_.polytransactiontag.md#enabledividends) +* [EnableGeneralPermissionManager](../enums/_types_index_.polytransactiontag.md#enablegeneralpermissionmanager) +* [EnableGeneralTransferManager](../enums/_types_index_.polytransactiontag.md#enablegeneraltransfermanager) +* [EnablePercentageTransferManager](../enums/_types_index_.polytransactiontag.md#enablepercentagetransfermanager) +* [EnableTieredSto](../enums/_types_index_.polytransactiontag.md#enabletieredsto) +* [FinalizeSto](../enums/_types_index_.polytransactiontag.md#finalizesto) +* [FreezeIssuance](../enums/_types_index_.polytransactiontag.md#freezeissuance) +* [FreezeTransfers](../enums/_types_index_.polytransactiontag.md#freezetransfers) +* [GetTokens](../enums/_types_index_.polytransactiontag.md#gettokens) +* [IssueMulti](../enums/_types_index_.polytransactiontag.md#issuemulti) +* [ModifyAddresses](../enums/_types_index_.polytransactiontag.md#modifyaddresses) +* [ModifyFunding](../enums/_types_index_.polytransactiontag.md#modifyfunding) +* [ModifyInvestorFlagMulti](../enums/_types_index_.polytransactiontag.md#modifyinvestorflagmulti) +* [ModifyKycDataMulti](../enums/_types_index_.polytransactiontag.md#modifykycdatamulti) +* [ModifyLimits](../enums/_types_index_.polytransactiontag.md#modifylimits) +* [ModifyOracles](../enums/_types_index_.polytransactiontag.md#modifyoracles) +* [ModifyTiers](../enums/_types_index_.polytransactiontag.md#modifytiers) +* [ModifyTimes](../enums/_types_index_.polytransactiontag.md#modifytimes) +* [ModifyWhitelistMulti](../enums/_types_index_.polytransactiontag.md#modifywhitelistmulti) +* [PauseSto](../enums/_types_index_.polytransactiontag.md#pausesto) +* [PullDividendPayment](../enums/_types_index_.polytransactiontag.md#pulldividendpayment) +* [PushDividendPayment](../enums/_types_index_.polytransactiontag.md#pushdividendpayment) +* [ReclaimDividendFunds](../enums/_types_index_.polytransactiontag.md#reclaimdividendfunds) +* [RemoveDocument](../enums/_types_index_.polytransactiontag.md#removedocument) +* [ReserveSecurityToken](../enums/_types_index_.polytransactiontag.md#reservesecuritytoken) +* [RevokePreMinting](../enums/_types_index_.polytransactiontag.md#revokepreminting) +* [SetAllowPrimaryIssuance](../enums/_types_index_.polytransactiontag.md#setallowprimaryissuance) +* [SetController](../enums/_types_index_.polytransactiontag.md#setcontroller) +* [SetDefaultExcluded](../enums/_types_index_.polytransactiontag.md#setdefaultexcluded) +* [SetDividendsWallet](../enums/_types_index_.polytransactiontag.md#setdividendswallet) +* [SetDocument](../enums/_types_index_.polytransactiontag.md#setdocument) +* [SetErc20TaxWithholding](../enums/_types_index_.polytransactiontag.md#seterc20taxwithholding) +* [SetEtherTaxWithholding](../enums/_types_index_.polytransactiontag.md#setethertaxwithholding) +* [Signature](../enums/_types_index_.polytransactiontag.md#signature) +* [TransferErc20](../enums/_types_index_.polytransactiontag.md#transfererc20) +* [TransferOwnership](../enums/_types_index_.polytransactiontag.md#transferownership) +* [TransferReservationOwnership](../enums/_types_index_.polytransactiontag.md#transferreservationownership) +* [TransferSecurityTokens](../enums/_types_index_.polytransactiontag.md#transfersecuritytokens) +* [UnfreezeTransfers](../enums/_types_index_.polytransactiontag.md#unfreezetransfers) +* [UnpauseSto](../enums/_types_index_.polytransactiontag.md#unpausesto) +* [WithdrawTaxWithholdings](../enums/_types_index_.polytransactiontag.md#withdrawtaxwithholdings) + +## Enumeration members + +### AddDelegate + +• **AddDelegate**: = "AddDelegate" + +_Defined in_ [_src/types/index.ts:219_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L219) + +### AllowPreMinting + +• **AllowPreMinting**: = "AllowPreMinting" + +_Defined in_ [_src/types/index.ts:232_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L232) + +### Any + +• **Any**: = "Any" + +_Defined in_ [_src/types/index.ts:193_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L193) + +### ApproveErc20 + +• **ApproveErc20**: = "ApproveErc20" + +_Defined in_ [_src/types/index.ts:195_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L195) + +### BuyTokens + +• **BuyTokens**: = "BuyTokens" + +_Defined in_ [_src/types/index.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L244) + +### BuyTokensWithPoly + +• **BuyTokensWithPoly**: = "BuyTokensWithPoly" + +_Defined in_ [_src/types/index.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L245) + +### BuyWithEthRateLimited + +• **BuyWithEthRateLimited**: = "BuyWithEthRateLimited" + +_Defined in_ [_src/types/index.ts:243_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L243) + +### BuyWithPolyRateLimited + +• **BuyWithPolyRateLimited**: = "BuyWithPolyRateLimited" + +_Defined in_ [_src/types/index.ts:242_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L242) + +### BuyWithScRateLimited + +• **BuyWithScRateLimited**: = "BuyWithScRateLimited" + +_Defined in_ [_src/types/index.ts:241_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L241) + +### ChangeAllowBeneficialInvestments + +• **ChangeAllowBeneficialInvestments**: = "ChangeAllowBeneficialInvestments" + +_Defined in_ [_src/types/index.ts:234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L234) + +### ChangeHolderCount + +• **ChangeHolderCount**: = "ChangeHolderCount" + +_Defined in_ [_src/types/index.ts:246_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L246) + +### ChangeHolderPercentage + +• **ChangeHolderPercentage**: = "ChangeHolderPercentage" + +_Defined in_ [_src/types/index.ts:247_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L247) + +### ChangePermission + +• **ChangePermission**: = "ChangePermission" + +_Defined in_ [_src/types/index.ts:220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L220) + +### ControllerRedeem + +• **ControllerRedeem**: = "ControllerRedeem" + +_Defined in_ [_src/types/index.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L222) + +### ControllerTransfer + +• **ControllerTransfer**: = "ControllerTransfer" + +_Defined in_ [_src/types/index.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L221) + +### CreateCheckpoint + +• **CreateCheckpoint**: = "CreateCheckpoint" + +_Defined in_ [_src/types/index.ts:199_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L199) + +### CreateErc20DividendDistribution + +• **CreateErc20DividendDistribution**: = "CreateErc20DividendDistribution" + +_Defined in_ [_src/types/index.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L200) + +### CreateSecurityToken + +• **CreateSecurityToken**: = "CreateSecurityToken" + +_Defined in_ [_src/types/index.ts:198_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L198) + +### DisableController + +• **DisableController**: = "DisableController" + +_Defined in_ [_src/types/index.ts:211_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L211) + +### DisableFeature + +• **DisableFeature**: = "DisableFeature" + +_Defined in_ [_src/types/index.ts:213_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L213) + +### EnableCappedSto + +• **EnableCappedSto**: = "EnableCappedSto" + +_Defined in_ [_src/types/index.ts:205_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L205) + +### EnableCountTransferManager + +• **EnableCountTransferManager**: = "EnableCountTransferManager" + +_Defined in_ [_src/types/index.ts:209_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L209) + +### EnableDividends + +• **EnableDividends**: = "EnableDividends" + +_Defined in_ [_src/types/index.ts:204_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L204) + +### EnableGeneralPermissionManager + +• **EnableGeneralPermissionManager**: = "EnableGeneralPermissionManager" + +_Defined in_ [_src/types/index.ts:207_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L207) + +### EnableGeneralTransferManager + +• **EnableGeneralTransferManager**: = "EnableGeneralTransferManager" + +_Defined in_ [_src/types/index.ts:208_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L208) + +### EnablePercentageTransferManager + +• **EnablePercentageTransferManager**: = "EnablePercentageTransferManager" + +_Defined in_ [_src/types/index.ts:210_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L210) + +### EnableTieredSto + +• **EnableTieredSto**: = "EnableTieredSto" + +_Defined in_ [_src/types/index.ts:206_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L206) + +### FinalizeSto + +• **FinalizeSto**: = "FinalizeSto" + +_Defined in_ [_src/types/index.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L225) + +### FreezeIssuance + +• **FreezeIssuance**: = "FreezeIssuance" + +_Defined in_ [_src/types/index.ts:212_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L212) + +### FreezeTransfers + +• **FreezeTransfers**: = "FreezeTransfers" + +_Defined in_ [_src/types/index.ts:252_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L252) + +### GetTokens + +• **GetTokens**: = "GetTokens" + +_Defined in_ [_src/types/index.ts:194_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L194) + +### IssueMulti + +• **IssueMulti**: = "IssueMulti" + +_Defined in_ [_src/types/index.ts:231_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L231) + +### ModifyAddresses + +• **ModifyAddresses**: = "ModifyAddresses" + +_Defined in_ [_src/types/index.ts:237_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L237) + +### ModifyFunding + +• **ModifyFunding**: = "ModifyFunding" + +_Defined in_ [_src/types/index.ts:236_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L236) + +### ModifyInvestorFlagMulti + +• **ModifyInvestorFlagMulti**: = "ModifyInvestorFlagMulti" + +_Defined in_ [_src/types/index.ts:230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L230) + +### ModifyKycDataMulti + +• **ModifyKycDataMulti**: = "ModifyKycDataMulti" + +_Defined in_ [_src/types/index.ts:229_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L229) + +### ModifyLimits + +• **ModifyLimits**: = "ModifyLimits" + +_Defined in_ [_src/types/index.ts:239_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L239) + +### ModifyOracles + +• **ModifyOracles**: = "ModifyOracles" + +_Defined in_ [_src/types/index.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L240) + +### ModifyTiers + +• **ModifyTiers**: = "ModifiyTiers" + +_Defined in_ [_src/types/index.ts:238_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L238) + +### ModifyTimes + +• **ModifyTimes**: = "ModifyTimes" + +_Defined in_ [_src/types/index.ts:235_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L235) + +### ModifyWhitelistMulti + +• **ModifyWhitelistMulti**: = "ModifyWhitelistMulti" + +_Defined in_ [_src/types/index.ts:248_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L248) + +### PauseSto + +• **PauseSto**: = "PauseSto" + +_Defined in_ [_src/types/index.ts:223_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L223) + +### PullDividendPayment + +• **PullDividendPayment**: = "PullDividendPayment" + +_Defined in_ [_src/types/index.ts:217_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L217) + +### PushDividendPayment + +• **PushDividendPayment**: = "PushDividendPayment" + +_Defined in_ [_src/types/index.ts:216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L216) + +### ReclaimDividendFunds + +• **ReclaimDividendFunds**: = "ReclaimDividendFunds" + +_Defined in_ [_src/types/index.ts:214_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L214) + +### RemoveDocument + +• **RemoveDocument**: = "RemoveDocument" + +_Defined in_ [_src/types/index.ts:228_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L228) + +### ReserveSecurityToken + +• **ReserveSecurityToken**: = "ReserveSecurityToken" + +_Defined in_ [_src/types/index.ts:197_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L197) + +### RevokePreMinting + +• **RevokePreMinting**: = "RevokePreMinting" + +_Defined in_ [_src/types/index.ts:233_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L233) + +### SetAllowPrimaryIssuance + +• **SetAllowPrimaryIssuance**: = "SetAllowPrimaryIssuance" + +_Defined in_ [_src/types/index.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L249) + +### SetController + +• **SetController**: = "SetController" + +_Defined in_ [_src/types/index.ts:226_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L226) + +### SetDefaultExcluded + +• **SetDefaultExcluded**: = "SetDefaultExcluded" + +_Defined in_ [_src/types/index.ts:203_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L203) + +### SetDividendsWallet + +• **SetDividendsWallet**: = "SetDividendsWallet" + +_Defined in_ [_src/types/index.ts:218_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L218) + +### SetDocument + +• **SetDocument**: = "SetDocument" + +_Defined in_ [_src/types/index.ts:227_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L227) + +### SetErc20TaxWithholding + +• **SetErc20TaxWithholding**: = "SetErc20TaxWithholding" + +_Defined in_ [_src/types/index.ts:201_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L201) + +### SetEtherTaxWithholding + +• **SetEtherTaxWithholding**: = "SetEtherTaxWithholding" + +_Defined in_ [_src/types/index.ts:202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L202) + +### Signature + +• **Signature**: = "Signature" + +_Defined in_ [_src/types/index.ts:253_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L253) + +### TransferErc20 + +• **TransferErc20**: = "TransferErc20" + +_Defined in_ [_src/types/index.ts:196_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L196) + +### TransferOwnership + +• **TransferOwnership**: = "TransferOwnership" + +_Defined in_ [_src/types/index.ts:255_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L255) + +### TransferReservationOwnership + +• **TransferReservationOwnership**: = "TransferReservationOwnership" + +_Defined in_ [_src/types/index.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L254) + +### TransferSecurityTokens + +• **TransferSecurityTokens**: = "TransferSecurityTokens" + +_Defined in_ [_src/types/index.ts:250_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L250) + +### UnfreezeTransfers + +• **UnfreezeTransfers**: = "UnfreezeTransfers" + +_Defined in_ [_src/types/index.ts:251_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L251) + +### UnpauseSto + +• **UnpauseSto**: = "UnpauseSto" + +_Defined in_ [_src/types/index.ts:224_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L224) + +### WithdrawTaxWithholdings + +• **WithdrawTaxWithholdings**: = "WithdrawTaxWithholdings" + +_Defined in_ [_src/types/index.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L215) + diff --git a/docs/api/external-modules/_types_index_.proceduretype.md b/docs/api/external-modules/_types_index_.proceduretype.md new file mode 100644 index 0000000..bff5734 --- /dev/null +++ b/docs/api/external-modules/_types_index_.proceduretype.md @@ -0,0 +1,368 @@ +# ProcedureType + +Types of Procedures available in the SDK + +## Index + +### Enumeration members + +* [ApproveErc20](../enums/_types_index_.proceduretype.md#approveerc20) +* [AssignSecurityTokenRole](../enums/_types_index_.proceduretype.md#assignsecuritytokenrole) +* [AssignStoRole](../enums/_types_index_.proceduretype.md#assignstorole) +* [ControllerRedeem](../enums/_types_index_.proceduretype.md#controllerredeem) +* [ControllerTransfer](../enums/_types_index_.proceduretype.md#controllertransfer) +* [CreateCheckpoint](../enums/_types_index_.proceduretype.md#createcheckpoint) +* [CreateDividendDistribution](../enums/_types_index_.proceduretype.md#createdividenddistribution) +* [CreateSecurityToken](../enums/_types_index_.proceduretype.md#createsecuritytoken) +* [DisableController](../enums/_types_index_.proceduretype.md#disablecontroller) +* [DisableFeature](../enums/_types_index_.proceduretype.md#disablefeature) +* [EnableCountTransferManager](../enums/_types_index_.proceduretype.md#enablecounttransfermanager) +* [EnableDividendManager](../enums/_types_index_.proceduretype.md#enabledividendmanager) +* [EnableGeneralPermissionManager](../enums/_types_index_.proceduretype.md#enablegeneralpermissionmanager) +* [EnableGeneralTransferManager](../enums/_types_index_.proceduretype.md#enablegeneraltransfermanager) +* [EnablePercentageTransferManager](../enums/_types_index_.proceduretype.md#enablepercentagetransfermanager) +* [FinalizeSto](../enums/_types_index_.proceduretype.md#finalizesto) +* [FreezeIssuance](../enums/_types_index_.proceduretype.md#freezeissuance) +* [InvestInSimpleSto](../enums/_types_index_.proceduretype.md#investinsimplesto) +* [InvestInTieredSto](../enums/_types_index_.proceduretype.md#investintieredsto) +* [IssueTokens](../enums/_types_index_.proceduretype.md#issuetokens) +* [LaunchSimpleSto](../enums/_types_index_.proceduretype.md#launchsimplesto) +* [LaunchTieredSto](../enums/_types_index_.proceduretype.md#launchtieredsto) +* [ModifyDividendsDefaultExclusionList](../enums/_types_index_.proceduretype.md#modifydividendsdefaultexclusionlist) +* [ModifyMaxHolderCount](../enums/_types_index_.proceduretype.md#modifymaxholdercount) +* [ModifyMaxHolderPercentage](../enums/_types_index_.proceduretype.md#modifymaxholderpercentage) +* [ModifyPercentageExemptions](../enums/_types_index_.proceduretype.md#modifypercentageexemptions) +* [ModifyTieredStoData](../enums/_types_index_.proceduretype.md#modifytieredstodata) +* [ModifyTokenholderData](../enums/_types_index_.proceduretype.md#modifytokenholderdata) +* [PullDividendPayment](../enums/_types_index_.proceduretype.md#pulldividendpayment) +* [PushDividendPayment](../enums/_types_index_.proceduretype.md#pushdividendpayment) +* [ReclaimFunds](../enums/_types_index_.proceduretype.md#reclaimfunds) +* [RemoveDocument](../enums/_types_index_.proceduretype.md#removedocument) +* [ReserveSecurityToken](../enums/_types_index_.proceduretype.md#reservesecuritytoken) +* [RevokeKyc](../enums/_types_index_.proceduretype.md#revokekyc) +* [SetController](../enums/_types_index_.proceduretype.md#setcontroller) +* [SetDividendsWallet](../enums/_types_index_.proceduretype.md#setdividendswallet) +* [SetDocument](../enums/_types_index_.proceduretype.md#setdocument) +* [SignDisableControllerAck](../enums/_types_index_.proceduretype.md#signdisablecontrollerack) +* [SignFreezeIssuanceAck](../enums/_types_index_.proceduretype.md#signfreezeissuanceack) +* [SignTransferData](../enums/_types_index_.proceduretype.md#signtransferdata) +* [ToggleAllowBeneficialInvestments](../enums/_types_index_.proceduretype.md#toggleallowbeneficialinvestments) +* [ToggleAllowPreIssuing](../enums/_types_index_.proceduretype.md#toggleallowpreissuing) +* [ToggleFreezeTransfers](../enums/_types_index_.proceduretype.md#togglefreezetransfers) +* [TogglePauseSto](../enums/_types_index_.proceduretype.md#togglepausesto) +* [TransferErc20](../enums/_types_index_.proceduretype.md#transfererc20) +* [TransferOwnership](../enums/_types_index_.proceduretype.md#transferownership) +* [TransferReservationOwnership](../enums/_types_index_.proceduretype.md#transferreservationownership) +* [TransferSecurityTokens](../enums/_types_index_.proceduretype.md#transfersecuritytokens) +* [UnnamedProcedure](../enums/_types_index_.proceduretype.md#unnamedprocedure) +* [UpdateDividendsTaxWithholdingList](../enums/_types_index_.proceduretype.md#updatedividendstaxwithholdinglist) +* [WithdrawTaxes](../enums/_types_index_.proceduretype.md#withdrawtaxes) + +## Enumeration members + +### ApproveErc20 + +• **ApproveErc20**: = "ApproveErc20" + +_Defined in_ [_src/types/index.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L137) + +### AssignSecurityTokenRole + +• **AssignSecurityTokenRole**: = "AssignSecurityTokenRole" + +_Defined in_ [_src/types/index.ts:159_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L159) + +### AssignStoRole + +• **AssignStoRole**: = "AssignStoRole" + +_Defined in_ [_src/types/index.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L160) + +### ControllerRedeem + +• **ControllerRedeem**: = "ControllerRedeem" + +_Defined in_ [_src/types/index.ts:162_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L162) + +### ControllerTransfer + +• **ControllerTransfer**: = "ControllerTransfer" + +_Defined in_ [_src/types/index.ts:161_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L161) + +### CreateCheckpoint + +• **CreateCheckpoint**: = "CreateCheckpoint" + +_Defined in_ [_src/types/index.ts:139_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L139) + +### CreateDividendDistribution + +• **CreateDividendDistribution**: = "CreateDividendDistribution" + +_Defined in_ [_src/types/index.ts:147_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L147) + +### CreateSecurityToken + +• **CreateSecurityToken**: = "CreateSecurityToken" + +_Defined in_ [_src/types/index.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L148) + +### DisableController + +• **DisableController**: = "DisableController" + +_Defined in_ [_src/types/index.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L168) + +### DisableFeature + +• **DisableFeature**: = "DisableFeature" + +_Defined in_ [_src/types/index.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L149) + +### EnableCountTransferManager + +• **EnableCountTransferManager**: = "EnableCountTransferManager" + +_Defined in_ [_src/types/index.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L143) + +### EnableDividendManager + +• **EnableDividendManager**: = "EnableDividendManager" + +_Defined in_ [_src/types/index.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L140) + +### EnableGeneralPermissionManager + +• **EnableGeneralPermissionManager**: = "EnableGeneralPermissionManager" + +_Defined in_ [_src/types/index.ts:141_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L141) + +### EnableGeneralTransferManager + +• **EnableGeneralTransferManager**: = "EnableGeneralTransferManager" + +_Defined in_ [_src/types/index.ts:142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L142) + +### EnablePercentageTransferManager + +• **EnablePercentageTransferManager**: = "EnablePercentageTransferManager" + +_Defined in_ [_src/types/index.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L144) + +### FinalizeSto + +• **FinalizeSto**: = "FinalizeSto" + +_Defined in_ [_src/types/index.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L164) + +### FreezeIssuance + +• **FreezeIssuance**: = "FreezeIssuance" + +_Defined in_ [_src/types/index.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L150) + +### InvestInSimpleSto + +• **InvestInSimpleSto**: = "InvestInSimpleSto" + +_Defined in_ [_src/types/index.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L176) + +### InvestInTieredSto + +• **InvestInTieredSto**: = "InvestInTieredSto" + +_Defined in_ [_src/types/index.ts:175_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L175) + +### IssueTokens + +• **IssueTokens**: = "IssueTokens" + +_Defined in_ [_src/types/index.ts:171_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L171) + +### LaunchSimpleSto + +• **LaunchSimpleSto**: = "LaunchSimpleSto" + +_Defined in_ [_src/types/index.ts:145_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L145) + +### LaunchTieredSto + +• **LaunchTieredSto**: = "LaunchTieredSto" + +_Defined in_ [_src/types/index.ts:146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L146) + +### ModifyDividendsDefaultExclusionList + +• **ModifyDividendsDefaultExclusionList**: = "ModifyDividendsDefaultExclusionList" + +_Defined in_ [_src/types/index.ts:158_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L158) + +### ModifyMaxHolderCount + +• **ModifyMaxHolderCount**: = "ModifyMaxHolderCount" + +_Defined in_ [_src/types/index.ts:177_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L177) + +### ModifyMaxHolderPercentage + +• **ModifyMaxHolderPercentage**: = "ModifyMaxHolderPercentage" + +_Defined in_ [_src/types/index.ts:178_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L178) + +### ModifyPercentageExemptions + +• **ModifyPercentageExemptions**: = "ModifyPercentageExemptions" + +_Defined in_ [_src/types/index.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L179) + +### ModifyTieredStoData + +• **ModifyTieredStoData**: = "ModifyTieredStoData" + +_Defined in_ [_src/types/index.ts:174_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L174) + +### ModifyTokenholderData + +• **ModifyTokenholderData**: = "ModifyTokenholderData" + +_Defined in_ [_src/types/index.ts:169_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L169) + +### PullDividendPayment + +• **PullDividendPayment**: = "PullDividendPayment" + +_Defined in_ [_src/types/index.ts:157_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L157) + +### PushDividendPayment + +• **PushDividendPayment**: = "PushDividendPayment" + +_Defined in_ [_src/types/index.ts:156_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L156) + +### ReclaimFunds + +• **ReclaimFunds**: = "ReclaimFunds" + +_Defined in_ [_src/types/index.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L151) + +### RemoveDocument + +• **RemoveDocument**: = "RemoveDocument" + +_Defined in_ [_src/types/index.ts:167_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L167) + +### ReserveSecurityToken + +• **ReserveSecurityToken**: = "ReserveSecurityToken" + +_Defined in_ [_src/types/index.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L152) + +### RevokeKyc + +• **RevokeKyc**: = "RevokeKyc" + +_Defined in_ [_src/types/index.ts:170_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L170) + +### SetController + +• **SetController**: = "SetController" + +_Defined in_ [_src/types/index.ts:165_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L165) + +### SetDividendsWallet + +• **SetDividendsWallet**: = "SetDividendsWallet" + +_Defined in_ [_src/types/index.ts:155_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L155) + +### SetDocument + +• **SetDocument**: = "SetDocument" + +_Defined in_ [_src/types/index.ts:166_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L166) + +### SignDisableControllerAck + +• **SignDisableControllerAck**: = "SignDisableControllerAck" + +_Defined in_ [_src/types/index.ts:183_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L183) + +### SignFreezeIssuanceAck + +• **SignFreezeIssuanceAck**: = "SignFreezeIssuanceAck" + +_Defined in_ [_src/types/index.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L184) + +### SignTransferData + +• **SignTransferData**: = "SignTransferData" + +_Defined in_ [_src/types/index.ts:182_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L182) + +### ToggleAllowBeneficialInvestments + +• **ToggleAllowBeneficialInvestments**: = "ToggleAllowBeneficialInvestments" + +_Defined in_ [_src/types/index.ts:173_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L173) + +### ToggleAllowPreIssuing + +• **ToggleAllowPreIssuing**: = "ToggleAllowPreIssuing" + +_Defined in_ [_src/types/index.ts:172_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L172) + +### ToggleFreezeTransfers + +• **ToggleFreezeTransfers**: = "ToggleFreezeTransfers" + +_Defined in_ [_src/types/index.ts:181_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L181) + +### TogglePauseSto + +• **TogglePauseSto**: = "PauseSto" + +_Defined in_ [_src/types/index.ts:163_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L163) + +### TransferErc20 + +• **TransferErc20**: = "TransferErc20" + +_Defined in_ [_src/types/index.ts:138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L138) + +### TransferOwnership + +• **TransferOwnership**: = "TransferOwnership" + +_Defined in_ [_src/types/index.ts:185_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L185) + +### TransferReservationOwnership + +• **TransferReservationOwnership**: = "TransferReservationOwnership" + +_Defined in_ [_src/types/index.ts:186_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L186) + +### TransferSecurityTokens + +• **TransferSecurityTokens**: = "TransferSecurityTokens" + +_Defined in_ [_src/types/index.ts:180_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L180) + +### UnnamedProcedure + +• **UnnamedProcedure**: = "UnnamedProcedure" + +_Defined in_ [_src/types/index.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L136) + +### UpdateDividendsTaxWithholdingList + +• **UpdateDividendsTaxWithholdingList**: = "UpdateDividendsTaxWithholdingList" + +_Defined in_ [_src/types/index.ts:154_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L154) + +### WithdrawTaxes + +• **WithdrawTaxes**: = "WithdrawTaxes" + +_Defined in_ [_src/types/index.ts:153_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L153) + diff --git a/docs/api/external-modules/_types_index_.pulldividendpaymentprocedureargs.md b/docs/api/external-modules/_types_index_.pulldividendpaymentprocedureargs.md new file mode 100644 index 0000000..1d3bb6a --- /dev/null +++ b/docs/api/external-modules/_types_index_.pulldividendpaymentprocedureargs.md @@ -0,0 +1,31 @@ +# PullDividendPaymentProcedureArgs + +Arguments for the [PullDividendPayment](../enums/_types_index_.proceduretype.md#pulldividendpayment) Procedure + +## Hierarchy + +* **PullDividendPaymentProcedureArgs** + +## Index + +### Properties + +* [dividendIndex](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md#dividendindex) +* [symbol](../interfaces/_types_index_.pulldividendpaymentprocedureargs.md#symbol) + +## Properties + +### dividendIndex + +• **dividendIndex**: _number_ + +_Defined in_ [_src/types/index.ts:389_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L389) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:388_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L388) + +symbol of the security token + diff --git a/docs/api/external-modules/_types_index_.pushdividendpaymentprocedureargs.md b/docs/api/external-modules/_types_index_.pushdividendpaymentprocedureargs.md new file mode 100644 index 0000000..e6d6eb8 --- /dev/null +++ b/docs/api/external-modules/_types_index_.pushdividendpaymentprocedureargs.md @@ -0,0 +1,40 @@ +# PushDividendPaymentProcedureArgs + +Arguments for the [PushDividendPayment](../enums/_types_index_.proceduretype.md#pushdividendpayment) Procedure + +## Hierarchy + +* **PushDividendPaymentProcedureArgs** + +## Index + +### Properties + +* [dividendIndex](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md#dividendindex) +* [symbol](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md#symbol) +* [tokenholderAddresses](../interfaces/_types_index_.pushdividendpaymentprocedureargs.md#optional-tokenholderaddresses) + +## Properties + +### dividendIndex + +• **dividendIndex**: _number_ + +_Defined in_ [_src/types/index.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L374) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:373_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L373) + +symbol of the security token + +### `Optional` tokenholderAddresses + +• **tokenholderAddresses**? : _string\[\]_ + +_Defined in_ [_src/types/index.ts:378_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L378) + +list of addresses of the Tokenholders that will receive payment + diff --git a/docs/api/external-modules/_types_index_.reclaimfundsprocedureargs.md b/docs/api/external-modules/_types_index_.reclaimfundsprocedureargs.md new file mode 100644 index 0000000..355efd7 --- /dev/null +++ b/docs/api/external-modules/_types_index_.reclaimfundsprocedureargs.md @@ -0,0 +1,31 @@ +# ReclaimFundsProcedureArgs + +Arguments for the [ReclaimFunds](../enums/_types_index_.proceduretype.md#reclaimfunds) Procedure + +## Hierarchy + +* **ReclaimFundsProcedureArgs** + +## Index + +### Properties + +* [dividendIndex](../interfaces/_types_index_.reclaimfundsprocedureargs.md#dividendindex) +* [symbol](../interfaces/_types_index_.reclaimfundsprocedureargs.md#symbol) + +## Properties + +### dividendIndex + +• **dividendIndex**: _number_ + +_Defined in_ [_src/types/index.ts:802_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L802) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:801_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L801) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.removedocumentprocedureargs.md b/docs/api/external-modules/_types_index_.removedocumentprocedureargs.md new file mode 100644 index 0000000..4befa38 --- /dev/null +++ b/docs/api/external-modules/_types_index_.removedocumentprocedureargs.md @@ -0,0 +1,33 @@ +# RemoveDocumentProcedureArgs + +Arguments for the [RemoveDocument](../enums/_types_index_.proceduretype.md#removedocument) Procedure + +## Hierarchy + +* **RemoveDocumentProcedureArgs** + +## Index + +### Properties + +* [name](../interfaces/_types_index_.removedocumentprocedureargs.md#name) +* [symbol](../interfaces/_types_index_.removedocumentprocedureargs.md#symbol) + +## Properties + +### name + +• **name**: _string_ + +_Defined in_ [_src/types/index.ts:1064_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1064) + +the name of the Document being removed + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1060_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1060) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.reservesecuritytokenprocedureargs.md b/docs/api/external-modules/_types_index_.reservesecuritytokenprocedureargs.md new file mode 100644 index 0000000..ee91edf --- /dev/null +++ b/docs/api/external-modules/_types_index_.reservesecuritytokenprocedureargs.md @@ -0,0 +1,33 @@ +# ReserveSecurityTokenProcedureArgs + +Arguments for the [ReserveSecurityToken](../enums/_types_index_.proceduretype.md#reservesecuritytoken) Procedure + +## Hierarchy + +* **ReserveSecurityTokenProcedureArgs** + +## Index + +### Properties + +* [owner](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md#optional-owner) +* [symbol](../interfaces/_types_index_.reservesecuritytokenprocedureargs.md#symbol) + +## Properties + +### `Optional` owner + +• **owner**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:816_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L816) + +if supplied, the reservation will be made on behalf of this address + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:812_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L812) + +the symbol to be reserved + diff --git a/docs/api/external-modules/_types_index_.revokekycprocedureargs.md b/docs/api/external-modules/_types_index_.revokekycprocedureargs.md new file mode 100644 index 0000000..e295ee0 --- /dev/null +++ b/docs/api/external-modules/_types_index_.revokekycprocedureargs.md @@ -0,0 +1,33 @@ +# RevokeKycProcedureArgs + +Arguments for the [RevokeKyc](../enums/_types_index_.proceduretype.md#revokekyc) Procedure + +## Hierarchy + +* **RevokeKycProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.revokekycprocedureargs.md#symbol) +* [tokenholderAddresses](../interfaces/_types_index_.revokekycprocedureargs.md#tokenholderaddresses) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1174_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1174) + +symbol of the Security Token + +### tokenholderAddresses + +• **tokenholderAddresses**: _string\[\]_ + +_Defined in_ [_src/types/index.ts:1178_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1178) + +list of Tokenholders addresses for which KYC will be revoked + diff --git a/docs/api/external-modules/_types_index_.securitytokenrole.md b/docs/api/external-modules/_types_index_.securitytokenrole.md new file mode 100644 index 0000000..79b3bbd --- /dev/null +++ b/docs/api/external-modules/_types_index_.securitytokenrole.md @@ -0,0 +1,51 @@ +# SecurityTokenRole + +## Index + +### Enumeration members + +* [DividendsAdministrator](../enums/_types_index_.securitytokenrole.md#dividendsadministrator) +* [DividendsOperator](../enums/_types_index_.securitytokenrole.md#dividendsoperator) +* [PercentageOwnershipRestrictionsAdministrator](../enums/_types_index_.securitytokenrole.md#percentageownershiprestrictionsadministrator) +* [PermissionsAdministrator](../enums/_types_index_.securitytokenrole.md#permissionsadministrator) +* [TokenholderCountRestrictionsAdministrator](../enums/_types_index_.securitytokenrole.md#tokenholdercountrestrictionsadministrator) +* [TokenholdersAdministrator](../enums/_types_index_.securitytokenrole.md#tokenholdersadministrator) + +## Enumeration members + +### DividendsAdministrator + +• **DividendsAdministrator**: = "DividendsAdministrator" + +_Defined in_ [_src/types/index.ts:1459_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1459) + +### DividendsOperator + +• **DividendsOperator**: = "DividendsOperator" + +_Defined in_ [_src/types/index.ts:1458_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1458) + +### PercentageOwnershipRestrictionsAdministrator + +• **PercentageOwnershipRestrictionsAdministrator**: = "PercentageOwnershipRestrictionsAdministrator" + +_Defined in_ [_src/types/index.ts:1462_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1462) + +### PermissionsAdministrator + +• **PermissionsAdministrator**: = "PermissionsAdministrator" + +_Defined in_ [_src/types/index.ts:1457_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1457) + +### TokenholderCountRestrictionsAdministrator + +• **TokenholderCountRestrictionsAdministrator**: = "TokenholderCountRestrictionsAdministrator" + +_Defined in_ [_src/types/index.ts:1461_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1461) + +### TokenholdersAdministrator + +• **TokenholdersAdministrator**: = "TokenholdersAdministrator" + +_Defined in_ [_src/types/index.ts:1460_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1460) + diff --git a/docs/api/external-modules/_types_index_.setcontrollerprocedureargs.md b/docs/api/external-modules/_types_index_.setcontrollerprocedureargs.md new file mode 100644 index 0000000..62162a5 --- /dev/null +++ b/docs/api/external-modules/_types_index_.setcontrollerprocedureargs.md @@ -0,0 +1,33 @@ +# SetControllerProcedureArgs + +Arguments for the [SetController](../enums/_types_index_.proceduretype.md#setcontroller) Procedure + +## Hierarchy + +* **SetControllerProcedureArgs** + +## Index + +### Properties + +* [controller](../interfaces/_types_index_.setcontrollerprocedureargs.md#controller) +* [symbol](../interfaces/_types_index_.setcontrollerprocedureargs.md#symbol) + +## Properties + +### controller + +• **controller**: _string_ + +_Defined in_ [_src/types/index.ts:1031_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1031) + +wallet address to be set as the Security Token's controller + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1027_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1027) + +the symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.setdividendswalletprocedureargs.md b/docs/api/external-modules/_types_index_.setdividendswalletprocedureargs.md new file mode 100644 index 0000000..cf65694 --- /dev/null +++ b/docs/api/external-modules/_types_index_.setdividendswalletprocedureargs.md @@ -0,0 +1,33 @@ +# SetDividendsWalletProcedureArgs + +Arguments for the [SetDividendsWallet](../enums/_types_index_.proceduretype.md#setdividendswallet) Procedure + +## Hierarchy + +* **SetDividendsWalletProcedureArgs** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.setdividendswalletprocedureargs.md#address) +* [symbol](../interfaces/_types_index_.setdividendswalletprocedureargs.md#symbol) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:859_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L859) + +wallet address + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:855_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L855) + +the symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.setdocumentprocedureargs.md b/docs/api/external-modules/_types_index_.setdocumentprocedureargs.md new file mode 100644 index 0000000..e161c5d --- /dev/null +++ b/docs/api/external-modules/_types_index_.setdocumentprocedureargs.md @@ -0,0 +1,49 @@ +# SetDocumentProcedureArgs + +Arguments for the [SetDocument](../enums/_types_index_.proceduretype.md#setdocument) Procedure + +## Hierarchy + +* **SetDocumentProcedureArgs** + +## Index + +### Properties + +* [documentHash](../interfaces/_types_index_.setdocumentprocedureargs.md#documenthash) +* [name](../interfaces/_types_index_.setdocumentprocedureargs.md#name) +* [symbol](../interfaces/_types_index_.setdocumentprocedureargs.md#symbol) +* [uri](../interfaces/_types_index_.setdocumentprocedureargs.md#uri) + +## Properties + +### documentHash + +• **documentHash**: _string_ + +_Defined in_ [_src/types/index.ts:1050_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1050) + +hash of the contents of the Document + +### name + +• **name**: _string_ + +_Defined in_ [_src/types/index.ts:1045_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1045) + +name of the Document. Must be unique for the Security Token + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1041_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1041) + +symbol of the Security Token + +### uri + +• **uri**: _string_ + +_Defined in_ [_src/types/index.ts:1046_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1046) + diff --git a/docs/api/external-modules/_types_index_.signdisablecontrollerackprocedureargs.md b/docs/api/external-modules/_types_index_.signdisablecontrollerackprocedureargs.md new file mode 100644 index 0000000..e709379 --- /dev/null +++ b/docs/api/external-modules/_types_index_.signdisablecontrollerackprocedureargs.md @@ -0,0 +1,24 @@ +# SignDisableControllerAckProcedureArgs + +Arguments for the [SignDisableControllerAck](../enums/_types_index_.proceduretype.md#signdisablecontrollerack) Procedure + +## Hierarchy + +* **SignDisableControllerAckProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.signdisablecontrollerackprocedureargs.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1311_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1311) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.signfreezeissuanceackprocedureargs.md b/docs/api/external-modules/_types_index_.signfreezeissuanceackprocedureargs.md new file mode 100644 index 0000000..0e19cb9 --- /dev/null +++ b/docs/api/external-modules/_types_index_.signfreezeissuanceackprocedureargs.md @@ -0,0 +1,24 @@ +# SignFreezeIssuanceAckProcedureArgs + +Arguments for the [SignFreezeIssuanceAck](../enums/_types_index_.proceduretype.md#signfreezeissuanceack) Procedure + +## Hierarchy + +* **SignFreezeIssuanceAckProcedureArgs** + +## Index + +### Properties + +* [symbol](../interfaces/_types_index_.signfreezeissuanceackprocedureargs.md#symbol) + +## Properties + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1321) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.signtransferdataprocedureargs.md b/docs/api/external-modules/_types_index_.signtransferdataprocedureargs.md new file mode 100644 index 0000000..4e86bd9 --- /dev/null +++ b/docs/api/external-modules/_types_index_.signtransferdataprocedureargs.md @@ -0,0 +1,51 @@ +# SignTransferDataProcedureArgs + +Arguments for the [SignTransferData](../enums/_types_index_.proceduretype.md#signtransferdata) Procedure + +## Hierarchy + +* **SignTransferDataProcedureArgs** + +## Index + +### Properties + +* [kycData](../interfaces/_types_index_.signtransferdataprocedureargs.md#kycdata) +* [symbol](../interfaces/_types_index_.signtransferdataprocedureargs.md#symbol) +* [validFrom](../interfaces/_types_index_.signtransferdataprocedureargs.md#validfrom) +* [validTo](../interfaces/_types_index_.signtransferdataprocedureargs.md#validto) + +## Properties + +### kycData + +• **kycData**: [_Omit_](_types_index_.md#omit)_‹_[_Omit_](_types_index_.md#omit)_‹_[_TokenholderDataEntry_](../interfaces/_types_index_.tokenholderdataentry.md)_, "isAccredited"›, "canBuyFromSto"›\[\]_ + +_Defined in_ [_src/types/index.ts:1293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1293) + +KYC data to sign + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1289) + +symbol of the Security Token + +### validFrom + +• **validFrom**: _Date_ + +_Defined in_ [_src/types/index.ts:1297_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1297) + +date from which the signature is valid + +### validTo + +• **validTo**: _Date_ + +_Defined in_ [_src/types/index.ts:1301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1301) + +date until which the signature is valid + diff --git a/docs/api/external-modules/_types_index_.storole.md b/docs/api/external-modules/_types_index_.storole.md new file mode 100644 index 0000000..5a889da --- /dev/null +++ b/docs/api/external-modules/_types_index_.storole.md @@ -0,0 +1,23 @@ +# StoRole + +## Index + +### Enumeration members + +* [StoAdministrator](../enums/_types_index_.storole.md#stoadministrator) +* [StoOperator](../enums/_types_index_.storole.md#stooperator) + +## Enumeration members + +### StoAdministrator + +• **StoAdministrator**: = "StoAdministrator" + +_Defined in_ [_src/types/index.ts:1467_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1467) + +### StoOperator + +• **StoOperator**: = "StoOperator" + +_Defined in_ [_src/types/index.ts:1466_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1466) + diff --git a/docs/api/external-modules/_types_index_.stotier.md b/docs/api/external-modules/_types_index_.stotier.md new file mode 100644 index 0000000..9d0910f --- /dev/null +++ b/docs/api/external-modules/_types_index_.stotier.md @@ -0,0 +1,51 @@ +# StoTier + +Represents a tier of investment in a Tiered STO. Different tiers can sell different Security Token amounts at different prices, and apply discounts when purchasing with POLY + +## Hierarchy + +* **StoTier** + +## Index + +### Properties + +* [discountedPrice](../interfaces/_types_index_.stotier.md#optional-discountedprice) +* [price](../interfaces/_types_index_.stotier.md#price) +* [tokensOnSale](../interfaces/_types_index_.stotier.md#tokensonsale) +* [tokensWithDiscount](../interfaces/_types_index_.stotier.md#optional-tokenswithdiscount) + +## Properties + +### `Optional` discountedPrice + +• **discountedPrice**? : _BigNumber_ + +_Defined in_ [_src/types/index.ts:717_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L717) + +Price of tokens sold at a discount + +### price + +• **price**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:708_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L708) + +Price of each token in this tier + +### tokensOnSale + +• **tokensOnSale**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:704_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L704) + +Amount of tokens to sell in this tier + +### `Optional` tokensWithDiscount + +• **tokensWithDiscount**? : _BigNumber_ + +_Defined in_ [_src/types/index.ts:713_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L713) + +Amount of tokens to sell at a discount if paid in POLY. Must be less than the amount of tokens on sale + diff --git a/docs/api/external-modules/_types_index_.stotype.md b/docs/api/external-modules/_types_index_.stotype.md new file mode 100644 index 0000000..63cc737 --- /dev/null +++ b/docs/api/external-modules/_types_index_.stotype.md @@ -0,0 +1,23 @@ +# StoType + +## Index + +### Enumeration members + +* [Simple](../enums/_types_index_.stotype.md#simple) +* [Tiered](../enums/_types_index_.stotype.md#tiered) + +## Enumeration members + +### Simple + +• **Simple**: = "Simple" + +_Defined in_ [_src/types/index.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L51) + +### Tiered + +• **Tiered**: = "Tiered" + +_Defined in_ [_src/types/index.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L52) + diff --git a/docs/api/external-modules/_types_index_.taxwithholdingentry.md b/docs/api/external-modules/_types_index_.taxwithholdingentry.md new file mode 100644 index 0000000..c0111ac --- /dev/null +++ b/docs/api/external-modules/_types_index_.taxwithholdingentry.md @@ -0,0 +1,33 @@ +# TaxWithholdingEntry + +Properties denoting a Tokenholder's Tax Withholding Percentage + +## Hierarchy + +* **TaxWithholdingEntry** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.taxwithholdingentry.md#address) +* [percentage](../interfaces/_types_index_.taxwithholdingentry.md#percentage) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L69) + +wallet address of the Tokenholder + +### percentage + +• **percentage**: _number_ + +_Defined in_ [_src/types/index.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L73) + +percentage of the Tokenholder's Dividend payments that will be withheld for tax + diff --git a/docs/api/external-modules/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md b/docs/api/external-modules/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md new file mode 100644 index 0000000..6d7e9ed --- /dev/null +++ b/docs/api/external-modules/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md @@ -0,0 +1,51 @@ +# ToggleAllowBeneficialInvestmentsProcedureArgs + +Arguments for the [ToggleAllowBeneficialInvestments](../enums/_types_index_.proceduretype.md#toggleallowbeneficialinvestments) Procedure + +## Hierarchy + +* **ToggleAllowBeneficialInvestmentsProcedureArgs** + +## Index + +### Properties + +* [allowBeneficialInvestments](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md#allowbeneficialinvestments) +* [stoAddress](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md#stoaddress) +* [stoType](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md#stotype) +* [symbol](../interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md#symbol) + +## Properties + +### allowBeneficialInvestments + +• **allowBeneficialInvestments**: _boolean_ + +_Defined in_ [_src/types/index.ts:598_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L598) + +whether the STO allows investing on behalf of a beneficiary + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:590_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L590) + +address of the STO + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/types/index.ts:594_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L594) + +type of the STO \(Simple, Tiered, etc\) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:586_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L586) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.toggleallowpreissuingprocedureargs.md b/docs/api/external-modules/_types_index_.toggleallowpreissuingprocedureargs.md new file mode 100644 index 0000000..ca47f53 --- /dev/null +++ b/docs/api/external-modules/_types_index_.toggleallowpreissuingprocedureargs.md @@ -0,0 +1,51 @@ +# ToggleAllowPreIssuingProcedureArgs + +Arguments for the [ToggleAllowPreIssuing](../enums/_types_index_.proceduretype.md#toggleallowpreissuing) Procedure + +## Hierarchy + +* **ToggleAllowPreIssuingProcedureArgs** + +## Index + +### Properties + +* [allowPreIssuing](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md#allowpreissuing) +* [stoAddress](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md#stoaddress) +* [stoType](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md#stotype) +* [symbol](../interfaces/_types_index_.toggleallowpreissuingprocedureargs.md#symbol) + +## Properties + +### allowPreIssuing + +• **allowPreIssuing**: _boolean_ + +_Defined in_ [_src/types/index.ts:576_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L576) + +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:567_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L567) + +address of the STO + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/types/index.ts:571_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L571) + +type of the STO \(Simple, Tiered, etc\) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:563_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L563) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.togglefreezetransfersprocedureargs.md b/docs/api/external-modules/_types_index_.togglefreezetransfersprocedureargs.md new file mode 100644 index 0000000..ddbce41 --- /dev/null +++ b/docs/api/external-modules/_types_index_.togglefreezetransfersprocedureargs.md @@ -0,0 +1,33 @@ +# ToggleFreezeTransfersProcedureArgs + +Arguments for the [ToggleFreezeTransfers](../enums/_types_index_.proceduretype.md#togglefreezetransfers) Procedure + +## Hierarchy + +* **ToggleFreezeTransfersProcedureArgs** + +## Index + +### Properties + +* [freeze](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md#freeze) +* [symbol](../interfaces/_types_index_.togglefreezetransfersprocedureargs.md#symbol) + +## Properties + +### freeze + +• **freeze**: _boolean_ + +_Defined in_ [_src/types/index.ts:1279_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1279) + +whether to freeze or un-freeze transfers + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1275) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.togglepausestoprocedureargs.md b/docs/api/external-modules/_types_index_.togglepausestoprocedureargs.md new file mode 100644 index 0000000..5d1edab --- /dev/null +++ b/docs/api/external-modules/_types_index_.togglepausestoprocedureargs.md @@ -0,0 +1,49 @@ +# TogglePauseStoProcedureArgs + +Arguments for the [TogglePauseSto](../enums/_types_index_.proceduretype.md#togglepausesto) Procedure + +## Hierarchy + +* **TogglePauseStoProcedureArgs** + +## Index + +### Properties + +* [pause](../interfaces/_types_index_.togglepausestoprocedureargs.md#pause) +* [stoAddress](../interfaces/_types_index_.togglepausestoprocedureargs.md#stoaddress) +* [stoType](../interfaces/_types_index_.togglepausestoprocedureargs.md#stotype) +* [symbol](../interfaces/_types_index_.togglepausestoprocedureargs.md#symbol) + +## Properties + +### pause + +• **pause**: _boolean_ + +_Defined in_ [_src/types/index.ts:1002_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1002) + +true if pausing the STO, false if un-pausing it + +### stoAddress + +• **stoAddress**: _string_ + +_Defined in_ [_src/types/index.ts:994_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L994) + +### stoType + +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) + +_Defined in_ [_src/types/index.ts:998_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L998) + +type of the STO \(Simple, Tiered, etc\) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:993_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L993) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.tokenholderbalance.md b/docs/api/external-modules/_types_index_.tokenholderbalance.md new file mode 100644 index 0000000..98fbe82 --- /dev/null +++ b/docs/api/external-modules/_types_index_.tokenholderbalance.md @@ -0,0 +1,33 @@ +# TokenholderBalance + +Balance in Security Tokens of a specific Tokenholder + +## Hierarchy + +* **TokenholderBalance** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.tokenholderbalance.md#address) +* [balance](../interfaces/_types_index_.tokenholderbalance.md#balance) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L125) + +wallet address of the Tokenholder + +### balance + +• **balance**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:129_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L129) + +amount of Security Tokens the Tokenholder possesses + diff --git a/docs/api/external-modules/_types_index_.tokenholderdataentry.md b/docs/api/external-modules/_types_index_.tokenholderdataentry.md new file mode 100644 index 0000000..33a1178 --- /dev/null +++ b/docs/api/external-modules/_types_index_.tokenholderdataentry.md @@ -0,0 +1,69 @@ +# TokenholderDataEntry + +A Tokenholder's KYC data + +## Hierarchy + +* **TokenholderDataEntry** + +## Index + +### Properties + +* [address](../interfaces/_types_index_.tokenholderdataentry.md#address) +* [canBuyFromSto](../interfaces/_types_index_.tokenholderdataentry.md#canbuyfromsto) +* [canReceiveAfter](../interfaces/_types_index_.tokenholderdataentry.md#canreceiveafter) +* [canSendAfter](../interfaces/_types_index_.tokenholderdataentry.md#cansendafter) +* [isAccredited](../interfaces/_types_index_.tokenholderdataentry.md#isaccredited) +* [kycExpiry](../interfaces/_types_index_.tokenholderdataentry.md#kycexpiry) + +## Properties + +### address + +• **address**: _string_ + +_Defined in_ [_src/types/index.ts:1130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1130) + +tokenholder wallet address to whitelist + +### canBuyFromSto + +• **canBuyFromSto**: _boolean_ + +_Defined in_ [_src/types/index.ts:1150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1150) + +whether the tokenholder is allowed to purchase tokens in an STO + +### canReceiveAfter + +• **canReceiveAfter**: _Date_ + +_Defined in_ [_src/types/index.ts:1138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1138) + +date from which the tokenholder can receive tokens + +### canSendAfter + +• **canSendAfter**: _Date_ + +_Defined in_ [_src/types/index.ts:1134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1134) + +date from which the tokenholder can transfer tokens + +### isAccredited + +• **isAccredited**: _boolean_ + +_Defined in_ [_src/types/index.ts:1146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1146) + +whether the tokenholder is accredited + +### kycExpiry + +• **kycExpiry**: _Date_ + +_Defined in_ [_src/types/index.ts:1142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1142) + +date at which the tokenholder's KYC expires + diff --git a/docs/api/external-modules/_types_index_.transactionspec.md b/docs/api/external-modules/_types_index_.transactionspec.md new file mode 100644 index 0000000..2258ece --- /dev/null +++ b/docs/api/external-modules/_types_index_.transactionspec.md @@ -0,0 +1,53 @@ +# TransactionSpec + +Schema of a specific transaction + +## Type parameters + +▪ **Args** + +▪ **Value**: _any\[\]_ + +▪ **Receipt**: _any_ + +▪ **FutureValue**: _any_ + +## Hierarchy + +* **TransactionSpec** + +## Index + +### Properties + +* [args](../interfaces/_types_index_.transactionspec.md#args) +* [method](../interfaces/_types_index_.transactionspec.md#method) +* [postTransactionResolvers](../interfaces/_types_index_.transactionspec.md#optional-posttransactionresolvers) +* [tag](../interfaces/_types_index_.transactionspec.md#optional-tag) + +## Properties + +### args + +• **args**: [_MapMaybeResolver_](_types_index_.md#mapmayberesolver)_‹Args›_ + +_Defined in_ [_src/types/index.ts:1562_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1562) + +### method + +• **method**: [_LowLevelMethod_](_types_index_.md#lowlevelmethod)_‹Args› \|_ [_SignatureRequest_](_types_index_.md#signaturerequest)_‹Args› \|_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod.md)_‹FutureValue, Args›_ + +_Defined in_ [_src/types/index.ts:1561_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1561) + +### `Optional` postTransactionResolvers + +• **postTransactionResolvers**? : [_PostTransactionResolverArray_](_types_index_.md#posttransactionresolverarray)_‹Value, Receipt›_ + +_Defined in_ [_src/types/index.ts:1563_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1563) + +### `Optional` tag + +• **tag**? : [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) + +_Defined in_ [_src/types/index.ts:1564_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1564) + diff --git a/docs/api/external-modules/_types_index_.transactionspeed.md b/docs/api/external-modules/_types_index_.transactionspeed.md new file mode 100644 index 0000000..379562e --- /dev/null +++ b/docs/api/external-modules/_types_index_.transactionspeed.md @@ -0,0 +1,37 @@ +# TransactionSpeed + +## Index + +### Enumeration members + +* [Fast](../enums/_types_index_.transactionspeed.md#fast) +* [Fastest](../enums/_types_index_.transactionspeed.md#fastest) +* [Medium](../enums/_types_index_.transactionspeed.md#medium) +* [Slow](../enums/_types_index_.transactionspeed.md#slow) + +## Enumeration members + +### Fast + +• **Fast**: = "Fast" + +_Defined in_ [_src/types/index.ts:1444_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1444) + +### Fastest + +• **Fastest**: = "Fastest" + +_Defined in_ [_src/types/index.ts:1445_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1445) + +### Medium + +• **Medium**: = "Medium" + +_Defined in_ [_src/types/index.ts:1443_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1443) + +### Slow + +• **Slow**: = "Slow" + +_Defined in_ [_src/types/index.ts:1442_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1442) + diff --git a/docs/api/external-modules/_types_index_.transactionstatus.md b/docs/api/external-modules/_types_index_.transactionstatus.md new file mode 100644 index 0000000..2f323b7 --- /dev/null +++ b/docs/api/external-modules/_types_index_.transactionstatus.md @@ -0,0 +1,51 @@ +# TransactionStatus + +## Index + +### Enumeration members + +* [Failed](../enums/_types_index_.transactionstatus.md#failed) +* [Idle](../enums/_types_index_.transactionstatus.md#idle) +* [Rejected](../enums/_types_index_.transactionstatus.md#rejected) +* [Running](../enums/_types_index_.transactionstatus.md#running) +* [Succeeded](../enums/_types_index_.transactionstatus.md#succeeded) +* [Unapproved](../enums/_types_index_.transactionstatus.md#unapproved) + +## Enumeration members + +### Failed + +• **Failed**: = "Failed" + +_Defined in_ [_src/types/index.ts:1385_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1385) + +### Idle + +• **Idle**: = "Idle" + +_Defined in_ [_src/types/index.ts:1380_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1380) + +### Rejected + +• **Rejected**: = "Rejected" + +_Defined in_ [_src/types/index.ts:1383_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1383) + +### Running + +• **Running**: = "Running" + +_Defined in_ [_src/types/index.ts:1382_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1382) + +### Succeeded + +• **Succeeded**: = "Succeeded" + +_Defined in_ [_src/types/index.ts:1384_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1384) + +### Unapproved + +• **Unapproved**: = "Unapproved" + +_Defined in_ [_src/types/index.ts:1381_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1381) + diff --git a/docs/api/external-modules/_types_index_.transfererc20procedureargs.md b/docs/api/external-modules/_types_index_.transfererc20procedureargs.md new file mode 100644 index 0000000..b9afa09 --- /dev/null +++ b/docs/api/external-modules/_types_index_.transfererc20procedureargs.md @@ -0,0 +1,42 @@ +# TransferErc20ProcedureArgs + +Arguments for the [TransferErc20](../enums/_types_index_.proceduretype.md#transfererc20) Procedure + +## Hierarchy + +* **TransferErc20ProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.transfererc20procedureargs.md#amount) +* [receiver](../interfaces/_types_index_.transfererc20procedureargs.md#receiver) +* [tokenAddress](../interfaces/_types_index_.transfererc20procedureargs.md#optional-tokenaddress) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:303_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L303) + +amount of tokens to be transferred + +### receiver + +• **receiver**: _string_ + +_Defined in_ [_src/types/index.ts:307_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L307) + +the receiver of tokens being transferred + +### `Optional` tokenAddress + +• **tokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:311_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L311) + +address of the ERC20 token \(defaults to POLY\) + diff --git a/docs/api/external-modules/_types_index_.transferownershipprocedureargs.md b/docs/api/external-modules/_types_index_.transferownershipprocedureargs.md new file mode 100644 index 0000000..19a028f --- /dev/null +++ b/docs/api/external-modules/_types_index_.transferownershipprocedureargs.md @@ -0,0 +1,33 @@ +# TransferOwnershipProcedureArgs + +Arguments for the [TransferOwnership](../enums/_types_index_.proceduretype.md#transferownership) Procedure + +## Hierarchy + +* **TransferOwnershipProcedureArgs** + +## Index + +### Properties + +* [newOwner](../interfaces/_types_index_.transferownershipprocedureargs.md#newowner) +* [symbol](../interfaces/_types_index_.transferownershipprocedureargs.md#symbol) + +## Properties + +### newOwner + +• **newOwner**: _string_ + +_Defined in_ [_src/types/index.ts:1106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1106) + +wallet address for the new Security Token owner + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1102) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.transferreservationownershipprocedureargs.md b/docs/api/external-modules/_types_index_.transferreservationownershipprocedureargs.md new file mode 100644 index 0000000..b7a4b9f --- /dev/null +++ b/docs/api/external-modules/_types_index_.transferreservationownershipprocedureargs.md @@ -0,0 +1,33 @@ +# TransferReservationOwnershipProcedureArgs + +Arguments for the [TransferReservationOwnership](../enums/_types_index_.proceduretype.md#transferreservationownership) Procedure + +## Hierarchy + +* **TransferReservationOwnershipProcedureArgs** + +## Index + +### Properties + +* [newOwner](../interfaces/_types_index_.transferreservationownershipprocedureargs.md#newowner) +* [symbol](../interfaces/_types_index_.transferreservationownershipprocedureargs.md#symbol) + +## Properties + +### newOwner + +• **newOwner**: _string_ + +_Defined in_ [_src/types/index.ts:1120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1120) + +wallet address for the new symbol Reservation owner + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1116) + +symbol of the Security Token + diff --git a/docs/api/external-modules/_types_index_.transfersecuritytokensprocedureargs.md b/docs/api/external-modules/_types_index_.transfersecuritytokensprocedureargs.md new file mode 100644 index 0000000..47581f1 --- /dev/null +++ b/docs/api/external-modules/_types_index_.transfersecuritytokensprocedureargs.md @@ -0,0 +1,60 @@ +# TransferSecurityTokensProcedureArgs + +Arguments for the [TransferSecurityTokens](../enums/_types_index_.proceduretype.md#transfersecuritytokens) Procedure + +## Hierarchy + +* **TransferSecurityTokensProcedureArgs** + +## Index + +### Properties + +* [amount](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md#amount) +* [data](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md#optional-data) +* [from](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md#optional-from) +* [symbol](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md#symbol) +* [to](../interfaces/_types_index_.transfersecuritytokensprocedureargs.md#to) + +## Properties + +### amount + +• **amount**: _BigNumber_ + +_Defined in_ [_src/types/index.ts:1257_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1257) + +amount of tokens being transferred + +### `Optional` data + +• **data**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:1261_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1261) + +signed KYC data that will be considered \(and applied to the Security Token\) when checking for transfer restrictions + +### `Optional` from + +• **from**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:1265_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1265) + +wallet address sending Security Tokens. Defaults to the current wallet + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:1249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1249) + +symbol of the Security Token + +### to + +• **to**: _string_ + +_Defined in_ [_src/types/index.ts:1253_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1253) + +wallet address receiving Security Tokens + diff --git a/docs/api/external-modules/_types_index_.transferstatuscode.md b/docs/api/external-modules/_types_index_.transferstatuscode.md new file mode 100644 index 0000000..7832b80 --- /dev/null +++ b/docs/api/external-modules/_types_index_.transferstatuscode.md @@ -0,0 +1,72 @@ +# TransferStatusCode + +## Index + +### Enumeration members + +* [FundsLocked](../enums/_types_index_.transferstatuscode.md#fundslocked) +* [InsufficientAllowance](../enums/_types_index_.transferstatuscode.md#insufficientallowance) +* [InsufficientBalance](../enums/_types_index_.transferstatuscode.md#insufficientbalance) +* [InvalidOperator](../enums/_types_index_.transferstatuscode.md#invalidoperator) +* [InvalidReceiver](../enums/_types_index_.transferstatuscode.md#invalidreceiver) +* [InvalidSender](../enums/_types_index_.transferstatuscode.md#invalidsender) +* [TransferFailure](../enums/_types_index_.transferstatuscode.md#transferfailure) +* [TransferSuccess](../enums/_types_index_.transferstatuscode.md#transfersuccess) +* [TransfersHalted](../enums/_types_index_.transferstatuscode.md#transfershalted) + +## Enumeration members + +### FundsLocked + +• **FundsLocked**: = "FundsLocked" + +_Defined in_ [_src/types/index.ts:1476_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1476) + +### InsufficientAllowance + +• **InsufficientAllowance**: = "InsufficientAllowance" + +_Defined in_ [_src/types/index.ts:1474_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1474) + +### InsufficientBalance + +• **InsufficientBalance**: = "InsufficientBalance" + +_Defined in_ [_src/types/index.ts:1473_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1473) + +### InvalidOperator + +• **InvalidOperator**: = "InvalidOperator" + +_Defined in_ [_src/types/index.ts:1479_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1479) + +### InvalidReceiver + +• **InvalidReceiver**: = "InvalidReceiver" + +_Defined in_ [_src/types/index.ts:1478_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1478) + +### InvalidSender + +• **InvalidSender**: = "InvalidSender" + +_Defined in_ [_src/types/index.ts:1477_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1477) + +### TransferFailure + +• **TransferFailure**: = "TransferFailure" + +_Defined in_ [_src/types/index.ts:1471_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1471) + +### TransferSuccess + +• **TransferSuccess**: = "TransferSuccess" + +_Defined in_ [_src/types/index.ts:1472_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1472) + +### TransfersHalted + +• **TransfersHalted**: = "TransfersHalted" + +_Defined in_ [_src/types/index.ts:1475_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1475) + diff --git a/docs/api/external-modules/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md b/docs/api/external-modules/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md new file mode 100644 index 0000000..eb7c027 --- /dev/null +++ b/docs/api/external-modules/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md @@ -0,0 +1,42 @@ +# UpdateDividendsTaxWithholdingListProcedureArgs + +Arguments for the [UpdateDividendsTaxWithholdingList](../enums/_types_index_.proceduretype.md#updatedividendstaxwithholdinglist) Procedure + +## Hierarchy + +* **UpdateDividendsTaxWithholdingListProcedureArgs** + +## Index + +### Properties + +* [percentages](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md#percentages) +* [symbol](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md#symbol) +* [tokenholderAddresses](../interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md#tokenholderaddresses) + +## Properties + +### percentages + +• **percentages**: _number\[\]_ + +_Defined in_ [_src/types/index.ts:845_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L845) + +list of percentages to update + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:837_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L837) + +the symbol of the Security Token + +### tokenholderAddresses + +• **tokenholderAddresses**: _string\[\]_ + +_Defined in_ [_src/types/index.ts:841_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L841) + +list of addresses of the Tokenholders for which to update the tax withholding percentages + diff --git a/docs/api/external-modules/_types_index_.withdrawtaxesprocedureargs.md b/docs/api/external-modules/_types_index_.withdrawtaxesprocedureargs.md new file mode 100644 index 0000000..29e8cc9 --- /dev/null +++ b/docs/api/external-modules/_types_index_.withdrawtaxesprocedureargs.md @@ -0,0 +1,31 @@ +# WithdrawTaxesProcedureArgs + +Arguments for the [WithdrawTaxes](../enums/_types_index_.proceduretype.md#withdrawtaxes) Procedure + +## Hierarchy + +* **WithdrawTaxesProcedureArgs** + +## Index + +### Properties + +* [dividendIndex](../interfaces/_types_index_.withdrawtaxesprocedureargs.md#dividendindex) +* [symbol](../interfaces/_types_index_.withdrawtaxesprocedureargs.md#symbol) + +## Properties + +### dividendIndex + +• **dividendIndex**: _number_ + +_Defined in_ [_src/types/index.ts:827_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L827) + +### symbol + +• **symbol**: _string_ + +_Defined in_ [_src/types/index.ts:826_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L826) + +the symbol of the Security Token + diff --git a/docs/api/external-modules/_utils_constants_.md b/docs/api/external-modules/_utils_constants_.md new file mode 100644 index 0000000..63e96f0 --- /dev/null +++ b/docs/api/external-modules/_utils_constants_.md @@ -0,0 +1,23 @@ +# utils/constants + +## Index + +### Variables + +* [FULL\_DECIMALS](_utils_constants_.md#const-full_decimals) +* [ZERO\_ADDRESS](_utils_constants_.md#const-zero_address) + +## Variables + +### `Const` FULL\_DECIMALS + +• **FULL\_DECIMALS**: _BigNumber_ = new BigNumber\(18\) + +_Defined in_ [_src/utils/constants.ts:3_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/constants.ts#L3) + +### `Const` ZERO\_ADDRESS + +• **ZERO\_ADDRESS**: _"0x0000000000000000000000000000000000000000"_ = "0x0000000000000000000000000000000000000000" + +_Defined in_ [_src/utils/constants.ts:4_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/constants.ts#L4) + diff --git a/docs/api/external-modules/_utils_index_.findcappedstopauseparams.md b/docs/api/external-modules/_utils_index_.findcappedstopauseparams.md new file mode 100644 index 0000000..79892fe --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findcappedstopauseparams.md @@ -0,0 +1,33 @@ +# FindCappedStoPauseParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindCappedStoPauseParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findcappedstopauseparams.md#eventname) +* [logs](../interfaces/_utils_index_.findcappedstopauseparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _Pause_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L168) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findcappedstopremintallowedparams.md b/docs/api/external-modules/_utils_index_.findcappedstopremintallowedparams.md new file mode 100644 index 0000000..0ef479e --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findcappedstopremintallowedparams.md @@ -0,0 +1,33 @@ +# FindCappedStoPreMintAllowedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindCappedStoPreMintAllowedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findcappedstopremintallowedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findcappedstopremintallowedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _AllowPreMintFlag_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:172_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L172) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findcheckpointcreatedparams.md b/docs/api/external-modules/_utils_index_.findcheckpointcreatedparams.md new file mode 100644 index 0000000..e3bf44f --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findcheckpointcreatedparams.md @@ -0,0 +1,33 @@ +# FindCheckpointCreatedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindCheckpointCreatedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findcheckpointcreatedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findcheckpointcreatedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _SecurityTokenEvents.CheckpointCreated_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L140) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findcontrollertransferparams.md b/docs/api/external-modules/_utils_index_.findcontrollertransferparams.md new file mode 100644 index 0000000..3f90cf6 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findcontrollertransferparams.md @@ -0,0 +1,33 @@ +# FindControllerTransferParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindControllerTransferParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findcontrollertransferparams.md#eventname) +* [logs](../interfaces/_utils_index_.findcontrollertransferparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _SecurityTokenEvents.ControllerTransfer_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L148) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.finderc20dividendclaimedparams.md b/docs/api/external-modules/_utils_index_.finderc20dividendclaimedparams.md new file mode 100644 index 0000000..91ba1c0 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.finderc20dividendclaimedparams.md @@ -0,0 +1,33 @@ +# FindErc20DividendClaimedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindErc20DividendClaimedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.finderc20dividendclaimedparams.md#eventname) +* [logs](../interfaces/_utils_index_.finderc20dividendclaimedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendClaimed_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L184) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.finderc20dividenddepositedparams.md b/docs/api/external-modules/_utils_index_.finderc20dividenddepositedparams.md new file mode 100644 index 0000000..b4d69e9 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.finderc20dividenddepositedparams.md @@ -0,0 +1,33 @@ +# FindErc20DividendDepositedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindErc20DividendDepositedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.finderc20dividenddepositedparams.md#eventname) +* [logs](../interfaces/_utils_index_.finderc20dividenddepositedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendDeposited_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L152) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.finderc20dividendreclaimedparams.md b/docs/api/external-modules/_utils_index_.finderc20dividendreclaimedparams.md new file mode 100644 index 0000000..bee13f6 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.finderc20dividendreclaimedparams.md @@ -0,0 +1,33 @@ +# FindErc20DividendReclaimedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindErc20DividendReclaimedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.finderc20dividendreclaimedparams.md#eventname) +* [logs](../interfaces/_utils_index_.finderc20dividendreclaimedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendReclaimed_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:192_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L192) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.finderc20setwalletparams.md b/docs/api/external-modules/_utils_index_.finderc20setwalletparams.md new file mode 100644 index 0000000..7cec047 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.finderc20setwalletparams.md @@ -0,0 +1,33 @@ +# FindErc20SetWalletParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindErc20SetWalletParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.finderc20setwalletparams.md#eventname) +* [logs](../interfaces/_utils_index_.finderc20setwalletparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ERC20DividendCheckpointEvents.SetWallet_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L200) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.finderc20setwithholdingparams.md b/docs/api/external-modules/_utils_index_.finderc20setwithholdingparams.md new file mode 100644 index 0000000..aa2efef --- /dev/null +++ b/docs/api/external-modules/_utils_index_.finderc20setwithholdingparams.md @@ -0,0 +1,33 @@ +# FindErc20SetWithholdingParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindErc20SetWithholdingParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.finderc20setwithholdingparams.md#eventname) +* [logs](../interfaces/_utils_index_.finderc20setwithholdingparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ERC20DividendCheckpointEvents.SetWithholding_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:208_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L208) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findethdividendclaimedparams.md b/docs/api/external-modules/_utils_index_.findethdividendclaimedparams.md new file mode 100644 index 0000000..40101f3 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findethdividendclaimedparams.md @@ -0,0 +1,33 @@ +# FindEthDividendClaimedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindEthDividendClaimedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findethdividendclaimedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findethdividendclaimedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendClaimed_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L188) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findethdividendreclaimedparams.md b/docs/api/external-modules/_utils_index_.findethdividendreclaimedparams.md new file mode 100644 index 0000000..7504fdd --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findethdividendreclaimedparams.md @@ -0,0 +1,33 @@ +# FindEthDividendReclaimedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindEthDividendReclaimedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findethdividendreclaimedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findethdividendreclaimedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendReclaimed_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:196_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L196) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findetherdividenddepositedparams.md b/docs/api/external-modules/_utils_index_.findetherdividenddepositedparams.md new file mode 100644 index 0000000..b99b3b7 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findetherdividenddepositedparams.md @@ -0,0 +1,33 @@ +# FindEtherDividendDepositedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindEtherDividendDepositedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findetherdividenddepositedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findetherdividenddepositedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendDeposited_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:156_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L156) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findethsetwalletparams.md b/docs/api/external-modules/_utils_index_.findethsetwalletparams.md new file mode 100644 index 0000000..7e8ed7d --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findethsetwalletparams.md @@ -0,0 +1,33 @@ +# FindEthSetWalletParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindEthSetWalletParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findethsetwalletparams.md#eventname) +* [logs](../interfaces/_utils_index_.findethsetwalletparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _EtherDividendCheckpointEvents.SetWallet_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:204_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L204) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findethsetwithholdingparams.md b/docs/api/external-modules/_utils_index_.findethsetwithholdingparams.md new file mode 100644 index 0000000..e880fcc --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findethsetwithholdingparams.md @@ -0,0 +1,33 @@ +# FindEthSetWithholdingParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindEthSetWithholdingParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findethsetwithholdingparams.md#eventname) +* [logs](../interfaces/_utils_index_.findethsetwithholdingparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _EtherDividendCheckpointEvents.SetWithholding_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:212_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L212) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findeventparams.md b/docs/api/external-modules/_utils_index_.findeventparams.md new file mode 100644 index 0000000..9286307 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findeventparams.md @@ -0,0 +1,69 @@ +# FindEventParams + +## Hierarchy + +* **FindEventParams** + + ↳ [FindTickerRegisteredParams](../interfaces/_utils_index_.findtickerregisteredparams.md) + + ↳ [FindNewSecurityTokenParams](../interfaces/_utils_index_.findnewsecuritytokenparams.md) + + ↳ [FindCheckpointCreatedParams](../interfaces/_utils_index_.findcheckpointcreatedparams.md) + + ↳ [FindModuleAddedParams](../interfaces/_utils_index_.findmoduleaddedparams.md) + + ↳ [FindControllerTransferParams](../interfaces/_utils_index_.findcontrollertransferparams.md) + + ↳ [FindErc20DividendDepositedParams](../interfaces/_utils_index_.finderc20dividenddepositedparams.md) + + ↳ [FindEtherDividendDepositedParams](../interfaces/_utils_index_.findetherdividenddepositedparams.md) + + ↳ [FindModifyKycDataParams](../interfaces/_utils_index_.findmodifykycdataparams.md) + + ↳ [FindModifyInvestorFlagParams](../interfaces/_utils_index_.findmodifyinvestorflagparams.md) + + ↳ [FindCappedStoPauseParams](../interfaces/_utils_index_.findcappedstopauseparams.md) + + ↳ [FindCappedStoPreMintAllowedParams](../interfaces/_utils_index_.findcappedstopremintallowedparams.md) + + ↳ [FindTieredStoPauseParams](../interfaces/_utils_index_.findtieredstopauseparams.md) + + ↳ [FindTieredStoPreMintAllowedParams](../interfaces/_utils_index_.findtieredstopremintallowedparams.md) + + ↳ [FindErc20DividendClaimedParams](../interfaces/_utils_index_.finderc20dividendclaimedparams.md) + + ↳ [FindEthDividendClaimedParams](../interfaces/_utils_index_.findethdividendclaimedparams.md) + + ↳ [FindErc20DividendReclaimedParams](../interfaces/_utils_index_.finderc20dividendreclaimedparams.md) + + ↳ [FindEthDividendReclaimedParams](../interfaces/_utils_index_.findethdividendreclaimedparams.md) + + ↳ [FindErc20SetWalletParams](../interfaces/_utils_index_.finderc20setwalletparams.md) + + ↳ [FindEthSetWalletParams](../interfaces/_utils_index_.findethsetwalletparams.md) + + ↳ [FindErc20SetWithholdingParams](../interfaces/_utils_index_.finderc20setwithholdingparams.md) + + ↳ [FindEthSetWithholdingParams](../interfaces/_utils_index_.findethsetwithholdingparams.md) + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findeventparams.md#eventname) +* [logs](../interfaces/_utils_index_.findeventparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ContractEvents_ + +_Defined in_ [_src/utils/index.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L128) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findevents.md b/docs/api/external-modules/_utils_index_.findevents.md new file mode 100644 index 0000000..5c2c347 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findevents.md @@ -0,0 +1,260 @@ +# FindEvents + +## Hierarchy + +* **FindEvents** + +## Callable + +▸ \(`params`: [FindTickerRegisteredParams](../interfaces/_utils_index_.findtickerregisteredparams.md)\): _LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L215) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindTickerRegisteredParams](../interfaces/_utils_index_.findtickerregisteredparams.md) | + +**Returns:** _LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›\[\]_ + +▸ \(`params`: [FindNewSecurityTokenParams](../interfaces/_utils_index_.findnewsecuritytokenparams.md)\): _LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:218_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L218) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindNewSecurityTokenParams](../interfaces/_utils_index_.findnewsecuritytokenparams.md) | + +**Returns:** _LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›\[\]_ + +▸ \(`params`: [FindModuleAddedParams](../interfaces/_utils_index_.findmoduleaddedparams.md)\): _LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L221) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindModuleAddedParams](../interfaces/_utils_index_.findmoduleaddedparams.md) | + +**Returns:** _LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›\[\]_ + +▸ \(`params`: [FindCheckpointCreatedParams](../interfaces/_utils_index_.findcheckpointcreatedparams.md)\): _LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L222) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindCheckpointCreatedParams](../interfaces/_utils_index_.findcheckpointcreatedparams.md) | + +**Returns:** _LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›\[\]_ + +▸ \(`params`: [FindControllerTransferParams](../interfaces/_utils_index_.findcontrollertransferparams.md)\): _LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L225) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindControllerTransferParams](../interfaces/_utils_index_.findcontrollertransferparams.md) | + +**Returns:** _LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›\[\]_ + +▸ \(`params`: [FindErc20DividendDepositedParams](../interfaces/_utils_index_.finderc20dividenddepositedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:228_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L228) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendDepositedParams](../interfaces/_utils_index_.finderc20dividenddepositedparams.md) | + +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›\[\]_ + +▸ \(`params`: [FindEtherDividendDepositedParams](../interfaces/_utils_index_.findetherdividenddepositedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:231_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L231) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindEtherDividendDepositedParams](../interfaces/_utils_index_.findetherdividenddepositedparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›\[\]_ + +▸ \(`params`: [FindModifyKycDataParams](../interfaces/_utils_index_.findmodifykycdataparams.md)\): _LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L234) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindModifyKycDataParams](../interfaces/_utils_index_.findmodifykycdataparams.md) | + +**Returns:** _LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›\[\]_ + +▸ \(`params`: [FindModifyInvestorFlagParams](../interfaces/_utils_index_.findmodifyinvestorflagparams.md)\): _LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:237_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L237) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindModifyInvestorFlagParams](../interfaces/_utils_index_.findmodifyinvestorflagparams.md) | + +**Returns:** _LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›\[\]_ + +▸ \(`params`: [FindCappedStoPauseParams](../interfaces/_utils_index_.findcappedstopauseparams.md)\): _LogWithDecodedArgs‹CappedSTOPauseEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L240) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindCappedStoPauseParams](../interfaces/_utils_index_.findcappedstopauseparams.md) | + +**Returns:** _LogWithDecodedArgs‹CappedSTOPauseEventArgs›\[\]_ + +▸ \(`params`: [FindCappedStoPreMintAllowedParams](../interfaces/_utils_index_.findcappedstopremintallowedparams.md)\): _LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:241_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L241) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindCappedStoPreMintAllowedParams](../interfaces/_utils_index_.findcappedstopremintallowedparams.md) | + +**Returns:** _LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›\[\]_ + +▸ \(`params`: [FindTieredStoPauseParams](../interfaces/_utils_index_.findtieredstopauseparams.md)\): _LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L244) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindTieredStoPauseParams](../interfaces/_utils_index_.findtieredstopauseparams.md) | + +**Returns:** _LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›\[\]_ + +▸ \(`params`: [FindTieredStoPreMintAllowedParams](../interfaces/_utils_index_.findtieredstopremintallowedparams.md)\): _LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L245) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindTieredStoPreMintAllowedParams](../interfaces/_utils_index_.findtieredstopremintallowedparams.md) | + +**Returns:** _LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›\[\]_ + +▸ \(`params`: [FindErc20DividendClaimedParams](../interfaces/_utils_index_.finderc20dividendclaimedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:248_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L248) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendClaimedParams](../interfaces/_utils_index_.finderc20dividendclaimedparams.md) | + +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›\[\]_ + +▸ \(`params`: [FindEthDividendClaimedParams](../interfaces/_utils_index_.findethdividendclaimedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:251_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L251) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindEthDividendClaimedParams](../interfaces/_utils_index_.findethdividendclaimedparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›\[\]_ + +▸ \(`params`: [FindErc20DividendReclaimedParams](../interfaces/_utils_index_.finderc20dividendreclaimedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L254) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendReclaimedParams](../interfaces/_utils_index_.finderc20dividendreclaimedparams.md) | + +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›\[\]_ + +▸ \(`params`: [FindEthDividendReclaimedParams](../interfaces/_utils_index_.findethdividendreclaimedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:257_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L257) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindEthDividendReclaimedParams](../interfaces/_utils_index_.findethdividendreclaimedparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›\[\]_ + +▸ \(`params`: [FindErc20SetWalletParams](../interfaces/_utils_index_.finderc20setwalletparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L260) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20SetWalletParams](../interfaces/_utils_index_.finderc20setwalletparams.md) | + +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›\[\]_ + +▸ \(`params`: [FindEthSetWalletParams](../interfaces/_utils_index_.findethsetwalletparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:263_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L263) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindEthSetWalletParams](../interfaces/_utils_index_.findethsetwalletparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›\[\]_ + +▸ \(`params`: [FindErc20SetWithholdingParams](../interfaces/_utils_index_.finderc20setwithholdingparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:264_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L264) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20SetWithholdingParams](../interfaces/_utils_index_.finderc20setwithholdingparams.md) | + +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›\[\]_ + +▸ \(`params`: [FindEthSetWithholdingParams](../interfaces/_utils_index_.findethsetwithholdingparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›\[\]_ + +_Defined in_ [_src/utils/index.ts:267_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L267) + +**Parameters:** + +| Name | Type | +| :--- | :--- | +| `params` | [FindEthSetWithholdingParams](../interfaces/_utils_index_.findethsetwithholdingparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›\[\]_ + diff --git a/docs/api/external-modules/_utils_index_.findmodifyinvestorflagparams.md b/docs/api/external-modules/_utils_index_.findmodifyinvestorflagparams.md new file mode 100644 index 0000000..3cda1ce --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findmodifyinvestorflagparams.md @@ -0,0 +1,33 @@ +# FindModifyInvestorFlagParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindModifyInvestorFlagParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findmodifyinvestorflagparams.md#eventname) +* [logs](../interfaces/_utils_index_.findmodifyinvestorflagparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ModifyInvestorFlag_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L164) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findmodifykycdataparams.md b/docs/api/external-modules/_utils_index_.findmodifykycdataparams.md new file mode 100644 index 0000000..4ea714a --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findmodifykycdataparams.md @@ -0,0 +1,33 @@ +# FindModifyKycDataParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindModifyKycDataParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findmodifykycdataparams.md#eventname) +* [logs](../interfaces/_utils_index_.findmodifykycdataparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _ModifyKYCData_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L160) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findmoduleaddedparams.md b/docs/api/external-modules/_utils_index_.findmoduleaddedparams.md new file mode 100644 index 0000000..39c5803 --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findmoduleaddedparams.md @@ -0,0 +1,33 @@ +# FindModuleAddedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindModuleAddedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findmoduleaddedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findmoduleaddedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _SecurityTokenEvents.ModuleAdded_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L144) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findnewsecuritytokenparams.md b/docs/api/external-modules/_utils_index_.findnewsecuritytokenparams.md new file mode 100644 index 0000000..e36bfec --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findnewsecuritytokenparams.md @@ -0,0 +1,33 @@ +# FindNewSecurityTokenParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindNewSecurityTokenParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findnewsecuritytokenparams.md#eventname) +* [logs](../interfaces/_utils_index_.findnewsecuritytokenparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _SecurityTokenRegistryEvents.NewSecurityToken_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L136) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findtickerregisteredparams.md b/docs/api/external-modules/_utils_index_.findtickerregisteredparams.md new file mode 100644 index 0000000..03c491c --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findtickerregisteredparams.md @@ -0,0 +1,33 @@ +# FindTickerRegisteredParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindTickerRegisteredParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findtickerregisteredparams.md#eventname) +* [logs](../interfaces/_utils_index_.findtickerregisteredparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _SecurityTokenRegistryEvents.RegisterTicker_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L132) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findtieredstopauseparams.md b/docs/api/external-modules/_utils_index_.findtieredstopauseparams.md new file mode 100644 index 0000000..006be5b --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findtieredstopauseparams.md @@ -0,0 +1,33 @@ +# FindTieredStoPauseParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindTieredStoPauseParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findtieredstopauseparams.md#eventname) +* [logs](../interfaces/_utils_index_.findtieredstopauseparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _Pause_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L176) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/external-modules/_utils_index_.findtieredstopremintallowedparams.md b/docs/api/external-modules/_utils_index_.findtieredstopremintallowedparams.md new file mode 100644 index 0000000..f6a858f --- /dev/null +++ b/docs/api/external-modules/_utils_index_.findtieredstopremintallowedparams.md @@ -0,0 +1,33 @@ +# FindTieredStoPreMintAllowedParams + +## Hierarchy + +* [FindEventParams](../interfaces/_utils_index_.findeventparams.md) + + ↳ **FindTieredStoPreMintAllowedParams** + +## Index + +### Properties + +* [eventName](../interfaces/_utils_index_.findtieredstopremintallowedparams.md#eventname) +* [logs](../interfaces/_utils_index_.findtieredstopremintallowedparams.md#logs) + +## Properties + +### eventName + +• **eventName**: _AllowPreMintFlag_ + +_Overrides_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_eventName_](../interfaces/_utils_index_.findeventparams.md#eventname) + +_Defined in_ [_src/utils/index.ts:180_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L180) + +### logs + +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ + +_Inherited from_ [_FindEventParams_](../interfaces/_utils_index_.findeventparams.md)_._[_logs_](../interfaces/_utils_index_.findeventparams.md#logs) + +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) + diff --git a/docs/api/modules/_utils_index_.md b/docs/api/external-modules/_utils_index_.md similarity index 64% rename from docs/api/modules/_utils_index_.md rename to docs/api/external-modules/_utils_index_.md index 90d7e44..62d9b15 100644 --- a/docs/api/modules/_utils_index_.md +++ b/docs/api/external-modules/_utils_index_.md @@ -1,4 +1,4 @@ -# External module: "utils/index" +# utils/index ## Index @@ -37,86 +37,81 @@ ## Functions -### areSameAddress +### areSameAddress -▸ **areSameAddress**(`a`: string, `b`: string): *boolean* +▸ **areSameAddress**\(`a`: string, `b`: string\): _boolean_ -*Defined in [src/utils/index.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L57)* +_Defined in_ [_src/utils/index.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L57) Check if two addresses correspond to the same wallet **Parameters:** -Name | Type | ------- | ------ | -`a` | string | -`b` | string | +| Name | Type | +| :--- | :--- | +| `a` | string | +| `b` | string | -**Returns:** *boolean* +**Returns:** _boolean_ -___ +### checkStringLength -### checkStringLength +▸ **checkStringLength**\(`value`: string, `variableName`: string, `opts`: object\): _void_ -▸ **checkStringLength**(`value`: string, `variableName`: string, `opts`: object): *void* - -*Defined in [src/utils/index.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L68)* +_Defined in_ [_src/utils/index.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L68) Check the length of a given string to ensure it meets correct bounds **Parameters:** -▪ **value**: *string* +▪ **value**: _string_ the string itself -▪ **variableName**: *string* +▪ **variableName**: _string_ the name of the variable associated to the string itself -▪`Default value` **opts**: *object*= { maxLength: 32 } - -optional min and max length of the string. Defaults to a minimum of 0 (empty string) and a maximum of 32 characters +▪`Default value` **opts**: _object_= { maxLength: 32 } -Name | Type | ------- | ------ | -`maxLength` | number | -`minLength?` | undefined | number | +optional min and max length of the string. Defaults to a minimum of 0 \(empty string\) and a maximum of 32 characters -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `maxLength` | number | +| `minLength?` | undefined \| number | -___ +**Returns:** _void_ -### convertVersionToEnum +### convertVersionToEnum -▸ **convertVersionToEnum**(`versionBigNumber`: BigNumber[]): *V3_0_0 | V3_1_0* +▸ **convertVersionToEnum**\(`versionBigNumber`: BigNumber\[\]\): _V3\_0\_0 \| V3\_1\_0_ -*Defined in [src/utils/index.ts:296](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L296)* +_Defined in_ [_src/utils/index.ts:296_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L296) -Convert a version number array into a string of type [[Version]] +Convert a version number array into a string of type \[\[Version\]\] **Parameters:** -Name | Type | ------- | ------ | -`versionBigNumber` | BigNumber[] | +| Name | Type | +| :--- | :--- | +| `versionBigNumber` | BigNumber\[\] | -**Returns:** *V3_0_0 | V3_1_0* - -___ +**Returns:** _V3\_0\_0 \| V3\_1\_0_ ### `Const` delay -▸ **delay**(`amount`: number): *Promise‹Object›* +▸ **delay**\(`amount`: number\): _Promise‹Object›_ -*Defined in [src/utils/index.ts:46](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L46)* +_Defined in_ [_src/utils/index.ts:46_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L46) Promisified version of a timeout **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`amount` | number | time to wait | +| Name | Type | Description | +| :--- | :--- | :--- | +| `amount` | number | time to wait | + +**Returns:** _Promise‹Object›_ -**Returns:** *Promise‹Object›* diff --git a/docs/api/external-modules/_wallet_.args.md b/docs/api/external-modules/_wallet_.args.md new file mode 100644 index 0000000..a0370d9 --- /dev/null +++ b/docs/api/external-modules/_wallet_.args.md @@ -0,0 +1,24 @@ +# Args + +## Hierarchy + +* **Args** + +## Index + +### Properties + +* [address](../interfaces/_wallet_.args.md#address) + +## Properties + +### address + +• **address**: _function_ + +_Defined in_ [_src/Wallet.ts:2_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Wallet.ts#L2) + +#### Type declaration: + +▸ \(\): _Promise‹string›_ + diff --git a/docs/api/modules/_wallet_.md b/docs/api/external-modules/_wallet_.md similarity index 70% rename from docs/api/modules/_wallet_.md rename to docs/api/external-modules/_wallet_.md index a6d7750..8dd4354 100644 --- a/docs/api/modules/_wallet_.md +++ b/docs/api/external-modules/_wallet_.md @@ -1,7 +1,8 @@ -# External module: "Wallet" +# Wallet ## Index ### Interfaces * [Args](../interfaces/_wallet_.args.md) + diff --git a/docs/api/globals.md b/docs/api/globals.md index 89c5111..66ad90d 100644 --- a/docs/api/globals.md +++ b/docs/api/globals.md @@ -1,115 +1,116 @@ -# @polymathnetwork/sdk - v3.0.0 +# Globals ## Index ### External modules -* ["Context"](modules/_context_.md) -* ["Polymath"](modules/_polymath_.md) -* ["PolymathBase"](modules/_polymathbase_.md) -* ["PolymathError"](modules/_polymatherror_.md) -* ["PostTransactionResolver"](modules/_posttransactionresolver_.md) -* ["Wallet"](modules/_wallet_.md) -* ["browserUtils"](modules/_browserutils_.md) -* ["entities/Checkpoint"](modules/_entities_checkpoint_.md) -* ["entities/DividendDistribution"](modules/_entities_dividenddistribution_.md) -* ["entities/Entity"](modules/_entities_entity_.md) -* ["entities/Erc20TokenBalance"](modules/_entities_erc20tokenbalance_.md) -* ["entities/Investment"](modules/_entities_investment_.md) -* ["entities/PolyTransaction"](modules/_entities_polytransaction_.md) -* ["entities/SecurityToken/Controller"](modules/_entities_securitytoken_controller_.md) -* ["entities/SecurityToken/Dividends"](modules/_entities_securitytoken_dividends_.md) -* ["entities/SecurityToken/Documents"](modules/_entities_securitytoken_documents_.md) -* ["entities/SecurityToken/Features"](modules/_entities_securitytoken_features_.md) -* ["entities/SecurityToken/Issuance/Issuance"](modules/_entities_securitytoken_issuance_issuance_.md) -* ["entities/SecurityToken/Issuance/Offerings"](modules/_entities_securitytoken_issuance_offerings_.md) -* ["entities/SecurityToken/Issuance/index"](modules/_entities_securitytoken_issuance_index_.md) -* ["entities/SecurityToken/Permissions"](modules/_entities_securitytoken_permissions_.md) -* ["entities/SecurityToken/SecurityToken"](modules/_entities_securitytoken_securitytoken_.md) -* ["entities/SecurityToken/SubModule"](modules/_entities_securitytoken_submodule_.md) -* ["entities/SecurityToken/Tokenholders"](modules/_entities_securitytoken_tokenholders_.md) -* ["entities/SecurityToken/Transfers/Restrictions/CountRestrictions"](modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md) -* ["entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions"](modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md) -* ["entities/SecurityToken/Transfers/Restrictions/Restrictions"](modules/_entities_securitytoken_transfers_restrictions_restrictions_.md) -* ["entities/SecurityToken/Transfers/Restrictions/index"](modules/_entities_securitytoken_transfers_restrictions_index_.md) -* ["entities/SecurityToken/Transfers/Transfers"](modules/_entities_securitytoken_transfers_transfers_.md) -* ["entities/SecurityToken/Transfers/index"](modules/_entities_securitytoken_transfers_index_.md) -* ["entities/SecurityToken/index"](modules/_entities_securitytoken_index_.md) -* ["entities/SecurityTokenReservation"](modules/_entities_securitytokenreservation_.md) -* ["entities/SimpleSto"](modules/_entities_simplesto_.md) -* ["entities/Sto"](modules/_entities_sto_.md) -* ["entities/TaxWithholding"](modules/_entities_taxwithholding_.md) -* ["entities/TieredSto"](modules/_entities_tieredsto_.md) -* ["entities/Tokenholder"](modules/_entities_tokenholder_.md) -* ["entities/TransactionQueue"](modules/_entities_transactionqueue_.md) -* ["entities/Wallet"](modules/_entities_wallet_.md) -* ["entities/factories/CheckpointFactory"](modules/_entities_factories_checkpointfactory_.md) -* ["entities/factories/DividendDistributionFactory"](modules/_entities_factories_dividenddistributionfactory_.md) -* ["entities/factories/Erc20TokenBalanceFactory"](modules/_entities_factories_erc20tokenbalancefactory_.md) -* ["entities/factories/Factory"](modules/_entities_factories_factory_.md) -* ["entities/factories/InvestmentFactory"](modules/_entities_factories_investmentfactory_.md) -* ["entities/factories/SecurityTokenFactory"](modules/_entities_factories_securitytokenfactory_.md) -* ["entities/factories/SecurityTokenReservationFactory"](modules/_entities_factories_securitytokenreservationfactory_.md) -* ["entities/factories/SimpleStoFactory"](modules/_entities_factories_simplestofactory_.md) -* ["entities/factories/TaxWithholdingFactory"](modules/_entities_factories_taxwithholdingfactory_.md) -* ["entities/factories/TieredStoFactory"](modules/_entities_factories_tieredstofactory_.md) -* ["entities/factories/TokenholderFactory"](modules/_entities_factories_tokenholderfactory_.md) -* ["entities/factories/WalletFactory"](modules/_entities_factories_walletfactory_.md) -* ["entities/factories/index"](modules/_entities_factories_index_.md) -* ["entities/index"](modules/_entities_index_.md) -* ["index"](modules/_index_.md) -* ["procedures/ApproveErc20"](modules/_procedures_approveerc20_.md) -* ["procedures/AssignSecurityTokenRole"](modules/_procedures_assignsecuritytokenrole_.md) -* ["procedures/AssignStoRole"](modules/_procedures_assignstorole_.md) -* ["procedures/ControllerRedeem"](modules/_procedures_controllerredeem_.md) -* ["procedures/ControllerTransfer"](modules/_procedures_controllertransfer_.md) -* ["procedures/CreateCheckpoint"](modules/_procedures_createcheckpoint_.md) -* ["procedures/CreateDividendDistribution"](modules/_procedures_createdividenddistribution_.md) -* ["procedures/CreateSecurityToken"](modules/_procedures_createsecuritytoken_.md) -* ["procedures/DisableController"](modules/_procedures_disablecontroller_.md) -* ["procedures/DisableFeature"](modules/_procedures_disablefeature_.md) -* ["procedures/EnableCountTransferManager"](modules/_procedures_enablecounttransfermanager_.md) -* ["procedures/EnableDividendManager"](modules/_procedures_enabledividendmanager_.md) -* ["procedures/EnableGeneralPermissionManager"](modules/_procedures_enablegeneralpermissionmanager_.md) -* ["procedures/EnableGeneralTransferManager"](modules/_procedures_enablegeneraltransfermanager_.md) -* ["procedures/EnablePercentageTransferManager"](modules/_procedures_enablepercentagetransfermanager_.md) -* ["procedures/FinalizeSto"](modules/_procedures_finalizesto_.md) -* ["procedures/FreezeIssuance"](modules/_procedures_freezeissuance_.md) -* ["procedures/InvestInSimpleSto"](modules/_procedures_investinsimplesto_.md) -* ["procedures/InvestInTieredSto"](modules/_procedures_investintieredsto_.md) -* ["procedures/IssueTokens"](modules/_procedures_issuetokens_.md) -* ["procedures/LaunchSimpleSto"](modules/_procedures_launchsimplesto_.md) -* ["procedures/LaunchTieredSto"](modules/_procedures_launchtieredsto_.md) -* ["procedures/ModifyDividendsDefaultExclusionList"](modules/_procedures_modifydividendsdefaultexclusionlist_.md) -* ["procedures/ModifyMaxHolderCount"](modules/_procedures_modifymaxholdercount_.md) -* ["procedures/ModifyMaxHolderPercentage"](modules/_procedures_modifymaxholderpercentage_.md) -* ["procedures/ModifyPercentageExemptions"](modules/_procedures_modifypercentageexemptions_.md) -* ["procedures/ModifyTieredStoData"](modules/_procedures_modifytieredstodata_.md) -* ["procedures/ModifyTokenholderData"](modules/_procedures_modifytokenholderdata_.md) -* ["procedures/Procedure"](modules/_procedures_procedure_.md) -* ["procedures/PullDividendPayment"](modules/_procedures_pulldividendpayment_.md) -* ["procedures/PushDividendPayment"](modules/_procedures_pushdividendpayment_.md) -* ["procedures/ReclaimFunds"](modules/_procedures_reclaimfunds_.md) -* ["procedures/RemoveDocument"](modules/_procedures_removedocument_.md) -* ["procedures/ReserveSecurityToken"](modules/_procedures_reservesecuritytoken_.md) -* ["procedures/RevokeKyc"](modules/_procedures_revokekyc_.md) -* ["procedures/SetController"](modules/_procedures_setcontroller_.md) -* ["procedures/SetDividendsWallet"](modules/_procedures_setdividendswallet_.md) -* ["procedures/SetDocument"](modules/_procedures_setdocument_.md) -* ["procedures/SignDisableControllerAck"](modules/_procedures_signdisablecontrollerack_.md) -* ["procedures/SignFreezeIssuanceAck"](modules/_procedures_signfreezeissuanceack_.md) -* ["procedures/SignTransferData"](modules/_procedures_signtransferdata_.md) -* ["procedures/ToggleAllowBeneficialInvestments"](modules/_procedures_toggleallowbeneficialinvestments_.md) -* ["procedures/ToggleAllowPreIssuing"](modules/_procedures_toggleallowpreissuing_.md) -* ["procedures/ToggleFreezeTransfers"](modules/_procedures_togglefreezetransfers_.md) -* ["procedures/TogglePauseSto"](modules/_procedures_togglepausesto_.md) -* ["procedures/TransferErc20"](modules/_procedures_transfererc20_.md) -* ["procedures/TransferOwnership"](modules/_procedures_transferownership_.md) -* ["procedures/TransferReservationOwnership"](modules/_procedures_transferreservationownership_.md) -* ["procedures/TransferSecurityTokens"](modules/_procedures_transfersecuritytokens_.md) -* ["procedures/UpdateDividendsTaxWithholdingList"](modules/_procedures_updatedividendstaxwithholdinglist_.md) -* ["procedures/WithdrawTaxes"](modules/_procedures_withdrawtaxes_.md) -* ["procedures/index"](modules/_procedures_index_.md) -* ["types/index"](modules/_types_index_.md) -* ["utils/constants"](modules/_utils_constants_.md) -* ["utils/index"](modules/_utils_index_.md) +* ["Context"](external-modules/_context_.md) +* ["Polymath"](external-modules/_polymath_.md) +* ["PolymathBase"](external-modules/_polymathbase_.md) +* ["PolymathError"](external-modules/_polymatherror_.md) +* ["PostTransactionResolver"](external-modules/_posttransactionresolver_.md) +* ["Wallet"](external-modules/_wallet_.md) +* ["browserUtils"](external-modules/_browserutils_.md) +* ["entities/Checkpoint"](external-modules/_entities_checkpoint_.md) +* ["entities/DividendDistribution"](external-modules/_entities_dividenddistribution_.md) +* ["entities/Entity"](external-modules/_entities_entity_.md) +* ["entities/Erc20TokenBalance"](external-modules/_entities_erc20tokenbalance_.md) +* ["entities/Investment"](external-modules/_entities_investment_.md) +* ["entities/PolyTransaction"](external-modules/_entities_polytransaction_.md) +* ["entities/SecurityToken/Controller"](external-modules/_entities_securitytoken_controller_.md) +* ["entities/SecurityToken/Dividends"](external-modules/_entities_securitytoken_dividends_.md) +* ["entities/SecurityToken/Documents"](external-modules/_entities_securitytoken_documents_.md) +* ["entities/SecurityToken/Features"](external-modules/_entities_securitytoken_features_.md) +* ["entities/SecurityToken/Issuance/Issuance"](external-modules/_entities_securitytoken_issuance_issuance_.md) +* ["entities/SecurityToken/Issuance/Offerings"](external-modules/_entities_securitytoken_issuance_offerings_.md) +* ["entities/SecurityToken/Issuance/index"](external-modules/_entities_securitytoken_issuance_index_.md) +* ["entities/SecurityToken/Permissions"](external-modules/_entities_securitytoken_permissions_.md) +* ["entities/SecurityToken/SecurityToken"](external-modules/_entities_securitytoken_securitytoken_.md) +* ["entities/SecurityToken/SubModule"](external-modules/_entities_securitytoken_submodule_.md) +* ["entities/SecurityToken/Tokenholders"](external-modules/_entities_securitytoken_tokenholders_.md) +* ["entities/SecurityToken/Transfers/Restrictions/CountRestrictions"](external-modules/_entities_securitytoken_transfers_restrictions_countrestrictions_.md) +* ["entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions"](external-modules/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.md) +* ["entities/SecurityToken/Transfers/Restrictions/Restrictions"](external-modules/_entities_securitytoken_transfers_restrictions_restrictions_.md) +* ["entities/SecurityToken/Transfers/Restrictions/index"](external-modules/_entities_securitytoken_transfers_restrictions_index_.md) +* ["entities/SecurityToken/Transfers/Transfers"](external-modules/_entities_securitytoken_transfers_transfers_.md) +* ["entities/SecurityToken/Transfers/index"](external-modules/_entities_securitytoken_transfers_index_.md) +* ["entities/SecurityToken/index"](external-modules/_entities_securitytoken_index_.md) +* ["entities/SecurityTokenReservation"](external-modules/_entities_securitytokenreservation_.md) +* ["entities/SimpleSto"](external-modules/_entities_simplesto_.md) +* ["entities/Sto"](external-modules/_entities_sto_.md) +* ["entities/TaxWithholding"](external-modules/_entities_taxwithholding_.md) +* ["entities/TieredSto"](external-modules/_entities_tieredsto_.md) +* ["entities/Tokenholder"](external-modules/_entities_tokenholder_.md) +* ["entities/TransactionQueue"](external-modules/_entities_transactionqueue_.md) +* ["entities/Wallet"](external-modules/_entities_wallet_.md) +* ["entities/factories/CheckpointFactory"](external-modules/_entities_factories_checkpointfactory_.md) +* ["entities/factories/DividendDistributionFactory"](external-modules/_entities_factories_dividenddistributionfactory_.md) +* ["entities/factories/Erc20TokenBalanceFactory"](external-modules/_entities_factories_erc20tokenbalancefactory_.md) +* ["entities/factories/Factory"](external-modules/_entities_factories_factory_.md) +* ["entities/factories/InvestmentFactory"](external-modules/_entities_factories_investmentfactory_.md) +* ["entities/factories/SecurityTokenFactory"](external-modules/_entities_factories_securitytokenfactory_.md) +* ["entities/factories/SecurityTokenReservationFactory"](external-modules/_entities_factories_securitytokenreservationfactory_.md) +* ["entities/factories/SimpleStoFactory"](external-modules/_entities_factories_simplestofactory_.md) +* ["entities/factories/TaxWithholdingFactory"](external-modules/_entities_factories_taxwithholdingfactory_.md) +* ["entities/factories/TieredStoFactory"](external-modules/_entities_factories_tieredstofactory_.md) +* ["entities/factories/TokenholderFactory"](external-modules/_entities_factories_tokenholderfactory_.md) +* ["entities/factories/WalletFactory"](external-modules/_entities_factories_walletfactory_.md) +* ["entities/factories/index"](external-modules/_entities_factories_index_.md) +* ["entities/index"](external-modules/_entities_index_.md) +* ["index"](external-modules/_index_.md) +* ["procedures/ApproveErc20"](external-modules/_procedures_approveerc20_.md) +* ["procedures/AssignSecurityTokenRole"](external-modules/_procedures_assignsecuritytokenrole_.md) +* ["procedures/AssignStoRole"](external-modules/_procedures_assignstorole_.md) +* ["procedures/ControllerRedeem"](external-modules/_procedures_controllerredeem_.md) +* ["procedures/ControllerTransfer"](external-modules/_procedures_controllertransfer_.md) +* ["procedures/CreateCheckpoint"](external-modules/_procedures_createcheckpoint_.md) +* ["procedures/CreateDividendDistribution"](external-modules/_procedures_createdividenddistribution_.md) +* ["procedures/CreateSecurityToken"](external-modules/_procedures_createsecuritytoken_.md) +* ["procedures/DisableController"](external-modules/_procedures_disablecontroller_.md) +* ["procedures/DisableFeature"](external-modules/_procedures_disablefeature_.md) +* ["procedures/EnableCountTransferManager"](external-modules/_procedures_enablecounttransfermanager_.md) +* ["procedures/EnableDividendManager"](external-modules/_procedures_enabledividendmanager_.md) +* ["procedures/EnableGeneralPermissionManager"](external-modules/_procedures_enablegeneralpermissionmanager_.md) +* ["procedures/EnableGeneralTransferManager"](external-modules/_procedures_enablegeneraltransfermanager_.md) +* ["procedures/EnablePercentageTransferManager"](external-modules/_procedures_enablepercentagetransfermanager_.md) +* ["procedures/FinalizeSto"](external-modules/_procedures_finalizesto_.md) +* ["procedures/FreezeIssuance"](external-modules/_procedures_freezeissuance_.md) +* ["procedures/InvestInSimpleSto"](external-modules/_procedures_investinsimplesto_.md) +* ["procedures/InvestInTieredSto"](external-modules/_procedures_investintieredsto_.md) +* ["procedures/IssueTokens"](external-modules/_procedures_issuetokens_.md) +* ["procedures/LaunchSimpleSto"](external-modules/_procedures_launchsimplesto_.md) +* ["procedures/LaunchTieredSto"](external-modules/_procedures_launchtieredsto_.md) +* ["procedures/ModifyDividendsDefaultExclusionList"](external-modules/_procedures_modifydividendsdefaultexclusionlist_.md) +* ["procedures/ModifyMaxHolderCount"](external-modules/_procedures_modifymaxholdercount_.md) +* ["procedures/ModifyMaxHolderPercentage"](external-modules/_procedures_modifymaxholderpercentage_.md) +* ["procedures/ModifyPercentageExemptions"](external-modules/_procedures_modifypercentageexemptions_.md) +* ["procedures/ModifyTieredStoData"](external-modules/_procedures_modifytieredstodata_.md) +* ["procedures/ModifyTokenholderData"](external-modules/_procedures_modifytokenholderdata_.md) +* ["procedures/Procedure"](external-modules/_procedures_procedure_.md) +* ["procedures/PullDividendPayment"](external-modules/_procedures_pulldividendpayment_.md) +* ["procedures/PushDividendPayment"](external-modules/_procedures_pushdividendpayment_.md) +* ["procedures/ReclaimFunds"](external-modules/_procedures_reclaimfunds_.md) +* ["procedures/RemoveDocument"](external-modules/_procedures_removedocument_.md) +* ["procedures/ReserveSecurityToken"](external-modules/_procedures_reservesecuritytoken_.md) +* ["procedures/RevokeKyc"](external-modules/_procedures_revokekyc_.md) +* ["procedures/SetController"](external-modules/_procedures_setcontroller_.md) +* ["procedures/SetDividendsWallet"](external-modules/_procedures_setdividendswallet_.md) +* ["procedures/SetDocument"](external-modules/_procedures_setdocument_.md) +* ["procedures/SignDisableControllerAck"](external-modules/_procedures_signdisablecontrollerack_.md) +* ["procedures/SignFreezeIssuanceAck"](external-modules/_procedures_signfreezeissuanceack_.md) +* ["procedures/SignTransferData"](external-modules/_procedures_signtransferdata_.md) +* ["procedures/ToggleAllowBeneficialInvestments"](external-modules/_procedures_toggleallowbeneficialinvestments_.md) +* ["procedures/ToggleAllowPreIssuing"](external-modules/_procedures_toggleallowpreissuing_.md) +* ["procedures/ToggleFreezeTransfers"](external-modules/_procedures_togglefreezetransfers_.md) +* ["procedures/TogglePauseSto"](external-modules/_procedures_togglepausesto_.md) +* ["procedures/TransferErc20"](external-modules/_procedures_transfererc20_.md) +* ["procedures/TransferOwnership"](external-modules/_procedures_transferownership_.md) +* ["procedures/TransferReservationOwnership"](external-modules/_procedures_transferreservationownership_.md) +* ["procedures/TransferSecurityTokens"](external-modules/_procedures_transfersecuritytokens_.md) +* ["procedures/UpdateDividendsTaxWithholdingList"](external-modules/_procedures_updatedividendstaxwithholdinglist_.md) +* ["procedures/WithdrawTaxes"](external-modules/_procedures_withdrawtaxes_.md) +* ["procedures/index"](external-modules/_procedures_index_.md) +* ["types/index"](external-modules/_types_index_.md) +* ["utils/constants"](external-modules/_utils_constants_.md) +* ["utils/index"](external-modules/_utils_index_.md) + diff --git a/docs/api/interfaces/README.md b/docs/api/interfaces/README.md new file mode 100644 index 0000000..98291ef --- /dev/null +++ b/docs/api/interfaces/README.md @@ -0,0 +1,2 @@ +# Interfaces + diff --git a/docs/api/interfaces/_browserutils_.ethereum.md b/docs/api/interfaces/_browserutils_.ethereum.md index 64e1904..1e178b8 100644 --- a/docs/api/interfaces/_browserutils_.ethereum.md +++ b/docs/api/interfaces/_browserutils_.ethereum.md @@ -1,4 +1,4 @@ -# Interface: Ethereum +# Ethereum ## Hierarchy @@ -10,7 +10,7 @@ ### Properties -* [_metamask](_browserutils_.ethereum.md#optional-_metamask) +* [\_metamask](_browserutils_.ethereum.md#optional-_metamask) * [networkVersion](_browserutils_.ethereum.md#networkversion) ### Methods @@ -20,45 +20,42 @@ ## Properties -### `Optional` _metamask +### `Optional` \_metamask -• **_metamask**? : *undefined | object* +• **\_metamask**? : _undefined \| object_ -*Defined in [src/browserUtils.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L15)* +_Defined in_ [_src/browserUtils.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L15) -___ +### networkVersion -### networkVersion +• **networkVersion**: _string_ -• **networkVersion**: *string* - -*Defined in [src/browserUtils.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L14)* +_Defined in_ [_src/browserUtils.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L14) ## Methods -### enable - -▸ **enable**(): *Promise‹any›* +### enable -*Defined in [src/browserUtils.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L18)* +▸ **enable**\(\): _Promise‹any›_ -**Returns:** *Promise‹any›* +_Defined in_ [_src/browserUtils.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L18) -___ +**Returns:** _Promise‹any›_ -### sendAsync +### sendAsync -▸ **sendAsync**(`payload`: JSONRPCRequestPayload, `callback`: JSONRPCErrorCallback): *void* +▸ **sendAsync**\(`payload`: JSONRPCRequestPayload, `callback`: JSONRPCErrorCallback\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/ethereum-types/lib/index.d.ts:13 +Defined in node\_modules/ethereum-types/lib/index.d.ts:13 **Parameters:** -Name | Type | ------- | ------ | -`payload` | JSONRPCRequestPayload | -`callback` | JSONRPCErrorCallback | +| Name | Type | +| :--- | :--- | +| `payload` | JSONRPCRequestPayload | +| `callback` | JSONRPCErrorCallback | + +**Returns:** _void_ -**Returns:** *void* diff --git a/docs/api/interfaces/_browserutils_.extendedwindow.md b/docs/api/interfaces/_browserutils_.extendedwindow.md index 733c6db..890b198 100644 --- a/docs/api/interfaces/_browserutils_.extendedwindow.md +++ b/docs/api/interfaces/_browserutils_.extendedwindow.md @@ -1,4 +1,4 @@ -# Interface: ExtendedWindow +# ExtendedWindow ## Hierarchy @@ -256,3038 +256,2564 @@ ## Properties -### Blob +### Blob -• **Blob**: *object* +• **Blob**: _object_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16514 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 #### Type declaration: -* **new __type**(`blobParts?`: BlobPart[], `options?`: BlobPropertyBag): *Blob* +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ -* **prototype**: *Blob* +### URL -___ +• **URL**: _object_ -### URL +_Inherited from void_ -• **URL**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16515 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 #### Type declaration: -* **new __type**(`url`: string, `base?`: string | URL): *URL* - -* **prototype**: *URL* - -* **createObjectURL**(`object`: any): *string* +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ -* **revokeObjectURL**(`url`: string): *void* +### URLSearchParams -___ +• **URLSearchParams**: _object_ -### URLSearchParams +_Inherited from void_ -• **URLSearchParams**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 #### Type declaration: -* **new __type**(`init?`: string[][] | Record‹string, string› | string | URLSearchParams): *URLSearchParams* - -* **prototype**: *URLSearchParams* - -___ +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ -### Window +### Window -• **Window**: *object* +• **Window**: _object_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16644 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16644 #### Type declaration: -* **new __type**(): *Window* - -* **prototype**: *Window* - -___ - -### applicationCache - -• **applicationCache**: *ApplicationCache* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16517 - -___ - -### caches +* **new \_\_type**\(\): _Window_ +* **prototype**: _Window_ -• **caches**: *CacheStorage* +### applicationCache -*Inherited from void* +• **applicationCache**: _ApplicationCache_ -*Overrides void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16518 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 -___ +### caches -### clientInformation +• **caches**: _CacheStorage_ -• **clientInformation**: *Navigator* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16519 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 -___ +### clientInformation -### closed +• **clientInformation**: _Navigator_ -• **closed**: *boolean* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16520 +### closed -___ +• **closed**: _boolean_ -### console +_Inherited from void_ -• **console**: *Console* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 -*Inherited from void* +### console -Defined in node_modules/typescript/lib/lib.dom.d.ts:16655 +• **console**: _Console_ -___ +_Inherited from void_ -### crypto +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 -• **crypto**: *Crypto* +### crypto -*Inherited from void* +• **crypto**: _Crypto_ -*Overrides void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16521 +_Overrides void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 -### customElements +### customElements -• **customElements**: *CustomElementRegistry* +• **customElements**: _CustomElementRegistry_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16522 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 -___ +### defaultStatus -### defaultStatus +• **defaultStatus**: _string_ -• **defaultStatus**: *string* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16523 +### devicePixelRatio -___ +• **devicePixelRatio**: _number_ -### devicePixelRatio +_Inherited from void_ -• **devicePixelRatio**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 -*Inherited from void* +### doNotTrack -Defined in node_modules/typescript/lib/lib.dom.d.ts:16524 +• **doNotTrack**: _string_ -___ +_Inherited from void_ -### doNotTrack +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 -• **doNotTrack**: *string* +### document -*Inherited from void* +• **document**: _Document_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16525 +_Inherited from void_ -___ - -### document - -• **document**: *Document* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16526 - -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 ### `Optional` ethereum -• **ethereum**? : *[Ethereum](_browserutils_.ethereum.md)* - -*Defined in [src/browserUtils.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31)* - -___ - -### event - -• **event**: *Event | undefined* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16527 - -___ - -### external - -• **external**: *External* - -*Inherited from void* +• **ethereum**? : [_Ethereum_](_browserutils_.ethereum.md) -Defined in node_modules/typescript/lib/lib.dom.d.ts:16529 +_Defined in_ [_src/browserUtils.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31) -**`deprecated`** +### event -___ +• **event**: _Event \| undefined_ -### frameElement +_Inherited from void_ -• **frameElement**: *Element* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 -*Inherited from void* +### external -Defined in node_modules/typescript/lib/lib.dom.d.ts:16530 +• **external**: _External_ -___ +_Inherited from void_ -### frames +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 -• **frames**: *Window* +**`deprecated`** -*Inherited from void* +### frameElement -Defined in node_modules/typescript/lib/lib.dom.d.ts:16531 +• **frameElement**: _Element_ -___ +_Inherited from void_ -### history +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 -• **history**: *History* +### frames -*Inherited from void* +• **frames**: _Window_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16532 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 -### indexedDB +### history -• **indexedDB**: *IDBFactory* +• **history**: _History_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 -Defined in node_modules/typescript/lib/lib.dom.d.ts:8824 +### indexedDB -___ +• **indexedDB**: _IDBFactory_ -### innerHeight +_Inherited from void_ -• **innerHeight**: *number* +_Overrides void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16533 +### innerHeight -___ +• **innerHeight**: _number_ -### innerWidth +_Inherited from void_ -• **innerWidth**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 -*Inherited from void* +### innerWidth -Defined in node_modules/typescript/lib/lib.dom.d.ts:16534 +• **innerWidth**: _number_ -___ +_Inherited from void_ -### isSecureContext +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 -• **isSecureContext**: *boolean* +### isSecureContext -*Inherited from void* +• **isSecureContext**: _boolean_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16535 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 -### length +### length -• **length**: *number* +• **length**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16536 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 -___ +### localStorage -### localStorage +• **localStorage**: _Storage_ -• **localStorage**: *Storage* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16701 +### location -___ +• **location**: _Location_ -### location +_Inherited from void_ -• **location**: *Location* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 -*Inherited from void* +### locationbar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16537 +• **locationbar**: _BarProp_ -___ +_Inherited from void_ -### locationbar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 -• **locationbar**: *BarProp* +### menubar -*Inherited from void* +• **menubar**: _BarProp_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16538 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 -### menubar +### msContentScript -• **menubar**: *BarProp* +• **msContentScript**: _ExtensionScriptApis_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16539 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 -___ +### name -### msContentScript +• **name**: _string_ -• **msContentScript**: *ExtensionScriptApis* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16540 +### navigator -___ +• **navigator**: _Navigator_ -### name +_Inherited from void_ -• **name**: *string* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 -*Inherited from void* +### offscreenBuffering -Defined in node_modules/typescript/lib/lib.dom.d.ts:16541 +• **offscreenBuffering**: _string \| boolean_ -___ +_Inherited from void_ -### navigator +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 -• **navigator**: *Navigator* +### onabort -*Inherited from void* +• **onabort**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16542 +_Inherited from void_ -___ - -### offscreenBuffering - -• **offscreenBuffering**: *string | boolean* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16543 - -___ - -### onabort - -• **onabort**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5387 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 Fires when the user aborts the download. **`param`** The event. -___ - -### onafterprint - -• **onafterprint**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16678 - -___ - -### onanimationcancel +### onafterprint -• **onanimationcancel**: *function | null* +• **onafterprint**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5388 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 -___ +### onanimationcancel -### onanimationend +• **onanimationcancel**: _function \| null_ -• **onanimationend**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5389 +### onanimationend -___ +• **onanimationend**: _function \| null_ -### onanimationiteration +_Inherited from void_ -• **onanimationiteration**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 -*Inherited from void* +### onanimationiteration -Defined in node_modules/typescript/lib/lib.dom.d.ts:5390 +• **onanimationiteration**: _function \| null_ -___ +_Inherited from void_ -### onanimationstart +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 -• **onanimationstart**: *function | null* +### onanimationstart -*Inherited from void* +• **onanimationstart**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5391 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 -### onauxclick +### onauxclick -• **onauxclick**: *function | null* +• **onauxclick**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5392 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 -___ +### onbeforeprint -### onbeforeprint +• **onbeforeprint**: _function \| null_ -• **onbeforeprint**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16679 +### onbeforeunload -___ +• **onbeforeunload**: _function \| null_ -### onbeforeunload +_Inherited from void_ -• **onbeforeunload**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 -*Inherited from void* +### onblur -Defined in node_modules/typescript/lib/lib.dom.d.ts:16680 +• **onblur**: _function \| null_ -___ +_Inherited from void_ -### onblur - -• **onblur**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5397 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 Fires when the object loses the input focus. **`param`** The focus event. -___ - -### oncancel +### oncancel -• **oncancel**: *function | null* +• **oncancel**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5398 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 -___ +### oncanplay -### oncanplay +• **oncanplay**: _function \| null_ -• **oncanplay**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5403 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 Occurs when playback is possible, but would require further buffering. **`param`** The event. -___ - -### oncanplaythrough +### oncanplaythrough -• **oncanplaythrough**: *function | null* +• **oncanplaythrough**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5404 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 -___ +### onchange -### onchange +• **onchange**: _function \| null_ -• **onchange**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5409 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 Fires when the contents of the object or selection have changed. **`param`** The event. -___ - -### onclick +### onclick -• **onclick**: *function | null* +• **onclick**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5414 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 Fires when the user clicks the left mouse button on the object **`param`** The mouse event. -___ +### onclose -### onclose +• **onclose**: _function \| null_ -• **onclose**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5415 +### oncompassneedscalibration -___ +• **oncompassneedscalibration**: _function \| null_ -### oncompassneedscalibration +_Inherited from void_ -• **oncompassneedscalibration**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 -*Inherited from void* +### oncontextmenu -Defined in node_modules/typescript/lib/lib.dom.d.ts:16544 +• **oncontextmenu**: _function \| null_ -___ +_Inherited from void_ -### oncontextmenu - -• **oncontextmenu**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5420 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 Fires when the user clicks the right mouse button in the client area, opening the context menu. **`param`** The mouse event. -___ - -### oncuechange +### oncuechange -• **oncuechange**: *function | null* +• **oncuechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5421 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 -___ +### ondblclick -### ondblclick +• **ondblclick**: _function \| null_ -• **ondblclick**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5426 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 Fires when the user double-clicks the object. **`param`** The mouse event. -___ - -### ondevicelight - -• **ondevicelight**: *function | null* +### ondevicelight -*Inherited from void* +• **ondevicelight**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16545 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 -### ondevicemotion +### ondevicemotion -• **ondevicemotion**: *function | null* +• **ondevicemotion**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16546 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 -___ +### ondeviceorientation -### ondeviceorientation +• **ondeviceorientation**: _function \| null_ -• **ondeviceorientation**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16547 +### ondrag -___ +• **ondrag**: _function \| null_ -### ondrag +_Inherited from void_ -• **ondrag**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5431 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 Fires on the source object continuously during a drag operation. **`param`** The event. -___ +### ondragend -### ondragend +• **ondragend**: _function \| null_ -• **ondragend**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5436 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 Fires on the source object when the user releases the mouse at the close of a drag operation. **`param`** The event. -___ - -### ondragenter +### ondragenter -• **ondragenter**: *function | null* +• **ondragenter**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5441 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 Fires on the target element when the user drags the object to a valid drop target. **`param`** The drag event. -___ +### ondragexit -### ondragexit +• **ondragexit**: _function \| null_ -• **ondragexit**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5442 +### ondragleave -___ +• **ondragleave**: _function \| null_ -### ondragleave +_Inherited from void_ -• **ondragleave**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5447 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. **`param`** The drag event. -___ +### ondragover -### ondragover +• **ondragover**: _function \| null_ -• **ondragover**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5452 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 Fires on the target element continuously while the user drags the object over a valid drop target. **`param`** The event. -___ - -### ondragstart +### ondragstart -• **ondragstart**: *function | null* +• **ondragstart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5457 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 Fires on the source object when the user starts to drag a text selection or selected object. **`param`** The event. -___ +### ondrop -### ondrop +• **ondrop**: _function \| null_ -• **ondrop**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5458 +### ondurationchange -___ +• **ondurationchange**: _function \| null_ -### ondurationchange +_Inherited from void_ -• **ondurationchange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5463 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 Occurs when the duration attribute is updated. **`param`** The event. -___ +### onemptied -### onemptied +• **onemptied**: _function \| null_ -• **onemptied**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5468 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 Occurs when the media element is reset to its initial state. **`param`** The event. -___ - -### onended +### onended -• **onended**: *function | null* +• **onended**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5473 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 Occurs when the end of playback is reached. **`param`** The event -___ +### onerror -### onerror +• **onerror**: _ErrorEventHandler_ -• **onerror**: *ErrorEventHandler* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5478 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 Fires when an error occurs during object loading. **`param`** The event. -___ - -### onfocus +### onfocus -• **onfocus**: *function | null* +• **onfocus**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5483 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 Fires when the object receives focus. **`param`** The event. -___ - -### ongotpointercapture +### ongotpointercapture -• **ongotpointercapture**: *function | null* +• **ongotpointercapture**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5484 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 -___ +### onhashchange -### onhashchange +• **onhashchange**: _function \| null_ -• **onhashchange**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16681 +### oninput -___ +• **oninput**: _function \| null_ -### oninput +_Inherited from void_ -• **oninput**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 -*Inherited from void* +### oninvalid -Defined in node_modules/typescript/lib/lib.dom.d.ts:5485 +• **oninvalid**: _function \| null_ -___ +_Inherited from void_ -### oninvalid +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 -• **oninvalid**: *function | null* +### onkeydown -*Inherited from void* +• **onkeydown**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5486 +_Inherited from void_ -___ - -### onkeydown - -• **onkeydown**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5491 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 Fires when the user presses a key. **`param`** The keyboard event -___ +### onkeypress -### onkeypress +• **onkeypress**: _function \| null_ -• **onkeypress**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5496 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 Fires when the user presses an alphanumeric key. **`param`** The event. -___ - -### onkeyup +### onkeyup -• **onkeyup**: *function | null* +• **onkeyup**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5501 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 Fires when the user releases a key. **`param`** The keyboard event -___ - -### onlanguagechange - -• **onlanguagechange**: *function | null* +### onlanguagechange -*Inherited from void* +• **onlanguagechange**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16682 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 -### onload +### onload -• **onload**: *function | null* +• **onload**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5506 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 Fires immediately after the browser loads the object. **`param`** The event. -___ +### onloadeddata -### onloadeddata +• **onloadeddata**: _function \| null_ -• **onloadeddata**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5511 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 Occurs when media data is loaded at the current playback position. **`param`** The event. -___ - -### onloadedmetadata +### onloadedmetadata -• **onloadedmetadata**: *function | null* +• **onloadedmetadata**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 Occurs when the duration and dimensions of the media have been determined. **`param`** The event. -___ - -### onloadend - -• **onloadend**: *function | null* +### onloadend -*Inherited from void* +• **onloadend**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5517 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 -### onloadstart +### onloadstart -• **onloadstart**: *function | null* +• **onloadstart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5522 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 Occurs when Internet Explorer begins looking for media data. **`param`** The event. -___ - -### onlostpointercapture - -• **onlostpointercapture**: *function | null* - -*Inherited from void* +### onlostpointercapture -Defined in node_modules/typescript/lib/lib.dom.d.ts:5523 +• **onlostpointercapture**: _function \| null_ -___ +_Inherited from void_ -### onmessage +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 -• **onmessage**: *function | null* +### onmessage -*Inherited from void* +• **onmessage**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16683 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 -### onmessageerror +### onmessageerror -• **onmessageerror**: *function | null* +• **onmessageerror**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16684 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 -___ +### onmousedown -### onmousedown +• **onmousedown**: _function \| null_ -• **onmousedown**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5528 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 Fires when the user clicks the object with either mouse button. **`param`** The mouse event. -___ - -### onmouseenter - -• **onmouseenter**: *function | null* - -*Inherited from void* +### onmouseenter -Defined in node_modules/typescript/lib/lib.dom.d.ts:5529 +• **onmouseenter**: _function \| null_ -___ +_Inherited from void_ -### onmouseleave +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 -• **onmouseleave**: *function | null* +### onmouseleave -*Inherited from void* +• **onmouseleave**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5530 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 -### onmousemove +### onmousemove -• **onmousemove**: *function | null* +• **onmousemove**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5535 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 Fires when the user moves the mouse over the object. **`param`** The mouse event. -___ +### onmouseout -### onmouseout +• **onmouseout**: _function \| null_ -• **onmouseout**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5540 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 Fires when the user moves the mouse pointer outside the boundaries of the object. **`param`** The mouse event. -___ - -### onmouseover +### onmouseover -• **onmouseover**: *function | null* +• **onmouseover**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5545 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 Fires when the user moves the mouse pointer into the object. **`param`** The mouse event. -___ +### onmouseup -### onmouseup +• **onmouseup**: _function \| null_ -• **onmouseup**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5550 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 Fires when the user releases a mouse button while the mouse is over the object. **`param`** The mouse event. -___ - -### onmousewheel - -• **onmousewheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16548 - -___ - -### onmsgesturechange - -• **onmsgesturechange**: *function | null* - -*Inherited from void* +### onmousewheel -Defined in node_modules/typescript/lib/lib.dom.d.ts:16549 +• **onmousewheel**: _function \| null_ -___ +_Inherited from void_ -### onmsgesturedoubletap +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 -• **onmsgesturedoubletap**: *function | null* +### onmsgesturechange -*Inherited from void* +• **onmsgesturechange**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16550 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 -### onmsgestureend +### onmsgesturedoubletap -• **onmsgestureend**: *function | null* +• **onmsgesturedoubletap**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16551 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 -___ +### onmsgestureend -### onmsgesturehold +• **onmsgestureend**: _function \| null_ -• **onmsgesturehold**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16552 +### onmsgesturehold -___ +• **onmsgesturehold**: _function \| null_ -### onmsgesturestart +_Inherited from void_ -• **onmsgesturestart**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 -*Inherited from void* +### onmsgesturestart -Defined in node_modules/typescript/lib/lib.dom.d.ts:16553 +• **onmsgesturestart**: _function \| null_ -___ +_Inherited from void_ -### onmsgesturetap +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 -• **onmsgesturetap**: *function | null* +### onmsgesturetap -*Inherited from void* +• **onmsgesturetap**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16554 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 -### onmsinertiastart +### onmsinertiastart -• **onmsinertiastart**: *function | null* +• **onmsinertiastart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16555 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 -___ +### onmspointercancel -### onmspointercancel +• **onmspointercancel**: _function \| null_ -• **onmspointercancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16556 +### onmspointerdown -___ +• **onmspointerdown**: _function \| null_ -### onmspointerdown +_Inherited from void_ -• **onmspointerdown**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 -*Inherited from void* +### onmspointerenter -Defined in node_modules/typescript/lib/lib.dom.d.ts:16557 +• **onmspointerenter**: _function \| null_ -___ +_Inherited from void_ -### onmspointerenter +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 -• **onmspointerenter**: *function | null* +### onmspointerleave -*Inherited from void* +• **onmspointerleave**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16558 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 -### onmspointerleave +### onmspointermove -• **onmspointerleave**: *function | null* +• **onmspointermove**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16559 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 -___ +### onmspointerout -### onmspointermove +• **onmspointerout**: _function \| null_ -• **onmspointermove**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16560 +### onmspointerover -___ +• **onmspointerover**: _function \| null_ -### onmspointerout +_Inherited from void_ -• **onmspointerout**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 -*Inherited from void* +### onmspointerup -Defined in node_modules/typescript/lib/lib.dom.d.ts:16561 +• **onmspointerup**: _function \| null_ -___ +_Inherited from void_ -### onmspointerover +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 -• **onmspointerover**: *function | null* +### onoffline -*Inherited from void* +• **onoffline**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16562 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 -### onmspointerup +### ononline -• **onmspointerup**: *function | null* +• **ononline**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16563 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 -___ +### onorientationchange -### onoffline +• **onorientationchange**: _function \| null_ -• **onoffline**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16685 +**`deprecated`** -___ +### onpagehide -### ononline +• **onpagehide**: _function \| null_ -• **ononline**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16686 +### onpageshow -___ +• **onpageshow**: _function \| null_ -### onorientationchange +_Inherited from void_ -• **onorientationchange**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 -*Inherited from void* +### onpause -Defined in node_modules/typescript/lib/lib.dom.d.ts:16565 +• **onpause**: _function \| null_ -**`deprecated`** +_Inherited from void_ -___ - -### onpagehide - -• **onpagehide**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16687 - -___ - -### onpageshow - -• **onpageshow**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16688 - -___ - -### onpause - -• **onpause**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5555 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 Occurs when playback is paused. **`param`** The event. -___ - -### onplay +### onplay -• **onplay**: *function | null* +• **onplay**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5560 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 Occurs when the play method is requested. **`param`** The event. -___ +### onplaying -### onplaying +• **onplaying**: _function \| null_ -• **onplaying**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5565 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 Occurs when the audio or video has started playing. **`param`** The event. -___ - -### onpointercancel - -• **onpointercancel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5566 - -___ - -### onpointerdown - -• **onpointerdown**: *function | null* +### onpointercancel -*Inherited from void* +• **onpointercancel**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5567 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 -### onpointerenter +### onpointerdown -• **onpointerenter**: *function | null* +• **onpointerdown**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5568 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 -___ +### onpointerenter -### onpointerleave +• **onpointerenter**: _function \| null_ -• **onpointerleave**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5569 +### onpointerleave -___ +• **onpointerleave**: _function \| null_ -### onpointermove +_Inherited from void_ -• **onpointermove**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 -*Inherited from void* +### onpointermove -Defined in node_modules/typescript/lib/lib.dom.d.ts:5570 +• **onpointermove**: _function \| null_ -___ +_Inherited from void_ -### onpointerout +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 -• **onpointerout**: *function | null* +### onpointerout -*Inherited from void* +• **onpointerout**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5571 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 -### onpointerover +### onpointerover -• **onpointerover**: *function | null* +• **onpointerover**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5572 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 -___ +### onpointerup -### onpointerup +• **onpointerup**: _function \| null_ -• **onpointerup**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5573 +### onpopstate -___ +• **onpopstate**: _function \| null_ -### onpopstate +_Inherited from void_ -• **onpopstate**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 -*Inherited from void* +### onprogress -Defined in node_modules/typescript/lib/lib.dom.d.ts:16689 +• **onprogress**: _function \| null_ -___ +_Inherited from void_ -### onprogress - -• **onprogress**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5578 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 Occurs to indicate progress while downloading media data. **`param`** The event. -___ - -### onratechange +### onratechange -• **onratechange**: *function | null* +• **onratechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5583 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 Occurs when the playback rate is increased or decreased. **`param`** The event. -___ - -### onreadystatechange - -• **onreadystatechange**: *function | null* - -*Inherited from void* +### onreadystatechange -Defined in node_modules/typescript/lib/lib.dom.d.ts:16566 +• **onreadystatechange**: _function \| null_ -___ +_Inherited from void_ -### onrejectionhandled +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 -• **onrejectionhandled**: *function | null* +### onrejectionhandled -*Inherited from void* +• **onrejectionhandled**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16690 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 -### onreset +### onreset -• **onreset**: *function | null* +• **onreset**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5588 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 Fires when the user resets a form. **`param`** The event. -___ +### onresize -### onresize +• **onresize**: _function \| null_ -• **onresize**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5589 +### onscroll -___ +• **onscroll**: _function \| null_ -### onscroll +_Inherited from void_ -• **onscroll**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5594 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 Fires when the user repositions the scroll box in the scroll bar on the object. **`param`** The event. -___ - -### onsecuritypolicyviolation - -• **onsecuritypolicyviolation**: *function | null* +### onsecuritypolicyviolation -*Inherited from void* +• **onsecuritypolicyviolation**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5595 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 -### onseeked +### onseeked -• **onseeked**: *function | null* +• **onseeked**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5600 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 Occurs when the seek operation ends. **`param`** The event. -___ +### onseeking -### onseeking +• **onseeking**: _function \| null_ -• **onseeking**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5605 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 Occurs when the current playback position is moved. **`param`** The event. -___ - -### onselect +### onselect -• **onselect**: *function | null* +• **onselect**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5610 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 Fires when the current selection changes. **`param`** The event. -___ +### onstalled -### onstalled +• **onstalled**: _function \| null_ -• **onstalled**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 Occurs when the download has stopped. **`param`** The event. -___ - -### onstorage +### onstorage -• **onstorage**: *function | null* +• **onstorage**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16691 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 -___ +### onsubmit -### onsubmit +• **onsubmit**: _function \| null_ -• **onsubmit**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5616 +### onsuspend -___ +• **onsuspend**: _function \| null_ -### onsuspend +_Inherited from void_ -• **onsuspend**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 Occurs if the load operation has been intentionally halted. **`param`** The event. -___ +### ontimeupdate -### ontimeupdate +• **ontimeupdate**: _function \| null_ -• **ontimeupdate**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 Occurs to indicate the current playback position. **`param`** The event. -___ - -### ontoggle - -• **ontoggle**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5627 +### ontoggle -___ +• **ontoggle**: _function \| null_ -### ontouchcancel +_Inherited from void_ -• **ontouchcancel**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 -*Inherited from void* +### ontouchcancel -Defined in node_modules/typescript/lib/lib.dom.d.ts:5628 +• **ontouchcancel**: _function \| null_ -___ +_Inherited from void_ -### ontouchend +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 -• **ontouchend**: *function | null* +### ontouchend -*Inherited from void* +• **ontouchend**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5629 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 -### ontouchmove +### ontouchmove -• **ontouchmove**: *function | null* +• **ontouchmove**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5630 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 -___ +### ontouchstart -### ontouchstart +• **ontouchstart**: _function \| null_ -• **ontouchstart**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5631 +### ontransitioncancel -___ +• **ontransitioncancel**: _function \| null_ -### ontransitioncancel +_Inherited from void_ -• **ontransitioncancel**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 -*Inherited from void* +### ontransitionend -Defined in node_modules/typescript/lib/lib.dom.d.ts:5632 +• **ontransitionend**: _function \| null_ -___ +_Inherited from void_ -### ontransitionend +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 -• **ontransitionend**: *function | null* +### ontransitionrun -*Inherited from void* +• **ontransitionrun**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5633 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 -### ontransitionrun +### ontransitionstart -• **ontransitionrun**: *function | null* +• **ontransitionstart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5634 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 -___ +### onunhandledrejection -### ontransitionstart +• **onunhandledrejection**: _function \| null_ -• **ontransitionstart**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5635 +### onunload -___ +• **onunload**: _function \| null_ -### onunhandledrejection +_Inherited from void_ -• **onunhandledrejection**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 -*Inherited from void* +### onvolumechange -Defined in node_modules/typescript/lib/lib.dom.d.ts:16692 +• **onvolumechange**: _function \| null_ -___ +_Inherited from void_ -### onunload - -• **onunload**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16693 - -___ - -### onvolumechange - -• **onvolumechange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 Occurs when the volume is changed, or playback is muted or unmuted. **`param`** The event. -___ - -### onvrdisplayactivate - -• **onvrdisplayactivate**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16567 - -___ - -### onvrdisplayblur - -• **onvrdisplayblur**: *function | null* +### onvrdisplayactivate -*Inherited from void* +• **onvrdisplayactivate**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16568 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 -### onvrdisplayconnect +### onvrdisplayblur -• **onvrdisplayconnect**: *function | null* +• **onvrdisplayblur**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16569 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 -___ +### onvrdisplayconnect -### onvrdisplaydeactivate +• **onvrdisplayconnect**: _function \| null_ -• **onvrdisplaydeactivate**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16570 +### onvrdisplaydeactivate -___ +• **onvrdisplaydeactivate**: _function \| null_ -### onvrdisplaydisconnect +_Inherited from void_ -• **onvrdisplaydisconnect**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 -*Inherited from void* +### onvrdisplaydisconnect -Defined in node_modules/typescript/lib/lib.dom.d.ts:16571 +• **onvrdisplaydisconnect**: _function \| null_ -___ +_Inherited from void_ -### onvrdisplayfocus +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 -• **onvrdisplayfocus**: *function | null* +### onvrdisplayfocus -*Inherited from void* +• **onvrdisplayfocus**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16572 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 -### onvrdisplaypointerrestricted +### onvrdisplaypointerrestricted -• **onvrdisplaypointerrestricted**: *function | null* +• **onvrdisplaypointerrestricted**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16573 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 -___ +### onvrdisplaypointerunrestricted -### onvrdisplaypointerunrestricted +• **onvrdisplaypointerunrestricted**: _function \| null_ -• **onvrdisplaypointerunrestricted**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16574 +### onvrdisplaypresentchange -___ +• **onvrdisplaypresentchange**: _function \| null_ -### onvrdisplaypresentchange +_Inherited from void_ -• **onvrdisplaypresentchange**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 -*Inherited from void* +### onwaiting -Defined in node_modules/typescript/lib/lib.dom.d.ts:16575 +• **onwaiting**: _function \| null_ -___ +_Inherited from void_ -### onwaiting - -• **onwaiting**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5645 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 Occurs when playback stops because the next frame of a video resource is not available. **`param`** The event. -___ - -### onwheel - -• **onwheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5646 - -___ - -### opener - -• **opener**: *any* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16576 - -___ - -### orientation - -• **orientation**: *string | number* +### onwheel -*Inherited from void* +• **onwheel**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16578 +_Inherited from void_ -**`deprecated`** +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 -___ +### opener -### origin +• **opener**: _any_ -• **origin**: *string* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16708 +### orientation -___ +• **orientation**: _string \| number_ -### outerHeight +_Inherited from void_ -• **outerHeight**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 -*Inherited from void* +**`deprecated`** -Defined in node_modules/typescript/lib/lib.dom.d.ts:16579 +### origin -___ +• **origin**: _string_ -### outerWidth +_Inherited from void_ -• **outerWidth**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 -*Inherited from void* +### outerHeight -Defined in node_modules/typescript/lib/lib.dom.d.ts:16580 +• **outerHeight**: _number_ -___ +_Inherited from void_ -### pageXOffset +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 -• **pageXOffset**: *number* +### outerWidth -*Inherited from void* +• **outerWidth**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16581 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 -### pageYOffset +### pageXOffset -• **pageYOffset**: *number* +• **pageXOffset**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16582 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 -___ +### pageYOffset -### parent +• **pageYOffset**: _number_ -• **parent**: *Window* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16583 +### parent -___ +• **parent**: _Window_ -### performance +_Inherited from void_ -• **performance**: *Performance* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 -*Inherited from void* +### performance -*Overrides void* +• **performance**: _Performance_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16584 +_Inherited from void_ -___ +_Overrides void_ -### personalbar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 -• **personalbar**: *BarProp* +### personalbar -*Inherited from void* +• **personalbar**: _BarProp_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16585 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 -### screen +### screen -• **screen**: *Screen* +• **screen**: _Screen_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16586 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 -___ +### screenLeft -### screenLeft +• **screenLeft**: _number_ -• **screenLeft**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16587 +### screenTop -___ +• **screenTop**: _number_ -### screenTop +_Inherited from void_ -• **screenTop**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 -*Inherited from void* +### screenX -Defined in node_modules/typescript/lib/lib.dom.d.ts:16588 +• **screenX**: _number_ -___ +_Inherited from void_ -### screenX +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 -• **screenX**: *number* +### screenY -*Inherited from void* +• **screenY**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16589 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 -### screenY +### scrollX -• **screenY**: *number* +• **scrollX**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16590 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 -___ +### scrollY -### scrollX +• **scrollY**: _number_ -• **scrollX**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16591 +### scrollbars -___ +• **scrollbars**: _BarProp_ -### scrollY +_Inherited from void_ -• **scrollY**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 -*Inherited from void* +### self -Defined in node_modules/typescript/lib/lib.dom.d.ts:16592 +• **self**: _Window_ -___ +_Inherited from void_ -### scrollbars +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 -• **scrollbars**: *BarProp* +### sessionStorage -*Inherited from void* +• **sessionStorage**: _Storage_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16593 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 -### self +### speechSynthesis -• **self**: *Window* +• **speechSynthesis**: _SpeechSynthesis_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16594 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 -___ +### status -### sessionStorage +• **status**: _string_ -• **sessionStorage**: *Storage* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16723 +### statusbar -___ +• **statusbar**: _BarProp_ -### speechSynthesis +_Inherited from void_ -• **speechSynthesis**: *SpeechSynthesis* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 -*Inherited from void* +### styleMedia -Defined in node_modules/typescript/lib/lib.dom.d.ts:16595 +• **styleMedia**: _StyleMedia_ -___ +_Inherited from void_ -### status +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 -• **status**: *string* +### toolbar -*Inherited from void* +• **toolbar**: _BarProp_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16596 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 -### statusbar +### top -• **statusbar**: *BarProp* +• **top**: _Window_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16597 - -___ - -### styleMedia - -• **styleMedia**: *StyleMedia* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16598 - -___ - -### toolbar - -• **toolbar**: *BarProp* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16599 - -___ - -### top - -• **top**: *Window* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16600 - -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 ### `Optional` web3 -• **web3**? : *[InjectedWeb3](_browserutils_.injectedweb3.md)* - -*Defined in [src/browserUtils.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32)* +• **web3**? : [_InjectedWeb3_](_browserutils_.injectedweb3.md) -___ +_Defined in_ [_src/browserUtils.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32) -### window +### window -• **window**: *Window* +• **window**: _Window_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16601 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 ## Methods -### addEventListener +### addEventListener -▸ **addEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16638 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | AddEventListenerOptions* +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **addEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16639 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | AddEventListenerOptions | +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | -**Returns:** *void* +**Returns:** _void_ -___ +### alert -### alert +▸ **alert**\(`message?`: any\): _void_ -▸ **alert**(`message?`: any): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16602 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 **Parameters:** -Name | Type | ------- | ------ | -`message?` | any | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `message?` | any | -___ +**Returns:** _void_ -### atob +### atob -▸ **atob**(`encodedString`: string): *string* +▸ **atob**\(`encodedString`: string\): _string_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16650 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 **Parameters:** -Name | Type | ------- | ------ | -`encodedString` | string | +| Name | Type | +| :--- | :--- | +| `encodedString` | string | -**Returns:** *string* +**Returns:** _string_ -___ +### blur -### blur +▸ **blur**\(\): _void_ -▸ **blur**(): *void* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16603 +**Returns:** _void_ -**Returns:** *void* +### btoa -___ +▸ **btoa**\(`rawString`: string\): _string_ -### btoa +_Inherited from void_ -▸ **btoa**(`rawString`: string): *string* +_Overrides void_ -*Inherited from void* - -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16651 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 **Parameters:** -Name | Type | ------- | ------ | -`rawString` | string | +| Name | Type | +| :--- | :--- | +| `rawString` | string | -**Returns:** *string* +**Returns:** _string_ -___ +### cancelAnimationFrame -### cancelAnimationFrame +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ -▸ **cancelAnimationFrame**(`handle`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16604 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle` | number | -___ +**Returns:** _void_ -### captureEvents +### captureEvents -▸ **captureEvents**(): *void* +▸ **captureEvents**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16606 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 -**`deprecated`** +**`deprecated`** -**Returns:** *void* +**Returns:** _void_ -___ +### clearInterval -### clearInterval +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ -▸ **clearInterval**(`handle?`: undefined | number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16712 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -___ +**Returns:** _void_ -### clearTimeout +### clearTimeout -▸ **clearTimeout**(`handle?`: undefined | number): *void* +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16713 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -### close +**Returns:** _void_ -▸ **close**(): *void* +### close -*Inherited from void* +▸ **close**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16607 +_Inherited from void_ -**Returns:** *void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 -___ +**Returns:** _void_ -### confirm +### confirm -▸ **confirm**(`message?`: undefined | string): *boolean* +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16608 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | -**Returns:** *boolean* +**Returns:** _boolean_ -___ +### createImageBitmap -### createImageBitmap +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ -▸ **createImageBitmap**(`image`: ImageBitmapSource): *Promise‹ImageBitmap›* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16714 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | -**Returns:** *Promise‹ImageBitmap›* +**Returns:** _Promise‹ImageBitmap›_ -▸ **createImageBitmap**(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number): *Promise‹ImageBitmap›* +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16715 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | -`sx` | number | -`sy` | number | -`sw` | number | -`sh` | number | - -**Returns:** *Promise‹ImageBitmap›* +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | -___ +**Returns:** _Promise‹ImageBitmap›_ -### departFocus +### departFocus -▸ **departFocus**(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin): *void* +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16609 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 **Parameters:** -Name | Type | ------- | ------ | -`navigationReason` | NavigationReason | -`origin` | FocusNavigationOrigin | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | -___ +**Returns:** _void_ -### dispatchEvent +### dispatchEvent -▸ **dispatchEvent**(`event`: Event): *boolean* +▸ **dispatchEvent**\(`event`: Event\): _boolean_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5074 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 -Dispatches a synthetic event event to target and returns true -if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. **Parameters:** -Name | Type | ------- | ------ | -`event` | Event | +| Name | Type | +| :--- | :--- | +| `event` | Event | -**Returns:** *boolean* +**Returns:** _boolean_ -___ +### fetch -### fetch +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ -▸ **fetch**(`input`: RequestInfo, `init?`: RequestInit): *Promise‹Response›* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5654 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 **Parameters:** -Name | Type | ------- | ------ | -`input` | RequestInfo | -`init?` | RequestInit | - -**Returns:** *Promise‹Response›* +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | -___ +**Returns:** _Promise‹Response›_ -### focus +### focus -▸ **focus**(): *void* +▸ **focus**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16610 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 -**Returns:** *void* +**Returns:** _void_ -___ +### getComputedStyle -### getComputedStyle +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ -▸ **getComputedStyle**(`elt`: Element, `pseudoElt?`: string | null): *CSSStyleDeclaration* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16611 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | - -**Returns:** *CSSStyleDeclaration* +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -___ +**Returns:** _CSSStyleDeclaration_ -### getMatchedCSSRules +### getMatchedCSSRules -▸ **getMatchedCSSRules**(`elt`: Element, `pseudoElt?`: string | null): *CSSRuleList* +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16612 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -**Returns:** *CSSRuleList* +**Returns:** _CSSRuleList_ -___ +### getSelection -### getSelection +▸ **getSelection**\(\): _Selection_ -▸ **getSelection**(): *Selection* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16613 +**Returns:** _Selection_ -**Returns:** *Selection* +### matchMedia -___ +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ -### matchMedia +_Inherited from void_ -▸ **matchMedia**(`query`: string): *MediaQueryList* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16614 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 **Parameters:** -Name | Type | ------- | ------ | -`query` | string | +| Name | Type | +| :--- | :--- | +| `query` | string | -**Returns:** *MediaQueryList* +**Returns:** _MediaQueryList_ -___ +### moveBy -### moveBy +▸ **moveBy**\(`x`: number, `y`: number\): _void_ -▸ **moveBy**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### moveTo +### moveTo -▸ **moveTo**(`x`: number, `y`: number): *void* +▸ **moveTo**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16616 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### msWriteProfilerMark -### msWriteProfilerMark +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ -▸ **msWriteProfilerMark**(`profilerMarkName`: string): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16617 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 **Parameters:** -Name | Type | ------- | ------ | -`profilerMarkName` | string | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | -___ +**Returns:** _void_ -### open +### open -▸ **open**(`url?`: undefined | string, `target?`: undefined | string, `features?`: undefined | string, `replace?`: undefined | false | true): *Window | null* +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16618 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 **Parameters:** -Name | Type | ------- | ------ | -`url?` | undefined | string | -`target?` | undefined | string | -`features?` | undefined | string | -`replace?` | undefined | false | true | +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | -**Returns:** *Window | null* +**Returns:** _Window \| null_ -___ +### postMessage -### postMessage +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ -▸ **postMessage**(`message`: any, `targetOrigin`: string, `transfer?`: Transferable[]): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16619 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 **Parameters:** -Name | Type | ------- | ------ | -`message` | any | -`targetOrigin` | string | -`transfer?` | Transferable[] | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | -___ +**Returns:** _void_ -### print +### print -▸ **print**(): *void* +▸ **print**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16620 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 -**Returns:** *void* +**Returns:** _void_ -___ +### prompt -### prompt +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ -▸ **prompt**(`message?`: undefined | string, `_default?`: undefined | string): *string | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | -`_default?` | undefined | string | - -**Returns:** *string | null* +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | -___ +**Returns:** _string \| null_ -### queueMicrotask +### queueMicrotask -▸ **queueMicrotask**(`callback`: Function): *void* +▸ **queueMicrotask**\(`callback`: Function\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16717 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 **Parameters:** -Name | Type | ------- | ------ | -`callback` | Function | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `callback` | Function | -___ +**Returns:** _void_ -### releaseEvents +### releaseEvents -▸ **releaseEvents**(): *void* +▸ **releaseEvents**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16623 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 -**`deprecated`** +**`deprecated`** -**Returns:** *void* +**Returns:** _void_ -___ +### removeEventListener -### removeEventListener +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ -▸ **removeEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | EventListenerOptions): *void* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | EventListenerOptions* +▪`Optional` **options**: _boolean \| EventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **removeEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | EventListenerOptions): *void* +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16641 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | EventListenerOptions | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | -___ +**Returns:** _void_ -### requestAnimationFrame +### requestAnimationFrame -▸ **requestAnimationFrame**(`callback`: FrameRequestCallback): *number* +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16624 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | -**Returns:** *number* +**Returns:** _number_ -___ +### resizeBy -### resizeBy +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ -▸ **resizeBy**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16625 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### resizeTo +### resizeTo -▸ **resizeTo**(`x`: number, `y`: number): *void* +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### scroll -### scroll +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ -▸ **scroll**(`options?`: ScrollToOptions): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16627 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scroll**(`x`: number, `y`: number): *void* +▸ **scroll**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16628 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### scrollBy +### scrollBy -▸ **scrollBy**(`options?`: ScrollToOptions): *void* +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16629 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollBy**(`x`: number, `y`: number): *void* +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16630 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### scrollTo -### scrollTo +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ -▸ **scrollTo**(`options?`: ScrollToOptions): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16631 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollTo**(`x`: number, `y`: number): *void* +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16632 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### setInterval +### setInterval -▸ **setInterval**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16718 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -**Returns:** *number* +**Returns:** _number_ -___ +### setTimeout -### setTimeout +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -▸ **setTimeout**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16719 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | - -**Returns:** *number* +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -___ +**Returns:** _number_ -### stop +### stop -▸ **stop**(): *void* +▸ **stop**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16633 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 -**Returns:** *void* +**Returns:** _void_ -___ +### webkitCancelAnimationFrame -### webkitCancelAnimationFrame +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ -▸ **webkitCancelAnimationFrame**(`handle`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16634 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle` | number | -___ +**Returns:** _void_ -### webkitConvertPointFromNodeToPage +### webkitConvertPointFromNodeToPage -▸ **webkitConvertPointFromNodeToPage**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16635 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -**Returns:** *WebKitPoint* +**Returns:** _WebKitPoint_ -___ +### webkitConvertPointFromPageToNode -### webkitConvertPointFromPageToNode +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -▸ **webkitConvertPointFromPageToNode**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16636 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | - -**Returns:** *WebKitPoint* +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -___ +**Returns:** _WebKitPoint_ -### webkitRequestAnimationFrame +### webkitRequestAnimationFrame -▸ **webkitRequestAnimationFrame**(`callback`: FrameRequestCallback): *number* +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16637 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ -**Returns:** *number* diff --git a/docs/api/interfaces/_browserutils_.injectedweb3.md b/docs/api/interfaces/_browserutils_.injectedweb3.md index a02f802..fc9d8b2 100644 --- a/docs/api/interfaces/_browserutils_.injectedweb3.md +++ b/docs/api/interfaces/_browserutils_.injectedweb3.md @@ -1,4 +1,4 @@ -# Interface: InjectedWeb3 +# InjectedWeb3 ## Hierarchy @@ -13,16 +13,15 @@ ## Properties -### currentProvider +### currentProvider -• **currentProvider**: *Provider* +• **currentProvider**: _Provider_ -*Defined in [src/browserUtils.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L26)* +_Defined in_ [_src/browserUtils.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L26) -___ +### version -### version +• **version**: [_Web3VersionAPI_](_browserutils_.web3versionapi.md) -• **version**: *[Web3VersionAPI](_browserutils_.web3versionapi.md)* +_Defined in_ [_src/browserUtils.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L27) -*Defined in [src/browserUtils.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L27)* diff --git a/docs/api/interfaces/_browserutils_.web3versionapi.md b/docs/api/interfaces/_browserutils_.web3versionapi.md index befb24c..5bfc066 100644 --- a/docs/api/interfaces/_browserutils_.web3versionapi.md +++ b/docs/api/interfaces/_browserutils_.web3versionapi.md @@ -1,4 +1,4 @@ -# Interface: Web3VersionAPI +# Web3VersionAPI ## Hierarchy @@ -14,6 +14,7 @@ ### `Optional` network -• **network**? : *undefined | string* +• **network**? : _undefined \| string_ + +_Defined in_ [_src/browserUtils.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L22) -*Defined in [src/browserUtils.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L22)* diff --git a/docs/api/interfaces/_browserutils_.windowwithethereum.md b/docs/api/interfaces/_browserutils_.windowwithethereum.md index e5f0d7a..2cd9843 100644 --- a/docs/api/interfaces/_browserutils_.windowwithethereum.md +++ b/docs/api/interfaces/_browserutils_.windowwithethereum.md @@ -1,10 +1,10 @@ -# Interface: WindowWithEthereum +# WindowWithEthereum ## Hierarchy - ↳ [ExtendedWindow](_browserutils_.extendedwindow.md) +↳ [ExtendedWindow](_browserutils_.extendedwindow.md) - ↳ **WindowWithEthereum** +↳ **WindowWithEthereum** ## Index @@ -251,3028 +251,2557 @@ ## Properties -### Blob +### Blob -• **Blob**: *object* +• **Blob**: _object_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16514 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 #### Type declaration: -* **new __type**(`blobParts?`: BlobPart[], `options?`: BlobPropertyBag): *Blob* +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ -* **prototype**: *Blob* +### URL -___ +• **URL**: _object_ -### URL +_Inherited from void_ -• **URL**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16515 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 #### Type declaration: -* **new __type**(`url`: string, `base?`: string | URL): *URL* - -* **prototype**: *URL* - -* **createObjectURL**(`object`: any): *string* +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ -* **revokeObjectURL**(`url`: string): *void* +### URLSearchParams -___ +• **URLSearchParams**: _object_ -### URLSearchParams +_Inherited from void_ -• **URLSearchParams**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 #### Type declaration: -* **new __type**(`init?`: string[][] | Record‹string, string› | string | URLSearchParams): *URLSearchParams* - -* **prototype**: *URLSearchParams* - -___ - -### applicationCache - -• **applicationCache**: *ApplicationCache* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16517 - -___ - -### caches - -• **caches**: *CacheStorage* - -*Inherited from void* - -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16518 - -___ - -### clientInformation - -• **clientInformation**: *Navigator* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16519 - -___ - -### closed - -• **closed**: *boolean* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16520 - -___ - -### console +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ -• **console**: *Console* +### applicationCache -*Inherited from void* +• **applicationCache**: _ApplicationCache_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16655 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 -### crypto +### caches -• **crypto**: *Crypto* +• **caches**: _CacheStorage_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16521 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 -___ +### clientInformation -### customElements +• **clientInformation**: _Navigator_ -• **customElements**: *CustomElementRegistry* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16522 +### closed -___ +• **closed**: _boolean_ -### defaultStatus +_Inherited from void_ -• **defaultStatus**: *string* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 -*Inherited from void* +### console -Defined in node_modules/typescript/lib/lib.dom.d.ts:16523 +• **console**: _Console_ -___ +_Inherited from void_ -### devicePixelRatio +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 -• **devicePixelRatio**: *number* +### crypto -*Inherited from void* +• **crypto**: _Crypto_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16524 +_Inherited from void_ -___ +_Overrides void_ -### doNotTrack +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 -• **doNotTrack**: *string* +### customElements -*Inherited from void* +• **customElements**: _CustomElementRegistry_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16525 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 -### document +### defaultStatus -• **document**: *Document* +• **defaultStatus**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16526 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 -___ +### devicePixelRatio -### ethereum +• **devicePixelRatio**: _number_ -• **ethereum**: *[Ethereum](_browserutils_.ethereum.md)* +_Inherited from void_ -*Overrides [ExtendedWindow](_browserutils_.extendedwindow.md).[ethereum](_browserutils_.extendedwindow.md#optional-ethereum)* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 -*Defined in [src/browserUtils.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L36)* +### doNotTrack -___ +• **doNotTrack**: _string_ -### event +_Inherited from void_ -• **event**: *Event | undefined* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 -*Inherited from void* +### document -Defined in node_modules/typescript/lib/lib.dom.d.ts:16527 +• **document**: _Document_ -___ +_Inherited from void_ -### external +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 -• **external**: *External* +### ethereum -*Inherited from void* +• **ethereum**: [_Ethereum_](_browserutils_.ethereum.md) -Defined in node_modules/typescript/lib/lib.dom.d.ts:16529 +_Overrides_ [_ExtendedWindow_](_browserutils_.extendedwindow.md)_._[_ethereum_](_browserutils_.extendedwindow.md#optional-ethereum) -**`deprecated`** +_Defined in_ [_src/browserUtils.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L36) -___ +### event -### frameElement +• **event**: _Event \| undefined_ -• **frameElement**: *Element* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16530 +### external -___ +• **external**: _External_ -### frames +_Inherited from void_ -• **frames**: *Window* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 -*Inherited from void* +**`deprecated`** -Defined in node_modules/typescript/lib/lib.dom.d.ts:16531 +### frameElement -___ +• **frameElement**: _Element_ -### history +_Inherited from void_ -• **history**: *History* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 -*Inherited from void* +### frames -Defined in node_modules/typescript/lib/lib.dom.d.ts:16532 +• **frames**: _Window_ -___ +_Inherited from void_ -### indexedDB +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 -• **indexedDB**: *IDBFactory* +### history -*Inherited from void* +• **history**: _History_ -*Overrides void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:8824 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 -___ +### indexedDB -### innerHeight +• **indexedDB**: _IDBFactory_ -• **innerHeight**: *number* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16533 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 -___ +### innerHeight -### innerWidth +• **innerHeight**: _number_ -• **innerWidth**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16534 +### innerWidth -___ +• **innerWidth**: _number_ -### isSecureContext +_Inherited from void_ -• **isSecureContext**: *boolean* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 -*Inherited from void* +### isSecureContext -Defined in node_modules/typescript/lib/lib.dom.d.ts:16535 +• **isSecureContext**: _boolean_ -___ +_Inherited from void_ -### length +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 -• **length**: *number* +### length -*Inherited from void* +• **length**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16536 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 -### localStorage +### localStorage -• **localStorage**: *Storage* +• **localStorage**: _Storage_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16701 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 -___ +### location -### location +• **location**: _Location_ -• **location**: *Location* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16537 +### locationbar -___ +• **locationbar**: _BarProp_ -### locationbar +_Inherited from void_ -• **locationbar**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 -*Inherited from void* +### menubar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16538 +• **menubar**: _BarProp_ -___ +_Inherited from void_ -### menubar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 -• **menubar**: *BarProp* +### msContentScript -*Inherited from void* +• **msContentScript**: _ExtensionScriptApis_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16539 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 -### msContentScript +### name -• **msContentScript**: *ExtensionScriptApis* +• **name**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16540 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 -___ +### navigator -### name +• **navigator**: _Navigator_ -• **name**: *string* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16541 +### offscreenBuffering -___ +• **offscreenBuffering**: _string \| boolean_ -### navigator +_Inherited from void_ -• **navigator**: *Navigator* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 -*Inherited from void* +### onabort -Defined in node_modules/typescript/lib/lib.dom.d.ts:16542 +• **onabort**: _function \| null_ -___ +_Inherited from void_ -### offscreenBuffering - -• **offscreenBuffering**: *string | boolean* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16543 - -___ - -### onabort - -• **onabort**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5387 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 Fires when the user aborts the download. **`param`** The event. -___ - -### onafterprint - -• **onafterprint**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16678 - -___ - -### onanimationcancel - -• **onanimationcancel**: *function | null* +### onafterprint -*Inherited from void* +• **onafterprint**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5388 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 -### onanimationend +### onanimationcancel -• **onanimationend**: *function | null* +• **onanimationcancel**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5389 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 -___ +### onanimationend -### onanimationiteration +• **onanimationend**: _function \| null_ -• **onanimationiteration**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5390 +### onanimationiteration -___ +• **onanimationiteration**: _function \| null_ -### onanimationstart +_Inherited from void_ -• **onanimationstart**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 -*Inherited from void* +### onanimationstart -Defined in node_modules/typescript/lib/lib.dom.d.ts:5391 +• **onanimationstart**: _function \| null_ -___ +_Inherited from void_ -### onauxclick +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 -• **onauxclick**: *function | null* +### onauxclick -*Inherited from void* +• **onauxclick**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5392 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 -### onbeforeprint +### onbeforeprint -• **onbeforeprint**: *function | null* +• **onbeforeprint**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16679 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 -___ +### onbeforeunload -### onbeforeunload +• **onbeforeunload**: _function \| null_ -• **onbeforeunload**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16680 +### onblur -___ +• **onblur**: _function \| null_ -### onblur +_Inherited from void_ -• **onblur**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5397 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 Fires when the object loses the input focus. **`param`** The focus event. -___ - -### oncancel - -• **oncancel**: *function | null* +### oncancel -*Inherited from void* +• **oncancel**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5398 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 -### oncanplay +### oncanplay -• **oncanplay**: *function | null* +• **oncanplay**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5403 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 Occurs when playback is possible, but would require further buffering. **`param`** The event. -___ +### oncanplaythrough -### oncanplaythrough +• **oncanplaythrough**: _function \| null_ -• **oncanplaythrough**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5404 +### onchange -___ +• **onchange**: _function \| null_ -### onchange +_Inherited from void_ -• **onchange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5409 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 Fires when the contents of the object or selection have changed. **`param`** The event. -___ +### onclick -### onclick +• **onclick**: _function \| null_ -• **onclick**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5414 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 Fires when the user clicks the left mouse button on the object **`param`** The mouse event. -___ - -### onclose +### onclose -• **onclose**: *function | null* +• **onclose**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5415 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 -___ +### oncompassneedscalibration -### oncompassneedscalibration +• **oncompassneedscalibration**: _function \| null_ -• **oncompassneedscalibration**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16544 +### oncontextmenu -___ +• **oncontextmenu**: _function \| null_ -### oncontextmenu +_Inherited from void_ -• **oncontextmenu**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5420 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 Fires when the user clicks the right mouse button in the client area, opening the context menu. **`param`** The mouse event. -___ - -### oncuechange - -• **oncuechange**: *function | null* +### oncuechange -*Inherited from void* +• **oncuechange**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5421 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 -### ondblclick +### ondblclick -• **ondblclick**: *function | null* +• **ondblclick**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5426 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 Fires when the user double-clicks the object. **`param`** The mouse event. -___ - -### ondevicelight - -• **ondevicelight**: *function | null* - -*Inherited from void* +### ondevicelight -Defined in node_modules/typescript/lib/lib.dom.d.ts:16545 +• **ondevicelight**: _function \| null_ -___ +_Inherited from void_ -### ondevicemotion +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 -• **ondevicemotion**: *function | null* +### ondevicemotion -*Inherited from void* +• **ondevicemotion**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16546 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 -### ondeviceorientation +### ondeviceorientation -• **ondeviceorientation**: *function | null* +• **ondeviceorientation**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16547 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 -___ +### ondrag -### ondrag +• **ondrag**: _function \| null_ -• **ondrag**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5431 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 Fires on the source object continuously during a drag operation. **`param`** The event. -___ - -### ondragend +### ondragend -• **ondragend**: *function | null* +• **ondragend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5436 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 Fires on the source object when the user releases the mouse at the close of a drag operation. **`param`** The event. -___ +### ondragenter -### ondragenter +• **ondragenter**: _function \| null_ -• **ondragenter**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5441 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 Fires on the target element when the user drags the object to a valid drop target. **`param`** The drag event. -___ - -### ondragexit +### ondragexit -• **ondragexit**: *function | null* +• **ondragexit**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5442 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 -___ +### ondragleave -### ondragleave +• **ondragleave**: _function \| null_ -• **ondragleave**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5447 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. **`param`** The drag event. -___ - -### ondragover +### ondragover -• **ondragover**: *function | null* +• **ondragover**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5452 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 Fires on the target element continuously while the user drags the object over a valid drop target. **`param`** The event. -___ +### ondragstart -### ondragstart +• **ondragstart**: _function \| null_ -• **ondragstart**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5457 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 Fires on the source object when the user starts to drag a text selection or selected object. **`param`** The event. -___ - -### ondrop +### ondrop -• **ondrop**: *function | null* +• **ondrop**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5458 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 -___ +### ondurationchange -### ondurationchange +• **ondurationchange**: _function \| null_ -• **ondurationchange**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5463 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 Occurs when the duration attribute is updated. **`param`** The event. -___ - -### onemptied +### onemptied -• **onemptied**: *function | null* +• **onemptied**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5468 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 Occurs when the media element is reset to its initial state. **`param`** The event. -___ +### onended -### onended +• **onended**: _function \| null_ -• **onended**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5473 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 Occurs when the end of playback is reached. **`param`** The event -___ - -### onerror +### onerror -• **onerror**: *ErrorEventHandler* +• **onerror**: _ErrorEventHandler_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5478 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 Fires when an error occurs during object loading. **`param`** The event. -___ +### onfocus -### onfocus +• **onfocus**: _function \| null_ -• **onfocus**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5483 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 Fires when the object receives focus. **`param`** The event. -___ - -### ongotpointercapture - -• **ongotpointercapture**: *function | null* +### ongotpointercapture -*Inherited from void* +• **ongotpointercapture**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5484 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 -### onhashchange +### onhashchange -• **onhashchange**: *function | null* +• **onhashchange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16681 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 -___ +### oninput -### oninput +• **oninput**: _function \| null_ -• **oninput**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5485 +### oninvalid -___ +• **oninvalid**: _function \| null_ -### oninvalid +_Inherited from void_ -• **oninvalid**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 -*Inherited from void* +### onkeydown -Defined in node_modules/typescript/lib/lib.dom.d.ts:5486 +• **onkeydown**: _function \| null_ -___ +_Inherited from void_ -### onkeydown - -• **onkeydown**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5491 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 Fires when the user presses a key. **`param`** The keyboard event -___ - -### onkeypress +### onkeypress -• **onkeypress**: *function | null* +• **onkeypress**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5496 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 Fires when the user presses an alphanumeric key. **`param`** The event. -___ +### onkeyup -### onkeyup +• **onkeyup**: _function \| null_ -• **onkeyup**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5501 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 Fires when the user releases a key. **`param`** The keyboard event -___ - -### onlanguagechange +### onlanguagechange -• **onlanguagechange**: *function | null* +• **onlanguagechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16682 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 -___ +### onload -### onload +• **onload**: _function \| null_ -• **onload**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5506 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 Fires immediately after the browser loads the object. **`param`** The event. -___ - -### onloadeddata +### onloadeddata -• **onloadeddata**: *function | null* +• **onloadeddata**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5511 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 Occurs when media data is loaded at the current playback position. **`param`** The event. -___ +### onloadedmetadata -### onloadedmetadata +• **onloadedmetadata**: _function \| null_ -• **onloadedmetadata**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 Occurs when the duration and dimensions of the media have been determined. **`param`** The event. -___ - -### onloadend +### onloadend -• **onloadend**: *function | null* +• **onloadend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5517 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 -___ +### onloadstart -### onloadstart +• **onloadstart**: _function \| null_ -• **onloadstart**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5522 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 Occurs when Internet Explorer begins looking for media data. **`param`** The event. -___ - -### onlostpointercapture - -• **onlostpointercapture**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5523 +### onlostpointercapture -___ +• **onlostpointercapture**: _function \| null_ -### onmessage +_Inherited from void_ -• **onmessage**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 -*Inherited from void* +### onmessage -Defined in node_modules/typescript/lib/lib.dom.d.ts:16683 +• **onmessage**: _function \| null_ -___ +_Inherited from void_ -### onmessageerror +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 -• **onmessageerror**: *function | null* +### onmessageerror -*Inherited from void* +• **onmessageerror**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16684 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 -### onmousedown +### onmousedown -• **onmousedown**: *function | null* +• **onmousedown**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5528 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 Fires when the user clicks the object with either mouse button. **`param`** The mouse event. -___ +### onmouseenter -### onmouseenter +• **onmouseenter**: _function \| null_ -• **onmouseenter**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5529 +### onmouseleave -___ +• **onmouseleave**: _function \| null_ -### onmouseleave +_Inherited from void_ -• **onmouseleave**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 -*Inherited from void* +### onmousemove -Defined in node_modules/typescript/lib/lib.dom.d.ts:5530 +• **onmousemove**: _function \| null_ -___ +_Inherited from void_ -### onmousemove - -• **onmousemove**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5535 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 Fires when the user moves the mouse over the object. **`param`** The mouse event. -___ - -### onmouseout +### onmouseout -• **onmouseout**: *function | null* +• **onmouseout**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5540 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 Fires when the user moves the mouse pointer outside the boundaries of the object. **`param`** The mouse event. -___ +### onmouseover -### onmouseover +• **onmouseover**: _function \| null_ -• **onmouseover**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5545 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 Fires when the user moves the mouse pointer into the object. **`param`** The mouse event. -___ - -### onmouseup +### onmouseup -• **onmouseup**: *function | null* +• **onmouseup**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5550 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 Fires when the user releases a mouse button while the mouse is over the object. **`param`** The mouse event. -___ - -### onmousewheel - -• **onmousewheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16548 - -___ - -### onmsgesturechange - -• **onmsgesturechange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16549 +### onmousewheel -___ +• **onmousewheel**: _function \| null_ -### onmsgesturedoubletap +_Inherited from void_ -• **onmsgesturedoubletap**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 -*Inherited from void* +### onmsgesturechange -Defined in node_modules/typescript/lib/lib.dom.d.ts:16550 +• **onmsgesturechange**: _function \| null_ -___ +_Inherited from void_ -### onmsgestureend +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 -• **onmsgestureend**: *function | null* +### onmsgesturedoubletap -*Inherited from void* +• **onmsgesturedoubletap**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16551 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 -### onmsgesturehold +### onmsgestureend -• **onmsgesturehold**: *function | null* +• **onmsgestureend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16552 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 -___ +### onmsgesturehold -### onmsgesturestart +• **onmsgesturehold**: _function \| null_ -• **onmsgesturestart**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16553 +### onmsgesturestart -___ +• **onmsgesturestart**: _function \| null_ -### onmsgesturetap +_Inherited from void_ -• **onmsgesturetap**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 -*Inherited from void* +### onmsgesturetap -Defined in node_modules/typescript/lib/lib.dom.d.ts:16554 +• **onmsgesturetap**: _function \| null_ -___ +_Inherited from void_ -### onmsinertiastart +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 -• **onmsinertiastart**: *function | null* +### onmsinertiastart -*Inherited from void* +• **onmsinertiastart**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16555 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 -### onmspointercancel +### onmspointercancel -• **onmspointercancel**: *function | null* +• **onmspointercancel**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16556 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 -___ +### onmspointerdown -### onmspointerdown +• **onmspointerdown**: _function \| null_ -• **onmspointerdown**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16557 +### onmspointerenter -___ +• **onmspointerenter**: _function \| null_ -### onmspointerenter +_Inherited from void_ -• **onmspointerenter**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 -*Inherited from void* +### onmspointerleave -Defined in node_modules/typescript/lib/lib.dom.d.ts:16558 +• **onmspointerleave**: _function \| null_ -___ +_Inherited from void_ -### onmspointerleave +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 -• **onmspointerleave**: *function | null* +### onmspointermove -*Inherited from void* +• **onmspointermove**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16559 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 -### onmspointermove +### onmspointerout -• **onmspointermove**: *function | null* +• **onmspointerout**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16560 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 -___ +### onmspointerover -### onmspointerout +• **onmspointerover**: _function \| null_ -• **onmspointerout**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16561 +### onmspointerup -___ +• **onmspointerup**: _function \| null_ -### onmspointerover +_Inherited from void_ -• **onmspointerover**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 -*Inherited from void* +### onoffline -Defined in node_modules/typescript/lib/lib.dom.d.ts:16562 +• **onoffline**: _function \| null_ -___ +_Inherited from void_ -### onmspointerup +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 -• **onmspointerup**: *function | null* +### ononline -*Inherited from void* +• **ononline**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16563 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 -### onoffline +### onorientationchange -• **onoffline**: *function | null* +• **onorientationchange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16685 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 -___ +**`deprecated`** -### ononline +### onpagehide -• **ononline**: *function | null* +• **onpagehide**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16686 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 -___ +### onpageshow -### onorientationchange +• **onpageshow**: _function \| null_ -• **onorientationchange**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16565 +### onpause -**`deprecated`** +• **onpause**: _function \| null_ -___ +_Inherited from void_ -### onpagehide - -• **onpagehide**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16687 - -___ - -### onpageshow - -• **onpageshow**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16688 - -___ - -### onpause - -• **onpause**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5555 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 Occurs when playback is paused. **`param`** The event. -___ - -### onplay +### onplay -• **onplay**: *function | null* +• **onplay**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5560 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 Occurs when the play method is requested. **`param`** The event. -___ - -### onplaying +### onplaying -• **onplaying**: *function | null* +• **onplaying**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5565 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 Occurs when the audio or video has started playing. **`param`** The event. -___ +### onpointercancel -### onpointercancel +• **onpointercancel**: _function \| null_ -• **onpointercancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5566 +### onpointerdown -___ +• **onpointerdown**: _function \| null_ -### onpointerdown +_Inherited from void_ -• **onpointerdown**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 -*Inherited from void* +### onpointerenter -Defined in node_modules/typescript/lib/lib.dom.d.ts:5567 +• **onpointerenter**: _function \| null_ -___ +_Inherited from void_ -### onpointerenter +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 -• **onpointerenter**: *function | null* +### onpointerleave -*Inherited from void* +• **onpointerleave**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5568 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 -### onpointerleave +### onpointermove -• **onpointerleave**: *function | null* +• **onpointermove**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5569 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 -___ +### onpointerout -### onpointermove +• **onpointerout**: _function \| null_ -• **onpointermove**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5570 +### onpointerover -___ +• **onpointerover**: _function \| null_ -### onpointerout +_Inherited from void_ -• **onpointerout**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 -*Inherited from void* +### onpointerup -Defined in node_modules/typescript/lib/lib.dom.d.ts:5571 +• **onpointerup**: _function \| null_ -___ +_Inherited from void_ -### onpointerover +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 -• **onpointerover**: *function | null* +### onpopstate -*Inherited from void* +• **onpopstate**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5572 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 -### onpointerup +### onprogress -• **onpointerup**: *function | null* +• **onprogress**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5573 - -___ - -### onpopstate - -• **onpopstate**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16689 - -___ - -### onprogress - -• **onprogress**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5578 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 Occurs to indicate progress while downloading media data. **`param`** The event. -___ +### onratechange -### onratechange +• **onratechange**: _function \| null_ -• **onratechange**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5583 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 Occurs when the playback rate is increased or decreased. **`param`** The event. -___ - -### onreadystatechange +### onreadystatechange -• **onreadystatechange**: *function | null* +• **onreadystatechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16566 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 -___ +### onrejectionhandled -### onrejectionhandled +• **onrejectionhandled**: _function \| null_ -• **onrejectionhandled**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16690 +### onreset -___ +• **onreset**: _function \| null_ -### onreset +_Inherited from void_ -• **onreset**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5588 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 Fires when the user resets a form. **`param`** The event. -___ - -### onresize +### onresize -• **onresize**: *function | null* +• **onresize**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5589 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 -___ +### onscroll -### onscroll +• **onscroll**: _function \| null_ -• **onscroll**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5594 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 Fires when the user repositions the scroll box in the scroll bar on the object. **`param`** The event. -___ - -### onsecuritypolicyviolation +### onsecuritypolicyviolation -• **onsecuritypolicyviolation**: *function | null* +• **onsecuritypolicyviolation**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5595 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 -___ +### onseeked -### onseeked +• **onseeked**: _function \| null_ -• **onseeked**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5600 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 Occurs when the seek operation ends. **`param`** The event. -___ - -### onseeking +### onseeking -• **onseeking**: *function | null* +• **onseeking**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5605 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 Occurs when the current playback position is moved. **`param`** The event. -___ +### onselect -### onselect +• **onselect**: _function \| null_ -• **onselect**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5610 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 Fires when the current selection changes. **`param`** The event. -___ - -### onstalled +### onstalled -• **onstalled**: *function | null* +• **onstalled**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 Occurs when the download has stopped. **`param`** The event. -___ - -### onstorage - -• **onstorage**: *function | null* +### onstorage -*Inherited from void* +• **onstorage**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16691 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 -### onsubmit +### onsubmit -• **onsubmit**: *function | null* +• **onsubmit**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5616 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 -___ +### onsuspend -### onsuspend +• **onsuspend**: _function \| null_ -• **onsuspend**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 Occurs if the load operation has been intentionally halted. **`param`** The event. -___ - -### ontimeupdate +### ontimeupdate -• **ontimeupdate**: *function | null* +• **ontimeupdate**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 Occurs to indicate the current playback position. **`param`** The event. -___ - -### ontoggle - -• **ontoggle**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5627 - -___ +### ontoggle -### ontouchcancel +• **ontoggle**: _function \| null_ -• **ontouchcancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5628 +### ontouchcancel -___ +• **ontouchcancel**: _function \| null_ -### ontouchend +_Inherited from void_ -• **ontouchend**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 -*Inherited from void* +### ontouchend -Defined in node_modules/typescript/lib/lib.dom.d.ts:5629 +• **ontouchend**: _function \| null_ -___ +_Inherited from void_ -### ontouchmove +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 -• **ontouchmove**: *function | null* +### ontouchmove -*Inherited from void* +• **ontouchmove**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5630 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 -### ontouchstart +### ontouchstart -• **ontouchstart**: *function | null* +• **ontouchstart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5631 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 -___ +### ontransitioncancel -### ontransitioncancel +• **ontransitioncancel**: _function \| null_ -• **ontransitioncancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5632 +### ontransitionend -___ +• **ontransitionend**: _function \| null_ -### ontransitionend +_Inherited from void_ -• **ontransitionend**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 -*Inherited from void* +### ontransitionrun -Defined in node_modules/typescript/lib/lib.dom.d.ts:5633 +• **ontransitionrun**: _function \| null_ -___ +_Inherited from void_ -### ontransitionrun +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 -• **ontransitionrun**: *function | null* +### ontransitionstart -*Inherited from void* +• **ontransitionstart**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5634 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 -### ontransitionstart +### onunhandledrejection -• **ontransitionstart**: *function | null* +• **onunhandledrejection**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5635 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 -___ +### onunload -### onunhandledrejection +• **onunload**: _function \| null_ -• **onunhandledrejection**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16692 +### onvolumechange -___ +• **onvolumechange**: _function \| null_ -### onunload +_Inherited from void_ -• **onunload**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16693 - -___ - -### onvolumechange - -• **onvolumechange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 Occurs when the volume is changed, or playback is muted or unmuted. **`param`** The event. -___ - -### onvrdisplayactivate - -• **onvrdisplayactivate**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16567 - -___ - -### onvrdisplayblur - -• **onvrdisplayblur**: *function | null* - -*Inherited from void* +### onvrdisplayactivate -Defined in node_modules/typescript/lib/lib.dom.d.ts:16568 +• **onvrdisplayactivate**: _function \| null_ -___ +_Inherited from void_ -### onvrdisplayconnect +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 -• **onvrdisplayconnect**: *function | null* +### onvrdisplayblur -*Inherited from void* +• **onvrdisplayblur**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16569 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 -### onvrdisplaydeactivate +### onvrdisplayconnect -• **onvrdisplaydeactivate**: *function | null* +• **onvrdisplayconnect**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16570 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 -___ +### onvrdisplaydeactivate -### onvrdisplaydisconnect +• **onvrdisplaydeactivate**: _function \| null_ -• **onvrdisplaydisconnect**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16571 +### onvrdisplaydisconnect -___ +• **onvrdisplaydisconnect**: _function \| null_ -### onvrdisplayfocus +_Inherited from void_ -• **onvrdisplayfocus**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 -*Inherited from void* +### onvrdisplayfocus -Defined in node_modules/typescript/lib/lib.dom.d.ts:16572 +• **onvrdisplayfocus**: _function \| null_ -___ +_Inherited from void_ -### onvrdisplaypointerrestricted +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 -• **onvrdisplaypointerrestricted**: *function | null* +### onvrdisplaypointerrestricted -*Inherited from void* +• **onvrdisplaypointerrestricted**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16573 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 -### onvrdisplaypointerunrestricted +### onvrdisplaypointerunrestricted -• **onvrdisplaypointerunrestricted**: *function | null* +• **onvrdisplaypointerunrestricted**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16574 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 -___ +### onvrdisplaypresentchange -### onvrdisplaypresentchange +• **onvrdisplaypresentchange**: _function \| null_ -• **onvrdisplaypresentchange**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16575 +### onwaiting -___ +• **onwaiting**: _function \| null_ -### onwaiting +_Inherited from void_ -• **onwaiting**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5645 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 Occurs when playback stops because the next frame of a video resource is not available. **`param`** The event. -___ - -### onwheel - -• **onwheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5646 - -___ - -### opener - -• **opener**: *any* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16576 - -___ - -### orientation - -• **orientation**: *string | number* - -*Inherited from void* +### onwheel -Defined in node_modules/typescript/lib/lib.dom.d.ts:16578 +• **onwheel**: _function \| null_ -**`deprecated`** +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 -### origin +### opener -• **origin**: *string* +• **opener**: _any_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16708 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 -___ +### orientation -### outerHeight +• **orientation**: _string \| number_ -• **outerHeight**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16579 +**`deprecated`** -___ +### origin -### outerWidth +• **origin**: _string_ -• **outerWidth**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16580 +### outerHeight -___ +• **outerHeight**: _number_ -### pageXOffset +_Inherited from void_ -• **pageXOffset**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 -*Inherited from void* +### outerWidth -Defined in node_modules/typescript/lib/lib.dom.d.ts:16581 +• **outerWidth**: _number_ -___ +_Inherited from void_ -### pageYOffset +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 -• **pageYOffset**: *number* +### pageXOffset -*Inherited from void* +• **pageXOffset**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16582 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 -### parent +### pageYOffset -• **parent**: *Window* +• **pageYOffset**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16583 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 -___ +### parent -### performance +• **parent**: _Window_ -• **performance**: *Performance* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 -*Overrides void* +### performance -Defined in node_modules/typescript/lib/lib.dom.d.ts:16584 +• **performance**: _Performance_ -___ +_Inherited from void_ -### personalbar +_Overrides void_ -• **personalbar**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 -*Inherited from void* +### personalbar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16585 +• **personalbar**: _BarProp_ -___ +_Inherited from void_ -### screen +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 -• **screen**: *Screen* +### screen -*Inherited from void* +• **screen**: _Screen_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16586 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 -### screenLeft +### screenLeft -• **screenLeft**: *number* +• **screenLeft**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16587 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 -___ +### screenTop -### screenTop +• **screenTop**: _number_ -• **screenTop**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16588 +### screenX -___ +• **screenX**: _number_ -### screenX +_Inherited from void_ -• **screenX**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 -*Inherited from void* +### screenY -Defined in node_modules/typescript/lib/lib.dom.d.ts:16589 +• **screenY**: _number_ -___ +_Inherited from void_ -### screenY +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 -• **screenY**: *number* +### scrollX -*Inherited from void* +• **scrollX**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16590 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 -### scrollX +### scrollY -• **scrollX**: *number* +• **scrollY**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16591 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 -___ +### scrollbars -### scrollY +• **scrollbars**: _BarProp_ -• **scrollY**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16592 +### self -___ +• **self**: _Window_ -### scrollbars +_Inherited from void_ -• **scrollbars**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 -*Inherited from void* +### sessionStorage -Defined in node_modules/typescript/lib/lib.dom.d.ts:16593 +• **sessionStorage**: _Storage_ -___ +_Inherited from void_ -### self +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 -• **self**: *Window* +### speechSynthesis -*Inherited from void* +• **speechSynthesis**: _SpeechSynthesis_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16594 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 -### sessionStorage +### status -• **sessionStorage**: *Storage* +• **status**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16723 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 -___ +### statusbar -### speechSynthesis +• **statusbar**: _BarProp_ -• **speechSynthesis**: *SpeechSynthesis* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16595 +### styleMedia -___ +• **styleMedia**: _StyleMedia_ -### status +_Inherited from void_ -• **status**: *string* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 -*Inherited from void* +### toolbar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16596 +• **toolbar**: _BarProp_ -___ +_Inherited from void_ -### statusbar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 -• **statusbar**: *BarProp* +### top -*Inherited from void* +• **top**: _Window_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16597 +_Inherited from void_ -___ - -### styleMedia - -• **styleMedia**: *StyleMedia* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16598 - -___ - -### toolbar - -• **toolbar**: *BarProp* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16599 - -___ - -### top - -• **top**: *Window* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16600 - -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 ### `Optional` web3 -• **web3**? : *[InjectedWeb3](_browserutils_.injectedweb3.md)* +• **web3**? : [_InjectedWeb3_](_browserutils_.injectedweb3.md) -*Inherited from [ExtendedWindow](_browserutils_.extendedwindow.md).[web3](_browserutils_.extendedwindow.md#optional-web3)* +_Inherited from_ [_ExtendedWindow_](_browserutils_.extendedwindow.md)_._[_web3_](_browserutils_.extendedwindow.md#optional-web3) -*Defined in [src/browserUtils.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32)* +_Defined in_ [_src/browserUtils.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L32) -___ +### window -### window +• **window**: _Window_ -• **window**: *Window* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16601 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 ## Methods -### addEventListener +### addEventListener -▸ **addEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16638 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | AddEventListenerOptions* +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **addEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16639 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | AddEventListenerOptions | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | -___ +**Returns:** _void_ -### alert +### alert -▸ **alert**(`message?`: any): *void* +▸ **alert**\(`message?`: any\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16602 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 **Parameters:** -Name | Type | ------- | ------ | -`message?` | any | +| Name | Type | +| :--- | :--- | +| `message?` | any | -**Returns:** *void* +**Returns:** _void_ -___ +### atob -### atob +▸ **atob**\(`encodedString`: string\): _string_ -▸ **atob**(`encodedString`: string): *string* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16650 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 **Parameters:** -Name | Type | ------- | ------ | -`encodedString` | string | - -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `encodedString` | string | -___ +**Returns:** _string_ -### blur +### blur -▸ **blur**(): *void* +▸ **blur**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16603 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 -**Returns:** *void* +**Returns:** _void_ -___ +### btoa -### btoa +▸ **btoa**\(`rawString`: string\): _string_ -▸ **btoa**(`rawString`: string): *string* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16651 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 **Parameters:** -Name | Type | ------- | ------ | -`rawString` | string | - -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `rawString` | string | -___ +**Returns:** _string_ -### cancelAnimationFrame +### cancelAnimationFrame -▸ **cancelAnimationFrame**(`handle`: number): *void* +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16604 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `handle` | number | -### captureEvents +**Returns:** _void_ -▸ **captureEvents**(): *void* +### captureEvents -*Inherited from void* +▸ **captureEvents**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16606 +_Inherited from void_ -**`deprecated`** +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 -**Returns:** *void* +**`deprecated`** -___ +**Returns:** _void_ -### clearInterval +### clearInterval -▸ **clearInterval**(`handle?`: undefined | number): *void* +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16712 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -**Returns:** *void* +**Returns:** _void_ -___ +### clearTimeout -### clearTimeout +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ -▸ **clearTimeout**(`handle?`: undefined | number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16713 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -___ +**Returns:** _void_ -### close +### close -▸ **close**(): *void* +▸ **close**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16607 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 -**Returns:** *void* +**Returns:** _void_ -___ +### confirm -### confirm +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ -▸ **confirm**(`message?`: undefined | string): *boolean* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16608 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | - -**Returns:** *boolean* +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | -___ +**Returns:** _boolean_ -### createImageBitmap +### createImageBitmap -▸ **createImageBitmap**(`image`: ImageBitmapSource): *Promise‹ImageBitmap›* +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16714 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | -**Returns:** *Promise‹ImageBitmap›* +**Returns:** _Promise‹ImageBitmap›_ -▸ **createImageBitmap**(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number): *Promise‹ImageBitmap›* +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16715 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | -`sx` | number | -`sy` | number | -`sw` | number | -`sh` | number | +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | -**Returns:** *Promise‹ImageBitmap›* +**Returns:** _Promise‹ImageBitmap›_ -___ +### departFocus -### departFocus +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ -▸ **departFocus**(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16609 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 **Parameters:** -Name | Type | ------- | ------ | -`navigationReason` | NavigationReason | -`origin` | FocusNavigationOrigin | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | -___ +**Returns:** _void_ -### dispatchEvent +### dispatchEvent -▸ **dispatchEvent**(`event`: Event): *boolean* +▸ **dispatchEvent**\(`event`: Event\): _boolean_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5074 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 -Dispatches a synthetic event event to target and returns true -if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. **Parameters:** -Name | Type | ------- | ------ | -`event` | Event | - -**Returns:** *boolean* +| Name | Type | +| :--- | :--- | +| `event` | Event | -___ +**Returns:** _boolean_ -### fetch +### fetch -▸ **fetch**(`input`: RequestInfo, `init?`: RequestInit): *Promise‹Response›* +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5654 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 **Parameters:** -Name | Type | ------- | ------ | -`input` | RequestInfo | -`init?` | RequestInit | +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | -**Returns:** *Promise‹Response›* +**Returns:** _Promise‹Response›_ -___ +### focus -### focus +▸ **focus**\(\): _void_ -▸ **focus**(): *void* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16610 +**Returns:** _void_ -**Returns:** *void* +### getComputedStyle -___ +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ -### getComputedStyle +_Inherited from void_ -▸ **getComputedStyle**(`elt`: Element, `pseudoElt?`: string | null): *CSSStyleDeclaration* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16611 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -**Returns:** *CSSStyleDeclaration* +**Returns:** _CSSStyleDeclaration_ -___ +### getMatchedCSSRules -### getMatchedCSSRules +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ -▸ **getMatchedCSSRules**(`elt`: Element, `pseudoElt?`: string | null): *CSSRuleList* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16612 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | - -**Returns:** *CSSRuleList* +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -___ +**Returns:** _CSSRuleList_ -### getSelection +### getSelection -▸ **getSelection**(): *Selection* +▸ **getSelection**\(\): _Selection_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16613 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 -**Returns:** *Selection* +**Returns:** _Selection_ -___ +### matchMedia -### matchMedia +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ -▸ **matchMedia**(`query`: string): *MediaQueryList* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16614 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 **Parameters:** -Name | Type | ------- | ------ | -`query` | string | - -**Returns:** *MediaQueryList* +| Name | Type | +| :--- | :--- | +| `query` | string | -___ +**Returns:** _MediaQueryList_ -### moveBy +### moveBy -▸ **moveBy**(`x`: number, `y`: number): *void* +▸ **moveBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### moveTo -### moveTo +▸ **moveTo**\(`x`: number, `y`: number\): _void_ -▸ **moveTo**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16616 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### msWriteProfilerMark +### msWriteProfilerMark -▸ **msWriteProfilerMark**(`profilerMarkName`: string): *void* +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16617 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 **Parameters:** -Name | Type | ------- | ------ | -`profilerMarkName` | string | +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | -**Returns:** *void* +**Returns:** _void_ -___ +### open -### open +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ -▸ **open**(`url?`: undefined | string, `target?`: undefined | string, `features?`: undefined | string, `replace?`: undefined | false | true): *Window | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16618 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 **Parameters:** -Name | Type | ------- | ------ | -`url?` | undefined | string | -`target?` | undefined | string | -`features?` | undefined | string | -`replace?` | undefined | false | true | - -**Returns:** *Window | null* +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | -___ +**Returns:** _Window \| null_ -### postMessage +### postMessage -▸ **postMessage**(`message`: any, `targetOrigin`: string, `transfer?`: Transferable[]): *void* +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16619 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 **Parameters:** -Name | Type | ------- | ------ | -`message` | any | -`targetOrigin` | string | -`transfer?` | Transferable[] | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | -### print +**Returns:** _void_ -▸ **print**(): *void* +### print -*Inherited from void* +▸ **print**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16620 +_Inherited from void_ -**Returns:** *void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 -___ +**Returns:** _void_ -### prompt +### prompt -▸ **prompt**(`message?`: undefined | string, `_default?`: undefined | string): *string | null* +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | -`_default?` | undefined | string | +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | -**Returns:** *string | null* +**Returns:** _string \| null_ -___ +### queueMicrotask -### queueMicrotask +▸ **queueMicrotask**\(`callback`: Function\): _void_ -▸ **queueMicrotask**(`callback`: Function): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16717 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 **Parameters:** -Name | Type | ------- | ------ | -`callback` | Function | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `callback` | Function | -### releaseEvents +**Returns:** _void_ -▸ **releaseEvents**(): *void* +### releaseEvents -*Inherited from void* +▸ **releaseEvents**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16623 +_Inherited from void_ -**`deprecated`** +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 -**Returns:** *void* +**`deprecated`** -___ +**Returns:** _void_ -### removeEventListener +### removeEventListener -▸ **removeEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | EventListenerOptions): *void* +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | EventListenerOptions* +▪`Optional` **options**: _boolean \| EventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **removeEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | EventListenerOptions): *void* +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16641 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | EventListenerOptions | +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | -**Returns:** *void* +**Returns:** _void_ -___ +### requestAnimationFrame -### requestAnimationFrame +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -▸ **requestAnimationFrame**(`callback`: FrameRequestCallback): *number* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16624 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | - -**Returns:** *number* +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | -___ +**Returns:** _number_ -### resizeBy +### resizeBy -▸ **resizeBy**(`x`: number, `y`: number): *void* +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16625 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### resizeTo -### resizeTo +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ -▸ **resizeTo**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### scroll +### scroll -▸ **scroll**(`options?`: ScrollToOptions): *void* +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16627 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scroll**(`x`: number, `y`: number): *void* +▸ **scroll**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16628 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### scrollBy -### scrollBy +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ -▸ **scrollBy**(`options?`: ScrollToOptions): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16629 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollBy**(`x`: number, `y`: number): *void* +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16630 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### scrollTo +### scrollTo -▸ **scrollTo**(`options?`: ScrollToOptions): *void* +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16631 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollTo**(`x`: number, `y`: number): *void* +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16632 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### setInterval +### setInterval -▸ **setInterval**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16718 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -**Returns:** *number* +**Returns:** _number_ -___ +### setTimeout -### setTimeout +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -▸ **setTimeout**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16719 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | - -**Returns:** *number* +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -___ +**Returns:** _number_ -### stop +### stop -▸ **stop**(): *void* +▸ **stop**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16633 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 -**Returns:** *void* +**Returns:** _void_ -___ +### webkitCancelAnimationFrame -### webkitCancelAnimationFrame +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ -▸ **webkitCancelAnimationFrame**(`handle`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16634 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle` | number | -___ +**Returns:** _void_ -### webkitConvertPointFromNodeToPage +### webkitConvertPointFromNodeToPage -▸ **webkitConvertPointFromNodeToPage**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16635 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -**Returns:** *WebKitPoint* +**Returns:** _WebKitPoint_ -___ +### webkitConvertPointFromPageToNode -### webkitConvertPointFromPageToNode +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -▸ **webkitConvertPointFromPageToNode**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16636 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | - -**Returns:** *WebKitPoint* +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -___ +**Returns:** _WebKitPoint_ -### webkitRequestAnimationFrame +### webkitRequestAnimationFrame -▸ **webkitRequestAnimationFrame**(`callback`: FrameRequestCallback): *number* +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16637 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ -**Returns:** *number* diff --git a/docs/api/interfaces/_browserutils_.windowwithweb3.md b/docs/api/interfaces/_browserutils_.windowwithweb3.md index ee18d60..0c9822d 100644 --- a/docs/api/interfaces/_browserutils_.windowwithweb3.md +++ b/docs/api/interfaces/_browserutils_.windowwithweb3.md @@ -1,10 +1,10 @@ -# Interface: WindowWithWeb3 +# WindowWithWeb3 ## Hierarchy - ↳ [ExtendedWindow](_browserutils_.extendedwindow.md) +↳ [ExtendedWindow](_browserutils_.extendedwindow.md) - ↳ **WindowWithWeb3** +↳ **WindowWithWeb3** ## Index @@ -251,3028 +251,2557 @@ ## Properties -### Blob +### Blob -• **Blob**: *object* +• **Blob**: _object_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16514 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16514 #### Type declaration: -* **new __type**(`blobParts?`: BlobPart[], `options?`: BlobPropertyBag): *Blob* +* **new \_\_type**\(`blobParts?`: BlobPart\[\], `options?`: BlobPropertyBag\): _Blob_ +* **prototype**: _Blob_ -* **prototype**: *Blob* +### URL -___ +• **URL**: _object_ -### URL +_Inherited from void_ -• **URL**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16515 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16515 #### Type declaration: -* **new __type**(`url`: string, `base?`: string | URL): *URL* - -* **prototype**: *URL* - -* **createObjectURL**(`object`: any): *string* +* **new \_\_type**\(`url`: string, `base?`: string \| URL\): _URL_ +* **prototype**: _URL_ +* **createObjectURL**\(`object`: any\): _string_ +* **revokeObjectURL**\(`url`: string\): _void_ -* **revokeObjectURL**(`url`: string): *void* +### URLSearchParams -___ +• **URLSearchParams**: _object_ -### URLSearchParams +_Inherited from void_ -• **URLSearchParams**: *object* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16516 #### Type declaration: -* **new __type**(`init?`: string[][] | Record‹string, string› | string | URLSearchParams): *URLSearchParams* - -* **prototype**: *URLSearchParams* - -___ - -### applicationCache - -• **applicationCache**: *ApplicationCache* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16517 - -___ - -### caches - -• **caches**: *CacheStorage* +* **new \_\_type**\(`init?`: string\[\]\[\] \| Record‹string, string› \| string \| URLSearchParams\): _URLSearchParams_ +* **prototype**: _URLSearchParams_ -*Inherited from void* +### applicationCache -*Overrides void* +• **applicationCache**: _ApplicationCache_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16518 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16517 -### clientInformation +### caches -• **clientInformation**: *Navigator* +• **caches**: _CacheStorage_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16519 +_Overrides void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16518 -### closed +### clientInformation -• **closed**: *boolean* +• **clientInformation**: _Navigator_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16520 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16519 -___ +### closed -### console +• **closed**: _boolean_ -• **console**: *Console* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16520 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16655 +### console -___ +• **console**: _Console_ -### crypto +_Inherited from void_ -• **crypto**: *Crypto* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16655 -*Inherited from void* +### crypto -*Overrides void* +• **crypto**: _Crypto_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16521 +_Inherited from void_ -___ +_Overrides void_ -### customElements +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16521 -• **customElements**: *CustomElementRegistry* +### customElements -*Inherited from void* +• **customElements**: _CustomElementRegistry_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16522 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16522 -### defaultStatus +### defaultStatus -• **defaultStatus**: *string* +• **defaultStatus**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16523 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16523 -___ +### devicePixelRatio -### devicePixelRatio +• **devicePixelRatio**: _number_ -• **devicePixelRatio**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16524 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16524 +### doNotTrack -___ +• **doNotTrack**: _string_ -### doNotTrack +_Inherited from void_ -• **doNotTrack**: *string* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16525 -*Inherited from void* +### document -Defined in node_modules/typescript/lib/lib.dom.d.ts:16525 +• **document**: _Document_ -___ +_Inherited from void_ -### document - -• **document**: *Document* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16526 - -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16526 ### `Optional` ethereum -• **ethereum**? : *[Ethereum](_browserutils_.ethereum.md)* - -*Inherited from [ExtendedWindow](_browserutils_.extendedwindow.md).[ethereum](_browserutils_.extendedwindow.md#optional-ethereum)* - -*Defined in [src/browserUtils.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31)* - -___ - -### event - -• **event**: *Event | undefined* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16527 - -___ - -### external - -• **external**: *External* - -*Inherited from void* +• **ethereum**? : [_Ethereum_](_browserutils_.ethereum.md) -Defined in node_modules/typescript/lib/lib.dom.d.ts:16529 +_Inherited from_ [_ExtendedWindow_](_browserutils_.extendedwindow.md)_._[_ethereum_](_browserutils_.extendedwindow.md#optional-ethereum) -**`deprecated`** +_Defined in_ [_src/browserUtils.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L31) -___ +### event -### frameElement +• **event**: _Event \| undefined_ -• **frameElement**: *Element* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16527 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16530 +### external -___ +• **external**: _External_ -### frames +_Inherited from void_ -• **frames**: *Window* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16529 -*Inherited from void* +**`deprecated`** -Defined in node_modules/typescript/lib/lib.dom.d.ts:16531 +### frameElement -___ +• **frameElement**: _Element_ -### history +_Inherited from void_ -• **history**: *History* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16530 -*Inherited from void* +### frames -Defined in node_modules/typescript/lib/lib.dom.d.ts:16532 +• **frames**: _Window_ -___ +_Inherited from void_ -### indexedDB +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16531 -• **indexedDB**: *IDBFactory* +### history -*Inherited from void* +• **history**: _History_ -*Overrides void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:8824 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16532 -___ +### indexedDB -### innerHeight +• **indexedDB**: _IDBFactory_ -• **innerHeight**: *number* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16533 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:8824 -___ +### innerHeight -### innerWidth +• **innerHeight**: _number_ -• **innerWidth**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16533 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16534 +### innerWidth -___ +• **innerWidth**: _number_ -### isSecureContext +_Inherited from void_ -• **isSecureContext**: *boolean* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16534 -*Inherited from void* +### isSecureContext -Defined in node_modules/typescript/lib/lib.dom.d.ts:16535 +• **isSecureContext**: _boolean_ -___ +_Inherited from void_ -### length +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16535 -• **length**: *number* +### length -*Inherited from void* +• **length**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16536 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16536 -### localStorage +### localStorage -• **localStorage**: *Storage* +• **localStorage**: _Storage_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16701 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16701 -___ +### location -### location +• **location**: _Location_ -• **location**: *Location* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16537 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16537 +### locationbar -___ +• **locationbar**: _BarProp_ -### locationbar +_Inherited from void_ -• **locationbar**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16538 -*Inherited from void* +### menubar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16538 +• **menubar**: _BarProp_ -___ +_Inherited from void_ -### menubar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16539 -• **menubar**: *BarProp* +### msContentScript -*Inherited from void* +• **msContentScript**: _ExtensionScriptApis_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16539 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16540 -### msContentScript +### name -• **msContentScript**: *ExtensionScriptApis* +• **name**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16540 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16541 -___ +### navigator -### name +• **navigator**: _Navigator_ -• **name**: *string* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16542 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16541 +### offscreenBuffering -___ +• **offscreenBuffering**: _string \| boolean_ -### navigator +_Inherited from void_ -• **navigator**: *Navigator* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16543 -*Inherited from void* +### onabort -Defined in node_modules/typescript/lib/lib.dom.d.ts:16542 +• **onabort**: _function \| null_ -___ +_Inherited from void_ -### offscreenBuffering - -• **offscreenBuffering**: *string | boolean* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16543 - -___ - -### onabort - -• **onabort**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5387 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5387 Fires when the user aborts the download. **`param`** The event. -___ - -### onafterprint - -• **onafterprint**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16678 - -___ - -### onanimationcancel - -• **onanimationcancel**: *function | null* +### onafterprint -*Inherited from void* +• **onafterprint**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5388 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16678 -### onanimationend +### onanimationcancel -• **onanimationend**: *function | null* +• **onanimationcancel**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5389 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5388 -___ +### onanimationend -### onanimationiteration +• **onanimationend**: _function \| null_ -• **onanimationiteration**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5389 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5390 +### onanimationiteration -___ +• **onanimationiteration**: _function \| null_ -### onanimationstart +_Inherited from void_ -• **onanimationstart**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5390 -*Inherited from void* +### onanimationstart -Defined in node_modules/typescript/lib/lib.dom.d.ts:5391 +• **onanimationstart**: _function \| null_ -___ +_Inherited from void_ -### onauxclick +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5391 -• **onauxclick**: *function | null* +### onauxclick -*Inherited from void* +• **onauxclick**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5392 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5392 -### onbeforeprint +### onbeforeprint -• **onbeforeprint**: *function | null* +• **onbeforeprint**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16679 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16679 -___ +### onbeforeunload -### onbeforeunload +• **onbeforeunload**: _function \| null_ -• **onbeforeunload**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16680 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16680 +### onblur -___ +• **onblur**: _function \| null_ -### onblur +_Inherited from void_ -• **onblur**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5397 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5397 Fires when the object loses the input focus. **`param`** The focus event. -___ - -### oncancel - -• **oncancel**: *function | null* +### oncancel -*Inherited from void* +• **oncancel**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5398 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5398 -### oncanplay +### oncanplay -• **oncanplay**: *function | null* +• **oncanplay**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5403 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5403 Occurs when playback is possible, but would require further buffering. **`param`** The event. -___ +### oncanplaythrough -### oncanplaythrough +• **oncanplaythrough**: _function \| null_ -• **oncanplaythrough**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5404 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5404 +### onchange -___ +• **onchange**: _function \| null_ -### onchange +_Inherited from void_ -• **onchange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5409 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5409 Fires when the contents of the object or selection have changed. **`param`** The event. -___ +### onclick -### onclick +• **onclick**: _function \| null_ -• **onclick**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5414 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5414 Fires when the user clicks the left mouse button on the object **`param`** The mouse event. -___ - -### onclose +### onclose -• **onclose**: *function | null* +• **onclose**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5415 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5415 -___ +### oncompassneedscalibration -### oncompassneedscalibration +• **oncompassneedscalibration**: _function \| null_ -• **oncompassneedscalibration**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16544 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16544 +### oncontextmenu -___ +• **oncontextmenu**: _function \| null_ -### oncontextmenu +_Inherited from void_ -• **oncontextmenu**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5420 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5420 Fires when the user clicks the right mouse button in the client area, opening the context menu. **`param`** The mouse event. -___ - -### oncuechange - -• **oncuechange**: *function | null* +### oncuechange -*Inherited from void* +• **oncuechange**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5421 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5421 -### ondblclick +### ondblclick -• **ondblclick**: *function | null* +• **ondblclick**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5426 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5426 Fires when the user double-clicks the object. **`param`** The mouse event. -___ - -### ondevicelight - -• **ondevicelight**: *function | null* - -*Inherited from void* +### ondevicelight -Defined in node_modules/typescript/lib/lib.dom.d.ts:16545 +• **ondevicelight**: _function \| null_ -___ +_Inherited from void_ -### ondevicemotion +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16545 -• **ondevicemotion**: *function | null* +### ondevicemotion -*Inherited from void* +• **ondevicemotion**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16546 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16546 -### ondeviceorientation +### ondeviceorientation -• **ondeviceorientation**: *function | null* +• **ondeviceorientation**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16547 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16547 -___ +### ondrag -### ondrag +• **ondrag**: _function \| null_ -• **ondrag**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5431 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5431 Fires on the source object continuously during a drag operation. **`param`** The event. -___ - -### ondragend +### ondragend -• **ondragend**: *function | null* +• **ondragend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5436 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5436 Fires on the source object when the user releases the mouse at the close of a drag operation. **`param`** The event. -___ +### ondragenter -### ondragenter +• **ondragenter**: _function \| null_ -• **ondragenter**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5441 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5441 Fires on the target element when the user drags the object to a valid drop target. **`param`** The drag event. -___ - -### ondragexit +### ondragexit -• **ondragexit**: *function | null* +• **ondragexit**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5442 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5442 -___ +### ondragleave -### ondragleave +• **ondragleave**: _function \| null_ -• **ondragleave**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5447 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5447 Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. **`param`** The drag event. -___ - -### ondragover +### ondragover -• **ondragover**: *function | null* +• **ondragover**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5452 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5452 Fires on the target element continuously while the user drags the object over a valid drop target. **`param`** The event. -___ +### ondragstart -### ondragstart +• **ondragstart**: _function \| null_ -• **ondragstart**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5457 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5457 Fires on the source object when the user starts to drag a text selection or selected object. **`param`** The event. -___ - -### ondrop +### ondrop -• **ondrop**: *function | null* +• **ondrop**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5458 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5458 -___ +### ondurationchange -### ondurationchange +• **ondurationchange**: _function \| null_ -• **ondurationchange**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5463 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5463 Occurs when the duration attribute is updated. **`param`** The event. -___ - -### onemptied +### onemptied -• **onemptied**: *function | null* +• **onemptied**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5468 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5468 Occurs when the media element is reset to its initial state. **`param`** The event. -___ +### onended -### onended +• **onended**: _function \| null_ -• **onended**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5473 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5473 Occurs when the end of playback is reached. **`param`** The event -___ - -### onerror +### onerror -• **onerror**: *ErrorEventHandler* +• **onerror**: _ErrorEventHandler_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5478 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5478 Fires when an error occurs during object loading. **`param`** The event. -___ +### onfocus -### onfocus +• **onfocus**: _function \| null_ -• **onfocus**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5483 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5483 Fires when the object receives focus. **`param`** The event. -___ - -### ongotpointercapture - -• **ongotpointercapture**: *function | null* +### ongotpointercapture -*Inherited from void* +• **ongotpointercapture**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5484 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5484 -### onhashchange +### onhashchange -• **onhashchange**: *function | null* +• **onhashchange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16681 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16681 -___ +### oninput -### oninput +• **oninput**: _function \| null_ -• **oninput**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5485 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5485 +### oninvalid -___ +• **oninvalid**: _function \| null_ -### oninvalid +_Inherited from void_ -• **oninvalid**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5486 -*Inherited from void* +### onkeydown -Defined in node_modules/typescript/lib/lib.dom.d.ts:5486 +• **onkeydown**: _function \| null_ -___ +_Inherited from void_ -### onkeydown - -• **onkeydown**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5491 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5491 Fires when the user presses a key. **`param`** The keyboard event -___ - -### onkeypress +### onkeypress -• **onkeypress**: *function | null* +• **onkeypress**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5496 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5496 Fires when the user presses an alphanumeric key. **`param`** The event. -___ +### onkeyup -### onkeyup +• **onkeyup**: _function \| null_ -• **onkeyup**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5501 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5501 Fires when the user releases a key. **`param`** The keyboard event -___ - -### onlanguagechange +### onlanguagechange -• **onlanguagechange**: *function | null* +• **onlanguagechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16682 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16682 -___ +### onload -### onload +• **onload**: _function \| null_ -• **onload**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5506 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5506 Fires immediately after the browser loads the object. **`param`** The event. -___ - -### onloadeddata +### onloadeddata -• **onloadeddata**: *function | null* +• **onloadeddata**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5511 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5511 Occurs when media data is loaded at the current playback position. **`param`** The event. -___ +### onloadedmetadata -### onloadedmetadata +• **onloadedmetadata**: _function \| null_ -• **onloadedmetadata**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5516 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5516 Occurs when the duration and dimensions of the media have been determined. **`param`** The event. -___ - -### onloadend +### onloadend -• **onloadend**: *function | null* +• **onloadend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5517 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5517 -___ +### onloadstart -### onloadstart +• **onloadstart**: _function \| null_ -• **onloadstart**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5522 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5522 Occurs when Internet Explorer begins looking for media data. **`param`** The event. -___ - -### onlostpointercapture - -• **onlostpointercapture**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5523 +### onlostpointercapture -___ +• **onlostpointercapture**: _function \| null_ -### onmessage +_Inherited from void_ -• **onmessage**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5523 -*Inherited from void* +### onmessage -Defined in node_modules/typescript/lib/lib.dom.d.ts:16683 +• **onmessage**: _function \| null_ -___ +_Inherited from void_ -### onmessageerror +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16683 -• **onmessageerror**: *function | null* +### onmessageerror -*Inherited from void* +• **onmessageerror**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16684 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16684 -### onmousedown +### onmousedown -• **onmousedown**: *function | null* +• **onmousedown**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5528 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5528 Fires when the user clicks the object with either mouse button. **`param`** The mouse event. -___ +### onmouseenter -### onmouseenter +• **onmouseenter**: _function \| null_ -• **onmouseenter**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5529 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5529 +### onmouseleave -___ +• **onmouseleave**: _function \| null_ -### onmouseleave +_Inherited from void_ -• **onmouseleave**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5530 -*Inherited from void* +### onmousemove -Defined in node_modules/typescript/lib/lib.dom.d.ts:5530 +• **onmousemove**: _function \| null_ -___ +_Inherited from void_ -### onmousemove - -• **onmousemove**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5535 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5535 Fires when the user moves the mouse over the object. **`param`** The mouse event. -___ - -### onmouseout +### onmouseout -• **onmouseout**: *function | null* +• **onmouseout**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5540 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5540 Fires when the user moves the mouse pointer outside the boundaries of the object. **`param`** The mouse event. -___ +### onmouseover -### onmouseover +• **onmouseover**: _function \| null_ -• **onmouseover**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5545 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5545 Fires when the user moves the mouse pointer into the object. **`param`** The mouse event. -___ - -### onmouseup +### onmouseup -• **onmouseup**: *function | null* +• **onmouseup**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5550 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5550 Fires when the user releases a mouse button while the mouse is over the object. **`param`** The mouse event. -___ - -### onmousewheel - -• **onmousewheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16548 - -___ - -### onmsgesturechange - -• **onmsgesturechange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16549 +### onmousewheel -___ +• **onmousewheel**: _function \| null_ -### onmsgesturedoubletap +_Inherited from void_ -• **onmsgesturedoubletap**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16548 -*Inherited from void* +### onmsgesturechange -Defined in node_modules/typescript/lib/lib.dom.d.ts:16550 +• **onmsgesturechange**: _function \| null_ -___ +_Inherited from void_ -### onmsgestureend +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16549 -• **onmsgestureend**: *function | null* +### onmsgesturedoubletap -*Inherited from void* +• **onmsgesturedoubletap**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16551 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16550 -### onmsgesturehold +### onmsgestureend -• **onmsgesturehold**: *function | null* +• **onmsgestureend**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16552 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16551 -___ +### onmsgesturehold -### onmsgesturestart +• **onmsgesturehold**: _function \| null_ -• **onmsgesturestart**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16552 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16553 +### onmsgesturestart -___ +• **onmsgesturestart**: _function \| null_ -### onmsgesturetap +_Inherited from void_ -• **onmsgesturetap**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16553 -*Inherited from void* +### onmsgesturetap -Defined in node_modules/typescript/lib/lib.dom.d.ts:16554 +• **onmsgesturetap**: _function \| null_ -___ +_Inherited from void_ -### onmsinertiastart +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16554 -• **onmsinertiastart**: *function | null* +### onmsinertiastart -*Inherited from void* +• **onmsinertiastart**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16555 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16555 -### onmspointercancel +### onmspointercancel -• **onmspointercancel**: *function | null* +• **onmspointercancel**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16556 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16556 -___ +### onmspointerdown -### onmspointerdown +• **onmspointerdown**: _function \| null_ -• **onmspointerdown**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16557 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16557 +### onmspointerenter -___ +• **onmspointerenter**: _function \| null_ -### onmspointerenter +_Inherited from void_ -• **onmspointerenter**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16558 -*Inherited from void* +### onmspointerleave -Defined in node_modules/typescript/lib/lib.dom.d.ts:16558 +• **onmspointerleave**: _function \| null_ -___ +_Inherited from void_ -### onmspointerleave +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16559 -• **onmspointerleave**: *function | null* +### onmspointermove -*Inherited from void* +• **onmspointermove**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16559 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16560 -### onmspointermove +### onmspointerout -• **onmspointermove**: *function | null* +• **onmspointerout**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16560 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16561 -___ +### onmspointerover -### onmspointerout +• **onmspointerover**: _function \| null_ -• **onmspointerout**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16562 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16561 +### onmspointerup -___ +• **onmspointerup**: _function \| null_ -### onmspointerover +_Inherited from void_ -• **onmspointerover**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16563 -*Inherited from void* +### onoffline -Defined in node_modules/typescript/lib/lib.dom.d.ts:16562 +• **onoffline**: _function \| null_ -___ +_Inherited from void_ -### onmspointerup +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16685 -• **onmspointerup**: *function | null* +### ononline -*Inherited from void* +• **ononline**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16563 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16686 -### onoffline +### onorientationchange -• **onoffline**: *function | null* +• **onorientationchange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16685 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16565 -___ +**`deprecated`** -### ononline +### onpagehide -• **ononline**: *function | null* +• **onpagehide**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16686 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16687 -___ +### onpageshow -### onorientationchange +• **onpageshow**: _function \| null_ -• **onorientationchange**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16688 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16565 +### onpause -**`deprecated`** +• **onpause**: _function \| null_ -___ +_Inherited from void_ -### onpagehide - -• **onpagehide**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16687 - -___ - -### onpageshow - -• **onpageshow**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16688 - -___ - -### onpause - -• **onpause**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5555 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5555 Occurs when playback is paused. **`param`** The event. -___ - -### onplay +### onplay -• **onplay**: *function | null* +• **onplay**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5560 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5560 Occurs when the play method is requested. **`param`** The event. -___ - -### onplaying +### onplaying -• **onplaying**: *function | null* +• **onplaying**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5565 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5565 Occurs when the audio or video has started playing. **`param`** The event. -___ +### onpointercancel -### onpointercancel +• **onpointercancel**: _function \| null_ -• **onpointercancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5566 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5566 +### onpointerdown -___ +• **onpointerdown**: _function \| null_ -### onpointerdown +_Inherited from void_ -• **onpointerdown**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5567 -*Inherited from void* +### onpointerenter -Defined in node_modules/typescript/lib/lib.dom.d.ts:5567 +• **onpointerenter**: _function \| null_ -___ +_Inherited from void_ -### onpointerenter +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5568 -• **onpointerenter**: *function | null* +### onpointerleave -*Inherited from void* +• **onpointerleave**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5568 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5569 -### onpointerleave +### onpointermove -• **onpointerleave**: *function | null* +• **onpointermove**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5569 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5570 -___ +### onpointerout -### onpointermove +• **onpointerout**: _function \| null_ -• **onpointermove**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5571 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5570 +### onpointerover -___ +• **onpointerover**: _function \| null_ -### onpointerout +_Inherited from void_ -• **onpointerout**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5572 -*Inherited from void* +### onpointerup -Defined in node_modules/typescript/lib/lib.dom.d.ts:5571 +• **onpointerup**: _function \| null_ -___ +_Inherited from void_ -### onpointerover +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5573 -• **onpointerover**: *function | null* +### onpopstate -*Inherited from void* +• **onpopstate**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5572 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16689 -### onpointerup +### onprogress -• **onpointerup**: *function | null* +• **onprogress**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5573 - -___ - -### onpopstate - -• **onpopstate**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16689 - -___ - -### onprogress - -• **onprogress**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5578 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5578 Occurs to indicate progress while downloading media data. **`param`** The event. -___ +### onratechange -### onratechange +• **onratechange**: _function \| null_ -• **onratechange**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5583 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5583 Occurs when the playback rate is increased or decreased. **`param`** The event. -___ - -### onreadystatechange +### onreadystatechange -• **onreadystatechange**: *function | null* +• **onreadystatechange**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16566 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16566 -___ +### onrejectionhandled -### onrejectionhandled +• **onrejectionhandled**: _function \| null_ -• **onrejectionhandled**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16690 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16690 +### onreset -___ +• **onreset**: _function \| null_ -### onreset +_Inherited from void_ -• **onreset**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5588 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5588 Fires when the user resets a form. **`param`** The event. -___ - -### onresize +### onresize -• **onresize**: *function | null* +• **onresize**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5589 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5589 -___ +### onscroll -### onscroll +• **onscroll**: _function \| null_ -• **onscroll**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5594 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5594 Fires when the user repositions the scroll box in the scroll bar on the object. **`param`** The event. -___ - -### onsecuritypolicyviolation +### onsecuritypolicyviolation -• **onsecuritypolicyviolation**: *function | null* +• **onsecuritypolicyviolation**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5595 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5595 -___ +### onseeked -### onseeked +• **onseeked**: _function \| null_ -• **onseeked**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5600 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5600 Occurs when the seek operation ends. **`param`** The event. -___ - -### onseeking +### onseeking -• **onseeking**: *function | null* +• **onseeking**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5605 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5605 Occurs when the current playback position is moved. **`param`** The event. -___ +### onselect -### onselect +• **onselect**: _function \| null_ -• **onselect**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5610 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5610 Fires when the current selection changes. **`param`** The event. -___ - -### onstalled +### onstalled -• **onstalled**: *function | null* +• **onstalled**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5615 Occurs when the download has stopped. **`param`** The event. -___ - -### onstorage - -• **onstorage**: *function | null* +### onstorage -*Inherited from void* +• **onstorage**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16691 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16691 -### onsubmit +### onsubmit -• **onsubmit**: *function | null* +• **onsubmit**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5616 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5616 -___ +### onsuspend -### onsuspend +• **onsuspend**: _function \| null_ -• **onsuspend**: *function | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5621 Occurs if the load operation has been intentionally halted. **`param`** The event. -___ - -### ontimeupdate +### ontimeupdate -• **ontimeupdate**: *function | null* +• **ontimeupdate**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5626 Occurs to indicate the current playback position. **`param`** The event. -___ - -### ontoggle - -• **ontoggle**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5627 - -___ +### ontoggle -### ontouchcancel +• **ontoggle**: _function \| null_ -• **ontouchcancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5627 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5628 +### ontouchcancel -___ +• **ontouchcancel**: _function \| null_ -### ontouchend +_Inherited from void_ -• **ontouchend**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5628 -*Inherited from void* +### ontouchend -Defined in node_modules/typescript/lib/lib.dom.d.ts:5629 +• **ontouchend**: _function \| null_ -___ +_Inherited from void_ -### ontouchmove +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5629 -• **ontouchmove**: *function | null* +### ontouchmove -*Inherited from void* +• **ontouchmove**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5630 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5630 -### ontouchstart +### ontouchstart -• **ontouchstart**: *function | null* +• **ontouchstart**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5631 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5631 -___ +### ontransitioncancel -### ontransitioncancel +• **ontransitioncancel**: _function \| null_ -• **ontransitioncancel**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5632 -Defined in node_modules/typescript/lib/lib.dom.d.ts:5632 +### ontransitionend -___ +• **ontransitionend**: _function \| null_ -### ontransitionend +_Inherited from void_ -• **ontransitionend**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5633 -*Inherited from void* +### ontransitionrun -Defined in node_modules/typescript/lib/lib.dom.d.ts:5633 +• **ontransitionrun**: _function \| null_ -___ +_Inherited from void_ -### ontransitionrun +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5634 -• **ontransitionrun**: *function | null* +### ontransitionstart -*Inherited from void* +• **ontransitionstart**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5634 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5635 -### ontransitionstart +### onunhandledrejection -• **ontransitionstart**: *function | null* +• **onunhandledrejection**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5635 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16692 -___ +### onunload -### onunhandledrejection +• **onunload**: _function \| null_ -• **onunhandledrejection**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16693 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16692 +### onvolumechange -___ +• **onvolumechange**: _function \| null_ -### onunload +_Inherited from void_ -• **onunload**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16693 - -___ - -### onvolumechange - -• **onvolumechange**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5640 Occurs when the volume is changed, or playback is muted or unmuted. **`param`** The event. -___ - -### onvrdisplayactivate - -• **onvrdisplayactivate**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16567 - -___ - -### onvrdisplayblur - -• **onvrdisplayblur**: *function | null* - -*Inherited from void* +### onvrdisplayactivate -Defined in node_modules/typescript/lib/lib.dom.d.ts:16568 +• **onvrdisplayactivate**: _function \| null_ -___ +_Inherited from void_ -### onvrdisplayconnect +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16567 -• **onvrdisplayconnect**: *function | null* +### onvrdisplayblur -*Inherited from void* +• **onvrdisplayblur**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16569 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16568 -### onvrdisplaydeactivate +### onvrdisplayconnect -• **onvrdisplaydeactivate**: *function | null* +• **onvrdisplayconnect**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16570 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16569 -___ +### onvrdisplaydeactivate -### onvrdisplaydisconnect +• **onvrdisplaydeactivate**: _function \| null_ -• **onvrdisplaydisconnect**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16570 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16571 +### onvrdisplaydisconnect -___ +• **onvrdisplaydisconnect**: _function \| null_ -### onvrdisplayfocus +_Inherited from void_ -• **onvrdisplayfocus**: *function | null* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16571 -*Inherited from void* +### onvrdisplayfocus -Defined in node_modules/typescript/lib/lib.dom.d.ts:16572 +• **onvrdisplayfocus**: _function \| null_ -___ +_Inherited from void_ -### onvrdisplaypointerrestricted +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16572 -• **onvrdisplaypointerrestricted**: *function | null* +### onvrdisplaypointerrestricted -*Inherited from void* +• **onvrdisplaypointerrestricted**: _function \| null_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16573 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16573 -### onvrdisplaypointerunrestricted +### onvrdisplaypointerunrestricted -• **onvrdisplaypointerunrestricted**: *function | null* +• **onvrdisplaypointerunrestricted**: _function \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16574 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16574 -___ +### onvrdisplaypresentchange -### onvrdisplaypresentchange +• **onvrdisplaypresentchange**: _function \| null_ -• **onvrdisplaypresentchange**: *function | null* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16575 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16575 +### onwaiting -___ +• **onwaiting**: _function \| null_ -### onwaiting +_Inherited from void_ -• **onwaiting**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5645 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5645 Occurs when playback stops because the next frame of a video resource is not available. **`param`** The event. -___ - -### onwheel - -• **onwheel**: *function | null* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:5646 - -___ - -### opener - -• **opener**: *any* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16576 - -___ - -### orientation - -• **orientation**: *string | number* - -*Inherited from void* +### onwheel -Defined in node_modules/typescript/lib/lib.dom.d.ts:16578 +• **onwheel**: _function \| null_ -**`deprecated`** +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5646 -### origin +### opener -• **origin**: *string* +• **opener**: _any_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16708 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16576 -___ +### orientation -### outerHeight +• **orientation**: _string \| number_ -• **outerHeight**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16578 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16579 +**`deprecated`** -___ +### origin -### outerWidth +• **origin**: _string_ -• **outerWidth**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16708 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16580 +### outerHeight -___ +• **outerHeight**: _number_ -### pageXOffset +_Inherited from void_ -• **pageXOffset**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16579 -*Inherited from void* +### outerWidth -Defined in node_modules/typescript/lib/lib.dom.d.ts:16581 +• **outerWidth**: _number_ -___ +_Inherited from void_ -### pageYOffset +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16580 -• **pageYOffset**: *number* +### pageXOffset -*Inherited from void* +• **pageXOffset**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16582 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16581 -### parent +### pageYOffset -• **parent**: *Window* +• **pageYOffset**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16583 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16582 -___ +### parent -### performance +• **parent**: _Window_ -• **performance**: *Performance* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16583 -*Overrides void* +### performance -Defined in node_modules/typescript/lib/lib.dom.d.ts:16584 +• **performance**: _Performance_ -___ +_Inherited from void_ -### personalbar +_Overrides void_ -• **personalbar**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16584 -*Inherited from void* +### personalbar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16585 +• **personalbar**: _BarProp_ -___ +_Inherited from void_ -### screen +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16585 -• **screen**: *Screen* +### screen -*Inherited from void* +• **screen**: _Screen_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16586 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16586 -### screenLeft +### screenLeft -• **screenLeft**: *number* +• **screenLeft**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16587 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16587 -___ +### screenTop -### screenTop +• **screenTop**: _number_ -• **screenTop**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16588 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16588 +### screenX -___ +• **screenX**: _number_ -### screenX +_Inherited from void_ -• **screenX**: *number* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16589 -*Inherited from void* +### screenY -Defined in node_modules/typescript/lib/lib.dom.d.ts:16589 +• **screenY**: _number_ -___ +_Inherited from void_ -### screenY +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16590 -• **screenY**: *number* +### scrollX -*Inherited from void* +• **scrollX**: _number_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16590 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16591 -### scrollX +### scrollY -• **scrollX**: *number* +• **scrollY**: _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16591 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16592 -___ +### scrollbars -### scrollY +• **scrollbars**: _BarProp_ -• **scrollY**: *number* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16593 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16592 +### self -___ +• **self**: _Window_ -### scrollbars +_Inherited from void_ -• **scrollbars**: *BarProp* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16594 -*Inherited from void* +### sessionStorage -Defined in node_modules/typescript/lib/lib.dom.d.ts:16593 +• **sessionStorage**: _Storage_ -___ +_Inherited from void_ -### self +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16723 -• **self**: *Window* +### speechSynthesis -*Inherited from void* +• **speechSynthesis**: _SpeechSynthesis_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16594 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16595 -### sessionStorage +### status -• **sessionStorage**: *Storage* +• **status**: _string_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16723 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16596 -___ +### statusbar -### speechSynthesis +• **statusbar**: _BarProp_ -• **speechSynthesis**: *SpeechSynthesis* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16597 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16595 +### styleMedia -___ +• **styleMedia**: _StyleMedia_ -### status +_Inherited from void_ -• **status**: *string* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16598 -*Inherited from void* +### toolbar -Defined in node_modules/typescript/lib/lib.dom.d.ts:16596 +• **toolbar**: _BarProp_ -___ +_Inherited from void_ -### statusbar +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16599 -• **statusbar**: *BarProp* +### top -*Inherited from void* +• **top**: _Window_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16597 +_Inherited from void_ -___ +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16600 -### styleMedia +### web3 -• **styleMedia**: *StyleMedia* +• **web3**: [_InjectedWeb3_](_browserutils_.injectedweb3.md) -*Inherited from void* +_Overrides_ [_ExtendedWindow_](_browserutils_.extendedwindow.md)_._[_web3_](_browserutils_.extendedwindow.md#optional-web3) -Defined in node_modules/typescript/lib/lib.dom.d.ts:16598 +_Defined in_ [_src/browserUtils.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L39) -___ +### window -### toolbar +• **window**: _Window_ -• **toolbar**: *BarProp* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16599 - -___ - -### top - -• **top**: *Window* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16600 - -___ - -### web3 - -• **web3**: *[InjectedWeb3](_browserutils_.injectedweb3.md)* - -*Overrides [ExtendedWindow](_browserutils_.extendedwindow.md).[web3](_browserutils_.extendedwindow.md#optional-web3)* - -*Defined in [src/browserUtils.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L39)* - -___ - -### window - -• **window**: *Window* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16601 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16601 ## Methods -### addEventListener +### addEventListener -▸ **addEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16638 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16638 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | AddEventListenerOptions* +▪`Optional` **options**: _boolean \| AddEventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **addEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | AddEventListenerOptions): *void* +▸ **addEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| AddEventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16639 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16639 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | AddEventListenerOptions | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| AddEventListenerOptions | -___ +**Returns:** _void_ -### alert +### alert -▸ **alert**(`message?`: any): *void* +▸ **alert**\(`message?`: any\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16602 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16602 **Parameters:** -Name | Type | ------- | ------ | -`message?` | any | +| Name | Type | +| :--- | :--- | +| `message?` | any | -**Returns:** *void* +**Returns:** _void_ -___ +### atob -### atob +▸ **atob**\(`encodedString`: string\): _string_ -▸ **atob**(`encodedString`: string): *string* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16650 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16650 **Parameters:** -Name | Type | ------- | ------ | -`encodedString` | string | - -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `encodedString` | string | -___ +**Returns:** _string_ -### blur +### blur -▸ **blur**(): *void* +▸ **blur**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16603 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16603 -**Returns:** *void* +**Returns:** _void_ -___ +### btoa -### btoa +▸ **btoa**\(`rawString`: string\): _string_ -▸ **btoa**(`rawString`: string): *string* +_Inherited from void_ -*Inherited from void* +_Overrides void_ -*Overrides void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16651 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16651 **Parameters:** -Name | Type | ------- | ------ | -`rawString` | string | - -**Returns:** *string* +| Name | Type | +| :--- | :--- | +| `rawString` | string | -___ +**Returns:** _string_ -### cancelAnimationFrame +### cancelAnimationFrame -▸ **cancelAnimationFrame**(`handle`: number): *void* +▸ **cancelAnimationFrame**\(`handle`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16604 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16604 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `handle` | number | -### captureEvents +**Returns:** _void_ -▸ **captureEvents**(): *void* +### captureEvents -*Inherited from void* +▸ **captureEvents**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16606 +_Inherited from void_ -**`deprecated`** +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16606 -**Returns:** *void* +**`deprecated`** -___ +**Returns:** _void_ -### clearInterval +### clearInterval -▸ **clearInterval**(`handle?`: undefined | number): *void* +▸ **clearInterval**\(`handle?`: undefined \| number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16712 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16712 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -**Returns:** *void* +**Returns:** _void_ -___ +### clearTimeout -### clearTimeout +▸ **clearTimeout**\(`handle?`: undefined \| number\): _void_ -▸ **clearTimeout**(`handle?`: undefined | number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16713 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16713 **Parameters:** -Name | Type | ------- | ------ | -`handle?` | undefined | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle?` | undefined \| number | -___ +**Returns:** _void_ -### close +### close -▸ **close**(): *void* +▸ **close**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16607 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16607 -**Returns:** *void* +**Returns:** _void_ -___ +### confirm -### confirm +▸ **confirm**\(`message?`: undefined \| string\): _boolean_ -▸ **confirm**(`message?`: undefined | string): *boolean* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16608 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16608 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | - -**Returns:** *boolean* +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | -___ +**Returns:** _boolean_ -### createImageBitmap +### createImageBitmap -▸ **createImageBitmap**(`image`: ImageBitmapSource): *Promise‹ImageBitmap›* +▸ **createImageBitmap**\(`image`: ImageBitmapSource\): _Promise‹ImageBitmap›_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16714 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16714 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | -**Returns:** *Promise‹ImageBitmap›* +**Returns:** _Promise‹ImageBitmap›_ -▸ **createImageBitmap**(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number): *Promise‹ImageBitmap›* +▸ **createImageBitmap**\(`image`: ImageBitmapSource, `sx`: number, `sy`: number, `sw`: number, `sh`: number\): _Promise‹ImageBitmap›_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16715 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16715 **Parameters:** -Name | Type | ------- | ------ | -`image` | ImageBitmapSource | -`sx` | number | -`sy` | number | -`sw` | number | -`sh` | number | +| Name | Type | +| :--- | :--- | +| `image` | ImageBitmapSource | +| `sx` | number | +| `sy` | number | +| `sw` | number | +| `sh` | number | -**Returns:** *Promise‹ImageBitmap›* +**Returns:** _Promise‹ImageBitmap›_ -___ +### departFocus -### departFocus +▸ **departFocus**\(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin\): _void_ -▸ **departFocus**(`navigationReason`: NavigationReason, `origin`: FocusNavigationOrigin): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16609 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16609 **Parameters:** -Name | Type | ------- | ------ | -`navigationReason` | NavigationReason | -`origin` | FocusNavigationOrigin | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `navigationReason` | NavigationReason | +| `origin` | FocusNavigationOrigin | -___ +**Returns:** _void_ -### dispatchEvent +### dispatchEvent -▸ **dispatchEvent**(`event`: Event): *boolean* +▸ **dispatchEvent**\(`event`: Event\): _boolean_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5074 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5074 -Dispatches a synthetic event event to target and returns true -if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault\(\) method was not invoked, and false otherwise. **Parameters:** -Name | Type | ------- | ------ | -`event` | Event | - -**Returns:** *boolean* +| Name | Type | +| :--- | :--- | +| `event` | Event | -___ +**Returns:** _boolean_ -### fetch +### fetch -▸ **fetch**(`input`: RequestInfo, `init?`: RequestInit): *Promise‹Response›* +▸ **fetch**\(`input`: RequestInfo, `init?`: RequestInit\): _Promise‹Response›_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:5654 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:5654 **Parameters:** -Name | Type | ------- | ------ | -`input` | RequestInfo | -`init?` | RequestInit | +| Name | Type | +| :--- | :--- | +| `input` | RequestInfo | +| `init?` | RequestInit | -**Returns:** *Promise‹Response›* +**Returns:** _Promise‹Response›_ -___ +### focus -### focus +▸ **focus**\(\): _void_ -▸ **focus**(): *void* +_Inherited from void_ -*Inherited from void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16610 -Defined in node_modules/typescript/lib/lib.dom.d.ts:16610 +**Returns:** _void_ -**Returns:** *void* +### getComputedStyle -___ +▸ **getComputedStyle**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSStyleDeclaration_ -### getComputedStyle +_Inherited from void_ -▸ **getComputedStyle**(`elt`: Element, `pseudoElt?`: string | null): *CSSStyleDeclaration* - -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16611 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16611 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -**Returns:** *CSSStyleDeclaration* +**Returns:** _CSSStyleDeclaration_ -___ +### getMatchedCSSRules -### getMatchedCSSRules +▸ **getMatchedCSSRules**\(`elt`: Element, `pseudoElt?`: string \| null\): _CSSRuleList_ -▸ **getMatchedCSSRules**(`elt`: Element, `pseudoElt?`: string | null): *CSSRuleList* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16612 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16612 **Parameters:** -Name | Type | ------- | ------ | -`elt` | Element | -`pseudoElt?` | string | null | - -**Returns:** *CSSRuleList* +| Name | Type | +| :--- | :--- | +| `elt` | Element | +| `pseudoElt?` | string \| null | -___ +**Returns:** _CSSRuleList_ -### getSelection +### getSelection -▸ **getSelection**(): *Selection* +▸ **getSelection**\(\): _Selection_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16613 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16613 -**Returns:** *Selection* +**Returns:** _Selection_ -___ +### matchMedia -### matchMedia +▸ **matchMedia**\(`query`: string\): _MediaQueryList_ -▸ **matchMedia**(`query`: string): *MediaQueryList* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16614 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16614 **Parameters:** -Name | Type | ------- | ------ | -`query` | string | - -**Returns:** *MediaQueryList* +| Name | Type | +| :--- | :--- | +| `query` | string | -___ +**Returns:** _MediaQueryList_ -### moveBy +### moveBy -▸ **moveBy**(`x`: number, `y`: number): *void* +▸ **moveBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16615 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16615 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### moveTo -### moveTo +▸ **moveTo**\(`x`: number, `y`: number\): _void_ -▸ **moveTo**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16616 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16616 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### msWriteProfilerMark +### msWriteProfilerMark -▸ **msWriteProfilerMark**(`profilerMarkName`: string): *void* +▸ **msWriteProfilerMark**\(`profilerMarkName`: string\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16617 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16617 **Parameters:** -Name | Type | ------- | ------ | -`profilerMarkName` | string | +| Name | Type | +| :--- | :--- | +| `profilerMarkName` | string | -**Returns:** *void* +**Returns:** _void_ -___ +### open -### open +▸ **open**\(`url?`: undefined \| string, `target?`: undefined \| string, `features?`: undefined \| string, `replace?`: undefined \| false \| true\): _Window \| null_ -▸ **open**(`url?`: undefined | string, `target?`: undefined | string, `features?`: undefined | string, `replace?`: undefined | false | true): *Window | null* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16618 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16618 **Parameters:** -Name | Type | ------- | ------ | -`url?` | undefined | string | -`target?` | undefined | string | -`features?` | undefined | string | -`replace?` | undefined | false | true | - -**Returns:** *Window | null* +| Name | Type | +| :--- | :--- | +| `url?` | undefined \| string | +| `target?` | undefined \| string | +| `features?` | undefined \| string | +| `replace?` | undefined \| false \| true | -___ +**Returns:** _Window \| null_ -### postMessage +### postMessage -▸ **postMessage**(`message`: any, `targetOrigin`: string, `transfer?`: Transferable[]): *void* +▸ **postMessage**\(`message`: any, `targetOrigin`: string, `transfer?`: Transferable\[\]\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16619 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16619 **Parameters:** -Name | Type | ------- | ------ | -`message` | any | -`targetOrigin` | string | -`transfer?` | Transferable[] | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `message` | any | +| `targetOrigin` | string | +| `transfer?` | Transferable\[\] | -### print +**Returns:** _void_ -▸ **print**(): *void* +### print -*Inherited from void* +▸ **print**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16620 +_Inherited from void_ -**Returns:** *void* +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16620 -___ +**Returns:** _void_ -### prompt +### prompt -▸ **prompt**(`message?`: undefined | string, `_default?`: undefined | string): *string | null* +▸ **prompt**\(`message?`: undefined \| string, `_default?`: undefined \| string\): _string \| null_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16621 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16621 **Parameters:** -Name | Type | ------- | ------ | -`message?` | undefined | string | -`_default?` | undefined | string | +| Name | Type | +| :--- | :--- | +| `message?` | undefined \| string | +| `_default?` | undefined \| string | -**Returns:** *string | null* +**Returns:** _string \| null_ -___ +### queueMicrotask -### queueMicrotask +▸ **queueMicrotask**\(`callback`: Function\): _void_ -▸ **queueMicrotask**(`callback`: Function): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16717 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16717 **Parameters:** -Name | Type | ------- | ------ | -`callback` | Function | - -**Returns:** *void* - -___ +| Name | Type | +| :--- | :--- | +| `callback` | Function | -### releaseEvents +**Returns:** _void_ -▸ **releaseEvents**(): *void* +### releaseEvents -*Inherited from void* +▸ **releaseEvents**\(\): _void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16623 +_Inherited from void_ -**`deprecated`** +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16623 -**Returns:** *void* +**`deprecated`** -___ +**Returns:** _void_ -### removeEventListener +### removeEventListener -▸ **removeEventListener**<**K**>(`type`: K, `listener`: function, `options?`: boolean | EventListenerOptions): *void* +▸ **removeEventListener**<**K**>\(`type`: K, `listener`: function, `options?`: boolean \| EventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16640 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16640 **Type parameters:** -▪ **K**: *keyof WindowEventMap* +▪ **K**: _keyof WindowEventMap_ **Parameters:** -▪ **type**: *K* +▪ **type**: _K_ -▪ **listener**: *function* +▪ **listener**: _function_ -▸ (`this`: Window, `ev`: WindowEventMap[K]): *any* +▸ \(`this`: Window, `ev`: WindowEventMap\[K\]\): _any_ **Parameters:** -Name | Type | ------- | ------ | -`this` | Window | -`ev` | WindowEventMap[K] | +| Name | Type | +| :--- | :--- | +| `this` | Window | +| `ev` | WindowEventMap\[K\] | -▪`Optional` **options**: *boolean | EventListenerOptions* +▪`Optional` **options**: _boolean \| EventListenerOptions_ -**Returns:** *void* +**Returns:** _void_ -▸ **removeEventListener**(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean | EventListenerOptions): *void* +▸ **removeEventListener**\(`type`: string, `listener`: EventListenerOrEventListenerObject, `options?`: boolean \| EventListenerOptions\): _void_ -*Inherited from void* +_Inherited from void_ -*Overrides void* +_Overrides void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16641 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16641 **Parameters:** -Name | Type | ------- | ------ | -`type` | string | -`listener` | EventListenerOrEventListenerObject | -`options?` | boolean | EventListenerOptions | +| Name | Type | +| :--- | :--- | +| `type` | string | +| `listener` | EventListenerOrEventListenerObject | +| `options?` | boolean \| EventListenerOptions | -**Returns:** *void* +**Returns:** _void_ -___ +### requestAnimationFrame -### requestAnimationFrame +▸ **requestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -▸ **requestAnimationFrame**(`callback`: FrameRequestCallback): *number* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16624 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16624 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | - -**Returns:** *number* +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | -___ +**Returns:** _number_ -### resizeBy +### resizeBy -▸ **resizeBy**(`x`: number, `y`: number): *void* +▸ **resizeBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16625 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16625 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### resizeTo -### resizeTo +▸ **resizeTo**\(`x`: number, `y`: number\): _void_ -▸ **resizeTo**(`x`: number, `y`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16626 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16626 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### scroll +### scroll -▸ **scroll**(`options?`: ScrollToOptions): *void* +▸ **scroll**\(`options?`: ScrollToOptions\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16627 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16627 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scroll**(`x`: number, `y`: number): *void* +▸ **scroll**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16628 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16628 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -**Returns:** *void* +**Returns:** _void_ -___ +### scrollBy -### scrollBy +▸ **scrollBy**\(`options?`: ScrollToOptions\): _void_ -▸ **scrollBy**(`options?`: ScrollToOptions): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16629 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16629 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollBy**(`x`: number, `y`: number): *void* +▸ **scrollBy**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16630 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16630 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### scrollTo +### scrollTo -▸ **scrollTo**(`options?`: ScrollToOptions): *void* +▸ **scrollTo**\(`options?`: ScrollToOptions\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16631 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16631 **Parameters:** -Name | Type | ------- | ------ | -`options?` | ScrollToOptions | +| Name | Type | +| :--- | :--- | +| `options?` | ScrollToOptions | -**Returns:** *void* +**Returns:** _void_ -▸ **scrollTo**(`x`: number, `y`: number): *void* +▸ **scrollTo**\(`x`: number, `y`: number\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16632 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16632 **Parameters:** -Name | Type | ------- | ------ | -`x` | number | -`y` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `x` | number | +| `y` | number | -___ +**Returns:** _void_ -### setInterval +### setInterval -▸ **setInterval**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +▸ **setInterval**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16718 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16718 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -**Returns:** *number* +**Returns:** _number_ -___ +### setTimeout -### setTimeout +▸ **setTimeout**\(`handler`: TimerHandler, `timeout?`: undefined \| number, ...`arguments`: any\[\]\): _number_ -▸ **setTimeout**(`handler`: TimerHandler, `timeout?`: undefined | number, ...`arguments`: any[]): *number* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16719 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16719 **Parameters:** -Name | Type | ------- | ------ | -`handler` | TimerHandler | -`timeout?` | undefined | number | -`...arguments` | any[] | - -**Returns:** *number* +| Name | Type | +| :--- | :--- | +| `handler` | TimerHandler | +| `timeout?` | undefined \| number | +| `...arguments` | any\[\] | -___ +**Returns:** _number_ -### stop +### stop -▸ **stop**(): *void* +▸ **stop**\(\): _void_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16633 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16633 -**Returns:** *void* +**Returns:** _void_ -___ +### webkitCancelAnimationFrame -### webkitCancelAnimationFrame +▸ **webkitCancelAnimationFrame**\(`handle`: number\): _void_ -▸ **webkitCancelAnimationFrame**(`handle`: number): *void* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16634 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16634 **Parameters:** -Name | Type | ------- | ------ | -`handle` | number | - -**Returns:** *void* +| Name | Type | +| :--- | :--- | +| `handle` | number | -___ +**Returns:** _void_ -### webkitConvertPointFromNodeToPage +### webkitConvertPointFromNodeToPage -▸ **webkitConvertPointFromNodeToPage**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +▸ **webkitConvertPointFromNodeToPage**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16635 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16635 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -**Returns:** *WebKitPoint* +**Returns:** _WebKitPoint_ -___ +### webkitConvertPointFromPageToNode -### webkitConvertPointFromPageToNode +▸ **webkitConvertPointFromPageToNode**\(`node`: Node, `pt`: WebKitPoint\): _WebKitPoint_ -▸ **webkitConvertPointFromPageToNode**(`node`: Node, `pt`: WebKitPoint): *WebKitPoint* +_Inherited from void_ -*Inherited from void* - -Defined in node_modules/typescript/lib/lib.dom.d.ts:16636 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16636 **Parameters:** -Name | Type | ------- | ------ | -`node` | Node | -`pt` | WebKitPoint | - -**Returns:** *WebKitPoint* +| Name | Type | +| :--- | :--- | +| `node` | Node | +| `pt` | WebKitPoint | -___ +**Returns:** _WebKitPoint_ -### webkitRequestAnimationFrame +### webkitRequestAnimationFrame -▸ **webkitRequestAnimationFrame**(`callback`: FrameRequestCallback): *number* +▸ **webkitRequestAnimationFrame**\(`callback`: FrameRequestCallback\): _number_ -*Inherited from void* +_Inherited from void_ -Defined in node_modules/typescript/lib/lib.dom.d.ts:16637 +Defined in node\_modules/typescript/lib/lib.dom.d.ts:16637 **Parameters:** -Name | Type | ------- | ------ | -`callback` | FrameRequestCallback | +| Name | Type | +| :--- | :--- | +| `callback` | FrameRequestCallback | + +**Returns:** _number_ -**Returns:** *number* diff --git a/docs/api/interfaces/_context_.constructorparams.md b/docs/api/interfaces/_context_.constructorparams.md index eb5227c..ca7ddfc 100644 --- a/docs/api/interfaces/_context_.constructorparams.md +++ b/docs/api/interfaces/_context_.constructorparams.md @@ -1,4 +1,4 @@ -# Interface: ConstructorParams +# ConstructorParams ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### contractWrappers +### contractWrappers -• **contractWrappers**: *[PolymathBase](../classes/_polymathbase_.polymathbase.md)* +• **contractWrappers**: [_PolymathBase_](../classes/_polymathbase_.polymathbase.md) + +_Defined in_ [_src/Context.ts:17_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L17) -*Defined in [src/Context.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L17)* diff --git a/docs/api/interfaces/_context_.factories.md b/docs/api/interfaces/_context_.factories.md index 5a4a742..2be00fd 100644 --- a/docs/api/interfaces/_context_.factories.md +++ b/docs/api/interfaces/_context_.factories.md @@ -1,4 +1,4 @@ -# Interface: Factories +# Factories ## Hierarchy @@ -21,80 +21,63 @@ ## Properties -### checkpointFactory +### checkpointFactory -• **checkpointFactory**: *CheckpointFactory* +• **checkpointFactory**: _CheckpointFactory_ -*Defined in [src/Context.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L28)* +_Defined in_ [_src/Context.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L28) -___ +### dividendDistributionFactory -### dividendDistributionFactory +• **dividendDistributionFactory**: _DividendDistributionFactory_ -• **dividendDistributionFactory**: *DividendDistributionFactory* +_Defined in_ [_src/Context.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L27) -*Defined in [src/Context.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L27)* +### erc20TokenBalanceFactory -___ +• **erc20TokenBalanceFactory**: [_Erc20TokenBalanceFactory_](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md) -### erc20TokenBalanceFactory +_Defined in_ [_src/Context.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L23) -• **erc20TokenBalanceFactory**: *[Erc20TokenBalanceFactory](../classes/_entities_factories_erc20tokenbalancefactory_.erc20tokenbalancefactory.md)* +### investmentFactory -*Defined in [src/Context.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L23)* +• **investmentFactory**: [_InvestmentFactory_](../classes/_entities_factories_investmentfactory_.investmentfactory.md) -___ +_Defined in_ [_src/Context.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L24) -### investmentFactory +### securityTokenFactory -• **investmentFactory**: *[InvestmentFactory](../classes/_entities_factories_investmentfactory_.investmentfactory.md)* +• **securityTokenFactory**: _SecurityTokenFactory_ -*Defined in [src/Context.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L24)* +_Defined in_ [_src/Context.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L21) -___ +### securityTokenReservationFactory -### securityTokenFactory +• **securityTokenReservationFactory**: _SecurityTokenReservationFactory_ -• **securityTokenFactory**: *SecurityTokenFactory* +_Defined in_ [_src/Context.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L22) -*Defined in [src/Context.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L21)* +### simpleStoFactory -___ +• **simpleStoFactory**: [_SimpleStoFactory_](../classes/_entities_factories_simplestofactory_.simplestofactory.md) -### securityTokenReservationFactory +_Defined in_ [_src/Context.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L25) -• **securityTokenReservationFactory**: *SecurityTokenReservationFactory* +### taxWithholdingFactory -*Defined in [src/Context.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L22)* +• **taxWithholdingFactory**: [_TaxWithholdingFactory_](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md) -___ +_Defined in_ [_src/Context.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L30) -### simpleStoFactory +### tieredStoFactory -• **simpleStoFactory**: *[SimpleStoFactory](../classes/_entities_factories_simplestofactory_.simplestofactory.md)* +• **tieredStoFactory**: [_TieredStoFactory_](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md) -*Defined in [src/Context.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L25)* +_Defined in_ [_src/Context.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L26) -___ +### tokenholderFactory -### taxWithholdingFactory +• **tokenholderFactory**: [_TokenholderFactory_](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md) -• **taxWithholdingFactory**: *[TaxWithholdingFactory](../classes/_entities_factories_taxwithholdingfactory_.taxwithholdingfactory.md)* +_Defined in_ [_src/Context.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L29) -*Defined in [src/Context.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L30)* - -___ - -### tieredStoFactory - -• **tieredStoFactory**: *[TieredStoFactory](../classes/_entities_factories_tieredstofactory_.tieredstofactory.md)* - -*Defined in [src/Context.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L26)* - -___ - -### tokenholderFactory - -• **tokenholderFactory**: *[TokenholderFactory](../classes/_entities_factories_tokenholderfactory_.tokenholderfactory.md)* - -*Defined in [src/Context.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Context.ts#L29)* diff --git a/docs/api/interfaces/_entities_checkpoint_.params.md b/docs/api/interfaces/_entities_checkpoint_.params.md index 1e2a6c4..cb2fcf0 100644 --- a/docs/api/interfaces/_entities_checkpoint_.params.md +++ b/docs/api/interfaces/_entities_checkpoint_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Checkpoint constructor parameters @@ -18,46 +18,39 @@ Checkpoint constructor parameters ## Properties -### createdAt +### createdAt -• **createdAt**: *Date* +• **createdAt**: _Date_ -*Defined in [src/entities/Checkpoint.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L48)* +_Defined in_ [_src/entities/Checkpoint.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L48) -___ +### dividendDistributions -### dividendDistributions +• **dividendDistributions**: [_DividendDistribution_](../classes/_entities_dividenddistribution_.dividenddistribution.md)_\[\]_ -• **dividendDistributions**: *[DividendDistribution](../classes/_entities_dividenddistribution_.dividenddistribution.md)[]* - -*Defined in [src/entities/Checkpoint.ts:38](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L38)* +_Defined in_ [_src/entities/Checkpoint.ts:38_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L38) dividend distributions associated to this checkpoint -___ - -### securityTokenSymbol +### securityTokenSymbol -• **securityTokenSymbol**: *string* +• **securityTokenSymbol**: _string_ -*Defined in [src/entities/Checkpoint.ts:42](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L42)* +_Defined in_ [_src/entities/Checkpoint.ts:42_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L42) symbol of the security token -___ - -### tokenholderBalances +### tokenholderBalances -• **tokenholderBalances**: *[TokenholderBalance](_types_index_.tokenholderbalance.md)[]* +• **tokenholderBalances**: [_TokenholderBalance_](_types_index_.tokenholderbalance.md)_\[\]_ -*Defined in [src/entities/Checkpoint.ts:46](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L46)* +_Defined in_ [_src/entities/Checkpoint.ts:46_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L46) tokenholder balances at this specific Checkpoint -___ +### totalSupply -### totalSupply +• **totalSupply**: _BigNumber_ -• **totalSupply**: *BigNumber* +_Defined in_ [_src/entities/Checkpoint.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L47) -*Defined in [src/entities/Checkpoint.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L47)* diff --git a/docs/api/interfaces/_entities_checkpoint_.uniqueidentifiers.md b/docs/api/interfaces/_entities_checkpoint_.uniqueidentifiers.md index c518344..9eef62b 100644 --- a/docs/api/interfaces/_entities_checkpoint_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_checkpoint_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Checkpoint @@ -15,20 +15,19 @@ Properties that uniquely identify a Checkpoint ## Properties -### index +### index -• **index**: *number* +• **index**: _number_ -*Defined in [src/entities/Checkpoint.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L19)* +_Defined in_ [_src/entities/Checkpoint.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L19) numerical index of the checkpoint. The higher the index, the more recent the checkpoint -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* - -*Defined in [src/entities/Checkpoint.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L15)* +_Defined in_ [_src/entities/Checkpoint.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L15) security token UUID + diff --git a/docs/api/interfaces/_entities_dividenddistribution_.params.md b/docs/api/interfaces/_entities_dividenddistribution_.params.md index d8dd4f7..b805ae4 100644 --- a/docs/api/interfaces/_entities_dividenddistribution_.params.md +++ b/docs/api/interfaces/_entities_dividenddistribution_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Dividend Distribution constructor parameters @@ -27,128 +27,103 @@ Dividend Distribution constructor parameters ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/entities/DividendDistribution.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L57)* +_Defined in_ [_src/entities/DividendDistribution.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L57) dividend amount -___ +### checkpointId -### checkpointId +• **checkpointId**: _string_ -• **checkpointId**: *string* +_Defined in_ [_src/entities/DividendDistribution.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L41) -*Defined in [src/entities/DividendDistribution.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L41)* +### claimedAmount -___ +• **claimedAmount**: _BigNumber_ -### claimedAmount - -• **claimedAmount**: *BigNumber* - -*Defined in [src/entities/DividendDistribution.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L61)* +_Defined in_ [_src/entities/DividendDistribution.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L61) amount of dividend claimed so far -___ - -### created +### created -• **created**: *Date* +• **created**: _Date_ -*Defined in [src/entities/DividendDistribution.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L45)* +_Defined in_ [_src/entities/DividendDistribution.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L45) date at which the dividend was created -___ +### currency -### currency +• **currency**: _string \| null_ -• **currency**: *string | null* - -*Defined in [src/entities/DividendDistribution.ts:77](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L77)* +_Defined in_ [_src/entities/DividendDistribution.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L77) symbol of the currency in which this dividend distribution is being paid -___ - -### expiry +### expiry -• **expiry**: *Date* +• **expiry**: _Date_ -*Defined in [src/entities/DividendDistribution.ts:53](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L53)* +_Defined in_ [_src/entities/DividendDistribution.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L53) date until which dividend can be claimed -___ - -### maturity +### maturity -• **maturity**: *Date* +• **maturity**: _Date_ -*Defined in [src/entities/DividendDistribution.ts:49](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L49)* +_Defined in_ [_src/entities/DividendDistribution.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L49) date after which dividend can be claimed -___ +### name -### name +• **name**: _string_ -• **name**: *string* +_Defined in_ [_src/entities/DividendDistribution.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L73) -*Defined in [src/entities/DividendDistribution.ts:73](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L73)* +### reclaimed -___ +• **reclaimed**: _boolean_ -### reclaimed - -• **reclaimed**: *boolean* - -*Defined in [src/entities/DividendDistribution.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L69)* +_Defined in_ [_src/entities/DividendDistribution.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L69) true if expiry has passed and issuer has reclaimed remaining dividend -___ - -### securityTokenSymbol +### securityTokenSymbol -• **securityTokenSymbol**: *string* +• **securityTokenSymbol**: _string_ -*Defined in [src/entities/DividendDistribution.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L40)* +_Defined in_ [_src/entities/DividendDistribution.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L40) -___ +### tokenholders -### tokenholders +• **tokenholders**: [_DividendTokenholderStatus_](_types_index_.dividendtokenholderstatus.md)_\[\]_ -• **tokenholders**: *[DividendTokenholderStatus](_types_index_.dividendtokenholderstatus.md)[]* +_Defined in_ [_src/entities/DividendDistribution.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L72) -*Defined in [src/entities/DividendDistribution.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L72)* +### totalSupply -___ +• **totalSupply**: _BigNumber_ -### totalSupply - -• **totalSupply**: *BigNumber* - -*Defined in [src/entities/DividendDistribution.ts:65](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L65)* +_Defined in_ [_src/entities/DividendDistribution.ts:65_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L65) total supply at the associated checkpoint -___ - -### totalWithheld +### totalWithheld -• **totalWithheld**: *BigNumber* +• **totalWithheld**: _BigNumber_ -*Defined in [src/entities/DividendDistribution.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L70)* +_Defined in_ [_src/entities/DividendDistribution.ts:70_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L70) -___ +### totalWithheldWithdrawn -### totalWithheldWithdrawn +• **totalWithheldWithdrawn**: _BigNumber_ -• **totalWithheldWithdrawn**: *BigNumber* +_Defined in_ [_src/entities/DividendDistribution.ts:71_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L71) -*Defined in [src/entities/DividendDistribution.ts:71](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L71)* diff --git a/docs/api/interfaces/_entities_dividenddistribution_.uniqueidentifiers.md b/docs/api/interfaces/_entities_dividenddistribution_.uniqueidentifiers.md index 974e318..32bb9bd 100644 --- a/docs/api/interfaces/_entities_dividenddistribution_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_dividenddistribution_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Dividend Distribution @@ -15,20 +15,19 @@ Properties that uniquely identify a Dividend Distribution ## Properties -### index +### index -• **index**: *number* +• **index**: _number_ -*Defined in [src/entities/DividendDistribution.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L20)* +_Defined in_ [_src/entities/DividendDistribution.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L20) ordered index of the distribution -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* - -*Defined in [src/entities/DividendDistribution.ts:16](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L16)* +_Defined in_ [_src/entities/DividendDistribution.ts:16_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/DividendDistribution.ts#L16) security token UUID + diff --git a/docs/api/interfaces/_entities_erc20tokenbalance_.params.md b/docs/api/interfaces/_entities_erc20tokenbalance_.params.md index 3ff6f57..42d2b28 100644 --- a/docs/api/interfaces/_entities_erc20tokenbalance_.params.md +++ b/docs/api/interfaces/_entities_erc20tokenbalance_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -15,16 +15,15 @@ Constructor parameters ## Properties -### balance +### balance -• **balance**: *BigNumber* +• **balance**: _BigNumber_ -*Defined in [src/entities/Erc20TokenBalance.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L29)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L29) -___ +### tokenSymbol -### tokenSymbol +• **tokenSymbol**: _string \| null_ -• **tokenSymbol**: *string | null* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L28) -*Defined in [src/entities/Erc20TokenBalance.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L28)* diff --git a/docs/api/interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md b/docs/api/interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md index d8aafc6..778daf7 100644 --- a/docs/api/interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_erc20tokenbalance_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify an ERC20 token balance @@ -15,16 +15,15 @@ Properties that uniquely identify an ERC20 token balance ## Properties -### tokenAddress +### tokenAddress -• **tokenAddress**: *string* +• **tokenAddress**: _string_ -*Defined in [src/entities/Erc20TokenBalance.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L11)* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L11) -___ +### walletAddress -### walletAddress +• **walletAddress**: _string_ -• **walletAddress**: *string* +_Defined in_ [_src/entities/Erc20TokenBalance.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L12) -*Defined in [src/entities/Erc20TokenBalance.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Erc20TokenBalance.ts#L12)* diff --git a/docs/api/interfaces/_entities_factories_factory_.entityclass.md b/docs/api/interfaces/_entities_factories_factory_.entityclass.md index efb1bda..ee1d9f8 100644 --- a/docs/api/interfaces/_entities_factories_factory_.entityclass.md +++ b/docs/api/interfaces/_entities_factories_factory_.entityclass.md @@ -1,4 +1,4 @@ -# Interface: EntityClass <**T, U**> +# EntityClass Represents an entity @@ -25,53 +25,52 @@ Represents an entity ## Constructors -### constructor +### constructor -\+ **new EntityClass**(`params`: T & U, `context`: [Context](../classes/_context_.context.md)): *[Entity](../classes/_entities_entity_.entity.md)‹T›* ++ **new EntityClass**\(`params`: T & U, `context`: [Context](../classes/_context_.context.md)\): [_Entity_](../classes/_entities_entity_.entity.md)_‹T›_ -*Defined in [src/entities/factories/Factory.ts:8](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L8)* +_Defined in_ [_src/entities/factories/Factory.ts:8_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L8) **Parameters:** -Name | Type | ------- | ------ | -`params` | T & U | -`context` | [Context](../classes/_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `params` | T & U | +| `context` | [Context](../classes/_context_.context.md) | -**Returns:** *[Entity](../classes/_entities_entity_.entity.md)‹T›* +**Returns:** [_Entity_](../classes/_entities_entity_.entity.md)_‹T›_ ## Methods -### generateId +### generateId -▸ **generateId**(`identifiers`: U): *string* +▸ **generateId**\(`identifiers`: U\): _string_ -*Defined in [src/entities/factories/Factory.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L19)* +_Defined in_ [_src/entities/factories/Factory.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L19) generate a unique identifier for an entity **Parameters:** -Name | Type | ------- | ------ | -`identifiers` | U | +| Name | Type | +| :--- | :--- | +| `identifiers` | U | -**Returns:** *string* +**Returns:** _string_ -___ +### unserialize -### unserialize +▸ **unserialize**\(`uid`: string\): _U_ -▸ **unserialize**(`uid`: string): *U* - -*Defined in [src/entities/factories/Factory.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L14)* +_Defined in_ [_src/entities/factories/Factory.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/Factory.ts#L14) unserialize serialized entity information **Parameters:** -Name | Type | ------- | ------ | -`uid` | string | +| Name | Type | +| :--- | :--- | +| `uid` | string | + +**Returns:** _U_ -**Returns:** *U* diff --git a/docs/api/interfaces/_entities_investment_.params.md b/docs/api/interfaces/_entities_investment_.params.md index a512f49..6896624 100644 --- a/docs/api/interfaces/_entities_investment_.params.md +++ b/docs/api/interfaces/_entities_investment_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -17,32 +17,27 @@ Constructor parameters ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Investment.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L33)* +_Defined in_ [_src/entities/Investment.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L33) -___ +### investedFunds -### investedFunds +• **investedFunds**: _BigNumber_ -• **investedFunds**: *BigNumber* +_Defined in_ [_src/entities/Investment.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L35) -*Defined in [src/entities/Investment.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L35)* +### securityTokenSymbol -___ +• **securityTokenSymbol**: _string_ -### securityTokenSymbol +_Defined in_ [_src/entities/Investment.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L32) -• **securityTokenSymbol**: *string* +### tokenAmount -*Defined in [src/entities/Investment.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L32)* +• **tokenAmount**: _BigNumber_ -___ +_Defined in_ [_src/entities/Investment.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L34) -### tokenAmount - -• **tokenAmount**: *BigNumber* - -*Defined in [src/entities/Investment.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L34)* diff --git a/docs/api/interfaces/_entities_investment_.uniqueidentifiers.md b/docs/api/interfaces/_entities_investment_.uniqueidentifiers.md index 96e3716..21a6ae0 100644 --- a/docs/api/interfaces/_entities_investment_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_investment_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify an Investment @@ -16,24 +16,21 @@ Properties that uniquely identify an Investment ## Properties -### index +### index -• **index**: *number* +• **index**: _number_ -*Defined in [src/entities/Investment.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L13)* +_Defined in_ [_src/entities/Investment.ts:13_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L13) -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/Investment.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L11) -*Defined in [src/entities/Investment.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L11)* +### stoId -___ +• **stoId**: _string_ -### stoId +_Defined in_ [_src/entities/Investment.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L12) -• **stoId**: *string* - -*Defined in [src/entities/Investment.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Investment.ts#L12)* diff --git a/docs/api/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md b/docs/api/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md index a0e6cd1..45eaff7 100644 --- a/docs/api/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md +++ b/docs/api/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md @@ -1,4 +1,4 @@ -# Interface: GetDistributionParams +# GetDistributionParams Parameters of the [getDistribution](../classes/_entities_securitytoken_dividends_.dividends.md#getdistribution) function @@ -14,10 +14,11 @@ Parameters of the [getDistribution](../classes/_entities_securitytoken_dividends ## Properties -### dividendIndex +### dividendIndex -• **dividendIndex**: *number* +• **dividendIndex**: _number_ -*Defined in [src/entities/SecurityToken/Dividends.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Dividends.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L22) dividend distribution representation + diff --git a/docs/api/interfaces/_entities_securitytoken_documents_.document.md b/docs/api/interfaces/_entities_securitytoken_documents_.document.md index c84479e..61b17a1 100644 --- a/docs/api/interfaces/_entities_securitytoken_documents_.document.md +++ b/docs/api/interfaces/_entities_securitytoken_documents_.document.md @@ -1,4 +1,4 @@ -# Interface: Document +# Document Represents a single Document attached to a Security Token @@ -17,38 +17,33 @@ Represents a single Document attached to a Security Token ## Properties -### documentHash +### documentHash -• **documentHash**: *string* +• **documentHash**: _string_ -*Defined in [src/entities/SecurityToken/Documents.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L22) hash of the document's contents -___ +### documentUri -### documentUri +• **documentUri**: _string_ -• **documentUri**: *string* - -*Defined in [src/entities/SecurityToken/Documents.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L18)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L18) off-chain uri of the document from where it is accessible to investors/advisors to read -___ - -### name +### name -• **name**: *string* +• **name**: _string_ -*Defined in [src/entities/SecurityToken/Documents.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L14)* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:14_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L14) name of the document. It should always be unique -___ +### updatedAt -### updatedAt +• **updatedAt**: _Date_ -• **updatedAt**: *Date* +_Defined in_ [_src/entities/SecurityToken/Documents.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L23) -*Defined in [src/entities/SecurityToken/Documents.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Documents.ts#L23)* diff --git a/docs/api/interfaces/_entities_securitytoken_features_.enable.md b/docs/api/interfaces/_entities_securitytoken_features_.enable.md index 52b2eb3..84b1fca 100644 --- a/docs/api/interfaces/_entities_securitytoken_features_.enable.md +++ b/docs/api/interfaces/_entities_securitytoken_features_.enable.md @@ -1,4 +1,4 @@ -# Interface: Enable +# Enable ## Hierarchy @@ -6,78 +6,79 @@ ## Callable -▸ (`args`: object): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableGeneralPermissionManagerProcedureArgs](_types_index_.enablegeneralpermissionmanagerprocedureargs.md)››* +▸ \(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralPermissionManagerProcedureArgs_](_types_index_.enablegeneralpermissionmanagerprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:53](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L53)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L53) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [Permissions](../enums/_types_index_.feature.md#permissions) | +| Name | Type | +| :--- | :--- | +| `feature` | [Permissions](../enums/_types_index_.feature.md#permissions) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableGeneralPermissionManagerProcedureArgs](_types_index_.enablegeneralpermissionmanagerprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralPermissionManagerProcedureArgs_](_types_index_.enablegeneralpermissionmanagerprocedureargs.md)_››_ -▸ (`args`: object): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableGeneralTransferManagerProcedureArgs](_types_index_.enablegeneraltransfermanagerprocedureargs.md)››* +▸ \(`args`: object\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralTransferManagerProcedureArgs_](_types_index_.enablegeneraltransfermanagerprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L56)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L56) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [Tokenholders](../enums/_types_index_.feature.md#tokenholders) | +| Name | Type | +| :--- | :--- | +| `feature` | [Tokenholders](../enums/_types_index_.feature.md#tokenholders) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableGeneralTransferManagerProcedureArgs](_types_index_.enablegeneraltransfermanagerprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableGeneralTransferManagerProcedureArgs_](_types_index_.enablegeneraltransfermanagerprocedureargs.md)_››_ -▸ (`args`: object, `opts`: [EnableErc20DividendsOpts](_entities_securitytoken_features_.enableerc20dividendsopts.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableDividendManagerProcedureArgs](_types_index_.enabledividendmanagerprocedureargs.md)››* +▸ \(`args`: object, `opts`: [EnableErc20DividendsOpts](_entities_securitytoken_features_.enableerc20dividendsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableDividendManagerProcedureArgs_](_types_index_.enabledividendmanagerprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L59)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L59) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [Dividends](../enums/_types_index_.feature.md#dividends) | +| Name | Type | +| :--- | :--- | +| `feature` | [Dividends](../enums/_types_index_.feature.md#dividends) | -▪ **opts**: *[EnableErc20DividendsOpts](_entities_securitytoken_features_.enableerc20dividendsopts.md)* +▪ **opts**: [_EnableErc20DividendsOpts_](_entities_securitytoken_features_.enableerc20dividendsopts.md) -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableDividendManagerProcedureArgs](_types_index_.enabledividendmanagerprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableDividendManagerProcedureArgs_](_types_index_.enabledividendmanagerprocedureargs.md)_››_ -▸ (`args`: object, `opts`: [EnableTokenholderCountRestrictionsOpts](_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableCountTransferManagerProcedureArgs](_types_index_.enablecounttransfermanagerprocedureargs.md)››* +▸ \(`args`: object, `opts`: [EnableTokenholderCountRestrictionsOpts](_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableCountTransferManagerProcedureArgs_](_types_index_.enablecounttransfermanagerprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:62](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L62)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L62) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [TokenholderCountRestrictions](../enums/_types_index_.feature.md#tokenholdercountrestrictions) | +| Name | Type | +| :--- | :--- | +| `feature` | [TokenholderCountRestrictions](../enums/_types_index_.feature.md#tokenholdercountrestrictions) | -▪ **opts**: *[EnableTokenholderCountRestrictionsOpts](_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md)* +▪ **opts**: [_EnableTokenholderCountRestrictionsOpts_](_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md) -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnableCountTransferManagerProcedureArgs](_types_index_.enablecounttransfermanagerprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnableCountTransferManagerProcedureArgs_](_types_index_.enablecounttransfermanagerprocedureargs.md)_››_ -▸ (`args`: object, `opts`: [EnablePercentageOwnershipRestrictionsOpts](_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnablePercentageTransferManagerProcedureArgs](_types_index_.enablepercentagetransfermanagerprocedureargs.md)››* +▸ \(`args`: object, `opts`: [EnablePercentageOwnershipRestrictionsOpts](_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnablePercentageTransferManagerProcedureArgs_](_types_index_.enablepercentagetransfermanagerprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Features.ts:66](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L66)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:66_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L66) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`feature` | [PercentageOwnershipRestrictions](../enums/_types_index_.feature.md#percentageownershiprestrictions) | +| Name | Type | +| :--- | :--- | +| `feature` | [PercentageOwnershipRestrictions](../enums/_types_index_.feature.md#percentageownershiprestrictions) | -▪ **opts**: *[EnablePercentageOwnershipRestrictionsOpts](_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md)* +▪ **opts**: [_EnablePercentageOwnershipRestrictionsOpts_](_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md) + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_EnablePercentageTransferManagerProcedureArgs_](_types_index_.enablepercentagetransfermanagerprocedureargs.md)_››_ -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[EnablePercentageTransferManagerProcedureArgs](_types_index_.enablepercentagetransfermanagerprocedureargs.md)››* diff --git a/docs/api/interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md b/docs/api/interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md index e07a2f2..e217678 100644 --- a/docs/api/interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md +++ b/docs/api/interfaces/_entities_securitytoken_features_.enableerc20dividendsopts.md @@ -1,4 +1,4 @@ -# Interface: EnableErc20DividendsOpts +# EnableErc20DividendsOpts ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### storageWalletAddress +### storageWalletAddress -• **storageWalletAddress**: *string* +• **storageWalletAddress**: _string_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L41) -*Defined in [src/entities/SecurityToken/Features.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L41)* diff --git a/docs/api/interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md b/docs/api/interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md index 4a9a809..2383637 100644 --- a/docs/api/interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md +++ b/docs/api/interfaces/_entities_securitytoken_features_.enablepercentageownershiprestrictionsopts.md @@ -1,4 +1,4 @@ -# Interface: EnablePercentageOwnershipRestrictionsOpts +# EnablePercentageOwnershipRestrictionsOpts ## Hierarchy @@ -15,14 +15,13 @@ ### `Optional` allowPrimaryIssuance -• **allowPrimaryIssuance**? : *undefined | false | true* +• **allowPrimaryIssuance**? : _undefined \| false \| true_ -*Defined in [src/entities/SecurityToken/Features.ts:50](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L50)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L50) -___ +### maxHolderPercentage -### maxHolderPercentage +• **maxHolderPercentage**: _BigNumber_ -• **maxHolderPercentage**: *BigNumber* +_Defined in_ [_src/entities/SecurityToken/Features.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L49) -*Defined in [src/entities/SecurityToken/Features.ts:49](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L49)* diff --git a/docs/api/interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md b/docs/api/interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md index e760f7d..5105832 100644 --- a/docs/api/interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md +++ b/docs/api/interfaces/_entities_securitytoken_features_.enabletokenholdercountrestrictionsopts.md @@ -1,4 +1,4 @@ -# Interface: EnableTokenholderCountRestrictionsOpts +# EnableTokenholderCountRestrictionsOpts ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### maxHolderCount +### maxHolderCount -• **maxHolderCount**: *number* +• **maxHolderCount**: _number_ + +_Defined in_ [_src/entities/SecurityToken/Features.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L45) -*Defined in [src/entities/SecurityToken/Features.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L45)* diff --git a/docs/api/interfaces/_entities_securitytoken_features_.featurestatuses.md b/docs/api/interfaces/_entities_securitytoken_features_.featurestatuses.md index dcbdcb8..b0fb307 100644 --- a/docs/api/interfaces/_entities_securitytoken_features_.featurestatuses.md +++ b/docs/api/interfaces/_entities_securitytoken_features_.featurestatuses.md @@ -1,6 +1,6 @@ -# Interface: FeatureStatuses +# FeatureStatuses -Current status (enabled/disabled) of all Security Token Features +Current status \(enabled/disabled\) of all Security Token Features ## Hierarchy @@ -10,48 +10,41 @@ Current status (enabled/disabled) of all Security Token Features ### Properties -* [[Feature.Dividends]](_entities_securitytoken_features_.featurestatuses.md#[feature.dividends]) -* [[Feature.PercentageOwnershipRestrictions]](_entities_securitytoken_features_.featurestatuses.md#[feature.percentageownershiprestrictions]) -* [[Feature.Permissions]](_entities_securitytoken_features_.featurestatuses.md#[feature.permissions]) -* [[Feature.TokenholderCountRestrictions]](_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholdercountrestrictions]) -* [[Feature.Tokenholders]](_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholders]) +* [\[Feature.Dividends\]](_entities_securitytoken_features_.featurestatuses.md#[feature.dividends]) +* [\[Feature.PercentageOwnershipRestrictions\]](_entities_securitytoken_features_.featurestatuses.md#[feature.percentageownershiprestrictions]) +* [\[Feature.Permissions\]](_entities_securitytoken_features_.featurestatuses.md#[feature.permissions]) +* [\[Feature.TokenholderCountRestrictions\]](_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholdercountrestrictions]) +* [\[Feature.Tokenholders\]](_entities_securitytoken_features_.featurestatuses.md#[feature.tokenholders]) ## Properties -### [Feature.Dividends] +### \[Feature.Dividends\] -• **[Feature.Dividends]**: *boolean* +• **\[Feature.Dividends\]**: _boolean_ -*Defined in [src/entities/SecurityToken/Features.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L30)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L30) -___ +### \[Feature.PercentageOwnershipRestrictions\] -### [Feature.PercentageOwnershipRestrictions] +• **\[Feature.PercentageOwnershipRestrictions\]**: _boolean_ -• **[Feature.PercentageOwnershipRestrictions]**: *boolean* +_Defined in_ [_src/entities/SecurityToken/Features.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L32) -*Defined in [src/entities/SecurityToken/Features.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L32)* +### \[Feature.Permissions\] -___ +• **\[Feature.Permissions\]**: _boolean_ -### [Feature.Permissions] +_Defined in_ [_src/entities/SecurityToken/Features.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L28) -• **[Feature.Permissions]**: *boolean* +### \[Feature.TokenholderCountRestrictions\] -*Defined in [src/entities/SecurityToken/Features.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L28)* +• **\[Feature.TokenholderCountRestrictions\]**: _boolean_ -___ +_Defined in_ [_src/entities/SecurityToken/Features.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L31) -### [Feature.TokenholderCountRestrictions] +### \[Feature.Tokenholders\] -• **[Feature.TokenholderCountRestrictions]**: *boolean* +• **\[Feature.Tokenholders\]**: _boolean_ -*Defined in [src/entities/SecurityToken/Features.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L31)* +_Defined in_ [_src/entities/SecurityToken/Features.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L29) -___ - -### [Feature.Tokenholders] - -• **[Feature.Tokenholders]**: *boolean* - -*Defined in [src/entities/SecurityToken/Features.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Features.ts#L29)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstomethod.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstomethod.md index 5363aa4..eb3017e 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstomethod.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstomethod.md @@ -1,4 +1,4 @@ -# Interface: GetStoMethod +# GetStoMethod ## Hierarchy @@ -6,44 +6,45 @@ ## Callable -▸ (`args`: object): *Promise‹[SimpleSto](../classes/_entities_simplesto_.simplesto.md)›* +▸ \(`args`: object\): _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_›_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:149](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L149)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:149_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L149) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`address` | string | -`stoType` | [Simple](../enums/_types_index_.stotype.md#simple) | +| Name | Type | +| :--- | :--- | +| `address` | string | +| `stoType` | [Simple](../enums/_types_index_.stotype.md#simple) | -**Returns:** *Promise‹[SimpleSto](../classes/_entities_simplesto_.simplesto.md)›* +**Returns:** _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md)_›_ -▸ (`args`: object): *Promise‹[TieredSto](../classes/_entities_tieredsto_.tieredsto.md)›* +▸ \(`args`: object\): _Promise‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L150)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L150) **Parameters:** -▪ **args**: *object* +▪ **args**: _object_ -Name | Type | ------- | ------ | -`address` | string | -`stoType` | [Tiered](../enums/_types_index_.stotype.md#tiered) | +| Name | Type | +| :--- | :--- | +| `address` | string | +| `stoType` | [Tiered](../enums/_types_index_.stotype.md#tiered) | -**Returns:** *Promise‹[TieredSto](../classes/_entities_tieredsto_.tieredsto.md)›* +**Returns:** _Promise‹_[_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ -▸ (`args`: string): *Promise‹[SimpleSto](../classes/_entities_simplesto_.simplesto.md) | [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)›* +▸ \(`args`: string\): _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:151](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L151)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:151_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L151) **Parameters:** -Name | Type | ------- | ------ | -`args` | string | +| Name | Type | +| :--- | :--- | +| `args` | string | + +**Returns:** _Promise‹_[_SimpleSto_](../classes/_entities_simplesto_.simplesto.md) _\|_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_›_ -**Returns:** *Promise‹[SimpleSto](../classes/_entities_simplesto_.simplesto.md) | [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)›* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md index 386df5b..4913919 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md @@ -1,4 +1,4 @@ -# Interface: GetStoParams +# GetStoParams Params for [getSto](../classes/_entities_securitytoken_issuance_offerings_.offerings.md#getsto) @@ -15,16 +15,15 @@ Params for [getSto](../classes/_entities_securitytoken_issuance_offerings_.offer ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L52)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L52) -___ +### stoType -### stoType +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:51_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L51) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:51](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L51)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md index 965d03b..f6a3a82 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyBothNoStableCoinParams +# LaunchTieredStoCustomCurrencyBothNoStableCoinParams ## Hierarchy @@ -15,24 +15,21 @@ ## Properties -### currencies +### currencies -• **currencies**: *[EthAndPoly](../modules/_entities_securitytoken_issuance_offerings_.md#ethandpoly)* +• **currencies**: [_EthAndPoly_](../external-modules/_entities_securitytoken_issuance_offerings_.md#ethandpoly) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:114](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L114)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:114_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L114) -___ +### customCurrency -### customCurrency +• **customCurrency**: _object_ -• **customCurrency**: *object* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:115](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L115)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:115_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L115) #### Type declaration: -* **currencySymbol**? : *undefined | string* - -* **ethOracleAddress**: *string* +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ +* **polyOracleAddress**: _string_ -* **polyOracleAddress**: *string* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md index 166e382..1a36fe5 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyBothParams +# LaunchTieredStoCustomCurrencyBothParams ## Hierarchy @@ -26,116 +26,95 @@ ### `Optional` allowPreIssuance -• **allowPreIssuance**? : *undefined | false | true* +• **allowPreIssuance**? : _undefined \| false \| true_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[allowPreIssuance](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) -___ +### currencies -### currencies +• **currencies**: [_AllCurrencies_](../external-modules/_entities_securitytoken_issuance_offerings_.md#allcurrencies) -• **currencies**: *[AllCurrencies](../modules/_entities_securitytoken_issuance_offerings_.md#allcurrencies)* +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[currencies](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:103_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L103) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:103](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L103)* +### customCurrency -___ +• **customCurrency**: _object_ -### customCurrency +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) -• **customCurrency**: *object* - -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[customCurrency](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L104)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:104_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L104) #### Type declaration: -* **currencySymbol**? : *undefined | string* - -* **ethOracleAddress**: *string* - -* **polyOracleAddress**: *string* - -___ - -### endDate - -• **endDate**: *Date* - -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[endDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20)* - -___ - -### minimumInvestment +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ +* **polyOracleAddress**: _string_ -• **minimumInvestment**: *BigNumber* +### endDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[minimumInvestment](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment)* +• **endDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) -### nonAccreditedInvestmentLimit +### minimumInvestment -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **minimumInvestment**: _BigNumber_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[nonAccreditedInvestmentLimit](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) -___ +### nonAccreditedInvestmentLimit -### raisedFundsWallet +• **nonAccreditedInvestmentLimit**: _BigNumber_ -• **raisedFundsWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[raisedFundsWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25)* +### raisedFundsWallet -___ +• **raisedFundsWallet**: _string_ -### stableCoinAddresses +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) -• **stableCoinAddresses**: *string[]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[stableCoinAddresses](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses)* +### stableCoinAddresses -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:109](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L109)* +• **stableCoinAddresses**: _string\[\]_ -___ +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) -### startDate +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:109_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L109) -• **startDate**: *Date* +### startDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[startDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate)* +• **startDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) -### tiers +### tiers -• **tiers**: *[StoTier](_types_index_.stotier.md)[]* +• **tiers**: [_StoTier_](_types_index_.stotier.md)_\[\]_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[tiers](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[unsoldTokensWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md index 9a72e41..44fa273 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyEthNoStableCoinParams +# LaunchTieredStoCustomCurrencyEthNoStableCoinParams ## Hierarchy @@ -15,22 +15,20 @@ ## Properties -### currencies +### currencies -• **currencies**: *[OnlyEth](../modules/_entities_securitytoken_issuance_offerings_.md#onlyeth)* +• **currencies**: [_OnlyEth_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlyeth) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:77](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L77)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:77_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L77) -___ +### customCurrency -### customCurrency +• **customCurrency**: _object_ -• **customCurrency**: *object* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:78](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L78)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:78_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L78) #### Type declaration: -* **currencySymbol**? : *undefined | string* +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ -* **ethOracleAddress**: *string* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md index 4f61eb4..fcf8e6f 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyEthParams +# LaunchTieredStoCustomCurrencyEthParams ## Hierarchy @@ -26,114 +26,94 @@ ### `Optional` allowPreIssuance -• **allowPreIssuance**? : *undefined | false | true* +• **allowPreIssuance**? : _undefined \| false \| true_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[allowPreIssuance](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) -___ +### currencies -### currencies +• **currencies**: [_OnlyEth_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlyeth) _\|_ [_EthAndStableCoin_](../external-modules/_entities_securitytoken_issuance_offerings_.md#ethandstablecoin) -• **currencies**: *[OnlyEth](../modules/_entities_securitytoken_issuance_offerings_.md#onlyeth) | [EthAndStableCoin](../modules/_entities_securitytoken_issuance_offerings_.md#ethandstablecoin)* +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[currencies](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:67_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L67) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:67](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L67)* +### customCurrency -___ +• **customCurrency**: _object_ -### customCurrency +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) -• **customCurrency**: *object* - -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[customCurrency](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L68)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L68) #### Type declaration: -* **currencySymbol**? : *undefined | string* - -* **ethOracleAddress**: *string* - -___ - -### endDate - -• **endDate**: *Date* - -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[endDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20)* - -___ - -### minimumInvestment +* **currencySymbol**? : _undefined \| string_ +* **ethOracleAddress**: _string_ -• **minimumInvestment**: *BigNumber* +### endDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[minimumInvestment](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment)* +• **endDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) -### nonAccreditedInvestmentLimit +### minimumInvestment -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **minimumInvestment**: _BigNumber_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[nonAccreditedInvestmentLimit](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) -___ +### nonAccreditedInvestmentLimit -### raisedFundsWallet +• **nonAccreditedInvestmentLimit**: _BigNumber_ -• **raisedFundsWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[raisedFundsWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25)* +### raisedFundsWallet -___ +• **raisedFundsWallet**: _string_ -### stableCoinAddresses +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) -• **stableCoinAddresses**: *string[]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[stableCoinAddresses](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses)* +### stableCoinAddresses -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L72)* +• **stableCoinAddresses**: _string\[\]_ -___ +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) -### startDate +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L72) -• **startDate**: *Date* +### startDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[startDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate)* +• **startDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) -### tiers +### tiers -• **tiers**: *[StoTier](_types_index_.stotier.md)[]* +• **tiers**: [_StoTier_](_types_index_.stotier.md)_\[\]_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[tiers](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[unsoldTokensWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md index 5900d2e..bd735c4 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyPolyNoStableCoinParams +# LaunchTieredStoCustomCurrencyPolyNoStableCoinParams ## Hierarchy @@ -15,22 +15,20 @@ ## Properties -### currencies +### currencies -• **currencies**: *[OnlyPoly](../modules/_entities_securitytoken_issuance_offerings_.md#onlypoly)* +• **currencies**: [_OnlyPoly_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlypoly) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:95](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L95)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:95_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L95) -___ +### customCurrency -### customCurrency +• **customCurrency**: _object_ -• **customCurrency**: *object* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:96](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L96)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:96_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L96) #### Type declaration: -* **currencySymbol**? : *undefined | string* +* **currencySymbol**? : _undefined \| string_ +* **polyOracleAddress**: _string_ -* **polyOracleAddress**: *string* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md index f5a4bcc..18e847d 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoCustomCurrencyPolyParams +# LaunchTieredStoCustomCurrencyPolyParams ## Hierarchy @@ -26,114 +26,94 @@ ### `Optional` allowPreIssuance -• **allowPreIssuance**? : *undefined | false | true* +• **allowPreIssuance**? : _undefined \| false \| true_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[allowPreIssuance](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_allowPreIssuance_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-allowpreissuance) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) -___ +### currencies -### currencies +• **currencies**: [_OnlyPoly_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlypoly) _\|_ [_PolyAndStableCoin_](../external-modules/_entities_securitytoken_issuance_offerings_.md#polyandstablecoin) -• **currencies**: *[OnlyPoly](../modules/_entities_securitytoken_issuance_offerings_.md#onlypoly) | [PolyAndStableCoin](../modules/_entities_securitytoken_issuance_offerings_.md#polyandstablecoin)* +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_currencies_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[currencies](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#currencies)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:85_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L85) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:85](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L85)* +### customCurrency -___ +• **customCurrency**: _object_ -### customCurrency +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_customCurrency_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency) -• **customCurrency**: *object* - -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[customCurrency](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-customcurrency)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:86](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L86)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:86_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L86) #### Type declaration: -* **currencySymbol**? : *undefined | string* - -* **polyOracleAddress**: *string* - -___ - -### endDate - -• **endDate**: *Date* - -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[endDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate)* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20)* - -___ - -### minimumInvestment +* **currencySymbol**? : _undefined \| string_ +* **polyOracleAddress**: _string_ -• **minimumInvestment**: *BigNumber* +### endDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[minimumInvestment](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment)* +• **endDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_endDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#enddate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) -### nonAccreditedInvestmentLimit +### minimumInvestment -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **minimumInvestment**: _BigNumber_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[nonAccreditedInvestmentLimit](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_minimumInvestment_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#minimuminvestment) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) -___ +### nonAccreditedInvestmentLimit -### raisedFundsWallet +• **nonAccreditedInvestmentLimit**: _BigNumber_ -• **raisedFundsWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_nonAccreditedInvestmentLimit_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#nonaccreditedinvestmentlimit) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[raisedFundsWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25)* +### raisedFundsWallet -___ +• **raisedFundsWallet**: _string_ -### stableCoinAddresses +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_raisedFundsWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#raisedfundswallet) -• **stableCoinAddresses**: *string[]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) -*Overrides [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[stableCoinAddresses](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses)* +### stableCoinAddresses -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L90)* +• **stableCoinAddresses**: _string\[\]_ -___ +_Overrides_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_stableCoinAddresses_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#optional-stablecoinaddresses) -### startDate +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:90_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L90) -• **startDate**: *Date* +### startDate -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[startDate](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate)* +• **startDate**: _Date_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_startDate_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#startdate) -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) -### tiers +### tiers -• **tiers**: *[StoTier](_types_index_.stotier.md)[]* +• **tiers**: [_StoTier_](_types_index_.stotier.md)_\[\]_ -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[tiers](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers)* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_tiers_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#tiers) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Inherited from_ [_LaunchTieredStoParams_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)_._[_unsoldTokensWallet_](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet) -*Inherited from [LaunchTieredStoParams](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md).[unsoldTokensWallet](_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md#unsoldtokenswallet)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md index 010b419..27c3c52 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstomethod.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoMethod +# LaunchTieredStoMethod ## Hierarchy @@ -6,98 +6,99 @@ ## Callable -▸ (`args`: [LaunchTieredStoNoCustomCurrencyParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoNoCustomCurrencyParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:122](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L122)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:122_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L122) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoNoCustomCurrencyParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoNoCustomCurrencyParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L125)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L125) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoNoCustomCurrencyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyEthParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyEthParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:128](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L128)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L128) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyEthParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyEthParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:131](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L131)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:131_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L131) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyEthNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencyethnostablecoinparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyPolyParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyPolyParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:134](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L134)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L134) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyPolyParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyPolyParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolyparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L137)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L137) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyPolyNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencypolynostablecoinparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyBothParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyBothParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L140)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L140) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyBothParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyBothParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -▸ (`args`: [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* +▸ \(`args`: [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:143](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L143)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:143_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L143) **Parameters:** -Name | Type | ------- | ------ | -`args` | [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md) | +| Name | Type | +| :--- | :--- | +| `args` | [LaunchTieredStoCustomCurrencyBothNoStableCoinParams](_entities_securitytoken_issuance_offerings_.launchtieredstocustomcurrencybothnostablecoinparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_LaunchTieredStoProcedureArgs_](_types_index_.launchtieredstoprocedureargs.md)_,_ [_TieredSto_](../classes/_entities_tieredsto_.tieredsto.md)_››_ -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[LaunchTieredStoProcedureArgs](_types_index_.launchtieredstoprocedureargs.md), [TieredSto](../classes/_entities_tieredsto_.tieredsto.md)››* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md index 927f1e6..e9fcf8d 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencynostablecoinparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoNoCustomCurrencyNoStableCoinParams +# LaunchTieredStoNoCustomCurrencyNoStableCoinParams ## Hierarchy @@ -14,8 +14,9 @@ ## Properties -### currencies +### currencies -• **currencies**: *[OnlyEth](../modules/_entities_securitytoken_issuance_offerings_.md#onlyeth) | [OnlyPoly](../modules/_entities_securitytoken_issuance_offerings_.md#onlypoly) | [EthAndPoly](../modules/_entities_securitytoken_issuance_offerings_.md#ethandpoly)* +• **currencies**: [_OnlyEth_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlyeth) _\|_ [_OnlyPoly_](../external-modules/_entities_securitytoken_issuance_offerings_.md#onlypoly) _\|_ [_EthAndPoly_](../external-modules/_entities_securitytoken_issuance_offerings_.md#ethandpoly) + +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L57) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L57)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md index ff67562..e516a48 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstonocustomcurrencyparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoNoCustomCurrencyParams +# LaunchTieredStoNoCustomCurrencyParams ## Hierarchy @@ -15,16 +15,15 @@ ## Properties -### currencies +### currencies -• **currencies**: *[EthAndStableCoin](../modules/_entities_securitytoken_issuance_offerings_.md#ethandstablecoin) | [PolyAndStableCoin](../modules/_entities_securitytoken_issuance_offerings_.md#polyandstablecoin) | [AllCurrencies](../modules/_entities_securitytoken_issuance_offerings_.md#allcurrencies)* +• **currencies**: [_EthAndStableCoin_](../external-modules/_entities_securitytoken_issuance_offerings_.md#ethandstablecoin) _\|_ [_PolyAndStableCoin_](../external-modules/_entities_securitytoken_issuance_offerings_.md#polyandstablecoin) _\|_ [_AllCurrencies_](../external-modules/_entities_securitytoken_issuance_offerings_.md#allcurrencies) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:62](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L62)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L62) -___ +### stableCoinAddresses -### stableCoinAddresses +• **stableCoinAddresses**: _string\[\]_ -• **stableCoinAddresses**: *string[]* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:63_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L63) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:63](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L63)* diff --git a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md index e89c229..c0dbb07 100644 --- a/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md +++ b/docs/api/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoParams +# LaunchTieredStoParams ## Hierarchy @@ -30,86 +30,67 @@ ### `Optional` allowPreIssuance -• **allowPreIssuance**? : *undefined | false | true* +• **allowPreIssuance**? : _undefined \| false \| true_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L29) -___ +### currencies -### currencies +• **currencies**: _Currency\[\]_ -• **currencies**: *Currency[]* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L24)* - -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L24) ### `Optional` customCurrency -• **customCurrency**? : *Partial‹[CustomCurrency](_types_index_.customcurrency.md)›* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L28)* - -___ - -### endDate +• **customCurrency**? : _Partial‹_[_CustomCurrency_](_types_index_.customcurrency.md)_›_ -• **endDate**: *Date* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L28) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20)* +### endDate -___ +• **endDate**: _Date_ -### minimumInvestment +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L20) -• **minimumInvestment**: *BigNumber* +### minimumInvestment -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:23](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23)* +• **minimumInvestment**: _BigNumber_ -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:23_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L23) -### nonAccreditedInvestmentLimit +### nonAccreditedInvestmentLimit -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **nonAccreditedInvestmentLimit**: _BigNumber_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L22) -___ +### raisedFundsWallet -### raisedFundsWallet +• **raisedFundsWallet**: _string_ -• **raisedFundsWallet**: *string* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25)* - -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L25) ### `Optional` stableCoinAddresses -• **stableCoinAddresses**? : *string[]* - -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L27)* - -___ +• **stableCoinAddresses**? : _string\[\]_ -### startDate +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L27) -• **startDate**: *Date* +### startDate -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19)* +• **startDate**: _Date_ -___ +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L19) -### tiers +### tiers -• **tiers**: *[StoTier](_types_index_.stotier.md)[]* +• **tiers**: [_StoTier_](_types_index_.stotier.md)_\[\]_ -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21)* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L21) -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Defined in_ [_src/entities/SecurityToken/Issuance/Offerings.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26) -*Defined in [src/entities/SecurityToken/Issuance/Offerings.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L26)* diff --git a/docs/api/interfaces/_entities_securitytoken_securitytoken_.params.md b/docs/api/interfaces/_entities_securitytoken_securitytoken_.params.md index a7a2a99..5373a01 100644 --- a/docs/api/interfaces/_entities_securitytoken_securitytoken_.params.md +++ b/docs/api/interfaces/_entities_securitytoken_securitytoken_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Security Token constructor parameters @@ -22,83 +22,67 @@ Security Token constructor parameters ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L44)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L44) address of the Security Token contract -___ +### currentCheckpoint -### currentCheckpoint +• **currentCheckpoint**: _number_ -• **currentCheckpoint**: *number* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L59)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L59) index of the current checkpoint -___ - -### granularity - -• **granularity**: *number* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:54](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L54)* +### granularity -___ +• **granularity**: _number_ -### name +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:54_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L54) -• **name**: *string* +### name -*Defined in [src/entities/SecurityToken/SecurityToken.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L40)* +• **name**: _string_ -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L40) -### owner +### owner -• **owner**: *string* +• **owner**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L48)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L48) address that owns the Security Token -___ +### tokenDetails -### tokenDetails +• **tokenDetails**: _string_ -• **tokenDetails**: *string* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L52)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L52) URL pointing to off-chain data associated with the Security Token -___ - -### totalSupply - -• **totalSupply**: *BigNumber* +### totalSupply -*Defined in [src/entities/SecurityToken/SecurityToken.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L55)* +• **totalSupply**: _BigNumber_ -___ +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L55) -### treasuryWallet +### treasuryWallet -• **treasuryWallet**: *string* +• **treasuryWallet**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L64)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L64) -default treasury wallet used by some features. -***For example, if an STO reaches its end date (or is finalized before that), remaining unsold tokens get transferred to this wallet unless otherwise specified by the STO itself*** +default treasury wallet used by some features. _**For example, if an STO reaches its end date \(or is finalized before that\), remaining unsold tokens get transferred to this wallet unless otherwise specified by the STO itself**_ -___ +### version -### version +• **version**: _Version_ -• **version**: *Version* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:53_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L53) -*Defined in [src/entities/SecurityToken/SecurityToken.ts:53](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L53)* diff --git a/docs/api/interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md b/docs/api/interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md index 4eaf9d4..60c6ed1 100644 --- a/docs/api/interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Security Token @@ -14,10 +14,11 @@ Properties that uniquely identify a Security Token ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/entities/SecurityToken/SecurityToken.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L24)* +_Defined in_ [_src/entities/SecurityToken/SecurityToken.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L24) symbol of the security token + diff --git a/docs/api/interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md b/docs/api/interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md index ea328cf..f50eaf6 100644 --- a/docs/api/interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md +++ b/docs/api/interfaces/_entities_securitytoken_tokenholders_.getcheckpointparams.md @@ -1,4 +1,4 @@ -# Interface: GetCheckpointParams +# GetCheckpointParams Parameters for [getCheckpoint](../classes/_polymathbase_.polymathbase.md#getcheckpoint) @@ -14,8 +14,9 @@ Parameters for [getCheckpoint](../classes/_polymathbase_.polymathbase.md#getchec ## Properties -### checkpointIndex +### checkpointIndex -• **checkpointIndex**: *number* +• **checkpointIndex**: _number_ + +_Defined in_ [_src/entities/SecurityToken/Tokenholders.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L18) -*Defined in [src/entities/SecurityToken/Tokenholders.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Tokenholders.ts#L18)* diff --git a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md index 94a33a4..a1544c6 100644 --- a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md +++ b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.modifyexemptionsmethod.md @@ -1,4 +1,4 @@ -# Interface: ModifyExemptionsMethod +# ModifyExemptionsMethod ## Hierarchy @@ -6,26 +6,27 @@ ## Callable -▸ (`params`: [PercentageWhitelistParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](_types_index_.modifypercentageexemptionsprocedureargs.md)››* +▸ \(`params`: [PercentageWhitelistParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:25](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L25)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L25) **Parameters:** -Name | Type | ------- | ------ | -`params` | [PercentageWhitelistParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [PercentageWhitelistParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md) | -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](_types_index_.modifypercentageexemptionsprocedureargs.md)››* +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ -▸ (`params`: [PercentageIssuanceParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md)): *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](_types_index_.modifypercentageexemptionsprocedureargs.md)››* +▸ \(`params`: [PercentageIssuanceParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md)\): _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L28)* +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L28) **Parameters:** -Name | Type | ------- | ------ | -`params` | [PercentageIssuanceParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [PercentageIssuanceParams](_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md) | + +**Returns:** _Promise‹_[_TransactionQueue_](../classes/_entities_transactionqueue_.transactionqueue.md)_‹_[_ModifyPercentageExemptionsProcedureArgs_](_types_index_.modifypercentageexemptionsprocedureargs.md)_››_ -**Returns:** *Promise‹[TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md)‹[ModifyPercentageExemptionsProcedureArgs](_types_index_.modifypercentageexemptionsprocedureargs.md)››* diff --git a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md index f3e85e1..23b6289 100644 --- a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md +++ b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentageissuanceparams.md @@ -1,4 +1,4 @@ -# Interface: PercentageIssuanceParams +# PercentageIssuanceParams ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### allowPrimaryIssuance +### allowPrimaryIssuance -• **allowPrimaryIssuance**: *boolean* +• **allowPrimaryIssuance**: _boolean_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L22) -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L22)* diff --git a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md index 29a37b3..8acb02d 100644 --- a/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md +++ b/docs/api/interfaces/_entities_securitytoken_transfers_restrictions_percentagerestrictions_.percentagewhitelistparams.md @@ -1,4 +1,4 @@ -# Interface: PercentageWhitelistParams +# PercentageWhitelistParams ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### whitelistEntries +### whitelistEntries -• **whitelistEntries**: *[PercentageWhitelistEntry](_types_index_.percentagewhitelistentry.md)[]* +• **whitelistEntries**: [_PercentageWhitelistEntry_](_types_index_.percentagewhitelistentry.md)_\[\]_ + +_Defined in_ [_src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:18_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L18) -*Defined in [src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts#L18)* diff --git a/docs/api/interfaces/_entities_securitytokenreservation_.params.md b/docs/api/interfaces/_entities_securitytokenreservation_.params.md index 1074d5b..67ba30a 100644 --- a/docs/api/interfaces/_entities_securitytokenreservation_.params.md +++ b/docs/api/interfaces/_entities_securitytokenreservation_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -17,34 +17,29 @@ Constructor parameters ## Properties -### expiry +### expiry -• **expiry**: *Date* +• **expiry**: _Date_ -*Defined in [src/entities/SecurityTokenReservation.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L31)* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L31) expiry date for the ticker reservation -___ +### ownerAddress -### ownerAddress +• **ownerAddress**: _string_ -• **ownerAddress**: *string* +_Defined in_ [_src/entities/SecurityTokenReservation.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L33) -*Defined in [src/entities/SecurityTokenReservation.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L33)* +### reservedAt -___ +• **reservedAt**: _Date_ -### reservedAt - -• **reservedAt**: *Date* - -*Defined in [src/entities/SecurityTokenReservation.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L32)* - -___ +_Defined in_ [_src/entities/SecurityTokenReservation.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L32) ### `Optional` securityTokenAddress -• **securityTokenAddress**? : *undefined | string* +• **securityTokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L34) -*Defined in [src/entities/SecurityTokenReservation.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L34)* diff --git a/docs/api/interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md b/docs/api/interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md index af4cbc1..8c21026 100644 --- a/docs/api/interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_securitytokenreservation_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Security Token Reservation @@ -14,8 +14,9 @@ Properties that uniquely identify a Security Token Reservation ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ + +_Defined in_ [_src/entities/SecurityTokenReservation.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L12) -*Defined in [src/entities/SecurityTokenReservation.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityTokenReservation.ts#L12)* diff --git a/docs/api/interfaces/_entities_simplesto_.params.md b/docs/api/interfaces/_entities_simplesto_.params.md index de699d0..d00b827 100644 --- a/docs/api/interfaces/_entities_simplesto_.params.md +++ b/docs/api/interfaces/_entities_simplesto_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Properties that uniquely identify a simple sto @@ -31,188 +31,159 @@ Properties that uniquely identify a simple sto ## Properties -### beneficialInvestmentsAllowed +### beneficialInvestmentsAllowed -• **beneficialInvestmentsAllowed**: *boolean* +• **beneficialInvestmentsAllowed**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[beneficialInvestmentsAllowed](_entities_sto_.params.md#beneficialinvestmentsallowed)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_beneficialInvestmentsAllowed_](_entities_sto_.params.md#beneficialinvestmentsallowed) -*Defined in [src/entities/Sto.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92)* +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) whether or not investments can be made on behalf of a beneficiary in the sto -___ +### cap -### cap +• **cap**: _BigNumber_ -• **cap**: *BigNumber* - -*Defined in [src/entities/SimpleSto.ts:24](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L24)* +_Defined in_ [_src/entities/SimpleSto.ts:24_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L24) cap for how many tokens can be sold -___ - -### capReached +### capReached -• **capReached**: *boolean* +• **capReached**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[capReached](_entities_sto_.params.md#capreached)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_capReached_](_entities_sto_.params.md#capreached) -*Defined in [src/entities/Sto.ts:80](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80)* +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) whether or not the cap has been reached for the sto -___ +### endDate -### endDate +• **endDate**: _Date_ -• **endDate**: *Date* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_endDate_](_entities_sto_.params.md#enddate) -*Inherited from [Params](_entities_sto_.params.md).[endDate](_entities_sto_.params.md#enddate)* - -*Defined in [src/entities/Sto.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48)* +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) expiry date of the sto -___ - -### fundraiseCurrencies +### fundraiseCurrencies -• **fundraiseCurrencies**: *Currency[]* +• **fundraiseCurrencies**: _Currency\[\]_ -*Inherited from [Params](_entities_sto_.params.md).[fundraiseCurrencies](_entities_sto_.params.md#fundraisecurrencies)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_fundraiseCurrencies_](_entities_sto_.params.md#fundraisecurrencies) -*Defined in [src/entities/Sto.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52)* +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) currencies that can be used to fundraise in this sto -___ +### investorCount -### investorCount +• **investorCount**: _number_ -• **investorCount**: *number* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_investorCount_](_entities_sto_.params.md#investorcount) -*Inherited from [Params](_entities_sto_.params.md).[investorCount](_entities_sto_.params.md#investorcount)* - -*Defined in [src/entities/Sto.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72)* +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) number of investors in the sto -___ - -### isFinalized +### isFinalized -• **isFinalized**: *boolean* +• **isFinalized**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[isFinalized](_entities_sto_.params.md#isfinalized)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_isFinalized_](_entities_sto_.params.md#isfinalized) -*Defined in [src/entities/Sto.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84)* +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) whether or not the sto has been finalized -___ +### isPaused -### isPaused +• **isPaused**: _boolean_ -• **isPaused**: *boolean* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_isPaused_](_entities_sto_.params.md#ispaused) -*Inherited from [Params](_entities_sto_.params.md).[isPaused](_entities_sto_.params.md#ispaused)* - -*Defined in [src/entities/Sto.ts:76](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76)* +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) whether or not the sto is currently paused -___ - -### preIssueAllowed +### preIssueAllowed -• **preIssueAllowed**: *boolean* +• **preIssueAllowed**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[preIssueAllowed](_entities_sto_.params.md#preissueallowed)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_preIssueAllowed_](_entities_sto_.params.md#preissueallowed) -*Defined in [src/entities/Sto.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88)* +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) whether or not pre issuance is allowed for the sto -___ +### raisedAmount -### raisedAmount +• **raisedAmount**: _BigNumber_ -• **raisedAmount**: *BigNumber* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_raisedAmount_](_entities_sto_.params.md#raisedamount) -*Inherited from [Params](_entities_sto_.params.md).[raisedAmount](_entities_sto_.params.md#raisedamount)* - -*Defined in [src/entities/Sto.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64)* +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) funds that have been raised to this date -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Inherited from [Params](_entities_sto_.params.md).[raisedFundsWallet](_entities_sto_.params.md#raisedfundswallet)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_raisedFundsWallet_](_entities_sto_.params.md#raisedfundswallet) -*Defined in [src/entities/Sto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56)* +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) wallet address where raised funds will be stored -___ +### rate -### rate +• **rate**: _BigNumber_ -• **rate**: *BigNumber* - -*Defined in [src/entities/SimpleSto.ts:28](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L28)* +_Defined in_ [_src/entities/SimpleSto.ts:28_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SimpleSto.ts#L28) rate at which tokens will be sold -___ - -### securityTokenSymbol +### securityTokenSymbol -• **securityTokenSymbol**: *string* +• **securityTokenSymbol**: _string_ -*Inherited from [Params](_entities_sto_.params.md).[securityTokenSymbol](_entities_sto_.params.md#securitytokensymbol)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_securityTokenSymbol_](_entities_sto_.params.md#securitytokensymbol) -*Defined in [src/entities/Sto.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40)* +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) symbol of security token -___ +### soldTokensAmount -### soldTokensAmount +• **soldTokensAmount**: _BigNumber_ -• **soldTokensAmount**: *BigNumber* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_soldTokensAmount_](_entities_sto_.params.md#soldtokensamount) -*Inherited from [Params](_entities_sto_.params.md).[soldTokensAmount](_entities_sto_.params.md#soldtokensamount)* - -*Defined in [src/entities/Sto.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68)* +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) amount of tokens that have been sold -___ - -### startDate +### startDate -• **startDate**: *Date* +• **startDate**: _Date_ -*Inherited from [Params](_entities_sto_.params.md).[startDate](_entities_sto_.params.md#startdate)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_startDate_](_entities_sto_.params.md#startdate) -*Defined in [src/entities/Sto.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44)* +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) start date of the sto -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_unsoldTokensWallet_](_entities_sto_.params.md#unsoldtokenswallet) -*Inherited from [Params](_entities_sto_.params.md).[unsoldTokensWallet](_entities_sto_.params.md#unsoldtokenswallet)* - -*Defined in [src/entities/Sto.ts:60](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60)* +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) wallet address where unsold tokens will be returned to + diff --git a/docs/api/interfaces/_entities_sto_.params.md b/docs/api/interfaces/_entities_sto_.params.md index cff0e95..d3b8609 100644 --- a/docs/api/interfaces/_entities_sto_.params.md +++ b/docs/api/interfaces/_entities_sto_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params STO constructor parameters @@ -31,140 +31,115 @@ STO constructor parameters ## Properties -### beneficialInvestmentsAllowed +### beneficialInvestmentsAllowed -• **beneficialInvestmentsAllowed**: *boolean* +• **beneficialInvestmentsAllowed**: _boolean_ -*Defined in [src/entities/Sto.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92)* +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) whether or not investments can be made on behalf of a beneficiary in the sto -___ +### capReached -### capReached +• **capReached**: _boolean_ -• **capReached**: *boolean* - -*Defined in [src/entities/Sto.ts:80](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80)* +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) whether or not the cap has been reached for the sto -___ - -### endDate +### endDate -• **endDate**: *Date* +• **endDate**: _Date_ -*Defined in [src/entities/Sto.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48)* +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) expiry date of the sto -___ +### fundraiseCurrencies -### fundraiseCurrencies +• **fundraiseCurrencies**: _Currency\[\]_ -• **fundraiseCurrencies**: *Currency[]* - -*Defined in [src/entities/Sto.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52)* +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) currencies that can be used to fundraise in this sto -___ - -### investorCount +### investorCount -• **investorCount**: *number* +• **investorCount**: _number_ -*Defined in [src/entities/Sto.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72)* +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) number of investors in the sto -___ +### isFinalized -### isFinalized +• **isFinalized**: _boolean_ -• **isFinalized**: *boolean* - -*Defined in [src/entities/Sto.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84)* +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) whether or not the sto has been finalized -___ - -### isPaused +### isPaused -• **isPaused**: *boolean* +• **isPaused**: _boolean_ -*Defined in [src/entities/Sto.ts:76](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76)* +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) whether or not the sto is currently paused -___ - -### preIssueAllowed +### preIssueAllowed -• **preIssueAllowed**: *boolean* +• **preIssueAllowed**: _boolean_ -*Defined in [src/entities/Sto.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88)* +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) whether or not pre issuance is allowed for the sto -___ +### raisedAmount -### raisedAmount +• **raisedAmount**: _BigNumber_ -• **raisedAmount**: *BigNumber* - -*Defined in [src/entities/Sto.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64)* +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) funds that have been raised to this date -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Defined in [src/entities/Sto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56)* +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) wallet address where raised funds will be stored -___ +### securityTokenSymbol -### securityTokenSymbol +• **securityTokenSymbol**: _string_ -• **securityTokenSymbol**: *string* - -*Defined in [src/entities/Sto.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40)* +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) symbol of security token -___ - -### soldTokensAmount +### soldTokensAmount -• **soldTokensAmount**: *BigNumber* +• **soldTokensAmount**: _BigNumber_ -*Defined in [src/entities/Sto.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68)* +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) amount of tokens that have been sold -___ +### startDate -### startDate +• **startDate**: _Date_ -• **startDate**: *Date* - -*Defined in [src/entities/Sto.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44)* +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) start date of the sto -___ - -### unsoldTokensWallet +### unsoldTokensWallet -• **unsoldTokensWallet**: *string* +• **unsoldTokensWallet**: _string_ -*Defined in [src/entities/Sto.ts:60](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60)* +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) wallet address where unsold tokens will be returned to + diff --git a/docs/api/interfaces/_entities_sto_.uniqueidentifiers.md b/docs/api/interfaces/_entities_sto_.uniqueidentifiers.md index dbee01f..1d0015d 100644 --- a/docs/api/interfaces/_entities_sto_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_sto_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify an STO @@ -16,24 +16,21 @@ Properties that uniquely identify an STO ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Sto.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L21)* +_Defined in_ [_src/entities/Sto.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L21) -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/Sto.ts:19_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L19) -*Defined in [src/entities/Sto.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L19)* +### stoType -___ +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -### stoType +_Defined in_ [_src/entities/Sto.ts:20_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L20) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* - -*Defined in [src/entities/Sto.ts:20](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L20)* diff --git a/docs/api/interfaces/_entities_taxwithholding_.params.md b/docs/api/interfaces/_entities_taxwithholding_.params.md index 42bec82..89947fb 100644 --- a/docs/api/interfaces/_entities_taxwithholding_.params.md +++ b/docs/api/interfaces/_entities_taxwithholding_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -15,16 +15,15 @@ Constructor parameters ## Properties -### percentage +### percentage -• **percentage**: *number* +• **percentage**: _number_ -*Defined in [src/entities/TaxWithholding.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L33)* +_Defined in_ [_src/entities/TaxWithholding.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L33) -___ +### securityTokenSymbol -### securityTokenSymbol +• **securityTokenSymbol**: _string_ -• **securityTokenSymbol**: *string* +_Defined in_ [_src/entities/TaxWithholding.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L32) -*Defined in [src/entities/TaxWithholding.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L32)* diff --git a/docs/api/interfaces/_entities_taxwithholding_.uniqueidentifiers.md b/docs/api/interfaces/_entities_taxwithholding_.uniqueidentifiers.md index df23d44..6beaa75 100644 --- a/docs/api/interfaces/_entities_taxwithholding_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_taxwithholding_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Tax Withholding percentage @@ -15,16 +15,15 @@ Properties that uniquely identify a Tax Withholding percentage ## Properties -### securityTokenId +### securityTokenId -• **securityTokenId**: *string* +• **securityTokenId**: _string_ -*Defined in [src/entities/TaxWithholding.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L10)* +_Defined in_ [_src/entities/TaxWithholding.ts:10_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L10) -___ +### tokenholderAddress -### tokenholderAddress +• **tokenholderAddress**: _string_ -• **tokenholderAddress**: *string* +_Defined in_ [_src/entities/TaxWithholding.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L11) -*Defined in [src/entities/TaxWithholding.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TaxWithholding.ts#L11)* diff --git a/docs/api/interfaces/_entities_tieredsto_.params.md b/docs/api/interfaces/_entities_tieredsto_.params.md index 194d9cd..1ec649a 100644 --- a/docs/api/interfaces/_entities_tieredsto_.params.md +++ b/docs/api/interfaces/_entities_tieredsto_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Represents a Tiered STO @@ -34,212 +34,177 @@ Represents a Tiered STO ## Properties -### beneficialInvestmentsAllowed +### beneficialInvestmentsAllowed -• **beneficialInvestmentsAllowed**: *boolean* +• **beneficialInvestmentsAllowed**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[beneficialInvestmentsAllowed](_entities_sto_.params.md#beneficialinvestmentsallowed)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_beneficialInvestmentsAllowed_](_entities_sto_.params.md#beneficialinvestmentsallowed) -*Defined in [src/entities/Sto.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92)* +_Defined in_ [_src/entities/Sto.ts:92_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L92) whether or not investments can be made on behalf of a beneficiary in the sto -___ +### capReached -### capReached +• **capReached**: _boolean_ -• **capReached**: *boolean* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_capReached_](_entities_sto_.params.md#capreached) -*Inherited from [Params](_entities_sto_.params.md).[capReached](_entities_sto_.params.md#capreached)* - -*Defined in [src/entities/Sto.ts:80](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80)* +_Defined in_ [_src/entities/Sto.ts:80_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L80) whether or not the cap has been reached for the sto -___ - -### currentTier +### currentTier -• **currentTier**: *number* +• **currentTier**: _number_ -*Defined in [src/entities/TieredSto.ts:57](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L57)* +_Defined in_ [_src/entities/TieredSto.ts:57_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L57) numerical identifier for the current tier index -___ - -### endDate +### endDate -• **endDate**: *Date* +• **endDate**: _Date_ -*Inherited from [Params](_entities_sto_.params.md).[endDate](_entities_sto_.params.md#enddate)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_endDate_](_entities_sto_.params.md#enddate) -*Defined in [src/entities/Sto.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48)* +_Defined in_ [_src/entities/Sto.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L48) expiry date of the sto -___ +### fundraiseCurrencies -### fundraiseCurrencies +• **fundraiseCurrencies**: _Currency\[\]_ -• **fundraiseCurrencies**: *Currency[]* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_fundraiseCurrencies_](_entities_sto_.params.md#fundraisecurrencies) -*Inherited from [Params](_entities_sto_.params.md).[fundraiseCurrencies](_entities_sto_.params.md#fundraisecurrencies)* - -*Defined in [src/entities/Sto.ts:52](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52)* +_Defined in_ [_src/entities/Sto.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L52) currencies that can be used to fundraise in this sto -___ - -### investorCount +### investorCount -• **investorCount**: *number* +• **investorCount**: _number_ -*Inherited from [Params](_entities_sto_.params.md).[investorCount](_entities_sto_.params.md#investorcount)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_investorCount_](_entities_sto_.params.md#investorcount) -*Defined in [src/entities/Sto.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72)* +_Defined in_ [_src/entities/Sto.ts:72_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L72) number of investors in the sto -___ +### isFinalized -### isFinalized +• **isFinalized**: _boolean_ -• **isFinalized**: *boolean* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_isFinalized_](_entities_sto_.params.md#isfinalized) -*Inherited from [Params](_entities_sto_.params.md).[isFinalized](_entities_sto_.params.md#isfinalized)* - -*Defined in [src/entities/Sto.ts:84](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84)* +_Defined in_ [_src/entities/Sto.ts:84_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L84) whether or not the sto has been finalized -___ - -### isPaused +### isPaused -• **isPaused**: *boolean* +• **isPaused**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[isPaused](_entities_sto_.params.md#ispaused)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_isPaused_](_entities_sto_.params.md#ispaused) -*Defined in [src/entities/Sto.ts:76](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76)* +_Defined in_ [_src/entities/Sto.ts:76_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L76) whether or not the sto is currently paused -___ - -### minimumInvestment - -• **minimumInvestment**: *BigNumber* - -*Defined in [src/entities/TieredSto.ts:63](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L63)* +### minimumInvestment -___ +• **minimumInvestment**: _BigNumber_ -### nonAccreditedInvestmentLimit +_Defined in_ [_src/entities/TieredSto.ts:63_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L63) -• **nonAccreditedInvestmentLimit**: *BigNumber* +### nonAccreditedInvestmentLimit -*Defined in [src/entities/TieredSto.ts:62](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L62)* +• **nonAccreditedInvestmentLimit**: _BigNumber_ -___ +_Defined in_ [_src/entities/TieredSto.ts:62_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L62) -### preIssueAllowed +### preIssueAllowed -• **preIssueAllowed**: *boolean* +• **preIssueAllowed**: _boolean_ -*Inherited from [Params](_entities_sto_.params.md).[preIssueAllowed](_entities_sto_.params.md#preissueallowed)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_preIssueAllowed_](_entities_sto_.params.md#preissueallowed) -*Defined in [src/entities/Sto.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88)* +_Defined in_ [_src/entities/Sto.ts:88_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L88) whether or not pre issuance is allowed for the sto -___ +### raisedAmount -### raisedAmount +• **raisedAmount**: _BigNumber_ -• **raisedAmount**: *BigNumber* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_raisedAmount_](_entities_sto_.params.md#raisedamount) -*Inherited from [Params](_entities_sto_.params.md).[raisedAmount](_entities_sto_.params.md#raisedamount)* - -*Defined in [src/entities/Sto.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64)* +_Defined in_ [_src/entities/Sto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L64) funds that have been raised to this date -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Inherited from [Params](_entities_sto_.params.md).[raisedFundsWallet](_entities_sto_.params.md#raisedfundswallet)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_raisedFundsWallet_](_entities_sto_.params.md#raisedfundswallet) -*Defined in [src/entities/Sto.ts:56](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56)* +_Defined in_ [_src/entities/Sto.ts:56_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L56) wallet address where raised funds will be stored -___ - -### securityTokenSymbol +### securityTokenSymbol -• **securityTokenSymbol**: *string* +• **securityTokenSymbol**: _string_ -*Inherited from [Params](_entities_sto_.params.md).[securityTokenSymbol](_entities_sto_.params.md#securitytokensymbol)* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_securityTokenSymbol_](_entities_sto_.params.md#securitytokensymbol) -*Defined in [src/entities/Sto.ts:40](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40)* +_Defined in_ [_src/entities/Sto.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L40) symbol of security token -___ +### soldTokensAmount -### soldTokensAmount +• **soldTokensAmount**: _BigNumber_ -• **soldTokensAmount**: *BigNumber* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_soldTokensAmount_](_entities_sto_.params.md#soldtokensamount) -*Inherited from [Params](_entities_sto_.params.md).[soldTokensAmount](_entities_sto_.params.md#soldtokensamount)* - -*Defined in [src/entities/Sto.ts:68](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68)* +_Defined in_ [_src/entities/Sto.ts:68_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L68) amount of tokens that have been sold -___ - -### stableCoinAddresses +### stableCoinAddresses -• **stableCoinAddresses**: *string[]* +• **stableCoinAddresses**: _string\[\]_ -*Defined in [src/entities/TieredSto.ts:64](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L64)* +_Defined in_ [_src/entities/TieredSto.ts:64_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L64) -___ +### startDate -### startDate +• **startDate**: _Date_ -• **startDate**: *Date* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_startDate_](_entities_sto_.params.md#startdate) -*Inherited from [Params](_entities_sto_.params.md).[startDate](_entities_sto_.params.md#startdate)* - -*Defined in [src/entities/Sto.ts:44](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44)* +_Defined in_ [_src/entities/Sto.ts:44_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L44) start date of the sto -___ - -### tiers +### tiers -• **tiers**: *[Tier](_entities_tieredsto_.tier.md)[]* +• **tiers**: [_Tier_](_entities_tieredsto_.tier.md)_\[\]_ -*Defined in [src/entities/TieredSto.ts:61](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L61)* +_Defined in_ [_src/entities/TieredSto.ts:61_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L61) array of tier information -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* +_Inherited from_ [_Params_](_entities_sto_.params.md)_._[_unsoldTokensWallet_](_entities_sto_.params.md#unsoldtokenswallet) -*Inherited from [Params](_entities_sto_.params.md).[unsoldTokensWallet](_entities_sto_.params.md#unsoldtokenswallet)* - -*Defined in [src/entities/Sto.ts:60](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60)* +_Defined in_ [_src/entities/Sto.ts:60_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Sto.ts#L60) wallet address where unsold tokens will be returned to + diff --git a/docs/api/interfaces/_entities_tieredsto_.tier.md b/docs/api/interfaces/_entities_tieredsto_.tier.md index fc309ab..ec58023 100644 --- a/docs/api/interfaces/_entities_tieredsto_.tier.md +++ b/docs/api/interfaces/_entities_tieredsto_.tier.md @@ -1,4 +1,4 @@ -# Interface: Tier +# Tier ## Hierarchy @@ -17,60 +17,51 @@ ## Properties -### discountedPrice +### discountedPrice -• **discountedPrice**: *BigNumber* +• **discountedPrice**: _BigNumber_ -*Defined in [src/entities/TieredSto.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L47)* +_Defined in_ [_src/entities/TieredSto.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L47) discounted price at which tokens will be sold -___ +### price -### price +• **price**: _BigNumber_ -• **price**: *BigNumber* - -*Defined in [src/entities/TieredSto.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L35)* +_Defined in_ [_src/entities/TieredSto.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L35) price at which tokens will be sold within the tier -___ - -### tokensOnSale +### tokensOnSale -• **tokensOnSale**: *BigNumber* +• **tokensOnSale**: _BigNumber_ -*Defined in [src/entities/TieredSto.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L27)* +_Defined in_ [_src/entities/TieredSto.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L27) total number of tokens that are available in the tier -___ - -### tokensSold +### tokensSold -• **tokensSold**: *BigNumber* +• **tokensSold**: _BigNumber_ -*Defined in [src/entities/TieredSto.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L31)* +_Defined in_ [_src/entities/TieredSto.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L31) total number of tokens that have been sold -___ +### tokensSoldAtDiscount -### tokensSoldAtDiscount +• **tokensSoldAtDiscount**: _BigNumber_ -• **tokensSoldAtDiscount**: *BigNumber* - -*Defined in [src/entities/TieredSto.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L43)* +_Defined in_ [_src/entities/TieredSto.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L43) total number of tokens that have been sold at a discount -___ - -### tokensWithDiscount +### tokensWithDiscount -• **tokensWithDiscount**: *BigNumber* +• **tokensWithDiscount**: _BigNumber_ -*Defined in [src/entities/TieredSto.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L39)* +_Defined in_ [_src/entities/TieredSto.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/TieredSto.ts#L39) total number of tokens that are available to be sold at a discount when paid in POLY + diff --git a/docs/api/interfaces/_entities_tokenholder_.params.md b/docs/api/interfaces/_entities_tokenholder_.params.md index 17ca84f..3158b7e 100644 --- a/docs/api/interfaces/_entities_tokenholder_.params.md +++ b/docs/api/interfaces/_entities_tokenholder_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -20,56 +20,45 @@ Constructor parameters ## Properties -### balance +### balance -• **balance**: *BigNumber* +• **balance**: _BigNumber_ -*Defined in [src/entities/Tokenholder.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L35)* +_Defined in_ [_src/entities/Tokenholder.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L35) -___ +### canBuyFromSto -### canBuyFromSto +• **canBuyFromSto**: _boolean_ -• **canBuyFromSto**: *boolean* +_Defined in_ [_src/entities/Tokenholder.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L34) -*Defined in [src/entities/Tokenholder.ts:34](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L34)* +### canReceiveAfter -___ +• **canReceiveAfter**: _Date_ -### canReceiveAfter +_Defined in_ [_src/entities/Tokenholder.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L31) -• **canReceiveAfter**: *Date* +### canSendAfter -*Defined in [src/entities/Tokenholder.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L31)* +• **canSendAfter**: _Date_ -___ +_Defined in_ [_src/entities/Tokenholder.ts:30_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L30) -### canSendAfter +### isAccredited -• **canSendAfter**: *Date* +• **isAccredited**: _boolean_ -*Defined in [src/entities/Tokenholder.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L30)* +_Defined in_ [_src/entities/Tokenholder.ts:33_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L33) -___ +### kycExpiry -### isAccredited +• **kycExpiry**: _Date_ -• **isAccredited**: *boolean* +_Defined in_ [_src/entities/Tokenholder.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L32) -*Defined in [src/entities/Tokenholder.ts:33](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L33)* +### securityTokenSymbol -___ +• **securityTokenSymbol**: _string_ -### kycExpiry +_Defined in_ [_src/entities/Tokenholder.ts:29_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L29) -• **kycExpiry**: *Date* - -*Defined in [src/entities/Tokenholder.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L32)* - -___ - -### securityTokenSymbol - -• **securityTokenSymbol**: *string* - -*Defined in [src/entities/Tokenholder.ts:29](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L29)* diff --git a/docs/api/interfaces/_entities_tokenholder_.uniqueidentifiers.md b/docs/api/interfaces/_entities_tokenholder_.uniqueidentifiers.md index c031c66..5b38b05 100644 --- a/docs/api/interfaces/_entities_tokenholder_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_tokenholder_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Tokenholder of a specific Security Token @@ -15,16 +15,15 @@ Properties that uniquely identify a Tokenholder of a specific Security Token ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/entities/Tokenholder.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L12)* +_Defined in_ [_src/entities/Tokenholder.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L12) -___ +### securityTokenId -### securityTokenId +• **securityTokenId**: _string_ -• **securityTokenId**: *string* +_Defined in_ [_src/entities/Tokenholder.ts:11_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L11) -*Defined in [src/entities/Tokenholder.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Tokenholder.ts#L11)* diff --git a/docs/api/interfaces/_entities_wallet_.params.md b/docs/api/interfaces/_entities_wallet_.params.md index ffa3306..18e0bb3 100644 --- a/docs/api/interfaces/_entities_wallet_.params.md +++ b/docs/api/interfaces/_entities_wallet_.params.md @@ -1,4 +1,4 @@ -# Interface: Params +# Params Constructor parameters @@ -16,10 +16,11 @@ Constructor parameters ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Inherited from [UniqueIdentifiers](_entities_wallet_.uniqueidentifiers.md).[address](_entities_wallet_.uniqueidentifiers.md#address)* +_Inherited from_ [_UniqueIdentifiers_](_entities_wallet_.uniqueidentifiers.md)_._[_address_](_entities_wallet_.uniqueidentifiers.md#address) + +_Defined in_ [_src/entities/Wallet.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12) -*Defined in [src/entities/Wallet.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12)* diff --git a/docs/api/interfaces/_entities_wallet_.uniqueidentifiers.md b/docs/api/interfaces/_entities_wallet_.uniqueidentifiers.md index ed9bbb1..4f25cb4 100644 --- a/docs/api/interfaces/_entities_wallet_.uniqueidentifiers.md +++ b/docs/api/interfaces/_entities_wallet_.uniqueidentifiers.md @@ -1,4 +1,4 @@ -# Interface: UniqueIdentifiers +# UniqueIdentifiers Properties that uniquely identify a Wallet @@ -16,8 +16,9 @@ Properties that uniquely identify a Wallet ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ + +_Defined in_ [_src/entities/Wallet.ts:12_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12) -*Defined in [src/entities/Wallet.ts:12](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Wallet.ts#L12)* diff --git a/docs/api/interfaces/_polymath_.addressparams.md b/docs/api/interfaces/_polymath_.addressparams.md index b8a5059..7324ad3 100644 --- a/docs/api/interfaces/_polymath_.addressparams.md +++ b/docs/api/interfaces/_polymath_.addressparams.md @@ -1,4 +1,4 @@ -# Interface: AddressParams +# AddressParams ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ + +_Defined in_ [_src/Polymath.ts:45_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L45) -*Defined in [src/Polymath.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L45)* diff --git a/docs/api/interfaces/_polymath_.connect.md b/docs/api/interfaces/_polymath_.connect.md index 514aaae..efbda3f 100644 --- a/docs/api/interfaces/_polymath_.connect.md +++ b/docs/api/interfaces/_polymath_.connect.md @@ -1,4 +1,4 @@ -# Interface: Connect +# Connect ## Hierarchy @@ -6,26 +6,27 @@ ## Callable -▸ (`params`: [PolymathNetworkParams](_polymath_.polymathnetworkparams.md)): *Promise‹[Polymath](../classes/_polymath_.polymath.md)›* +▸ \(`params`: [PolymathNetworkParams](_polymath_.polymathnetworkparams.md)\): _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ -*Defined in [src/Polymath.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L35)* +_Defined in_ [_src/Polymath.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L35) **Parameters:** -Name | Type | ------- | ------ | -`params` | [PolymathNetworkParams](_polymath_.polymathnetworkparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [PolymathNetworkParams](_polymath_.polymathnetworkparams.md) | -**Returns:** *Promise‹[Polymath](../classes/_polymath_.polymath.md)›* +**Returns:** _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ -▸ (`params`: [PolymathNetworkNodeParams](_polymath_.polymathnetworknodeparams.md)): *Promise‹[Polymath](../classes/_polymath_.polymath.md)›* +▸ \(`params`: [PolymathNetworkNodeParams](_polymath_.polymathnetworknodeparams.md)\): _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ -*Defined in [src/Polymath.ts:36](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L36)* +_Defined in_ [_src/Polymath.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L36) **Parameters:** -Name | Type | ------- | ------ | -`params` | [PolymathNetworkNodeParams](_polymath_.polymathnetworknodeparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [PolymathNetworkNodeParams](_polymath_.polymathnetworknodeparams.md) | + +**Returns:** _Promise‹_[_Polymath_](../classes/_polymath_.polymath.md)_›_ -**Returns:** *Promise‹[Polymath](../classes/_polymath_.polymath.md)›* diff --git a/docs/api/interfaces/_polymath_.connectparams.md b/docs/api/interfaces/_polymath_.connectparams.md index 679c838..22391dc 100644 --- a/docs/api/interfaces/_polymath_.connectparams.md +++ b/docs/api/interfaces/_polymath_.connectparams.md @@ -1,4 +1,4 @@ -# Interface: ConnectParams +# ConnectParams ## Hierarchy @@ -19,34 +19,29 @@ ### `Optional` polymathRegistryAddress -• **polymathRegistryAddress**? : *undefined | string* +• **polymathRegistryAddress**? : _undefined \| string_ -*Inherited from [PolymathNetworkParams](_polymath_.polymathnetworkparams.md).[polymathRegistryAddress](_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress)* +_Inherited from_ [_PolymathNetworkParams_](_polymath_.polymathnetworkparams.md)_._[_polymathRegistryAddress_](_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress) -*Defined in [src/Polymath.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21)* - -___ +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) ### `Optional` privateKey -• **privateKey**? : *undefined | string* - -*Defined in [src/Polymath.ts:32](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L32)* +• **privateKey**? : _undefined \| string_ -___ +_Defined in_ [_src/Polymath.ts:32_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L32) ### `Optional` providerUrl -• **providerUrl**? : *undefined | string* +• **providerUrl**? : _undefined \| string_ -*Defined in [src/Polymath.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L31)* - -___ +_Defined in_ [_src/Polymath.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L31) ### `Optional` speed -• **speed**? : *[TransactionSpeed](../enums/_types_index_.transactionspeed.md)* +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Inherited from_ [_PolymathNetworkParams_](_polymath_.polymathnetworkparams.md)_._[_speed_](_polymath_.polymathnetworkparams.md#optional-speed) -*Inherited from [PolymathNetworkParams](_polymath_.polymathnetworkparams.md).[speed](_polymath_.polymathnetworkparams.md#optional-speed)* +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) -*Defined in [src/Polymath.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22)* diff --git a/docs/api/interfaces/_polymath_.getsecuritytoken.md b/docs/api/interfaces/_polymath_.getsecuritytoken.md index 6ccf712..32927ee 100644 --- a/docs/api/interfaces/_polymath_.getsecuritytoken.md +++ b/docs/api/interfaces/_polymath_.getsecuritytoken.md @@ -1,4 +1,4 @@ -# Interface: GetSecurityToken +# GetSecurityToken ## Hierarchy @@ -6,38 +6,39 @@ ## Callable -▸ (`params`: [SymbolParams](_polymath_.symbolparams.md)): *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* +▸ \(`params`: [SymbolParams](_polymath_.symbolparams.md)\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -*Defined in [src/Polymath.ts:48](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L48)* +_Defined in_ [_src/Polymath.ts:48_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L48) **Parameters:** -Name | Type | ------- | ------ | -`params` | [SymbolParams](_polymath_.symbolparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [SymbolParams](_polymath_.symbolparams.md) | -**Returns:** *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -▸ (`params`: [AddressParams](_polymath_.addressparams.md)): *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* +▸ \(`params`: [AddressParams](_polymath_.addressparams.md)\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -*Defined in [src/Polymath.ts:49](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L49)* +_Defined in_ [_src/Polymath.ts:49_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L49) **Parameters:** -Name | Type | ------- | ------ | -`params` | [AddressParams](_polymath_.addressparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [AddressParams](_polymath_.addressparams.md) | -**Returns:** *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -▸ (`params`: string): *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* +▸ \(`params`: string\): _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -*Defined in [src/Polymath.ts:50](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L50)* +_Defined in_ [_src/Polymath.ts:50_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L50) **Parameters:** -Name | Type | ------- | ------ | -`params` | string | +| Name | Type | +| :--- | :--- | +| `params` | string | + +**Returns:** _Promise‹_[_SecurityToken_](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)_›_ -**Returns:** *Promise‹[SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md)›* diff --git a/docs/api/interfaces/_polymath_.polymathnetworknodeparams.md b/docs/api/interfaces/_polymath_.polymathnetworknodeparams.md index 12f4169..ccc376e 100644 --- a/docs/api/interfaces/_polymath_.polymathnetworknodeparams.md +++ b/docs/api/interfaces/_polymath_.polymathnetworknodeparams.md @@ -1,4 +1,4 @@ -# Interface: PolymathNetworkNodeParams +# PolymathNetworkNodeParams ## Hierarchy @@ -19,34 +19,29 @@ ### `Optional` polymathRegistryAddress -• **polymathRegistryAddress**? : *undefined | string* +• **polymathRegistryAddress**? : _undefined \| string_ -*Inherited from [PolymathNetworkParams](_polymath_.polymathnetworkparams.md).[polymathRegistryAddress](_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress)* +_Inherited from_ [_PolymathNetworkParams_](_polymath_.polymathnetworkparams.md)_._[_polymathRegistryAddress_](_polymath_.polymathnetworkparams.md#optional-polymathregistryaddress) -*Defined in [src/Polymath.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21)* +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) -___ +### privateKey -### privateKey +• **privateKey**: _string_ -• **privateKey**: *string* +_Defined in_ [_src/Polymath.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L27) -*Defined in [src/Polymath.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L27)* +### providerUrl -___ +• **providerUrl**: _string_ -### providerUrl - -• **providerUrl**: *string* - -*Defined in [src/Polymath.ts:26](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L26)* - -___ +_Defined in_ [_src/Polymath.ts:26_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L26) ### `Optional` speed -• **speed**? : *[TransactionSpeed](../enums/_types_index_.transactionspeed.md)* +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Inherited from_ [_PolymathNetworkParams_](_polymath_.polymathnetworkparams.md)_._[_speed_](_polymath_.polymathnetworkparams.md#optional-speed) -*Inherited from [PolymathNetworkParams](_polymath_.polymathnetworkparams.md).[speed](_polymath_.polymathnetworkparams.md#optional-speed)* +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) -*Defined in [src/Polymath.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22)* diff --git a/docs/api/interfaces/_polymath_.polymathnetworkparams.md b/docs/api/interfaces/_polymath_.polymathnetworkparams.md index 6db226f..5204e4d 100644 --- a/docs/api/interfaces/_polymath_.polymathnetworkparams.md +++ b/docs/api/interfaces/_polymath_.polymathnetworkparams.md @@ -1,4 +1,4 @@ -# Interface: PolymathNetworkParams +# PolymathNetworkParams ## Hierarchy @@ -19,14 +19,13 @@ ### `Optional` polymathRegistryAddress -• **polymathRegistryAddress**? : *undefined | string* +• **polymathRegistryAddress**? : _undefined \| string_ -*Defined in [src/Polymath.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21)* - -___ +_Defined in_ [_src/Polymath.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L21) ### `Optional` speed -• **speed**? : *[TransactionSpeed](../enums/_types_index_.transactionspeed.md)* +• **speed**? : [_TransactionSpeed_](../enums/_types_index_.transactionspeed.md) + +_Defined in_ [_src/Polymath.ts:22_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22) -*Defined in [src/Polymath.ts:22](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L22)* diff --git a/docs/api/interfaces/_polymath_.symbolparams.md b/docs/api/interfaces/_polymath_.symbolparams.md index 3197ec6..cabafb7 100644 --- a/docs/api/interfaces/_polymath_.symbolparams.md +++ b/docs/api/interfaces/_polymath_.symbolparams.md @@ -1,4 +1,4 @@ -# Interface: SymbolParams +# SymbolParams ## Hierarchy @@ -12,8 +12,9 @@ ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ + +_Defined in_ [_src/Polymath.ts:41_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L41) -*Defined in [src/Polymath.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Polymath.ts#L41)* diff --git a/docs/api/interfaces/_polymathbase_.basecheckpoint.md b/docs/api/interfaces/_polymathbase_.basecheckpoint.md index 911c2c1..0c9d6cd 100644 --- a/docs/api/interfaces/_polymathbase_.basecheckpoint.md +++ b/docs/api/interfaces/_polymathbase_.basecheckpoint.md @@ -1,4 +1,4 @@ -# Interface: BaseCheckpoint +# BaseCheckpoint Internal representation of a Checkpoint @@ -17,40 +17,35 @@ Internal representation of a Checkpoint ## Properties -### createdAt +### createdAt -• **createdAt**: *Date* +• **createdAt**: _Date_ -*Defined in [src/PolymathBase.ts:271](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L271)* +_Defined in_ [_src/PolymathBase.ts:271_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L271) date at which the Checkpoint was created -___ +### index -### index +• **index**: _number_ -• **index**: *number* - -*Defined in [src/PolymathBase.ts:259](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L259)* +_Defined in_ [_src/PolymathBase.ts:259_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L259) index of the Checkpoint -___ - -### tokenholderBalances +### tokenholderBalances -• **tokenholderBalances**: *[TokenholderBalance](_types_index_.tokenholderbalance.md)[]* +• **tokenholderBalances**: [_TokenholderBalance_](_types_index_.tokenholderbalance.md)_\[\]_ -*Defined in [src/PolymathBase.ts:267](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L267)* +_Defined in_ [_src/PolymathBase.ts:267_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L267) tokenholder balances at the Checkpoint -___ +### totalSupply -### totalSupply +• **totalSupply**: _BigNumber_ -• **totalSupply**: *BigNumber* - -*Defined in [src/PolymathBase.ts:263](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L263)* +_Defined in_ [_src/PolymathBase.ts:263_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L263) total supply of the Security Token at the Checkpoint + diff --git a/docs/api/interfaces/_polymathbase_.basedividend.md b/docs/api/interfaces/_polymathbase_.basedividend.md index 9afb85a..316bd48 100644 --- a/docs/api/interfaces/_polymathbase_.basedividend.md +++ b/docs/api/interfaces/_polymathbase_.basedividend.md @@ -1,4 +1,4 @@ -# Interface: BaseDividend +# BaseDividend Internal representation of a Dividend Distribution @@ -27,140 +27,115 @@ Internal representation of a Dividend Distribution ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/PolymathBase.ts:301](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L301)* +_Defined in_ [_src/PolymathBase.ts:301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L301) amount of tokens provided in the Dividend -___ +### checkpointId -### checkpointId +• **checkpointId**: _number_ -• **checkpointId**: *number* - -*Defined in [src/PolymathBase.ts:285](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L285)* +_Defined in_ [_src/PolymathBase.ts:285_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L285) checkpoint UUID to which this Dividend Distribution is associated -___ - -### claimedAmount +### claimedAmount -• **claimedAmount**: *BigNumber* +• **claimedAmount**: _BigNumber_ -*Defined in [src/PolymathBase.ts:305](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L305)* +_Defined in_ [_src/PolymathBase.ts:305_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L305) amount of tokens paid so far -___ +### created -### created +• **created**: _Date_ -• **created**: *Date* - -*Defined in [src/PolymathBase.ts:289](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L289)* +_Defined in_ [_src/PolymathBase.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L289) date at which the Dividend was created -___ - -### currency +### currency -• **currency**: *string | null* +• **currency**: _string \| null_ -*Defined in [src/PolymathBase.ts:329](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L329)* +_Defined in_ [_src/PolymathBase.ts:329_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L329) symbol of the currency in which Dividends are being distributed -___ +### expiry -### expiry +• **expiry**: _Date_ -• **expiry**: *Date* - -*Defined in [src/PolymathBase.ts:297](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L297)* +_Defined in_ [_src/PolymathBase.ts:297_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L297) date at which the Dividend will expire -___ - -### index +### index -• **index**: *number* +• **index**: _number_ -*Defined in [src/PolymathBase.ts:281](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L281)* +_Defined in_ [_src/PolymathBase.ts:281_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L281) index of the dividend -___ - -### maturity +### maturity -• **maturity**: *Date* +• **maturity**: _Date_ -*Defined in [src/PolymathBase.ts:293](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L293)* +_Defined in_ [_src/PolymathBase.ts:293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L293) date from which payments can be distributed -___ +### name -### name +• **name**: _string_ -• **name**: *string* - -*Defined in [src/PolymathBase.ts:325](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L325)* +_Defined in_ [_src/PolymathBase.ts:325_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L325) name of the Dividend -___ - -### reclaimed +### reclaimed -• **reclaimed**: *boolean* +• **reclaimed**: _boolean_ -*Defined in [src/PolymathBase.ts:313](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L313)* +_Defined in_ [_src/PolymathBase.ts:313_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L313) whether expired payments have been reclaimed -___ +### tokenholders -### tokenholders +• **tokenholders**: [_DividendTokenholderStatus_](_types_index_.dividendtokenholderstatus.md)_\[\]_ -• **tokenholders**: *[DividendTokenholderStatus](_types_index_.dividendtokenholderstatus.md)[]* - -*Defined in [src/PolymathBase.ts:333](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L333)* +_Defined in_ [_src/PolymathBase.ts:333_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L333) dividend Tokenholders -___ - -### totalSupply +### totalSupply -• **totalSupply**: *BigNumber* +• **totalSupply**: _BigNumber_ -*Defined in [src/PolymathBase.ts:309](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L309)* +_Defined in_ [_src/PolymathBase.ts:309_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L309) total supply of the Security Token -___ +### totalWithheld -### totalWithheld +• **totalWithheld**: _BigNumber_ -• **totalWithheld**: *BigNumber* - -*Defined in [src/PolymathBase.ts:317](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L317)* +_Defined in_ [_src/PolymathBase.ts:317_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L317) total amount of tokens withheld as tax so far -___ - -### totalWithheldWithdrawn +### totalWithheldWithdrawn -• **totalWithheldWithdrawn**: *BigNumber* +• **totalWithheldWithdrawn**: _BigNumber_ -*Defined in [src/PolymathBase.ts:321](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L321)* +_Defined in_ [_src/PolymathBase.ts:321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L321) total amount of withheld taxes already withdrawn from the storage wallet + diff --git a/docs/api/interfaces/_polymathbase_.getattachedmodulesopts.md b/docs/api/interfaces/_polymathbase_.getattachedmodulesopts.md index 30e52c7..f61a91c 100644 --- a/docs/api/interfaces/_polymathbase_.getattachedmodulesopts.md +++ b/docs/api/interfaces/_polymathbase_.getattachedmodulesopts.md @@ -1,4 +1,4 @@ -# Interface: GetAttachedModulesOpts +# GetAttachedModulesOpts Options for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getattachedmodules) @@ -14,10 +14,11 @@ Options for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getat ## Properties -### unarchived +### unarchived -• **unarchived**: *boolean* +• **unarchived**: _boolean_ -*Defined in [src/PolymathBase.ts:93](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L93)* +_Defined in_ [_src/PolymathBase.ts:93_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L93) whether to include unarchived modules in the search + diff --git a/docs/api/interfaces/_polymathbase_.getattachedmodulesparams.md b/docs/api/interfaces/_polymathbase_.getattachedmodulesparams.md index 5101304..34c4a66 100644 --- a/docs/api/interfaces/_polymathbase_.getattachedmodulesparams.md +++ b/docs/api/interfaces/_polymathbase_.getattachedmodulesparams.md @@ -1,4 +1,4 @@ -# Interface: GetAttachedModulesParams +# GetAttachedModulesParams Arguments for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#getattachedmodules) @@ -15,20 +15,19 @@ Arguments for [getAttachedModules](../classes/_polymathbase_.polymathbase.md#get ## Properties -### moduleName +### moduleName -• **moduleName**: *ModuleName* +• **moduleName**: _ModuleName_ -*Defined in [src/PolymathBase.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L83)* +_Defined in_ [_src/PolymathBase.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L83) name of the module -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/PolymathBase.ts:79](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L79)* +_Defined in_ [_src/PolymathBase.ts:79_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L79) Security Token symbol + diff --git a/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameopts.md b/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameopts.md index 81e901d..a590bc6 100644 --- a/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameopts.md +++ b/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameopts.md @@ -1,4 +1,4 @@ -# Interface: GetModuleAddressesByNameOpts +# GetModuleAddressesByNameOpts Options for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md#getmoduleaddressesbyname) @@ -14,10 +14,11 @@ Options for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md ## Properties -### unarchived +### unarchived -• **unarchived**: *boolean* +• **unarchived**: _boolean_ -*Defined in [src/PolymathBase.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L69)* +_Defined in_ [_src/PolymathBase.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L69) whether to include unarchived modules in the search + diff --git a/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameparams.md b/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameparams.md index 24a0105..9065f86 100644 --- a/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameparams.md +++ b/docs/api/interfaces/_polymathbase_.getmoduleaddressesbynameparams.md @@ -1,4 +1,4 @@ -# Interface: GetModuleAddressesByNameParams +# GetModuleAddressesByNameParams Arguments for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase.md#getmoduleaddressesbyname) @@ -15,20 +15,19 @@ Arguments for [getModuleAddressesByName](../classes/_polymathbase_.polymathbase. ## Properties -### moduleName +### moduleName -• **moduleName**: *ModuleName* +• **moduleName**: _ModuleName_ -*Defined in [src/PolymathBase.ts:59](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L59)* +_Defined in_ [_src/PolymathBase.ts:59_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L59) the name of the Security Token module -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/PolymathBase.ts:55](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L55)* +_Defined in_ [_src/PolymathBase.ts:55_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L55) Security Token symbol + diff --git a/docs/api/interfaces/_polymathbase_.getmodulefactoryaddressargs.md b/docs/api/interfaces/_polymathbase_.getmodulefactoryaddressargs.md index f874a24..ed305c7 100644 --- a/docs/api/interfaces/_polymathbase_.getmodulefactoryaddressargs.md +++ b/docs/api/interfaces/_polymathbase_.getmodulefactoryaddressargs.md @@ -1,4 +1,4 @@ -# Interface: GetModuleFactoryAddressArgs +# GetModuleFactoryAddressArgs Arguments for [getModuleFactoryAddress](../classes/_polymathbase_.polymathbase.md#getmodulefactoryaddress) @@ -15,20 +15,19 @@ Arguments for [getModuleFactoryAddress](../classes/_polymathbase_.polymathbase.m ## Properties -### moduleName +### moduleName -• **moduleName**: *ModuleName* +• **moduleName**: _ModuleName_ -*Defined in [src/PolymathBase.ts:245](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L245)* +_Defined in_ [_src/PolymathBase.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L245) name of Security Token module -___ +### tokenAddress -### tokenAddress +• **tokenAddress**: _string_ -• **tokenAddress**: *string* - -*Defined in [src/PolymathBase.ts:249](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L249)* +_Defined in_ [_src/PolymathBase.ts:249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathBase.ts#L249) ethereum address of Module Factory + diff --git a/docs/api/interfaces/_procedures_procedure_.procedureclass.md b/docs/api/interfaces/_procedures_procedure_.procedureclass.md index 40be09c..ead79e5 100644 --- a/docs/api/interfaces/_procedures_procedure_.procedureclass.md +++ b/docs/api/interfaces/_procedures_procedure_.procedureclass.md @@ -1,10 +1,10 @@ -# Interface: ProcedureClass <**Args, ReturnType**> +# ProcedureClass ## Type parameters ▪ **Args** -▪ **ReturnType**: *any* +▪ **ReturnType**: _any_ ## Hierarchy @@ -18,17 +18,18 @@ ## Constructors -### constructor +### constructor -\+ **new ProcedureClass**(`args`: Args, `context`: [Context](../classes/_context_.context.md)): *Procedure‹Args, ReturnType›* ++ **new ProcedureClass**\(`args`: Args, `context`: [Context](../classes/_context_.context.md)\): _Procedure‹Args, ReturnType›_ -*Defined in [src/procedures/Procedure.ts:21](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L21)* +_Defined in_ [_src/procedures/Procedure.ts:21_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L21) **Parameters:** -Name | Type | ------- | ------ | -`args` | Args | -`context` | [Context](../classes/_context_.context.md) | +| Name | Type | +| :--- | :--- | +| `args` | Args | +| `context` | [Context](../classes/_context_.context.md) | + +**Returns:** _Procedure‹Args, ReturnType›_ -**Returns:** *Procedure‹Args, ReturnType›* diff --git a/docs/api/interfaces/_types_index_.approveerc20procedureargs.md b/docs/api/interfaces/_types_index_.approveerc20procedureargs.md index f4ccd74..15ea7f5 100644 --- a/docs/api/interfaces/_types_index_.approveerc20procedureargs.md +++ b/docs/api/interfaces/_types_index_.approveerc20procedureargs.md @@ -1,4 +1,4 @@ -# Interface: ApproveErc20ProcedureArgs +# ApproveErc20ProcedureArgs Arguments for the [ApproveErc20](../enums/_types_index_.proceduretype.md#approveerc20) Procedure @@ -16,30 +16,27 @@ Arguments for the [ApproveErc20](../enums/_types_index_.proceduretype.md#approve ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:285](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L285)* +_Defined in_ [_src/types/index.ts:285_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L285) amount of tokens to be approved -___ +### spender -### spender +• **spender**: _string_ -• **spender**: *string* - -*Defined in [src/types/index.ts:289](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L289)* +_Defined in_ [_src/types/index.ts:289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L289) the spender of the tokens being approved -___ - ### `Optional` tokenAddress -• **tokenAddress**? : *undefined | string* +• **tokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L293) -*Defined in [src/types/index.ts:293](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L293)* +address of the ERC20 token \(defaults to POLY\) -address of the ERC20 token (defaults to POLY) diff --git a/docs/api/interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md b/docs/api/interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md index e83934a..aa34afa 100644 --- a/docs/api/interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md +++ b/docs/api/interfaces/_types_index_.assignsecuritytokenroleprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: AssignSecurityTokenRoleProcedureArgs +# AssignSecurityTokenRoleProcedureArgs Arguments for the [AssignSecurityTokenRole](../enums/_types_index_.proceduretype.md#assignsecuritytokenrole) Procedure @@ -18,50 +18,43 @@ Arguments for the [AssignSecurityTokenRole](../enums/_types_index_.proceduretype ## Properties -### assign +### assign -• **assign**: *boolean* +• **assign**: _boolean_ -*Defined in [src/types/index.ts:896](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L896)* +_Defined in_ [_src/types/index.ts:896_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L896) whether to assign or revoke the role -___ +### delegateAddress -### delegateAddress +• **delegateAddress**: _string_ -• **delegateAddress**: *string* - -*Defined in [src/types/index.ts:888](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L888)* +_Defined in_ [_src/types/index.ts:888_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L888) wallet address of the delegate -___ - -### description - -• **description**: *string* +### description -*Defined in [src/types/index.ts:900](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L900)* +• **description**: _string_ -description of the delegate (i.e. "company accountant") +_Defined in_ [_src/types/index.ts:900_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L900) -___ +description of the delegate \(i.e. "company accountant"\) -### role +### role -• **role**: *[SecurityTokenRole](../enums/_types_index_.securitytokenrole.md)* +• **role**: [_SecurityTokenRole_](../enums/_types_index_.securitytokenrole.md) -*Defined in [src/types/index.ts:892](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L892)* +_Defined in_ [_src/types/index.ts:892_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L892) role to assign/revoke to/from the delegate -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:884](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L884)* +_Defined in_ [_src/types/index.ts:884_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L884) the symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.assignstoroleprocedureargs.md b/docs/api/interfaces/_types_index_.assignstoroleprocedureargs.md index e2d84f4..fcb81ff 100644 --- a/docs/api/interfaces/_types_index_.assignstoroleprocedureargs.md +++ b/docs/api/interfaces/_types_index_.assignstoroleprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: AssignStoRoleProcedureArgs +# AssignStoRoleProcedureArgs Arguments for the [AssignStoRole](../enums/_types_index_.proceduretype.md#assignstorole) Procedure @@ -19,58 +19,49 @@ Arguments for the [AssignStoRole](../enums/_types_index_.proceduretype.md#assign ## Properties -### assign +### assign -• **assign**: *boolean* +• **assign**: _boolean_ -*Defined in [src/types/index.ts:923](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L923)* +_Defined in_ [_src/types/index.ts:923_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L923) whether to assign or revoke the role -___ +### delegateAddress -### delegateAddress +• **delegateAddress**: _string_ -• **delegateAddress**: *string* - -*Defined in [src/types/index.ts:914](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L914)* +_Defined in_ [_src/types/index.ts:914_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L914) wallet address of the delegate -___ - ### `Optional` description -• **description**? : *undefined | string* - -*Defined in [src/types/index.ts:927](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L927)* +• **description**? : _undefined \| string_ -description of the delegate (i.e. "company lawyer") +_Defined in_ [_src/types/index.ts:927_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L927) -___ +description of the delegate \(i.e. "company lawyer"\) -### role +### role -• **role**: *[StoRole](../enums/_types_index_.storole.md)* +• **role**: [_StoRole_](../enums/_types_index_.storole.md) -*Defined in [src/types/index.ts:919](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L919)* +_Defined in_ [_src/types/index.ts:919_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L919) role to assign/revoke to/from the delegate -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* +_Defined in_ [_src/types/index.ts:915_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L915) -*Defined in [src/types/index.ts:915](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L915)* +### symbol -___ +• **symbol**: _string_ -### symbol - -• **symbol**: *string* - -*Defined in [src/types/index.ts:910](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L910)* +_Defined in_ [_src/types/index.ts:910_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L910) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.controllerredeemprocedureargs.md b/docs/api/interfaces/_types_index_.controllerredeemprocedureargs.md index eb6a18e..18ab2c8 100644 --- a/docs/api/interfaces/_types_index_.controllerredeemprocedureargs.md +++ b/docs/api/interfaces/_types_index_.controllerredeemprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ControllerRedeemProcedureArgs +# ControllerRedeemProcedureArgs Arguments for the [ControllerRedeem](../enums/_types_index_.proceduretype.md#controllerredeem) Procedure @@ -18,50 +18,43 @@ Arguments for the [ControllerRedeem](../enums/_types_index_.proceduretype.md#con ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:975](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L975)* +_Defined in_ [_src/types/index.ts:975_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L975) -amount of tokens being redeemed (burned) - -___ +amount of tokens being redeemed \(burned\) ### `Optional` data -• **data**? : *undefined | string* +• **data**? : _undefined \| string_ -*Defined in [src/types/index.ts:979](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L979)* +_Defined in_ [_src/types/index.ts:979_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L979) extra KYC transfer data -___ - -### from - -• **from**: *string* +### from -*Defined in [src/types/index.ts:967](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L967)* +• **from**: _string_ -wallet address from which tokens will be redeemed (burned) +_Defined in_ [_src/types/index.ts:967_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L967) -___ +wallet address from which tokens will be redeemed \(burned\) ### `Optional` reason -• **reason**? : *undefined | string* +• **reason**? : _undefined \| string_ -*Defined in [src/types/index.ts:983](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L983)* +_Defined in_ [_src/types/index.ts:983_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L983) reason why tokens are being redeemed -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:971](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L971)* +_Defined in_ [_src/types/index.ts:971_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L971) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.controllertransferprocedureargs.md b/docs/api/interfaces/_types_index_.controllertransferprocedureargs.md index 3a2b6b6..2d11978 100644 --- a/docs/api/interfaces/_types_index_.controllertransferprocedureargs.md +++ b/docs/api/interfaces/_types_index_.controllertransferprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ControllerTransferProcedureArgs +# ControllerTransferProcedureArgs Arguments for the [ControllerTransfer](../enums/_types_index_.proceduretype.md#controllertransfer) Procedure @@ -19,60 +19,51 @@ Arguments for the [ControllerTransfer](../enums/_types_index_.proceduretype.md#c ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:949](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L949)* +_Defined in_ [_src/types/index.ts:949_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L949) amount of tokens being forcefully transferred -___ - ### `Optional` data -• **data**? : *undefined | string* +• **data**? : _undefined \| string_ -*Defined in [src/types/index.ts:953](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L953)* +_Defined in_ [_src/types/index.ts:953_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L953) extra KYC transfer data -___ - -### from +### from -• **from**: *string* +• **from**: _string_ -*Defined in [src/types/index.ts:937](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L937)* +_Defined in_ [_src/types/index.ts:937_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L937) sender's wallet address -___ - ### `Optional` log -• **log**? : *undefined | string* +• **log**? : _undefined \| string_ -*Defined in [src/types/index.ts:957](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L957)* +_Defined in_ [_src/types/index.ts:957_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L957) extra log information -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:945](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L945)* +_Defined in_ [_src/types/index.ts:945_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L945) symbol of the Security Token -___ - -### to +### to -• **to**: *string* +• **to**: _string_ -*Defined in [src/types/index.ts:941](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L941)* +_Defined in_ [_src/types/index.ts:941_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L941) receiver's wallet address + diff --git a/docs/api/interfaces/_types_index_.createcheckpointprocedureargs.md b/docs/api/interfaces/_types_index_.createcheckpointprocedureargs.md index 83ca2a7..e97565f 100644 --- a/docs/api/interfaces/_types_index_.createcheckpointprocedureargs.md +++ b/docs/api/interfaces/_types_index_.createcheckpointprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: CreateCheckpointProcedureArgs +# CreateCheckpointProcedureArgs Arguments for the [CreateCheckpoint](../enums/_types_index_.proceduretype.md#createcheckpoint) Procedure @@ -14,10 +14,11 @@ Arguments for the [CreateCheckpoint](../enums/_types_index_.proceduretype.md#cre ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:321](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L321)* +_Defined in_ [_src/types/index.ts:321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L321) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.createdividenddistributionprocedureargs.md b/docs/api/interfaces/_types_index_.createdividenddistributionprocedureargs.md index 0b3fa98..1af5e75 100644 --- a/docs/api/interfaces/_types_index_.createdividenddistributionprocedureargs.md +++ b/docs/api/interfaces/_types_index_.createdividenddistributionprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: CreateDividendDistributionProcedureArgs +# CreateDividendDistributionProcedureArgs Arguments for the [CreateDividendDistribution](../enums/_types_index_.proceduretype.md#createdividenddistribution) Procedure @@ -22,90 +22,75 @@ Arguments for the [CreateDividendDistribution](../enums/_types_index_.proceduret ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:347](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L347)* +_Defined in_ [_src/types/index.ts:347_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L347) amount to be distributed as dividends -___ +### checkpointIndex -### checkpointIndex +• **checkpointIndex**: _number_ -• **checkpointIndex**: *number* - -*Defined in [src/types/index.ts:351](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L351)* +_Defined in_ [_src/types/index.ts:351_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L351) index of the Checkpoint in which the Dividend Distribution will be based -___ - -### erc20Address +### erc20Address -• **erc20Address**: *string* +• **erc20Address**: _string_ -*Defined in [src/types/index.ts:343](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L343)* +_Defined in_ [_src/types/index.ts:343_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L343) address of the ERC20 token -___ - ### `Optional` excludedAddresses -• **excludedAddresses**? : *string[]* +• **excludedAddresses**? : _string\[\]_ -*Defined in [src/types/index.ts:359](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L359)* +_Defined in_ [_src/types/index.ts:359_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L359) list of addresses that will be excluded from receiving payment -___ +### expiryDate -### expiryDate +• **expiryDate**: _Date_ -• **expiryDate**: *Date* - -*Defined in [src/types/index.ts:339](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L339)* +_Defined in_ [_src/types/index.ts:339_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L339) date on which the Dividend will expire -___ - -### maturityDate +### maturityDate -• **maturityDate**: *Date* +• **maturityDate**: _Date_ -*Defined in [src/types/index.ts:335](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L335)* +_Defined in_ [_src/types/index.ts:335_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L335) date from which Dividend payments can be pushed/claimed -___ +### name -### name +• **name**: _string_ -• **name**: *string* - -*Defined in [src/types/index.ts:355](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L355)* +_Defined in_ [_src/types/index.ts:355_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L355) name of the distribution -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:331](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L331)* +_Defined in_ [_src/types/index.ts:331_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L331) symbol of the Security Token -___ - ### `Optional` taxWithholdings -• **taxWithholdings**? : *[TaxWithholdingEntry](_types_index_.taxwithholdingentry.md)[]* +• **taxWithholdings**? : [_TaxWithholdingEntry_](_types_index_.taxwithholdingentry.md)_\[\]_ -*Defined in [src/types/index.ts:363](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L363)* +_Defined in_ [_src/types/index.ts:363_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L363) tax withholding list for the Dividend Distribution + diff --git a/docs/api/interfaces/_types_index_.createsecuritytokenprocedureargs.md b/docs/api/interfaces/_types_index_.createsecuritytokenprocedureargs.md index 0e8f68e..7bc497d 100644 --- a/docs/api/interfaces/_types_index_.createsecuritytokenprocedureargs.md +++ b/docs/api/interfaces/_types_index_.createsecuritytokenprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: CreateSecurityTokenProcedureArgs +# CreateSecurityTokenProcedureArgs Arguments for the [CreateSecurityToken](../enums/_types_index_.proceduretype.md#createsecuritytoken) Procedure @@ -20,48 +20,41 @@ Arguments for the [CreateSecurityToken](../enums/_types_index_.proceduretype.md# ### `Optional` detailsUrl -• **detailsUrl**? : *undefined | string* +• **detailsUrl**? : _undefined \| string_ -*Defined in [src/types/index.ts:407](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L407)* +_Defined in_ [_src/types/index.ts:407_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L407) url where Security Token details can be found -___ +### divisible -### divisible +• **divisible**: _boolean_ -• **divisible**: *boolean* - -*Defined in [src/types/index.ts:411](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L411)* +_Defined in_ [_src/types/index.ts:411_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L411) whether or not the Security Token is divisible -___ - -### name +### name -• **name**: *string* +• **name**: _string_ -*Defined in [src/types/index.ts:399](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L399)* +_Defined in_ [_src/types/index.ts:399_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L399) name of the Security Token -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:403](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L403)* +_Defined in_ [_src/types/index.ts:403_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L403) symbol of the Security Token -___ - ### `Optional` treasuryWallet -• **treasuryWallet**? : *undefined | string* +• **treasuryWallet**? : _undefined \| string_ -*Defined in [src/types/index.ts:415](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L415)* +_Defined in_ [_src/types/index.ts:415_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L415) the Treasury Wallet address + diff --git a/docs/api/interfaces/_types_index_.customcurrency.md b/docs/api/interfaces/_types_index_.customcurrency.md index 15624e6..8168da0 100644 --- a/docs/api/interfaces/_types_index_.customcurrency.md +++ b/docs/api/interfaces/_types_index_.customcurrency.md @@ -1,4 +1,4 @@ -# Interface: CustomCurrency +# CustomCurrency Custom currency in which a Tiered STO can raise funds @@ -16,30 +16,27 @@ Custom currency in which a Tiered STO can raise funds ## Properties -### currencySymbol +### currencySymbol -• **currencySymbol**: *string* +• **currencySymbol**: _string_ -*Defined in [src/types/index.ts:727](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L727)* +_Defined in_ [_src/types/index.ts:727_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L727) -symbol of the custom currency (USD, CAD, EUR, etc. Default is USD) +symbol of the custom currency \(USD, CAD, EUR, etc. Default is USD\) -___ +### ethOracleAddress -### ethOracleAddress +• **ethOracleAddress**: _string_ -• **ethOracleAddress**: *string* - -*Defined in [src/types/index.ts:731](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L731)* +_Defined in_ [_src/types/index.ts:731_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L731) address of the oracle that states the price of ETH in the custom currency. Only required if raising funds in ETH -___ - -### polyOracleAddress +### polyOracleAddress -• **polyOracleAddress**: *string* +• **polyOracleAddress**: _string_ -*Defined in [src/types/index.ts:735](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L735)* +_Defined in_ [_src/types/index.ts:735_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L735) address of the oracle that states the price of POLY in the custom currency. Only required if raising funds in POLY + diff --git a/docs/api/interfaces/_types_index_.disablecontrollerprocedureargs.md b/docs/api/interfaces/_types_index_.disablecontrollerprocedureargs.md index 40c9cac..c1c30b3 100644 --- a/docs/api/interfaces/_types_index_.disablecontrollerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.disablecontrollerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: DisableControllerProcedureArgs +# DisableControllerProcedureArgs Arguments for the [DisableController](../enums/_types_index_.proceduretype.md#disablecontroller) Procedure @@ -17,18 +17,17 @@ Arguments for the [DisableController](../enums/_types_index_.proceduretype.md#di ### `Optional` signature -• **signature**? : *undefined | string* +• **signature**? : _undefined \| string_ -*Defined in [src/types/index.ts:1092](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1092)* +_Defined in_ [_src/types/index.ts:1092_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1092) acknowledgement signature -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1088](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1088)* +_Defined in_ [_src/types/index.ts:1088_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1088) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.disablefeatureprocedureargs.md b/docs/api/interfaces/_types_index_.disablefeatureprocedureargs.md index ed4e36f..921638c 100644 --- a/docs/api/interfaces/_types_index_.disablefeatureprocedureargs.md +++ b/docs/api/interfaces/_types_index_.disablefeatureprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: DisableFeatureProcedureArgs +# DisableFeatureProcedureArgs Arguments for the [DisableFeature](../enums/_types_index_.proceduretype.md#disablefeature) Procedure @@ -15,20 +15,19 @@ Arguments for the [DisableFeature](../enums/_types_index_.proceduretype.md#disab ## Properties -### moduleName +### moduleName -• **moduleName**: *ModuleName* +• **moduleName**: _ModuleName_ -*Defined in [src/types/index.ts:496](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L496)* +_Defined in_ [_src/types/index.ts:496_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L496) name of the Module that will be disabled -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:492](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L492)* +_Defined in_ [_src/types/index.ts:492_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L492) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.dividendtokenholderstatus.md b/docs/api/interfaces/_types_index_.dividendtokenholderstatus.md index 38a45df..06042d0 100644 --- a/docs/api/interfaces/_types_index_.dividendtokenholderstatus.md +++ b/docs/api/interfaces/_types_index_.dividendtokenholderstatus.md @@ -1,4 +1,4 @@ -# Interface: DividendTokenholderStatus +# DividendTokenholderStatus Status of a Tokenholder in regards to a Dividend Distribution @@ -19,60 +19,51 @@ Status of a Tokenholder in regards to a Dividend Distribution ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:27](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L27)* +_Defined in_ [_src/types/index.ts:27_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L27) wallet address of the Tokenholder -___ +### amountReceived -### amountReceived +• **amountReceived**: _BigNumber_ -• **amountReceived**: *BigNumber* - -*Defined in [src/types/index.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L43)* +_Defined in_ [_src/types/index.ts:43_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L43) the amount of tokens the Tokenholder has received as Dividend payment -___ - -### balance +### balance -• **balance**: *BigNumber* +• **balance**: _BigNumber_ -*Defined in [src/types/index.ts:47](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L47)* +_Defined in_ [_src/types/index.ts:47_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L47) the balance of the Tokenholder -___ - -### excluded +### excluded -• **excluded**: *boolean* +• **excluded**: _boolean_ -*Defined in [src/types/index.ts:35](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L35)* +_Defined in_ [_src/types/index.ts:35_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L35) whether the Tokenholder is excluded from the Dividend distribution -___ +### paymentReceived -### paymentReceived +• **paymentReceived**: _boolean_ -• **paymentReceived**: *boolean* - -*Defined in [src/types/index.ts:31](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L31)* +_Defined in_ [_src/types/index.ts:31_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L31) whether the Tokenholder has received payment -___ - -### withheldTax +### withheldTax -• **withheldTax**: *BigNumber* +• **withheldTax**: _BigNumber_ -*Defined in [src/types/index.ts:39](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L39)* +_Defined in_ [_src/types/index.ts:39_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L39) amount of tokens withheld for tax purposes + diff --git a/docs/api/interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md b/docs/api/interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md index 336f700..3a821b0 100644 --- a/docs/api/interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.enablecounttransfermanagerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: EnableCountTransferManagerProcedureArgs +# EnableCountTransferManagerProcedureArgs Arguments for the [EnableCountTransferManager](../enums/_types_index_.proceduretype.md#enablecounttransfermanager) Procedure @@ -15,20 +15,19 @@ Arguments for the [EnableCountTransferManager](../enums/_types_index_.proceduret ## Properties -### maxHolderCount +### maxHolderCount -• **maxHolderCount**: *number* +• **maxHolderCount**: _number_ -*Defined in [src/types/index.ts:463](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L463)* +_Defined in_ [_src/types/index.ts:463_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L463) maximum number of simultaneous token holders -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:459](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L459)* +_Defined in_ [_src/types/index.ts:459_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L459) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.enabledividendmanagerprocedureargs.md b/docs/api/interfaces/_types_index_.enabledividendmanagerprocedureargs.md index b69bfe0..3389a66 100644 --- a/docs/api/interfaces/_types_index_.enabledividendmanagerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.enabledividendmanagerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: EnableDividendManagerProcedureArgs +# EnableDividendManagerProcedureArgs Arguments for the [EnableDividendManager](../enums/_types_index_.proceduretype.md#enabledividendmanager) Procedure @@ -15,20 +15,19 @@ Arguments for the [EnableDividendManager](../enums/_types_index_.proceduretype.m ## Properties -### storageWalletAddress +### storageWalletAddress -• **storageWalletAddress**: *string* +• **storageWalletAddress**: _string_ -*Defined in [src/types/index.ts:429](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L429)* +_Defined in_ [_src/types/index.ts:429_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L429) storage wallet where Dividends funds will be stored -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:425](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L425)* +_Defined in_ [_src/types/index.ts:425_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L425) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md b/docs/api/interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md index 857f497..7567e75 100644 --- a/docs/api/interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.enablegeneralpermissionmanagerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: EnableGeneralPermissionManagerProcedureArgs +# EnableGeneralPermissionManagerProcedureArgs Arguments for the [EnableGeneralPermissionManager](../enums/_types_index_.proceduretype.md#enablegeneralpermissionmanager) Procedure @@ -14,10 +14,11 @@ Arguments for the [EnableGeneralPermissionManager](../enums/_types_index_.proced ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:439](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L439)* +_Defined in_ [_src/types/index.ts:439_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L439) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md b/docs/api/interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md index 1776088..7edbc26 100644 --- a/docs/api/interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.enablegeneraltransfermanagerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: EnableGeneralTransferManagerProcedureArgs +# EnableGeneralTransferManagerProcedureArgs Arguments for the [EnableGeneralTransferManager](../enums/_types_index_.proceduretype.md#enablegeneraltransfermanager) Procedure @@ -14,10 +14,11 @@ Arguments for the [EnableGeneralTransferManager](../enums/_types_index_.procedur ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:449](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L449)* +_Defined in_ [_src/types/index.ts:449_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L449) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md b/docs/api/interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md index 9883228..bc7a40b 100644 --- a/docs/api/interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.enablepercentagetransfermanagerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: EnablePercentageTransferManagerProcedureArgs +# EnablePercentageTransferManagerProcedureArgs Arguments for the [EnablePercentageTransferManager](../enums/_types_index_.proceduretype.md#enablepercentagetransfermanager) Procedure @@ -18,29 +18,25 @@ Arguments for the [EnablePercentageTransferManager](../enums/_types_index_.proce ### `Optional` allowPrimaryIssuance -• **allowPrimaryIssuance**? : *undefined | false | true* +• **allowPrimaryIssuance**? : _undefined \| false \| true_ -*Defined in [src/types/index.ts:482](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L482)* +_Defined in_ [_src/types/index.ts:482_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L482) -whether primary issuance is exempted from percentage restrictions. -If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions +whether primary issuance is exempted from percentage restrictions. If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions -___ +### maxHolderPercentage -### maxHolderPercentage +• **maxHolderPercentage**: _BigNumber_ -• **maxHolderPercentage**: *BigNumber* - -*Defined in [src/types/index.ts:477](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L477)* +_Defined in_ [_src/types/index.ts:477_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L477) maximum percentage of the total supply a single token holder can hold -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:473](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L473)* +_Defined in_ [_src/types/index.ts:473_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L473) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.fees.md b/docs/api/interfaces/_types_index_.fees.md index b2f6e65..9168a65 100644 --- a/docs/api/interfaces/_types_index_.fees.md +++ b/docs/api/interfaces/_types_index_.fees.md @@ -1,4 +1,4 @@ -# Interface: Fees +# Fees Fees associated with running a [TransactionQueue](../classes/_entities_transactionqueue_.transactionqueue.md) @@ -15,20 +15,19 @@ Fees associated with running a [TransactionQueue](../classes/_entities_transacti ## Properties -### poly +### poly -• **poly**: *BigNumber* +• **poly**: _BigNumber_ -*Defined in [src/types/index.ts:1409](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1409)* +_Defined in_ [_src/types/index.ts:1409_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1409) fees expressed in POLY -___ +### usd -### usd +• **usd**: _BigNumber \| null_ -• **usd**: *BigNumber | null* - -*Defined in [src/types/index.ts:1405](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1405)* +_Defined in_ [_src/types/index.ts:1405_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1405) fees expressed in USD. Can be null if the Smart Contract doesn't specify one + diff --git a/docs/api/interfaces/_types_index_.finalizestoprocedureargs.md b/docs/api/interfaces/_types_index_.finalizestoprocedureargs.md index 63fd777..c977a4c 100644 --- a/docs/api/interfaces/_types_index_.finalizestoprocedureargs.md +++ b/docs/api/interfaces/_types_index_.finalizestoprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: FinalizeStoProcedureArgs +# FinalizeStoProcedureArgs Arguments for the [FinalizeSto](../enums/_types_index_.proceduretype.md#finalizesto) Procedure @@ -16,28 +16,25 @@ Arguments for the [FinalizeSto](../enums/_types_index_.proceduretype.md#finalize ## Properties -### stoAddress +### stoAddress -• **stoAddress**: *string* +• **stoAddress**: _string_ -*Defined in [src/types/index.ts:1013](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1013)* +_Defined in_ [_src/types/index.ts:1013_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1013) -___ +### stoType -### stoType +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +_Defined in_ [_src/types/index.ts:1017_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1017) -*Defined in [src/types/index.ts:1017](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1017)* +type of the STO \(Simple, Tiered, etc\) -type of the STO (Simple, Tiered, etc) +### symbol -___ +• **symbol**: _string_ -### symbol - -• **symbol**: *string* - -*Defined in [src/types/index.ts:1012](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1012)* +_Defined in_ [_src/types/index.ts:1012_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1012) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.freezeissuanceprocedureargs.md b/docs/api/interfaces/_types_index_.freezeissuanceprocedureargs.md index 493a8b1..b375060 100644 --- a/docs/api/interfaces/_types_index_.freezeissuanceprocedureargs.md +++ b/docs/api/interfaces/_types_index_.freezeissuanceprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: FreezeIssuanceProcedureArgs +# FreezeIssuanceProcedureArgs Arguments for the [FreezeIssuance](../enums/_types_index_.proceduretype.md#freezeissuance) Procedure @@ -17,18 +17,17 @@ Arguments for the [FreezeIssuance](../enums/_types_index_.proceduretype.md#freez ### `Optional` signature -• **signature**? : *undefined | string* +• **signature**? : _undefined \| string_ -*Defined in [src/types/index.ts:1078](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1078)* +_Defined in_ [_src/types/index.ts:1078_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1078) acknowledgement signature -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1074](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1074)* +_Defined in_ [_src/types/index.ts:1074_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1074) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.futurelowlevelmethod.md b/docs/api/interfaces/_types_index_.futurelowlevelmethod.md index 85a9d36..e794085 100644 --- a/docs/api/interfaces/_types_index_.futurelowlevelmethod.md +++ b/docs/api/interfaces/_types_index_.futurelowlevelmethod.md @@ -1,7 +1,6 @@ -# Interface: FutureLowLevelMethod <**T, U**> +# FutureLowLevelMethod -Represents a contract method that doesn't exist yet but will exist -once a certain post transaction resolver is resolved +Represents a contract method that doesn't exist yet but will exist once a certain post transaction resolver is resolved ## Type parameters @@ -26,30 +25,29 @@ type of the arguments object that the future method will accept ## Properties -### futureMethod +### futureMethod -• **futureMethod**: *function* +• **futureMethod**: _function_ -*Defined in [src/types/index.ts:1519](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1519)* +_Defined in_ [_src/types/index.ts:1519_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1519) function that returns a low level method #### Type declaration: -▸ (`resolvedValue`: T): *Promise‹[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹U››* +▸ \(`resolvedValue`: T\): _Promise‹_[_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹U››_ **Parameters:** -Name | Type | ------- | ------ | -`resolvedValue` | T | +| Name | Type | +| :--- | :--- | +| `resolvedValue` | T | -___ +### futureValue -### futureValue +• **futureValue**: _PostTransactionResolver‹T›_ -• **futureValue**: *PostTransactionResolver‹T›* - -*Defined in [src/types/index.ts:1523](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1523)* +_Defined in_ [_src/types/index.ts:1523_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1523) post transaction resolver that resolves into the value that is passed to the future method + diff --git a/docs/api/interfaces/_types_index_.investinsimplestoprocedureargs.md b/docs/api/interfaces/_types_index_.investinsimplestoprocedureargs.md index 1c19d74..493bf21 100644 --- a/docs/api/interfaces/_types_index_.investinsimplestoprocedureargs.md +++ b/docs/api/interfaces/_types_index_.investinsimplestoprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: InvestInSimpleStoProcedureArgs +# InvestInSimpleStoProcedureArgs Arguments for the [InvestInSimpleSto](../enums/_types_index_.proceduretype.md#investinsimplesto) Procedure @@ -17,40 +17,35 @@ Arguments for the [InvestInSimpleSto](../enums/_types_index_.proceduretype.md#in ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:680](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L680)* +_Defined in_ [_src/types/index.ts:680_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L680) amount to invest -___ - ### `Optional` beneficiary -• **beneficiary**? : *undefined | string* +• **beneficiary**? : _undefined \| string_ -*Defined in [src/types/index.ts:684](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L684)* +_Defined in_ [_src/types/index.ts:684_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L684) if specified, the investment will be made on behalf of this address -___ - -### stoAddress +### stoAddress -• **stoAddress**: *string* +• **stoAddress**: _string_ -*Defined in [src/types/index.ts:676](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L676)* +_Defined in_ [_src/types/index.ts:676_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L676) address of the STO -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:672](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L672)* +_Defined in_ [_src/types/index.ts:672_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L672) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.investintieredstobaseprocedureargs.md b/docs/api/interfaces/_types_index_.investintieredstobaseprocedureargs.md index 001653d..5a98521 100644 --- a/docs/api/interfaces/_types_index_.investintieredstobaseprocedureargs.md +++ b/docs/api/interfaces/_types_index_.investintieredstobaseprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: InvestInTieredStoBaseProcedureArgs +# InvestInTieredStoBaseProcedureArgs ## Hierarchy @@ -19,61 +19,51 @@ ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:628](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628)* +_Defined in_ [_src/types/index.ts:628_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628) amount to invest -___ - ### `Optional` beneficiary -• **beneficiary**? : *undefined | string* +• **beneficiary**? : _undefined \| string_ -*Defined in [src/types/index.ts:641](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641)* +_Defined in_ [_src/types/index.ts:641_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641) if specified, the investment will be made on behalf of this address -___ - -### currency +### currency -• **currency**: *Currency* +• **currency**: _Currency_ -*Defined in [src/types/index.ts:632](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L632)* +_Defined in_ [_src/types/index.ts:632_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L632) currency type in which the investment is being made -___ - ### `Optional` minTokens -• **minTokens**? : *BigNumber* +• **minTokens**? : _BigNumber_ -*Defined in [src/types/index.ts:637](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637)* +_Defined in_ [_src/types/index.ts:637_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637) -minimum amount of Security Tokens that should be bought. -If, because of price fluctuations, a lower amount is being bought, the transaction will revert +minimum amount of Security Tokens that should be bought. If, because of price fluctuations, a lower amount is being bought, the transaction will revert -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* - -*Defined in [src/types/index.ts:624](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624)* +_Defined in_ [_src/types/index.ts:624_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624) address of the STO -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:620](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620)* +_Defined in_ [_src/types/index.ts:620_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.investwithstablecoinargs.md b/docs/api/interfaces/_types_index_.investwithstablecoinargs.md index 2931aeb..952faa2 100644 --- a/docs/api/interfaces/_types_index_.investwithstablecoinargs.md +++ b/docs/api/interfaces/_types_index_.investwithstablecoinargs.md @@ -1,4 +1,4 @@ -# Interface: InvestWithStableCoinArgs +# InvestWithStableCoinArgs ## Hierarchy @@ -20,79 +20,67 @@ ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Inherited from [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[amount](_types_index_.investintieredstobaseprocedureargs.md#amount)* +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_amount_](_types_index_.investintieredstobaseprocedureargs.md#amount) -*Defined in [src/types/index.ts:628](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628)* +_Defined in_ [_src/types/index.ts:628_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L628) amount to invest -___ - ### `Optional` beneficiary -• **beneficiary**? : *undefined | string* +• **beneficiary**? : _undefined \| string_ -*Inherited from [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[beneficiary](_types_index_.investintieredstobaseprocedureargs.md#optional-beneficiary)* +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_beneficiary_](_types_index_.investintieredstobaseprocedureargs.md#optional-beneficiary) -*Defined in [src/types/index.ts:641](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641)* +_Defined in_ [_src/types/index.ts:641_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L641) if specified, the investment will be made on behalf of this address -___ - -### currency +### currency -• **currency**: *Currency.StableCoin* +• **currency**: _Currency.StableCoin_ -*Overrides [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[currency](_types_index_.investintieredstobaseprocedureargs.md#currency)* +_Overrides_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_currency_](_types_index_.investintieredstobaseprocedureargs.md#currency) -*Defined in [src/types/index.ts:645](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L645)* - -___ +_Defined in_ [_src/types/index.ts:645_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L645) ### `Optional` minTokens -• **minTokens**? : *BigNumber* - -*Inherited from [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[minTokens](_types_index_.investintieredstobaseprocedureargs.md#optional-mintokens)* +• **minTokens**? : _BigNumber_ -*Defined in [src/types/index.ts:637](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637)* +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_minTokens_](_types_index_.investintieredstobaseprocedureargs.md#optional-mintokens) -minimum amount of Security Tokens that should be bought. -If, because of price fluctuations, a lower amount is being bought, the transaction will revert +_Defined in_ [_src/types/index.ts:637_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L637) -___ +minimum amount of Security Tokens that should be bought. If, because of price fluctuations, a lower amount is being bought, the transaction will revert -### stableCoinAddress +### stableCoinAddress -• **stableCoinAddress**: *string* +• **stableCoinAddress**: _string_ -*Defined in [src/types/index.ts:646](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L646)* +_Defined in_ [_src/types/index.ts:646_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L646) -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_stoAddress_](_types_index_.investintieredstobaseprocedureargs.md#stoaddress) -*Inherited from [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[stoAddress](_types_index_.investintieredstobaseprocedureargs.md#stoaddress)* - -*Defined in [src/types/index.ts:624](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624)* +_Defined in_ [_src/types/index.ts:624_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L624) address of the STO -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Inherited from [InvestInTieredStoBaseProcedureArgs](_types_index_.investintieredstobaseprocedureargs.md).[symbol](_types_index_.investintieredstobaseprocedureargs.md#symbol)* +_Inherited from_ [_InvestInTieredStoBaseProcedureArgs_](_types_index_.investintieredstobaseprocedureargs.md)_._[_symbol_](_types_index_.investintieredstobaseprocedureargs.md#symbol) -*Defined in [src/types/index.ts:620](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620)* +_Defined in_ [_src/types/index.ts:620_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L620) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.issuancedataentry.md b/docs/api/interfaces/_types_index_.issuancedataentry.md index 80544f1..4f141a2 100644 --- a/docs/api/interfaces/_types_index_.issuancedataentry.md +++ b/docs/api/interfaces/_types_index_.issuancedataentry.md @@ -1,4 +1,4 @@ -# Interface: IssuanceDataEntry +# IssuanceDataEntry Specifies how many tokens to issue and who to issue them to @@ -16,30 +16,27 @@ Specifies how many tokens to issue and who to issue them to ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L83)* +_Defined in_ [_src/types/index.ts:83_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L83) wallet address where Tokens will be received -___ +### amount -### amount +• **amount**: _BigNumber_ -• **amount**: *BigNumber* - -*Defined in [src/types/index.ts:87](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L87)* +_Defined in_ [_src/types/index.ts:87_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L87) amount of tokens to be issued -___ - ### `Optional` tokenholderData -• **tokenholderData**? : *[Omit](../modules/_types_index_.md#omit)‹[TokenholderDataEntry](_types_index_.tokenholderdataentry.md), "address"›* +• **tokenholderData**? : [_Omit_](../external-modules/_types_index_.md#omit)_‹_[_TokenholderDataEntry_](_types_index_.tokenholderdataentry.md)_, "address"›_ -*Defined in [src/types/index.ts:91](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L91)* +_Defined in_ [_src/types/index.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L91) KYC data for the Tokenholder + diff --git a/docs/api/interfaces/_types_index_.issuetokensprocedureargs.md b/docs/api/interfaces/_types_index_.issuetokensprocedureargs.md index 3b8e668..adc695f 100644 --- a/docs/api/interfaces/_types_index_.issuetokensprocedureargs.md +++ b/docs/api/interfaces/_types_index_.issuetokensprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: IssueTokensProcedureArgs +# IssueTokensProcedureArgs Arguments for the [IssueTokens](../enums/_types_index_.proceduretype.md#issuetokens) Procedure @@ -15,20 +15,19 @@ Arguments for the [IssueTokens](../enums/_types_index_.proceduretype.md#issuetok ## Properties -### issuanceData +### issuanceData -• **issuanceData**: *[IssuanceDataEntry](_types_index_.issuancedataentry.md)[]* +• **issuanceData**: [_IssuanceDataEntry_](_types_index_.issuancedataentry.md)_\[\]_ -*Defined in [src/types/index.ts:553](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L553)* +_Defined in_ [_src/types/index.ts:553_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L553) array of entries that specify who to issue tokens to and the amounts -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:549](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L549)* +_Defined in_ [_src/types/index.ts:549_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L549) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.launchsimplestoprocedureargs.md b/docs/api/interfaces/_types_index_.launchsimplestoprocedureargs.md index ec16938..2db07eb 100644 --- a/docs/api/interfaces/_types_index_.launchsimplestoprocedureargs.md +++ b/docs/api/interfaces/_types_index_.launchsimplestoprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: LaunchSimpleStoProcedureArgs +# LaunchSimpleStoProcedureArgs Arguments for the [LaunchSimpleSto](../enums/_types_index_.proceduretype.md#launchsimplesto) Procedure @@ -24,89 +24,73 @@ Arguments for the [LaunchSimpleSto](../enums/_types_index_.proceduretype.md#laun ### `Optional` allowPreIssuing -• **allowPreIssuing**? : *undefined | false | true* +• **allowPreIssuing**? : _undefined \| false \| true_ -*Defined in [src/types/index.ts:539](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L539)* +_Defined in_ [_src/types/index.ts:539_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L539) -whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. -Otherwise, they will be issued on each purchase. Defaults to false +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false -___ +### currency -### currency +• **currency**: _Currency.ETH \| Currency.POLY_ -• **currency**: *Currency.ETH | Currency.POLY* - -*Defined in [src/types/index.ts:526](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L526)* +_Defined in_ [_src/types/index.ts:526_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L526) currency for the Simple STO fund raise -___ - -### endDate +### endDate -• **endDate**: *Date* +• **endDate**: _Date_ -*Defined in [src/types/index.ts:514](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L514)* +_Defined in_ [_src/types/index.ts:514_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L514) end date of the STO -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Defined in [src/types/index.ts:530](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L530)* +_Defined in_ [_src/types/index.ts:530_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L530) wallet to which raised funds will be sent -___ +### rate -### rate +• **rate**: _BigNumber_ -• **rate**: *BigNumber* - -*Defined in [src/types/index.ts:522](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L522)* +_Defined in_ [_src/types/index.ts:522_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L522) amount of tokens sold per unit of currency -___ - -### startDate +### startDate -• **startDate**: *Date* +• **startDate**: _Date_ -*Defined in [src/types/index.ts:510](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L510)* +_Defined in_ [_src/types/index.ts:510_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L510) start date of the STO -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:506](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L506)* +_Defined in_ [_src/types/index.ts:506_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L506) symbol of the Security Token -___ - -### tokensOnSale +### tokensOnSale -• **tokensOnSale**: *BigNumber* +• **tokensOnSale**: _BigNumber_ -*Defined in [src/types/index.ts:518](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L518)* +_Defined in_ [_src/types/index.ts:518_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L518) number of tokens that will be sold -___ +### unsoldTokensWallet -### unsoldTokensWallet +• **unsoldTokensWallet**: _string_ -• **unsoldTokensWallet**: *string* - -*Defined in [src/types/index.ts:534](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L534)* +_Defined in_ [_src/types/index.ts:534_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L534) wallet to which unsold tokens will be sent if the STO expires + diff --git a/docs/api/interfaces/_types_index_.launchtieredstoprocedureargs.md b/docs/api/interfaces/_types_index_.launchtieredstoprocedureargs.md index 41b7795..329e3df 100644 --- a/docs/api/interfaces/_types_index_.launchtieredstoprocedureargs.md +++ b/docs/api/interfaces/_types_index_.launchtieredstoprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: LaunchTieredStoProcedureArgs +# LaunchTieredStoProcedureArgs Arguments for the [LaunchTieredSto](../enums/_types_index_.proceduretype.md#launchtieredsto) Procedure @@ -27,120 +27,97 @@ Arguments for the [LaunchTieredSto](../enums/_types_index_.proceduretype.md#laun ### `Optional` allowPreIssuing -• **allowPreIssuing**? : *undefined | false | true* +• **allowPreIssuing**? : _undefined \| false \| true_ -*Defined in [src/types/index.ts:791](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L791)* +_Defined in_ [_src/types/index.ts:791_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L791) -whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. -Otherwise, they will be issued on each purchase. Defaults to false +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false -___ +### currencies -### currencies +• **currencies**: _Currency\[\]_ -• **currencies**: *Currency[]* - -*Defined in [src/types/index.ts:769](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L769)* +_Defined in_ [_src/types/index.ts:769_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L769) currencies with which Security Tokens can be purchased in the STO -___ - ### `Optional` customCurrency -• **customCurrency**? : *Partial‹[CustomCurrency](_types_index_.customcurrency.md)›* - -*Defined in [src/types/index.ts:786](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L786)* +• **customCurrency**? : _Partial‹_[_CustomCurrency_](_types_index_.customcurrency.md)_›_ -if raising in Stable Coin, -this parameter can be used to specify a currency different than USD for the STO to be pegged in +_Defined in_ [_src/types/index.ts:786_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L786) -___ +if raising in Stable Coin, this parameter can be used to specify a currency different than USD for the STO to be pegged in -### endDate +### endDate -• **endDate**: *Date* +• **endDate**: _Date_ -*Defined in [src/types/index.ts:753](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L753)* +_Defined in_ [_src/types/index.ts:753_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L753) end date of the STO -___ +### minimumInvestment -### minimumInvestment +• **minimumInvestment**: _BigNumber_ -• **minimumInvestment**: *BigNumber* - -*Defined in [src/types/index.ts:765](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L765)* +_Defined in_ [_src/types/index.ts:765_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L765) minimum amount that can be invested by any investor -___ - -### nonAccreditedInvestmentLimit +### nonAccreditedInvestmentLimit -• **nonAccreditedInvestmentLimit**: *BigNumber* +• **nonAccreditedInvestmentLimit**: _BigNumber_ -*Defined in [src/types/index.ts:761](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L761)* +_Defined in_ [_src/types/index.ts:761_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L761) maximum amount that can be invested by non accredited investors -___ - -### raisedFundsWallet +### raisedFundsWallet -• **raisedFundsWallet**: *string* +• **raisedFundsWallet**: _string_ -*Defined in [src/types/index.ts:773](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L773)* +_Defined in_ [_src/types/index.ts:773_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L773) wallet where raised funds will be sent -___ - ### `Optional` stableCoinAddresses -• **stableCoinAddresses**? : *string[]* +• **stableCoinAddresses**? : _string\[\]_ -*Defined in [src/types/index.ts:781](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L781)* +_Defined in_ [_src/types/index.ts:781_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L781) list of the addresses of the Stable Coins that can be used to purchase Security Tokens in the STO -___ - -### startDate +### startDate -• **startDate**: *Date* +• **startDate**: _Date_ -*Defined in [src/types/index.ts:749](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L749)* +_Defined in_ [_src/types/index.ts:749_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L749) start date of the STO -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:745](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L745)* +_Defined in_ [_src/types/index.ts:745_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L745) symbol of the Security Token -___ +### tiers -### tiers +• **tiers**: [_StoTier_](_types_index_.stotier.md)_\[\]_ -• **tiers**: *[StoTier](_types_index_.stotier.md)[]* - -*Defined in [src/types/index.ts:757](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L757)* +_Defined in_ [_src/types/index.ts:757_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L757) array of Tier information -___ - -### unsoldTokensWallet +### unsoldTokensWallet -• **unsoldTokensWallet**: *string* +• **unsoldTokensWallet**: _string_ -*Defined in [src/types/index.ts:777](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L777)* +_Defined in_ [_src/types/index.ts:777_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L777) wallet where unsold tokens will be sent if the STO expires + diff --git a/docs/api/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md b/docs/api/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md index ec08947..babadeb 100644 --- a/docs/api/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyDividendsDefaultExclusionListProcedureArgs +# ModifyDividendsDefaultExclusionListProcedureArgs Arguments for the [ModifyDividendsDefaultExclusionList](../enums/_types_index_.proceduretype.md#modifydividendsdefaultexclusionlist) Procedure @@ -15,21 +15,19 @@ Arguments for the [ModifyDividendsDefaultExclusionList](../enums/_types_index_.p ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:869](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L869)* +_Defined in_ [_src/types/index.ts:869_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L869) the symbol of the Security Token -___ +### tokenholderAddresses -### tokenholderAddresses +• **tokenholderAddresses**: _string\[\]_ -• **tokenholderAddresses**: *string[]* +_Defined in_ [_src/types/index.ts:874_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L874) -*Defined in [src/types/index.ts:874](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L874)* +list of addresses to conform the new default exclusion list. Addresses in this list will not be considered for Dividend Distribution payments -list of addresses to conform the new default exclusion list. -Addresses in this list will not be considered for Dividend Distribution payments diff --git a/docs/api/interfaces/_types_index_.modifymaxholdercountprocedureargs.md b/docs/api/interfaces/_types_index_.modifymaxholdercountprocedureargs.md index 685bf0b..14548f3 100644 --- a/docs/api/interfaces/_types_index_.modifymaxholdercountprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifymaxholdercountprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyMaxHolderCountProcedureArgs +# ModifyMaxHolderCountProcedureArgs Arguments for the [ModifyMaxHolderCount](../enums/_types_index_.proceduretype.md#modifymaxholdercount) Procedure @@ -15,20 +15,19 @@ Arguments for the [ModifyMaxHolderCount](../enums/_types_index_.proceduretype.md ## Properties -### maxHolderCount +### maxHolderCount -• **maxHolderCount**: *number* +• **maxHolderCount**: _number_ -*Defined in [src/types/index.ts:1192](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1192)* +_Defined in_ [_src/types/index.ts:1192_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1192) maximum number of simultaneous token holders -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1188](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1188)* +_Defined in_ [_src/types/index.ts:1188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1188) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md b/docs/api/interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md index 00e7831..2ecc60e 100644 --- a/docs/api/interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifymaxholderpercentageprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyMaxHolderPercentageProcedureArgs +# ModifyMaxHolderPercentageProcedureArgs Arguments for the [ModifyMaxHolderPercentage](../enums/_types_index_.proceduretype.md#modifymaxholderpercentage) Procedure @@ -15,20 +15,19 @@ Arguments for the [ModifyMaxHolderPercentage](../enums/_types_index_.procedurety ## Properties -### maxHolderPercentage +### maxHolderPercentage -• **maxHolderPercentage**: *BigNumber* +• **maxHolderPercentage**: _BigNumber_ -*Defined in [src/types/index.ts:1206](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1206)* +_Defined in_ [_src/types/index.ts:1206_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1206) maximum percentage of total tokens a single Tokenholder can hold -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1202](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1202)* +_Defined in_ [_src/types/index.ts:1202_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1202) the symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md b/docs/api/interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md index 0b4a4b3..b17f9d9 100644 --- a/docs/api/interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifypercentageexemptionsprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyPercentageExemptionsProcedureArgs +# ModifyPercentageExemptionsProcedureArgs Arguments for the [ModifyPercentageExemptions](../enums/_types_index_.proceduretype.md#modifypercentageexemptions) Procedure @@ -18,29 +18,25 @@ Arguments for the [ModifyPercentageExemptions](../enums/_types_index_.proceduret ### `Optional` allowPrimaryIssuance -• **allowPrimaryIssuance**? : *undefined | false | true* +• **allowPrimaryIssuance**? : _undefined \| false \| true_ -*Defined in [src/types/index.ts:1239](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1239)* +_Defined in_ [_src/types/index.ts:1239_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1239) -whether primary issuance is exempted from percentage restrictions. -If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions +whether primary issuance is exempted from percentage restrictions. If true, issuing tokens to a wallet that doesn't own tokens will bypass percentage restrictions -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1230](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1230)* +_Defined in_ [_src/types/index.ts:1230_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1230) symbol of the Security Token -___ - ### `Optional` whitelistEntries -• **whitelistEntries**? : *[PercentageWhitelistEntry](_types_index_.percentagewhitelistentry.md)[]* +• **whitelistEntries**? : [_PercentageWhitelistEntry_](_types_index_.percentagewhitelistentry.md)_\[\]_ -*Defined in [src/types/index.ts:1234](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1234)* +_Defined in_ [_src/types/index.ts:1234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1234) list of Tokenholders to add/remove to/from the whitelist + diff --git a/docs/api/interfaces/_types_index_.modifytieredstodataprocedureargs.md b/docs/api/interfaces/_types_index_.modifytieredstodataprocedureargs.md index 0b6789f..f524478 100644 --- a/docs/api/interfaces/_types_index_.modifytieredstodataprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifytieredstodataprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyTieredStoDataProcedureArgs +# ModifyTieredStoDataProcedureArgs Arguments for the [ModifyTieredStoData](../enums/_types_index_.proceduretype.md#modifytieredstodata) Procedure @@ -17,20 +17,19 @@ Arguments for the [ModifyTieredStoData](../enums/_types_index_.proceduretype.md# ## Properties -### stoAddress +### stoAddress -• **stoAddress**: *string* +• **stoAddress**: _string_ -*Defined in [src/types/index.ts:609](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L609)* +_Defined in_ [_src/types/index.ts:609_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L609) address of the STO -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:613](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L613)* +_Defined in_ [_src/types/index.ts:613_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L613) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.modifytokenholderdataprocedureargs.md b/docs/api/interfaces/_types_index_.modifytokenholderdataprocedureargs.md index b494d60..de7fed8 100644 --- a/docs/api/interfaces/_types_index_.modifytokenholderdataprocedureargs.md +++ b/docs/api/interfaces/_types_index_.modifytokenholderdataprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ModifyTokenholderDataProcedureArgs +# ModifyTokenholderDataProcedureArgs Arguments for the [ModifyTokenholderData](../enums/_types_index_.proceduretype.md#modifytokenholderdata) Procedure @@ -15,20 +15,19 @@ Arguments for the [ModifyTokenholderData](../enums/_types_index_.proceduretype.m ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1160)* +_Defined in_ [_src/types/index.ts:1160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1160) symbol of the Security Token -___ +### tokenholderData -### tokenholderData +• **tokenholderData**: [_TokenholderDataEntry_](_types_index_.tokenholderdataentry.md)_\[\]_ -• **tokenholderData**: *[TokenholderDataEntry](_types_index_.tokenholderdataentry.md)[]* - -*Defined in [src/types/index.ts:1164](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1164)* +_Defined in_ [_src/types/index.ts:1164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1164) tokenholder KYC data that will be added/modified + diff --git a/docs/api/interfaces/_types_index_.percentagewhitelistentry.md b/docs/api/interfaces/_types_index_.percentagewhitelistentry.md index 1baf8cf..ba0fa60 100644 --- a/docs/api/interfaces/_types_index_.percentagewhitelistentry.md +++ b/docs/api/interfaces/_types_index_.percentagewhitelistentry.md @@ -1,4 +1,4 @@ -# Interface: PercentageWhitelistEntry +# PercentageWhitelistEntry Entry that represents whether a Tokenholder is exempted from Percentage Restrictions @@ -15,20 +15,19 @@ Entry that represents whether a Tokenholder is exempted from Percentage Restrict ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:1216](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1216)* +_Defined in_ [_src/types/index.ts:1216_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1216) Tokenholder wallet address -___ +### whitelisted -### whitelisted +• **whitelisted**: _boolean_ -• **whitelisted**: *boolean* - -*Defined in [src/types/index.ts:1220](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1220)* +_Defined in_ [_src/types/index.ts:1220_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1220) whether the address is whitelisted or not + diff --git a/docs/api/interfaces/_types_index_.pojo.md b/docs/api/interfaces/_types_index_.pojo.md index 2eac388..7c4b013 100644 --- a/docs/api/interfaces/_types_index_.pojo.md +++ b/docs/api/interfaces/_types_index_.pojo.md @@ -1,4 +1,4 @@ -# Interface: Pojo +# Pojo ## Hierarchy @@ -6,4 +6,5 @@ ## Indexable -* \[ **key**: *string*\]: string | number | boolean | null | [Pojo](_types_index_.pojo.md) | BigNumber | Date | null | string | number | false | true | BigNumber | Date | [Pojo](_types_index_.pojo.md)[] +* \[ **key**: _string_\]: string \| number \| boolean \| null \| [Pojo](_types_index_.pojo.md) \| BigNumber \| Date \| null \| string \| number \| false \| true \| BigNumber \| Date \| [Pojo](_types_index_.pojo.md)\[\] + diff --git a/docs/api/interfaces/_types_index_.pulldividendpaymentprocedureargs.md b/docs/api/interfaces/_types_index_.pulldividendpaymentprocedureargs.md index 9e1d174..a314ff6 100644 --- a/docs/api/interfaces/_types_index_.pulldividendpaymentprocedureargs.md +++ b/docs/api/interfaces/_types_index_.pulldividendpaymentprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: PullDividendPaymentProcedureArgs +# PullDividendPaymentProcedureArgs Arguments for the [PullDividendPayment](../enums/_types_index_.proceduretype.md#pulldividendpayment) Procedure @@ -15,18 +15,17 @@ Arguments for the [PullDividendPayment](../enums/_types_index_.proceduretype.md# ## Properties -### dividendIndex +### dividendIndex -• **dividendIndex**: *number* +• **dividendIndex**: _number_ -*Defined in [src/types/index.ts:389](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L389)* +_Defined in_ [_src/types/index.ts:389_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L389) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:388](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L388)* +_Defined in_ [_src/types/index.ts:388_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L388) symbol of the security token + diff --git a/docs/api/interfaces/_types_index_.pushdividendpaymentprocedureargs.md b/docs/api/interfaces/_types_index_.pushdividendpaymentprocedureargs.md index b091673..7fa3890 100644 --- a/docs/api/interfaces/_types_index_.pushdividendpaymentprocedureargs.md +++ b/docs/api/interfaces/_types_index_.pushdividendpaymentprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: PushDividendPaymentProcedureArgs +# PushDividendPaymentProcedureArgs Arguments for the [PushDividendPayment](../enums/_types_index_.proceduretype.md#pushdividendpayment) Procedure @@ -16,28 +16,25 @@ Arguments for the [PushDividendPayment](../enums/_types_index_.proceduretype.md# ## Properties -### dividendIndex +### dividendIndex -• **dividendIndex**: *number* +• **dividendIndex**: _number_ -*Defined in [src/types/index.ts:374](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L374)* +_Defined in_ [_src/types/index.ts:374_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L374) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:373](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L373)* +_Defined in_ [_src/types/index.ts:373_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L373) symbol of the security token -___ - ### `Optional` tokenholderAddresses -• **tokenholderAddresses**? : *string[]* +• **tokenholderAddresses**? : _string\[\]_ -*Defined in [src/types/index.ts:378](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L378)* +_Defined in_ [_src/types/index.ts:378_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L378) list of addresses of the Tokenholders that will receive payment + diff --git a/docs/api/interfaces/_types_index_.reclaimfundsprocedureargs.md b/docs/api/interfaces/_types_index_.reclaimfundsprocedureargs.md index 2c3eb0a..80d9f18 100644 --- a/docs/api/interfaces/_types_index_.reclaimfundsprocedureargs.md +++ b/docs/api/interfaces/_types_index_.reclaimfundsprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ReclaimFundsProcedureArgs +# ReclaimFundsProcedureArgs Arguments for the [ReclaimFunds](../enums/_types_index_.proceduretype.md#reclaimfunds) Procedure @@ -15,18 +15,17 @@ Arguments for the [ReclaimFunds](../enums/_types_index_.proceduretype.md#reclaim ## Properties -### dividendIndex +### dividendIndex -• **dividendIndex**: *number* +• **dividendIndex**: _number_ -*Defined in [src/types/index.ts:802](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L802)* +_Defined in_ [_src/types/index.ts:802_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L802) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:801](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L801)* +_Defined in_ [_src/types/index.ts:801_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L801) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.removedocumentprocedureargs.md b/docs/api/interfaces/_types_index_.removedocumentprocedureargs.md index 58b0d44..f50c1b4 100644 --- a/docs/api/interfaces/_types_index_.removedocumentprocedureargs.md +++ b/docs/api/interfaces/_types_index_.removedocumentprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: RemoveDocumentProcedureArgs +# RemoveDocumentProcedureArgs Arguments for the [RemoveDocument](../enums/_types_index_.proceduretype.md#removedocument) Procedure @@ -15,20 +15,19 @@ Arguments for the [RemoveDocument](../enums/_types_index_.proceduretype.md#remov ## Properties -### name +### name -• **name**: *string* +• **name**: _string_ -*Defined in [src/types/index.ts:1064](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1064)* +_Defined in_ [_src/types/index.ts:1064_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1064) the name of the Document being removed -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1060](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1060)* +_Defined in_ [_src/types/index.ts:1060_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1060) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.reservesecuritytokenprocedureargs.md b/docs/api/interfaces/_types_index_.reservesecuritytokenprocedureargs.md index b616a86..c156ca7 100644 --- a/docs/api/interfaces/_types_index_.reservesecuritytokenprocedureargs.md +++ b/docs/api/interfaces/_types_index_.reservesecuritytokenprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ReserveSecurityTokenProcedureArgs +# ReserveSecurityTokenProcedureArgs Arguments for the [ReserveSecurityToken](../enums/_types_index_.proceduretype.md#reservesecuritytoken) Procedure @@ -17,18 +17,17 @@ Arguments for the [ReserveSecurityToken](../enums/_types_index_.proceduretype.md ### `Optional` owner -• **owner**? : *undefined | string* +• **owner**? : _undefined \| string_ -*Defined in [src/types/index.ts:816](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L816)* +_Defined in_ [_src/types/index.ts:816_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L816) if supplied, the reservation will be made on behalf of this address -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:812](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L812)* +_Defined in_ [_src/types/index.ts:812_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L812) the symbol to be reserved + diff --git a/docs/api/interfaces/_types_index_.revokekycprocedureargs.md b/docs/api/interfaces/_types_index_.revokekycprocedureargs.md index 90a5642..6c9d1c1 100644 --- a/docs/api/interfaces/_types_index_.revokekycprocedureargs.md +++ b/docs/api/interfaces/_types_index_.revokekycprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: RevokeKycProcedureArgs +# RevokeKycProcedureArgs Arguments for the [RevokeKyc](../enums/_types_index_.proceduretype.md#revokekyc) Procedure @@ -15,20 +15,19 @@ Arguments for the [RevokeKyc](../enums/_types_index_.proceduretype.md#revokekyc) ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1174](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1174)* +_Defined in_ [_src/types/index.ts:1174_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1174) symbol of the Security Token -___ +### tokenholderAddresses -### tokenholderAddresses +• **tokenholderAddresses**: _string\[\]_ -• **tokenholderAddresses**: *string[]* - -*Defined in [src/types/index.ts:1178](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1178)* +_Defined in_ [_src/types/index.ts:1178_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1178) list of Tokenholders addresses for which KYC will be revoked + diff --git a/docs/api/interfaces/_types_index_.setcontrollerprocedureargs.md b/docs/api/interfaces/_types_index_.setcontrollerprocedureargs.md index 6436af8..63eaabd 100644 --- a/docs/api/interfaces/_types_index_.setcontrollerprocedureargs.md +++ b/docs/api/interfaces/_types_index_.setcontrollerprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SetControllerProcedureArgs +# SetControllerProcedureArgs Arguments for the [SetController](../enums/_types_index_.proceduretype.md#setcontroller) Procedure @@ -15,20 +15,19 @@ Arguments for the [SetController](../enums/_types_index_.proceduretype.md#setcon ## Properties -### controller +### controller -• **controller**: *string* +• **controller**: _string_ -*Defined in [src/types/index.ts:1031](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1031)* +_Defined in_ [_src/types/index.ts:1031_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1031) wallet address to be set as the Security Token's controller -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1027](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1027)* +_Defined in_ [_src/types/index.ts:1027_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1027) the symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.setdividendswalletprocedureargs.md b/docs/api/interfaces/_types_index_.setdividendswalletprocedureargs.md index f1516c9..fe82718 100644 --- a/docs/api/interfaces/_types_index_.setdividendswalletprocedureargs.md +++ b/docs/api/interfaces/_types_index_.setdividendswalletprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SetDividendsWalletProcedureArgs +# SetDividendsWalletProcedureArgs Arguments for the [SetDividendsWallet](../enums/_types_index_.proceduretype.md#setdividendswallet) Procedure @@ -15,20 +15,19 @@ Arguments for the [SetDividendsWallet](../enums/_types_index_.proceduretype.md#s ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:859](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L859)* +_Defined in_ [_src/types/index.ts:859_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L859) wallet address -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:855](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L855)* +_Defined in_ [_src/types/index.ts:855_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L855) the symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.setdocumentprocedureargs.md b/docs/api/interfaces/_types_index_.setdocumentprocedureargs.md index 98cb44f..cf2fd74 100644 --- a/docs/api/interfaces/_types_index_.setdocumentprocedureargs.md +++ b/docs/api/interfaces/_types_index_.setdocumentprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SetDocumentProcedureArgs +# SetDocumentProcedureArgs Arguments for the [SetDocument](../enums/_types_index_.proceduretype.md#setdocument) Procedure @@ -17,38 +17,33 @@ Arguments for the [SetDocument](../enums/_types_index_.proceduretype.md#setdocum ## Properties -### documentHash +### documentHash -• **documentHash**: *string* +• **documentHash**: _string_ -*Defined in [src/types/index.ts:1050](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1050)* +_Defined in_ [_src/types/index.ts:1050_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1050) hash of the contents of the Document -___ +### name -### name +• **name**: _string_ -• **name**: *string* - -*Defined in [src/types/index.ts:1045](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1045)* +_Defined in_ [_src/types/index.ts:1045_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1045) name of the Document. Must be unique for the Security Token -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1041](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1041)* +_Defined in_ [_src/types/index.ts:1041_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1041) symbol of the Security Token -___ +### uri -### uri +• **uri**: _string_ -• **uri**: *string* +_Defined in_ [_src/types/index.ts:1046_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1046) -*Defined in [src/types/index.ts:1046](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1046)* diff --git a/docs/api/interfaces/_types_index_.signdisablecontrollerackprocedureargs.md b/docs/api/interfaces/_types_index_.signdisablecontrollerackprocedureargs.md index 2d8e250..ff14bca 100644 --- a/docs/api/interfaces/_types_index_.signdisablecontrollerackprocedureargs.md +++ b/docs/api/interfaces/_types_index_.signdisablecontrollerackprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SignDisableControllerAckProcedureArgs +# SignDisableControllerAckProcedureArgs Arguments for the [SignDisableControllerAck](../enums/_types_index_.proceduretype.md#signdisablecontrollerack) Procedure @@ -14,10 +14,11 @@ Arguments for the [SignDisableControllerAck](../enums/_types_index_.proceduretyp ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1311](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1311)* +_Defined in_ [_src/types/index.ts:1311_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1311) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.signfreezeissuanceackprocedureargs.md b/docs/api/interfaces/_types_index_.signfreezeissuanceackprocedureargs.md index b13eb85..3d516ef 100644 --- a/docs/api/interfaces/_types_index_.signfreezeissuanceackprocedureargs.md +++ b/docs/api/interfaces/_types_index_.signfreezeissuanceackprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SignFreezeIssuanceAckProcedureArgs +# SignFreezeIssuanceAckProcedureArgs Arguments for the [SignFreezeIssuanceAck](../enums/_types_index_.proceduretype.md#signfreezeissuanceack) Procedure @@ -14,10 +14,11 @@ Arguments for the [SignFreezeIssuanceAck](../enums/_types_index_.proceduretype.m ## Properties -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1321](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1321)* +_Defined in_ [_src/types/index.ts:1321_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1321) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.signtransferdataprocedureargs.md b/docs/api/interfaces/_types_index_.signtransferdataprocedureargs.md index c894e07..48f0b66 100644 --- a/docs/api/interfaces/_types_index_.signtransferdataprocedureargs.md +++ b/docs/api/interfaces/_types_index_.signtransferdataprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: SignTransferDataProcedureArgs +# SignTransferDataProcedureArgs Arguments for the [SignTransferData](../enums/_types_index_.proceduretype.md#signtransferdata) Procedure @@ -17,40 +17,35 @@ Arguments for the [SignTransferData](../enums/_types_index_.proceduretype.md#sig ## Properties -### kycData +### kycData -• **kycData**: *[Omit](../modules/_types_index_.md#omit)‹[Omit](../modules/_types_index_.md#omit)‹[TokenholderDataEntry](_types_index_.tokenholderdataentry.md), "isAccredited"›, "canBuyFromSto"›[]* +• **kycData**: [_Omit_](../external-modules/_types_index_.md#omit)_‹_[_Omit_](../external-modules/_types_index_.md#omit)_‹_[_TokenholderDataEntry_](_types_index_.tokenholderdataentry.md)_, "isAccredited"›, "canBuyFromSto"›\[\]_ -*Defined in [src/types/index.ts:1293](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1293)* +_Defined in_ [_src/types/index.ts:1293_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1293) KYC data to sign -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1289](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1289)* +_Defined in_ [_src/types/index.ts:1289_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1289) symbol of the Security Token -___ - -### validFrom +### validFrom -• **validFrom**: *Date* +• **validFrom**: _Date_ -*Defined in [src/types/index.ts:1297](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1297)* +_Defined in_ [_src/types/index.ts:1297_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1297) date from which the signature is valid -___ +### validTo -### validTo +• **validTo**: _Date_ -• **validTo**: *Date* - -*Defined in [src/types/index.ts:1301](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1301)* +_Defined in_ [_src/types/index.ts:1301_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1301) date until which the signature is valid + diff --git a/docs/api/interfaces/_types_index_.stotier.md b/docs/api/interfaces/_types_index_.stotier.md index 0628057..e908312 100644 --- a/docs/api/interfaces/_types_index_.stotier.md +++ b/docs/api/interfaces/_types_index_.stotier.md @@ -1,7 +1,6 @@ -# Interface: StoTier +# StoTier -Represents a tier of investment in a Tiered STO. -Different tiers can sell different Security Token amounts at different prices, and apply discounts when purchasing with POLY +Represents a tier of investment in a Tiered STO. Different tiers can sell different Security Token amounts at different prices, and apply discounts when purchasing with POLY ## Hierarchy @@ -20,39 +19,33 @@ Different tiers can sell different Security Token amounts at different prices, a ### `Optional` discountedPrice -• **discountedPrice**? : *BigNumber* +• **discountedPrice**? : _BigNumber_ -*Defined in [src/types/index.ts:717](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L717)* +_Defined in_ [_src/types/index.ts:717_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L717) Price of tokens sold at a discount -___ +### price -### price +• **price**: _BigNumber_ -• **price**: *BigNumber* - -*Defined in [src/types/index.ts:708](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L708)* +_Defined in_ [_src/types/index.ts:708_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L708) Price of each token in this tier -___ - -### tokensOnSale +### tokensOnSale -• **tokensOnSale**: *BigNumber* +• **tokensOnSale**: _BigNumber_ -*Defined in [src/types/index.ts:704](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L704)* +_Defined in_ [_src/types/index.ts:704_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L704) Amount of tokens to sell in this tier -___ - ### `Optional` tokensWithDiscount -• **tokensWithDiscount**? : *BigNumber* +• **tokensWithDiscount**? : _BigNumber_ + +_Defined in_ [_src/types/index.ts:713_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L713) -*Defined in [src/types/index.ts:713](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L713)* +Amount of tokens to sell at a discount if paid in POLY. Must be less than the amount of tokens on sale -Amount of tokens to sell at a discount if paid in POLY. -Must be less than the amount of tokens on sale diff --git a/docs/api/interfaces/_types_index_.taxwithholdingentry.md b/docs/api/interfaces/_types_index_.taxwithholdingentry.md index 53e1db3..ba29b23 100644 --- a/docs/api/interfaces/_types_index_.taxwithholdingentry.md +++ b/docs/api/interfaces/_types_index_.taxwithholdingentry.md @@ -1,4 +1,4 @@ -# Interface: TaxWithholdingEntry +# TaxWithholdingEntry Properties denoting a Tokenholder's Tax Withholding Percentage @@ -15,20 +15,19 @@ Properties denoting a Tokenholder's Tax Withholding Percentage ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:69](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L69)* +_Defined in_ [_src/types/index.ts:69_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L69) wallet address of the Tokenholder -___ +### percentage -### percentage +• **percentage**: _number_ -• **percentage**: *number* - -*Defined in [src/types/index.ts:73](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L73)* +_Defined in_ [_src/types/index.ts:73_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L73) percentage of the Tokenholder's Dividend payments that will be withheld for tax + diff --git a/docs/api/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md b/docs/api/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md index 23d1fa4..b2842a7 100644 --- a/docs/api/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md +++ b/docs/api/interfaces/_types_index_.toggleallowbeneficialinvestmentsprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ToggleAllowBeneficialInvestmentsProcedureArgs +# ToggleAllowBeneficialInvestmentsProcedureArgs Arguments for the [ToggleAllowBeneficialInvestments](../enums/_types_index_.proceduretype.md#toggleallowbeneficialinvestments) Procedure @@ -17,40 +17,35 @@ Arguments for the [ToggleAllowBeneficialInvestments](../enums/_types_index_.proc ## Properties -### allowBeneficialInvestments +### allowBeneficialInvestments -• **allowBeneficialInvestments**: *boolean* +• **allowBeneficialInvestments**: _boolean_ -*Defined in [src/types/index.ts:598](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L598)* +_Defined in_ [_src/types/index.ts:598_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L598) whether the STO allows investing on behalf of a beneficiary -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* - -*Defined in [src/types/index.ts:590](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L590)* +_Defined in_ [_src/types/index.ts:590_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L590) address of the STO -___ - -### stoType +### stoType -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -*Defined in [src/types/index.ts:594](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L594)* +_Defined in_ [_src/types/index.ts:594_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L594) -type of the STO (Simple, Tiered, etc) +type of the STO \(Simple, Tiered, etc\) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:586](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L586)* +_Defined in_ [_src/types/index.ts:586_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L586) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.toggleallowpreissuingprocedureargs.md b/docs/api/interfaces/_types_index_.toggleallowpreissuingprocedureargs.md index 6e56a1d..3e45326 100644 --- a/docs/api/interfaces/_types_index_.toggleallowpreissuingprocedureargs.md +++ b/docs/api/interfaces/_types_index_.toggleallowpreissuingprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ToggleAllowPreIssuingProcedureArgs +# ToggleAllowPreIssuingProcedureArgs Arguments for the [ToggleAllowPreIssuing](../enums/_types_index_.proceduretype.md#toggleallowpreissuing) Procedure @@ -17,41 +17,35 @@ Arguments for the [ToggleAllowPreIssuing](../enums/_types_index_.proceduretype.m ## Properties -### allowPreIssuing +### allowPreIssuing -• **allowPreIssuing**: *boolean* +• **allowPreIssuing**: _boolean_ -*Defined in [src/types/index.ts:576](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L576)* +_Defined in_ [_src/types/index.ts:576_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L576) -whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. -Otherwise, they will be issued on each purchase. Defaults to false +whether the total amount of Security Tokens that will be sold should be issued at the time the STO starts. Otherwise, they will be issued on each purchase. Defaults to false -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* - -*Defined in [src/types/index.ts:567](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L567)* +_Defined in_ [_src/types/index.ts:567_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L567) address of the STO -___ - -### stoType +### stoType -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -*Defined in [src/types/index.ts:571](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L571)* +_Defined in_ [_src/types/index.ts:571_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L571) -type of the STO (Simple, Tiered, etc) +type of the STO \(Simple, Tiered, etc\) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:563](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L563)* +_Defined in_ [_src/types/index.ts:563_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L563) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.togglefreezetransfersprocedureargs.md b/docs/api/interfaces/_types_index_.togglefreezetransfersprocedureargs.md index cf1bdda..16ca5b4 100644 --- a/docs/api/interfaces/_types_index_.togglefreezetransfersprocedureargs.md +++ b/docs/api/interfaces/_types_index_.togglefreezetransfersprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: ToggleFreezeTransfersProcedureArgs +# ToggleFreezeTransfersProcedureArgs Arguments for the [ToggleFreezeTransfers](../enums/_types_index_.proceduretype.md#togglefreezetransfers) Procedure @@ -15,20 +15,19 @@ Arguments for the [ToggleFreezeTransfers](../enums/_types_index_.proceduretype.m ## Properties -### freeze +### freeze -• **freeze**: *boolean* +• **freeze**: _boolean_ -*Defined in [src/types/index.ts:1279](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1279)* +_Defined in_ [_src/types/index.ts:1279_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1279) whether to freeze or un-freeze transfers -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1275](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1275)* +_Defined in_ [_src/types/index.ts:1275_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1275) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.togglepausestoprocedureargs.md b/docs/api/interfaces/_types_index_.togglepausestoprocedureargs.md index e5d854a..058533f 100644 --- a/docs/api/interfaces/_types_index_.togglepausestoprocedureargs.md +++ b/docs/api/interfaces/_types_index_.togglepausestoprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: TogglePauseStoProcedureArgs +# TogglePauseStoProcedureArgs Arguments for the [TogglePauseSto](../enums/_types_index_.proceduretype.md#togglepausesto) Procedure @@ -17,38 +17,33 @@ Arguments for the [TogglePauseSto](../enums/_types_index_.proceduretype.md#toggl ## Properties -### pause +### pause -• **pause**: *boolean* +• **pause**: _boolean_ -*Defined in [src/types/index.ts:1002](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1002)* +_Defined in_ [_src/types/index.ts:1002_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1002) true if pausing the STO, false if un-pausing it -___ +### stoAddress -### stoAddress +• **stoAddress**: _string_ -• **stoAddress**: *string* +_Defined in_ [_src/types/index.ts:994_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L994) -*Defined in [src/types/index.ts:994](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L994)* +### stoType -___ +• **stoType**: [_StoType_](../enums/_types_index_.stotype.md) -### stoType +_Defined in_ [_src/types/index.ts:998_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L998) -• **stoType**: *[StoType](../enums/_types_index_.stotype.md)* +type of the STO \(Simple, Tiered, etc\) -*Defined in [src/types/index.ts:998](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L998)* +### symbol -type of the STO (Simple, Tiered, etc) +• **symbol**: _string_ -___ - -### symbol - -• **symbol**: *string* - -*Defined in [src/types/index.ts:993](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L993)* +_Defined in_ [_src/types/index.ts:993_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L993) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.tokenholderbalance.md b/docs/api/interfaces/_types_index_.tokenholderbalance.md index 64bb652..5e1104e 100644 --- a/docs/api/interfaces/_types_index_.tokenholderbalance.md +++ b/docs/api/interfaces/_types_index_.tokenholderbalance.md @@ -1,4 +1,4 @@ -# Interface: TokenholderBalance +# TokenholderBalance Balance in Security Tokens of a specific Tokenholder @@ -15,20 +15,19 @@ Balance in Security Tokens of a specific Tokenholder ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:125](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L125)* +_Defined in_ [_src/types/index.ts:125_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L125) wallet address of the Tokenholder -___ +### balance -### balance +• **balance**: _BigNumber_ -• **balance**: *BigNumber* - -*Defined in [src/types/index.ts:129](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L129)* +_Defined in_ [_src/types/index.ts:129_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L129) amount of Security Tokens the Tokenholder possesses + diff --git a/docs/api/interfaces/_types_index_.tokenholderdataentry.md b/docs/api/interfaces/_types_index_.tokenholderdataentry.md index d8890e5..4434dcc 100644 --- a/docs/api/interfaces/_types_index_.tokenholderdataentry.md +++ b/docs/api/interfaces/_types_index_.tokenholderdataentry.md @@ -1,4 +1,4 @@ -# Interface: TokenholderDataEntry +# TokenholderDataEntry A Tokenholder's KYC data @@ -19,60 +19,51 @@ A Tokenholder's KYC data ## Properties -### address +### address -• **address**: *string* +• **address**: _string_ -*Defined in [src/types/index.ts:1130](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1130)* +_Defined in_ [_src/types/index.ts:1130_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1130) tokenholder wallet address to whitelist -___ +### canBuyFromSto -### canBuyFromSto +• **canBuyFromSto**: _boolean_ -• **canBuyFromSto**: *boolean* - -*Defined in [src/types/index.ts:1150](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1150)* +_Defined in_ [_src/types/index.ts:1150_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1150) whether the tokenholder is allowed to purchase tokens in an STO -___ - -### canReceiveAfter +### canReceiveAfter -• **canReceiveAfter**: *Date* +• **canReceiveAfter**: _Date_ -*Defined in [src/types/index.ts:1138](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1138)* +_Defined in_ [_src/types/index.ts:1138_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1138) date from which the tokenholder can receive tokens -___ - -### canSendAfter +### canSendAfter -• **canSendAfter**: *Date* +• **canSendAfter**: _Date_ -*Defined in [src/types/index.ts:1134](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1134)* +_Defined in_ [_src/types/index.ts:1134_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1134) date from which the tokenholder can transfer tokens -___ +### isAccredited -### isAccredited +• **isAccredited**: _boolean_ -• **isAccredited**: *boolean* - -*Defined in [src/types/index.ts:1146](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1146)* +_Defined in_ [_src/types/index.ts:1146_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1146) whether the tokenholder is accredited -___ - -### kycExpiry +### kycExpiry -• **kycExpiry**: *Date* +• **kycExpiry**: _Date_ -*Defined in [src/types/index.ts:1142](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1142)* +_Defined in_ [_src/types/index.ts:1142_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1142) date at which the tokenholder's KYC expires + diff --git a/docs/api/interfaces/_types_index_.transactionspec.md b/docs/api/interfaces/_types_index_.transactionspec.md index b23436d..6a59653 100644 --- a/docs/api/interfaces/_types_index_.transactionspec.md +++ b/docs/api/interfaces/_types_index_.transactionspec.md @@ -1,4 +1,4 @@ -# Interface: TransactionSpec <**Args, Value, Receipt, FutureValue**> +# TransactionSpec Schema of a specific transaction @@ -6,11 +6,11 @@ Schema of a specific transaction ▪ **Args** -▪ **Value**: *any[]* +▪ **Value**: _any\[\]_ -▪ **Receipt**: *any* +▪ **Receipt**: _any_ -▪ **FutureValue**: *any* +▪ **FutureValue**: _any_ ## Hierarchy @@ -27,32 +27,27 @@ Schema of a specific transaction ## Properties -### args +### args -• **args**: *[MapMaybeResolver](../modules/_types_index_.md#mapmayberesolver)‹Args›* +• **args**: [_MapMaybeResolver_](../external-modules/_types_index_.md#mapmayberesolver)_‹Args›_ -*Defined in [src/types/index.ts:1562](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1562)* +_Defined in_ [_src/types/index.ts:1562_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1562) -___ +### method -### method +• **method**: [_LowLevelMethod_](../external-modules/_types_index_.md#lowlevelmethod)_‹Args› \|_ [_SignatureRequest_](../external-modules/_types_index_.md#signaturerequest)_‹Args› \|_ [_FutureLowLevelMethod_](_types_index_.futurelowlevelmethod.md)_‹FutureValue, Args›_ -• **method**: *[LowLevelMethod](../modules/_types_index_.md#lowlevelmethod)‹Args› | [SignatureRequest](../modules/_types_index_.md#signaturerequest)‹Args› | [FutureLowLevelMethod](_types_index_.futurelowlevelmethod.md)‹FutureValue, Args›* - -*Defined in [src/types/index.ts:1561](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1561)* - -___ +_Defined in_ [_src/types/index.ts:1561_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1561) ### `Optional` postTransactionResolvers -• **postTransactionResolvers**? : *[PostTransactionResolverArray](../modules/_types_index_.md#posttransactionresolverarray)‹Value, Receipt›* +• **postTransactionResolvers**? : [_PostTransactionResolverArray_](../external-modules/_types_index_.md#posttransactionresolverarray)_‹Value, Receipt›_ -*Defined in [src/types/index.ts:1563](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1563)* - -___ +_Defined in_ [_src/types/index.ts:1563_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1563) ### `Optional` tag -• **tag**? : *[PolyTransactionTag](../enums/_types_index_.polytransactiontag.md)* +• **tag**? : [_PolyTransactionTag_](../enums/_types_index_.polytransactiontag.md) + +_Defined in_ [_src/types/index.ts:1564_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1564) -*Defined in [src/types/index.ts:1564](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1564)* diff --git a/docs/api/interfaces/_types_index_.transfererc20procedureargs.md b/docs/api/interfaces/_types_index_.transfererc20procedureargs.md index c7e9bb0..54fdf8e 100644 --- a/docs/api/interfaces/_types_index_.transfererc20procedureargs.md +++ b/docs/api/interfaces/_types_index_.transfererc20procedureargs.md @@ -1,4 +1,4 @@ -# Interface: TransferErc20ProcedureArgs +# TransferErc20ProcedureArgs Arguments for the [TransferErc20](../enums/_types_index_.proceduretype.md#transfererc20) Procedure @@ -16,30 +16,27 @@ Arguments for the [TransferErc20](../enums/_types_index_.proceduretype.md#transf ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:303](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L303)* +_Defined in_ [_src/types/index.ts:303_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L303) amount of tokens to be transferred -___ +### receiver -### receiver +• **receiver**: _string_ -• **receiver**: *string* - -*Defined in [src/types/index.ts:307](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L307)* +_Defined in_ [_src/types/index.ts:307_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L307) the receiver of tokens being transferred -___ - ### `Optional` tokenAddress -• **tokenAddress**? : *undefined | string* +• **tokenAddress**? : _undefined \| string_ + +_Defined in_ [_src/types/index.ts:311_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L311) -*Defined in [src/types/index.ts:311](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L311)* +address of the ERC20 token \(defaults to POLY\) -address of the ERC20 token (defaults to POLY) diff --git a/docs/api/interfaces/_types_index_.transferownershipprocedureargs.md b/docs/api/interfaces/_types_index_.transferownershipprocedureargs.md index ca607bf..ef98abf 100644 --- a/docs/api/interfaces/_types_index_.transferownershipprocedureargs.md +++ b/docs/api/interfaces/_types_index_.transferownershipprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: TransferOwnershipProcedureArgs +# TransferOwnershipProcedureArgs Arguments for the [TransferOwnership](../enums/_types_index_.proceduretype.md#transferownership) Procedure @@ -15,20 +15,19 @@ Arguments for the [TransferOwnership](../enums/_types_index_.proceduretype.md#tr ## Properties -### newOwner +### newOwner -• **newOwner**: *string* +• **newOwner**: _string_ -*Defined in [src/types/index.ts:1106](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1106)* +_Defined in_ [_src/types/index.ts:1106_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1106) wallet address for the new Security Token owner -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1102](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1102)* +_Defined in_ [_src/types/index.ts:1102_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1102) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.transferreservationownershipprocedureargs.md b/docs/api/interfaces/_types_index_.transferreservationownershipprocedureargs.md index 0f4302d..978bc0f 100644 --- a/docs/api/interfaces/_types_index_.transferreservationownershipprocedureargs.md +++ b/docs/api/interfaces/_types_index_.transferreservationownershipprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: TransferReservationOwnershipProcedureArgs +# TransferReservationOwnershipProcedureArgs Arguments for the [TransferReservationOwnership](../enums/_types_index_.proceduretype.md#transferreservationownership) Procedure @@ -15,20 +15,19 @@ Arguments for the [TransferReservationOwnership](../enums/_types_index_.procedur ## Properties -### newOwner +### newOwner -• **newOwner**: *string* +• **newOwner**: _string_ -*Defined in [src/types/index.ts:1120](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1120)* +_Defined in_ [_src/types/index.ts:1120_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1120) wallet address for the new symbol Reservation owner -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:1116](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1116)* +_Defined in_ [_src/types/index.ts:1116_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1116) symbol of the Security Token + diff --git a/docs/api/interfaces/_types_index_.transfersecuritytokensprocedureargs.md b/docs/api/interfaces/_types_index_.transfersecuritytokensprocedureargs.md index 0ea7c04..cad4c17 100644 --- a/docs/api/interfaces/_types_index_.transfersecuritytokensprocedureargs.md +++ b/docs/api/interfaces/_types_index_.transfersecuritytokensprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: TransferSecurityTokensProcedureArgs +# TransferSecurityTokensProcedureArgs Arguments for the [TransferSecurityTokens](../enums/_types_index_.proceduretype.md#transfersecuritytokens) Procedure @@ -18,50 +18,43 @@ Arguments for the [TransferSecurityTokens](../enums/_types_index_.proceduretype. ## Properties -### amount +### amount -• **amount**: *BigNumber* +• **amount**: _BigNumber_ -*Defined in [src/types/index.ts:1257](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1257)* +_Defined in_ [_src/types/index.ts:1257_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1257) amount of tokens being transferred -___ - ### `Optional` data -• **data**? : *undefined | string* - -*Defined in [src/types/index.ts:1261](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1261)* +• **data**? : _undefined \| string_ -signed KYC data that will be considered (and applied to the Security Token) when checking for transfer restrictions +_Defined in_ [_src/types/index.ts:1261_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1261) -___ +signed KYC data that will be considered \(and applied to the Security Token\) when checking for transfer restrictions ### `Optional` from -• **from**? : *undefined | string* +• **from**? : _undefined \| string_ -*Defined in [src/types/index.ts:1265](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1265)* +_Defined in_ [_src/types/index.ts:1265_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1265) wallet address sending Security Tokens. Defaults to the current wallet -___ - -### symbol +### symbol -• **symbol**: *string* +• **symbol**: _string_ -*Defined in [src/types/index.ts:1249](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1249)* +_Defined in_ [_src/types/index.ts:1249_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1249) symbol of the Security Token -___ +### to -### to +• **to**: _string_ -• **to**: *string* - -*Defined in [src/types/index.ts:1253](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1253)* +_Defined in_ [_src/types/index.ts:1253_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L1253) wallet address receiving Security Tokens + diff --git a/docs/api/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md b/docs/api/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md index c829d99..af199ec 100644 --- a/docs/api/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md +++ b/docs/api/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: UpdateDividendsTaxWithholdingListProcedureArgs +# UpdateDividendsTaxWithholdingListProcedureArgs Arguments for the [UpdateDividendsTaxWithholdingList](../enums/_types_index_.proceduretype.md#updatedividendstaxwithholdinglist) Procedure @@ -16,30 +16,27 @@ Arguments for the [UpdateDividendsTaxWithholdingList](../enums/_types_index_.pro ## Properties -### percentages +### percentages -• **percentages**: *number[]* +• **percentages**: _number\[\]_ -*Defined in [src/types/index.ts:845](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L845)* +_Defined in_ [_src/types/index.ts:845_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L845) list of percentages to update -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:837](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L837)* +_Defined in_ [_src/types/index.ts:837_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L837) the symbol of the Security Token -___ - -### tokenholderAddresses +### tokenholderAddresses -• **tokenholderAddresses**: *string[]* +• **tokenholderAddresses**: _string\[\]_ -*Defined in [src/types/index.ts:841](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L841)* +_Defined in_ [_src/types/index.ts:841_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L841) list of addresses of the Tokenholders for which to update the tax withholding percentages + diff --git a/docs/api/interfaces/_types_index_.withdrawtaxesprocedureargs.md b/docs/api/interfaces/_types_index_.withdrawtaxesprocedureargs.md index 617bd04..60643d9 100644 --- a/docs/api/interfaces/_types_index_.withdrawtaxesprocedureargs.md +++ b/docs/api/interfaces/_types_index_.withdrawtaxesprocedureargs.md @@ -1,4 +1,4 @@ -# Interface: WithdrawTaxesProcedureArgs +# WithdrawTaxesProcedureArgs Arguments for the [WithdrawTaxes](../enums/_types_index_.proceduretype.md#withdrawtaxes) Procedure @@ -15,18 +15,17 @@ Arguments for the [WithdrawTaxes](../enums/_types_index_.proceduretype.md#withdr ## Properties -### dividendIndex +### dividendIndex -• **dividendIndex**: *number* +• **dividendIndex**: _number_ -*Defined in [src/types/index.ts:827](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L827)* +_Defined in_ [_src/types/index.ts:827_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L827) -___ +### symbol -### symbol +• **symbol**: _string_ -• **symbol**: *string* - -*Defined in [src/types/index.ts:826](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L826)* +_Defined in_ [_src/types/index.ts:826_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/types/index.ts#L826) the symbol of the Security Token + diff --git a/docs/api/interfaces/_utils_index_.findcappedstopauseparams.md b/docs/api/interfaces/_utils_index_.findcappedstopauseparams.md index 725ef11..a4d0173 100644 --- a/docs/api/interfaces/_utils_index_.findcappedstopauseparams.md +++ b/docs/api/interfaces/_utils_index_.findcappedstopauseparams.md @@ -1,4 +1,4 @@ -# Interface: FindCappedStoPauseParams +# FindCappedStoPauseParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *Pause* +• **eventName**: _Pause_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:168](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L168)* +_Defined in_ [_src/utils/index.ts:168_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L168) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findcappedstopremintallowedparams.md b/docs/api/interfaces/_utils_index_.findcappedstopremintallowedparams.md index 97b8682..64ae16d 100644 --- a/docs/api/interfaces/_utils_index_.findcappedstopremintallowedparams.md +++ b/docs/api/interfaces/_utils_index_.findcappedstopremintallowedparams.md @@ -1,4 +1,4 @@ -# Interface: FindCappedStoPreMintAllowedParams +# FindCappedStoPreMintAllowedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *AllowPreMintFlag* +• **eventName**: _AllowPreMintFlag_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:172](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L172)* +_Defined in_ [_src/utils/index.ts:172_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L172) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findcheckpointcreatedparams.md b/docs/api/interfaces/_utils_index_.findcheckpointcreatedparams.md index 8db90e3..e40809e 100644 --- a/docs/api/interfaces/_utils_index_.findcheckpointcreatedparams.md +++ b/docs/api/interfaces/_utils_index_.findcheckpointcreatedparams.md @@ -1,4 +1,4 @@ -# Interface: FindCheckpointCreatedParams +# FindCheckpointCreatedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *SecurityTokenEvents.CheckpointCreated* +• **eventName**: _SecurityTokenEvents.CheckpointCreated_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:140](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L140)* +_Defined in_ [_src/utils/index.ts:140_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L140) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findcontrollertransferparams.md b/docs/api/interfaces/_utils_index_.findcontrollertransferparams.md index 85f08ac..7393b9d 100644 --- a/docs/api/interfaces/_utils_index_.findcontrollertransferparams.md +++ b/docs/api/interfaces/_utils_index_.findcontrollertransferparams.md @@ -1,4 +1,4 @@ -# Interface: FindControllerTransferParams +# FindControllerTransferParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *SecurityTokenEvents.ControllerTransfer* +• **eventName**: _SecurityTokenEvents.ControllerTransfer_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:148](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L148)* +_Defined in_ [_src/utils/index.ts:148_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L148) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.finderc20dividendclaimedparams.md b/docs/api/interfaces/_utils_index_.finderc20dividendclaimedparams.md index 8b5b01d..93c3564 100644 --- a/docs/api/interfaces/_utils_index_.finderc20dividendclaimedparams.md +++ b/docs/api/interfaces/_utils_index_.finderc20dividendclaimedparams.md @@ -1,4 +1,4 @@ -# Interface: FindErc20DividendClaimedParams +# FindErc20DividendClaimedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ERC20DividendCheckpointEvents.ERC20DividendClaimed* +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendClaimed_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:184](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L184)* +_Defined in_ [_src/utils/index.ts:184_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L184) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.finderc20dividenddepositedparams.md b/docs/api/interfaces/_utils_index_.finderc20dividenddepositedparams.md index 06c407f..2f6f4f9 100644 --- a/docs/api/interfaces/_utils_index_.finderc20dividenddepositedparams.md +++ b/docs/api/interfaces/_utils_index_.finderc20dividenddepositedparams.md @@ -1,4 +1,4 @@ -# Interface: FindErc20DividendDepositedParams +# FindErc20DividendDepositedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ERC20DividendCheckpointEvents.ERC20DividendDeposited* +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendDeposited_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:152](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L152)* +_Defined in_ [_src/utils/index.ts:152_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L152) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.finderc20dividendreclaimedparams.md b/docs/api/interfaces/_utils_index_.finderc20dividendreclaimedparams.md index 8a18a88..2554ef2 100644 --- a/docs/api/interfaces/_utils_index_.finderc20dividendreclaimedparams.md +++ b/docs/api/interfaces/_utils_index_.finderc20dividendreclaimedparams.md @@ -1,4 +1,4 @@ -# Interface: FindErc20DividendReclaimedParams +# FindErc20DividendReclaimedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ERC20DividendCheckpointEvents.ERC20DividendReclaimed* +• **eventName**: _ERC20DividendCheckpointEvents.ERC20DividendReclaimed_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:192](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L192)* +_Defined in_ [_src/utils/index.ts:192_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L192) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.finderc20setwalletparams.md b/docs/api/interfaces/_utils_index_.finderc20setwalletparams.md index 04f64c9..f680b3e 100644 --- a/docs/api/interfaces/_utils_index_.finderc20setwalletparams.md +++ b/docs/api/interfaces/_utils_index_.finderc20setwalletparams.md @@ -1,4 +1,4 @@ -# Interface: FindErc20SetWalletParams +# FindErc20SetWalletParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ERC20DividendCheckpointEvents.SetWallet* +• **eventName**: _ERC20DividendCheckpointEvents.SetWallet_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:200](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L200)* +_Defined in_ [_src/utils/index.ts:200_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L200) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.finderc20setwithholdingparams.md b/docs/api/interfaces/_utils_index_.finderc20setwithholdingparams.md index 69f2270..f64630e 100644 --- a/docs/api/interfaces/_utils_index_.finderc20setwithholdingparams.md +++ b/docs/api/interfaces/_utils_index_.finderc20setwithholdingparams.md @@ -1,4 +1,4 @@ -# Interface: FindErc20SetWithholdingParams +# FindErc20SetWithholdingParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ERC20DividendCheckpointEvents.SetWithholding* +• **eventName**: _ERC20DividendCheckpointEvents.SetWithholding_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:208](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L208)* +_Defined in_ [_src/utils/index.ts:208_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L208) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findethdividendclaimedparams.md b/docs/api/interfaces/_utils_index_.findethdividendclaimedparams.md index 961767c..11c359c 100644 --- a/docs/api/interfaces/_utils_index_.findethdividendclaimedparams.md +++ b/docs/api/interfaces/_utils_index_.findethdividendclaimedparams.md @@ -1,4 +1,4 @@ -# Interface: FindEthDividendClaimedParams +# FindEthDividendClaimedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *EtherDividendCheckpointEvents.EtherDividendClaimed* +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendClaimed_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:188](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L188)* +_Defined in_ [_src/utils/index.ts:188_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L188) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findethdividendreclaimedparams.md b/docs/api/interfaces/_utils_index_.findethdividendreclaimedparams.md index b3cbbe4..c523162 100644 --- a/docs/api/interfaces/_utils_index_.findethdividendreclaimedparams.md +++ b/docs/api/interfaces/_utils_index_.findethdividendreclaimedparams.md @@ -1,4 +1,4 @@ -# Interface: FindEthDividendReclaimedParams +# FindEthDividendReclaimedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *EtherDividendCheckpointEvents.EtherDividendReclaimed* +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendReclaimed_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:196](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L196)* +_Defined in_ [_src/utils/index.ts:196_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L196) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findetherdividenddepositedparams.md b/docs/api/interfaces/_utils_index_.findetherdividenddepositedparams.md index 3ebd8d3..45cafcc 100644 --- a/docs/api/interfaces/_utils_index_.findetherdividenddepositedparams.md +++ b/docs/api/interfaces/_utils_index_.findetherdividenddepositedparams.md @@ -1,4 +1,4 @@ -# Interface: FindEtherDividendDepositedParams +# FindEtherDividendDepositedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *EtherDividendCheckpointEvents.EtherDividendDeposited* +• **eventName**: _EtherDividendCheckpointEvents.EtherDividendDeposited_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:156](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L156)* +_Defined in_ [_src/utils/index.ts:156_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L156) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findethsetwalletparams.md b/docs/api/interfaces/_utils_index_.findethsetwalletparams.md index ec7c075..874a485 100644 --- a/docs/api/interfaces/_utils_index_.findethsetwalletparams.md +++ b/docs/api/interfaces/_utils_index_.findethsetwalletparams.md @@ -1,4 +1,4 @@ -# Interface: FindEthSetWalletParams +# FindEthSetWalletParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *EtherDividendCheckpointEvents.SetWallet* +• **eventName**: _EtherDividendCheckpointEvents.SetWallet_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:204](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L204)* +_Defined in_ [_src/utils/index.ts:204_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L204) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findethsetwithholdingparams.md b/docs/api/interfaces/_utils_index_.findethsetwithholdingparams.md index 5e7683d..f3757df 100644 --- a/docs/api/interfaces/_utils_index_.findethsetwithholdingparams.md +++ b/docs/api/interfaces/_utils_index_.findethsetwithholdingparams.md @@ -1,4 +1,4 @@ -# Interface: FindEthSetWithholdingParams +# FindEthSetWithholdingParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *EtherDividendCheckpointEvents.SetWithholding* +• **eventName**: _EtherDividendCheckpointEvents.SetWithholding_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:212](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L212)* +_Defined in_ [_src/utils/index.ts:212_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L212) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findeventparams.md b/docs/api/interfaces/_utils_index_.findeventparams.md index 09de955..91f9bfa 100644 --- a/docs/api/interfaces/_utils_index_.findeventparams.md +++ b/docs/api/interfaces/_utils_index_.findeventparams.md @@ -1,4 +1,4 @@ -# Interface: FindEventParams +# FindEventParams ## Hierarchy @@ -55,16 +55,15 @@ ## Properties -### eventName +### eventName -• **eventName**: *ContractEvents* +• **eventName**: _ContractEvents_ -*Defined in [src/utils/index.ts:128](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L128)* +_Defined in_ [_src/utils/index.ts:128_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L128) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findevents.md b/docs/api/interfaces/_utils_index_.findevents.md index 5f72b48..81fd23f 100644 --- a/docs/api/interfaces/_utils_index_.findevents.md +++ b/docs/api/interfaces/_utils_index_.findevents.md @@ -1,4 +1,4 @@ -# Interface: FindEvents +# FindEvents ## Hierarchy @@ -6,254 +6,255 @@ ## Callable -▸ (`params`: [FindTickerRegisteredParams](_utils_index_.findtickerregisteredparams.md)): *LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›[]* +▸ \(`params`: [FindTickerRegisteredParams](_utils_index_.findtickerregisteredparams.md)\): _LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›\[\]_ -*Defined in [src/utils/index.ts:215](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L215)* +_Defined in_ [_src/utils/index.ts:215_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L215) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindTickerRegisteredParams](_utils_index_.findtickerregisteredparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindTickerRegisteredParams](_utils_index_.findtickerregisteredparams.md) | -**Returns:** *LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹SecurityTokenRegistryRegisterTickerEventArgs›\[\]_ -▸ (`params`: [FindNewSecurityTokenParams](_utils_index_.findnewsecuritytokenparams.md)): *LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›[]* +▸ \(`params`: [FindNewSecurityTokenParams](_utils_index_.findnewsecuritytokenparams.md)\): _LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›\[\]_ -*Defined in [src/utils/index.ts:218](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L218)* +_Defined in_ [_src/utils/index.ts:218_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L218) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindNewSecurityTokenParams](_utils_index_.findnewsecuritytokenparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindNewSecurityTokenParams](_utils_index_.findnewsecuritytokenparams.md) | -**Returns:** *LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹SecurityTokenRegistryNewSecurityTokenEventArgs›\[\]_ -▸ (`params`: [FindModuleAddedParams](_utils_index_.findmoduleaddedparams.md)): *LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›[]* +▸ \(`params`: [FindModuleAddedParams](_utils_index_.findmoduleaddedparams.md)\): _LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:221](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L221)* +_Defined in_ [_src/utils/index.ts:221_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L221) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindModuleAddedParams](_utils_index_.findmoduleaddedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindModuleAddedParams](_utils_index_.findmoduleaddedparams.md) | -**Returns:** *LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹SecurityTokenModuleAddedEventArgs›\[\]_ -▸ (`params`: [FindCheckpointCreatedParams](_utils_index_.findcheckpointcreatedparams.md)): *LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›[]* +▸ \(`params`: [FindCheckpointCreatedParams](_utils_index_.findcheckpointcreatedparams.md)\): _LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:222](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L222)* +_Defined in_ [_src/utils/index.ts:222_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L222) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindCheckpointCreatedParams](_utils_index_.findcheckpointcreatedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindCheckpointCreatedParams](_utils_index_.findcheckpointcreatedparams.md) | -**Returns:** *LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹SecurityTokenCheckpointCreatedEventArgs›\[\]_ -▸ (`params`: [FindControllerTransferParams](_utils_index_.findcontrollertransferparams.md)): *LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›[]* +▸ \(`params`: [FindControllerTransferParams](_utils_index_.findcontrollertransferparams.md)\): _LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›\[\]_ -*Defined in [src/utils/index.ts:225](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L225)* +_Defined in_ [_src/utils/index.ts:225_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L225) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindControllerTransferParams](_utils_index_.findcontrollertransferparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindControllerTransferParams](_utils_index_.findcontrollertransferparams.md) | -**Returns:** *LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹SecurityTokenControllerTransferEventArgs›\[\]_ -▸ (`params`: [FindErc20DividendDepositedParams](_utils_index_.finderc20dividenddepositedparams.md)): *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›[]* +▸ \(`params`: [FindErc20DividendDepositedParams](_utils_index_.finderc20dividenddepositedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:228](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L228)* +_Defined in_ [_src/utils/index.ts:228_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L228) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindErc20DividendDepositedParams](_utils_index_.finderc20dividenddepositedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendDepositedParams](_utils_index_.finderc20dividenddepositedparams.md) | -**Returns:** *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendDepositedEventArgs›\[\]_ -▸ (`params`: [FindEtherDividendDepositedParams](_utils_index_.findetherdividenddepositedparams.md)): *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›[]* +▸ \(`params`: [FindEtherDividendDepositedParams](_utils_index_.findetherdividenddepositedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:231](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L231)* +_Defined in_ [_src/utils/index.ts:231_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L231) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindEtherDividendDepositedParams](_utils_index_.findetherdividenddepositedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindEtherDividendDepositedParams](_utils_index_.findetherdividenddepositedparams.md) | -**Returns:** *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendDepositedEventArgs›\[\]_ -▸ (`params`: [FindModifyKycDataParams](_utils_index_.findmodifykycdataparams.md)): *LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›[]* +▸ \(`params`: [FindModifyKycDataParams](_utils_index_.findmodifykycdataparams.md)\): _LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›\[\]_ -*Defined in [src/utils/index.ts:234](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L234)* +_Defined in_ [_src/utils/index.ts:234_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L234) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindModifyKycDataParams](_utils_index_.findmodifykycdataparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindModifyKycDataParams](_utils_index_.findmodifykycdataparams.md) | -**Returns:** *LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹GeneralTransferManagerModifyKYCDataEventArgs›\[\]_ -▸ (`params`: [FindModifyInvestorFlagParams](_utils_index_.findmodifyinvestorflagparams.md)): *LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›[]* +▸ \(`params`: [FindModifyInvestorFlagParams](_utils_index_.findmodifyinvestorflagparams.md)\): _LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›\[\]_ -*Defined in [src/utils/index.ts:237](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L237)* +_Defined in_ [_src/utils/index.ts:237_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L237) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindModifyInvestorFlagParams](_utils_index_.findmodifyinvestorflagparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindModifyInvestorFlagParams](_utils_index_.findmodifyinvestorflagparams.md) | -**Returns:** *LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹GeneralTransferManagerModifyInvestorFlagEventArgs›\[\]_ -▸ (`params`: [FindCappedStoPauseParams](_utils_index_.findcappedstopauseparams.md)): *LogWithDecodedArgs‹CappedSTOPauseEventArgs›[]* +▸ \(`params`: [FindCappedStoPauseParams](_utils_index_.findcappedstopauseparams.md)\): _LogWithDecodedArgs‹CappedSTOPauseEventArgs›\[\]_ -*Defined in [src/utils/index.ts:240](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L240)* +_Defined in_ [_src/utils/index.ts:240_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L240) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindCappedStoPauseParams](_utils_index_.findcappedstopauseparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindCappedStoPauseParams](_utils_index_.findcappedstopauseparams.md) | -**Returns:** *LogWithDecodedArgs‹CappedSTOPauseEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹CappedSTOPauseEventArgs›\[\]_ -▸ (`params`: [FindCappedStoPreMintAllowedParams](_utils_index_.findcappedstopremintallowedparams.md)): *LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›[]* +▸ \(`params`: [FindCappedStoPreMintAllowedParams](_utils_index_.findcappedstopremintallowedparams.md)\): _LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›\[\]_ -*Defined in [src/utils/index.ts:241](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L241)* +_Defined in_ [_src/utils/index.ts:241_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L241) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindCappedStoPreMintAllowedParams](_utils_index_.findcappedstopremintallowedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindCappedStoPreMintAllowedParams](_utils_index_.findcappedstopremintallowedparams.md) | -**Returns:** *LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹CappedSTOAllowPreMintFlagEventArgs›\[\]_ -▸ (`params`: [FindTieredStoPauseParams](_utils_index_.findtieredstopauseparams.md)): *LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›[]* +▸ \(`params`: [FindTieredStoPauseParams](_utils_index_.findtieredstopauseparams.md)\): _LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›\[\]_ -*Defined in [src/utils/index.ts:244](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L244)* +_Defined in_ [_src/utils/index.ts:244_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L244) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindTieredStoPauseParams](_utils_index_.findtieredstopauseparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindTieredStoPauseParams](_utils_index_.findtieredstopauseparams.md) | -**Returns:** *LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹USDTieredSTOPauseEventArgs›\[\]_ -▸ (`params`: [FindTieredStoPreMintAllowedParams](_utils_index_.findtieredstopremintallowedparams.md)): *LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›[]* +▸ \(`params`: [FindTieredStoPreMintAllowedParams](_utils_index_.findtieredstopremintallowedparams.md)\): _LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›\[\]_ -*Defined in [src/utils/index.ts:245](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L245)* +_Defined in_ [_src/utils/index.ts:245_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L245) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindTieredStoPreMintAllowedParams](_utils_index_.findtieredstopremintallowedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindTieredStoPreMintAllowedParams](_utils_index_.findtieredstopremintallowedparams.md) | -**Returns:** *LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹USDTieredSTOAllowPreMintFlagEventArgs›\[\]_ -▸ (`params`: [FindErc20DividendClaimedParams](_utils_index_.finderc20dividendclaimedparams.md)): *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›[]* +▸ \(`params`: [FindErc20DividendClaimedParams](_utils_index_.finderc20dividendclaimedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:248](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L248)* +_Defined in_ [_src/utils/index.ts:248_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L248) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindErc20DividendClaimedParams](_utils_index_.finderc20dividendclaimedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendClaimedParams](_utils_index_.finderc20dividendclaimedparams.md) | -**Returns:** *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendClaimedEventArgs›\[\]_ -▸ (`params`: [FindEthDividendClaimedParams](_utils_index_.findethdividendclaimedparams.md)): *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›[]* +▸ \(`params`: [FindEthDividendClaimedParams](_utils_index_.findethdividendclaimedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:251](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L251)* +_Defined in_ [_src/utils/index.ts:251_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L251) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindEthDividendClaimedParams](_utils_index_.findethdividendclaimedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindEthDividendClaimedParams](_utils_index_.findethdividendclaimedparams.md) | -**Returns:** *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendClaimedEventArgs›\[\]_ -▸ (`params`: [FindErc20DividendReclaimedParams](_utils_index_.finderc20dividendreclaimedparams.md)): *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›[]* +▸ \(`params`: [FindErc20DividendReclaimedParams](_utils_index_.finderc20dividendreclaimedparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:254](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L254)* +_Defined in_ [_src/utils/index.ts:254_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L254) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindErc20DividendReclaimedParams](_utils_index_.finderc20dividendreclaimedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20DividendReclaimedParams](_utils_index_.finderc20dividendreclaimedparams.md) | -**Returns:** *LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointERC20DividendReclaimedEventArgs›\[\]_ -▸ (`params`: [FindEthDividendReclaimedParams](_utils_index_.findethdividendreclaimedparams.md)): *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›[]* +▸ \(`params`: [FindEthDividendReclaimedParams](_utils_index_.findethdividendreclaimedparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›\[\]_ -*Defined in [src/utils/index.ts:257](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L257)* +_Defined in_ [_src/utils/index.ts:257_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L257) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindEthDividendReclaimedParams](_utils_index_.findethdividendreclaimedparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindEthDividendReclaimedParams](_utils_index_.findethdividendreclaimedparams.md) | -**Returns:** *LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointEtherDividendReclaimedEventArgs›\[\]_ -▸ (`params`: [FindErc20SetWalletParams](_utils_index_.finderc20setwalletparams.md)): *LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›[]* +▸ \(`params`: [FindErc20SetWalletParams](_utils_index_.finderc20setwalletparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›\[\]_ -*Defined in [src/utils/index.ts:260](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L260)* +_Defined in_ [_src/utils/index.ts:260_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L260) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindErc20SetWalletParams](_utils_index_.finderc20setwalletparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20SetWalletParams](_utils_index_.finderc20setwalletparams.md) | -**Returns:** *LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointSetWalletEventArgs›\[\]_ -▸ (`params`: [FindEthSetWalletParams](_utils_index_.findethsetwalletparams.md)): *LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›[]* +▸ \(`params`: [FindEthSetWalletParams](_utils_index_.findethsetwalletparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›\[\]_ -*Defined in [src/utils/index.ts:263](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L263)* +_Defined in_ [_src/utils/index.ts:263_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L263) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindEthSetWalletParams](_utils_index_.findethsetwalletparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindEthSetWalletParams](_utils_index_.findethsetwalletparams.md) | -**Returns:** *LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointSetWalletEventArgs›\[\]_ -▸ (`params`: [FindErc20SetWithholdingParams](_utils_index_.finderc20setwithholdingparams.md)): *LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›[]* +▸ \(`params`: [FindErc20SetWithholdingParams](_utils_index_.finderc20setwithholdingparams.md)\): _LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›\[\]_ -*Defined in [src/utils/index.ts:264](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L264)* +_Defined in_ [_src/utils/index.ts:264_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L264) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindErc20SetWithholdingParams](_utils_index_.finderc20setwithholdingparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindErc20SetWithholdingParams](_utils_index_.finderc20setwithholdingparams.md) | -**Returns:** *LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›[]* +**Returns:** _LogWithDecodedArgs‹ERC20DividendCheckpointSetWithholdingEventArgs›\[\]_ -▸ (`params`: [FindEthSetWithholdingParams](_utils_index_.findethsetwithholdingparams.md)): *LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›[]* +▸ \(`params`: [FindEthSetWithholdingParams](_utils_index_.findethsetwithholdingparams.md)\): _LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›\[\]_ -*Defined in [src/utils/index.ts:267](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L267)* +_Defined in_ [_src/utils/index.ts:267_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L267) **Parameters:** -Name | Type | ------- | ------ | -`params` | [FindEthSetWithholdingParams](_utils_index_.findethsetwithholdingparams.md) | +| Name | Type | +| :--- | :--- | +| `params` | [FindEthSetWithholdingParams](_utils_index_.findethsetwithholdingparams.md) | + +**Returns:** _LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›\[\]_ -**Returns:** *LogWithDecodedArgs‹EtherDividendCheckpointSetWithholdingEventArgs›[]* diff --git a/docs/api/interfaces/_utils_index_.findmodifyinvestorflagparams.md b/docs/api/interfaces/_utils_index_.findmodifyinvestorflagparams.md index 1d6693a..aa05134 100644 --- a/docs/api/interfaces/_utils_index_.findmodifyinvestorflagparams.md +++ b/docs/api/interfaces/_utils_index_.findmodifyinvestorflagparams.md @@ -1,4 +1,4 @@ -# Interface: FindModifyInvestorFlagParams +# FindModifyInvestorFlagParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ModifyInvestorFlag* +• **eventName**: _ModifyInvestorFlag_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L164)* +_Defined in_ [_src/utils/index.ts:164_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L164) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findmodifykycdataparams.md b/docs/api/interfaces/_utils_index_.findmodifykycdataparams.md index 901b88f..f25ae40 100644 --- a/docs/api/interfaces/_utils_index_.findmodifykycdataparams.md +++ b/docs/api/interfaces/_utils_index_.findmodifykycdataparams.md @@ -1,4 +1,4 @@ -# Interface: FindModifyKycDataParams +# FindModifyKycDataParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *ModifyKYCData* +• **eventName**: _ModifyKYCData_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:160](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L160)* +_Defined in_ [_src/utils/index.ts:160_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L160) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findmoduleaddedparams.md b/docs/api/interfaces/_utils_index_.findmoduleaddedparams.md index f684625..c8bf92b 100644 --- a/docs/api/interfaces/_utils_index_.findmoduleaddedparams.md +++ b/docs/api/interfaces/_utils_index_.findmoduleaddedparams.md @@ -1,4 +1,4 @@ -# Interface: FindModuleAddedParams +# FindModuleAddedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *SecurityTokenEvents.ModuleAdded* +• **eventName**: _SecurityTokenEvents.ModuleAdded_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:144](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L144)* +_Defined in_ [_src/utils/index.ts:144_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L144) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findnewsecuritytokenparams.md b/docs/api/interfaces/_utils_index_.findnewsecuritytokenparams.md index 273a14d..bd54d16 100644 --- a/docs/api/interfaces/_utils_index_.findnewsecuritytokenparams.md +++ b/docs/api/interfaces/_utils_index_.findnewsecuritytokenparams.md @@ -1,4 +1,4 @@ -# Interface: FindNewSecurityTokenParams +# FindNewSecurityTokenParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *SecurityTokenRegistryEvents.NewSecurityToken* +• **eventName**: _SecurityTokenRegistryEvents.NewSecurityToken_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:136](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L136)* +_Defined in_ [_src/utils/index.ts:136_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L136) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findtickerregisteredparams.md b/docs/api/interfaces/_utils_index_.findtickerregisteredparams.md index 695a8d4..26cad56 100644 --- a/docs/api/interfaces/_utils_index_.findtickerregisteredparams.md +++ b/docs/api/interfaces/_utils_index_.findtickerregisteredparams.md @@ -1,4 +1,4 @@ -# Interface: FindTickerRegisteredParams +# FindTickerRegisteredParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *SecurityTokenRegistryEvents.RegisterTicker* +• **eventName**: _SecurityTokenRegistryEvents.RegisterTicker_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:132](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L132)* +_Defined in_ [_src/utils/index.ts:132_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L132) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findtieredstopauseparams.md b/docs/api/interfaces/_utils_index_.findtieredstopauseparams.md index 26bb74b..0c72bea 100644 --- a/docs/api/interfaces/_utils_index_.findtieredstopauseparams.md +++ b/docs/api/interfaces/_utils_index_.findtieredstopauseparams.md @@ -1,4 +1,4 @@ -# Interface: FindTieredStoPauseParams +# FindTieredStoPauseParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *Pause* +• **eventName**: _Pause_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:176](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L176)* +_Defined in_ [_src/utils/index.ts:176_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L176) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_utils_index_.findtieredstopremintallowedparams.md b/docs/api/interfaces/_utils_index_.findtieredstopremintallowedparams.md index 337bd4f..57c9c12 100644 --- a/docs/api/interfaces/_utils_index_.findtieredstopremintallowedparams.md +++ b/docs/api/interfaces/_utils_index_.findtieredstopremintallowedparams.md @@ -1,4 +1,4 @@ -# Interface: FindTieredStoPreMintAllowedParams +# FindTieredStoPreMintAllowedParams ## Hierarchy @@ -15,20 +15,19 @@ ## Properties -### eventName +### eventName -• **eventName**: *AllowPreMintFlag* +• **eventName**: _AllowPreMintFlag_ -*Overrides [FindEventParams](_utils_index_.findeventparams.md).[eventName](_utils_index_.findeventparams.md#eventname)* +_Overrides_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_eventName_](_utils_index_.findeventparams.md#eventname) -*Defined in [src/utils/index.ts:180](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L180)* +_Defined in_ [_src/utils/index.ts:180_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L180) -___ +### logs -### logs +• **logs**: _LogEntry \| LogWithDecodedArgs‹DecodedLogArgs›\[\]_ -• **logs**: *LogEntry | LogWithDecodedArgs‹DecodedLogArgs›[]* +_Inherited from_ [_FindEventParams_](_utils_index_.findeventparams.md)_._[_logs_](_utils_index_.findeventparams.md#logs) -*Inherited from [FindEventParams](_utils_index_.findeventparams.md).[logs](_utils_index_.findeventparams.md#logs)* +_Defined in_ [_src/utils/index.ts:127_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127) -*Defined in [src/utils/index.ts:127](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/index.ts#L127)* diff --git a/docs/api/interfaces/_wallet_.args.md b/docs/api/interfaces/_wallet_.args.md index 4a557c8..fa0194c 100644 --- a/docs/api/interfaces/_wallet_.args.md +++ b/docs/api/interfaces/_wallet_.args.md @@ -1,4 +1,4 @@ -# Interface: Args +# Args ## Hierarchy @@ -12,12 +12,13 @@ ## Properties -### address +### address -• **address**: *function* +• **address**: _function_ -*Defined in [src/Wallet.ts:2](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Wallet.ts#L2)* +_Defined in_ [_src/Wallet.ts:2_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/Wallet.ts#L2) #### Type declaration: -▸ (): *Promise‹string›* +▸ \(\): _Promise‹string›_ + diff --git a/docs/api/modules/_browserutils_.md b/docs/api/modules/_browserutils_.md deleted file mode 100644 index bd6ef82..0000000 --- a/docs/api/modules/_browserutils_.md +++ /dev/null @@ -1,92 +0,0 @@ -# External module: "browserUtils" - -## Index - -### Enumerations - -* [BrowserSupport](../enums/_browserutils_.browsersupport.md) - -### Interfaces - -* [Ethereum](../interfaces/_browserutils_.ethereum.md) -* [ExtendedWindow](../interfaces/_browserutils_.extendedwindow.md) -* [InjectedWeb3](../interfaces/_browserutils_.injectedweb3.md) -* [Web3VersionAPI](../interfaces/_browserutils_.web3versionapi.md) -* [WindowWithEthereum](../interfaces/_browserutils_.windowwithethereum.md) -* [WindowWithWeb3](../interfaces/_browserutils_.windowwithweb3.md) - -### Functions - -* [getBrowserSupport](_browserutils_.md#getbrowsersupport) -* [onAddressChange](_browserutils_.md#onaddresschange) -* [onNetworkChange](_browserutils_.md#onnetworkchange) - -## Functions - -### getBrowserSupport - -▸ **getBrowserSupport**(): *[NoMetamask](../enums/_browserutils_.browsersupport.md#nometamask) | [MetamaskLegacy](../enums/_browserutils_.browsersupport.md#metamasklegacy) | [MetamaskModern](../enums/_browserutils_.browsersupport.md#metamaskmodern) | [None](../enums/_browserutils_.browsersupport.md#none)* - -*Defined in [src/browserUtils.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L45)* - -Returns the browser support for Ethereum - -**Returns:** *[NoMetamask](../enums/_browserutils_.browsersupport.md#nometamask) | [MetamaskLegacy](../enums/_browserutils_.browsersupport.md#metamasklegacy) | [MetamaskModern](../enums/_browserutils_.browsersupport.md#metamaskmodern) | [None](../enums/_browserutils_.browsersupport.md#none)* - -___ - -### onAddressChange - -▸ **onAddressChange**(`cb`: function): *(Anonymous function)* - -*Defined in [src/browserUtils.ts:189](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L189)* - -Runs the callback anytime the wallet address changes in the browser - -**Parameters:** - -▪ **cb**: *function* - -callback that receives the new address and the previous one - -▸ (`newAddress`: string, `previousAddress?`: undefined | string): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`newAddress` | string | -`previousAddress?` | undefined | string | - -**Returns:** *(Anonymous function)* - -an unsubscribe function - -___ - -### onNetworkChange - -▸ **onNetworkChange**(`cb`: function): *(Anonymous function)* - -*Defined in [src/browserUtils.ts:225](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/browserUtils.ts#L225)* - -Runs the callback anytime the current network changes in the browser - -**Parameters:** - -▪ **cb**: *function* - -callback that receives the new network id and the previous one - -▸ (`newNetwork`: number, `previousNetwork?`: undefined | number): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`newNetwork` | number | -`previousNetwork?` | undefined | number | - -**Returns:** *(Anonymous function)* - -an unsubscribe function diff --git a/docs/api/modules/_entities_factories_checkpointfactory_.md b/docs/api/modules/_entities_factories_checkpointfactory_.md deleted file mode 100644 index b357912..0000000 --- a/docs/api/modules/_entities_factories_checkpointfactory_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/factories/CheckpointFactory" - - diff --git a/docs/api/modules/_entities_factories_dividenddistributionfactory_.md b/docs/api/modules/_entities_factories_dividenddistributionfactory_.md deleted file mode 100644 index 93d4980..0000000 --- a/docs/api/modules/_entities_factories_dividenddistributionfactory_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/factories/DividendDistributionFactory" - - diff --git a/docs/api/modules/_entities_factories_index_.md b/docs/api/modules/_entities_factories_index_.md deleted file mode 100644 index 23a6e2f..0000000 --- a/docs/api/modules/_entities_factories_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/factories/index" - - diff --git a/docs/api/modules/_entities_factories_investmentfactory_.md b/docs/api/modules/_entities_factories_investmentfactory_.md deleted file mode 100644 index 1d1877a..0000000 --- a/docs/api/modules/_entities_factories_investmentfactory_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "entities/factories/InvestmentFactory" - -## Index - -### Classes - -* [InvestmentFactory](../classes/_entities_factories_investmentfactory_.investmentfactory.md) - -### Variables - -* [weiToValue](_entities_factories_investmentfactory_.md#weitovalue) - -## Variables - -### weiToValue - -• **weiToValue**: *weiToValue* - -*Defined in [src/entities/factories/InvestmentFactory.ts:17](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/factories/InvestmentFactory.ts#L17)* diff --git a/docs/api/modules/_entities_factories_securitytokenfactory_.md b/docs/api/modules/_entities_factories_securitytokenfactory_.md deleted file mode 100644 index 647a28c..0000000 --- a/docs/api/modules/_entities_factories_securitytokenfactory_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/factories/SecurityTokenFactory" - - diff --git a/docs/api/modules/_entities_factories_securitytokenreservationfactory_.md b/docs/api/modules/_entities_factories_securitytokenreservationfactory_.md deleted file mode 100644 index be311a4..0000000 --- a/docs/api/modules/_entities_factories_securitytokenreservationfactory_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/factories/SecurityTokenReservationFactory" - - diff --git a/docs/api/modules/_entities_index_.md b/docs/api/modules/_entities_index_.md deleted file mode 100644 index 6f85597..0000000 --- a/docs/api/modules/_entities_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/index" - - diff --git a/docs/api/modules/_entities_securitytoken_index_.md b/docs/api/modules/_entities_securitytoken_index_.md deleted file mode 100644 index 613976a..0000000 --- a/docs/api/modules/_entities_securitytoken_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/SecurityToken/index" - - diff --git a/docs/api/modules/_entities_securitytoken_issuance_index_.md b/docs/api/modules/_entities_securitytoken_issuance_index_.md deleted file mode 100644 index b2b6e7b..0000000 --- a/docs/api/modules/_entities_securitytoken_issuance_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/SecurityToken/Issuance/index" - - diff --git a/docs/api/modules/_entities_securitytoken_securitytoken_.md b/docs/api/modules/_entities_securitytoken_securitytoken_.md deleted file mode 100644 index c028ef7..0000000 --- a/docs/api/modules/_entities_securitytoken_securitytoken_.md +++ /dev/null @@ -1,53 +0,0 @@ -# External module: "entities/SecurityToken/SecurityToken" - -## Index - -### Classes - -* [SecurityToken](../classes/_entities_securitytoken_securitytoken_.securitytoken.md) - -### Interfaces - -* [Params](../interfaces/_entities_securitytoken_securitytoken_.params.md) -* [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) - -### Functions - -* [isUniqueIdentifiers](_entities_securitytoken_securitytoken_.md#isuniqueidentifiers) -* [unserialize](_entities_securitytoken_securitytoken_.md#const-unserialize) - -## Functions - -### isUniqueIdentifiers - -▸ **isUniqueIdentifiers**(`identifiers`: any): *identifiers is UniqueIdentifiers* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:30](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L30)* - -Check if the provided value is of type [UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md) - -**Parameters:** - -Name | Type | ------- | ------ | -`identifiers` | any | - -**Returns:** *identifiers is UniqueIdentifiers* - -___ - -### `Const` unserialize - -▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md)* - -*Defined in [src/entities/SecurityToken/SecurityToken.ts:72](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SecurityToken.ts#L72)* - -Unserialize string to a Security Token object representation - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`serialized` | string | Security Token's serialized representation | - -**Returns:** *[UniqueIdentifiers](../interfaces/_entities_securitytoken_securitytoken_.uniqueidentifiers.md)* diff --git a/docs/api/modules/_entities_securitytoken_transfers_index_.md b/docs/api/modules/_entities_securitytoken_transfers_index_.md deleted file mode 100644 index 3ea077f..0000000 --- a/docs/api/modules/_entities_securitytoken_transfers_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/SecurityToken/Transfers/index" - - diff --git a/docs/api/modules/_entities_securitytoken_transfers_restrictions_index_.md b/docs/api/modules/_entities_securitytoken_transfers_restrictions_index_.md deleted file mode 100644 index 86ff936..0000000 --- a/docs/api/modules/_entities_securitytoken_transfers_restrictions_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "entities/SecurityToken/Transfers/Restrictions/index" - - diff --git a/docs/api/modules/_index_.md b/docs/api/modules/_index_.md deleted file mode 100644 index 9dae99a..0000000 --- a/docs/api/modules/_index_.md +++ /dev/null @@ -1,24 +0,0 @@ -# External module: "index" - -## Index - -### Variables - -* [browserUtils](_index_.md#const-browserutils) -* [isNode](_index_.md#const-isnode) - -## Variables - -### `Const` browserUtils - -• **browserUtils**: *any* = isNode ? null : require('./browserUtils') - -*Defined in [src/index.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/index.ts#L9)* - -___ - -### `Const` isNode - -• **isNode**: *boolean* = typeof window === 'undefined' - -*Defined in [src/index.ts:7](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/index.ts#L7)* diff --git a/docs/api/modules/_polymatherror_.md b/docs/api/modules/_polymatherror_.md deleted file mode 100644 index 6fd3557..0000000 --- a/docs/api/modules/_polymatherror_.md +++ /dev/null @@ -1,39 +0,0 @@ -# External module: "PolymathError" - -## Index - -### Classes - -* [PolymathError](../classes/_polymatherror_.polymatherror.md) - -### Object literals - -* [ErrorMessagesPerCode](_polymatherror_.md#const-errormessagespercode) - -## Object literals - -### `Const` ErrorMessagesPerCode - -### ▪ **ErrorMessagesPerCode**: *object* - -*Defined in [src/PolymathError.ts:3](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L3)* - -### __computed - -• **__computed**: *string* = "You must install the Metamask browser extension if attempting to use Polymath SDK from the browser" - -*Defined in [src/PolymathError.ts:6](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L6)* - -*Defined in [src/PolymathError.ts:7](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L7)* - -*Defined in [src/PolymathError.ts:9](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L9)* - -*Defined in [src/PolymathError.ts:10](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L10)* - -*Defined in [src/PolymathError.ts:11](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L11)* - -*Defined in [src/PolymathError.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L13)* - -*Defined in [src/PolymathError.ts:14](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L14)* - -*Defined in [src/PolymathError.ts:16](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/PolymathError.ts#L16)* diff --git a/docs/api/modules/_posttransactionresolver_.md b/docs/api/modules/_posttransactionresolver_.md deleted file mode 100644 index 0f4b7ce..0000000 --- a/docs/api/modules/_posttransactionresolver_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "PostTransactionResolver" - - diff --git a/docs/api/modules/_procedures_index_.md b/docs/api/modules/_procedures_index_.md deleted file mode 100644 index 7331028..0000000 --- a/docs/api/modules/_procedures_index_.md +++ /dev/null @@ -1,3 +0,0 @@ -# External module: "procedures/index" - - diff --git a/docs/api/modules/_procedures_modifydividendsdefaultexclusionlist_.md b/docs/api/modules/_procedures_modifydividendsdefaultexclusionlist_.md deleted file mode 100644 index 3cb3318..0000000 --- a/docs/api/modules/_procedures_modifydividendsdefaultexclusionlist_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "procedures/ModifyDividendsDefaultExclusionList" - -## Index - -### Classes - -* [ModifyDividendsDefaultExclusionList](../classes/_procedures_modifydividendsdefaultexclusionlist_.modifydividendsdefaultexclusionlist.md) - -### Variables - -* [CHUNK_SIZE](_procedures_modifydividendsdefaultexclusionlist_.md#const-chunk_size) - -## Variables - -### `Const` CHUNK_SIZE - -• **CHUNK_SIZE**: *200* = 200 - -*Defined in [src/procedures/ModifyDividendsDefaultExclusionList.ts:13](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyDividendsDefaultExclusionList.ts#L13)* diff --git a/docs/api/modules/_procedures_modifytokenholderdata_.md b/docs/api/modules/_procedures_modifytokenholderdata_.md deleted file mode 100644 index d75e901..0000000 --- a/docs/api/modules/_procedures_modifytokenholderdata_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "procedures/ModifyTokenholderData" - -## Index - -### Classes - -* [ModifyTokenholderData](../classes/_procedures_modifytokenholderdata_.modifytokenholderdata.md) - -### Variables - -* [dateToBigNumber](_procedures_modifytokenholderdata_.md#datetobignumber) - -## Variables - -### dateToBigNumber - -• **dateToBigNumber**: *dateToBigNumber* - -*Defined in [src/procedures/ModifyTokenholderData.ts:18](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ModifyTokenholderData.ts#L18)* diff --git a/docs/api/modules/_procedures_pushdividendpayment_.md b/docs/api/modules/_procedures_pushdividendpayment_.md deleted file mode 100644 index 3c61277..0000000 --- a/docs/api/modules/_procedures_pushdividendpayment_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "procedures/PushDividendPayment" - -## Index - -### Classes - -* [PushDividendPayment](../classes/_procedures_pushdividendpayment_.pushdividendpayment.md) - -### Variables - -* [CHUNK_SIZE](_procedures_pushdividendpayment_.md#const-chunk_size) - -## Variables - -### `Const` CHUNK_SIZE - -• **CHUNK_SIZE**: *100* = 100 - -*Defined in [src/procedures/PushDividendPayment.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/PushDividendPayment.ts#L15)* diff --git a/docs/api/modules/_procedures_reservesecuritytoken_.md b/docs/api/modules/_procedures_reservesecuritytoken_.md deleted file mode 100644 index aaf3f78..0000000 --- a/docs/api/modules/_procedures_reservesecuritytoken_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "procedures/ReserveSecurityToken" - -## Index - -### Classes - -* [ReserveSecurityToken](../classes/_procedures_reservesecuritytoken_.reservesecuritytoken.md) - -### Variables - -* [bigNumberToDate](_procedures_reservesecuritytoken_.md#bignumbertodate) - -## Variables - -### bigNumberToDate - -• **bigNumberToDate**: *bigNumberToDate* - -*Defined in [src/procedures/ReserveSecurityToken.ts:19](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/ReserveSecurityToken.ts#L19)* diff --git a/docs/api/modules/_procedures_updatedividendstaxwithholdinglist_.md b/docs/api/modules/_procedures_updatedividendstaxwithholdinglist_.md deleted file mode 100644 index 7fb2507..0000000 --- a/docs/api/modules/_procedures_updatedividendstaxwithholdinglist_.md +++ /dev/null @@ -1,19 +0,0 @@ -# External module: "procedures/UpdateDividendsTaxWithholdingList" - -## Index - -### Classes - -* [UpdateDividendsTaxWithholdingList](../classes/_procedures_updatedividendstaxwithholdinglist_.updatedividendstaxwithholdinglist.md) - -### Variables - -* [CHUNK_SIZE](_procedures_updatedividendstaxwithholdinglist_.md#const-chunk_size) - -## Variables - -### `Const` CHUNK_SIZE - -• **CHUNK_SIZE**: *200* = 200 - -*Defined in [src/procedures/UpdateDividendsTaxWithholdingList.ts:15](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/UpdateDividendsTaxWithholdingList.ts#L15)* diff --git a/docs/api/modules/_utils_constants_.md b/docs/api/modules/_utils_constants_.md deleted file mode 100644 index 71fb816..0000000 --- a/docs/api/modules/_utils_constants_.md +++ /dev/null @@ -1,24 +0,0 @@ -# External module: "utils/constants" - -## Index - -### Variables - -* [FULL_DECIMALS](_utils_constants_.md#const-full_decimals) -* [ZERO_ADDRESS](_utils_constants_.md#const-zero_address) - -## Variables - -### `Const` FULL_DECIMALS - -• **FULL_DECIMALS**: *BigNumber* = new BigNumber(18) - -*Defined in [src/utils/constants.ts:3](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/constants.ts#L3)* - -___ - -### `Const` ZERO_ADDRESS - -• **ZERO_ADDRESS**: *"0x0000000000000000000000000000000000000000"* = "0x0000000000000000000000000000000000000000" - -*Defined in [src/utils/constants.ts:4](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/utils/constants.ts#L4)*