@dynamic-labs/bitcoin 3.0.0-alpha.9 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/bitcoin",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dynamic-labs/dynamic-auth.git",
@@ -27,14 +27,15 @@
   },
   "dependencies": {
     "@btckit/types": "0.0.19",
-    "@dynamic-labs/sdk-api-core": "0.0.470",
+    "@dynamic-labs/sdk-api-core": "0.0.529",
     "@wallet-standard/app": "1.0.1",
     "@wallet-standard/base": "1.0.1",
     "bitcoinjs-lib": "6.1.5",
-    "sats-connect": "2.0.0",
-    "@dynamic-labs/utils": "3.0.0-alpha.9",
-    "@dynamic-labs/wallet-book": "3.0.0-alpha.9",
-    "@dynamic-labs/wallet-connector-core": "3.0.0-alpha.9",
+    "sats-connect": "2.8.0",
+    "@dynamic-labs/types": "3.0.0",
+    "@dynamic-labs/utils": "3.0.0",
+    "@dynamic-labs/wallet-book": "3.0.0",
+    "@dynamic-labs/wallet-connector-core": "3.0.0",
     "stream": "0.0.2"
   },
   "peerDependencies": {}

package/src/BitcoinLocalStorageCache.cjs

@@ -9,7 +9,6 @@ var utils = require('@dynamic-labs/utils');
 class BitcoinLocalStorageCache {
     constructor(key) {
         this.CONNECTED_ACCOUNTS_KEY = `bitcoin_${key}_connectedAccounts`;
-        this.LAST_BALANCE_KEY = `bitcoin_${key}_lastBalance`;
     }
     getActiveAccount() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -63,21 +62,6 @@ class BitcoinLocalStorageCache {
             return utils.removeItemAsync(this.CONNECTED_ACCOUNTS_KEY);
         });
     }
-    getLastBalance() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            return utils.getItemAsync(this.LAST_BALANCE_KEY);
-        });
-    }
-    setLastBalance(balance) {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            return utils.setItemAsync(this.LAST_BALANCE_KEY, balance);
-        });
-    }
-    clearLastBalance() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            return utils.removeItemAsync(this.LAST_BALANCE_KEY);
-        });
-    }
 }
 
 exports.BitcoinLocalStorageCache = BitcoinLocalStorageCache;

package/src/BitcoinLocalStorageCache.d.ts

@@ -9,16 +9,12 @@ type BitcoinActiveAccount = {
 };
 export declare class BitcoinLocalStorageCache implements IBitcoinSessionCache {
     private readonly CONNECTED_ACCOUNTS_KEY;
-    private readonly LAST_BALANCE_KEY;
     constructor(key: string);
     getActiveAccount(): Promise<BitcoinActiveAccount | undefined>;
     getConnectedAccounts(): Promise<BitcoinConnectedAccounts | undefined>;
     getConnectedAccount(address: string): Promise<BitcoinConnectedAccount | undefined>;
     setConnectedAccount(addess: string, account: BitcoinConnectedAccount): Promise<void>;
     clearConnectedAcccounts(): Promise<void>;
-    getLastBalance(): Promise<string | undefined>;
-    setLastBalance(balance: string): Promise<void>;
-    clearLastBalance(): Promise<void>;
 }
 export interface IBitcoinSessionCache {
     clearConnectedAcccounts(): Promise<void>;
@@ -26,8 +22,5 @@ export interface IBitcoinSessionCache {
     getConnectedAccount(address: string): Promise<BitcoinConnectedAccount | undefined>;
     getConnectedAccounts(): Promise<BitcoinConnectedAccounts | undefined>;
     setConnectedAccount(addess: string, account: BitcoinConnectedAccount): Promise<void>;
-    clearLastBalance(): Promise<void>;
-    getLastBalance(): Promise<string | undefined>;
-    setLastBalance(balance: string): Promise<void>;
 }
 export {};

package/src/BitcoinLocalStorageCache.js

@@ -5,7 +5,6 @@ import { getItemAsync, setItemAsync, removeItemAsync } from '@dynamic-labs/utils
 class BitcoinLocalStorageCache {
     constructor(key) {
         this.CONNECTED_ACCOUNTS_KEY = `bitcoin_${key}_connectedAccounts`;
-        this.LAST_BALANCE_KEY = `bitcoin_${key}_lastBalance`;
     }
     getActiveAccount() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -59,21 +58,6 @@ class BitcoinLocalStorageCache {
             return removeItemAsync(this.CONNECTED_ACCOUNTS_KEY);
         });
     }
