Documentation GitHub npm

Class

FeeBumpTransaction

FeeBumpTransaction(envelope, networkPassphrase)

Use TransactionBuilder.buildFeeBumpTransaction to build a FeeBumpTransaction object. If you have an object or base64-encoded string of the transaction envelope XDR use TransactionBuilder.fromXDR.

Once a FeeBumpTransaction has been created, its attributes and operations should not be changed. You should only add signatures (using FeeBumpTransaction#sign) before submitting to the network or forwarding on to additional signers.

Constructor

# new FeeBumpTransaction(envelope, networkPassphrase)

Parameters:
Name Type Description
envelope string | xdr.TransactionEnvelope

transaction envelope object or base64 encoded string.
networkPassphrase string

passphrase of the target Stellar network (e.g. "Public Global Stellar Network ; September 2015").

View Source js-stellar-base/src/fee_bump_transaction.js, line 24

Extends

Classes

FeeBumpTransaction

Members

string

# readonly fee

Overrides:

View Source js-stellar-base/src/transaction_base.js, line 46

string

# readonly feeSource

View Source js-stellar-base/src/fee_bump_transaction.js, line 76

Transaction

# readonly innerTransaction

View Source js-stellar-base/src/fee_bump_transaction.js, line 60

string

# readonly networkPassphrase

Overrides:

View Source js-stellar-base/src/transaction_base.js, line 58

Array.<Operation>

# readonly operations

View Source js-stellar-base/src/fee_bump_transaction.js, line 68

Array.<xdr.DecoratedSignature>

# readonly signatures

Overrides:

View Source js-stellar-base/src/transaction_base.js, line 26

Methods

# addDecoratedSignature(signature) → {void}

Add a decorated signature directly to the transaction envelope.

Parameters:
Name Type Description
signature xdr.DecoratedSignature

raw signature to add
Overrides:
See:
  • Keypair.signDecorated
  • Keypair.signPayloadDecorated

View Source js-stellar-base/src/transaction_base.js, line 170

void

# addSignature(publicKey, signature) → {void}

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 getKeypairSignature to sign the transaction.
  • They should send you back their publicKey and the signature string from getKeypairSignature, both of which you pass to this function.
Parameters:
Name Type Description
publicKey string

The public key of the signer
signature string

The base64 value of the signature XDR
Overrides:

View Source js-stellar-base/src/transaction_base.js, line 129

void

# 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 addSignature for more information).

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, networkPassphrase);
const keypair = Keypair.fromSecret(myStellarSeed);
return transaction.getKeypairSignature(keypair);
Parameters:
Name Type Description
keypair Keypair

Keypair of signer
Overrides:

View Source js-stellar-base/src/transaction_base.js, line 101

Signature string

string

# hash() → {Buffer}

Returns a hash for this transaction, suitable for signing.

Overrides:

View Source js-stellar-base/src/transaction_base.js, line 198

Buffer

# sign(…keypairs) → {void}

Signs the transaction with the given Keypair.

Parameters:
Name Type Attributes Description
keypairs Keypair <repeatable>

Keypairs of signers
Overrides:

View Source js-stellar-base/src/transaction_base.js, line 71

void

# signHashX(preimage) → {void}

Add hashX signer preimage as signature.

Parameters:
Name Type Description
preimage Buffer | String

Preimage of hash used as signer
Overrides:

View Source js-stellar-base/src/transaction_base.js, line 179

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.

View Source js-stellar-base/src/fee_bump_transaction.js, line 89

Buffer

# toEnvelope() → {xdr.TransactionEnvelope}

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

View Source js-stellar-base/src/fee_bump_transaction.js, line 107

xdr.TransactionEnvelope

# toXDR() → {string}

Get the transaction envelope as a base64-encoded string

Overrides:

View Source js-stellar-base/src/transaction_base.js, line 214

XDR string

string