@avalabs/bitcoin-module 0.0.22 → 0.1.0

package/package.json

@@ -1,18 +1,26 @@
 {
   "name": "@avalabs/bitcoin-module",
-  "version": "0.0.22",
+  "version": "0.1.0",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
   "type": "module",
+  "files": [
+    "dist",
+    "manifest.json"
+  ],
+  "license": "Limited Ecosystem License",
   "dependencies": {
-    "@avalabs/vm-module-types": "0.0.22",
+    "@avalabs/vm-module-types": "0.1.0",
     "@avalabs/wallets-sdk": "2.8.0-alpha.193",
     "@avalabs/coingecko-sdk": "v2.8.0-alpha.193",
     "@avalabs/utils-sdk": "2.8.0-alpha.193",
     "@metamask/rpc-errors": "6.3.0",
     "big.js": "6.2.1",
-    "bn.js": "5.2.1"
+    "bn.js": "5.2.1",
+    "zod": "3.23.8",
+    "@zodios/core": "10.9.6",
+    "bitcoinjs-lib": "5.2.0"
   },
   "devDependencies": {
     "@types/big.js": "6.2.2",
@@ -27,6 +35,7 @@
   },
   "scripts": {
     "build": "tsup",
+    "dev": "tsup --watch",
     "lint": "eslint \"src/**/*.ts\"",
     "test": "jest",
     "test:watch": "jest --watch"

package/.turbo/turbo-build.log

@@ -1,22 +0,0 @@
-
-> @avalabs/bitcoin-module@0.0.22 build /home/runner/work/vm-modules/vm-modules/packages/bitcoin-module
-> tsup
-
-CLI Building entry: ./src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
-CLI Using tsup config: /home/runner/work/vm-modules/vm-modules/packages/bitcoin-module/tsup.config.ts
-CLI Target: es2021
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-DTS Build start
-ESM dist/index.js     277.03 KB
-ESM dist/index.js.map 916.88 KB
-ESM ⚡️ Build success in 17748ms
-CJS dist/index.cjs     277.92 KB
-CJS dist/index.cjs.map 916.88 KB
-CJS ⚡️ Build success in 17750ms
-DTS ⚡️ Build success in 25765ms
-DTS dist/index.d.cts 1.25 KB
-DTS dist/index.d.ts  1.25 KB

package/.turbo/turbo-lint.log

@@ -1,4 +0,0 @@
-
-> @avalabs/bitcoin-module@0.0.22 lint /home/runner/work/vm-modules/vm-modules/packages/bitcoin-module
-> eslint "src/**/*.ts"
-

package/.turbo/turbo-test.log

@@ -1,16 +0,0 @@
-
-> @avalabs/bitcoin-module@0.0.22 test /home/runner/work/vm-modules/vm-modules/packages/bitcoin-module
-> jest
-
-PASS src/handlers/get-balances/get-balances.test.ts (35.044 s)
-PASS src/handlers/get-transaction-history/convert-btc-transaction.test.ts
-PASS src/handlers/get-transaction-history/get-transaction-history.test.ts
-PASS src/module.test.ts
-PASS src/utils/get-provider.test.ts
-PASS src/handlers/get-network-fee/get-network-fee.test.ts
-
-Test Suites: 6 passed, 6 total
-Tests:       20 passed, 20 total
-Snapshots:   0 total
-Time:        42.462 s
-Ran all test suites.

package/CHANGELOG.md

@@ -1,49 +0,0 @@
-# @avalabs/bitcoin-module
-
-## 0.0.22
-
-### Patch Changes
-
-- @avalabs/vm-module-types@0.0.22
-
-## 0.0.21
-
-### Patch Changes
-
-- @avalabs/vm-module-types@0.0.21
-
-## 0.0.20
-
-### Patch Changes
-
-- 9bfa82d: Implement balance fetching for BitcoinModule
-- Updated dependencies [9bfa82d]
-  - @avalabs/vm-module-types@0.0.20
-
-## 0.0.19
-
-### Patch Changes
-
-- Updated dependencies [5af458b]
-  - @avalabs/vm-module-types@0.0.19
-
-## 0.0.18
-
-### Patch Changes
-
-- @avalabs/vm-module-types@0.0.18
-
-## 0.0.17
-
-### Patch Changes
-
-- Updated dependencies [3590edf]
-  - @avalabs/vm-module-types@0.0.17
-
-## 0.0.16
-
-### Patch Changes
-
-- de9824c: feat: created bitcoin module
-- Updated dependencies [bc48457]
-  - @avalabs/vm-module-types@0.0.16

package/jest.config.js

@@ -1,10 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-export default {
-  clearMocks: true,
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  passWithNoTests: true,
-  transform: {
-    '.ts': ['ts-jest', { tsconfig: './tsconfig.jest.json' }],
-  },
-};

package/src/env.ts

@@ -1,25 +0,0 @@
-import { Environment } from '@avalabs/vm-module-types';
-
-type Env = {
-  glacierApiUrl: string;
-  proxyApiUrl: string;
-};
-
-export const prodEnv: Env = {
-  glacierApiUrl: 'https://glacier-api.avax.network',
-  proxyApiUrl: 'https://proxy-api.avax.network',
-};
-
-export const devEnv: Env = {
-  glacierApiUrl: 'https://glacier-api-dev.avax.network',
-  proxyApiUrl: 'https://proxy-api-dev.avax.network',
-};
-
-export const getEnv = (environment: Environment): Env => {
-  switch (environment) {
-    case Environment.PRODUCTION:
-      return prodEnv;
-    case Environment.DEV:
-      return devEnv;
-  }
-};

package/src/handlers/get-balances/get-balances.test.ts

@@ -1,181 +0,0 @@
-import type { BitcoinProvider } from '@avalabs/wallets-sdk';
-
-import { getProvider } from '../../utils/get-provider';
-import { getBalances } from './get-balances';
-import { TokenType, type Network } from '@avalabs/vm-module-types';
-import { BN } from 'bn.js';
-import { TokenService } from '@internal/utils';
-
-jest.mock('../../utils/get-provider');
-
-const proxyApiUrl = 'https://proxy.api/';
-
-describe('get-balances', () => {
-  const provider = { getUtxoBalance: jest.fn() } as unknown as BitcoinProvider;
-  const nativeTokenId = 'btc-id';
-  const network = {
-    pricingProviders: {
-      coingecko: {
-        nativeTokenId,
-      },
-    },
-    networkToken: {
-      decimals: 8,
-      symbol: 'BTC',
-      name: 'Bitcoin',
-    },
-    isTestnet: false,
-  } as const as Network;
-
-  const mockedBalance = {
-    balance: 15_000_000,
-    balanceUnconfirmed: 5_000_000,
-    utxos: [
-      { txHash: 'utxo-1', index: 0, value: 10_000_000, blockHeight: 10, confirmations: 20 },
-      { txHash: 'utxo-2', index: 1, value: 5_000_000, blockHeight: 15, confirmations: 5 },
-    ],
-    utxosUnconfirmed: [{ txHash: 'utxo-3', index: 2, value: 5_000_000, blockHeight: 20, confirmations: 0 }],
-  };
-
-  const marketData = {
-    [nativeTokenId]: {
-      USD: {
-        price: 50_000,
-        marketCap: 1_500_000_000_000,
-        vol24: 500_000_000_000,
-        change24: 0.01,
-      },
-    },
-  };
-
-  beforeEach(() => {
-    jest.mocked(provider.getUtxoBalance).mockResolvedValue(mockedBalance);
-    jest.mocked(getProvider).mockReturnValue(provider);
-
-    jest.spyOn(TokenService.prototype, 'getSimplePrice').mockResolvedValue(marketData);
-  });
-
-  it('should build the provider and use it', async () => {
-    await getBalances({
-      addresses: [],
-      network: {
-        ...network,
-        isTestnet: true,
-      },
-      proxyApiUrl,
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: true, proxyApiUrl });
-
-    await getBalances({
-      addresses: [],
-      network: {
-        ...network,
-        isTestnet: false,
-      },
-      proxyApiUrl: 'https://proxy-dev.api/',
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: false, proxyApiUrl: 'https://proxy-dev.api/' });
-  });
-
-  it('should call getUtxoBalance() method', async () => {
-    await getBalances({
-      addresses: ['first-address'],
-      network,
-      proxyApiUrl,
-    });
-
-    expect(provider.getUtxoBalance).toHaveBeenCalledWith('first-address', undefined);
-  });
-
-  it('uses withScripts option when requested', async () => {
-    await getBalances({
-      addresses: ['first-address'],
-      network,
-      proxyApiUrl,
-      withScripts: true,
-    });
-
-    expect(provider.getUtxoBalance).toHaveBeenCalledWith('first-address', true);
-  });
-
-  describe('when no currency is passed', () => {
-    it('does not call the token service', async () => {
-      jest.spyOn(TokenService.prototype, 'getSimplePrice');
-
-      await getBalances({
-        addresses: ['first-address'],
-        network,
-        proxyApiUrl,
-      });
-
-      expect(TokenService.prototype.getSimplePrice).not.toHaveBeenCalled();
-    });
-
-    it('does not return the price-related information', async () => {
-      expect(
-        await getBalances({
-          addresses: ['first-address'],
-          network,
-          proxyApiUrl,
-        }),
-      ).toEqual({
-        'first-address': {
-          BTC: {
-            ...network.networkToken,
-            utxos: mockedBalance.utxos,
-            utxosUnconfirmed: mockedBalance.utxosUnconfirmed,
-            coingeckoId: network.pricingProviders?.coingecko?.nativeTokenId,
-            type: TokenType.NATIVE,
-            balance: new BN(mockedBalance.balance, 8),
-            balanceDisplayValue: '0.15',
-            balanceInCurrency: undefined,
-            balanceCurrencyDisplayValue: undefined,
-            priceInCurrency: undefined,
-            marketCap: undefined,
-            vol24: undefined,
-            change24: undefined,
-            unconfirmedBalance: new BN(mockedBalance.balanceUnconfirmed, 8),
-            unconfirmedBalanceDisplayValue: '0.05',
-            unconfirmedBalanceInCurrency: undefined,
-            unconfirmedBalanceCurrencyDisplayValue: undefined,
-          },
-        },
-      });
-    });
-  });
-
-  it('maps returned balances to known model', async () => {
-    expect(
-      await getBalances({
-        addresses: ['first-address'],
-        currency: 'USD',
-        network,
-        proxyApiUrl,
-      }),
-    ).toEqual({
-      'first-address': {
-        BTC: {
-          ...network.networkToken,
-          utxos: mockedBalance.utxos,
-          utxosUnconfirmed: mockedBalance.utxosUnconfirmed,
-          coingeckoId: network.pricingProviders?.coingecko?.nativeTokenId,
-          type: TokenType.NATIVE,
-          balance: new BN(mockedBalance.balance, 8),
-          balanceDisplayValue: '0.15',
-          balanceInCurrency: 7500,
-          balanceCurrencyDisplayValue: '7500.00',
-          priceInCurrency: 50_000,
-          marketCap: 1_500_000_000_000,
-          vol24: 500_000_000_000,
-          change24: 0.01,
-          unconfirmedBalance: new BN(mockedBalance.balanceUnconfirmed, 8),
-          unconfirmedBalanceDisplayValue: '0.05',
-          unconfirmedBalanceInCurrency: 2500,
-          unconfirmedBalanceCurrencyDisplayValue: '2500.00',
-        },
-      },
-    });
-  });
-});

package/src/handlers/get-balances/get-balances.ts

@@ -1,108 +0,0 @@
-import { TokenType, type GetBalancesParams, type GetBalancesResponse } from '@avalabs/vm-module-types';
-import { bigToBN, balanceToDisplayValue } from '@avalabs/utils-sdk';
-import type { VsCurrencyType } from '@avalabs/coingecko-sdk';
-import Big from 'big.js';
-
-import { TokenService } from '@internal/utils';
-
-import { getProvider } from '../../utils/get-provider';
-import { extractTokenMarketData } from '../../utils/extract-token-market-data';
-
-type GetBTCBalancesParams = Omit<GetBalancesParams, 'currency'> & {
-  proxyApiUrl: string;
-  withScripts?: boolean;
-  currency?: string;
-};
-
-export const getBalances = async ({
-  addresses,
-  currency,
-  network,
-  withScripts,
-  proxyApiUrl,
-  storage,
-}: GetBTCBalancesParams): Promise<GetBalancesResponse> => {
-  const provider = getProvider({
-    isTestnet: Boolean(network.isTestnet),
-    proxyApiUrl,
-  });
-
-  const tokenService = new TokenService({ proxyApiUrl, storage });
-  const coingeckoTokenId = network.pricingProviders?.coingecko.nativeTokenId;
-  const withPrices = typeof currency === 'string' && typeof coingeckoTokenId === 'string';
-  const marketData = withPrices
-    ? await tokenService.getSimplePrice({
-        coinIds: [coingeckoTokenId],
-        currencies: [currency] as VsCurrencyType[],
-      })
-    : undefined;
-  const denomination = network.networkToken.decimals;
-  const { priceInCurrency, change24, marketCap, vol24 } = extractTokenMarketData(
-    coingeckoTokenId ?? '',
-    currency,
-    marketData,
-  );
-
-  const balances = await Promise.allSettled(
-    addresses.map(async (address) => {
-      const {
-        balance: balanceInSatoshis,
-        utxos,
-        balanceUnconfirmed: unconfirmedBalanceInSatoshis,
-        utxosUnconfirmed,
-      } = await provider.getUtxoBalance(address, withScripts);
-
-      const balanceBig = new Big(balanceInSatoshis).div(10 ** denomination);
-      const balance = bigToBN(balanceBig, denomination);
-      const balanceDisplayValue = balanceToDisplayValue(balance, denomination);
-      const balanceInCurrency =
-        priceInCurrency === undefined ? undefined : balanceBig.times(priceInCurrency).toNumber();
-
-      const balanceCurrencyDisplayValue = balanceInCurrency?.toFixed(2);
-
-      const unconfirmedBalanceBig = new Big(unconfirmedBalanceInSatoshis).div(10 ** denomination);
-      const unconfirmedBalance = bigToBN(unconfirmedBalanceBig, denomination);
-      const unconfirmedBalanceDisplayValue = balanceToDisplayValue(unconfirmedBalance, denomination);
-      const unconfirmedBalanceInCurrency =
-        priceInCurrency === undefined ? undefined : unconfirmedBalanceBig.times(priceInCurrency).toNumber();
-      const unconfirmedBalanceCurrencyDisplayValue = unconfirmedBalanceInCurrency?.toFixed(2);
-
-      const symbol = network.networkToken.symbol;
-
-      return {
-        [address]: {
-          [symbol]: {
-            ...network.networkToken,
-            utxos,
-            utxosUnconfirmed,
-            coingeckoId: coingeckoTokenId ?? '',
-            type: TokenType.NATIVE,
-            balance,
-            balanceDisplayValue,
-            balanceInCurrency,
-            balanceCurrencyDisplayValue,
-            priceInCurrency,
-            marketCap,
-            vol24,
-            change24,
-            unconfirmedBalance,
-            unconfirmedBalanceDisplayValue,
-            unconfirmedBalanceInCurrency,
-            unconfirmedBalanceCurrencyDisplayValue,
-          },
-        },
-      };
-    }),
-  );
-
-  return balances.reduce((acc, accountBalance) => {
-    if (accountBalance.status === 'rejected') {
-      return acc;
-    }
-
-    return {
-      ...acc,
-      ...accountBalance.value,
-    };
-  }, {});
-};

package/src/handlers/get-balances/index.ts

@@ -1 +0,0 @@
-export * from './get-balances';

package/src/handlers/get-network-fee/get-network-fee.test.ts

@@ -1,67 +0,0 @@
-import type { BitcoinProvider } from '@avalabs/wallets-sdk';
-
-import { getProvider } from '../../utils/get-provider';
-import { getNetworkFee } from './get-network-fee';
-
-jest.mock('../../utils/get-provider');
-
-const proxyApiUrl = 'https://proxy.api/';
-
-describe('get-network-fee', () => {
-  const provider = { getFeeRates: jest.fn() } as unknown as BitcoinProvider;
-
-  beforeEach(() => {
-    jest.mocked(provider.getFeeRates).mockResolvedValue({
-      low: 1,
-      medium: 2,
-      high: 4,
-    });
-
-    jest.mocked(getProvider).mockReturnValue(provider);
-  });
-
-  it('should build the provider and use it', async () => {
-    await getNetworkFee({
-      isTestnet: true,
-      proxyApiUrl,
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: true, proxyApiUrl });
-
-    await getNetworkFee({
-      isTestnet: false,
-      proxyApiUrl: 'https://proxy-dev.api/',
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: false, proxyApiUrl: 'https://proxy-dev.api/' });
-  });
-
-  it('should call getFeeRates() method', async () => {
-    await getNetworkFee({
-      isTestnet: false,
-      proxyApiUrl,
-    });
-
-    expect(provider.getFeeRates).toHaveBeenCalled();
-  });
-
-  it('maps returned fee rates to known model', async () => {
-    expect(
-      await getNetworkFee({
-        isTestnet: false,
-        proxyApiUrl,
-      }),
-    ).toEqual({
-      low: {
-        maxFeePerGas: 1n,
-      },
-      medium: {
-        maxFeePerGas: 2n,
-      },
-      high: {
-        maxFeePerGas: 4n,
-      },
-      isFixedFee: false,
-    });
-  });
-});

package/src/handlers/get-network-fee/get-network-fee.ts

@@ -1,34 +0,0 @@
-import type { NetworkFees } from '@avalabs/vm-module-types';
-
-import { getProvider } from '../../utils/get-provider';
-
-/**
- * Returns {@link NetworkFees} based on `estimatesmartfee` RPC call
- */
-export async function getNetworkFee({
-  isTestnet,
-  proxyApiUrl,
-}: {
-  isTestnet: boolean;
-  proxyApiUrl: string;
-}): Promise<NetworkFees> {
-  const provider = getProvider({
-    isTestnet,
-    proxyApiUrl,
-  });
-
-  const { high, low, medium } = await provider.getFeeRates();
-
-  return {
-    low: {
-      maxFeePerGas: BigInt(low),
-    },
-    medium: {
-      maxFeePerGas: BigInt(medium),
-    },
-    high: {
-      maxFeePerGas: BigInt(high),
-    },
-    isFixedFee: false,
-  };
-}

package/src/handlers/get-network-fee/index.ts

@@ -1 +0,0 @@
-export * from './get-network-fee';

package/src/handlers/get-transaction-history/convert-btc-transaction.test.ts

@@ -1,108 +0,0 @@
-import { TokenType, TransactionType, type Network } from '@avalabs/vm-module-types';
-
-import { convertBtcTransaction } from './convert-btc-transaction';
-
-const btcMain: Network = {
-  isTestnet: false,
-  chainId: 987654,
-  networkToken: {
-    decimals: 8,
-    name: 'Bitcoin',
-    symbol: 'BTC',
-  },
-  explorerUrl: 'https://btc.main',
-} as unknown as Network;
-
-const btcTest: Network = {
-  isTestnet: true,
-  chainId: 987653,
-  networkToken: {
-    decimals: 8,
-    name: 'Bitcoin',
-    symbol: 'BTC',
-  },
-  explorerUrl: 'https://btc.test',
-} as unknown as Network;
-
-const userAddress = 'b1-user-address';
-const txAddress = 'b1-tx-address';
-
-const outgoingTx = {
-  addresses: [txAddress],
-  amount: 15_000,
-  fee: 600,
-  block: 100_000,
-  confirmations: 1,
-  containsMultisig: false,
-  hash: '0x1rstTxHash',
-  isSender: true,
-  receivedTime: 123_456_789,
-  confirmedTime: 123_456_987,
-};
-
-const incomingTx = {
-  addresses: [txAddress],
-  amount: 30_000,
-  fee: 450,
-  block: 110_000,
-  confirmations: 5,
-  containsMultisig: false,
-  hash: '0x2ndTxHash',
-  isSender: false,
-  receivedTime: 123_654_789,
-  confirmedTime: 123_654_987,
-};
-
-describe('convert-btc-transaction', () => {
-  it('should properly map outgoing txs', () => {
-    expect(convertBtcTransaction(outgoingTx, { address: userAddress, network: btcMain })).toEqual({
-      chainId: btcMain.chainId.toString(),
-      explorerLink: `${btcMain.explorerUrl}/btc/tx/${outgoingTx.hash}`,
-      from: userAddress,
-      gasUsed: outgoingTx.fee.toString(),
-      hash: outgoingTx.hash,
-      isContractCall: false,
-      isIncoming: false,
-      isOutgoing: true,
-      isSender: true,
-      timestamp: outgoingTx.receivedTime * 1000,
-      to: txAddress,
-      tokens: [
-        {
-          amount: (Math.abs(outgoingTx.amount) / 10 ** btcMain.networkToken.decimals).toString(),
-          decimal: btcMain.networkToken.decimals.toString(),
-          name: btcMain.networkToken.name,
-          symbol: btcMain.networkToken.symbol,
-          type: TokenType.NATIVE,
-        },
-      ],
-      txType: TransactionType.SEND,
-    });
-  });
-
-  it('should properly map incoming txs', () => {
-    expect(convertBtcTransaction(incomingTx, { address: userAddress, network: btcTest })).toEqual({
-      chainId: btcTest.chainId.toString(),
-      explorerLink: `${btcTest.explorerUrl}/btc-testnet/tx/${incomingTx.hash}`,
-      from: txAddress,
-      gasUsed: incomingTx.fee.toString(),
-      hash: incomingTx.hash,
-      isContractCall: false,
-      isIncoming: true,
-      isOutgoing: false,
-      isSender: false,
-      timestamp: incomingTx.receivedTime * 1000,
-      to: userAddress,
-      tokens: [
-        {
-          amount: (Math.abs(incomingTx.amount) / 10 ** btcTest.networkToken.decimals).toString(),
-          decimal: btcTest.networkToken.decimals.toString(),
-          name: btcTest.networkToken.name,
-          symbol: btcTest.networkToken.symbol,
-          type: TokenType.NATIVE,
-        },
-      ],
-      txType: TransactionType.RECEIVE,
-    });
-  });
-});