@avalabs/avalanche-module 0.0.23 → 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright (C) 2021, Ava Labs, Inc. All rights reserved.
+
+Subject to the limited license below (**”License””), you may not, and you may not permit anyone else to, copy, reproduce, aggregate, republish, download, post, distribute, license, sublicense, reverse engineer, modify, or create derivative works based on this software (collectively, **“Software”**). 
+
+You are hereby granted a limited, non-exclusive, non-sublicensable and non-transferable license to download and use the Software as-is solely (i) for use in connection with the Avalanche Public Blockchain platform, having a NetworkID of 1 (Mainnet) or 5 (Fuji), and associated blockchains, comprised exclusively of the Avalanche X-Chain, C-Chain, P-Chain and any subnets linked to the P-Chain (**“Avalanche Authorized Platform”**) or (ii) for non-production, testing or research purposes without any commercial application within the Avalanche ecosystem (**“Non-Commercial Use”**); provided that, in each case, you may not use or allow use of the Software (a) in connection with any forks of the Avalanche Authorized Platform, (b) in any manner not operationally connected to the Avalanche Authorized Platform other than for Non-Commercial Use, or (c) to the extent the number of monthly active users or the number of total installs of any software that uses the Software across all versions thereof exceeds 10,000 at any time. You may not modify or alter the Software in any way.
+
+You hereby acknowledge and agree to the terms set forth at www.avalabs.org/important-notice.
+
+**TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED ON AN “AS IS” BASIS, AND AVA LABS EXPRESSLY DISCLAIMS AND EXCLUDES ALL REPRESENTATIONS, WARRANTIES AND OTHER TERMS AND CONDITIONS, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION BY OPERATION OF LAW OR BY CUSTOM, STATUTE OR OTHERWISE, AND INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTY, TERM, OR CONDITION OF NON-INFRINGEMENT, MERCHANTABILITY, TITLE, OR FITNESS FOR PARTICULAR PURPOSE. YOU USE THE SOFTWARE AT YOUR OWN RISK. AVA LABS EXPRESSLY DISCLAIMS ALL LIABILITY (INCLUDING FOR ALL DIRECT, CONSEQUENTIAL OR OTHER DAMAGES OR LOSSES) RELATED TO ANY USE OF THE SOFTWARE.**

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "@avalabs/avalanche-module",
-  "version": "0.0.23",
+  "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.23",
+    "@avalabs/vm-module-types": "0.1.0",
     "@metamask/rpc-errors": "6.3.0",
     "@avalabs/utils-sdk": "v2.8.0-alpha.193",
     "@avalabs/etherscan-sdk": "v2.8.0-alpha.193",

package/.turbo/turbo-build.log

@@ -1,22 +0,0 @@
-
-> @avalabs/avalanche-module@0.0.23 build /home/runner/work/vm-modules/vm-modules/packages/avalanche-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/avalanche-module/tsup.config.ts
-CLI Target: es2021
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-ESM dist/index.js     16.73 KB
-ESM dist/index.js.map 64.68 KB
-ESM ⚡️ Build success in 2768ms
-CJS dist/index.cjs     17.70 KB
-CJS dist/index.cjs.map 64.68 KB
-CJS ⚡️ Build success in 2797ms
-DTS Build start
-DTS ⚡️ Build success in 24712ms
-DTS dist/index.d.cts 1.68 KB
-DTS dist/index.d.ts  1.68 KB

package/.turbo/turbo-lint.log

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

package/.turbo/turbo-test.log

@@ -1,12 +0,0 @@
-
-> @avalabs/avalanche-module@0.0.23 test /home/runner/work/vm-modules/vm-modules/packages/avalanche-module
-> jest
-
-PASS src/utils/hash-blockchain-id.test.ts (27.639 s)
-PASS src/handlers/get-network-fee/get-network-fee.test.ts
-
-Test Suites: 2 passed, 2 total
-Tests:       7 passed, 7 total
-Snapshots:   0 total
-Time:        29.674 s
-Ran all test suites.

package/CHANGELOG.md

@@ -1,99 +0,0 @@
-# @avalabs/avalanche-module
-
-## 0.0.23
-
-### Patch Changes
-
-- bed2fcb: add transaction types for bitcoin module
-- 898dde1: Add getAddress function
-- Updated dependencies [fbdefd2]
-  - @avalabs/vm-module-types@0.0.23
-
-## 0.0.22
-
-### Patch Changes
-
-- a841a90: handle all eth\_\* methods
-  - @avalabs/vm-module-types@0.0.22
-
-## 0.0.21
-
-### Patch Changes
-
-- bb1478d: fix simplePrice caching logic
-  - @avalabs/vm-module-types@0.0.21
-
-## 0.0.20
-
-### Patch Changes
-
-- Updated dependencies [9bfa82d]
-  - @avalabs/vm-module-types@0.0.20
-
-## 0.0.19
-
-### Patch Changes
-
-- 5af458b: Add getBalances to avalanche-module
-- 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
-
-- f39ff3a: Fixe internal dependencies
-- 2bb0a1a: add getHashedBlockchainId util to avalanche module
-- Updated dependencies [bc48457]
-  - @avalabs/vm-module-types@0.0.16
-
-## 0.0.15
-
-### Patch Changes
-
-- Updated dependencies [f536d58]
-  - @avalabs/vm-module-types@0.0.15
-  - @internal/utils@0.0.3
-
-## 0.0.14
-
-### Patch Changes
-
-- 0593258: add getBalances to evm-module
-- Updated dependencies [0593258]
-  - @avalabs/vm-module-types@0.0.14
-  - @internal/utils@0.0.2
-
-## 0.0.13
-
-### Patch Changes
-
-- af68c81: Add getTransactionHistory to avalanche module
-- d9fa0f5: added getNetworkFee to avalanche module
-- Updated dependencies [af68c81]
-- Updated dependencies [d9fa0f5]
-  - @avalabs/vm-module-types@0.0.13
-
-## 0.0.12
-
-### Patch Changes
-
-- d0c2cc9: make module interface more consistent
-- 02560da: Created Avalanche module
-- Updated dependencies [cd97708]
-- Updated dependencies [d0c2cc9]
-- Updated dependencies [7bc6c6e]
-  - @avalabs/vm-module-types@0.0.12

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-address/get-address.ts

