Transfers

Namespace that handles all Transfer related functionality

Hierarchy

• SubModule

  ↳ Transfers

Index

Constructors

• constructor

Properties

• context

• restrictions

• securityToken

Methods

• canTransfer

• freeze

• frozen

• getStatusCode

• signKycData

• transfer

• unfreeze

Constructors

constructor

+ new Transfers(securityToken: SecurityToken, context: Context): Transfers

Overrides SubModule.constructor

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:21

Create a new Transfers instance

Parameters:

Name	Type
securityToken	SecurityToken
context	Context

Returns: Transfers

Properties

Protected context

• context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

restrictions

• restrictions: Restrictions

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:21

Protected securityToken

• securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

canTransfer

▸ canTransfer(args: object): Promise‹object›

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:130

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‹ToggleFreezeTransfersProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:114

Freeze transfers of the security token

Returns: Promise‹TransactionQueue‹ToggleFreezeTransfersProcedureArgs, void››

frozen

▸ frozen(): Promise‹boolean›

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:89

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

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:168

Parameters:

Name	Type
statusCode	RawTransferStatusCode

Returns: TransferStatusCode

signKycData

▸ signKycData(args: object): Promise‹TransactionQueue‹SignTransferDataProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:47

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‹Omit‹TokenholderDataEntry, "canBuyFromSto"›, "isAccredited"›[]
validFrom	Date
validTo	Date

Returns: Promise‹TransactionQueue‹SignTransferDataProcedureArgs, void››

transfer

▸ transfer(args: object): Promise‹TransactionQueue‹TransferSecurityTokensProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:72

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‹TransferSecurityTokensProcedureArgs, void››

unfreeze

▸ unfreeze(): Promise‹TransactionQueue‹ToggleFreezeTransfersProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Transfers.ts:201

Unfreeze transfers of the security token

Returns: Promise‹TransactionQueue‹ToggleFreezeTransfersProcedureArgs, void››