ecash-lib 1.1.0 → 1.2.1-rc

package/.nyc_output/processinfo/0fc40ca6-d52c-45eb-b31b-2601ce70b887.json

@@ -0,0 +1 @@
+{"parent":"b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8","pid":2715843,"argv":["/home/joey/.nvm/versions/node/v20.11.0/bin/node","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/node_modules/mocha/lib/cli/cli.js","./src/ecc.test.ts","./src/hash.test.ts","./src/op.test.ts","./src/script.test.ts","./src/sigHashType.test.ts","./src/tx.test.ts","./src/unsignedTx.test.ts","./src/io/bytes.test.ts","./src/io/varsize.test.ts","./src/io/writerbytes.test.ts","./src/io/writerlength.test.ts","--reporter","mocha-junit-reporter","--reporter-option","mochaFile=test_results/ecash-lib-junit.xml","--reporter-option","testsuitesTitle=Ecash Lib Unit Tests","--reporter-option","rootSuiteTitle=Ecash Lib","--no-config","--no-package","--diff","--extension","js","--extension","cjs","--extension","mjs","--slow","75","--timeout","2000","--ui","bdd","--watch-ignore","node_modules","--watch-ignore",".git"],"execArgv":["--import=tsx"],"cwd":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib","time":1714065308447,"ppid":2715833,"coverageFilename":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/.nyc_output/0fc40ca6-d52c-45eb-b31b-2601ce70b887.json","externalId":"","uuid":"0fc40ca6-d52c-45eb-b31b-2601ce70b887","files":[]}

package/.nyc_output/processinfo/ac5be6db-4e40-41f8-8b84-7598d4747e57.json

@@ -0,0 +1 @@
+{"parent":null,"pid":2715808,"argv":["/home/joey/.nvm/versions/node/v20.11.0/bin/node","/home/joey/.nvm/versions/node/v20.11.0/bin/npm","test","--","--reporter","mocha-junit-reporter","--reporter-options","mochaFile=test_results/ecash-lib-junit.xml","--reporter-options","testsuitesTitle=Ecash Lib Unit Tests","--reporter-options","rootSuiteTitle=Ecash Lib"],"execArgv":[],"cwd":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib","time":1714065307741,"ppid":2715758,"coverageFilename":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/.nyc_output/ac5be6db-4e40-41f8-8b84-7598d4747e57.json","externalId":"","uuid":"ac5be6db-4e40-41f8-8b84-7598d4747e57","files":[]}

package/.nyc_output/processinfo/b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8.json

@@ -0,0 +1 @@
+{"parent":"ac5be6db-4e40-41f8-8b84-7598d4747e57","pid":2715833,"argv":["/home/joey/.nvm/versions/node/v20.11.0/bin/node","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/node_modules/.bin/mocha","--import=tsx","./src/ecc.test.ts","./src/hash.test.ts","./src/op.test.ts","./src/script.test.ts","./src/sigHashType.test.ts","./src/tx.test.ts","./src/unsignedTx.test.ts","./src/io/bytes.test.ts","./src/io/varsize.test.ts","./src/io/writerbytes.test.ts","./src/io/writerlength.test.ts","--reporter","mocha-junit-reporter","--reporter-options","mochaFile=test_results/ecash-lib-junit.xml","--reporter-options","testsuitesTitle=Ecash Lib Unit Tests","--reporter-options","rootSuiteTitle=Ecash Lib"],"execArgv":[],"cwd":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib","time":1714065308079,"ppid":2715832,"coverageFilename":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/.nyc_output/b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8.json","externalId":"","uuid":"b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8","files":[]}

package/.nyc_output/processinfo/f965566b-9422-4874-b45e-9eefda9c769c.json