@@ -1,44 +0,0 @@
-import type { GetAddressParams, GetAddressResponse } from '@avalabs/vm-module-types';
-import { Avalanche } from '@avalabs/wallets-sdk';
-import { NetworkVMType, WalletType } from '@avalabs/vm-module-types';
-import { rpcErrors } from '@metamask/rpc-errors';
-
-type GetAddress = Omit<GetAddressParams, 'xpub'>;
-
-export const getAddress = async ({
-  accountIndex,
-  isTestnet,
-  xpubXP,
-  walletType,
-}: GetAddress): Promise<GetAddressResponse> => {
-  if (xpubXP === undefined) {
-    throw rpcErrors.invalidParams('xpubXP is required to get address');
-  }
-
-  const provXP = isTestnet
-    ? Avalanche.JsonRpcProvider.getDefaultFujiProvider()
-    : Avalanche.JsonRpcProvider.getDefaultMainnetProvider();
-  let xpPub: Buffer;
-
-  switch (walletType) {
-    case WalletType.Mnemonic:
-    case WalletType.Ledger:
-    case WalletType.Keystone: {
-      // X and P addresses different derivation path m/44'/9000'/0'...
-      xpPub = Avalanche.getAddressPublicKeyFromXpub(xpubXP, accountIndex);
-      break;
-    }
-    case WalletType.LedgerLive:
-    case WalletType.Seedless: {
-      xpPub = Buffer.from(xpubXP, 'hex');
-      break;
-    }
-    default:
-      throw rpcErrors.invalidParams(`Unsupported wallet type: ${walletType}`);
-  }
-
-  return {
-    [NetworkVMType.AVM]: provXP.getAddress(xpPub, 'X'),
-    [NetworkVMType.PVM]: provXP.getAddress(xpPub, 'P'),
-  };
-};

package/src/handlers/get-balances/convert-p-chain-balance.ts

@@ -1,91 +0,0 @@
-import type { AggregatedAssetAmount, PChainBalance } from '@avalabs/glacier-sdk';
-import { balanceToDisplayValue, bnToBig } from '@avalabs/utils-sdk';
-import { BN } from 'bn.js';
-import { calculateTotalBalance, getTokenValue } from './utils';
-import { TokenType, type NetworkToken, type TokenWithBalancePVM } from '@avalabs/vm-module-types';
-
-export const convertPChainBalance = ({
-  balance,
-  networkToken,
-  priceInCurrency,
-  marketCap,
-  vol24,
-  change24,
-  coingeckoId,
-}: {
-  balance: PChainBalance;
-  networkToken: NetworkToken;
-  priceInCurrency?: number;
-  marketCap?: number;
-  vol24?: number;
-  change24?: number;
-  coingeckoId: string;
-}): TokenWithBalancePVM => {
-  const decimals = networkToken.decimals;
-  const balancePerType: Record<string, number> = {};
-
-  const balanceTypes: Record<string, AggregatedAssetAmount[]> = {
-    unlockedUnstaked: balance.unlockedUnstaked,
-    unlockedStaked: balance.unlockedStaked,
-    pendingStaked: balance.pendingStaked,
-    lockedStaked: balance.lockedStaked,
-    lockedStakeable: balance.lockedStakeable,
-    lockedPlatform: balance.lockedPlatform,
-    atomicMemoryLocked: balance.atomicMemoryLocked,
-    atomicMemoryUnlocked: balance.atomicMemoryUnlocked,
-  };
-
-  for (const balanceType in balanceTypes) {
-    const balancesToAdd = balanceTypes[balanceType];
-    if (!balancesToAdd || !balancesToAdd.length) {
-      balancePerType[balanceType] = 0;
-      continue;
-    }
-
-    balancesToAdd.forEach((uxto: AggregatedAssetAmount) => {
-      const previousBalance = balancePerType[balanceType] ?? 0;
-      const newBalance = previousBalance + Number(uxto.amount);
-      balancePerType[balanceType] = newBalance;
-    });
-  }
-
-  const available = balancePerType['unlockedUnstaked'] ? new BN(balancePerType['unlockedUnstaked']) : new BN(0);
-  const availableInCurrency = priceInCurrency
-    ? bnToBig(available, decimals).mul(priceInCurrency).toNumber()
-    : undefined;
-  const availableDisplayValue = balanceToDisplayValue(available, decimals);
-  const totalBalance = calculateTotalBalance(balance);
-  const balanceInCurrency = priceInCurrency
-    ? bnToBig(totalBalance, decimals).mul(priceInCurrency).toNumber()
-    : undefined;
-  const balanceDisplayValue = balanceToDisplayValue(totalBalance, decimals);
-
-  return {
-    ...networkToken,
-    type: TokenType.NATIVE,
-    priceInCurrency,
-    balance: totalBalance,
-    balanceInCurrency,
-    balanceDisplayValue,
-    balanceCurrencyDisplayValue: balanceInCurrency?.toFixed(2),
-    available,
-    availableInCurrency,
-    availableDisplayValue,
-    availableCurrencyDisplayValue: availableInCurrency?.toFixed(2),
-    utxos: balance,
-    balancePerType: {
-      lockedStaked: getTokenValue(decimals, balancePerType['lockedStaked']),
-      lockedStakeable: getTokenValue(decimals, balancePerType['lockedStakeable']),
-      lockedPlatform: getTokenValue(decimals, balancePerType['lockedPlatform']),
-      atomicMemoryLocked: getTokenValue(decimals, balancePerType['atomicMemoryLocked']),
-      atomicMemoryUnlocked: getTokenValue(decimals, balancePerType['atomicMemoryUnlocked']),
-      unlockedUnstaked: getTokenValue(decimals, balancePerType['unlockedUnstaked']),
-      unlockedStaked: getTokenValue(decimals, balancePerType['unlockedStaked']),
-      pendingStaked: getTokenValue(decimals, balancePerType['pendingStaked']),
-    },
-    marketCap,
-    vol24,
-    change24,
-    coingeckoId,
-  };
-};

