fee_bump_transaction.js

  1. import xdr from './xdr';
  2. import { hash } from './hashing';
  4. import { Transaction } from './transaction';
  5. import { TransactionBase } from './transaction_base';
  6. import { encodeMuxedAccountToAddress } from './util/decode_encode_muxed_account';
  8. /**
  9.  * Use {@link TransactionBuilder.buildFeeBumpTransaction} to build a
  10.  * FeeBumpTransaction object. If you have an object or base64-encoded string of
  11.  * the transaction envelope XDR use {@link TransactionBuilder.fromXDR}.
  12.  *
  13.  * Once a {@link FeeBumpTransaction} has been created, its attributes and operations
  14.  * should not be changed. You should only add signatures (using {@link FeeBumpTransaction#sign}) before
  15.  * submitting to the network or forwarding on to additional signers.
  16.  *
  17.  * @param {string|xdr.TransactionEnvelope} envelope - transaction envelope
  18.  *     object or base64 encoded string.
  19.  * @param {string} networkPassphrase - passphrase of the target Stellar network
  20.  *     (e.g. "Public Global Stellar Network ; September 2015").
  21.  *
  22.  * @extends TransactionBase
  23.  */
  24. export class FeeBumpTransaction extends TransactionBase {
  25.   constructor(envelope, networkPassphrase) {
  26.     if (typeof envelope === 'string') {
  27.       const buffer = Buffer.from(envelope, 'base64');
  28.       envelope = xdr.TransactionEnvelope.fromXDR(buffer);
  29.     }
  31.     const envelopeType = envelope.switch();
  32.     if (envelopeType !== xdr.EnvelopeType.envelopeTypeTxFeeBump()) {
  33.       throw new Error(
  34.         `Invalid TransactionEnvelope: expected an envelopeTypeTxFeeBump but received an ${envelopeType.name}.`
  35.       );
  36.     }
  38.     const txEnvelope = envelope.value();
  39.     const tx = txEnvelope.tx();
  40.     const fee = tx.fee().toString();
  41.     // clone signatures
  42.     const signatures = (txEnvelope.signatures() || []).slice();
  44.     super(tx, signatures, fee, networkPassphrase);
  46.     const innerTxEnvelope = xdr.TransactionEnvelope.envelopeTypeTx(
  47.       tx.innerTx().v1()
  48.     );
  49.     this._feeSource = encodeMuxedAccountToAddress(this.tx.feeSource());
  50.     this._innerTransaction = new Transaction(
  51.       innerTxEnvelope,
  52.       networkPassphrase
  53.     );
  54.   }
  56.   /**
  57.    * @type {Transaction}
  58.    * @readonly
  59.    */
  60.   get innerTransaction() {
  61.     return this._innerTransaction;
  62.   }
  64.   /**
  65.    * @type {Operation[]}
  66.    * @readonly
  67.    */
  68.   get operations() {
  69.     return this._innerTransaction.operations;
  70.   }
  72.   /**
  73.    * @type {string}
  74.    * @readonly
  75.    */
  76.   get feeSource() {
  77.     return this._feeSource;
  78.   }
  80.   /**
  81.    * Returns the "signature base" of this transaction, which is the value
  82.    * that, when hashed, should be signed to create a signature that
  83.    * validators on the Stellar Network will accept.
  84.    *
  85.    * It is composed of a 4 prefix bytes followed by the xdr-encoded form
  86.    * of this transaction.
  87.    * @returns {Buffer}
  88.    */
  89.   signatureBase() {
  90.     const taggedTransaction =
  91.       new xdr.TransactionSignaturePayloadTaggedTransaction.envelopeTypeTxFeeBump(
  92.         this.tx
  93.       );
  95.     const txSignature = new xdr.TransactionSignaturePayload({
  96.       networkId: xdr.Hash.fromXDR(hash(this.networkPassphrase)),
  97.       taggedTransaction
  98.     });
  100.     return txSignature.toXDR();
  101.   }
  103.   /**
  104.    * To envelope returns a xdr.TransactionEnvelope which can be submitted to the network.
  105.    * @returns {xdr.TransactionEnvelope}
  106.    */
  107.   toEnvelope() {
  108.     const envelope = new xdr.FeeBumpTransactionEnvelope({
  109.       tx: xdr.FeeBumpTransaction.fromXDR(this.tx.toXDR()), // make a copy of the tx
  110.       signatures: this.signatures.slice() // make a copy of the signatures
  111.     });
  113.     return new xdr.TransactionEnvelope.envelopeTypeTxFeeBump(envelope);
  114.   }
  115. }