@avalabs/bitcoin-module 0.0.23 → 0.1.1

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

@@ -1,98 +0,0 @@
-import type { BitcoinHistoryTx, BitcoinProvider } from '@avalabs/wallets-sdk';
-import type { Network } from '@avalabs/vm-module-types';
-
-import { getProvider } from '../../utils/get-provider';
-
-import { getTransactionHistory } from './get-transaction-history';
-import { convertBtcTransaction } from './convert-btc-transaction';
-
-jest.mock('../../utils/get-provider');
-
-const proxyApiUrl = 'https://proxy.api/';
-
-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 rawHistory: BitcoinHistoryTx[] = [
-  {
-    addresses: [txAddress],
-    amount: 15_000,
-    fee: 600,
-    block: 100_000,
-    confirmations: 1,
-    containsMultisig: false,
-    hash: '0x1rstTxHash',
-    isSender: true,
-    receivedTime: 172139193,
-    confirmedTime: 172139323,
-  },
-];
-
-describe('get-transaction-history', () => {
-  const provider = { getTxHistory: jest.fn() } as unknown as BitcoinProvider;
-
-  beforeEach(() => {
-    jest.mocked(provider.getTxHistory).mockResolvedValue(rawHistory);
-    jest.mocked(getProvider).mockReturnValue(provider);
-  });
-
-  it('should build the provider', async () => {
-    await getTransactionHistory({
-      address: userAddress,
-      network: btcMain,
-      proxyApiUrl,
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: false, proxyApiUrl });
-
-    await getTransactionHistory({
-      address: txAddress,
-      network: btcTest,
-      proxyApiUrl: 'https://proxy-dev.api/',
-    });
-
-    expect(getProvider).toHaveBeenCalledWith({ isTestnet: true, proxyApiUrl: 'https://proxy-dev.api/' });
-  });
-
-  it('calls getTxHistory() method', async () => {
-    await getTransactionHistory({
-      address: userAddress,
-      network: btcTest,
-      proxyApiUrl,
-    });
-
-    expect(provider.getTxHistory).toHaveBeenCalledWith(userAddress);
-  });
-
-  it('maps returned fee rates to known model', async () => {
-    expect(
-      await getTransactionHistory({
-        address: userAddress,
-        network: btcTest,
-        proxyApiUrl,
-      }),
-    ).toEqual(rawHistory.map((tx) => convertBtcTransaction(tx, { address: userAddress, network: btcTest })));
-  });
-});

package/src/handlers/get-transaction-history/get-transaction-history.ts

@@ -1,23 +0,0 @@
-import type { Network } from '@avalabs/vm-module-types';
-
-import { getProvider } from '../../utils/get-provider';
-
-import { convertBtcTransaction } from './convert-btc-transaction';
-
-type GetBtcTransactionHistoryOptions = {
-  network: Network;
-  address: string;
-  proxyApiUrl: string;
-};
-
-export const getTransactionHistory = async ({ address, network, proxyApiUrl }: GetBtcTransactionHistoryOptions) => {
-  const provider = getProvider({ isTestnet: Boolean(network.isTestnet), proxyApiUrl });
-  const rawHistory = await provider.getTxHistory(address);
-
-  return rawHistory.map((tx) =>
-    convertBtcTransaction(tx, {
-      address,
-      network,
-    }),
-  );
-};

package/src/handlers/get-transaction-history/index.ts

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

package/src/index.ts

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

package/src/module.test.ts