package/src/handlers/get-balances/covnert-x-chain-balance.ts

@@ -1,74 +0,0 @@
-import type { AggregatedAssetAmount, XChainBalances } from '@avalabs/glacier-sdk';
-import { balanceToDisplayValue, bnToBig } from '@avalabs/utils-sdk';
-import { calculateTotalBalance, getTokenValue } from './utils';
-import { TokenType, type NetworkToken, type TokenWithBalanceAVM } from '@avalabs/vm-module-types';
-
-export const convertXChainBalance = ({
-  balance,
-  networkToken,
-  priceInCurrency,
-  marketCap,
-  vol24,
-  change24,
-  coingeckoId,
-}: {
-  balance: XChainBalances;
-  networkToken: NetworkToken;
-  priceInCurrency?: number;
-  marketCap?: number;
-  vol24?: number;
-  change24?: number;
-  coingeckoId: string;
-}): TokenWithBalanceAVM => {
-  const decimals = networkToken.decimals;
-  const balancePerType: Record<string, number> = {};
-
-  const balanceTypes: Record<string, AggregatedAssetAmount[]> = {
-    unlocked: balance.unlocked,
-    locked: balance.locked,
-    atomicMemoryUnlocked: balance.atomicMemoryUnlocked,
-    atomicMemoryLocked: balance.atomicMemoryLocked,
-  };
-
-  for (const balanceType in balanceTypes) {
-    const balancesToAdd = balanceTypes[balanceType];
-    if (!balancesToAdd || !balancesToAdd.length) {
-      balancePerType[balanceType] = 0;
-      continue;
-    }
-
-    balancesToAdd.forEach((uxto: AggregatedAssetAmount) => {
-      const previousBalance = balancePerType[balanceType] ?? 0;
-      const newBalance = previousBalance + Number(uxto.amount);
-      balancePerType[balanceType] = newBalance;
-    });
-  }
-
-  const totalBalance = calculateTotalBalance(balance);
-  const balanceDisplayValue = balanceToDisplayValue(totalBalance, decimals);
-  const balanceInCurrency = priceInCurrency
-    ? bnToBig(totalBalance, decimals).mul(priceInCurrency).toNumber()
-    : undefined;
-  const balanceCurrencyDisplayValue = balanceInCurrency?.toFixed(2);
-
-  return {
-    ...networkToken,
-    coingeckoId,
-    type: TokenType.NATIVE,
-    priceInCurrency,
-    balance: totalBalance,
-    balanceInCurrency,
-    balanceDisplayValue,
-    balanceCurrencyDisplayValue,
-    utxos: balance,
-    balancePerType: {
-      unlocked: getTokenValue(decimals, balancePerType['unlocked']),
-      locked: getTokenValue(decimals, balancePerType['locked']),
-      atomicMemoryUnlocked: getTokenValue(decimals, balancePerType['atomicMemoryUnlocked']),
-      atomicMemoryLocked: getTokenValue(decimals, balancePerType['atomicMemoryLocked']),
-    },
-    marketCap,
-    vol24,
-    change24,
-  };
-};

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

