@avalabs/vm-module-types 0.0.0-CP-8800-20240626134307

package/.turbo/turbo-lint.log

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

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# @avalabs/vm-module-types
+
+## 0.0.0-CP-8800-20240626134307
+
+### Patch Changes
+
+- 985ab0d: 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
+
+### Patch Changes
+
+- 1122704: test release
+
+## 0.0.3
+
+### Patch Changes
+
+- 0b0c52e: Move types to @avalabs/vm-module-types
+
+## 0.0.2
+
+### Patch Changes
+
+- 4b7d5e9: Move types from packages-internal/types to packages/types

package/README.md

@@ -0,0 +1,9 @@
+# VM Module Types
+
+## Overview
+
+This package exposes the types for the VM modules
+
+## Installation
+
+The module is privately available on NPM as `@avalabs/vm-module-types`

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@avalabs/vm-module-types",
+  "version": "0.0.0-CP-8800-20240626134307",
+  "main": "src/index.ts",
+  "dependencies": {
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "eslint-config-custom": "0.0.1"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\""
+  }
+}

package/src/index.ts

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

package/src/types.ts

@@ -0,0 +1,205 @@
+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 enum RpcMethod {
+  /* EVM */
+  ETH_SEND_TRANSACTION = 'eth_sendTransaction',
+  SIGN_TYPED_DATA_V3 = 'eth_signTypedData_v3',
+  SIGN_TYPED_DATA_V4 = 'eth_signTypedData_v4',
+  SIGN_TYPED_DATA_V1 = 'eth_signTypedData_v1',
+  SIGN_TYPED_DATA = 'eth_signTypedData',
+  PERSONAL_SIGN = 'personal_sign',
+  ETH_SIGN = 'eth_sign',
+  WALLET_ADD_ETHEREUM_CHAIN = 'wallet_addEthereumChain',
+  WALLET_SWITCH_ETHEREUM_CHAIN = 'wallet_switchEthereumChain',
+  WALLET_GET_ETHEREUM_CHAIN = 'wallet_getEthereumChain',
+}
+
+export type RpcRequest = {
+  method: RpcMethod;
+  params: unknown;
+};
+
+export type RpcResponse<R = unknown, E extends Error = Error> =
+  | {
+      result: R;
+    }
+  | {
+      error: E;
+    };
+
+export type Chain = {
+  isTestnet?: boolean;
+  chainId?: string;
+  chainName?: string;
+  rpcUrl?: string;
+  multiContractAddress?: string;
+};
+
+export type GetNetworkFeeParams = Chain;
+
+export interface Module {
+  getManifest: () => Manifest | undefined;
+  getBalances: () => Promise<string>;
+  getTransactionHistory: (params: GetTransactionHistory) => Promise<TransactionHistoryResponse>;
+  getNetworkFee: (params: GetNetworkFeeParams) => Promise<NetworkFees>;
+  getAddress: () => Promise<string>;
+  getTokens: (chainId: number) => Promise<NetworkContractToken[]>;
+  onRpcRequest: (request: RpcRequest) => Promise<RpcResponse>;
+}
+
+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;
+}
+
+export interface NetworkContractToken {
+  address: string;
+  chainId?: number;
+  color?: string;
+  contractType: string;
+  decimals: number;
+  logoUri?: string;
+  name: string;
+  symbol: 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

@@ -0,0 +1,8 @@
+{
+  "extends": "@internal/tsconfig/tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "composite": true
+  },
+  "include": ["src"]
+}