@subwallet/extension-base 1.3.41-0 → 1.3.43-0

package/utils/bitcoin/utxo-management.js

@@ -0,0 +1,266 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+import { TransactionError } from '@subwallet/extension-base/background/errors/TransactionError';
+import { BTC_DUST_AMOUNT } from '@subwallet/extension-base/constants';
+import { InsufficientFundsError, TransferTxErrorType } from '@subwallet/extension-base/types';
+import { balanceFormatter, formatNumber } from '@subwallet/extension-base/utils';
+import { BitcoinAddressType } from '@subwallet/keyring/types';
+import { getBitcoinAddressInfo, validateBitcoinAddress } from '@subwallet/keyring/utils';
+import BigN from 'bignumber.js';
+import { getSizeInfo, getSpendableAmount } from "./common.js";
+
+// https://github.com/leather-wallet/extension/blob/dev/src/app/common/transactions/bitcoin/utils.ts
+// Check if the spendable amount drops when adding a utxo. If it drops, don't use that utxo.
+// Method might be not particularly efficient as it would
+// go through the utxo array multiple times, but it's reliable.
+export function filterUneconomicalUtxos({
+  feeRate,
+  recipients,
+  sender,
+  utxos
+}) {
+  const addressInfo = validateBitcoinAddress(sender) ? getBitcoinAddressInfo(sender) : null;
+  const inputAddressTypeWithFallback = addressInfo ? addressInfo.type : BitcoinAddressType.p2wpkh;
+  const filteredAndSortUtxos = utxos.filter(utxo => utxo.value >= BTC_DUST_AMOUNT[inputAddressTypeWithFallback]).sort((a, b) => a.value - b.value); // ascending order
+
+  return filteredAndSortUtxos.reduce((utxos, utxo, currentIndex) => {
+    const utxosWithout = utxos.filter(u => u.txid !== utxo.txid);
+    const {
+      spendableAmount: spendableAmountWithout
+    } = getSpendableAmount({
+      utxos: utxosWithout,
+      feeRate,
+      recipients,
+      sender
+    });
+    const {
+      spendableAmount
+    } = getSpendableAmount({
+      utxos,
+      feeRate,
+      recipients,
+      sender
+    });
+
+    // console.log(utxosWithout, feeWithout, spendableAmountWithout.toString());
+    // console.log(utxos, fee, spendableAmount.toString());
+
+    if (spendableAmount.lte(0)) {
+      return utxosWithout;
+    } else {
+      // if spendable amount becomes bigger, do not use that utxo
+      return spendableAmountWithout.gt(spendableAmount) ? utxosWithout : utxos;
+    }
+  }, [...filteredAndSortUtxos]).reverse();
+}
+
+// https://github.com/leather-wallet/extension/blob/dev/src/app/common/transactions/bitcoin/coinselect/local-coin-selection.ts
+export function determineUtxosForSpendAll({
+  feeRate,
+  recipient,
+  sender,
+  utxos
+}) {
+  if (!validateBitcoinAddress(recipient)) {
+    throw new Error('Cannot calculate spend of invalid address type');
+  }
+  const recipientAddressInfo = getBitcoinAddressInfo(recipient);
+  const recipientDustLimit = BTC_DUST_AMOUNT[recipientAddressInfo.type] || 546;
+  const recipients = [recipient];
+  const filteredUtxos = filterUneconomicalUtxos({
+    utxos,
+    feeRate,
+    recipients,
+    sender
+  });
+  const sizeInfo = getSizeInfo({
+    sender,
+    inputLength: filteredUtxos.length,
+    recipients
+  });
+  const amount = filteredUtxos.reduce((acc, utxo) => acc + utxo.value, 0) - Math.ceil(sizeInfo.txVBytes * feeRate);
+  if (amount <= 0) {
+    throw new InsufficientFundsError();
+  }
+  if (amount < recipientDustLimit) {
+    const atLeastStr = formatNumber(recipientDustLimit, 8, balanceFormatter, {
+      maxNumberFormat: 8,
+      minNumberFormat: 8
+    });
+    throw new TransactionError(TransferTxErrorType.NOT_ENOUGH_VALUE, `You must transfer at least ${atLeastStr} BTC`);
+  }
+
+  // Fee has already been deducted from the amount with send all
+  const outputs = [{
+    value: amount,
+    address: recipient
+  }];
+  const fee = Math.ceil(sizeInfo.txVBytes * feeRate);
+  return {
+    inputs: filteredUtxos,
+    outputs,
+    size: sizeInfo.txVBytes,
+    fee,
+    isCustomFeeRate: false
+  };
+}
+
+// https://github.com/leather-wallet/extension/blob/dev/src/app/common/transactions/bitcoin/coinselect/local-coin-selection.ts
+export function determineUtxosForSpend({
+  amount,
+  feeRate,
+  recipient,
+  sender,
+  utxos
+}) {
+  if (!validateBitcoinAddress(recipient)) {
+    throw new Error('Cannot calculate spend of invalid address type');
+  }
+  const recipientAddressInfo = getBitcoinAddressInfo(recipient);
+  const recipientDustLimit = BTC_DUST_AMOUNT[recipientAddressInfo.type] || 546;
+  if (amount < recipientDustLimit) {
+    const atLeastStr = formatNumber(recipientDustLimit, 8, balanceFormatter, {
+      maxNumberFormat: 8,
+      minNumberFormat: 8
+    });
+    throw new TransactionError(TransferTxErrorType.NOT_ENOUGH_VALUE, `You must transfer at least ${atLeastStr} BTC`);
+  }
+  const orderedUtxos = utxos.sort((a, b) => b.value - a.value);
+  const recipients = [recipient, sender];
+  const filteredUtxos = filterUneconomicalUtxos({
+    utxos: orderedUtxos,
+    feeRate,
+    recipients,
+    sender
+  });
+  const neededUtxos = [];
+  let sum = new BigN(0);
+  let sizeInfo = null;
+  for (const utxo of filteredUtxos) {
+    sizeInfo = getSizeInfo({
+      inputLength: neededUtxos.length,
+      sender,
+      recipients
+    });
+    const currentValue = new BigN(amount).plus(Math.ceil(sizeInfo.txVBytes * feeRate));
+    if (sum.gte(currentValue)) {
+      break;
+    }
+    sum = sum.plus(utxo.value);
+    neededUtxos.push(utxo);
+
+    // re calculate size info, some case array end
+    sizeInfo = getSizeInfo({
+      inputLength: neededUtxos.length,
+      sender,
+      recipients
+    });
+  }
+  if (!sizeInfo) {
+    throw new InsufficientFundsError();
+  }
+  const fee = Math.ceil(sizeInfo.txVBytes * feeRate);
+  const amountLeft = sum.minus(amount).minus(fee);
+  if (amountLeft.lte(0)) {
+    throw new InsufficientFundsError();
+  }
+  const senderAddressInfo = getBitcoinAddressInfo(sender);
+  const dustLimit = BTC_DUST_AMOUNT[senderAddressInfo.type] || 546;
+  const outputs = [
+  // outputs[0] = the desired amount going to recipient
+  {
+    value: amount,
+    address: recipient
+  }];
+  if (amountLeft.gte(dustLimit)) {
+    // outputs[1] = the remainder to be returned to a change address
+    outputs.push({
+      value: amountLeft.toNumber(),
+      address: sender
+    });
+  } else {
+    // Todo: This solution for improve later, current throw error
+    // // Increase the fee to use the remaining balance
+    console.warn(`Change output of ${amountLeft.toString()} satoshis is below dust limit (${dustLimit} satoshis for ${senderAddressInfo.type}). Omitting change output.`);
+    //
+    sizeInfo = getSizeInfo({
+      inputLength: neededUtxos.length,
+      sender,
+      recipients: recipients.slice(0, 1)
+    });
+    const newFee = sum.minus(amount).toNumber();
+    return {
+      filteredUtxos,
+      inputs: neededUtxos,
+      outputs,
+      size: sizeInfo.txVBytes,
+      fee: newFee,
+      isCustomFeeRate: true
+    };
+  }
+  return {
+    filteredUtxos,
+    inputs: neededUtxos,
+    outputs,
+    size: sizeInfo.txVBytes,
+    fee,
+    isCustomFeeRate: false
+  };
+}
+export function filterOutPendingTxsUtxos(utxos) {
+  return utxos.filter(utxo => utxo.status.confirmed);
+}
+export function filteredOutTxsUtxos(allTxsUtxos, filteredOutTxsUtxos) {
+  if (!filteredOutTxsUtxos.length) {
+    return allTxsUtxos;
+  }
+  const listFilterOut = filteredOutTxsUtxos.map(utxo => {
+    return `${utxo.txid}:${utxo.vout}`;
+  });
+  return allTxsUtxos.filter(element => !listFilterOut.includes(`${element.txid}:${element.vout}`));
+}
+export async function getRuneUtxos(bitcoinApi, address) {
+  const responseRuneUtxos = await bitcoinApi.api.getRuneUtxos(address);
+  const runeUtxos = [];
+  responseRuneUtxos.forEach(responseRuneUtxo => {
+    const txid = responseRuneUtxo.txid;
+    const vout = responseRuneUtxo.vout;
+    const utxoValue = responseRuneUtxo.satoshi;
+    if (txid && vout && utxoValue) {
+      const item = {
+        txid,
+        vout,
+        status: {
+          confirmed: true // not use in filter out rune utxos
+        },
+
+        value: utxoValue
+      };
+      runeUtxos.push(item);
+    }
+  });
+  return runeUtxos;
+}
+export async function getInscriptionUtxos(bitcoinApi, address) {
+  try {
+    const inscriptions = await bitcoinApi.api.getAddressInscriptions(address);
+    return inscriptions.map(inscription => {
+      const [txid, vout] = inscription.output.split(':');
+      return {
+        txid,
+        vout: parseInt(vout),
+        status: {
+          confirmed: true,
+          // not use in filter out inscription utxos
+          block_height: inscription.genesis_block_height,
+          block_hash: inscription.genesis_block_hash,
+          block_time: inscription.genesis_timestamp
+        },
+        value: parseInt(inscription.value)
+      };
+    });
+  } catch (e) {
+    return [];
+  }
+}

