🔗btc
Last updated
Last updated
The transfer
function is an asynchronous function that facilitates the transfer of a specified value of a cryptocurrency (Bitcoin) from one address to another.
Parameter | Data Type | Description |
---|---|---|
Field | Data Type | Description |
---|---|---|
Before making requests with Nest SDK, you must have it installed.
You can install Nest SDK using either npm
or yarn
. Use the following commands to install Nest SDK:
Here is an example of how to make a transfer
request using the Nest SDK:
Transfer Bitcoin: The transfer
function can be used to transfer a specific amount of Bitcoin from one address to another. It requires the private key of the sender's address, the amount to be transferred, the recipient's address, the desired environment (e.g., testnet or mainnet), the sender's address, and the ECC object for cryptographic operations.
Error Handling: The function handles potential errors during the transfer process. If any step fails, an error object with a code and description is returned, indicating the cause of the failure.
privateKey
string
The private key of the sender's address, required to sign the transaction and prove ownership of the funds.
value
string
The amount of Bitcoin to be transferred.
receiver
string
The address of the recipient where the funds will be transferred.
env
string
The environment or network in which the transaction will be executed (e.g., 'mainnet', 'testnet', etc.).
address
string
The sender's address from which the funds will be transferred.
ecc
any
An object representing the elliptic curve cryptography (ECC) implementation or library used for key operations.
tx
any
The transaction object that contains the necessary information for the transfer, such as inputs, outputs, and transaction details.
toSign
any
Data that needs to be signed by the private key to generate valid signatures. This typically includes transaction information and script data.
signatures
any
Signatures generated by the private key for the transaction. These signatures are used to verify the authenticity and authorization of the sender.
pubkeys
any
Public keys associated with the private key used to generate the signatures. These are used to verify the signatures and ensure they correspond to the correct private key and address.