[Issue-4168] Support Bitcoin account

.github/workflows/push-koni-dev.yml

@@ -5,6 +5,9 @@ on:
       - koni-dev
       - upgrade-ui
       - subwallet-dev
+      - koni/dev/issue-4200-v2
+      - koni/dev/issue-4297
+      - koni/dev/issue-4263
   push:
     branches:
       - koni-dev
@@ -72,6 +75,7 @@ jobs:
         TARGET_BRANCH: ${{ github.event.pull_request.base.ref }}
         CURRENT_BRANCH: ${{ github.event.pull_request.head.ref || github.ref }}
         BRANCH_NAME: ${{ github.ref_name }}
+        BTC_SERVICE_TOKEN: ${{ secrets.BTC_SERVICE_TOKEN }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
         yarn build:koni-dev

.github/workflows/push-master.yml

@@ -30,6 +30,7 @@ jobs:
         COINBASE_PAY_ID: ${{ secrets.COINBASE_PAY_ID }}
         MELD_WIZARD_KEY: ${{ secrets.MELD_WIZARD_KEY }}
         BRANCH_NAME: ${{ github.ref_name }}
+        BTC_SERVICE_TOKEN: ${{ secrets.BTC_SERVICE_TOKEN }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
         yarn ${{ matrix.step }}

.github/workflows/push-web-runner.yml

@@ -34,6 +34,7 @@ jobs:
         COINBASE_PAY_ID: ${{ secrets.COINBASE_PAY_ID }}
         MELD_WIZARD_KEY: ${{ secrets.MELD_WIZARD_KEY }}
         BRANCH_NAME: master
+        BTC_SERVICE_TOKEN: ${{ secrets.BTC_SERVICE_TOKEN }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
         yarn ${{ matrix.step }}

.github/workflows/push-webapp.yml

@@ -34,6 +34,7 @@ jobs:
         NFT_MINTING_HOST: ${{ secrets.NFT_MINTING_HOST }}
         MELD_WIZARD_KEY: ${{ secrets.MELD_WIZARD_KEY }}
         BRANCH_NAME: ${{ github.ref_name }}
+        BTC_SERVICE_TOKEN: ${{ secrets.BTC_SERVICE_TOKEN }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
         if [ ${{ github.ref_name }} == 'webapp-dev' ]; then

package.json

@@ -63,6 +63,7 @@
   },
   "dependencies": {
     "@types/node": "^17.0.10",
+    "bitcoinjs-lib": "6.1.5",
     "dexie": "^3.2.2",
     "loglevel": "^1.8.1",
     "react-markdown": "^9.0.1",
@@ -110,6 +111,7 @@
     "@subwallet/keyring": "^0.1.12",
     "@subwallet/react-ui": "5.1.2-b79",
     "@subwallet/ui-keyring": "^0.1.12",
+    "bitcoinjs-lib": "6.1.5",
     "@types/bn.js": "^5.1.6",
     "@zondax/ledger-substrate": "1.0.1",
     "babel-core": "^7.0.0-bridge.0",

packages/extension-base/package.json

@@ -72,11 +72,12 @@
     "avail-js-sdk": "^0.2.12",
     "axios": "^1.6.2",
     "bignumber.js": "^9.1.1",
+    "bitcoinjs-lib": "6.1.5",
     "bn.js": "^5.2.1",
     "bowser": "^2.11.0",
     "browser-passworder": "^2.0.3",
     "buffer": "^6.0.3",
-    "cross-fetch": "^3.1.5",
+    "cross-fetch": "^4.1.0",
     "dexie": "^3.2.2",
     "dexie-export-import": "^4.0.7",
     "eth-simple-keyring": "^4.2.0",

packages/extension-base/src/background/KoniTypes.ts

@@ -10,24 +10,27 @@
 import { CardanoBalanceItem } from '@subwallet/extension-base/services/balance-service/helpers/subscribe/cardano/types';
 import { CardanoTransactionConfig } from '@subwallet/extension-base/services/balance-service/transfer/cardano-transfer';
 import { TonTransactionConfig } from '@subwallet/extension-base/services/balance-service/transfer/ton-transfer';
+import { BitcoinApiStrategy } from '@subwallet/extension-base/services/chain-service/handler/bitcoin/strategy/types';
 import { _CHAIN_VALIDATION_ERROR } from '@subwallet/extension-base/services/chain-service/handler/types';
 import { _ChainState, _EvmApi, _NetworkUpsertParams, _SubstrateApi, _ValidateCustomAssetRequest, _ValidateCustomAssetResponse, EnableChainParams, EnableMultiChainParams } from '@subwallet/extension-base/services/chain-service/types';
 import { TokenPayFeeInfo } from '@subwallet/extension-base/services/fee-service/interfaces';
 import { _NotificationInfo, NotificationSetup } from '@subwallet/extension-base/services/inapp-notification-service/interfaces';
 import { AppBannerData, AppConfirmationData, AppPopupData } from '@subwallet/extension-base/services/mkt-campaign-service/types';
 import { AuthUrls } from '@subwallet/extension-base/services/request-service/types';
 import { CrowdloanContributionsResponse } from '@subwallet/extension-base/services/subscan-service/types';
-import { SWTransactionResponse, SWTransactionResult } from '@subwallet/extension-base/services/transaction-service/types';
+import { BitcoinTransactionData, SWTransactionResponse, SWTransactionResult } from '@subwallet/extension-base/services/transaction-service/types';
 import { WalletConnectNotSupportRequest, WalletConnectSessionRequest } from '@subwallet/extension-base/services/wallet-connect-service/types';
 import { AccountChainType, AccountJson, AccountsWithCurrentAddress, AddressJson, BalanceJson, BaseRequestSign, BuyServiceInfo, BuyTokenInfo, CommonOptimalTransferPath, CurrentAccountInfo, EarningRewardHistoryItem, EarningRewardJson, EarningStatus, HandleYieldStepParams, InternalRequestSign, LeavePoolAdditionalData, NominationPoolInfo, OptimalYieldPath, OptimalYieldPathParams, RequestAccountBatchExportV2, RequestAccountCreateSuriV2, RequestAccountNameValidate, RequestAccountProxyEdit, RequestAccountProxyForget, RequestBatchJsonGetAccountInfo, RequestBatchRestoreV2, RequestBounceableValidate, RequestChangeAllowOneSign, RequestChangeTonWalletContractVersion, RequestCheckCrossChainTransfer, RequestCheckPublicAndSecretKey, RequestCheckTransfer, RequestCrossChainTransfer, RequestDeriveCreateMultiple, RequestDeriveCreateV3, RequestDeriveValidateV2, RequestEarlyValidateYield, RequestEarningSlippage, RequestExportAccountProxyMnemonic, RequestGetAllTonWalletContractVersion, RequestGetAmountForPair, RequestGetDeriveAccounts, RequestGetDeriveSuggestion, RequestGetTokensCanPayFee, RequestGetYieldPoolTargets, RequestInputAccountSubscribe, RequestJsonGetAccountInfo, RequestJsonRestoreV2, RequestMetadataHash, RequestMnemonicCreateV2, RequestMnemonicValidateV2, RequestPrivateKeyValidateV2, RequestShortenMetadata, RequestStakeCancelWithdrawal, RequestStakeClaimReward, RequestSubmitProcessTransaction, RequestSubscribeProcessById, RequestTransfer, RequestUnlockDotCheckCanMint, RequestUnlockDotSubscribeMintedData, RequestYieldLeave, RequestYieldStepSubmit, RequestYieldWithdrawal, ResponseAccountBatchExportV2, ResponseAccountCreateSuriV2, ResponseAccountNameValidate, ResponseBatchJsonGetAccountInfo, ResponseCheckPublicAndSecretKey, ResponseDeriveValidateV2, ResponseEarlyValidateYield, ResponseExportAccountProxyMnemonic, ResponseGetAllTonWalletContractVersion, ResponseGetDeriveAccounts, ResponseGetDeriveSuggestion, ResponseGetYieldPoolTargets, ResponseInputAccountSubscribe, ResponseJsonGetAccountInfo, ResponseMetadataHash, ResponseMnemonicCreateV2, ResponseMnemonicValidateV2, ResponsePrivateKeyValidateV2, ResponseShortenMetadata, ResponseSubscribeProcessAlive, ResponseSubscribeProcessById, StorageDataInterface, SubmitYieldStepData, SubnetYieldPositionInfo, SwapPair, SwapQuoteResponse, SwapRequest, SwapRequestResult, SwapRequestV2, SwapSubmitParams, SwapTxData, TokenSpendingApprovalParams, UnlockDotTransactionNft, UnstakingStatus, ValidateSwapProcessParams, ValidateYieldProcessParams, YieldPoolInfo, YieldPoolType, YieldPositionInfo } from '@subwallet/extension-base/types';
-import { RequestSubmitTransfer, RequestSubscribeTransfer, ResponseSubscribeTransfer } from '@subwallet/extension-base/types/balance/transfer';
+import { RequestSubmitSignPsbtTransfer, RequestSubmitTransfer, RequestSubmitTransferWithId, RequestSubscribeTransfer, ResponseSubscribeTransfer } from '@subwallet/extension-base/types/balance/transfer';
 import { RequestClaimBridge } from '@subwallet/extension-base/types/bridge';
 import { GetNotificationParams, RequestIsClaimedPolygonBridge, RequestSwitchStatusParams } from '@subwallet/extension-base/types/notification';
 import { InjectedAccount, InjectedAccountWithMeta, MetadataDefBase } from '@subwallet/extension-inject/types';
 import { KeyringPair$Meta } from '@subwallet/keyring/types';
 import { KeyringOptions } from '@subwallet/ui-keyring/options/types';
 import { KeyringAddress } from '@subwallet/ui-keyring/types';
 import { SessionTypes } from '@walletconnect/types/dist/types/sign-client/session';
+import { Psbt } from 'bitcoinjs-lib';
+import BN from 'bn.js';
 import { DexieExportJsonStructure } from 'dexie-export-import';
 import Web3 from 'web3';
 import { RequestArguments, TransactionConfig } from 'web3-core';
@@ -262,13 +265,13 @@
   externalUrl?: string;
   rarity?: string;
   description?: string;
   properties?: Record<any, any> | null;
 }
 
 interface NftItemExtraInfo {
   type?: _AssetType.ERC721 | _AssetType.PSP34 | RMRK_VER; // for sending
   rmrk_ver?: RMRK_VER;
   onChainOption?: any; // for sending PSP-34 tokens, should be done better
   assetHubType?: AssetHubNftType // for sending assetHub nft. There're 2 types nft
 }
 
@@ -599,7 +602,7 @@
   [ExtrinsicType.STAKING_COMPOUNDING]: RequestTuringStakeCompound,
   [ExtrinsicType.STAKING_CANCEL_COMPOUNDING]: RequestTuringCancelStakeCompound,
   [ExtrinsicType.STAKING_CANCEL_UNSTAKE]: RequestStakeCancelWithdrawal,
   [ExtrinsicType.STAKING_POOL_WITHDRAW]: any,
 
   // Yield
   [ExtrinsicType.JOIN_YIELD_POOL]: RequestYieldStepSubmit,
@@ -630,9 +633,9 @@
   [ExtrinsicType.CLAIM_BRIDGE]: RequestClaimBridge
 
   [ExtrinsicType.EVM_EXECUTE]: TransactionConfig,
   [ExtrinsicType.CROWDLOAN]: any,
   [ExtrinsicType.SWAP]: SwapTxData
   [ExtrinsicType.UNKNOWN]: any
 }
 
 export enum ExtrinsicStatus {
@@ -731,8 +734,8 @@
 //     : T extends ExtrinsicType.MINT_VDOT
 //       ? Pick<SubmitBifrostLiquidStaking, 'rewardTokenSlug' | 'estimatedAmountReceived'>
 //       : undefined;
 export interface TransactionHistoryItem<ET extends ExtrinsicType = ExtrinsicType.TRANSFER_BALANCE> {
-  origin?: 'app' | 'migration' | 'subsquid' | 'subscan', // 'app' or history source
+  origin?: 'app' | 'migration' | 'subsquid' | 'subscan' | 'blockstream', // 'app' or history source
   callhash?: string,
   signature?: string,
   chain: string,
@@ -748,6 +751,7 @@
   status: ExtrinsicStatus,
   transactionId?: string, // Available for transaction history
   extrinsicHash: string,
+  blockTime?: number, // Block time. With bitcoin, time to submit is different with time on block
   time: number,
   data?: string,
   blockNumber: number,
@@ -756,11 +760,12 @@
   tip?: AmountData,
   fee?: AmountData,
   explorerUrl?: string,
   additionalInfo?: any,
   startBlock?: number,
   nonce?: number,
   addressPrefix?: number,
   processId?: string;
+  apiTxIndex?: number;
 }
 
 export interface SWWarning {
@@ -989,12 +994,12 @@
   recipientAddress: string,
 
   nftItemName?: string, // Use for confirmation view only
   params: Record<string, any>,
   nftItem: NftItem
 }
 
 export interface EvmNftTransaction extends ValidateTransactionResponse {
   tx: Record<string, any> | null;
 }
 
 export interface ValidateNetworkResponse {
@@ -1114,6 +1119,16 @@
   INTERNAL_ERROR = 'INTERNAL_ERROR',
 }
 
+export enum BitcoinProviderErrorType {
+  USER_REJECTED_REQUEST = 'USER_REJECTED_REQUEST',
+  UNAUTHORIZED = 'UNAUTHORIZED',
+  UNSUPPORTED_METHOD = 'UNSUPPORTED_METHOD',
+  DISCONNECTED = 'DISCONNECTED',
+  CHAIN_DISCONNECTED = 'CHAIN_DISCONNECTED',
+  INVALID_PARAMS = 'INVALID_PARAMS',
+  INTERNAL_ERROR = 'INTERNAL_ERROR',
+}
+
 export interface EvmSendTransactionParams {
   from: string;
   to?: string;
@@ -1132,6 +1147,54 @@
   canSign: boolean;
 }
 
+export interface BitcoinSignRequest {
+  account: AccountJson;
+  hashPayload: string;
+  canSign: boolean;
+}
+
+export interface BitcoinRecipientTransactionParams{
+  address: string;
+  amount: string;
+}
+
+export interface BitcoinSendTransactionParams {
+  account: string;
+  network: 'mainnet' | 'testnet';
+  recipients: BitcoinRecipientTransactionParams[]
+}
+
+export interface PsbtTransactionArg {
+  address?: string;
+  amount?: string;
+}
+
+export interface BitcoinSignPsbtPayload extends Omit<BitcoinSignPsbtRawRequest, 'psbt'>{
+  txInput: PsbtTransactionArg[];
+  txOutput: PsbtTransactionArg[];
+  to: string;
+  value: string;
+  psbt: Psbt;
+  tokenSlug: string;
+}
+
+enum SignatureHash {
+  DEFAULT = 0,
+  ALL = 1,
+  NONE = 2,
+  SINGLE = 3,
+  ANYONECANPAY = 128
+}
+
+export interface BitcoinSignPsbtRawRequest {
+  psbt: string;
+  allowedSighash?: SignatureHash[];
+  signAtIndex?: number | number[];
+  broadcast?: boolean;
+  network: string;
+  account: string;
+}
+
 export interface TonSignRequest {
   account: AccountJson;
   hashPayload: string;
@@ -1251,6 +1314,21 @@
 
 export type ResponseCardanoSignTransaction = Cbor;
 
+export type BitcoinSendTransactionRequest = BitcoinSignRequest
+
+export interface BitcoinSignatureRequest extends BitcoinSignRequest {
+  id: string;
+  payload: unknown;
+  payloadJson: any;
+}
+
+export interface BitcoinAppState {
+  networkKey?: string,
+  isConnected?: boolean,
+  strategy?: BitcoinApiStrategy,
+  listenEvents?: string[]
+}
+
 // TODO: add account info + dataToSign
 export type TonSendTransactionRequest = TonTransactionConfig;
 export type CardanoSendTransactionRequest = CardanoTransactionConfig;
@@ -1259,6 +1337,10 @@
 export type EvmWatchTransactionRequest = EvmSendTransactionRequest;
 export type TonWatchTransactionRequest = TonSendTransactionRequest;
 export type CardanoWatchTransactionRequest = CardanoSendTransactionRequest;
+export type BitcoinWatchTransactionRequest = BitcoinSendTransactionRequest;
+export type BitcoinSignPsbtRequest = BitcoinSignRequest & {
+  payload: BitcoinSignPsbtPayload;
+};
 
 export interface ConfirmationsQueueItemOptions {
   requiredPassword?: boolean;
@@ -1267,6 +1349,26 @@
   isPassConfirmation?: boolean;
 }
 
+export interface BitcoinTransactionConfig{
+  id?: string,
+  from?: string | number;
+  to?: BitcoinRecipientTransactionParams[];
+  value?: number | string | BN;
+  networkKey?: string;
+  tokenSlug?: string;
+}
+
+export interface SignMessageBitcoinResult {
+  signature: string;
+  message: string;
+  address: string;
+}
+
+export interface SignPsbtBitcoinResult {
+  psbt: string;
+  txid?: string
+}
+
 export interface ConfirmationsQueueItem<T> extends ConfirmationsQueueItemOptions, ConfirmationRequestBase {
   payload: T;
   payloadJson: string;
@@ -1333,9 +1435,18 @@
   cardanoWatchTransactionRequest: [ConfirmationsQueueItem<CardanoWatchTransactionRequest>, ConfirmationResult<string>]
 }
 
+export interface ConfirmationDefinitionsBitcoin {
+  bitcoinSignatureRequest: [ConfirmationsQueueItem<BitcoinSignatureRequest>, ConfirmationResult<SignMessageBitcoinResult>],
+  bitcoinSendTransactionRequest: [ConfirmationsQueueItem<BitcoinSendTransactionRequest>, ConfirmationResult<string>],
+  bitcoinSendTransactionRequestAfterConfirmation: [ConfirmationsQueueItem<BitcoinSendTransactionRequest>, ConfirmationResult<string>],
+  bitcoinWatchTransactionRequest: [ConfirmationsQueueItem<BitcoinWatchTransactionRequest>, ConfirmationResult<string>],
+  bitcoinSignPsbtRequest: [ConfirmationsQueueItem<BitcoinSignPsbtRequest>, ConfirmationResult<SignPsbtBitcoinResult>],
+}
+
 export type ConfirmationType = keyof ConfirmationDefinitions;
 export type ConfirmationTypeTon = keyof ConfirmationDefinitionsTon;
 export type ConfirmationTypeCardano = keyof ConfirmationDefinitionsCardano;
+export type ConfirmationTypeBitcoin = keyof ConfirmationDefinitionsBitcoin;
 
 export type ConfirmationsQueue = {
   [CT in ConfirmationType]: Record<string, ConfirmationDefinitions[CT][0]>;
@@ -1347,14 +1458,24 @@
   [CT in ConfirmationTypeCardano]: Record<string, ConfirmationDefinitionsCardano[CT][0]>;
 }
 
+export type ConfirmationsQueueBitcoin = {
+  [CT in ConfirmationTypeBitcoin]: Record<string, ConfirmationDefinitionsBitcoin[CT][0]>;
+}
+
 export type RequestConfirmationsSubscribe = null;
 export type RequestConfirmationsSubscribeTon = null;
 export type RequestConfirmationsSubscribeCardano = null;
+export type RequestConfirmationsSubscribeBitcoin = null;
 
 // Design to use only one confirmation
 export type RequestConfirmationComplete = {
   [CT in ConfirmationType]?: ConfirmationDefinitions[CT][1];
 }
+
+export type RequestConfirmationCompleteBitcoin = {
+  [CT in ConfirmationTypeBitcoin]?: ConfirmationDefinitionsBitcoin[CT][1];
+}
+
 export type RequestConfirmationCompleteTon = {
   [CT in ConfirmationTypeTon]?: ConfirmationDefinitionsTon[CT][1];
 }
@@ -2132,7 +2253,17 @@
 
 /* Core types */
 export type _Address = string;
-export type _BalanceMetadata = unknown;
+export type _BalanceMetadata = BitcoinBalanceMetadata | unknown;
+export type BitcoinBalanceMetadata = {
+  inscriptionCount: number,
+  runeBalance: string, // sum of BTC in UTXO which contains rune
+  inscriptionBalance: string // sum of BTC in UTXO which contains rune
+}
+
+export interface AddressBalanceResult {
+  balance: string;
+  bitcoinBalanceMetadata: BitcoinBalanceMetadata;
+}
 
 // Use stringify to communicate, pure boolean value will error with case 'false' value
 export interface KoniRequestSignatures {
@@ -2394,6 +2525,9 @@
   // Transfer
   'pri(accounts.checkTransfer)': [RequestCheckTransfer, ValidateTransactionResponse];
   'pri(accounts.transfer)': [RequestSubmitTransfer, SWTransactionResponse];
+  'pri(accounts.bitcoin.dapp.transfer.confirmation)': [RequestSubmitTransferWithId, SWTransactionResponse];
+  'pri(accounts.psbt.transfer.confirmation)': [RequestSubmitSignPsbtTransfer, SWTransactionResponse];
+  'pri(accounts.getBitcoinTransactionData)': [RequestSubmitTransfer, BitcoinTransactionData];
   'pri(accounts.getOptimalTransferProcess)': [RequestOptimalTransferProcess, CommonOptimalTransferPath];
   'pri(accounts.approveSpending)': [TokenSpendingApprovalParams, SWTransactionResponse];
 
@@ -2407,9 +2541,11 @@
   'pri(confirmations.subscribe)': [RequestConfirmationsSubscribe, ConfirmationsQueue, ConfirmationsQueue];
   'pri(confirmationsTon.subscribe)': [RequestConfirmationsSubscribeTon, ConfirmationsQueueTon, ConfirmationsQueueTon];
   'pri(confirmationsCardano.subscribe)': [RequestConfirmationsSubscribeCardano, ConfirmationsQueueCardano, ConfirmationsQueueCardano];
+  'pri(confirmationsBitcoin.subscribe)': [RequestConfirmationsSubscribeBitcoin, ConfirmationsQueueBitcoin, ConfirmationsQueueBitcoin];
   'pri(confirmations.complete)': [RequestConfirmationComplete, boolean];
   'pri(confirmationsTon.complete)': [RequestConfirmationCompleteTon, boolean];
   'pri(confirmationsCardano.complete)': [RequestConfirmationCompleteCardano, boolean];
+  'pri(confirmationsBitcoin.complete)': [RequestConfirmationCompleteBitcoin, boolean];
 
   'pub(utils.getRandom)': [RandomTestRequest, number];
   'pub(accounts.listV2)': [RequestAccountList, InjectedAccount[]];

packages/extension-base/src/background/errors/BitcoinProviderError.ts

@@ -0,0 +1,50 @@
+// Copyright 2019-2022 @subwallet/extension-koni authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { SWError } from '@subwallet/extension-base/background/errors/SWError';
+import { BitcoinProviderErrorType } from '@subwallet/extension-base/background/KoniTypes';
+import { detectTranslate } from '@subwallet/extension-base/utils';
+import { t } from 'i18next';
+
+const defaultErrorMap: Record<BitcoinProviderErrorType, { message: string, code?: number }> = {
+  USER_REJECTED_REQUEST: {
+    message: detectTranslate('User Rejected Request'),
+    code: 4001
+  },
+  UNAUTHORIZED: {
+    message: detectTranslate('Failed to sign'),
+    code: 4100
+  },
+  UNSUPPORTED_METHOD: {
+    message: detectTranslate('Unsupported Method'),
+    code: 4200
+  },
+  DISCONNECTED: {
+    message: detectTranslate('Network is disconnected'),
+    code: 4900
+  },
+  CHAIN_DISCONNECTED: {
+    message: detectTranslate('Network is disconnected'),
+    code: 4901
+  },
+  INVALID_PARAMS: {
+    message: detectTranslate('Undefined error. Please contact SubWallet support'),
+    code: -32602
+  },
+  INTERNAL_ERROR: {
+    message: detectTranslate('Undefined error. Please contact SubWallet support'),
+    code: -32603
+  }
+};
+
+export class BitcoinProviderError extends SWError {
+  override errorType: BitcoinProviderErrorType;
+
+  constructor (errorType: BitcoinProviderErrorType, errMessage?: string, data?: unknown) {
+    const { code, message } = defaultErrorMap[errorType];
+    const finalMessage = errMessage || t(message || '') || errorType;
+
+    super(errorType, finalMessage, code, data);
+    this.errorType = errorType;
+  }
+}