package/utils/fee/transfer.d.ts

@@ -1,10 +1,11 @@
 import { _ChainAsset, _ChainInfo } from '@subwallet/chain-list/types';
 import { AmountData } from '@subwallet/extension-base/background/KoniTypes';
-import { _CardanoApi, _EvmApi, _SubstrateApi, _TonApi } from '@subwallet/extension-base/services/chain-service/types';
+import { _BitcoinApi, _CardanoApi, _EvmApi, _SubstrateApi, _TonApi } from '@subwallet/extension-base/services/chain-service/types';
 import { FeeChainType, FeeInfo, TransactionFee } from '@subwallet/extension-base/types';
 import { ResponseSubscribeTransfer } from '@subwallet/extension-base/types/balance/transfer';
 export interface CalculateMaxTransferable extends TransactionFee {
     address: string;
+    to?: string;
     value: string;
     srcToken: _ChainAsset;
     destToken?: _ChainAsset;
@@ -14,6 +15,7 @@ export interface CalculateMaxTransferable extends TransactionFee {
     evmApi: _EvmApi;
     tonApi: _TonApi;
     cardanoApi: _CardanoApi;
+    bitcoinApi: _BitcoinApi;
     isTransferLocalTokenAndPayThatTokenAsFee: boolean;
     isTransferNativeTokenAndPayLocalTokenAsFee: boolean;
     nativeToken: _ChainAsset;

package/utils/fee/transfer.js

@@ -4,6 +4,7 @@
 import { _SUPPORT_TOKEN_PAY_FEE_GROUP, XCM_FEE_RATIO } from '@subwallet/extension-base/constants';
 import { _isSnowBridgeXcm } from '@subwallet/extension-base/core/substrate/xcm-parser';
 import { DEFAULT_CARDANO_TTL_OFFSET } from '@subwallet/extension-base/services/balance-service/helpers/subscribe/cardano/consts';
+import { createBitcoinTransaction } from '@subwallet/extension-base/services/balance-service/transfer/bitcoin-transfer';
 import { createCardanoTransaction } from '@subwallet/extension-base/services/balance-service/transfer/cardano-transfer';
 import { getERC20TransactionObject, getEVMTransactionObject } from '@subwallet/extension-base/services/balance-service/transfer/smart-contract';
 import { createSubstrateExtrinsic } from '@subwallet/extension-base/services/balance-service/transfer/token';
@@ -14,13 +15,15 @@ import { isAvailChainBridge } from '@subwallet/extension-base/services/balance-s
 import { _isPolygonChainBridge } from '@subwallet/extension-base/services/balance-service/transfer/xcm/polygonBridge';
 import { _isPosChainBridge } from '@subwallet/extension-base/services/balance-service/transfer/xcm/posBridge';
 import { estimateXcmFee } from '@subwallet/extension-base/services/balance-service/transfer/xcm/utils';
-import { _getAssetDecimals, _getContractAddressOfToken, _isChainCardanoCompatible, _isChainEvmCompatible, _isChainTonCompatible, _isLocalToken, _isNativeToken, _isPureEvmChain, _isTokenEvmSmartContract, _isTokenTransferredByCardano, _isTokenTransferredByEvm, _isTokenTransferredByTon } from '@subwallet/extension-base/services/chain-service/utils';
+import { _getAssetDecimals, _getContractAddressOfToken, _isChainBitcoinCompatible, _isChainCardanoCompatible, _isChainEvmCompatible, _isChainTonCompatible, _isLocalToken, _isNativeToken, _isPureEvmChain, _isTokenEvmSmartContract, _isTokenTransferredByBitcoin, _isTokenTransferredByCardano, _isTokenTransferredByEvm, _isTokenTransferredByTon } from '@subwallet/extension-base/services/chain-service/utils';
 import { calculateToAmountByReservePool, FEE_COVERAGE_PERCENTAGE_SPECIAL_CASE } from '@subwallet/extension-base/services/fee-service/utils';
 import { getHydrationRate } from '@subwallet/extension-base/services/fee-service/utils/tokenPayFee';
 import { isCardanoTransaction, isTonTransaction } from '@subwallet/extension-base/services/transaction-service/helpers';
 import { BN_ZERO } from '@subwallet/extension-base/utils';
 import { isCardanoAddress, isTonAddress } from '@subwallet/keyring';
+import { isBitcoinAddress } from '@subwallet/keyring/utils/address/validate';
 import BigN from 'bignumber.js';
+import * as bitcoin from 'bitcoinjs-lib';
 import { u8aToHex } from '@polkadot/util';
 import { addressToEvm, isEthereumAddress } from '@polkadot/util-crypto';
 import { combineEthFee, combineSubstrateFee } from "./combine.js";
@@ -40,6 +43,8 @@ export const detectTransferTxType = (srcToken, srcChain, destChain) => {
       return 'ton';
     } else if (_isChainCardanoCompatible(srcChain) && _isTokenTransferredByCardano(srcToken)) {
       return 'cardano';
+    } else if (_isChainBitcoinCompatible(srcChain) && _isTokenTransferredByBitcoin(srcToken)) {
+      return 'bitcoin';
     } else {
       return 'substrate';
     }
@@ -69,6 +74,7 @@ export const calculateMaxTransferable = async (id, request, freeBalance, fee) =>
 export const calculateTransferMaxTransferable = async (id, request, freeBalance, fee) => {
   const {
     address,
+    bitcoinApi,
     cardanoApi,
     destChain,
     evmApi,
@@ -80,6 +86,7 @@ export const calculateTransferMaxTransferable = async (id, request, freeBalance,
     srcChain,
     srcToken,
     substrateApi,
+    to,
     tonApi,
     value
   } = request;
@@ -149,6 +156,18 @@ export const calculateTransferMaxTransferable = async (id, request, freeBalance,
         cardanoApi,
         nativeTokenInfo: nativeToken
       });
+    } else if (isBitcoinAddress(address) && _isTokenTransferredByBitcoin(srcToken)) {
+      const network = srcChain.isTestnet ? bitcoin.networks.testnet : bitcoin.networks.bitcoin;
+      [transaction] = await createBitcoinTransaction({
+        chain: srcChain.slug,
+        from: address,
+        to: to || address,
+        value,
+        feeInfo: fee,
+        transferAll: false,
+        bitcoinApi,
+        network: network
+      });
     } else {
       [transaction] = await createSubstrateExtrinsic({
         transferAll: false,
@@ -194,6 +213,15 @@ export const calculateTransferMaxTransferable = async (id, request, freeBalance,
         ...fee,
         estimatedFee
       };
+    } else if (feeChainType === 'bitcoin') {
+      // Calculate fee for bitcoin transaction
+      // TODO: Support maxTransferable for bitcoin
+      estimatedFee = '0';
+      feeOptions = {
+        ...fee,
+        vSize: 0,
+        estimatedFee
+      };
     } else {
       if (transaction) {
         if (isTonTransaction(transaction)) {
@@ -233,6 +261,12 @@ export const calculateTransferMaxTransferable = async (id, request, freeBalance,
         estimatedFee,
         gasLimit: '0'
       };
+    } else if (fee.type === 'bitcoin') {
+      feeOptions = {
+        ...fee,
+        estimatedFee,
+        vSize: 0
+      };
     } else {
       feeOptions = {
         ...fee,
@@ -395,6 +429,12 @@ export const calculateXcmMaxTransferable = async (id, request, freeBalance, fee)
         ...fee,
         estimatedFee
       };
+    } else if (feeChainType === 'bitcoin') {
+      feeOptions = {
+        ...fee,
+        estimatedFee,
+        vSize: 0
+      };
     } else {
       // Not implemented yet
       estimatedFee = '0';
@@ -411,6 +451,12 @@ export const calculateXcmMaxTransferable = async (id, request, freeBalance, fee)
         estimatedFee,
         gasLimit: '0'
       };
+    } else if (fee.type === 'bitcoin') {
+      feeOptions = {
+        ...fee,
+        estimatedFee,
+        vSize: 0
+      };
     } else {
       feeOptions = {
         ...fee,

package/utils/index.d.ts

@@ -68,3 +68,4 @@ export * from './promise';
 export * from './registry';
 export * from './swap';
 export * from './translate';
+export * from './bitcoin';

package/utils/index.js

@@ -3,9 +3,10 @@
 
 import { CrowdloanParaState } from '@subwallet/extension-base/background/KoniTypes';
 import { getRandomIpfsGateway, SUBWALLET_IPFS } from '@subwallet/extension-base/koni/api/nft/config';
-import { _isChainCardanoCompatible, _isChainEvmCompatible, _isChainSubstrateCompatible, _isChainTonCompatible } from '@subwallet/extension-base/services/chain-service/utils';
+import { _isChainBitcoinCompatible, _isChainCardanoCompatible, _isChainEvmCompatible, _isChainSubstrateCompatible, _isChainTonCompatible } from '@subwallet/extension-base/services/chain-service/utils';
 import { reformatAddress } from '@subwallet/extension-base/utils/account';
 import { decodeAddress, encodeAddress, isCardanoAddress, isTonAddress } from '@subwallet/keyring';
+import { isBitcoinAddress } from '@subwallet/keyring/utils/address/validate';
 import { t } from 'i18next';
 import { assert, BN, hexToU8a, isHex } from '@polkadot/util';
 import { ethereumEncode, isEthereumAddress } from '@polkadot/util-crypto';
@@ -256,7 +257,8 @@ export function isAddressAndChainCompatible(address, chain) {
   const isTonCompatible = isTonAddress(address) && _isChainTonCompatible(chain);
   const isSubstrateCompatible = !isEthereumAddress(address) && !isTonAddress(address) && _isChainSubstrateCompatible(chain); // todo: need isSubstrateAddress util function to check exactly
   const isCardanoCompatible = isCardanoAddress(address) && _isChainCardanoCompatible(chain);
-  return isEvmCompatible || isSubstrateCompatible || isTonCompatible || isCardanoCompatible;
+  const isBitcoinCompatible = isBitcoinAddress(address) && _isChainBitcoinCompatible(chain);
+  return isEvmCompatible || isSubstrateCompatible || isTonCompatible || isCardanoCompatible || isBitcoinCompatible;
 }
 export function getDomainFromUrl(url) {
   return url.replace(/^(https?:\/\/)?(www\.)?/, '').split('/')[0];
@@ -342,4 +344,5 @@ export * from "./object.js";
 export * from "./promise.js";
 export * from "./registry.js";
 export * from "./swap.js";
-export * from "./translate.js";
+export * from "./translate.js";
+export * from "./bitcoin/index.js";