Transfers
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all Transfer related functionality
↳ Transfers
Create a new Transfers instance
Parameters:
Name
Type
securityToken
context
Protected contextProtected securityToken▸ canTransfer(args: object): Promise‹object›
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 transfers of the security token
▸ frozen(): Promise‹boolean›
Retrieve whether the transfer of tokens is frozen or not Can be modified with freeze and unfreeze
Returns: Promise‹boolean›
Private getStatusCodeParameters:
Name
Type
statusCode
RawTransferStatusCode
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
validFrom
Date
validTo
Date
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
Unfreeze transfers of the security token
+ new Transfers(securityToken: , context: ):
Overrides .
Defined in
Returns:
• context:
Inherited from .
Defined in
• restrictions:
Defined in
• securityToken:
Inherited from .
Defined in
Defined in
▸ freeze(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Defined in
â–¸ getStatusCode(statusCode: RawTransferStatusCode):
Defined in
Returns:
▸ signKycData(args: object): Promise‹‹, void››
Defined in
‹‹, "canBuyFromSto"›, "isAccredited"›[]
Returns: Promise‹‹, void››
▸ transfer(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ unfreeze(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››