@@ -1,101 +0,0 @@
-import {
-  NetworkVMType,
-  type GetBalancesParams,
-  type TokenWithBalanceAVM,
-  type TokenWithBalancePVM,
-} from '@avalabs/vm-module-types';
-import { type AvalancheGlacierService } from '../../services/glacier-service/glacier-service';
-import {
-  BlockchainId,
-  Network,
-  type ListPChainBalancesResponse,
-  type ListXChainBalancesResponse,
-} from '@avalabs/glacier-sdk';
-import type { TokenService } from '@internal/utils';
-import { VsCurrencyType } from '@avalabs/coingecko-sdk';
-import { isPchainBalance, isXchainBalance } from './utils';
-import { convertPChainBalance } from './convert-p-chain-balance';
-import { convertXChainBalance } from './covnert-x-chain-balance';
-
-type GetAvalancheBalancesResponse = Record<string, Record<string, TokenWithBalanceAVM | TokenWithBalancePVM>>;
-
-export const getBalances = async ({
-  addresses,
-  currency,
-  network,
-  glacierService,
-  tokenService,
-}: GetBalancesParams & {
-  glacierService: AvalancheGlacierService;
-  tokenService: TokenService;
-}): Promise<GetAvalancheBalancesResponse> => {
-  const isHealthy = glacierService.isHealthy();
-  if (!isHealthy) {
-    return Promise.reject('Glacier is unhealthy. Try again later.');
-  }
-
-  const lowercaseCurrency = currency.toLowerCase();
-  const address = addresses[0] ?? '';
-  const networkToken = network.networkToken;
-  const coingeckoId = network.pricingProviders?.coingecko.nativeTokenId;
-
-  const blockchainId = network.vmName === NetworkVMType.PVM ? BlockchainId.P_CHAIN : BlockchainId.X_CHAIN;
-  const networkName = network.isTestnet ? Network.FUJI : Network.MAINNET;
-
-  const chainBalances = await glacierService
-    .getChainBalance({
-      blockchainId,
-      network: networkName,
-      addresses: addresses.join(','),
-    })
-    .then((value) => (value as ListPChainBalancesResponse | ListXChainBalancesResponse).balances);
-
-  const simplePriceResponse = coingeckoId
-    ? await tokenService.getSimplePrice({
-        coinIds: [coingeckoId],
-        currencies: [lowercaseCurrency] as VsCurrencyType[],
-      })
-    : {};
-
-  const priceInCurrency = simplePriceResponse?.[coingeckoId ?? '']?.[lowercaseCurrency]?.price ?? undefined;
-  const marketCap = simplePriceResponse?.[coingeckoId ?? '']?.[lowercaseCurrency]?.marketCap ?? undefined;
-  const vol24 = simplePriceResponse?.[coingeckoId ?? '']?.[lowercaseCurrency]?.vol24 ?? undefined;
-  const change24 = simplePriceResponse?.[coingeckoId ?? '']?.[lowercaseCurrency]?.change24 ?? undefined;
-
-  let balance: TokenWithBalanceAVM | TokenWithBalancePVM;
-  if (isPchainBalance(chainBalances)) {
-    balance = convertPChainBalance({
-      balance: chainBalances,
-      networkToken,
-      priceInCurrency,
-      marketCap,
-      vol24,
-      change24,
-      coingeckoId: coingeckoId ?? '',
-    });
-
-    return {
-      [address]: {
-        [networkToken.symbol]: balance,
-      },
-    };
-  }
-
-  if (isXchainBalance(chainBalances)) {
-    balance = convertXChainBalance({
-      balance: chainBalances,
-      networkToken,
-      priceInCurrency,
-      marketCap,
-      vol24,
-      change24,
-      coingeckoId: coingeckoId ?? '',
-    });
-    return {
-      [address]: {
-        [networkToken.symbol]: balance,
-      },
-    };
-  }
-  return Promise.reject('Incorrect type balance was returned from glacier');
-};

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

@@ -1,9 +0,0 @@
-import type { TokenWithBalance, TokenWithBalanceAVM, TokenWithBalancePVM } from '@avalabs/vm-module-types';
-
-export const isTokenWithBalancePVM = (token: TokenWithBalance): token is TokenWithBalancePVM => {
-  return 'balancePerType' in token && 'unlockedUnstaked' in token.balancePerType;
-};
-
-export const isTokenWithBalanceAVM = (token: TokenWithBalance): token is TokenWithBalanceAVM => {
-  return 'balancePerType' in token && 'unlocked' in token.balancePerType;
-};

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

@@ -1,27 +0,0 @@
-import type { PChainBalance, XChainBalances } from '@avalabs/glacier-sdk';
-import BN from 'bn.js';
-
-export const isPchainBalance = (balanceResult: PChainBalance | XChainBalances): balanceResult is PChainBalance => {
-  return Object.keys(balanceResult).includes('unlockedUnstaked');
-};
-
-export const isXchainBalance = (balanceResult: PChainBalance | XChainBalances): balanceResult is XChainBalances => {
-  return Object.keys(balanceResult).includes('locked');
-};
-
-export function calculateTotalBalance(uxtos: PChainBalance | XChainBalances): BN {
-  const sum = Object.values(uxtos).reduce(function (totalAcc, utxoList) {
-    const typeSum = utxoList.reduce(function (typeAcc, utxo) {
-      const balanceToAdd = Number(utxo.amount);
-      return typeAcc + balanceToAdd;
-    }, 0);
-
-    return totalAcc + typeSum;
-  }, 0);
-
-  return new BN(sum);
-}
-
-export function getTokenValue(decimals: number, amount?: number) {
-  return amount === undefined ? 0 : amount / 10 ** decimals;
-}

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

@@ -1,19 +0,0 @@
-import { getNetworkFee } from './get-network-fee';
-
-describe('get-network-fee', () => {
-  it('should return fixed network fees', async () => {
-    await expect(getNetworkFee()).resolves.toEqual({
-      baseFee: 1000000n,
-      low: {
-        maxFeePerGas: 1000000n,
-      },
-      medium: {
-        maxFeePerGas: 1000000n,
-      },
-      high: {
-        maxFeePerGas: 1000000n,
-      },
-      isFixedFee: true,
-    });
-  });
-});

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

@@ -1,21 +0,0 @@
-import type { NetworkFees } from '@avalabs/vm-module-types';
-
-/**
- * Returns {@link NetworkFees} based on a fixed fee.
- */
-export async function getNetworkFee(): Promise<NetworkFees> {
-  // this is 0.001 Avax denominated in nAvax, taken from https://docs.avax.network/reference/standards/guides/txn-fees#fee-schedule
-  return {
-    baseFee: BigInt(1000000),
-    low: {
-      maxFeePerGas: BigInt(1000000),
-    },
-    medium: {
-      maxFeePerGas: BigInt(1000000),
-    },
-    high: {
-      maxFeePerGas: BigInt(1000000),
-    },
-    isFixedFee: true,
-  };
-}

