ecash-lib 4.3.0 → 4.3.1

package/README.md

@@ -98,3 +98,4 @@ console.log(toHex(rawTx));
 -   4.1.0 - Add Tx deserialization methods [D18393](https://reviews.bitcoinabc.org/D18393)
 -   4.2.0 - Add Tx.txid() method to compute the TxId of a transaction [D18394](https://reviews.bitcoinabc.org/D18394)
 -   4.3.0 - Export a Tx.toHex() method [D18396](https://reviews.bitcoinabc.org/D18396)
+-   4.3.1 - Modify union type of payment outputs to include ecash-wallet template OP_RETURN [D18403](https://reviews.bitcoinabc.org/D18403)

package/dist/payment/output.d.ts

@@ -7,16 +7,31 @@ export type PaymentOutput = PaymentNonTokenOutput | PaymentTokenOutput;
  *
  * Note than an OP_RETURN output is a NonTokenPaymentOutput
  */
-export interface PaymentNonTokenOutput {
+export type PaymentNonTokenOutput = {
     /** The amount of satoshis in this tx output */
     sats?: bigint;
     /** The outputScript of this tx output */
     script?: Script;
-}
+    /**
+     * The eCash address of this tx output
+     * Alternative to script - if script is provided, address should not be set
+     */
+    address?: never;
+} | {
+    /** The amount of satoshis in this tx output */
+    sats?: bigint;
+    /** The outputScript of this tx output */
+    script?: never;
+    /**
+     * The eCash address of this tx output
+     * Alternative to script - if script is not provided, address must be set
+     */
+    address: string;
+};
 /**
  * All token transaction outputs specified in Action have this shape
  */
-export interface PaymentTokenOutput extends PaymentNonTokenOutput {
+export type PaymentTokenOutput = PaymentNonTokenOutput & {
     /** The tokenId of the token associated with this tx output */
     tokenId: string;
     /**
@@ -27,5 +42,5 @@ export interface PaymentTokenOutput extends PaymentNonTokenOutput {
     atoms: bigint;
     /** Is this tx output a mint baton */
     isMintBaton: boolean;
-}
+};
 //# sourceMappingURL=output.d.ts.map

package/dist/payment/output.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/payment/output.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB;IAC7D,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/payment/output.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC3B;IACI,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;CACnB,GACD;IACI,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,MAAM,CAAC,EAAE,KAAK,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,GAAG;IACrD,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ecash-lib",
-    "version": "4.3.0",
+    "version": "4.3.1",
     "description": "Library for eCash transaction building",
     "main": "./dist/indexNodeJs.js",
     "browser": "./dist/indexBrowser.js",

package/src/payment/output.ts

@@ -13,17 +13,34 @@ export type PaymentOutput = PaymentNonTokenOutput | PaymentTokenOutput;
  *
  * Note than an OP_RETURN output is a NonTokenPaymentOutput
  */
-export interface PaymentNonTokenOutput {
-    /** The amount of satoshis in this tx output */
-    sats?: bigint;
-    /** The outputScript of this tx output */
-    script?: Script;
-}
+export type PaymentNonTokenOutput =
+    | {
+          /** The amount of satoshis in this tx output */
+          sats?: bigint;
+          /** The outputScript of this tx output */
+          script?: Script;
+          /**
+           * The eCash address of this tx output
+           * Alternative to script - if script is provided, address should not be set
+           */
+          address?: never;
+      }
+    | {
+          /** The amount of satoshis in this tx output */
+          sats?: bigint;
+          /** The outputScript of this tx output */
+          script?: never;
+          /**
+           * The eCash address of this tx output
+           * Alternative to script - if script is not provided, address must be set
+           */
+          address: string;
+      };
 
 /**
  * All token transaction outputs specified in Action have this shape
  */
-export interface PaymentTokenOutput extends PaymentNonTokenOutput {
+export type PaymentTokenOutput = PaymentNonTokenOutput & {
     /** The tokenId of the token associated with this tx output */
     tokenId: string;
     /**
@@ -34,4 +51,4 @@ export interface PaymentTokenOutput extends PaymentNonTokenOutput {
     atoms: bigint;
     /** Is this tx output a mint baton */
     isMintBaton: boolean;
-}
+};