@meshsdk/bitcoin 1.9.0-beta.50 → 1.9.0-beta.53

package/dist/index.d.cts

@@ -198,44 +198,49 @@ declare class BrowserWallet implements IBitcoinWallet {
     submitTx(signedTx: string): Promise<string>;
 }
 
-type CreateBitcoinEmbeddedWalletOptions = {
-    networkId: 0 | 1;
+type CreateWalletOptions = {
+    testnet: boolean;
     key: {
         type: "mnemonic";
         words: string[];
     };
+    path?: string;
     provider?: IBitcoinProvider;
 };
 /**
- * 0': Indicates the Bitcoin mainnet.
- * 1': Indicates the Bitcoin testnet.
- *
  * EmbeddedWallet is a class that provides a simple interface to interact with Bitcoin wallets.
- *
- * @params options - The options to create an EmbeddedWallet.
- * networkId - The network ID of the wallet.
- * key - The key to create the wallet.
- * provider - The Bitcoin provider to interact with the Bitcoin network.
  */
 declare class EmbeddedWallet {
-    private readonly _networkId;
-    private readonly _BIP32Interface;
-    private readonly _p2wpkh;
+    private readonly _network;
+    private readonly _wallet;
     private readonly _provider?;
-    constructor(options: CreateBitcoinEmbeddedWalletOptions);
+    constructor(options: CreateWalletOptions);
     /**
-     * Get wallet network ID.
+     * Returns the wallet's SegWit (P2WPKH) address and associated public key.
      *
-     * @returns network ID
+     * @returns {Address} The wallet address object including address, public key, and metadata.
+     * @throws {Error} If internal address or public key is not properly initialized.
+     */
+    getAddress(): Address;
+    /**
+     * Returns the hex-encoded public key of the wallet.
+     *
+     * @returns {string} The public key in hexadecimal format.
      */
-    getNetworkId(): 0 | 1;
-    getPaymentAddress(): Address;
     getPublicKey(): string;
+    /**
+     * Returns the network identifier of the wallet.
+     * 0': Indicates the Bitcoin mainnet.
+     * 1': Indicates the Bitcoin testnet.
+     *
+     * @returns {0 | 1} The Bitcoin network ID.
+     */
+    getNetworkId(): 0 | 1;
     /**
      * Get UTXOs for the wallet address.
      * @returns An array of UTXOs.
      */
-    getUtxos(): Promise<UTxO[]>;
+    getUTxOs(): Promise<UTxO[]>;
     /**
      * Signs a given message using the wallet's private key.
      *
@@ -250,12 +255,13 @@ declare class EmbeddedWallet {
      */
     signTx(payload: bitcoin.Transaction): string;
     /**
-     * Generate mnemonic or private key
+     * Generates a mnemonic phrase and returns it as an array of words.
      *
-     * @param privateKey return private key if true
-     * @returns a transaction hash
+     * @param {number} [strength=128] - The strength of the mnemonic in bits (must be a multiple of 32 between 128 and 256).
+     * @returns {string[]} An array of words representing the generated mnemonic.
+     * @throws {Error} If the strength is not valid.
      */
     static brew(strength?: number): string[];
 }
 
-export { type Address, BlockstreamProvider, BrowserWallet, type CreateBitcoinEmbeddedWalletOptions, ECPair, EmbeddedWallet, type IBitcoinWallet, type UTxO, bip32 };
+export { type Address, BlockstreamProvider, BrowserWallet, type CreateWalletOptions, ECPair, EmbeddedWallet, type IBitcoinWallet, type UTxO, bip32 };

package/dist/index.d.ts

@@ -198,44 +198,49 @@ declare class BrowserWallet implements IBitcoinWallet {
     submitTx(signedTx: string): Promise<string>;
 }
 
-type CreateBitcoinEmbeddedWalletOptions = {
-    networkId: 0 | 1;
+type CreateWalletOptions = {
+    testnet: boolean;
     key: {
         type: "mnemonic";
         words: string[];
     };
+    path?: string;
     provider?: IBitcoinProvider;
 };
 /**
- * 0': Indicates the Bitcoin mainnet.
- * 1': Indicates the Bitcoin testnet.
- *
  * EmbeddedWallet is a class that provides a simple interface to interact with Bitcoin wallets.
- *
- * @params options - The options to create an EmbeddedWallet.
- * networkId - The network ID of the wallet.
- * key - The key to create the wallet.
- * provider - The Bitcoin provider to interact with the Bitcoin network.
  */
 declare class EmbeddedWallet {
-    private readonly _networkId;
-    private readonly _BIP32Interface;
-    private readonly _p2wpkh;
+    private readonly _network;
+    private readonly _wallet;
     private readonly _provider?;
-    constructor(options: CreateBitcoinEmbeddedWalletOptions);
+    constructor(options: CreateWalletOptions);
     /**
-     * Get wallet network ID.
+     * Returns the wallet's SegWit (P2WPKH) address and associated public key.
      *
-     * @returns network ID
+     * @returns {Address} The wallet address object including address, public key, and metadata.
+     * @throws {Error} If internal address or public key is not properly initialized.
+     */
+    getAddress(): Address;
+    /**
+     * Returns the hex-encoded public key of the wallet.
+     *
+     * @returns {string} The public key in hexadecimal format.
      */
-    getNetworkId(): 0 | 1;
-    getPaymentAddress(): Address;
     getPublicKey(): string;
+    /**
+     * Returns the network identifier of the wallet.
+     * 0': Indicates the Bitcoin mainnet.
+     * 1': Indicates the Bitcoin testnet.
+     *
+     * @returns {0 | 1} The Bitcoin network ID.
+     */
+    getNetworkId(): 0 | 1;
     /**
      * Get UTXOs for the wallet address.
      * @returns An array of UTXOs.
      */
-    getUtxos(): Promise<UTxO[]>;
+    getUTxOs(): Promise<UTxO[]>;
     /**
      * Signs a given message using the wallet's private key.
      *
@@ -250,12 +255,13 @@ declare class EmbeddedWallet {
      */
     signTx(payload: bitcoin.Transaction): string;
     /**
-     * Generate mnemonic or private key
+     * Generates a mnemonic phrase and returns it as an array of words.
      *
-     * @param privateKey return private key if true
-     * @returns a transaction hash
+     * @param {number} [strength=128] - The strength of the mnemonic in bits (must be a multiple of 32 between 128 and 256).
+     * @returns {string[]} An array of words representing the generated mnemonic.
+     * @throws {Error} If the strength is not valid.
      */
     static brew(strength?: number): string[];
 }
 
-export { type Address, BlockstreamProvider, BrowserWallet, type CreateBitcoinEmbeddedWalletOptions, ECPair, EmbeddedWallet, type IBitcoinWallet, type UTxO, bip32 };
+export { type Address, BlockstreamProvider, BrowserWallet, type CreateWalletOptions, ECPair, EmbeddedWallet, type IBitcoinWallet, type UTxO, bip32 };

package/dist/index.js

@@ -3533,24 +3533,23 @@ var axios_default = axios;
 var Axios2 = axios_default.Axios, AxiosError2 = axios_default.AxiosError, CanceledError2 = axios_default.CanceledError, isCancel2 = axios_default.isCancel, CancelToken2 = axios_default.CancelToken, VERSION2 = axios_default.VERSION, all2 = axios_default.all, Cancel = axios_default.Cancel, isAxiosError2 = axios_default.isAxiosError, spread2 = axios_default.spread, toFormData2 = axios_default.toFormData, AxiosHeaders2 = axios_default.AxiosHeaders, HttpStatusCode2 = axios_default.HttpStatusCode, formToJSON = axios_default.formToJSON, getAdapter = axios_default.getAdapter, mergeConfig2 = axios_default.mergeConfig;
 // src/providers/common.ts
 var parseHttpError = function(error) {
-    if (axios_default.isAxiosError(error)) {
-        if (error.response) {
-            return JSON.stringify({
-                data: error.response.data,
-                headers: error.response.headers,
-                status: error.response.status
-            });
-        } else if (error.request && !_instanceof(error.request, XMLHttpRequest)) {
-            return JSON.stringify(error.request);
-        } else {
-            return JSON.stringify({
-                code: error.code,
-                message: error.message
-            });
-        }
-    } else {
+    if (!axios_default.isAxiosError(error)) {
         return JSON.stringify(error);
     }
+    if (error.response) {
+        return JSON.stringify({
+            data: error.response.data,
+            headers: error.response.headers,
+            status: error.response.status
+        });
+    }
+    if (error.request && !_instanceof(error.request, XMLHttpRequest)) {
+        return JSON.stringify(error.request);
+    }
+    return JSON.stringify({
+        code: error.code,
+        message: error.message
+    });
 };
 // src/providers/blockstream.ts
 var BlockstreamProvider = /*#__PURE__*/ function() {
@@ -4235,58 +4234,68 @@ var WalletStaticMethods = /*#__PURE__*/ function() {
     return WalletStaticMethods;
 }();
 // src/wallets/embedded/index.ts
+import { mnemonicToSeedSync, validateMnemonic } from "bip39";
 var EmbeddedWallet = /*#__PURE__*/ function() {
     "use strict";
     function EmbeddedWallet(options) {
         _class_call_check(this, EmbeddedWallet);
-        this._networkId = options.networkId;
-        var bIP32Interface = WalletStaticMethods2.fromMnemonic(options.key.words.join(" "), options.networkId);
-        this._BIP32Interface = bIP32Interface;
-        this._p2wpkh = bitcoin.payments.p2wpkh({
-            pubkey: this._BIP32Interface.publicKey,
-            network: this._networkId === 0 ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
-        });
+        this._network = options.testnet ? bitcoin.networks.testnet : bitcoin.networks.bitcoin;
+        var _options_path;
+        this._wallet = _derive(options.key.words, (_options_path = options.path) !== null && _options_path !== void 0 ? _options_path : "m/84'/0'/0'/0/0", this._network);
         this._provider = options.provider;
     }
     _create_class(EmbeddedWallet, [
         {
             /**
-   * Get wallet network ID.
+   * Returns the wallet's SegWit (P2WPKH) address and associated public key.
    *
-   * @returns network ID
-   */ key: "getNetworkId",
-            value: function getNetworkId() {
-                return this._networkId;
-            }
-        },
-        {
-            /*
-   * Get wallet address.
-   *
-   * @returns wallet address
-   */ key: "getPaymentAddress",
-            value: function getPaymentAddress() {
-                var address = {
-                    address: this._p2wpkh.address,
-                    publicKey: this._BIP32Interface.publicKey.toString("hex"),
+   * @returns {Address} The wallet address object including address, public key, and metadata.
+   * @throws {Error} If internal address or public key is not properly initialized.
+   */ key: "getAddress",
+            value: function getAddress() {
+                var p2wpkh = bitcoin.payments.p2wpkh({
+                    pubkey: this._wallet.publicKey,
+                    network: this._network
+                });
+                if (!(p2wpkh === null || p2wpkh === void 0 ? void 0 : p2wpkh.address)) {
+                    throw new Error("Address is not initialized.");
+                }
+                return {
+                    address: p2wpkh.address,
+                    publicKey: this._wallet.publicKey.toString("hex"),
                     purpose: "payment",
                     addressType: "p2wpkh"
                 };
-                return address;
             }
         },
         {
-            key: "getPublicKey",
+            /**
+   * Returns the hex-encoded public key of the wallet.
+   *
+   * @returns {string} The public key in hexadecimal format.
+   */ key: "getPublicKey",
             value: function getPublicKey() {
-                return this._BIP32Interface.publicKey.toString("hex");
+                return this._wallet.publicKey.toString("hex");
+            }
+        },
+        {
+            /**
+   * Returns the network identifier of the wallet.
+   * 0': Indicates the Bitcoin mainnet.
+   * 1': Indicates the Bitcoin testnet.
+   *
+   * @returns {0 | 1} The Bitcoin network ID.
+   */ key: "getNetworkId",
+            value: function getNetworkId() {
+                return this._network === bitcoin.networks.testnet ? 1 : 0;
             }
         },
         {
-            key: "getUtxos",
+            key: "getUTxOs",
             value: /**
    * Get UTXOs for the wallet address.
    * @returns An array of UTXOs.
-   */ function getUtxos() {
+   */ function getUTxOs() {
                 var _this = this;
                 return _async_to_generator(function() {
                     var _this__provider, address;
@@ -4294,7 +4303,7 @@ var EmbeddedWallet = /*#__PURE__*/ function() {
                         switch(_state.label){
                             case 0:
                                 console.log("getUtxos");
-                                address = _this.getPaymentAddress();
+                                address = _this.getAddress();
                                 if (_this._provider === void 0) {
                                     throw new Error("`provider` is not defined. Provide a BitcoinProvider.");
                                 }
@@ -4337,12 +4346,22 @@ var EmbeddedWallet = /*#__PURE__*/ function() {
         {
             key: "brew",
             value: /**
-   * Generate mnemonic or private key
+   * Generates a mnemonic phrase and returns it as an array of words.
    *
-   * @param privateKey return private key if true
-   * @returns a transaction hash
+   * @param {number} [strength=128] - The strength of the mnemonic in bits (must be a multiple of 32 between 128 and 256).
+   * @returns {string[]} An array of words representing the generated mnemonic.
+   * @throws {Error} If the strength is not valid.
    */ function brew() {
                 var strength = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : 128;
+                if (![
+                    128,
+                    160,
+                    192,
+                    224,
+                    256
+                ].includes(strength)) {
+                    throw new Error("Invalid strength. Must be one of: 128, 160, 192, 224, 256.");
+                }
                 var mnemonic = bip39.generateMnemonic(strength);
                 return mnemonic.split(" ");
             }
@@ -4350,34 +4369,16 @@ var EmbeddedWallet = /*#__PURE__*/ function() {
     ]);
     return EmbeddedWallet;
 }();
-var WalletStaticMethods2 = /*#__PURE__*/ function() {
-    "use strict";
-    function _WalletStaticMethods() {
-        _class_call_check(this, _WalletStaticMethods);
+function _derive(words) {
+    var path = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : "m/84'/0'/0'/0/0", network = arguments.length > 2 ? arguments[2] : void 0;
+    var mnemonic = words.join(" ");
+    if (!validateMnemonic(mnemonic)) {
+        throw new Error("Invalid mnemonic provided.");
     }
-    _create_class(_WalletStaticMethods, null, [
-        {
-            key: "fromMnemonic",
-            value: function fromMnemonic(mnemonic, networkId) {
-                var accountIndex = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : 0, change = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : 0, addressIndex = arguments.length > 4 && arguments[4] !== void 0 ? arguments[4] : 0;
-                var seed = bip39.mnemonicToSeedSync(mnemonic);
-                var root = bip32.fromSeed(seed, _WalletStaticMethods.getNetwork(networkId));
-                var purpose = 84;
-                var coinType = networkId;
-                var path = "m/".concat(purpose, "'/").concat(coinType, "'/").concat(accountIndex, "'/").concat(change, "/").concat(addressIndex);
-                var child = root.derivePath(path);
-                return child;
-            }
-        },
-        {
-            key: "getNetwork",
-            value: // todo: this is the confusing part in our sdk, since cardano 0 is testnet. we need to use enums or string instead for clearer
-            function getNetwork(network) {
-                return network === 0 ? bitcoin.networks.bitcoin : bitcoin.networks.testnet;
-            }
-        }
-    ]);
-    return _WalletStaticMethods;
-}();
+    var seed = mnemonicToSeedSync(mnemonic);
+    var root = bip32.fromSeed(seed, network);
+    var child = root.derivePath(path);
+    return child;
+}
 export { BlockstreamProvider, BrowserWallet, ECPair, EmbeddedWallet, bip32, bip39, bitcoin };
 //# sourceMappingURL=index.js.map