package/src/handlers/get-transaction-history/convert-p-chain-transaction.ts

@@ -1,132 +0,0 @@
-import { type PChainTransaction, type NetworkToken } from '@avalabs/glacier-sdk';
-import Big from 'big.js';
-import { Avalanche } from '@avalabs/wallets-sdk';
-import { TokenType, type Transaction } from '@avalabs/vm-module-types';
-import { getExplorerAddressByNetwork, getTokenValue } from './utils';
-
-export function convertPChainTransaction({
-  tx,
-  address,
-  networkToken,
-  chainId,
-  explorerUrl,
-  isTestnet,
-}: {
-  tx: PChainTransaction;
-  address: string;
-  networkToken: NetworkToken;
-  chainId: number;
-  explorerUrl?: string;
-  isTestnet?: boolean;
-}): Transaction {
-  const froms = new Set(tx.consumedUtxos.flatMap((utxo) => utxo.addresses) || []);
-  const tos = new Set(tx.emittedUtxos.flatMap((utxo) => utxo.addresses) || []);
-
-  const amount = getAmount({
-    tx,
-    isTestnet,
-    networkToken,
-    froms,
-  });
-
-  const avaxBurnedAmount = getBurnedAmount({ tx, isTestnet, networkToken });
-  const chainAddress = address.toLowerCase().startsWith('p-') ? address.slice(2) : address;
-  const isSender = froms.has(chainAddress);
-
-  return {
-    hash: tx.txHash,
-    isContractCall: false,
-    isIncoming: !isSender,
-    isOutgoing: isSender,
-    from: [...froms.values()].join(','),
-    to: [...tos.values()].join(','),
-    isSender,
-    timestamp: tx.blockTimestamp * 1000, // to millis
-    tokens: [
-      {
-        decimal: networkToken.decimals.toString(),
-        name: networkToken.name,
-        symbol: networkToken.symbol,
-        type: TokenType.NATIVE,
-        amount: amount.toString(),
-      },
-    ],
-    gasUsed: avaxBurnedAmount.toString(),
-    explorerLink: getExplorerAddressByNetwork(explorerUrl ?? '', tx.txHash, 'tx'),
-    txType: tx.txType,
-    chainId: chainId.toString(),
-  };
-}
-
-function getAmount({
-  tx,
-  isTestnet,
-  networkToken,
-  froms,
-}: {
-  tx: PChainTransaction;
-  isTestnet?: boolean;
-  networkToken: NetworkToken;
-  froms: Set<string>;
-}): Big {
-  const isImportExport = ['ImportTx', 'ExportTx'].includes(tx.txType);
-  const isBaseTx = tx.txType === 'BaseTx';
-
-  const nonChangeEmittedUtxosAmt = tx.emittedUtxos
-    .filter(
-      (utxo) => utxo.asset.assetId === getAvaxAssetId(!!isTestnet) && !utxo.addresses.some((addr) => froms.has(addr)),
-    )
-    .reduce((agg, utxo) => agg.add(utxo.asset.amount), new Big(0));
-  const txValue = tx.value.find((val) => val.assetId === getAvaxAssetId(!!isTestnet))?.amount;
-  // This ternary attempts to cover the case where users send themselves AVAX
-  // in which case the senders are the recipients and we should use the total tx value.
-  const baseTxValue = nonChangeEmittedUtxosAmt.gt(new Big(0))
-    ? nonChangeEmittedUtxosAmt
-    : txValue
-    ? new Big(txValue)
-    : new Big(0) ?? new Big(0);
-
-  const pBlockchainId = isTestnet ? Avalanche.FujiContext.pBlockchainID : Avalanche.MainnetContext.pBlockchainID;
-
-  const importExportAmount = tx.emittedUtxos
-    .filter(
-      (utxo) =>
-        utxo.asset.assetId === getAvaxAssetId(!!isTestnet) &&
-        ((tx.txType === 'ImportTx' && utxo.consumedOnChainId === pBlockchainId) ||
-          (tx.txType === 'ExportTx' && utxo.consumedOnChainId !== pBlockchainId)),
-    )
-    .reduce((agg, utxo) => agg.add(utxo.amount), new Big(0));
-  const nAvaxAmount = isBaseTx
-    ? baseTxValue
-    : isImportExport
-    ? importExportAmount
-    : tx.amountStaked.length === 0
-    ? aggregateValue(tx.value, !!isTestnet)
-    : aggregateValue(tx.amountStaked, !!isTestnet);
-  return getTokenValue({ amount: nAvaxAmount?.toNumber(), decimals: networkToken.decimals });
-}
-
-function getBurnedAmount({
-  tx,
-  isTestnet,
-  networkToken,
-}: {
-  tx: PChainTransaction;
-  isTestnet?: boolean;
-  networkToken: NetworkToken;
-}): Big {
-  const nAvaxFee = tx.amountBurned
-    ?.filter((value) => value.assetId === getAvaxAssetId(!!isTestnet))
-    .reduce((accumulator, value) => accumulator.add(value.amount), new Big(0));
-  return getTokenValue({ amount: nAvaxFee?.toNumber(), decimals: networkToken.decimals });
-}
-
-function aggregateValue(value: PChainTransaction['value'], isTestnet: boolean): Big | undefined {
-  return value
-    .filter((value_) => value_.assetId === getAvaxAssetId(isTestnet))
-    .reduce((accumulator, value_) => accumulator.add(value_.amount), new Big(0));
-}
-
-function getAvaxAssetId(isTestnet: boolean): string {
-  return isTestnet ? Avalanche.FujiContext.avaxAssetID : Avalanche.MainnetContext.avaxAssetID;
-}

