ToggleFreezeTransfers
Procedure that toggles whether transfers of a Security Token are frozen or no
Type parameters
▪ ReturnType
Hierarchy
Procedure‹ToggleFreezeTransfersProcedureArgs›
↳ ToggleFreezeTransfers
Index
Constructors
constructor
Properties
args
context
type
Methods
addProcedure
addSignatureRequest
addTransaction
prepare
prepareTransactions
Constructors
constructor
+ new ToggleFreezeTransfers(args
: ToggleFreezeTransfersProcedureArgs, context
: Context): ToggleFreezeTransfers
Inherited from void
Defined in src/procedures/Procedure.ts:40
Parameters:
Name | Type |
| ToggleFreezeTransfersProcedureArgs |
| Context |
Returns: ToggleFreezeTransfers
Properties
Protected
args
Protected
args• args: ToggleFreezeTransfersProcedureArgs
Inherited from void
Defined in src/procedures/Procedure.ts:34
Protected
context
Protected
context• context: Context
Inherited from void
Defined in src/procedures/Procedure.ts:36
type
• type: ProcedureType = ProcedureType.ToggleFreezeTransfers
Overrides void
Defined in src/procedures/ToggleFreezeTransfers.ts:26
Methods
addProcedure
▸ addProcedure<A, R>(Proc
: ProcedureClass‹A, R›): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:91
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 |
| ProcedureClass‹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‹A›): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:179
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 |
| 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‹A› | FutureLowLevelMethod‹V, A›, __namedParameters
: object): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:137
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‹A› | FutureLowLevelMethod‹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 |
| undefined | Fees | - |
| object | ([] as unknown) as ResolverArray |
| undefined | Any | GetTokens | ApproveErc20 | TransferErc20 | ReserveSecurityToken | CreateSecurityToken | CreateCheckpoint | CreateErc20DividendDistribution | SetErc20TaxWithholding | SetEtherTaxWithholding | SetDefaultExcluded | EnableDividends | EnableCappedSto | EnableTieredSto | EnableGeneralPermissionManager | EnableGeneralTransferManager | EnableCountTransferManager | EnablePercentageTransferManager | DisableController | FreezeIssuance | DisableFeature | ReclaimDividendFunds | WithdrawTaxWithholdings | PushDividendPayment | PullDividendPayment | SetDividendsWallet | AddDelegate | ChangePermission | ControllerTransfer | ControllerRedeem | PauseSto | UnpauseSto | FinalizeSto | SetController | SetDocument | RemoveDocument | ModifyKycDataMulti | ModifyInvestorFlagMulti | IssueMulti | AllowPreMinting | RevokePreMinting | ChangeAllowBeneficialInvestments | ModifyTimes | ModifyFunding | ModifyAddresses | ModifyTiers | ModifyLimits | ModifyOracles | BuyWithScRateLimited | BuyWithPolyRateLimited | BuyWithEthRateLimited | BuyTokens | BuyTokensWithPoly | ChangeHolderCount | ChangeHolderPercentage | ModifyWhitelistMulti | SetAllowPrimaryIssuance | TransferSecurityTokens | UnfreezeTransfers | FreezeTransfers | Signature | TransferReservationOwnership | 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‹Args, ReturnType››
Inherited from void
Defined in src/procedures/Procedure.ts:52
Mandatory method that builds a list of transactions that will be run
Returns: Promise‹TransactionQueue‹Args, ReturnType››
prepareTransactions
▸ prepareTransactions(): Promise‹void›
Overrides void
Defined in src/procedures/ToggleFreezeTransfers.ts:35
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›
Last updated