@avalabs/vm-module-types 0.0.0-testRetry-20240726170629 → 0.0.0-testSkipCI-20240620194941

package/.turbo/turbo-lint.log

@@ -1,4 +1,4 @@
 
-> @avalabs/vm-module-types@0.0.20 lint /home/runner/work/vm-modules/vm-modules/packages/types
+> @avalabs/vm-module-types@0.0.3 lint /home/runner/work/vm-modules/vm-modules/packages/types
 > eslint "src/**/*.ts"
 

package/CHANGELOG.md

@@ -1,91 +1,10 @@
 # @avalabs/vm-module-types
 
-## 0.0.0-testRetry-20240726170629
-
-## 0.0.20
-
-### Patch Changes
-
-- 9bfa82d: Implement balance fetching for BitcoinModule
-
-## 0.0.19
-
-### Patch Changes
-
-- 5af458b: Add getBalances to avalanche-module
-
-## 0.0.18
-
-## 0.0.17
-
-### Patch Changes
-
-- 3590edf: Transaction parsing, validation and simulation for EVM
-
-## 0.0.16
-
-### Patch Changes
-
-- bc48457: add support for all eth_sign methods
-
-## 0.0.15
-
-### Patch Changes
-
-- f536d58: add module functions to evm-module
-
-## 0.0.14
-
-### Patch Changes
-
-- 0593258: add getBalances to evm-module
-
-## 0.0.13
-
-### Patch Changes
-
-- af68c81: Add getTransactionHistory to avalanche module
-- d9fa0f5: added getNetworkFee to avalanche module
-
-## 0.0.12
-
-### Patch Changes
-
-- cd97708: fix: build types package
-- d0c2cc9: make module interface more consistent
-- 7bc6c6e: add eth_sendTransaction handler
-
-## 0.0.11
-
-## 0.0.10
-
-### Patch Changes
-
-- 60f36fa: add getTokens function
-
-## 0.0.9
-
-### Patch Changes
-
-- 6ffa356: add module functions to evm-module
-
-## 0.0.8
-
-### Patch Changes
-
-- d1d080f: test release
-
-## 0.0.7
-
-### Patch Changes
-
-- bb98621: Move types to @avalabs/vm-module-types
-
-## 0.0.6
+## 0.0.0-testSkipCI-20240620194941
 
 ### Patch Changes
 
-- 1122704: test release
+- fc6fd4e: test release
 
 ## 0.0.3
 

package/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This package exposes the types for the VM modules
+This package exposes the types for the VM modules.
 
 ## Installation
 

package/package.json

@@ -1,30 +1,14 @@
 {
   "name": "@avalabs/vm-module-types",
-  "version": "0.0.0-testRetry-20240726170629",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "type": "module",
+  "version": "0.0.0-testSkipCI-20240620194941",
+  "main": "src/index.ts",
   "dependencies": {
-    "zod": "3.23.8",
-    "@metamask/rpc-errors": "6.3.0",
-    "ethers": "6.8.1"
+    "zod": "3.23.8"
   },
   "devDependencies": {
-    "tsup": "7.2.0",
-    "bn.js": "5.2.1",
-    "@types/bn.js": "5.1.5",
-    "@avalabs/coingecko-sdk": "v2.8.0-alpha.193",
-    "@avalabs/glacier-sdk": "v2.8.0-alpha.193",
-    "@avalabs/utils-sdk": "2.8.0-alpha.193",
-    "@internal/tsup-config": "0.0.1",
     "eslint-config-custom": "0.0.1"
   },
-  "peerDependencies": {
-    "ethers": "^6.8.1"
-  },
   "scripts": {
-    "build": "tsup",
     "lint": "eslint \"src/**/*.ts\""
   }
 }

package/src/index.ts