@@ -1,57 +0,0 @@
-import { Environment, type Network } from '@avalabs/vm-module-types';
-
-import { BitcoinModule } from './module';
-import { getNetworkFee } from './handlers/get-network-fee';
-import { getBalances } from './handlers/get-balances';
-import { devEnv, prodEnv } from './env';
-
-jest.mock('./handlers/get-network-fee');
-jest.mock('./handlers/get-balances');
-
-describe('bitcoin-module', () => {
-  describe('getNetworkFee()', () => {
-    it('uses the get-network-fee handler', async () => {
-      const devModule = new BitcoinModule({ environment: Environment.DEV });
-      await devModule.getNetworkFee({ isTestnet: true } as Network);
-
-      expect(getNetworkFee).toHaveBeenCalledWith({
-        isTestnet: true,
-        proxyApiUrl: devEnv.proxyApiUrl,
-      });
-
-      const prodModule = new BitcoinModule({ environment: Environment.PRODUCTION });
-      await prodModule.getNetworkFee({ isTestnet: false } as Network);
-
-      expect(getNetworkFee).toHaveBeenCalledWith({
-        isTestnet: false,
-        proxyApiUrl: prodEnv.proxyApiUrl,
-      });
-    });
-  });
-
-  describe('getBalances()', () => {
-    it('uses the get-balances handler', async () => {
-      const params = {
-        network: { isTestnet: true } as Network,
-        addresses: ['address-1'],
-        currency: 'USD',
-      };
-
-      const devModule = new BitcoinModule({ environment: Environment.DEV });
-      await devModule.getBalances(params);
-
-      expect(getBalances).toHaveBeenCalledWith({
-        ...params,
-        proxyApiUrl: devEnv.proxyApiUrl,
-      });
-
-      const prodModule = new BitcoinModule({ environment: Environment.PRODUCTION });
-      await prodModule.getBalances(params);
-
-      expect(getBalances).toHaveBeenCalledWith({
-        ...params,
-        proxyApiUrl: prodEnv.proxyApiUrl,
-      });
-    });
-  });
-});

package/src/module.ts

@@ -1,77 +0,0 @@
-import type {
-  Module,
-  Manifest,
-  NetworkFees,
-  GetTransactionHistory,
-  RpcRequest,
-  Network,
-  Environment,
-  GetBalancesParams,
-  GetAddressParams,
-  GetAddressResponse,
-} from '@avalabs/vm-module-types';
-import { parseManifest } from '@avalabs/vm-module-types';
-import { rpcErrors } from '@metamask/rpc-errors';
-import { getEnv } from './env';
-
-import ManifestJson from '../manifest.json';
-import { getNetworkFee } from './handlers/get-network-fee';
-import { getTransactionHistory } from './handlers/get-transaction-history';
-import { getBalances } from './handlers/get-balances';
-import { getAddress } from './handlers/get-address/get-address';
-
-export class BitcoinModule implements Module {
-  #proxyApiUrl: string;
-
-  constructor({ environment }: { environment: Environment }) {
-    const { proxyApiUrl } = getEnv(environment);
-    this.#proxyApiUrl = proxyApiUrl;
-  }
-
-  getAddress({ accountIndex, xpub, isTestnet, walletType }: GetAddressParams): Promise<GetAddressResponse> {
-    return getAddress({ accountIndex, xpub, isTestnet, walletType });
-  }
-
-  getBalances({ addresses, currency, network, storage }: GetBalancesParams) {
-    return getBalances({
-      addresses,
-      currency,
-      network,
-      proxyApiUrl: this.#proxyApiUrl,
-      storage,
-    });
-  }
-
-  getManifest(): Manifest | undefined {
-    const result = parseManifest(ManifestJson);
-    return result.success ? result.data : undefined;
-  }
-
-  getNetworkFee(network: Network): Promise<NetworkFees> {
-    return getNetworkFee({
-      isTestnet: Boolean(network.isTestnet),
-      proxyApiUrl: this.#proxyApiUrl,
-    });
-  }
-
-  async getTransactionHistory({ address, network }: GetTransactionHistory) {
-    return {
-      transactions: await getTransactionHistory({
-        address,
-        network,
-        proxyApiUrl: this.#proxyApiUrl,
-      }),
-    };
-  }
-
-  getTokens(_: Network) {
-    return Promise.resolve([]);
-  }
-
-  async onRpcRequest(request: RpcRequest, _network: Network) {
-    switch (request.method) {
-      default:
-        return { error: rpcErrors.methodNotSupported(`Method ${request.method} not supported`) };
-    }
-  }
-}

package/src/utils/extract-token-market-data.ts

