Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 4.15 KB

TransferRequest.md

File metadata and controls

30 lines (18 loc) · 4.15 KB
Raw

TransferRequest

Properties

Name Type Description Notes
waitForConfirmation Boolean Whether to wait for the transaction to be confirmed on the blockchain or simply be processed. Processed means that our node has picked up the transaction request, but not that it was confirmed by the Solana cluster. Confirmed means that the cluster voted on your transaction and approved it. To be completely sure that the transaction succeeded, you can either set `wait_for_confirmation=True` (call takes 20 seconds with True; about 4 seconds for processed) or you can get the transaction metadata using the signature in the response returned. Once it returns the metadata, then the transaction should have succeeded. [optional]
recipientAddress String The public key address of the recipient to whom you want to send a token or NFT
wallet Wallet [optional]
tokenAddress String If you're transfering an NFT, supply the `mint` (the address of the mint) for the `token_address`. If you're transfering a token, supply the token address found on the explorer (e.g., see `SRMuApVNdxXokk5GT7XD5cUUgXMBCoAz2LHeuAoKWRt` for <a href=&quot;https://explorer.solana.com/address/SRMuApVNdxXokk5GT7XD5cUUgXMBCoAz2LHeuAoKWRt\" target=&quot;_blank&quot;>Serum Token</a>) for the `token_address`. If you're transferring SOL, do not supply a value for `token_address`. [optional]
network NetworkEnum [optional]
amount String This value must be a string. What you provide here depends on if you are sending an NFT, an SPL token, or SOL. - NFT: This must be '1'. - SPL Token: This must be an integer in string format. To convert from what you see on a wallet UI (e.g., 1 ATLAS, 1 USDC) to an integer value, you have to multiply that value by 10^<i>x</i> where <i>x</i> is the number of decimals. For example, to transfer 0.2 USDC, if USDC uses 6 decimals, then the amount is 0.2 * 10^6 = 200000. You can get the number of decimals for a given SPL token <a href=&quot;#operation/solanaGetSPLToken&quot;>here</a>. - SOL: Supply this value denominated in SOL in a string format. This does not need to be an integer. For example, if you want to send 0.0005 SOL, then amount = &quot;0.0005&quot;. [optional]
returnCompiledTransaction Boolean If `false`, we sign and submit the transaction (`wallet` is required in this case; do not provide a value for `sender_public_key`). If `true`, we compile the transaction (either `wallet` or `sender_public_key` is required in this case; do not provide both). [optional]
senderPublicKey String To understand the purpose of `sender_public_key` first note the following: There are two ways you can complete a transfer transaction: (1) we complete it for you with your `wallet` information or (2) we return the raw instruction data that you can sign and submit yourself (no private keys required). When you provide your `wallet` authentication, we are able to determine your wallet's public key, which is the sender public key of the transaction. When you are not providing your `wallet` as authentication, we still need the `sender_public_key` to be able to return the compiled transaction. Thus, you provide `sender_public_key` only if you are not providing `wallet` authentication information and you are returning a compiled transaction. You will receive an error if you provide both `wallet` and `sender_public_key`. You will receive an error if you provide neither `wallet` nor `sender_public_key`. [optional]
feePayerWallet FeePayerWallet [optional]

Enum: NetworkEnum

Name Value
DEVNET "devnet"
MAINNET_BETA "mainnet-beta"