@@ -0,0 +1 @@
+{"parent":null,"pid":2715758,"argv":["/home/joey/.nvm/versions/node/v20.11.0/bin/node","/home/joey/.nvm/versions/node/v20.11.0/bin/nyc","--reporter=text","--reporter=lcov","--reporter=teamcity","npm","test","--","--reporter","mocha-junit-reporter","--reporter-options","mochaFile=test_results/ecash-lib-junit.xml","--reporter-options","testsuitesTitle=Ecash Lib Unit Tests","--reporter-options","rootSuiteTitle=Ecash Lib"],"execArgv":[],"cwd":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib","time":1714065305953,"ppid":2715321,"coverageFilename":"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/.nyc_output/f965566b-9422-4874-b45e-9eefda9c769c.json","externalId":"","uuid":"f965566b-9422-4874-b45e-9eefda9c769c","files":["/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/ffi/ecash_lib_wasm.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/ecc.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/hash.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/index.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/bytes.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/hex.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/int.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/str.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/varsize.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writer.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writerbytes.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writerlength.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/op.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/opcode.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/script.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/sigHashType.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/alp.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/common.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/empp.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/tx.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/txBuilder.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/unsignedTx.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/eslint.config.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/ecc.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/ffi/ecash_lib_wasm.js","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/hash.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/index.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/bytes.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/hex.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/int.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/str.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/varsize.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writer.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writerbytes.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writerlength.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/op.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/opcode.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/script.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/sigHashType.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/alp.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/common.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/empp.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/tx.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/txBuilder.ts","/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/unsignedTx.ts"]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"0fc40ca6-d52c-45eb-b31b-2601ce70b887":{"parent":"b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8","children":[]},"ac5be6db-4e40-41f8-8b84-7598d4747e57":{"parent":null,"children":["b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8"]},"b316d46f-5ea0-4e98-884a-bfbf9cc1d0f8":{"parent":"ac5be6db-4e40-41f8-8b84-7598d4747e57","children":["0fc40ca6-d52c-45eb-b31b-2601ce70b887"]},"f965566b-9422-4874-b45e-9eefda9c769c":{"parent":null,"children":[]}},"files":{"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/ffi/ecash_lib_wasm.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/ecc.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/hash.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/index.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/bytes.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/hex.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/int.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/str.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/varsize.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writer.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writerbytes.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/io/writerlength.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/op.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/opcode.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/script.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/sigHashType.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/alp.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/common.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/token/empp.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/tx.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/txBuilder.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/dist/src/unsignedTx.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/eslint.config.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/ecc.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/ffi/ecash_lib_wasm.js":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/hash.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/index.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/bytes.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/hex.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/int.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/str.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/varsize.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writer.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writerbytes.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/io/writerlength.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/op.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/opcode.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/script.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/sigHashType.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/alp.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/common.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/token/empp.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/tx.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/txBuilder.ts":["f965566b-9422-4874-b45e-9eefda9c769c"],"/home/joey/github/abc/bitcoin-abc/modules/ecash-lib/src/unsignedTx.ts":["f965566b-9422-4874-b45e-9eefda9c769c"]},"externalIds":{}}

package/README.md