@@ -1,10 +1 @@
-export * from './common';
-export * from './coingecko';
-export * from './balance';
-export * from './manifest';
-export * from './module';
-export * from './network-fee';
-export * from './rpc';
-export * from './token';
-export * from './transaction-history';
-export * from './transaction-simulation';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,155 @@
+import { object, string, boolean, z } from 'zod';
+
+export enum TransactionType {
+  BRIDGE = 'Bridge',
+  SWAP = 'Swap',
+  SEND = 'Send',
+  RECEIVE = 'Receive',
+  NFT_BUY = 'NFTBuy',
+  APPROVE = 'Approve',
+  TRANSFER = 'Transfer',
+  NFT_SEND = 'NFTSend',
+  NFT_RECEIVE = 'NFTReceive',
+  AIRDROP = 'Airdrop',
+  FILL_ORDER = 'FillOrder',
+  UNWRAP = 'Unwrap',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum TokenType {
+  NATIVE = 'NATIVE',
+  ERC20 = 'ERC20',
+  ERC721 = 'ERC721',
+  ERC1155 = 'ERC1155',
+}
+
+export type NetworkFees = {
+  low: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
+  medium: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
+  high: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
+  baseFee: bigint;
+};
+
+export interface Module {
+  getManifest: () => Manifest | undefined;
+  getBalances: () => Promise<string>;
+  getTransactionHistory: (params: GetTransactionHistory) => Promise<TransactionHistoryResponse>;
+  getNetworkFee: () => Promise<NetworkFees>;
+  getAddress: () => Promise<string>;
+}
+
+export type GetTransactionHistory = {
+  chainId: number;
+  isTestnet: boolean;
+  networkToken: NetworkToken;
+  explorerUrl: string;
+  address: string;
+  nextPageToken?: string;
+  offset?: number;
+  glacierApiUrl?: string;
+};
+
+export type TransactionHistoryResponse = {
+  transactions: Transaction[];
+  nextPageToken?: string;
+};
+
+export type Transaction = {
+  isContractCall: boolean;
+  isIncoming: boolean;
+  isOutgoing: boolean;
+  isSender: boolean;
+  timestamp: number;
+  hash: string;
+  from: string;
+  to: string;
+  tokens: TxToken[];
+  gasPrice?: string;
+  gasUsed: string;
+  txType?: TransactionType;
+  chainId: string; // chainId from ActiveNetwork used to fetch tx
+  method?: string;
+  explorerLink: string;
+};
+
+export interface TxToken {
+  decimal?: string;
+  name: string;
+  symbol: string;
+  amount: string;
+  imageUri?: string;
+  from?: RichAddress;
+  to?: RichAddress;
+  collectableTokenId?: string;
+  type: TokenType;
+}
+
+type RichAddress = {
+  /**
+   * The contract name.
+   */
+  name?: string;
+  /**
+   * The contract symbol.
+   */
+  symbol?: string;
+  /**
+   * The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
+   */
+  decimals?: number;
+  /**
+   * The logo uri for the address.
+   */
+  logoUri?: string;
+  /**
+   * A wallet or contract address in mixed-case checksum encoding.
+   */
+  address: string;
+};
+
+export interface NetworkToken {
+  name: string;
+  symbol: string;
+  description: string;
+  decimals: number;
+  logoUri: string;
+}
+
+const sourceSchema = object({
+  checksum: string(),
+  location: object({
+    npm: object({
+      filePath: string(),
+      packageName: string(),
+      registry: string(),
+    }),
+  }),
+});
+
+const manifestSchema = object({
+  name: string(),
+  version: string(),
+  description: string(),
+  sources: object({
+    module: sourceSchema,
+    provider: sourceSchema.optional(),
+  }),
+  network: object({
+    chainIds: string().array(),
+    namespaces: string().array(),
+  }),
+  cointype: string(),
+  permissions: object({
+    rpc: object({
+      dapps: boolean(),
+      methods: string().array(),
+    }),
+  }),
+  manifestVersion: string(),
+});
+
+export type Manifest = z.infer<typeof manifestSchema>;
+
+export const parseManifest = (params: unknown): z.SafeParseReturnType<unknown, Manifest> => {
+  return manifestSchema.safeParse(params);
+};

package/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "@internal/tsconfig/tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
-    "tsBuildInfoFile": ".tsbuildinfo"
+    "composite": true
   },
   "include": ["src"]
 }

package/.turbo/turbo-build.log

