@digitalworld/digital-world-sdk 16.0.0

package/lib/esm/base/transaction.d.ts

@@ -0,0 +1,110 @@
+import xdr from "./xdr.js";
+import { Memo } from "./memo.js";
+import { TransactionBase } from "./transaction_base.js";
+import { OperationRecord } from "./operations/types.js";
+/**
+ * Use {@link TransactionBuilder} to build a transaction object. If you have an
+ * object or base64-encoded string of the transaction envelope XDR, use {@link
+ * TransactionBuilder.fromXDR}.
+ *
+ * Once a Transaction has been created, its attributes and operations should not
+ * be changed. You should only add signatures (using {@link Transaction.sign})
+ * to a Transaction object before submitting to the network or forwarding on to
+ * additional signers.
+ *
+ */
+export declare class Transaction extends TransactionBase<xdr.Transaction | xdr.TransactionV0> {
+    private _envelopeType;
+    private _source;
+    private _memo;
+    private _sequence;
+    private _operations;
+    private _timeBounds?;
+    private _ledgerBounds?;
+    private _minAccountSequence?;
+    private _minAccountSequenceAge?;
+    private _minAccountSequenceLedgerGap?;
+    private _extraSigners?;
+    /**
+     * @param envelope - transaction envelope object or base64 encoded string
+     * @param networkPassphrase - passphrase of the target Digital World network
+     *     (e.g. "Digital World Network ; June 2021")
+     */
+    constructor(envelope: xdr.TransactionEnvelope | string, networkPassphrase: string);
+    /**
+     * The time bounds for this transaction, with `minTime` and `maxTime` as
+     * 64-bit unix timestamps (strings).
+     */
+    get timeBounds(): {
+        minTime: string;
+        maxTime: string;
+    } | undefined;
+    set timeBounds(_value: {
+        minTime: string;
+        maxTime: string;
+    } | undefined);
+    /**
+     * The ledger bounds for this transaction, with `minLedger` (uint32) and
+     * `maxLedger` (uint32, or 0 for no upper bound).
+     */
+    get ledgerBounds(): {
+        minLedger: number;
+        maxLedger: number;
+    } | undefined;
+    set ledgerBounds(_value: {
+        minLedger: number;
+        maxLedger: number;
+    } | undefined);
+    /** The minimum account sequence (64-bit, as a string). */
+    get minAccountSequence(): string | undefined;
+    set minAccountSequence(_value: string | undefined);
+    /** The minimum account sequence age (64-bit number of seconds). */
+    get minAccountSequenceAge(): bigint | undefined;
+    set minAccountSequenceAge(_value: bigint | undefined);
+    /** The minimum account sequence ledger gap (32-bit number of ledgers). */
+    get minAccountSequenceLedgerGap(): number | undefined;
+    set minAccountSequenceLedgerGap(_value: number | undefined);
+    /**
+     * Array of extra signers as XDR objects; use {@link SignerKey.encodeSignerKey}
+     * to convert to StrKey strings.
+     */
+    get extraSigners(): xdr.SignerKey[] | undefined;
+    set extraSigners(_value: xdr.SignerKey[] | undefined);
+    /** The sequence number for this transaction. */
+    get sequence(): string;
+    set sequence(_value: string);
+    /** The source account for this transaction. */
+    get source(): string;
+    set source(_value: string);
+    /** The list of operations in this transaction. */
+    get operations(): OperationRecord[];
+    set operations(_value: OperationRecord[]);
+    /** The memo attached to this transaction. */
+    get memo(): Memo<import("./memo.js").MemoType>;
+    set memo(_value: Memo<import("./memo.js").MemoType>);
+    /**
+     * 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 Digital World Network will accept.
+     *
+     * It is composed of a 4 prefix bytes followed by the xdr-encoded form
+     * of this transaction.
+     */
+    signatureBase(): Buffer;
+    /**
+     * To envelope returns a xdr.TransactionEnvelope which can be submitted to the network.
+     */
+    toEnvelope(): xdr.TransactionEnvelope;
+    /**
+     * Calculate the claimable balance ID for an operation within the transaction.
+     *
+     * @param opIndex - the index of the CreateClaimableBalance op
+     *
+     * @throws for invalid `opIndex` value, if op at `opIndex` is not
+     *    `CreateClaimableBalance`, or for general XDR un/marshalling failures
+     *
+     * @see https://github.com/stellar/go/blob/d712346e61e288d450b0c08038c158f8848cc3e4/txnbuild/transaction.go#L392-L435
+     *
+     */
+    getClaimableBalanceId(opIndex: number): string;
+}

package/lib/esm/base/transaction.js

