Skip to content

@armada/sdk / index / createTransferNote

Function: createTransferNote() ​

createTransferNote(params): TransactNote

Defined in: src/sync/note-crypto.ts:61

Build a transfer note with the wallet-source tag set (required for V2 annotation data). Sender address is hidden by default (showSenderAddressToRecipient=false), matching the privacy default. outputType (default Transfer) rides in the annotation data — encrypted to the SENDER's own viewing key — and is what classifies the note as a recipient transfer / broadcaster fee / change when the author recovers its own send history (tryDecryptSentCommitment).

Parameters ​

params ​

receiverAddressData ​

AddressData

senderAddressData? ​

AddressData

value ​

bigint

tokenData ​

TokenData

memoText? ​

string

showSenderAddressToRecipient? ​

boolean

outputType? ​

OutputType

Returns ​

TransactNote