Preparing search index...
The search index is not available
Stacks.js
Stacks.js
@stacks/transactions
createTokenTransferPayload
Function createTokenTransferPayload
create
Token
Transfer
Payload
(
recipient
,
amount
,
memo
?
)
:
TokenTransferPayloadWire
Parameters
recipient
:
string
|
PrincipalCV
amount
:
IntegerType
Optional
memo
:
string
|
MemoStringWire
Returns
TokenTransferPayloadWire
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
Stacks.js
@stacks/api
@stacks/auth
@stacks/encryption
@stacks/network
@stacks/stacking
@stacks/transactions
Address
Cl
Pc
Address
Hash
Mode
Address
Version
Anchor
Mode
Asset
Type
Auth
Field
Type
Auth
Type
Clarity
Abi
Type
Id
Clarity
Type
Clarity
Version
Clarity
Wire
Type
Fungible
Condition
Code
Non
Fungible
Condition
Code
Payload
Type
Post
Condition
Mode
Post
Condition
Principal
Id
Post
Condition
Type
Pub
Key
Encoding
Stacks
Wire
Type
Tenure
Change
Cause
Stacks
Transaction
Transaction
Signer
Address
Wire
Base
Contract
Deploy
Options
BufferCV
Clarity
Abi
Clarity
Abi
Function
Clarity
Abi
Map
Clarity
Abi
Type
Fungible
Token
Clarity
Abi
Type
Non
Fungible
Token
Clarity
Abi
Variable
Coinbase
Payload
To
Alt
Recipient
Coinbase
Payload
Wire
Contract
Call
Options
Contract
Call
Payload
Contract
Deploy
Options
Contract
PrincipalCV
FalseCV
Fee
Estimate
Response
Fee
Estimation
IntCV
Length
Prefixed
List
ListCV
Memo
String
Wire
Message
Signature
Wire
Multi
Sig
Options
Multi
Sig
Spending
Condition
Multi
Sig
Spending
Condition
Opts
Nakamoto
Coinbase
Payload
Wire
NoneCV
Poison
Payload
Wire
Public
Key
Wire
Read
Only
Function
Error
Response
Read
Only
Function
Options
Read
Only
Function
Success
Response
Response
ErrorCV
Response
OkCV
Signed
Contract
Call
Options
Signed
Contract
Deploy
Options
Signed
Token
Transfer
Options
Single
Sig
Spending
Condition
Single
Sig
Spending
Condition
Opts
Smart
Contract
Payload
Wire
SomeCV
Sponsor
Options
Opts
Sponsored
Authorization
Standard
Authorization
Standard
PrincipalCV
String
AsciiCV
String
Utf8CV
Structured
Data
Signature
Wire
Stx
Post
Condition
Tenure
Change
Payload
Wire
Token
Transfer
Payload
Wire
Transaction
Auth
Field
Wire
TrueCV
TupleCV
UIntCV
Unsigned
Contract
Call
Options
Unsigned
Contract
Deploy
Options
Unsigned
Multi
Sig
Options
Unsigned
Token
Transfer
Options
Versioned
Smart
Contract
Payload
Wire
Address
String
Anchor
Mode
Name
Asset
String
Authorization
Bad
Address
Version
Byte
Rejection
Bad
Function
Argument
Rejection
Bad
Nonce
Rejection
Base
Rejection
BooleanCV
Clarity
Abi
Type
Clarity
Abi
Type
Bool
Clarity
Abi
Type
Buffer
Clarity
Abi
Type
Int128
Clarity
Abi
Type
List
Clarity
Abi
Type
None
Clarity
Abi
Type
Optional
Clarity
Abi
Type
Primitive
Clarity
Abi
Type
Principal
Clarity
Abi
Type
Response
Clarity
Abi
Type
String
Ascii
Clarity
Abi
Type
String
Utf8
Clarity
Abi
Type
Trait
Reference
Clarity
Abi
Type
Tuple
Clarity
Abi
TypeUInt128
Clarity
Abi
Type
Union
Clarity
Value
Contract
Already
Exists
Rejection
Contract
Id
String
Decoded
Structured
Data
Deserialization
Rejection
Fee
Too
Low
Rejection
Fungible
Comparator
Fungible
Post
Condition
Multi
Sig
Hash
Mode
No
Coinbase
Via
Mempool
Rejection
No
Such
Contract
Rejection
No
Such
Public
Function
Rejection
Non
Fungible
Comparator
Non
Fungible
Post
Condition
Not
Enough
Funds
Rejection
OptionalCV
Payload
Input
Payload
Wire
Poison
Microblock
Has
Unknown
Pub
Key
Hash
Rejection
Poison
Microblock
Is
Invalid
Rejection
Poison
Microblocks
Do
Not
Conflict
Rejection
Post
Condition
PrincipalCV
Read
Only
Function
Response
ResponseCV
Serialization
Rejection
Server
Failure
Database
Rejection
Server
Failure
No
Such
Chain
Tip
Rejection
Server
Failure
Other
Rejection
Signature
Validation
Rejection
Signed
Multi
Sig
Contract
Call
Options
Signed
Multi
Sig
Contract
Deploy
Options
Signed
Multi
Sig
Options
Signed
Multi
Sig
Token
Transfer
Options
Single
Sig
Hash
Mode
Spending
Condition
Spending
Condition
Opts
Token
Transfer
Options
Transaction
Auth
Field
Contents
Wire
Tuple
Data
Tx
Broadcast
Result
Tx
Broadcast
Result
Ok
Tx
Broadcast
Result
Rejected
Unsigned
Multi
Sig
Contract
Call
Options
Unsigned
Multi
Sig
Contract
Deploy
Options
Unsigned
Multi
Sig
Token
Transfer
Options
ACCOUNT_
PATH
Anchor
Mode
Names
BROADCAST_
PATH
CLARITY_
INT_
BYTE_
SIZE
CLARITY_
INT_
SIZE
COINBASE_
BYTES_
LENGTH
COMPRESSED_
PUBKEY_
LENGTH_
BYTES
CONTRACT_
ABI_
PATH
MAP_
ENTRY_
PATH
MAX_
STRING_
LENGTH_
BYTES
MEMO_
MAX_
LENGTH_
BYTES
READONLY_
FUNCTION_
CALL_
PATH
RECOVERABLE_
ECDSA_
SIG_
LENGTH_
BYTES
STRUCTURED_
DATA_
PREFIX
TRANSACTION_
FEE_
ESTIMATE_
PATH
TRANSFER_
FEE_
ESTIMATE_
PATH
UNCOMPRESSED_
PUBKEY_
LENGTH_
BYTES
VRF_
PROOF_
BYTES_
LENGTH
abi
Function
To
String
address
From
Hash
Mode
address
From
Public
Keys
address
From
Version
Hash
address
Hash
Mode
To
Version
address
To
String
boolCV
broadcast
Transaction
bufferCV
bufferCVFrom
String
code
Body
String
compress
Public
Key
contract
PrincipalCV
contract
PrincipalCVFrom
Address
contract
PrincipalCVFrom
Standard
create
Coinbase
Payload
create
Contract
Call
Payload
create
Empty
Address
createLPList
create
Memo
String
create
Message
Signature
create
Multi
Sig
Spending
Condition
create
Nakamoto
Coinbase
Payload
create
Poison
Payload
create
Single
Sig
Spending
Condition
create
Smart
Contract
Payload
create
Spending
Condition
create
Sponsored
Auth
create
Stacks
Public
Key
create
Standard
Auth
create
Tenure
Change
Payload
create
Token
Transfer
Payload
create
Transaction
Auth
Field
cv
To
Hex
cv
ToJSON
cv
To
String
cv
To
Value
decode
Structured
Data
Signature
deserialize
Address
deserialize
Asset
deserialize
Authorization
deserializeCV
deserializeLPList
deserializeLPString
deserialize
Memo
String
deserialize
Message
Signature
deserialize
Multi
Sig
Spending
Condition
deserialize
Payload
deserialize
Post
Condition
deserialize
Principal
deserialize
Public
Key
deserialize
Single
Sig
Spending
Condition
deserialize
Spending
Condition
deserialize
Transaction
deserialize
Transaction
Auth
Field
empty
Message
Signature
encode
Abi
Clarity
Value
encode
Clarity
Value
encode
Structured
Data
estimate
Transaction
Byte
Length
exceeds
Max
Length
Bytes
falseCV
fetch
Abi
fetch
Call
Read
Only
Function
fetch
Contract
Map
Entry
fetch
Fee
Estimate
fetch
Fee
Estimate
Transaction
fetch
Fee
Estimate
Transfer
fetch
Nonce
get
Address
From
Private
Key
get
Address
From
Public
Key
getCVType
String
get
Fee
get
Type
String
get
Type
Union
hash160
hash
Structured
Data
hex
ToCV
intCV
into
Initial
Sighash
Auth
is
Clarity
Abi
Buffer
is
Clarity
Abi
List
is
Clarity
Abi
Optional
is
Clarity
Abi
Primitive
is
Clarity
Abi
Response
is
Clarity
Abi
String
Ascii
is
Clarity
Abi
String
Utf8
is
Clarity
Abi
Tuple
is
Clarity
Name
is
Clarity
Type
is
Coinbase
Payload
is
Contract
Call
Payload
is
Poison
Payload
is
Private
Key
Compressed
is
Public
Key
Compressed
is
Smart
Contract
Payload
is
Token
Transfer
Payload
left
Pad
Hex
left
Pad
Hex
To
Length
listCV
make
Contract
Call
make
Contract
Deploy
make
Random
Priv
Key
makeSTXToken
Transfer
make
Sig
Hash
Pre
Sign
make
Unsigned
Contract
Call
make
Unsigned
Contract
Deploy
make
UnsignedSTXToken
Transfer
next
Signature
next
Verification
noneCV
omit
optionalCVOf
parse
Read
Only
Response
parse
ToCV
post
Condition
To
Hex
principalCV
private
Key
Is
Compressed
private
Key
To
Address
private
Key
To
Hex
private
Key
To
Public
public
Key
From
Signature
Rsv
public
Key
From
Signature
Vrs
public
Key
Is
Compressed
public
Key
To
Address
public
Key
To
Address
Single
Sig
public
Key
To
Hex
random
Bytes
response
ErrorCV
response
OkCV
right
Pad
Hex
To
Length
serialize
Address
serialize
Asset
serialize
Authorization
serializeCV
serializeLPList
serializeLPString
serialize
Memo
String
serialize
Message
Signature
serialize
Multi
Sig
Spending
Condition
serialize
Payload
serialize
Post
Condition
serialize
Principal
serialize
Public
Key
serialize
Single
Sig
Spending
Condition
serialize
Spending
Condition
serialize
Transaction
serialize
Transaction
Auth
Field
serialize
Transaction
Bytes
set
Fee
set
Nonce
set
Sponsor
set
Sponsor
Nonce
sign
Message
Hash
Rsv
sign
Structured
Data
sign
With
Key
someCV
sponsor
Transaction
standard
PrincipalCV
standard
PrincipalCVFrom
Address
string
AsciiCV
string
Utf8CV
transaction
To
Hex
trueCV
tupleCV
txid
From
Bytes
txid
From
Data
uintCV
uncompress
Public
Key
validate
Contract
Call
validate
Stacks
Address
verify
Origin
verify
Signature
when
Wire
Type
@stacks/bns
@stacks/common
@stacks/profile
@stacks/storage
@stacks/wallet-
sdk
Generated using
TypeDoc