package/src/handlers/get-transaction-history/convert-x-chain-transaction.ts

@@ -1,106 +0,0 @@
-import { type NetworkToken, XChainNonLinearTransaction, XChainLinearTransaction } from '@avalabs/glacier-sdk';
-import Big from 'big.js';
-import { Avalanche } from '@avalabs/wallets-sdk';
-import { TokenType, type Transaction } from '@avalabs/vm-module-types';
-import { getExplorerAddressByNetwork, getTokenValue } from './utils';
-
-export function convertXChainTransaction({
-  tx,
-  address,
-  networkToken,
-  chainId,
-  explorerUrl,
-  isTestnet,
-}: {
-  tx: XChainNonLinearTransaction | XChainLinearTransaction;
-  address: string;
-  networkToken: NetworkToken;
-  chainId: number;
-  isTestnet?: boolean;
-  explorerUrl?: string;
-}): Transaction {
-  const froms = new Set(tx.consumedUtxos.flatMap((utxo) => utxo.addresses) || []);
-  const tos = new Set(tx.emittedUtxos.flatMap((utxo) => utxo.addresses) || []);
-
-  const amount = getAmount({
-    tx,
-    isTestnet,
-    networkToken,
-  });
-  const avaxBurnedAmount = getBurnedAmount({ isTestnet, tx, totalAmountCreated: amount, networkToken });
-  const chainAddress = address.toLowerCase().startsWith('x-') ? address.slice(2) : address;
-  const isSender = froms.has(chainAddress);
-
-  return {
-    hash: tx.txHash,
-    isContractCall: false,
-    isIncoming: !isSender,
-    isOutgoing: isSender,
-    from: [...froms.values()].join(','),
-    to: [...tos.values()].join(','),
-    isSender,
-    timestamp: tx.timestamp * 1000, // to millis
-    tokens: [
-      {
-        decimal: networkToken.decimals.toString(),
-        name: networkToken.name,
-        symbol: networkToken.symbol,
-        type: TokenType.NATIVE,
-        amount: amount.toString(),
-      },
-    ],
-    gasUsed: avaxBurnedAmount.toString(),
-    explorerLink: getExplorerAddressByNetwork(explorerUrl ?? '', tx.txHash, 'tx'),
-    txType: tx.txType,
-    chainId: chainId.toString(),
-  };
-}
-
-function getAmount({
-  tx,
-  isTestnet,
-  networkToken,
-}: {
-  tx: XChainNonLinearTransaction | XChainLinearTransaction;
-  isTestnet?: boolean;
-  networkToken: NetworkToken;
-}): Big {
-  const isImportExport = ['ImportTx', 'ExportTx'].includes(tx.txType);
-  const xBlockchainId = isTestnet ? Avalanche.FujiContext.xBlockchainID : Avalanche.MainnetContext.xBlockchainID;
-  const importExportAmount = tx.emittedUtxos
-    .filter(
-      (utxo) =>
-        utxo.asset.assetId === getAvaxAssetId(!!isTestnet) &&
-        ((tx.txType === 'ImportTx' && utxo.consumedOnChainId === xBlockchainId) ||
-          (tx.txType === 'ExportTx' && utxo.consumedOnChainId !== xBlockchainId)),
-    )
-    .reduce((agg, utxo) => agg.add(utxo.asset.amount), new Big(0));
-
-  const totalAmountCreated = tx.amountCreated
-    .filter((asset) => asset.assetId === getAvaxAssetId(!!isTestnet))
-    .reduce((accumulator, asset) => accumulator.add(asset.amount), new Big(0));
-  const nAvaxAmt = isImportExport ? importExportAmount : totalAmountCreated;
-  return getTokenValue({ amount: nAvaxAmt.toNumber(), decimals: networkToken.decimals });
-}
-
-function getBurnedAmount({
-  isTestnet,
-  tx,
-  totalAmountCreated,
-  networkToken,
-}: {
-  isTestnet?: boolean;
-  tx: XChainNonLinearTransaction | XChainLinearTransaction;
-  totalAmountCreated: Big;
-  networkToken: NetworkToken;
-}): Big {
-  const totalAmountUnlocked = tx.amountUnlocked
-    .filter((asset) => asset.assetId === getAvaxAssetId(!!isTestnet))
-    .reduce((accumulator, asset) => accumulator.add(asset.amount), new Big(0));
-  const nAvaxFee = totalAmountUnlocked.minus(totalAmountCreated);
-  return getTokenValue({ amount: nAvaxFee.toNumber(), decimals: networkToken.decimals });
-}
-
-function getAvaxAssetId(isTestnet: boolean): string {
-  return isTestnet ? Avalanche.FujiContext.avaxAssetID : Avalanche.MainnetContext.avaxAssetID;
-}

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