-    getLastBalance() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return getItemAsync(this.LAST_BALANCE_KEY);
-        });
-    }
-    setLastBalance(balance) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return setItemAsync(this.LAST_BALANCE_KEY, balance);
-        });
-    }
-    clearLastBalance() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return removeItemAsync(this.LAST_BALANCE_KEY);
-        });
-    }
 }
 
 export { BitcoinLocalStorageCache };

package/src/bitcoinProviderHelper.d.ts

@@ -14,6 +14,7 @@ export declare class BitcoinProviderHelper {
         walletStandard?: {
             features: string[];
             name: string;
+            providerId?: string | undefined;
         } | undefined;
         walletStandardLocators?: {
             name: string;

package/src/connectors/BitcoinSatsConnectConnector/BitcoinSatsConnectConnector.cjs

@@ -8,36 +8,54 @@ var bitcoinjsLib = require('bitcoinjs-lib');
 var satsConnect = require('sats-connect');
 var utils = require('@dynamic-labs/utils');
 var walletBook = require('@dynamic-labs/wallet-book');
-var _const = require('../../const.cjs');
-require('@dynamic-labs/wallet-connector-core');
-var BitcoinWalletConnector = require('../BitcoinWalletConnector.cjs');
-var validatePsbt = require('../../utils/psbt/validator/validatePsbt.cjs');
-var getSigHashType = require('../../utils/psbt/getSigHashType.cjs');
+var walletConnectorCore = require('@dynamic-labs/wallet-connector-core');
 var bitcoinNetworkTypeToNetworks = require('../../utils/psbt/bitcoinNetworkTypeToNetworks.cjs');
-var supportsSatsConnect = require('../../utils/supportsSatsConnect.cjs');
+var BitcoinWalletConnector = require('../BitcoinWalletConnector.cjs');
+var createSignPsbtOptions = require('../../utils/psbt/createSignPsbtOptions.cjs');
+var _const = require('../../const.cjs');
 
 class BitcoinSatsConnectConnector extends BitcoinWalletConnector.BitcoinWalletConnector {
     constructor(opts) {
         super(opts);
+        this.isLegacy = false;
         this.currentNetwork = satsConnect.BitcoinNetworkType.Mainnet;
-        // satsconnect wallets don't support fetching connected accounts without prompting
-        // for a connection, so we handle getConnectedAccounts differently.
-        this.canFetchConnectedAccounts = false;
     }
-    getAddress() {
+    getGenericUserCancelledError() {
+        const error = new Error();
+        error.code = '-32000'; // error code for user cancelled
+        return error;
+    }
+    getAddresses() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             var _a;
-            // xverse doesn't support wallet standard, so we won't have a wallet object,
-            // but it's already the default provider for sats-connect, so it's ok
-            // for getProvider in getAddress to return undefined
-            // if we're not using xverse, we need to check if there is a wallet and
-            // that it has the satsconnect feature to return the correct provider to use
-            if (!supportsSatsConnect.supportsSatsConnect(this)) {
-                return;
+            const getAddressResponse = yield satsConnect.request('getAddresses', {
+                purposes: [satsConnect.AddressPurpose.Payment, satsConnect.AddressPurpose.Ordinals],
+            });
+            if (getAddressResponse.status !== 'success') {
+                throw getAddressResponse.error;
             }
+            const { addresses } = getAddressResponse.result;
+            const ordinalsAccount = addresses === null || addresses === void 0 ? void 0 : addresses.find((address) => address.purpose === satsConnect.AddressPurpose.Ordinals);
+            const paymentAccount = addresses === null || addresses === void 0 ? void 0 : addresses.find((address) => address.purpose === satsConnect.AddressPurpose.Payment);
+            const mainAddress = (_a = ordinalsAccount === null || ordinalsAccount === void 0 ? void 0 : ordinalsAccount.address) !== null && _a !== void 0 ? _a : paymentAccount === null || paymentAccount === void 0 ? void 0 : paymentAccount.address;
+            yield this.setConnectedAccountWithAddresses({
+                active: true,
+                mainAddress,
+                ordinalsAddress: ordinalsAccount,
+                paymentAddress: paymentAccount,
+            });
+            return mainAddress;
+        });
+    }
+    getAddress() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a;
             const wallet = walletBook.findWalletBookWallet(this.walletBook, this.key);
             const inAppBrowserUrl = (_a = wallet === null || wallet === void 0 ? void 0 : wallet.mobile) === null || _a === void 0 ? void 0 : _a.inAppBrowser;
-            if (utils.isMobile() && !this.isInstalledOnBrowser() && inAppBrowserUrl) {
+            if (utils.isMobile() &&
+                !this.isInstalledOnBrowser() &&
+                inAppBrowserUrl &&
+                this.mobileExperience === 'in-app-browser') {
                 const inAppBrowserTemplate = utils.template(inAppBrowserUrl);
                 const deepLink = inAppBrowserTemplate({
                     encodedDappURI: encodeURIComponent(window.location.toString()),
@@ -45,143 +63,123 @@ class BitcoinSatsConnectConnector extends BitcoinWalletConnector.BitcoinWalletCo
                 window.location.href = deepLink;
                 return;
             }
-            return new Promise((resolve, reject) => {
-                satsConnect.getAddress({
-                    getProvider: () => _tslib.__awaiter(this, void 0, void 0, function* () {
-                        var _a, _b;
-                        return (_b = (_a = this.wallet) === null || _a === void 0 ? void 0 : _a.features[_const.SATSCONNECT_FEATURE]) === null || _b === void 0 ? void 0 : _b.provider;
-                    }),
-                    onCancel: () => {
-                        const error = new Error();
-                        error.code = '-32000'; // error code for user cancelled
-                        reject(error);
-                    },
-                    onFinish: (response) => _tslib.__awaiter(this, void 0, void 0, function* () {
-                        var _c;
-                        const { addresses } = response;
-                        const ordinalsAccount = addresses === null || addresses === void 0 ? void 0 : addresses.find((address) => address.purpose === satsConnect.AddressPurpose.Ordinals);
-                        const paymentAccount = addresses === null || addresses === void 0 ? void 0 : addresses.find((address) => address.purpose === satsConnect.AddressPurpose.Payment);
-                        const mainAddress = (_c = ordinalsAccount === null || ordinalsAccount === void 0 ? void 0 : ordinalsAccount.address) !== null && _c !== void 0 ? _c : paymentAccount === null || paymentAccount === void 0 ? void 0 : paymentAccount.address;
-                        yield this.setConnectedAccountWithAddresses({
-                            active: true,
-                            mainAddress,
-                            ordinalsAddress: ordinalsAccount,
-                            paymentAddress: paymentAccount,
-                        });
-                        resolve(mainAddress);
-                    }),
-                    payload: {
-                        message: 'Address for receiving Ordinals and payments',
-                        network: {
-                            type: this.currentNetwork,
-                        },
-                        purposes: [satsConnect.AddressPurpose.Ordinals, satsConnect.AddressPurpose.Payment],
-                    },
-                });
-            });
+            try {
+                // requesting permissions on initial connect will avoid connection prompt for other requests
+                const permissionResponse = yield satsConnect.request('wallet_requestPermissions', undefined);
+                if (permissionResponse.status !== 'success') {
+                    throw permissionResponse.error;
+                }
+                const address = yield this.getAddresses();
+                return address;
+            }
+            catch (_) {
+                const error = this.getGenericUserCancelledError();
+                throw error;
+            }
         });
     }
-    signMessage(messageToSign) {
+    signMessage(messageToSign, withAddress) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const [walletAddress] = yield this.getConnectedAccounts();
-            if (!walletAddress || !supportsSatsConnect.supportsSatsConnect(this)) {
-                return;
-            }
-            return new Promise((resolve, reject) => {
-                satsConnect.signMessage({
-                    getProvider: () => _tslib.__awaiter(this, void 0, void 0, function* () {
-                        var _a, _b;
-                        return (_b = (_a = this.wallet) === null || _a === void 0 ? void 0 : _a.features[_const.SATSCONNECT_FEATURE]) === null || _b === void 0 ? void 0 : _b.provider;
-                    }),
-                    onCancel: () => {
-                        const error = new Error();
-                        error.code = '-32000'; // error code for user cancelled
-                        reject(error);
-                    },
-                    onFinish: (response) => _tslib.__awaiter(this, void 0, void 0, function* () {
-                        if (this.isHardwareWalletEnabled) {
-                            return resolve(JSON.stringify({
-                                signedTransaction: {
-                                    data: response,
-                                },
-                            }));
-                        }
-                        resolve(response);
-                    }),
-                    payload: {
-                        address: walletAddress,
-                        message: messageToSign,
-                        network: {
-                            type: this.currentNetwork,
-                        },
-                    },
+            try {
+                const response = yield satsConnect.request('signMessage', {
+                    address: withAddress,
+                    message: messageToSign,
                 });
-            });
+                if (response.status !== 'success') {
+                    throw response.error;
+                }
+                if (this.isHardwareWalletEnabled) {
+                    return JSON.stringify({
+                        signedTransaction: {
+                            data: response.result.signature,
+                        },
+                    });
+                }
+                return response.result.signature;
+            }
+            catch (_) {
+                const error = this.getGenericUserCancelledError();
+                throw error;
+            }
         });
     }
     sendBitcoin(transaction) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const mainAddress = yield this.getAddress();
-            const senderAddress = (_a = (yield this.getAdditionalAddresses(mainAddress)).find((address) => address.type === 'payment')) === null || _a === void 0 ? void 0 : _a.address;
-            if (!senderAddress || !supportsSatsConnect.supportsSatsConnect(this)) {
-                return;
-            }
-            return new Promise((resolve, reject) => {
-                satsConnect.sendBtcTransaction({
-                    getProvider: () => _tslib.__awaiter(this, void 0, void 0, function* () {
-                        var _a, _b;
-                        return (_b = (_a = this.wallet) === null || _a === void 0 ? void 0 : _a.features[_const.SATSCONNECT_FEATURE]) === null || _b === void 0 ? void 0 : _b.provider;
-                    }),
-                    onCancel: () => {
-                        const error = new Error();
-                        error.code = '-32000'; // error code for user cancelled
-                        reject(error);
-                    },
-                    onFinish: (response) => {
-                        resolve(response);
-                    },
-                    payload: {
-                        network: {
-                            type: this.currentNetwork,
+            try {
+                const response = yield satsConnect.request('sendTransfer', {
+                    recipients: [
+                        {
+                            address: transaction.recipientAddress,
+                            amount: Number(transaction.amount),
                         },
-                        recipients: [
-                            {
-                                address: transaction.recipientAddress,
-                                amountSats: transaction.amount,
-                            },
-                        ],
-                        senderAddress,
-                    },
+                    ],
                 });
-            });
+                if (response.status !== 'success') {
+                    throw response.error;
+                }
+                return response.result.txid;
+            }
+            catch (_) {
+                const error = this.getGenericUserCancelledError();
+                throw error;
+            }
         });
     }
     signTransaction(params) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const { message, psbtBase64, broadcast, inputsToSign } = params;
+            const { allowedSignHash, psbtBase64, broadcast, inputsToSign } = params;
+            const signPbstPayload = {
+                allowedSignHash,
+                broadcast,
+                psbt: psbtBase64,
+                // we have to combine signing indexes for like addresses
+                signInputs: inputsToSign.reduce((accum, curr) => {
+                    if (!accum[curr.address]) {
+                        accum[curr.address] = [];
+                    }
+                    accum[curr.address].push(...curr.signingIndexes);
+                    return accum;
+                }, {}),
+            };
+            walletConnectorCore.logger.logVerboseTroubleshootingMessage('[BitcoinSatsConnectConnector] signTransaction', {
+                signPbstPayload,
+            });
+            try {
+                const response = yield satsConnect.request('signPsbt', signPbstPayload);
+                if (response.status !== 'success') {
+                    throw response.error;
+                }
+                return { psbtBase64: response.result.psbt, txId: response.result.txid };
+            }
+            catch (_) {
+                const error = this.getGenericUserCancelledError();
+                throw error;
+            }
+        });
+    }
+    signTransactions(transactions) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const { message, psbts, network } = transactions;
+            walletConnectorCore.logger.logVerboseTroubleshootingMessage('[BitcoinSatsConnectConnector] signTransactions', {
+                transactions,
+            });
             return new Promise((resolve, reject) => {
-                satsConnect.signTransaction({
+                satsConnect.signMultipleTransactions({
                     getProvider: () => _tslib.__awaiter(this, void 0, void 0, function* () {
                         var _a, _b;
                         return (_b = (_a = this.wallet) === null || _a === void 0 ? void 0 : _a.features[_const.SATSCONNECT_FEATURE]) === null || _b === void 0 ? void 0 : _b.provider;
                     }),
                     onCancel: () => {
-                        const error = new Error();
-                        error.code = '-32000'; // error code for user cancelled
+                        const error = this.getGenericUserCancelledError();
                         reject(error);
                     },
                     onFinish: (response) => {
                         resolve(response);
                     },
                     payload: {
-                        broadcast,
-                        inputsToSign,
                         message: message || 'Sign Transaction',
-                        network: {
-                            type: this.currentNetwork,
-                        },
-                        psbtBase64,
+                        network,
+                        psbts,
                     },
                 });
             });
@@ -189,27 +187,22 @@ class BitcoinSatsConnectConnector extends BitcoinWalletConnector.BitcoinWalletCo
     }
     signPsbt(request) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
+            var _a;
             if (!((_a = request.allowedSighash) === null || _a === void 0 ? void 0 : _a.length))
                 throw new Error('allowedSighash cannot be an empty array');
             const network = bitcoinNetworkTypeToNetworks.convertNetworkTypeForPsbt(this.currentNetwork);
             const psbtFromBase64 = bitcoinjsLib.Psbt.fromBase64(request.unsignedPsbtBase64, {
                 network,
             });
-            if ((_b = request.signature) === null || _b === void 0 ? void 0 : _b.length) {
-                validatePsbt.validatePsbt(psbtFromBase64, request.allowedSighash, request.signature);
-            }
-            const inputsToSign = ((_d = (_c = request.signature) === null || _c === void 0 ? void 0 : _c.map((sig) => {
-                var _a;
-                return ((_a = sig.signingIndexes) !== null && _a !== void 0 ? _a : []).map((inputIndex) => ({
-                    address: sig.address,
-                    sigHash: getSigHashType.getSigHashType(psbtFromBase64.data.inputs[inputIndex]),
-                    signingIndexes: [inputIndex],
-                }));
-            })) !== null && _d !== void 0 ? _d : []).flat();
+            walletConnectorCore.logger.logVerboseTroubleshootingMessage('signPsbt', {
+                isLegacy: this.isLegacy,
+                psbtFromBase64,
+                request,
+            });
             const signedPsbt = yield this.signTransaction({
+                allowedSignHash: request.allowedSighash[0],
                 broadcast: false,
-                inputsToSign,
+                inputsToSign: createSignPsbtOptions.createSignPsbtOptionsForSatsConnect(psbtFromBase64, request, this.isLegacy),
                 psbtBase64: request.unsignedPsbtBase64,
             });
             if (!signedPsbt) {
@@ -218,6 +211,42 @@ class BitcoinSatsConnectConnector extends BitcoinWalletConnector.BitcoinWalletCo
             return { signedPsbt: signedPsbt.psbtBase64 };
         });
     }