@@ -105,3 +105,5 @@ console.log(toHex(rawTx));
 -   1.0.0 - **(Breaking change)** Modify `GenesisInfo` so that `auth` and `data` types match [D17194](https://reviews.bitcoinabc.org/D17194)
 -   1.0.1 - Include `ecashaddrjs` and `chronik-client` installations from `npmjs` instead of local, to prevent need for peer dependencies [D17215](https://reviews.bitcoinabc.org/D17215)
 -   1.1.0 - Add support for the original pre-UAHF Bitcoin signatures, so we can sign transactions for other blockchains like BTC/DOGE/... [D17255](https://reviews.bitcoinabc.org/D17255)
+-   1.2.0 - Add `Address` class for cashaddr and legacy addresses. [D17269](https://reviews.bitcoinabc.org/D17269)
+-   1.2.1 - Patch type check causing txBuilder txs using change to fail in NodeJS environments [D17461](https://reviews.bitcoinabc.org/D17461)

package/dist/address/address.d.ts

@@ -0,0 +1,131 @@
+import { Script } from '../script';
+export type AddressType = 'p2pkh' | 'p2sh';
+export type AddressEncoding = 'cashaddr' | 'legacy';
+export declare const ECASH_PREFIXES_TESTNET: string[];
+/**
+ * Converts an ecash address in cashaddr format to legacy format
+ * Throws if user attempts to convert a legacy address to a legacy address
+ * Separated as its own function here for
+ *
+ * 1 - simpler unit testing
+ * 2 - exported for users looking to convert string cashaddr to string legacy addr
+ *     without using the Address class
+ */
+export declare const toLegacyAddress: (cashaddress: string) => string;
+interface AddressInterface {
+    /**
+     * hash
+     * The hash this address encodes as a hex string.
+     * It's part of the Script this address represents.
+     */
+    hash: string;
+    /**
+     * p2pkh or p2sh
+     * The type of address
+     * Address supports p2pkh or p2sh address types
+     */
+    type: AddressType;
+    /**
+     * Defined for a cashaddr address, i.e. one with encoding === 'cashaddr'
+     * This is distinct from the version byte. Common prefixes on ecash include
+     * 'ecash', 'etoken', 'ectest', and 'ecregest'. But a prefix could be anything
+     * so long as the address checksum matches.
+     */
+    prefix?: string;
+    /**
+     * encoded address as a string
+     * cashaddr or legacy
+     * type available in 'encoding' field
+     */
+    address: string;
+    /**
+     * How this address is encoded
+     * cashaddr or legacy
+     * If cashaddr, 'prefix' is defined and a string
+     */
+    encoding: AddressEncoding;
+}
+export declare const DEFAULT_PREFIX = "ecash";
+/**
+ * Address
+ * Stores properties of supported crypto addresses
+ * in standard typed structure. Provides methods for
+ * easy access of address data in dev-friendly formats.
+ * Provides methods for instantiating by type, encoding,
+ * script, prefix, and address string of arbitrary encoding.
+ *
+ * Simplifies conversion between cashaddr prefixes and
+ * address encoding types.
+ *
+ * Address is an ecash-first class. Legacy BTC format
+ * is supported to simplify conversion to and from
+ * ecash addresses.
+ *
+ * Address may be extended to support other crypto
+ * address formats.
+ */
+export declare class Address implements AddressInterface {
+    hash: string;
+    type: AddressType;
+    prefix?: string;
+    address: string;
+    encoding: AddressEncoding;
+    private constructor();
+    /**
+     * Create a new p2pkh Address from hash
+     * cashaddr encoding, ecash: prefix
+     */
+    static p2pkh: (hash: string | Uint8Array) => Address;
+    /**
+     * Create a new p2sh Address from hash
+     * cashaddr encoding
+     * ecash: prefix
+     */
+    static p2sh: (hash: string | Uint8Array) => Address;
+    /**
+     * Create a new Address from a given address string
+     * address must be valid legacy or cashaddr address
+     */
+    static parse: (address: string) => Address;
+    /**
+     * Create a new Address from a cashaddr
+     * prefix, type, and hash from creating cashaddr
+     */
+    static fromCashAddress: (address: string) => Address;
+    /**
+     * Create a new Address from legacy address
+     * No prefix for Address created from legacy address
+     * type and hash from legacy address
+     */
+    static fromLegacyAddress: (legacy: string) => Address;
+    /**
+     * Create a new Address from an outputScript as Script
+     * type and hash from outputScript
+     * cashaddr encoding
+     * ecash: prefix
+     */
+    static fromScript: (script: Script) => Address;
+    /**
+     * Create a new Address from an outputScript as hex string
+     * type and hash from outputScript
+     * cashaddr encoding
+     * ecash: prefix
+     */
+    static fromScriptHex: (scriptHex: string) => Address;
+    toString: () => string;
+    legacy: () => Address;
+    /**
+     * Create an Address with cashaddr encoding
+     * from an existing Address
+     */
+    cash: () => Address;
+    /**
+     * Create address with specified prefix
+     * from an existing cashaddr-encoding Address
+     */
+    withPrefix: (prefix: string) => Address;
+    toScript: () => Script;
+    toScriptHex: () => string;
+}
+export {};
+//# sourceMappingURL=address.d.ts.map

package/dist/address/address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../src/address/address.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,CAAC;AAC3C,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEpD,eAAO,MAAM,sBAAsB,UAA0B,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,gBAAiB,MAAM,KAAG,MA4CrD,CAAC;AAEF,UAAU,gBAAgB;IACtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC7B;AAaD,eAAO,MAAM,cAAc,UAAU,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAQ,YAAW,gBAAgB;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,eAAe,CAAC;IAE1B,OAAO;IAWP;;;OAGG;IACH,MAAM,CAAC,KAAK,SAAU,MAAM,GAAG,UAAU,aAOlC;IAEP;;;;OAIG;IACH,MAAM,CAAC,IAAI,SAAU,MAAM,GAAG,UAAU,aAOjC;IAEP;;;OAGG;IACH,MAAM,CAAC,KAAK,YAAa,MAAM,aAsB7B;IAEF;;;OAGG;IACH,MAAM,CAAC,eAAe,YAAa,MAAM,aASvC;IAEF;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,WAAY,MAAM,aASxC;IAEF;;;;;OAKG;IACH,MAAM,CAAC,UAAU,WAAY,MAAM,aAGjC;IAEF;;;;;OAKG;IACH,MAAM,CAAC,aAAa,cAAe,MAAM,aAcvC;IAEF,QAAQ,eAEN;IAEF,MAAM,gBAMC;IAEP;;;OAGG;IACH,IAAI,gBAgBG;IAEP;;;OAGG;IACH,UAAU,WAAY,MAAM,aAgB1B;IAEF,QAAQ,QAAO,MAAM,CAInB;IAEF,WAAW,QAAO,MAAM,CAEtB;CACL"}

package/dist/address/address.js

@@ -0,0 +1,253 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Address = exports.DEFAULT_PREFIX = exports.toLegacyAddress = exports.ECASH_PREFIXES_TESTNET = void 0;
+// Copyright (c) 2024 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+const hex_1 = require("../io/hex");
+const ecashaddrjs_1 = require("ecashaddrjs");
+const legacyaddr_1 = require("./legacyaddr");
+const script_1 = require("../script");
+exports.ECASH_PREFIXES_TESTNET = ['ectest', 'ecregtest'];
+/**
+ * Converts an ecash address in cashaddr format to legacy format
+ * Throws if user attempts to convert a legacy address to a legacy address
+ * Separated as its own function here for
+ *
+ * 1 - simpler unit testing
+ * 2 - exported for users looking to convert string cashaddr to string legacy addr
+ *     without using the Address class
+ */
+const toLegacyAddress = (cashaddress) => {
+    try {
+        // No-op if user is trying to convert legacy to legacy
+        (0, legacyaddr_1.decodeLegacyAddress)(cashaddress);
+        return cashaddress;
+    }
+    catch {
+        // Do nothing with this error since we expect it every time for the function's intended use case
+        // Proceed to convert to legacy
+    }
+    const { prefix, type, hash } = (0, ecashaddrjs_1.decodeCashAddress)(cashaddress);
+    const isTestnet = exports.ECASH_PREFIXES_TESTNET.includes(prefix);
+    // Get correct version byte for legacy format
+    let versionByte;
+    switch (type) {
+        case 'p2pkh':
+            versionByte = isTestnet
+                ? legacyaddr_1.LEGACY_VERSION_BYTES.legacy.testnet.p2pkh
+                : legacyaddr_1.LEGACY_VERSION_BYTES.legacy.mainnet.p2pkh;
+            break;
+        case 'p2sh':
+            versionByte = isTestnet
+                ? legacyaddr_1.LEGACY_VERSION_BYTES.legacy.testnet.p2sh
+                : legacyaddr_1.LEGACY_VERSION_BYTES.legacy.mainnet.p2sh;
+            break;
+        default:
+            throw new Error('Unsupported address type: ' + type);
+    }
+    // Convert hash to Uint8Array
+    const hashArray = (0, hex_1.fromHex)(hash);
+    // Create a new Uint8Array to hold the data
+    const uint8Array = new Uint8Array(1 + hashArray.length);
+    // Set the version byte
+    uint8Array[0] = versionByte;
+    // Set the hash
+    uint8Array.set(hashArray, 1);
+    // Encode to base58check
+    return (0, legacyaddr_1.encodeBase58Check)(uint8Array);
+};
+exports.toLegacyAddress = toLegacyAddress;
+exports.DEFAULT_PREFIX = 'ecash';
+/**
+ * Address
+ * Stores properties of supported crypto addresses
+ * in standard typed structure. Provides methods for
+ * easy access of address data in dev-friendly formats.
+ * Provides methods for instantiating by type, encoding,
+ * script, prefix, and address string of arbitrary encoding.
+ *
+ * Simplifies conversion between cashaddr prefixes and
+ * address encoding types.
+ *
+ * Address is an ecash-first class. Legacy BTC format
+ * is supported to simplify conversion to and from
+ * ecash addresses.
+ *
+ * Address may be extended to support other crypto
+ * address formats.
+ */
+class Address {
+    constructor(params) {
+        this.toString = () => {
+            return this.address;
+        };
+        this.legacy = () => new Address({
+            type: this.type,
+            hash: this.hash,
+            address: (0, exports.toLegacyAddress)(this.address),
+            encoding: 'legacy',
+        });
+        /**
+         * Create an Address with cashaddr encoding
+         * from an existing Address
+         */
+        this.cash = () => new Address({
+            type: this.type,
+            hash: this.hash,
+            address: (0, ecashaddrjs_1.encodeCashAddress)(typeof this.prefix !== 'undefined'
+                ? this.prefix
+                : exports.DEFAULT_PREFIX, this.type, this.hash),
+            encoding: 'cashaddr',
+            prefix: typeof this.prefix !== 'undefined'
+                ? this.prefix
+                : exports.DEFAULT_PREFIX,
+        });
+        /**
+         * Create address with specified prefix
+         * from an existing cashaddr-encoding Address
+         */
+        this.withPrefix = (prefix) => {
+            if (this.encoding === 'legacy') {
+                // Take no action for legacy address types
+                throw new Error('withPrefix does not support legacy address types');
+            }
+            if (this.prefix === prefix) {
+                // Take no action if prefix is not changing
+                throw new Error(`prefix is already "${this.prefix}"`);
+            }
+            return new Address({
+                type: this.type,
+                hash: this.hash,
+                prefix,
+                address: (0, ecashaddrjs_1.encodeCashAddress)(prefix, this.type, this.hash),
+                encoding: 'cashaddr',
+            });
+        };
+        this.toScript = () => {
+            return new script_1.Script((0, hex_1.fromHex)((0, ecashaddrjs_1.getOutputScriptFromTypeAndHash)(this.type, this.hash)));
+        };
+        this.toScriptHex = () => {
+            return (0, ecashaddrjs_1.getOutputScriptFromTypeAndHash)(this.type, this.hash);
+        };
+        const { hash, type, address, encoding } = params;
+        this.hash = hash;
+        this.type = type;
+        this.address = address;
+        this.encoding = encoding;
+        if (typeof params.prefix !== 'undefined') {
+            this.prefix = params.prefix;
+        }
+    }
+}
+exports.Address = Address;
+/**
+ * Create a new p2pkh Address from hash
+ * cashaddr encoding, ecash: prefix
+ */
+Address.p2pkh = (hash) => new Address({
+    type: 'p2pkh',
+    hash: hash instanceof Uint8Array ? (0, hex_1.toHex)(hash) : hash,
+    prefix: exports.DEFAULT_PREFIX,
+    address: (0, ecashaddrjs_1.encodeCashAddress)(exports.DEFAULT_PREFIX, 'p2pkh', hash),
+    encoding: 'cashaddr',
+});
+/**
+ * Create a new p2sh Address from hash
+ * cashaddr encoding
+ * ecash: prefix
+ */
+Address.p2sh = (hash) => new Address({
+    type: 'p2sh',
+    hash: hash instanceof Uint8Array ? (0, hex_1.toHex)(hash) : hash,
+    prefix: exports.DEFAULT_PREFIX,
+    address: (0, ecashaddrjs_1.encodeCashAddress)(exports.DEFAULT_PREFIX, 'p2sh', hash),
+    encoding: 'cashaddr',
+});
+/**
+ * Create a new Address from a given address string
+ * address must be valid legacy or cashaddr address
+ */
+Address.parse = (address) => {
+    if ((0, ecashaddrjs_1.isValidCashAddress)(address)) {
+        const { type, hash, prefix } = (0, ecashaddrjs_1.decodeCashAddress)(address);
+        return new Address({
+            type,
+            hash,
+            prefix,
+            encoding: 'cashaddr',
+            address,
+        });
+    }
+    try {
+        const { type, hash } = (0, legacyaddr_1.decodeLegacyAddress)(address);
+        return new Address({
+            type,
+            hash,
+            encoding: 'legacy',
+            address,
+        });
+    }
+    catch {
+        throw new Error('Invalid cashaddr or legacy address');
+    }
+};
+/**
+ * Create a new Address from a cashaddr
+ * prefix, type, and hash from creating cashaddr
+ */
+Address.fromCashAddress = (address) => {
+    const { type, hash, prefix } = (0, ecashaddrjs_1.decodeCashAddress)(address);
+    return new Address({
+        type,
+        hash,
+        address,
+        encoding: 'cashaddr',
+        prefix,
+    });
+};
+/**
+ * Create a new Address from legacy address
+ * No prefix for Address created from legacy address
+ * type and hash from legacy address
+ */
+Address.fromLegacyAddress = (legacy) => {
+    // Determine addr params from legacy address
+    const { type, hash } = (0, legacyaddr_1.decodeLegacyAddress)(legacy);
+    return new Address({
+        type,
+        hash,
+        address: legacy,
+        encoding: 'legacy',
+    });
+};
+/**
+ * Create a new Address from an outputScript as Script
+ * type and hash from outputScript
+ * cashaddr encoding
+ * ecash: prefix
+ */
+Address.fromScript = (script) => {
+    const scriptHex = (0, hex_1.toHex)(script.bytecode);
+    return Address.fromScriptHex(scriptHex);
+};
+/**
+ * Create a new Address from an outputScript as hex string
+ * type and hash from outputScript
+ * cashaddr encoding
+ * ecash: prefix
+ */
+Address.fromScriptHex = (scriptHex) => {
+    const { type, hash } = (0, ecashaddrjs_1.getTypeAndHashFromOutputScript)(scriptHex);
+    // Default cashaddr encoding with default prefix
+    const address = (0, ecashaddrjs_1.encodeCashAddress)(exports.DEFAULT_PREFIX, type, hash);
+    const prefix = exports.DEFAULT_PREFIX;
+    return new Address({
+        type,
+        hash,
+        prefix,
+        address,
+        encoding: 'cashaddr',
+    });
+};
+//# sourceMappingURL=address.js.map

package/dist/address/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../src/address/address.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;AACtE,mCAA2C;AAC3C,6CAMqB;AACrB,6CAIsB;AACtB,sCAAmC;AAKtB,QAAA,sBAAsB,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAE9D;;;;;;;;GAQG;AACI,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAU,EAAE;IAC3D,IAAI,CAAC;QACD,sDAAsD;QACtD,IAAA,gCAAmB,EAAC,WAAW,CAAC,CAAC;QACjC,OAAO,WAAW,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACL,gGAAgG;QAChG,+BAA+B;IACnC,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,+BAAiB,EAAC,WAAW,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,8BAAsB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE1D,6CAA6C;IAC7C,IAAI,WAAmB,CAAC;IACxB,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,OAAO;YACR,WAAW,GAAG,SAAS;gBACnB,CAAC,CAAC,iCAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK;gBAC3C,CAAC,CAAC,iCAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAChD,MAAM;QACV,KAAK,MAAM;YACP,WAAW,GAAG,SAAS;gBACnB,CAAC,CAAC,iCAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI;gBAC1C,CAAC,CAAC,iCAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;YAC/C,MAAM;QACV;YACI,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,6BAA6B;IAC7B,MAAM,SAAS,GAAG,IAAA,aAAO,EAAC,IAAI,CAAC,CAAC;IAEhC,2CAA2C;IAC3C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAExD,uBAAuB;IACvB,UAAU,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IAE5B,eAAe;IACf,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAE7B,wBAAwB;IACxB,OAAO,IAAA,8BAAiB,EAAC,UAAU,CAAC,CAAC;AACzC,CAAC,CAAC;AA5CW,QAAA,eAAe,mBA4C1B;AA+CW,QAAA,cAAc,GAAG,OAAO,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,OAAO;IAOhB,YAAoB,MAAgC;QAkIpD,aAAQ,GAAG,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC;QACxB,CAAC,CAAC;QAEF,WAAM,GAAG,GAAG,EAAE,CACV,IAAI,OAAO,CAAC;YACR,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAA,uBAAe,EAAC,IAAI,CAAC,OAAO,CAAC;YACtC,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;QAEP;;;WAGG;QACH,SAAI,GAAG,GAAG,EAAE,CACR,IAAI,OAAO,CAAC;YACR,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAA,+BAAiB,EACtB,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW;gBAC9B,CAAC,CAAC,IAAI,CAAC,MAAM;gBACb,CAAC,CAAC,sBAAc,EACpB,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,IAAI,CACZ;YACD,QAAQ,EAAE,UAAU;YACpB,MAAM,EACF,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW;gBAC9B,CAAC,CAAC,IAAI,CAAC,MAAM;gBACb,CAAC,CAAC,sBAAc;SAC3B,CAAC,CAAC;QAEP;;;WAGG;QACH,eAAU,GAAG,CAAC,MAAc,EAAE,EAAE;YAC5B,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC7B,0CAA0C;gBAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBACzB,2CAA2C;gBAC3C,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,IAAI,OAAO,CAAC;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM;gBACN,OAAO,EAAE,IAAA,+BAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;gBACxD,QAAQ,EAAE,UAAU;aACvB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,aAAQ,GAAG,GAAW,EAAE;YACpB,OAAO,IAAI,eAAM,CACb,IAAA,aAAO,EAAC,IAAA,4CAA8B,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAChE,CAAC;QACN,CAAC,CAAC;QAEF,gBAAW,GAAG,GAAW,EAAE;YACvB,OAAO,IAAA,4CAA8B,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC,CAAC;QAjME,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAChC,CAAC;IACL,CAAC;;AAhBL,0BA0MC;AAxLG;;;GAGG;AACI,aAAK,GAAG,CAAC,IAAyB,EAAE,EAAE,CACzC,IAAI,OAAO,CAAC;IACR,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,WAAK,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;IACrD,MAAM,EAAE,sBAAc;IACtB,OAAO,EAAE,IAAA,+BAAiB,EAAC,sBAAc,EAAE,OAAO,EAAE,IAAI,CAAC;IACzD,QAAQ,EAAE,UAAU;CACvB,CAAC,AAPM,CAOL;AAEP;;;;GAIG;AACI,YAAI,GAAG,CAAC,IAAyB,EAAE,EAAE,CACxC,IAAI,OAAO,CAAC;IACR,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,WAAK,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;IACrD,MAAM,EAAE,sBAAc;IACtB,OAAO,EAAE,IAAA,+BAAiB,EAAC,sBAAc,EAAE,MAAM,EAAE,IAAI,CAAC;IACxD,QAAQ,EAAE,UAAU;CACvB,CAAC,AAPK,CAOJ;AAEP;;;GAGG;AACI,aAAK,GAAG,CAAC,OAAe,EAAE,EAAE;IAC/B,IAAI,IAAA,gCAAkB,EAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAA,+BAAiB,EAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,OAAO,CAAC;YACf,IAAI;YACJ,IAAI;YACJ,MAAM;YACN,QAAQ,EAAE,UAAU;YACpB,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IACD,IAAI,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,gCAAmB,EAAC,OAAO,CAAC,CAAC;QACpD,OAAO,IAAI,OAAO,CAAC;YACf,IAAI;YACJ,IAAI;YACJ,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IAAC,MAAM,CAAC;QACL,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAC1D,CAAC;AACL,CAAC,AAtBW,CAsBV;AAEF;;;GAGG;AACI,uBAAe,GAAG,CAAC,OAAe,EAAE,EAAE;IACzC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAA,+BAAiB,EAAC,OAAO,CAAC,CAAC;IAC1D,OAAO,IAAI,OAAO,CAAC;QACf,IAAI;QACJ,IAAI;QACJ,OAAO;QACP,QAAQ,EAAE,UAAU;QACpB,MAAM;KACT,CAAC,CAAC;AACP,CAAC,AATqB,CASpB;AAEF;;;;GAIG;AACI,yBAAiB,GAAG,CAAC,MAAc,EAAE,EAAE;IAC1C,4CAA4C;IAC5C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,gCAAmB,EAAC,MAAM,CAAC,CAAC;IACnD,OAAO,IAAI,OAAO,CAAC;QACf,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE,QAAQ;KACrB,CAAC,CAAC;AACP,CAAC,AATuB,CAStB;AAEF;;;;;GAKG;AACI,kBAAU,GAAG,CAAC,MAAc,EAAE,EAAE;IACnC,MAAM,SAAS,GAAG,IAAA,WAAK,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,OAAO,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC,AAHgB,CAGf;AAEF;;;;;GAKG;AACI,qBAAa,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,4CAA8B,EAAC,SAAS,CAAC,CAAC;IAEjE,gDAAgD;IAChD,MAAM,OAAO,GAAG,IAAA,+BAAiB,EAAC,sBAAc,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9D,MAAM,MAAM,GAAG,sBAAc,CAAC;IAE9B,OAAO,IAAI,OAAO,CAAC;QACf,IAAI;QACJ,IAAI;QACJ,MAAM;QACN,OAAO;QACP,QAAQ,EAAE,UAAU;KACvB,CAAC,CAAC;AACP,CAAC,AAdmB,CAclB"}

package/dist/address/cashaddr.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Handle cashaddr methods
+ * Improve and extend existing functionality of the ecashaddrjs lib
+ *
+ * Spec
+ * https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md
+ */
+export type AddressType = 'p2pkh' | 'p2sh';
+export declare const ADDRESS_TYPES: AddressType[];
+export declare const VALID_HASH_SIZES: number[];
+/**
+ * Converts an array of integers made up of 'from' bits into an
+ * array of integers made up of 'to' bits. The output array is
+ * zero-padded if necessary, unless strict mode is true.
+ * Original by Pieter Wuille: https://github.com/sipa/bech32.
+ *
+ * @param data Array of integers made up of 'from' bits.
+ * @param from Length in bits of elements in the input array.
+ * @param to Length in bits of elements in the output array.
+ * @param strictMode Require the conversion to be completed without padding.
+ */
+export declare const convertBits: (data: Uint8Array, from: number, to: number, strictMode?: boolean) => Uint8Array;
+export declare const getHashSize: (versionByte: number) => number;
+/**
+ * Base 32 encoding / decoding
+ */
+export declare const BASE32_CHARSET: string;
+/**
+ * Encodes the given array of 5-bit integers as a base32-encoded string.
+ * @param data Array of integers between 0 and 31 inclusive.
+ */
+export declare const encodeBase32: (data: Uint8Array) => string;
+export declare const decodeBase32: (string: string) => Uint8Array;
+/**
+ * Encode a hash as a p2pkh or p2sh cashaddr
+ * defaults to p2pkh "ecash"-prefixed cashaddr
+ */
+export declare const toCashAddress: (hash: string | Uint8Array, prefix?: string, type?: AddressType) => string;
+interface DecodedAddress {
+    prefix: string;
+    type: AddressType;
+    hash: string;
+}
+export declare const decodeCashAddress: (address: string) => DecodedAddress;
+/**
+ * Get type and hash from an outputScript
+ *
+ * Supported outputScripts:
+ *
+ * p2pkh: 76a914<hash>88ac
+ * p2sh:  a914<hash>87
+ *
+ * Validates for supported outputScript and hash length
+ */
+export declare const getTypeAndHashFromOutputScript: (outputScript: string) => {
+    type: AddressType;
+    hash: string;
+};
+export declare const outputScriptToAddress: (outputScript: string, prefix?: string) => string;
+export declare const ECASH_PREFIXES_MAINNET: string[];
+export declare const toLegacyAddress: (cashaddress: string) => string;
+type NetworkType = 'mainnet' | 'testnet';
+export interface DecodedLegacyAddress {
+    type: AddressType;
+    hash: string;
+    network: NetworkType;
+}
+export declare const decodeLegacyAddress: (address: string) => DecodedLegacyAddress;
+/**
+ * Encode a legacy address given type and hash
+ * For now, this is a stub method that supports only BTC p2pkh and p2sh
+ */
+export declare const encodeLegacyAddress: (hash: Uint8Array, type: 'p2pkh' | 'p2sh', network?: NetworkType) => string;
+export declare const isValidCashAddress: (cashaddress: string, optionalPrefix?: boolean | string) => boolean;
+export declare const encodeOutputScript: (type: AddressType, hash: string) => string;
+export declare const getOutputScriptFromAddress: (address: string) => string;
+export {};
+//# sourceMappingURL=cashaddr.d.ts.map

package/dist/address/cashaddr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cashaddr.d.ts","sourceRoot":"","sources":["../../src/address/cashaddr.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,CAAC;AAC3C,eAAO,MAAM,aAAa,EAAE,WAAW,EAAsB,CAAC;AAG9D,eAAO,MAAM,gBAAgB,UAAmC,CAAC;AAiEjE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,SACd,UAAU,QACV,MAAM,MACR,MAAM,eACE,OAAO,KACpB,UAqCF,CAAC;AAsDF,eAAO,MAAM,WAAW,gBAAiB,MAAM,KAAG,MAqBjD,CAAC;AAiBF;;GAEG;AAGH,eAAO,MAAM,cAAc,EAAE,MAA2C,CAAC;AAsCzE;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAU,UAAU,KAAG,MAa/C,CAAC;AAGF,eAAO,MAAM,YAAY,WAAY,MAAM,KAAG,UAc7C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,SAChB,MAAM,GAAG,UAAU,0BAEnB,WAAW,WAmCpB,CAAC;AAEF,UAAU,cAAc;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,iBAAiB,YAAa,MAAM,KAAG,cAmDnD,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,8BAA8B,iBACzB,MAAM;UACb,WAAW;UAAQ,MAAM;CA4CnC,CAAC;AAGF,eAAO,MAAM,qBAAqB,iBAChB,MAAM,sBAErB,MAMF,CAAC;AAEF,eAAO,MAAM,sBAAsB,UAAsB,CAAC;AAG1D,eAAO,MAAM,eAAe,gBAAiB,MAAM,KAAG,MAyCrD,CAAC;AAEF,KAAK,WAAW,GAAG,SAAS,GAAG,SAAS,CAAC;AACzC,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,WAAW,CAAC;CACxB;AAuBD,eAAO,MAAM,mBAAmB,YAAa,MAAM,KAAG,oBA4CrD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,SACtB,UAAU,QACV,OAAO,GAAG,MAAM,YACb,WAAW,WAOvB,CAAC;AAIF,eAAO,MAAM,kBAAkB,gBACd,MAAM,mBACH,OAAO,GAAG,MAAM,KACjC,OAUF,CAAC;AAEF,eAAO,MAAM,kBAAkB,SAAU,WAAW,QAAQ,MAAM,KAAG,MAQpE,CAAC;AAEF,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAS5D,CAAC"}