@@ -1,59 +0,0 @@
-import type { GetTransactionHistory, Transaction, TransactionHistoryResponse } from '@avalabs/vm-module-types';
-import { BlockchainId, Network, SortOrder } from '@avalabs/glacier-sdk';
-import { isPChainTransactions, isXChainTransactions } from './utils';
-import { convertPChainTransaction } from './convert-p-chain-transaction';
-import { convertXChainTransaction } from './convert-x-chain-transaction';
-import type { AvalancheGlacierService } from '../../services/glacier-service/glacier-service';
-
-export const getTransactionHistory = async ({
-  address,
-  nextPageToken,
-  offset,
-  network,
-  glacierService,
-}: GetTransactionHistory & { glacierService: AvalancheGlacierService }): Promise<TransactionHistoryResponse> => {
-  const { isTestnet, networkToken, explorerUrl, chainId } = network;
-  const isHealthy = glacierService.isHealthy();
-  if (!isHealthy) {
-    return {
-      transactions: [],
-      nextPageToken: '',
-    };
-  }
-
-  const response = await glacierService.listLatestPrimaryNetworkTransactions({
-    addresses: address,
-    blockchainId: getBlockchainIdByAddress(address),
-    network: isTestnet ? Network.FUJI : Network.MAINNET,
-    pageSize: offset,
-    pageToken: nextPageToken,
-    sortOrder: SortOrder.DESC,
-  });
-
-  let transactions: Transaction[] = [];
-  if (isPChainTransactions(response)) {
-    transactions = response.transactions.map((value) =>
-      convertPChainTransaction({ tx: value, isTestnet, address, networkToken, explorerUrl, chainId }),
-    );
-  }
-  if (isXChainTransactions(response)) {
-    transactions = response.transactions.map((value) =>
-      convertXChainTransaction({ tx: value, isTestnet, address, networkToken, explorerUrl, chainId }),
-    );
-  }
-
-  return {
-    transactions,
-    nextPageToken: response.nextPageToken,
-  };
-};
-
-const getBlockchainIdByAddress = (address: string) => {
-  // A comma separated list of X-Chain or P-Chain wallet addresses,
-  // starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji"
-  const firstAddress = address.split(',')[0];
-  if (firstAddress?.toLowerCase().startsWith('p-')) {
-    return BlockchainId.P_CHAIN;
-  }
-  return BlockchainId.X_CHAIN;
-};

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