+    signPsbts(requests) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const network = bitcoinNetworkTypeToNetworks.convertNetworkTypeForPsbt(this.currentNetwork);
+            const signMultipleTransactionPayload = {
+                message: 'Sign Transaction',
+                network: {
+                    type: this.currentNetwork,
+                },
+                psbts: [],
+            };
+            for (const request of requests) {
+                const psbtFromBase64 = bitcoinjsLib.Psbt.fromBase64(request.unsignedPsbtBase64, {
+                    network,
+                });
+                const inputsToSign = createSignPsbtOptions.createSignPsbtOptionsForSatsConnect(psbtFromBase64, request, this.isLegacy);
+                signMultipleTransactionPayload.psbts.push({
+                    inputsToSign,
+                    psbtBase64: request.unsignedPsbtBase64,
+                });
+            }
+            walletConnectorCore.logger.logVerboseTroubleshootingMessage('signPsbts', signMultipleTransactionPayload);
+            const signedPsbts = yield this.signTransactions(signMultipleTransactionPayload);
+            return (_a = signedPsbts === null || signedPsbts === void 0 ? void 0 : signedPsbts.map((signedPsbts) => signedPsbts.psbtBase64)) !== null && _a !== void 0 ? _a : [];
+        });
+    }
+    validateActiveWallet(expectedAddress) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            // TODO: this is a workaround to avoid extra connecting prompt for xverse
+            // we should revisit it once xverse releases a new version with bug fixes
+            walletConnectorCore.logger.debug('validateActiveWallet - skipping validation for xverse', {
+                expectedAddress,
+            });
+            return;
+        });
+    }
 }
 
 exports.BitcoinSatsConnectConnector = BitcoinSatsConnectConnector;