@@ -0,0 +1,289 @@
+import { Buffer } from 'buffer';
+import types from './generated/curr_generated.js';
+import { hash } from './hashing.js';
+import { StrKey } from './strkey.js';
+import { Operation } from './operation.js';
+import { Memo } from './memo.js';
+import { TransactionBase } from './transaction_base.js';
+import { encodeMuxedAccountToAddress, extractBaseAddress } from './util/decode_encode_muxed_account.js';
+
+class Transaction extends TransactionBase {
+  _envelopeType;
+  _source = "";
+  _memo;
+  _sequence;
+  _operations;
+  _timeBounds;
+  _ledgerBounds;
+  _minAccountSequence;
+  _minAccountSequenceAge;
+  _minAccountSequenceLedgerGap;
+  _extraSigners;
+  /**
+   * @param envelope - transaction envelope object or base64 encoded string
+   * @param networkPassphrase - passphrase of the target Digital World network
+   *     (e.g. "Digital World Network ; June 2021")
+   */
+  constructor(envelope, networkPassphrase) {
+    if (typeof envelope === "string") {
+      const buffer = Buffer.from(envelope, "base64");
+      envelope = types.TransactionEnvelope.fromXDR(buffer);
+    }
+    const envelopeType = envelope.switch();
+    if (!(envelopeType === types.EnvelopeType.envelopeTypeTxV0() || envelopeType === types.EnvelopeType.envelopeTypeTx())) {
+      throw new Error(
+        `Invalid TransactionEnvelope: expected an envelopeTypeTxV0 or envelopeTypeTx but received an ${envelopeType.name}.`
+      );
+    }
+    const txEnvelope = envelope.value();
+    const tx = txEnvelope.tx();
+    const fee = tx.fee().toString();
+    const signatures = (txEnvelope.signatures() || []).slice();
+    super(tx, signatures, fee, networkPassphrase);
+    this._envelopeType = envelopeType;
+    this._memo = tx.memo();
+    this._sequence = tx.seqNum().toString();
+    switch (this._envelopeType) {
+      case types.EnvelopeType.envelopeTypeTxV0():
+        this._source = StrKey.encodeEd25519PublicKey(
+          tx.sourceAccountEd25519()
+        );
+        break;
+      default:
+        this._source = encodeMuxedAccountToAddress(
+          tx.sourceAccount()
+        );
+        break;
+    }
+    let cond = null;
+    let timeBounds = null;
+    switch (this._envelopeType) {
+      case types.EnvelopeType.envelopeTypeTxV0():
+        timeBounds = tx.timeBounds();
+        break;
+      case types.EnvelopeType.envelopeTypeTx():
+        switch (tx.cond().switch()) {
+          case types.PreconditionType.precondTime():
+            timeBounds = tx.cond().timeBounds();
+            break;
+          case types.PreconditionType.precondV2():
+            cond = tx.cond().v2();
+            timeBounds = cond.timeBounds();
+            break;
+        }
+        break;
+    }
+    if (timeBounds) {
+      this._timeBounds = {
+        minTime: timeBounds.minTime().toString(),
+        maxTime: timeBounds.maxTime().toString()
+      };
+    }
+    if (cond) {
+      const ledgerBounds = cond.ledgerBounds();
+      if (ledgerBounds) {
+        this._ledgerBounds = {
+          minLedger: ledgerBounds.minLedger(),
+          maxLedger: ledgerBounds.maxLedger()
+        };
+      }
+      const minSeq = cond.minSeqNum();
+      if (minSeq) {
+        this._minAccountSequence = minSeq.toString();
+      }
+      this._minAccountSequenceAge = cond.minSeqAge().toBigInt();
+      this._minAccountSequenceLedgerGap = cond.minSeqLedgerGap();
+      this._extraSigners = cond.extraSigners();
+    }
+    const operations = tx.operations() || [];
+    this._operations = operations.map((op) => Operation.fromXDRObject(op));
+  }
+  /**
+   * The time bounds for this transaction, with `minTime` and `maxTime` as
+   * 64-bit unix timestamps (strings).
+   */
+  get timeBounds() {
+    return this._timeBounds;
+  }
+  set timeBounds(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /**
+   * The ledger bounds for this transaction, with `minLedger` (uint32) and
+   * `maxLedger` (uint32, or 0 for no upper bound).
+   */
+  get ledgerBounds() {
+    return this._ledgerBounds;
+  }
+  set ledgerBounds(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The minimum account sequence (64-bit, as a string). */
+  get minAccountSequence() {
+    return this._minAccountSequence;
+  }
+  set minAccountSequence(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The minimum account sequence age (64-bit number of seconds). */
+  get minAccountSequenceAge() {
+    return this._minAccountSequenceAge;
+  }
+  set minAccountSequenceAge(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The minimum account sequence ledger gap (32-bit number of ledgers). */
+  get minAccountSequenceLedgerGap() {
+    return this._minAccountSequenceLedgerGap;
+  }
+  set minAccountSequenceLedgerGap(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /**
+   * Array of extra signers as XDR objects; use {@link SignerKey.encodeSignerKey}
+   * to convert to StrKey strings.
+   */
+  get extraSigners() {
+    return this._extraSigners;
+  }
+  set extraSigners(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The sequence number for this transaction. */
+  get sequence() {
+    return this._sequence;
+  }
+  set sequence(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The source account for this transaction. */
+  get source() {
+    return this._source;
+  }
+  set source(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The list of operations in this transaction. */
+  get operations() {
+    return this._operations;
+  }
+  set operations(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /** The memo attached to this transaction. */
+  get memo() {
+    return Memo.fromXDRObject(this._memo);
+  }
+  set memo(_value) {
+    throw new Error("Transaction is immutable");
+  }
+  /**
+   * 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 Digital World Network will accept.
+   *
+   * It is composed of a 4 prefix bytes followed by the xdr-encoded form
+   * of this transaction.
+   */
+  signatureBase() {
+    let tx = this.tx;
+    if (this._envelopeType === types.EnvelopeType.envelopeTypeTxV0()) {
+      tx = types.Transaction.fromXDR(
+        Buffer.concat([
+          // TransactionV0 is a transaction with the AccountID discriminant
+          // stripped off, we need to put it back to build a valid transaction
+          // which we can use to build a TransactionSignaturePayloadTaggedTransaction
+          Buffer.alloc(4),
+          // AccountID discriminant: publicKeyTypeEd25519 = 0
+          tx.toXDR()
+        ])
+      );
+    }
+    const taggedTransaction = types.TransactionSignaturePayloadTaggedTransaction.envelopeTypeTx(
+      tx
+    );
+    const txSignature = new types.TransactionSignaturePayload({
+      networkId: types.Hash.fromXDR(hash(this.networkPassphrase)),
+      taggedTransaction
+    });
+    return txSignature.toXDR();
+  }
+  /**
+   * To envelope returns a xdr.TransactionEnvelope which can be submitted to the network.
+   */
+  toEnvelope() {
+    const rawTx = this.tx.toXDR();
+    const signatures = this.signatures.slice();
+    let envelope;
+    switch (this._envelopeType) {
+      case types.EnvelopeType.envelopeTypeTxV0():
+        envelope = types.TransactionEnvelope.envelopeTypeTxV0(
+          new types.TransactionV0Envelope({
+            tx: types.TransactionV0.fromXDR(rawTx),
+            // make a copy of tx
+            signatures
+          })
+        );
+        break;
+      case types.EnvelopeType.envelopeTypeTx():
+        envelope = types.TransactionEnvelope.envelopeTypeTx(
+          new types.TransactionV1Envelope({
+            tx: types.Transaction.fromXDR(rawTx),
+            // make a copy of tx
+            signatures
+          })
+        );
+        break;
+      default:
+        throw new Error(
+          `Invalid TransactionEnvelope: expected an envelopeTypeTxV0 or envelopeTypeTx but received an ${this._envelopeType.name}.`
+        );
+    }
+    return envelope;
+  }
+  /**
+   * Calculate the claimable balance ID for an operation within the transaction.
+   *
+   * @param opIndex - the index of the CreateClaimableBalance op
+   *
+   * @throws for invalid `opIndex` value, if op at `opIndex` is not
+   *    `CreateClaimableBalance`, or for general XDR un/marshalling failures
+   *
+   * @see https://github.com/stellar/go/blob/d712346e61e288d450b0c08038c158f8848cc3e4/txnbuild/transaction.go#L392-L435
+   *
+   */
+  getClaimableBalanceId(opIndex) {
+    if (!Number.isInteger(opIndex) || opIndex < 0 || opIndex >= this.operations.length) {
+      throw new RangeError("invalid operation index");
+    }
+    const op = this.operations[opIndex];
+    if (op === void 0) {
+      throw new RangeError("invalid operation index");
+    }
+    try {
+      Operation.createClaimableBalance(
+        op
+      );
+    } catch (err) {
+      throw new TypeError(
+        `expected createClaimableBalance, got ${op.type}: ${String(err)}`
+      );
+    }
+    const account = StrKey.decodeEd25519PublicKey(
+      extractBaseAddress(this.source)
+    );
+    const operationId = types.HashIdPreimage.envelopeTypeOpId(
+      new types.HashIdPreimageOperationId({
+        sourceAccount: types.PublicKey.publicKeyTypeEd25519(account),
+        seqNum: types.Int64.fromString(this.sequence),
+        opNum: opIndex
+      })
+    );
+    const opIdHash = hash(operationId.toXDR("raw"));
+    const balanceId = types.ClaimableBalanceId.claimableBalanceIdTypeV0(opIdHash);
+    return balanceId.toXDR("hex");
+  }
+}
+
+export { Transaction };
+//# sourceMappingURL=transaction.js.map

package/lib/esm/base/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sources":["../../../src/base/transaction.ts"],"sourcesContent":["import xdr from \"./xdr.js\";\nimport { hash } from \"./hashing.js\";\n\nimport { StrKey } from \"./strkey.js\";\nimport { Operation } from \"./operation.js\";\nimport { Memo } from \"./memo.js\";\nimport { TransactionBase } from \"./transaction_base.js\";\nimport {\n  extractBaseAddress,\n  encodeMuxedAccountToAddress,\n} from \"./util/decode_encode_muxed_account.js\";\nimport { OperationRecord } from \"./operations/types.js\";\n\n/**\n * Use {@link TransactionBuilder} to build a transaction object. If you have an\n * object or base64-encoded string of the transaction envelope XDR, use {@link\n * TransactionBuilder.fromXDR}.\n *\n * Once a Transaction has been created, its attributes and operations should not\n * be changed. You should only add signatures (using {@link Transaction.sign})\n * to a Transaction object before submitting to the network or forwarding on to\n * additional signers.\n *\n */\nexport class Transaction extends TransactionBase<\n  xdr.Transaction | xdr.TransactionV0\n> {\n  private _envelopeType: xdr.EnvelopeType;\n  private _source: string = \"\";\n  private _memo: xdr.Memo;\n  private _sequence: string;\n  private _operations: OperationRecord[];\n  private _timeBounds?: { minTime: string; maxTime: string };\n  private _ledgerBounds?: { minLedger: number; maxLedger: number };\n  private _minAccountSequence?: string;\n  private _minAccountSequenceAge?: bigint;\n  private _minAccountSequenceLedgerGap?: number;\n  private _extraSigners?: xdr.SignerKey[];\n\n  /**\n   * @param envelope - transaction envelope object or base64 encoded string\n   * @param networkPassphrase - passphrase of the target Digital World network\n   *     (e.g. \"Digital World Network ; June 2021\")\n   */\n  constructor(\n    envelope: xdr.TransactionEnvelope | string,\n    networkPassphrase: string,\n  ) {\n    if (typeof envelope === \"string\") {\n      const buffer = Buffer.from(envelope, \"base64\");\n      envelope = xdr.TransactionEnvelope.fromXDR(buffer);\n    }\n\n    const envelopeType = envelope.switch();\n    if (\n      !(\n        envelopeType === xdr.EnvelopeType.envelopeTypeTxV0() ||\n        envelopeType === xdr.EnvelopeType.envelopeTypeTx()\n      )\n    ) {\n      throw new Error(\n        `Invalid TransactionEnvelope: expected an envelopeTypeTxV0 or envelopeTypeTx but received an ${envelopeType.name}.`,\n      );\n    }\n\n    const txEnvelope = envelope.value() as\n      | xdr.TransactionV0Envelope\n      | xdr.TransactionV1Envelope;\n    const tx = txEnvelope.tx();\n    const fee = tx.fee().toString();\n    const signatures = (txEnvelope.signatures() || []).slice();\n\n    super(tx, signatures, fee, networkPassphrase);\n\n    this._envelopeType = envelopeType;\n    this._memo = tx.memo();\n    this._sequence = tx.seqNum().toString();\n\n    switch (this._envelopeType) {\n      case xdr.EnvelopeType.envelopeTypeTxV0():\n        this._source = StrKey.encodeEd25519PublicKey(\n          (tx as xdr.TransactionV0).sourceAccountEd25519(),\n        );\n        break;\n      default:\n        this._source = encodeMuxedAccountToAddress(\n          (tx as xdr.Transaction).sourceAccount(),\n        );\n        break;\n    }\n\n    let cond = null;\n    let timeBounds = null;\n    switch (this._envelopeType) {\n      case xdr.EnvelopeType.envelopeTypeTxV0():\n        timeBounds = (tx as xdr.TransactionV0).timeBounds();\n        break;\n\n      case xdr.EnvelopeType.envelopeTypeTx():\n        switch ((tx as xdr.Transaction).cond().switch()) {\n          case xdr.PreconditionType.precondTime():\n            timeBounds = (tx as xdr.Transaction).cond().timeBounds();\n            break;\n\n          case xdr.PreconditionType.precondV2():\n            cond = (tx as xdr.Transaction).cond().v2();\n            timeBounds = cond.timeBounds();\n            break;\n\n          default:\n            break;\n        }\n        break;\n\n      default:\n        break;\n    }\n\n    if (timeBounds) {\n      this._timeBounds = {\n        minTime: timeBounds.minTime().toString(),\n        maxTime: timeBounds.maxTime().toString(),\n      };\n    }\n\n    if (cond) {\n      const ledgerBounds = cond.ledgerBounds();\n      if (ledgerBounds) {\n        this._ledgerBounds = {\n          minLedger: ledgerBounds.minLedger(),\n          maxLedger: ledgerBounds.maxLedger(),\n        };\n      }\n\n      const minSeq = cond.minSeqNum();\n      if (minSeq) {\n        this._minAccountSequence = minSeq.toString();\n      }\n\n      this._minAccountSequenceAge = cond.minSeqAge().toBigInt();\n      this._minAccountSequenceLedgerGap = cond.minSeqLedgerGap();\n      this._extraSigners = cond.extraSigners();\n    }\n\n    const operations = tx.operations() || [];\n    this._operations = operations.map((op) => Operation.fromXDRObject(op));\n  }\n\n  /**\n   * The time bounds for this transaction, with `minTime` and `maxTime` as\n   * 64-bit unix timestamps (strings).\n   */\n  get timeBounds() {\n    return this._timeBounds;\n  }\n  set timeBounds(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /**\n   * The ledger bounds for this transaction, with `minLedger` (uint32) and\n   * `maxLedger` (uint32, or 0 for no upper bound).\n   */\n  get ledgerBounds() {\n    return this._ledgerBounds;\n  }\n  set ledgerBounds(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The minimum account sequence (64-bit, as a string). */\n  get minAccountSequence() {\n    return this._minAccountSequence;\n  }\n  set minAccountSequence(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The minimum account sequence age (64-bit number of seconds). */\n  get minAccountSequenceAge() {\n    return this._minAccountSequenceAge;\n  }\n  set minAccountSequenceAge(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The minimum account sequence ledger gap (32-bit number of ledgers). */\n  get minAccountSequenceLedgerGap() {\n    return this._minAccountSequenceLedgerGap;\n  }\n  set minAccountSequenceLedgerGap(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /**\n   * Array of extra signers as XDR objects; use {@link SignerKey.encodeSignerKey}\n   * to convert to StrKey strings.\n   */\n  get extraSigners() {\n    return this._extraSigners;\n  }\n  set extraSigners(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The sequence number for this transaction. */\n  get sequence() {\n    return this._sequence;\n  }\n  set sequence(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The source account for this transaction. */\n  get source() {\n    return this._source;\n  }\n  set source(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The list of operations in this transaction. */\n  get operations() {\n    return this._operations;\n  }\n  set operations(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /** The memo attached to this transaction. */\n  get memo() {\n    return Memo.fromXDRObject(this._memo);\n  }\n  set memo(_value) {\n    throw new Error(\"Transaction is immutable\");\n  }\n\n  /**\n   * Returns the \"signature base\" of this transaction, which is the value\n   * that, when hashed, should be signed to create a signature that\n   * validators on the Digital World Network will accept.\n   *\n   * It is composed of a 4 prefix bytes followed by the xdr-encoded form\n   * of this transaction.\n   */\n  override signatureBase(): Buffer {\n    let tx = this.tx;\n\n    // Backwards Compatibility: Use ENVELOPE_TYPE_TX to sign ENVELOPE_TYPE_TX_V0\n    // we need a Transaction to generate the signature base\n    if (this._envelopeType === xdr.EnvelopeType.envelopeTypeTxV0()) {\n      tx = xdr.Transaction.fromXDR(\n        Buffer.concat([\n          // TransactionV0 is a transaction with the AccountID discriminant\n          // stripped off, we need to put it back to build a valid transaction\n          // which we can use to build a TransactionSignaturePayloadTaggedTransaction\n          Buffer.alloc(4), // AccountID discriminant: publicKeyTypeEd25519 = 0\n          tx.toXDR(),\n        ]),\n      );\n    }\n\n    const taggedTransaction =\n      xdr.TransactionSignaturePayloadTaggedTransaction.envelopeTypeTx(\n        tx as xdr.Transaction,\n      );\n\n    const txSignature = new xdr.TransactionSignaturePayload({\n      networkId: xdr.Hash.fromXDR(hash(this.networkPassphrase)),\n      taggedTransaction,\n    });\n\n    return txSignature.toXDR();\n  }\n\n  /**\n   * To envelope returns a xdr.TransactionEnvelope which can be submitted to the network.\n   */\n  override toEnvelope(): xdr.TransactionEnvelope {\n    const rawTx = this.tx.toXDR();\n    const signatures = this.signatures.slice(); // make a copy of the signatures\n\n    let envelope;\n    switch (this._envelopeType) {\n      case xdr.EnvelopeType.envelopeTypeTxV0():\n        envelope = xdr.TransactionEnvelope.envelopeTypeTxV0(\n          new xdr.TransactionV0Envelope({\n            tx: xdr.TransactionV0.fromXDR(rawTx), // make a copy of tx\n            signatures,\n          }),\n        );\n        break;\n      case xdr.EnvelopeType.envelopeTypeTx():\n        envelope = xdr.TransactionEnvelope.envelopeTypeTx(\n          new xdr.TransactionV1Envelope({\n            tx: xdr.Transaction.fromXDR(rawTx), // make a copy of tx\n            signatures,\n          }),\n        );\n        break;\n      default:\n        throw new Error(\n          `Invalid TransactionEnvelope: expected an envelopeTypeTxV0 or envelopeTypeTx but received an ${this._envelopeType.name}.`,\n        );\n    }\n\n    return envelope;\n  }\n\n  /**\n   * Calculate the claimable balance ID for an operation within the transaction.\n   *\n   * @param opIndex - the index of the CreateClaimableBalance op\n   *\n   * @throws for invalid `opIndex` value, if op at `opIndex` is not\n   *    `CreateClaimableBalance`, or for general XDR un/marshalling failures\n   *\n   * @see https://github.com/stellar/go/blob/d712346e61e288d450b0c08038c158f8848cc3e4/txnbuild/transaction.go#L392-L435\n   *\n   */\n  getClaimableBalanceId(opIndex: number): string {\n    // Validate and then extract the operation from the transaction.\n    if (\n      !Number.isInteger(opIndex) ||\n      opIndex < 0 ||\n      opIndex >= this.operations.length\n    ) {\n      throw new RangeError(\"invalid operation index\");\n    }\n\n    const op = this.operations[opIndex];\n\n    if (op === undefined) {\n      throw new RangeError(\"invalid operation index\");\n    }\n\n    try {\n      Operation.createClaimableBalance(\n        op as Parameters<typeof Operation.createClaimableBalance>[0],\n      );\n    } catch (err) {\n      throw new TypeError(\n        `expected createClaimableBalance, got ${op.type}: ${String(err)}`,\n      );\n    }\n\n    // Always use the transaction's *unmuxed* source.\n    const account = StrKey.decodeEd25519PublicKey(\n      extractBaseAddress(this.source),\n    );\n    const operationId = xdr.HashIdPreimage.envelopeTypeOpId(\n      new xdr.HashIdPreimageOperationId({\n        sourceAccount: xdr.PublicKey.publicKeyTypeEd25519(account),\n        seqNum: xdr.Int64.fromString(this.sequence),\n        opNum: opIndex,\n      }),\n    );\n\n    const opIdHash = hash(operationId.toXDR(\"raw\"));\n    const balanceId = xdr.ClaimableBalanceId.claimableBalanceIdTypeV0(opIdHash);\n    return balanceId.toXDR(\"hex\");\n  }\n}\n"],"names":["xdr"],"mappings":";;;;;;;;;AAwBO,MAAM,oBAAoB,eAAA,CAE/B;AAAA,EACQ,aAAA;AAAA,EACA,OAAA,GAAkB,EAAA;AAAA,EAClB,KAAA;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAA;AAAA,EACA,mBAAA;AAAA,EACA,sBAAA;AAAA,EACA,4BAAA;AAAA,EACA,aAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOR,WAAA,CACE,UACA,iBAAA,EACA;AACA,IAAA,IAAI,OAAO,aAAa,QAAA,EAAU;AAChC,MAAA,MAAM,MAAA,GAAS,MAAA,CAAO,IAAA,CAAK,QAAA,EAAU,QAAQ,CAAA;AAC7C,MAAA,QAAA,GAAWA,KAAA,CAAI,mBAAA,CAAoB,OAAA,CAAQ,MAAM,CAAA;AAAA,IACnD;AAEA,IAAA,MAAM,YAAA,GAAe,SAAS,MAAA,EAAO;AACrC,IAAA,IACE,EACE,YAAA,KAAiBA,KAAA,CAAI,YAAA,CAAa,gBAAA,MAClC,YAAA,KAAiBA,KAAA,CAAI,YAAA,CAAa,cAAA,EAAe,CAAA,EAEnD;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,4FAAA,EAA+F,aAAa,IAAI,CAAA,CAAA;AAAA,OAClH;AAAA,IACF;AAEA,IAAA,MAAM,UAAA,GAAa,SAAS,KAAA,EAAM;AAGlC,IAAA,MAAM,EAAA,GAAK,WAAW,EAAA,EAAG;AACzB,IAAA,MAAM,GAAA,GAAM,EAAA,CAAG,GAAA,EAAI,CAAE,QAAA,EAAS;AAC9B,IAAA,MAAM,cAAc,UAAA,CAAW,UAAA,EAAW,IAAK,IAAI,KAAA,EAAM;AAEzD,IAAA,KAAA,CAAM,EAAA,EAAI,UAAA,EAAY,GAAA,EAAK,iBAAiB,CAAA;AAE5C,IAAA,IAAA,CAAK,aAAA,GAAgB,YAAA;AACrB,IAAA,IAAA,CAAK,KAAA,GAAQ,GAAG,IAAA,EAAK;AACrB,IAAA,IAAA,CAAK,SAAA,GAAY,EAAA,CAAG,MAAA,EAAO,CAAE,QAAA,EAAS;AAEtC,IAAA,QAAQ,KAAK,aAAA;AAAe,MAC1B,KAAKA,KAAA,CAAI,YAAA,CAAa,gBAAA,EAAiB;AACrC,QAAA,IAAA,CAAK,UAAU,MAAA,CAAO,sBAAA;AAAA,UACnB,GAAyB,oBAAA;AAAqB,SACjD;AACA,QAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,OAAA,GAAU,2BAAA;AAAA,UACZ,GAAuB,aAAA;AAAc,SACxC;AACA,QAAA;AAAA;AAGJ,IAAA,IAAI,IAAA,GAAO,IAAA;AACX,IAAA,IAAI,UAAA,GAAa,IAAA;AACjB,IAAA,QAAQ,KAAK,aAAA;AAAe,MAC1B,KAAKA,KAAA,CAAI,YAAA,CAAa,gBAAA,EAAiB;AACrC,QAAA,UAAA,GAAc,GAAyB,UAAA,EAAW;AAClD,QAAA;AAAA,MAEF,KAAKA,KAAA,CAAI,YAAA,CAAa,cAAA,EAAe;AACnC,QAAA,QAAS,EAAA,CAAuB,IAAA,EAAK,CAAE,MAAA,EAAO;AAAG,UAC/C,KAAKA,KAAA,CAAI,gBAAA,CAAiB,WAAA,EAAY;AACpC,YAAA,UAAA,GAAc,EAAA,CAAuB,IAAA,EAAK,CAAE,UAAA,EAAW;AACvD,YAAA;AAAA,UAEF,KAAKA,KAAA,CAAI,gBAAA,CAAiB,SAAA,EAAU;AAClC,YAAA,IAAA,GAAQ,EAAA,CAAuB,IAAA,EAAK,CAAE,EAAA,EAAG;AACzC,YAAA,UAAA,GAAa,KAAK,UAAA,EAAW;AAC7B,YAAA;AAGA;AAEJ,QAAA;AAGA;AAGJ,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,IAAA,CAAK,WAAA,GAAc;AAAA,QACjB,OAAA,EAAS,UAAA,CAAW,OAAA,EAAQ,CAAE,QAAA,EAAS;AAAA,QACvC,OAAA,EAAS,UAAA,CAAW,OAAA,EAAQ,CAAE,QAAA;AAAS,OACzC;AAAA,IACF;AAEA,IAAA,IAAI,IAAA,EAAM;AACR,MAAA,MAAM,YAAA,GAAe,KAAK,YAAA,EAAa;AACvC,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,IAAA,CAAK,aAAA,GAAgB;AAAA,UACnB,SAAA,EAAW,aAAa,SAAA,EAAU;AAAA,UAClC,SAAA,EAAW,aAAa,SAAA;AAAU,SACpC;AAAA,MACF;AAEA,MAAA,MAAM,MAAA,GAAS,KAAK,SAAA,EAAU;AAC9B,MAAA,IAAI,MAAA,EAAQ;AACV,QAAA,IAAA,CAAK,mBAAA,GAAsB,OAAO,QAAA,EAAS;AAAA,MAC7C;AAEA,MAAA,IAAA,CAAK,sBAAA,GAAyB,IAAA,CAAK,SAAA,EAAU,CAAE,QAAA,EAAS;AACxD,MAAA,IAAA,CAAK,4BAAA,GAA+B,KAAK,eAAA,EAAgB;AACzD,MAAA,IAAA,CAAK,aAAA,GAAgB,KAAK,YAAA,EAAa;AAAA,IACzC;AAEA,IAAA,MAAM,UAAA,GAAa,EAAA,CAAG,UAAA,EAAW,IAAK,EAAC;AACvC,IAAA,IAAA,CAAK,WAAA,GAAc,WAAW,GAAA,CAAI,CAAC,OAAO,SAAA,CAAU,aAAA,CAAc,EAAE,CAAC,CAAA;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAA,GAAa;AACf,IAAA,OAAO,IAAA,CAAK,WAAA;AAAA,EACd;AAAA,EACA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAA,GAAe;AACjB,IAAA,OAAO,IAAA,CAAK,aAAA;AAAA,EACd;AAAA,EACA,IAAI,aAAa,MAAA,EAAQ;AACvB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,kBAAA,GAAqB;AACvB,IAAA,OAAO,IAAA,CAAK,mBAAA;AAAA,EACd;AAAA,EACA,IAAI,mBAAmB,MAAA,EAAQ;AAC7B,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,qBAAA,GAAwB;AAC1B,IAAA,OAAO,IAAA,CAAK,sBAAA;AAAA,EACd;AAAA,EACA,IAAI,sBAAsB,MAAA,EAAQ;AAChC,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,2BAAA,GAA8B;AAChC,IAAA,OAAO,IAAA,CAAK,4BAAA;AAAA,EACd;AAAA,EACA,IAAI,4BAA4B,MAAA,EAAQ;AACtC,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAA,GAAe;AACjB,IAAA,OAAO,IAAA,CAAK,aAAA;AAAA,EACd;AAAA,EACA,IAAI,aAAa,MAAA,EAAQ;AACvB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,QAAA,GAAW;AACb,IAAA,OAAO,IAAA,CAAK,SAAA;AAAA,EACd;AAAA,EACA,IAAI,SAAS,MAAA,EAAQ;AACnB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,MAAA,GAAS;AACX,IAAA,OAAO,IAAA,CAAK,OAAA;AAAA,EACd;AAAA,EACA,IAAI,OAAO,MAAA,EAAQ;AACjB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,UAAA,GAAa;AACf,IAAA,OAAO,IAAA,CAAK,WAAA;AAAA,EACd;AAAA,EACA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA,EAGA,IAAI,IAAA,GAAO;AACT,IAAA,OAAO,IAAA,CAAK,aAAA,CAAc,IAAA,CAAK,KAAK,CAAA;AAAA,EACtC;AAAA,EACA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUS,aAAA,GAAwB;AAC/B,IAAA,IAAI,KAAK,IAAA,CAAK,EAAA;AAId,IAAA,IAAI,IAAA,CAAK,aAAA,KAAkBA,KAAA,CAAI,YAAA,CAAa,kBAAiB,EAAG;AAC9D,MAAA,EAAA,GAAKA,MAAI,WAAA,CAAY,OAAA;AAAA,QACnB,OAAO,MAAA,CAAO;AAAA;AAAA;AAAA;AAAA,UAIZ,MAAA,CAAO,MAAM,CAAC,CAAA;AAAA;AAAA,UACd,GAAG,KAAA;AAAM,SACV;AAAA,OACH;AAAA,IACF;AAEA,IAAA,MAAM,iBAAA,GACJA,MAAI,4CAAA,CAA6C,cAAA;AAAA,MAC/C;AAAA,KACF;AAEF,IAAA,MAAM,WAAA,GAAc,IAAIA,KAAA,CAAI,2BAAA,CAA4B;AAAA,MACtD,WAAWA,KAAA,CAAI,IAAA,CAAK,QAAQ,IAAA,CAAK,IAAA,CAAK,iBAAiB,CAAC,CAAA;AAAA,MACxD;AAAA,KACD,CAAA;AAED,IAAA,OAAO,YAAY,KAAA,EAAM;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKS,UAAA,GAAsC;AAC7C,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,EAAA,CAAG,KAAA,EAAM;AAC5B,IAAA,MAAM,UAAA,GAAa,IAAA,CAAK,UAAA,CAAW,KAAA,EAAM;AAEzC,IAAA,IAAI,QAAA;AACJ,IAAA,QAAQ,KAAK,aAAA;AAAe,MAC1B,KAAKA,KAAA,CAAI,YAAA,CAAa,gBAAA,EAAiB;AACrC,QAAA,QAAA,GAAWA,MAAI,mBAAA,CAAoB,gBAAA;AAAA,UACjC,IAAIA,MAAI,qBAAA,CAAsB;AAAA,YAC5B,EAAA,EAAIA,KAAA,CAAI,aAAA,CAAc,OAAA,CAAQ,KAAK,CAAA;AAAA;AAAA,YACnC;AAAA,WACD;AAAA,SACH;AACA,QAAA;AAAA,MACF,KAAKA,KAAA,CAAI,YAAA,CAAa,cAAA,EAAe;AACnC,QAAA,QAAA,GAAWA,MAAI,mBAAA,CAAoB,cAAA;AAAA,UACjC,IAAIA,MAAI,qBAAA,CAAsB;AAAA,YAC5B,EAAA,EAAIA,KAAA,CAAI,WAAA,CAAY,OAAA,CAAQ,KAAK,CAAA;AAAA;AAAA,YACjC;AAAA,WACD;AAAA,SACH;AACA,QAAA;AAAA,MACF;AACE,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4FAAA,EAA+F,IAAA,CAAK,aAAA,CAAc,IAAI,CAAA,CAAA;AAAA,SACxH;AAAA;AAGJ,IAAA,OAAO,QAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,sBAAsB,OAAA,EAAyB;AAE7C,IAAA,IACE,CAAC,MAAA,CAAO,SAAA,CAAU,OAAO,CAAA,IACzB,UAAU,CAAA,IACV,OAAA,IAAW,IAAA,CAAK,UAAA,CAAW,MAAA,EAC3B;AACA,MAAA,MAAM,IAAI,WAAW,yBAAyB,CAAA;AAAA,IAChD;AAEA,IAAA,MAAM,EAAA,GAAK,IAAA,CAAK,UAAA,CAAW,OAAO,CAAA;AAElC,IAAA,IAAI,OAAO,MAAA,EAAW;AACpB,MAAA,MAAM,IAAI,WAAW,yBAAyB,CAAA;AAAA,IAChD;AAEA,IAAA,IAAI;AACF,MAAA,SAAA,CAAU,sBAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,wCAAwC,EAAA,CAAG,IAAI,CAAA,EAAA,EAAK,MAAA,CAAO,GAAG,CAAC,CAAA;AAAA,OACjE;AAAA,IACF;AAGA,IAAA,MAAM,UAAU,MAAA,CAAO,sBAAA;AAAA,MACrB,kBAAA,CAAmB,KAAK,MAAM;AAAA,KAChC;AACA,IAAA,MAAM,WAAA,GAAcA,MAAI,cAAA,CAAe,gBAAA;AAAA,MACrC,IAAIA,MAAI,yBAAA,CAA0B;AAAA,QAChC,aAAA,EAAeA,KAAA,CAAI,SAAA,CAAU,oBAAA,CAAqB,OAAO,CAAA;AAAA,QACzD,MAAA,EAAQA,KAAA,CAAI,KAAA,CAAM,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,QAC1C,KAAA,EAAO;AAAA,OACR;AAAA,KACH;AAEA,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,WAAA,CAAY,KAAA,CAAM,KAAK,CAAC,CAAA;AAC9C,IAAA,MAAM,SAAA,GAAYA,KAAA,CAAI,kBAAA,CAAmB,wBAAA,CAAyB,QAAQ,CAAA;AAC1E,IAAA,OAAO,SAAA,CAAU,MAAM,KAAK,CAAA;AAAA,EAC9B;AACF;;;;"}

package/lib/esm/base/transaction_base.d.ts

@@ -0,0 +1,110 @@
+import xdr from "./xdr.js";
+import { Keypair } from "./keypair.js";
+/**
+ * @ignore
+ */
+export declare class TransactionBase<TTx extends xdr.FeeBumpTransaction | xdr.Transaction | xdr.TransactionV0> {
+    private _tx;
+    private _signatures;
+    private _fee;
+    private _networkPassphrase;
+    constructor(tx: TTx, signatures: xdr.DecoratedSignature[], fee: string, networkPassphrase: string);
+    /** The list of signatures for this transaction. */
+    get signatures(): xdr.DecoratedSignature[];
+    set signatures(_value: xdr.DecoratedSignature[]);
+    /**
+     * The underlying XDR transaction object.
+     *
+     * Returns a defensive copy so that external mutations cannot alter the
+     * transaction that will be signed or serialized.
+     *
+     * @throws if the internal transaction is not a recognized XDR type
+     */
+    get tx(): TTx;
+    set tx(_value: TTx);
+    /** The total fee for this transaction, in Nats. */
+    get fee(): string;
+    set fee(_value: string);
+    /** The network passphrase for this transaction. */
+    get networkPassphrase(): string;
+    set networkPassphrase(_networkPassphrase: string);
+    /**
+     * Signs the transaction with the given {@link Keypair}.
+     * @param keypairs - Keypairs of signers
+     */
+    sign(...keypairs: Keypair[]): void;
+    /**
+     * Signs a transaction with the given {@link Keypair}. Useful if someone sends
+     * you a transaction XDR for you to sign and return (see
+     * `{@link Transaction.addSignature | addSignature}` for more information).
+     *
+     * When you get a transaction XDR to sign....
+     * - Instantiate a `Transaction` object with the XDR
+     * - Use {@link Keypair} to generate a keypair object for your Digital World secret seed.
+     * - Run `getKeypairSignature` with that keypair
+     * - Send back the signature along with your publicKey (not your secret seed!)
+     *
+     * Example:
+     * ```javascript
+     * // `transactionXDR` is a string from the person generating the transaction
+     * const transaction = new Transaction(transactionXDR, networkPassphrase);
+     * const keypair = Keypair.fromSecret(myDigitalWorldSeed);
+     * return transaction.getKeypairSignature(keypair);
+     * ```
+     *
+     * Returns the base64-encoded signature string for the given keypair.
+     *
+     * @param keypair - Keypair of signer
+     */
+    getKeypairSignature(keypair: Keypair): string;
+    /**
+     * 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 `{@link Transaction.getKeypairSignature | getKeypairSignature}` to sign the transaction.
+     * - They should send you back their `publicKey` and the `signature` string
+     * from `{@link Transaction.getKeypairSignature | getKeypairSignature}`, both of which you pass to
+     * this function.
+     *
+     * @param publicKey - the public key of the signer
+     * @param signature - the base64 value of the signature XDR
+     */
+    addSignature(publicKey?: string, signature?: string): void;
+    /**
+     * Add a decorated signature directly to the transaction envelope.
+     *
+     * @param signature - raw signature to add
+     *
+     * @see Keypair.signDecorated
+     * @see Keypair.signPayloadDecorated
+     */
+    addDecoratedSignature(signature: xdr.DecoratedSignature): void;
+    /**
+     * Add `hashX` signer preimage as signature.
+     * @param preimage - preimage of hash used as signer
+     */
+    signHashX(preimage: Buffer | string): void;
+    /**
+     * Returns a hash for this transaction, suitable for signing.
+     */
+    hash(): Buffer;
+    /** Returns the signature base for this transaction, to be overridden by subclasses. */
+    signatureBase(): Buffer;
+    /** Returns the XDR transaction envelope, to be overridden by subclasses. */
+    toEnvelope(): xdr.TransactionEnvelope;
+    /**
+     * Returns the transaction envelope as a base64-encoded XDR string.
+     */
+    toXDR(): string;
+}