TransferSecurityTokens

Procedure that transfer security tokens

Type parameters

▪ ReturnType

Hierarchy

• Procedure‹TransferSecurityTokensProcedureArgs›

  ↳ TransferSecurityTokens

Index

Constructors

• constructor

Properties

• args

• context

• type

Methods

• addProcedure

• addSignatureRequest

• addTransaction

• prepare

• prepareTransactions

Constructors

constructor

+ new TransferSecurityTokens(args: TransferSecurityTokensProcedureArgs, context: Context): TransferSecurityTokens

Inherited from void

Defined in src/procedures/Procedure.ts:40

Parameters:

Name	Type
args	TransferSecurityTokensProcedureArgs
context	Context

Returns: TransferSecurityTokens

Properties

Protected args

• args: TransferSecurityTokensProcedureArgs

Inherited from void

Defined in src/procedures/Procedure.ts:34

Protected context

• context: Context

Inherited from void

Defined in src/procedures/Procedure.ts:36

type

• type: ProcedureType = ProcedureType.TransferSecurityTokens

Overrides void

Defined in src/procedures/TransferSecurityTokens.ts:43

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
Proc	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
request	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‹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
fees	undefined | Fees	-
resolvers	object	([] as unknown) as ResolverArray
tag	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/TransferSecurityTokens.ts:70

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›