Transaction

Transaction

Use TransactionBuilder to build a transaction object, unless you have an object or base64-encoded string of the transaction envelope XDR. Once a Transaction has been created, its attributes and operations should not be changed. You should only add signatures (using Transaction#sign) to a Transaction object before submitting to the network or forwarding on to additional signers.

Constructor

new Transaction(envelope)

Source:
Parameters:
Name Type Description
envelope string | xdr.TransactionEnvelope

The transaction envelope object or base64 encoded string.

Methods

addSignature(publicKey, signature) → {TransactionBuilder}

Add a signature to the transaction. Useful when a party wants to pre-sign a transaction but doesn't want to give access to their secret keys. This will also verify whether the signature is valid.

Here's how you would use this feature to solicit multiple signatures.

  • Use TransactionBuilder to build a new transaction.
  • Make sure to set a long enough timeout on that transaction to give your signers enough time to sign!
  • Once you build the transaction, use transaction.toXDR() to get the base64-encoded XDR string.
  • Warning! Once you've built this transaction, don't submit any other transactions onto your account! Doing so will invalidate this pre-compiled transaction!
  • Send this XDR string to your other parties. They can use the instructions for Transaction#getKeypairSignature to sign the transaction.
  • They should send you back their publicKey and the signature string from Transaction#getKeypairSignature, both of which you pass to this function.
Source:
Parameters:
Name Type Description
publicKey string

The public key of the signer

signature string

The base64 value of the signature XDR

Returns:
Type:
TransactionBuilder

getKeypairSignature(keypair) → {string}

Signs a transaction with the given Keypair. Useful if someone sends you a transaction XDR for you to sign and return (see Transaction#addSignature for how that works).

When you get a transaction XDR to sign....

  • Instantiate a Transaction object with the XDR
  • Use Keypair to generate a keypair object for your Stellar seed.
  • Run getKeypairSignature with that keypair
  • Send back the signature along with your publicKey (not your secret seed!)

Example:

// `transactionXDR` is a string from the person generating the transaction
const transaction = new Transaction(transactionXDR);
const keypair = Keypair.fromSecret(myStellarSeed);
return transaction.getKeypairSignature(keypair);
Source:
Parameters:
Name Type Description
keypair Keypair

Keypair of signer

Returns:
Type:
string

Signature string

hash() → {Buffer}

Returns a hash for this transaction, suitable for signing.

Source:
Returns:
Type:
Buffer

sign(…keypairs) → {void}

Signs the transaction with the given Keypair.

Source:
Parameters:
Name Type Attributes Description
keypairs Keypair <repeatable>

Keypairs of signers

Returns:
Type:
void

signatureBase() → {Buffer}

Returns the "signature base" of this transaction, which is the value that, when hashed, should be signed to create a signature that validators on the Stellar Network will accept.

It is composed of a 4 prefix bytes followed by the xdr-encoded form of this transaction.

Source:
Returns:
Type:
Buffer

signHashX(preimage) → {void}

Add hashX signer preimage as signature.

Source:
Parameters:
Name Type Description
preimage Buffer | String

Preimage of hash used as signer

Returns:
Type:
void

toEnvelope() → {xdr.TransactionEnvelope}

To envelope returns a xdr.TransactionEnvelope which can be submitted to the network.

Source:
Returns:
Type:
xdr.TransactionEnvelope

toXDR() → {string}

Get the transaction envelope as a base64-encoded string

Source:
Returns:
Type:
string

XDR string