package/src/connectors/BitcoinSatsConnectConnector/BitcoinSatsConnectConnector.d.ts

@@ -1,13 +1,18 @@
-import { BitcoinNetworkType, SignTransactionResponse } from 'sats-connect';
+import { BitcoinNetworkType, SignMultipleTransactionsPayload, SignTransactionResponse } from 'sats-connect';
 import { BitcoinSignPsbtRequest, BitcoinSignPsbtResponse, BitcoinTransaction, SatsConnectSignTransactionInput } from '../../types';
 import { BitcoinWalletConnector, BitcoinWalletConnectorOpts } from '../BitcoinWalletConnector';
 export declare abstract class BitcoinSatsConnectConnector extends BitcoinWalletConnector {
+    isLegacy: boolean;
     currentNetwork: BitcoinNetworkType;
-    canFetchConnectedAccounts: boolean;
     constructor(opts: BitcoinWalletConnectorOpts);
+    private getGenericUserCancelledError;
+    private getAddresses;
     getAddress(): Promise<string | undefined>;
-    signMessage(messageToSign: string): Promise<string | undefined>;
+    signMessage(messageToSign: string, withAddress: string): Promise<string | undefined>;
     sendBitcoin(transaction: BitcoinTransaction): Promise<string | undefined>;
     signTransaction(params: SatsConnectSignTransactionInput): Promise<SignTransactionResponse | undefined>;
+    signTransactions(transactions: SignMultipleTransactionsPayload): Promise<SignTransactionResponse[] | undefined>;
     signPsbt(request: BitcoinSignPsbtRequest): Promise<BitcoinSignPsbtResponse | undefined>;
+    signPsbts(requests: BitcoinSignPsbtRequest[]): Promise<string[] | undefined>;
+    validateActiveWallet(expectedAddress: string): Promise<void>;
 }