@@ -1,31 +0,0 @@
-import {
-  PrimaryNetworkChainName,
-  type ListCChainAtomicTransactionsResponse,
-  type ListPChainTransactionsResponse,
-  type ListXChainTransactionsResponse,
-} from '@avalabs/glacier-sdk';
-import Big from 'big.js';
-
-export const isPChainTransactions = (
-  value: ListPChainTransactionsResponse | ListXChainTransactionsResponse | ListCChainAtomicTransactionsResponse,
-): value is ListPChainTransactionsResponse => {
-  return value.chainInfo.chainName === PrimaryNetworkChainName.P_CHAIN;
-};
-
-export const isXChainTransactions = (
-  value: ListPChainTransactionsResponse | ListXChainTransactionsResponse | ListCChainAtomicTransactionsResponse,
-): value is ListXChainTransactionsResponse => {
-  return value.chainInfo.chainName === PrimaryNetworkChainName.X_CHAIN;
-};
-
-export function getExplorerAddressByNetwork(
-  explorerUrl: string,
-  hash: string,
-  hashType: 'address' | 'tx' = 'tx',
-): string {
-  return `${explorerUrl}/${hashType}/${hash}`;
-}
-
-export function getTokenValue({ amount, decimals }: { decimals: number; amount?: number }): Big {
-  return amount === undefined ? new Big(0) : new Big(amount / 10 ** decimals);
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './module';
-export * from './handlers/get-balances/typeguards';

package/src/module.ts

@@ -1,72 +0,0 @@
-import type {
-  Module,
-  Manifest,
-  NetworkFees,
-  GetTransactionHistory,
-  RpcRequest,
-  Network,
-  GetBalancesParams,
-  GetBalancesResponse,
-  Environment,
-  GetAddressParams,
-  GetAddressResponse,
-} from '@avalabs/vm-module-types';
-import { parseManifest } from '@avalabs/vm-module-types';
-import { rpcErrors } from '@metamask/rpc-errors';
-import ManifestJson from '../manifest.json';
-import { getNetworkFee } from './handlers/get-network-fee/get-network-fee';
-import { getTransactionHistory } from './handlers/get-transaction-history/get-transaction-history';
-import { getEnv } from './env';
-import { AvalancheGlacierService } from './services/glacier-service/glacier-service';
-import { TokenService } from '@internal/utils';
-import { getBalances } from './handlers/get-balances/get-balances';
-import { hashBlockchainId } from './utils/hash-blockchain-id';
-import { getAddress } from './handlers/get-address/get-address';
-
-export class AvalancheModule implements Module {
-  #glacierService: AvalancheGlacierService;
-  #proxyApiUrl: string;
-
-  constructor({ environment }: { environment: Environment }) {
-    const { glacierApiUrl, proxyApiUrl } = getEnv(environment);
-    this.#glacierService = new AvalancheGlacierService({ glacierApiUrl });
-    this.#proxyApiUrl = proxyApiUrl;
-  }
-
-  getAddress({ accountIndex, xpubXP, isTestnet, walletType }: GetAddressParams): Promise<GetAddressResponse> {
-    return getAddress({ accountIndex, xpubXP, isTestnet, walletType });
-  }
-
-  getBalances({ addresses, network, storage, currency }: GetBalancesParams): Promise<GetBalancesResponse> {
-    const tokenService = new TokenService({ storage, proxyApiUrl: this.#proxyApiUrl });
-    return getBalances({ addresses, currency, network, glacierService: this.#glacierService, tokenService });
-  }
-
-  getManifest(): Manifest | undefined {
-    const result = parseManifest(ManifestJson);
-    return result.success ? result.data : undefined;
-  }
-
-  getNetworkFee(_: Network): Promise<NetworkFees> {
-    return getNetworkFee();
-  }
-
-  getTransactionHistory({ network, address, nextPageToken, offset }: GetTransactionHistory) {
-    return getTransactionHistory({ network, address, nextPageToken, offset, glacierService: this.#glacierService });
-  }
-
-  getTokens(_: Network) {
-    return Promise.resolve([]);
-  }
-
-  async onRpcRequest(request: RpcRequest, _network: Network) {
-    switch (request.method) {
-      default:
-        return { error: rpcErrors.methodNotSupported(`Method ${request.method} not supported`) };
-    }
-  }
-
-  static getHashedBlockchainId({ blockchainId, isTestnet }: { blockchainId: string; isTestnet?: boolean }): string {
-    return hashBlockchainId({ blockchainId, isTestnet });
-  }
-}

package/src/services/glacier-service/glacier-service.ts

@@ -1,75 +0,0 @@
-import {
-  BlockchainId,
-  Glacier,
-  type ListCChainAtomicBalancesResponse,
-  type ListCChainAtomicTransactionsResponse,
-  type ListPChainBalancesResponse,
-  type ListPChainTransactionsResponse,
-  type ListXChainBalancesResponse,
-  type ListXChainTransactionsResponse,
-  Network,
-  PrimaryNetworkTxType,
-  SortOrder,
-} from '@avalabs/glacier-sdk';
-
-class GlacierUnhealthyError extends Error {
-  override message = 'Glacier is unhealthy. Try again later.';
-}
-
-export class AvalancheGlacierService {
-  glacierSdk: Glacier;
-  isGlacierHealthy = true;
-
-  constructor({ glacierApiUrl }: { glacierApiUrl: string }) {
-    this.glacierSdk = new Glacier({ BASE: glacierApiUrl });
-  }
-
-  isHealthy = (): boolean => this.isGlacierHealthy;
-
-  setGlacierToUnhealthy(): void {
-    this.isGlacierHealthy = false;
-    setTimeout(
-      () => {
-        this.isGlacierHealthy = true;
-      },
-      5 * 60 * 1000,
-    ); // 5 minutes
-  }
-
-  async listLatestPrimaryNetworkTransactions(params: {
-    blockchainId: BlockchainId;
-    network: Network;
-    addresses?: string;
-    txTypes?: Array<PrimaryNetworkTxType>;
-    startTimestamp?: number;
-    endTimestamp?: number;
-    pageToken?: string;
-    pageSize?: number;
-    sortOrder?: SortOrder;
-  }): Promise<ListPChainTransactionsResponse | ListXChainTransactionsResponse | ListCChainAtomicTransactionsResponse> {
-    try {
-      return this.glacierSdk.primaryNetworkTransactions.listLatestPrimaryNetworkTransactions(params);
-    } catch (error) {
-      if (error instanceof GlacierUnhealthyError) {
-        this.setGlacierToUnhealthy();
-      }
-      throw error;
-    }
-  }
-
-  async getChainBalance(params: {
-    blockchainId: BlockchainId;
-    network: Network;
-    blockTimestamp?: number;
-    addresses?: string;
-  }): Promise<ListPChainBalancesResponse | ListXChainBalancesResponse | ListCChainAtomicBalancesResponse> {
-    try {
-      return this.glacierSdk.primaryNetworkBalances.getBalancesByAddresses(params);
-    } catch (error) {
-      if (error instanceof GlacierUnhealthyError) {
-        this.setGlacierToUnhealthy();
-      }
-      throw error;
-    }
-  }
-}

package/src/utils/hash-blockchain-id.test.ts

@@ -1,43 +0,0 @@
-import { hashBlockchainId } from '../utils/hash-blockchain-id';
-
-describe('hashBlockchainId', () => {
-  it('hashes the c-chain mainnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: '2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5',
-    });
-    expect(result).toBe('avax:8aDU0Kqh-5d23op-B-r-4YbQFRbsgF9a');
-  });
-  it('hashes the c-chain testnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: 'yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp',
-      isTestnet: true,
-    });
-    expect(result).toBe('avax:YRLfeDBJpfEqUWe2FYR1OpXsnDDZeKWd');
-  });
-  it('hashes the p-chain mainnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: '11111111111111111111111111111111LpoYY',
-    });
-    expect(result).toBe('avax:Rr9hnPVPxuUvrdCul-vjEsU1zmqKqRDo');
-  });
-  it('hashes the p-chain testnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: '11111111111111111111111111111111LpoYY',
-      isTestnet: true,
-    });
-    expect(result).toBe('avax:Sj7NVE3jXTbJvwFAiu7OEUo_8g8ctXMG');
-  });
-  it('hashes the x-chain mainnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: '2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM',
-    });
-    expect(result).toBe('avax:imji8papUf2EhV3le337w1vgFauqkJg-');
-  });
-  it('hashes the x-chain testnet blockchain id', () => {
-    const result = hashBlockchainId({
-      blockchainId: '2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm',
-      isTestnet: true,
-    });
-    expect(result).toBe('avax:8AJTpRj3SAqv1e80Mtl9em08LhvKEbkl');
-  });
-});

package/src/utils/hash-blockchain-id.ts

@@ -1,11 +0,0 @@
-import Crypto from 'crypto';
-
-//github.com/gergelylovas/chain-agnostic-namespaces/pull/1/files#diff-cf7185539a48e85d069d194c1c17d7cfa0317b3caa3a89c92e797e3717e49d59R40
-export function hashBlockchainId({ blockchainId, isTestnet }: { blockchainId: string; isTestnet?: boolean }): string {
-  const blockChainIdWithPrefix = isTestnet ? 'fuji' + blockchainId : blockchainId;
-  const base64 = Crypto.createHash('sha256').update(blockChainIdWithPrefix).digest('base64');
-  const hash = convertBase64ToBase64Url(base64).substring(0, 32);
-  return 'avax:' + hash;
-}
-
-const convertBase64ToBase64Url = (base64: string) => base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');

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);