@@ -1,130 +0,0 @@
-
-> @avalabs/vm-module-types@0.0.20 build /home/runner/work/vm-modules/vm-modules/packages/types
-> tsup
-
-CLI Building entry: src/balance.ts, src/coingecko.ts, src/common.ts, src/index.ts, src/manifest.ts, src/module.ts, src/network-fee.ts, src/rpc.ts, src/token.ts, src/transaction-history.ts, src/transaction-simulation.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
-CLI Using tsup config: /home/runner/work/vm-modules/vm-modules/packages/types/tsup.config.ts
-CLI Target: es2021
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-Generated an empty chunk: "chunk-47KTBBRA".
-Generated an empty chunk: "chunk-JUV577XH".
-Generated an empty chunk: "chunk-OGQBQHLH".
-Generated an empty chunk: "chunk-AILYKQEY".
-Generated an empty chunk: "chunk-P6AM7I3B".
-Generated an empty chunk: "chunk-BHB5UV3J".
-Generated an empty chunk: "chunk-CUVJNZP5".
-Generated an empty chunk: "chunk-7U2R34EQ".
-CJS dist/chunk-2KGTZTXY.cjs             219.00 B
-CJS dist/chunk-BFBDZPL3.cjs             1.21 KB
-CJS dist/chunk-47KTBBRA.cjs             90.00 B
-CJS dist/chunk-JUV577XH.cjs             90.00 B
-CJS dist/chunk-VRQJHO4F.cjs             276.00 B
-CJS dist/chunk-OGQBQHLH.cjs             90.00 B
-CJS dist/chunk-AILYKQEY.cjs             90.00 B
-CJS dist/chunk-YVYCETG2.cjs             483.00 B
-CJS dist/token.cjs                      260.00 B
-CJS dist/transaction-history.cjs        542.00 B
-CJS dist/transaction-simulation.cjs     132.00 B
-CJS dist/balance.cjs                    117.00 B
-CJS dist/coingecko.cjs                  418.00 B
-CJS dist/common.cjs                     386.00 B
-CJS dist/index.cjs                      1.90 KB
-CJS dist/chunk-4PGCXP4C.cjs             433.00 B
-CJS dist/manifest.cjs                   267.00 B
-CJS dist/chunk-74SNNWSF.cjs             667.00 B
-CJS dist/module.cjs                     116.00 B
-CJS dist/network-fee.cjs                121.00 B
-CJS dist/rpc.cjs                        377.00 B
-CJS dist/chunk-2KGTZTXY.cjs.map         1.18 KB
-CJS dist/chunk-BFBDZPL3.cjs.map         3.69 KB
-CJS dist/chunk-47KTBBRA.cjs.map         51.00 B
-CJS dist/chunk-JUV577XH.cjs.map         51.00 B
-CJS dist/chunk-VRQJHO4F.cjs.map         1.08 KB
-CJS dist/chunk-OGQBQHLH.cjs.map         51.00 B
-CJS dist/chunk-AILYKQEY.cjs.map         51.00 B
-CJS dist/chunk-YVYCETG2.cjs.map         4.03 KB
-CJS dist/token.cjs.map                  51.00 B
-CJS dist/transaction-history.cjs.map    51.00 B
-CJS dist/transaction-simulation.cjs.map 51.00 B
-CJS dist/balance.cjs.map                51.00 B
-CJS dist/coingecko.cjs.map              51.00 B
-CJS dist/common.cjs.map                 51.00 B
-CJS dist/index.cjs.map                  51.00 B
-CJS dist/chunk-4PGCXP4C.cjs.map         1.24 KB
-CJS dist/manifest.cjs.map               51.00 B
-CJS dist/chunk-74SNNWSF.cjs.map         1.65 KB
-CJS dist/module.cjs.map                 51.00 B
-CJS dist/network-fee.cjs.map            51.00 B
-CJS dist/rpc.cjs.map                    51.00 B
-CJS ⚡️ Build success in 1247ms
-ESM dist/chunk-7Y6UGMPZ.js             207.00 B
-ESM dist/chunk-H6ZZE5M7.js             1.18 KB
-ESM dist/chunk-P6AM7I3B.js             75.00 B
-ESM dist/chunk-BHB5UV3J.js             75.00 B
-ESM dist/chunk-4BNYMHOY.js             257.00 B
-ESM dist/chunk-CUVJNZP5.js             75.00 B
-ESM dist/chunk-7U2R34EQ.js             75.00 B
-ESM dist/chunk-RKFOXZ35.js             464.00 B
-ESM dist/token.js                      119.00 B
-ESM dist/transaction-history.js        195.00 B
-ESM dist/transaction-simulation.js     112.00 B
-ESM dist/balance.js                    97.00 B
-ESM dist/coingecko.js                  174.00 B
-ESM dist/common.js                     142.00 B
-ESM dist/index.js                      664.00 B
-ESM dist/chunk-WOO6UGSQ.js             394.00 B
-ESM dist/manifest.js                   126.00 B
-ESM dist/chunk-A4YEBDMG.js             592.00 B
-ESM dist/module.js                     96.00 B
-ESM dist/network-fee.js                101.00 B
-ESM dist/rpc.js                        133.00 B
-ESM dist/chunk-7Y6UGMPZ.js.map         1.18 KB
-ESM dist/chunk-H6ZZE5M7.js.map         3.69 KB
-ESM dist/chunk-P6AM7I3B.js.map         51.00 B
-ESM dist/chunk-BHB5UV3J.js.map         51.00 B
-ESM dist/chunk-4BNYMHOY.js.map         1.08 KB
-ESM dist/chunk-CUVJNZP5.js.map         51.00 B
-ESM dist/chunk-7U2R34EQ.js.map         51.00 B
-ESM dist/chunk-RKFOXZ35.js.map         4.03 KB
-ESM dist/token.js.map                  51.00 B
-ESM dist/transaction-history.js.map    51.00 B
-ESM dist/transaction-simulation.js.map 51.00 B
-ESM dist/balance.js.map                51.00 B
-ESM dist/coingecko.js.map              51.00 B
-ESM dist/common.js.map                 51.00 B
-ESM dist/index.js.map                  51.00 B
-ESM dist/chunk-WOO6UGSQ.js.map         1.24 KB
-ESM dist/manifest.js.map               51.00 B
-ESM dist/chunk-A4YEBDMG.js.map         1.65 KB
-ESM dist/module.js.map                 51.00 B
-ESM dist/network-fee.js.map            51.00 B
-ESM dist/rpc.js.map                    51.00 B
-ESM ⚡️ Build success in 1265ms
-DTS Build start
-DTS ⚡️ Build success in 10171ms
-DTS dist/index.d.cts                  1.43 KB
-DTS dist/coingecko.d.cts              1.09 KB
-DTS dist/module.d.cts                 1.04 KB
-DTS dist/balance.d.cts                3.81 KB
-DTS dist/manifest.d.cts               6.95 KB
-DTS dist/network-fee.d.cts            361.00 B
-DTS dist/rpc.d.cts                    3.65 KB
-DTS dist/transaction-history.d.cts    2.88 KB
-DTS dist/common.d.cts                 902.00 B
-DTS dist/transaction-simulation.d.cts 642.00 B
-DTS dist/token.d.cts                  1.05 KB
-DTS dist/index.d.ts                   1.42 KB
-DTS dist/coingecko.d.ts               1.09 KB
-DTS dist/module.d.ts                  1.04 KB
-DTS dist/balance.d.ts                 3.80 KB
-DTS dist/manifest.d.ts                6.95 KB
-DTS dist/network-fee.d.ts             361.00 B
-DTS dist/rpc.d.ts                     3.65 KB
-DTS dist/transaction-history.d.ts     2.88 KB
-DTS dist/common.d.ts                  901.00 B
-DTS dist/transaction-simulation.d.ts  641.00 B
-DTS dist/token.d.ts                   1.05 KB

