Class StacksTransaction

constructor

• new StacksTransaction(version, auth, payload, postConditions?, postConditionMode?, anchorMode?, chainId?): StacksTransaction

• Parameters

  • version: TransactionVersion

  • auth: Authorization

  • payload: PayloadInput

  • Optional postConditions: LengthPrefixedList

  • Optional postConditionMode: PostConditionMode

  • Optional anchorMode: "onChainOnly" | "offChainOnly" | "any" | AnchorMode

  • Optional chainId: ChainId

  Returns StacksTransaction

anchorMode

auth

chainId

payload

postConditionMode

postConditions

version

appendPubkey

• appendPubkey(publicKey): void

• Append a public key to the spending-condition of the transaction

  Parameters

  • publicKey: PublicKey

    the public key to append

  Returns void

  Example

  import { makeSTXTokenTransfer } from '@stacks/transactions';
  
  const transaction = makeSTXTokenTransfer({ ... });
  transaction.appendPubkey('034f355bdcb7cc0af728..24c0e585c5e89ac788521e0');
  Copy

• appendPubkey(publicKey): void

• Parameters

  • publicKey: PublicKeyWire

  Returns void

serialize

• serialize(): string

• Serialize a transaction to a hex string (byte representation)

  Returns string

  A hex string of the serialized transaction

  Example

  import { makeSTXTokenTransfer } from '@stacks/transactions';
  
  const transaction = makeSTXTokenTransfer({ ... });
  const hex = transaction.serialize();
  Copy

serializeBytes

• serializeBytes(): Uint8Array

• Serialize a transaction to bytes

  Returns Uint8Array

  A Uint8Array of the serialized transaction

  Example

  import { makeSTXTokenTransfer } from '@stacks/transactions';
  
  const transaction = makeSTXTokenTransfer({ ... });
  const bytes = transaction.serializeBytes();
  Copy

setFee

• setFee(amount): void

• Set the total fee to be paid for this transaction

  Parameters

  • amount: IntegerType

  Returns void

setNonce

• setNonce(nonce): void

• Set the transaction nonce

  Parameters

  • nonce: IntegerType

    the nonce value

  Returns void

setSponsor

• setSponsor(sponsorSpendingCondition): void

• Parameters

  • sponsorSpendingCondition: SpendingConditionOpts

  Returns void

setSponsorNonce

• setSponsorNonce(nonce): void

• Set the transaction sponsor nonce

  Parameters

  • nonce: IntegerType

    the sponsor nonce value

  Returns void

signAndAppend

• signAndAppend(condition, curSigHash, authType, privateKey): string

• Warning: method mutates the condition param

  Parameters

  • condition: SpendingConditionOpts

    condition is mutated by this method

  • curSigHash: string

  • authType: AuthType

  • privateKey: PrivateKey

  Returns string

signBegin

• signBegin(): string

• Returns string

  Deprecated

  Does NOT mutate transaction, but rather returns the hash of the transaction with a cleared initial authorization

signNextOrigin

• signNextOrigin(sigHash, privateKey): string

• Parameters

  • sigHash: string

  • privateKey: PrivateKey

  Returns string

signNextSponsor

• signNextSponsor(sigHash, privateKey): string

• Parameters

  • sigHash: string

  • privateKey: PrivateKey

  Returns string

txid

• txid(): string

• Returns string

verifyBegin

• verifyBegin(): string

• Returns string

  Deprecated

  Alias of .signBegin()

verifyOrigin

• verifyOrigin(): string

• Returns string