@@ -1,16 +0,0 @@
-import type { SimplePriceResponse, TokenMarketData } from '@avalabs/vm-module-types';
-
-export const extractTokenMarketData = (
-  coinId: string,
-  currency?: string,
-  data?: SimplePriceResponse,
-): TokenMarketData => {
-  const coinData = data?.[coinId]?.[currency ?? ''] ?? {};
-
-  return {
-    priceInCurrency: coinData.price ?? undefined,
-    marketCap: coinData.marketCap ?? undefined,
-    vol24: coinData.vol24 ?? undefined,
-    change24: coinData.change24 ?? undefined,
-  };
-};

package/src/utils/get-provider.test.ts

@@ -1,55 +0,0 @@
-import { BitcoinProvider } from '@avalabs/wallets-sdk';
-
-import { getProvider } from './get-provider';
-
-jest.mock('@avalabs/wallets-sdk');
-
-const PROXY_API_PROD = 'https://proxy.api';
-const PROXY_API_DEV = 'https://proxy-dev.api';
-
-describe('get-provider', () => {
-  it.each([
-    { isTestnet: true, proxyApiUrl: PROXY_API_DEV },
-    { isTestnet: false, proxyApiUrl: PROXY_API_DEV },
-    { isTestnet: false, proxyApiUrl: PROXY_API_PROD },
-  ])('builds BitcoinProvider instance with proper params', (params) => {
-    const result = getProvider(params);
-
-    expect(BitcoinProvider).toHaveBeenCalledWith(
-      !params.isTestnet,
-      undefined,
-      `${params.proxyApiUrl}/proxy/nownodes/${params.isTestnet ? 'btcbook-testnet' : 'btcbook'}`,
-      `${params.proxyApiUrl}/proxy/nownodes/${params.isTestnet ? 'btc-testnet' : 'btc'}`,
-      {},
-    );
-
-    expect(result).toBeInstanceOf(BitcoinProvider);
-  });
-
-  describe('when process.env.GLACIER_API_KEY is defined', () => {
-    const env = process.env;
-
-    beforeAll(() => {
-      process.env = {
-        ...env,
-        GLACIER_API_KEY: 'glacier-api-key',
-      };
-    });
-
-    afterAll(() => {
-      process.env = env;
-    });
-
-    it('passes it to the constructor', () => {
-      getProvider({ isTestnet: true, proxyApiUrl: PROXY_API_DEV });
-
-      expect(BitcoinProvider).toHaveBeenCalledWith(
-        false,
-        undefined,
-        `${PROXY_API_DEV}/proxy/nownodes/btcbook-testnet`,
-        `${PROXY_API_DEV}/proxy/nownodes/btc-testnet`,
-        { token: 'glacier-api-key' },
-      );
-    });
-  });
-});

package/src/utils/get-provider.ts

@@ -1,18 +0,0 @@
-import { BitcoinProvider } from '@avalabs/wallets-sdk';
-
-type ProviderParams = {
-  isTestnet: boolean;
-  proxyApiUrl: string;
-};
-
-export const getProvider = ({ isTestnet, proxyApiUrl }: ProviderParams): BitcoinProvider =>
-  new BitcoinProvider(
-    !isTestnet,
-    undefined,
-    `${proxyApiUrl}/proxy/nownodes/${isTestnet ? 'btcbook-testnet' : 'btcbook'}`,
-    `${proxyApiUrl}/proxy/nownodes/${isTestnet ? 'btc-testnet' : 'btc'}`,
-
-    // The Glacier API key is only needed in development to bypass rate limits.
-    // It should never be used in production.
-    process.env.GLACIER_API_KEY ? { token: process.env.GLACIER_API_KEY } : {},
-  );

package/tsconfig.jest.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "verbatimModuleSyntax": false,
-    "esModuleInterop": true
-  }
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "extends": "@internal/tsconfig/tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "declaration": false,
-    "incremental": false // Need to turn off because of tsup dts
-  },
-  "include": ["src"],
-  "references": [
-    {
-      "path": "../../packages-internal/utils/tsconfig.json"
-    }
-  ]
-}

package/tsup.config.ts

@@ -1,4 +0,0 @@
-import { defineConfig } from 'tsup';
-import { baseConfig } from '@internal/tsup-config';
-
-export default defineConfig(baseConfig);