package/dist/balance.cjs

@@ -1,6 +0,0 @@
-'use strict';
-
-require('./chunk-JUV577XH.cjs');
-
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=balance.cjs.map

package/dist/balance.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/balance.d.cts

@@ -1,124 +0,0 @@
-import { Network, Storage } from './common.cjs';
-import { NetworkContractToken, TokenType, NetworkToken } from './token.cjs';
-import BN from 'bn.js';
-import { PChainBalance, XChainBalances } from '@avalabs/glacier-sdk';
-
-type GetBalancesParams = {
-    addresses: string[];
-    network: Network;
-    customTokens?: NetworkContractToken[];
-    currency: string;
-    storage?: Storage;
-};
-type TokenBalanceData = {
-    type: TokenType;
-    name: string;
-    symbol: string;
-    balance: BN;
-    balanceDisplayValue: string;
-    balanceInCurrency?: number;
-    balanceCurrencyDisplayValue?: string;
-};
-type TokenMarketData = {
-    priceInCurrency?: number;
-    priceChanges?: {
-        percentage?: number;
-        value?: number;
-    };
-    marketCap?: number;
-    change24?: number;
-    vol24?: number;
-};
-type NetworkTokenWithBalance = TokenBalanceDataWithDecimals & NetworkToken & TokenMarketData & {
-    coingeckoId: string;
-    type: TokenType.NATIVE;
-};
-interface TokenBalanceDataWithDecimals extends TokenBalanceData {
-    decimals: number;
-}
-/**
- * EVM TokenWithBalance interface.
- */
-type TokenWithBalanceERC20 = TokenBalanceDataWithDecimals & TokenMarketData & NetworkContractToken & {
-    type: TokenType.ERC20;
-};
-type TokenWithBalanceEVM = NetworkTokenWithBalance | TokenWithBalanceERC20;
-/**
- * Bitcoin TokenWithBalance interface.
- */
-interface BitcoinInputUTXO {
-    txHash: string;
-    txHex?: string;
-    index: number;
-    value: number;
-    script: string;
-    blockHeight: number;
-    confirmations: number;
-    confirmedTime?: string;
-}
-interface BitcoinInputUTXOWithOptionalScript extends Omit<BitcoinInputUTXO, 'script'> {
-    script?: string;
-}
-interface TokenWithBalanceBTC extends NetworkTokenWithBalance {
-    logoUri: string;
-    utxos: BitcoinInputUTXOWithOptionalScript[];
-    utxosUnconfirmed?: BitcoinInputUTXOWithOptionalScript[];
-    unconfirmedBalance?: BN;
-    unconfirmedBalanceDisplayValue?: string;
-    unconfirmedBalanceCurrencyDisplayValue?: string;
-    unconfirmedBalanceInCurrency?: number;
-}
-/**
- * Avalanche TokenWithBalance interface.
- */
-interface TokenWithBalancePVM extends NetworkTokenWithBalance {
-    available?: BN;
-    availableInCurrency?: number;
-    availableDisplayValue?: string;
-    availableCurrencyDisplayValue?: string;
-    utxos?: PChainBalance;
-    balancePerType: {
-        lockedStaked: number;
-        lockedStakeable: number;
-        lockedPlatform: number;
-        atomicMemoryLocked: number;
-        atomicMemoryUnlocked: number;
-        unlockedUnstaked: number;
-        unlockedStaked: number;
-        pendingStaked: number;
-    };
-}
-interface TokenWithBalanceAVM extends NetworkTokenWithBalance {
-    available?: BN;
-    availableInCurrency?: number;
-    availableDisplayValue?: string;
-    availableCurrencyDisplayValue?: string;
-    utxos?: XChainBalances;
-    balancePerType: {
-        locked: number;
-        unlocked: number;
-        atomicMemoryUnlocked: number;
-        atomicMemoryLocked: number;
-    };
-}
-interface NftTokenWithBalance extends Omit<NetworkTokenWithBalance, 'type'> {
-    type: TokenType.ERC721 | TokenType.ERC1155;
-    address: string;
-    description: string;
-    logoUri: string;
-    logoSmall: string;
-    name: string;
-    symbol: string;
-    tokenId: string;
-    attributes: TokenAttribute[];
-    collectionName: string;
-    updatedAt?: number;
-}
-interface TokenAttribute {
-    name: string;
-    value: string;
-}
-type TokenWithBalance = TokenWithBalanceEVM | TokenWithBalanceBTC | TokenWithBalancePVM | TokenWithBalanceAVM | NftTokenWithBalance;
-type GetBalancesResponse = Record<string, Record<string, TokenWithBalance>>;
-
-export { GetBalancesParams, GetBalancesResponse, NetworkTokenWithBalance, NftTokenWithBalance, TokenAttribute, TokenBalanceData, TokenMarketData, TokenWithBalance, TokenWithBalanceAVM, TokenWithBalanceBTC, TokenWithBalanceERC20, TokenWithBalanceEVM, TokenWithBalancePVM };