@avalabs/vm-module-types 0.0.13 → 0.0.15

package/dist/token.js

@@ -0,0 +1,3 @@
+export { a as TokenType } from './chunk-TSO5BGJ4.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=token.js.map

package/dist/token.js.map

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

package/dist/transaction-history.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+var chunkBFBDZPL3_cjs = require('./chunk-BFBDZPL3.cjs');
+
+
+
+Object.defineProperty(exports, 'PChainTransactionType', {
+	enumerable: true,
+	get: function () { return chunkBFBDZPL3_cjs.b; }
+});
+Object.defineProperty(exports, 'TransactionType', {
+	enumerable: true,
+	get: function () { return chunkBFBDZPL3_cjs.a; }
+});
+Object.defineProperty(exports, 'XChainTransactionType', {
+	enumerable: true,
+	get: function () { return chunkBFBDZPL3_cjs.c; }
+});
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=transaction-history.cjs.map

package/dist/transaction-history.cjs.map

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

package/dist/transaction-history.d.cts

@@ -0,0 +1,106 @@
+import { Network } from './common.cjs';
+import { TokenType } from './token.cjs';
+
+type GetTransactionHistory = {
+    network: Network;
+    address: string;
+    nextPageToken?: string;
+    offset?: number;
+};
+type TransactionHistoryResponse = {
+    transactions: Transaction[];
+    nextPageToken?: string;
+};
+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 | PChainTransactionType | XChainTransactionType;
+    chainId: string;
+    method?: string;
+    explorerLink: string;
+};
+interface TxToken {
+    decimal?: string;
+    name: string;
+    symbol: string;
+    amount: string;
+    imageUri?: string;
+    from?: TokenWithAddress;
+    to?: TokenWithAddress;
+    collectableTokenId?: string;
+    type: TokenType;
+}
+type TokenWithAddress = {
+    /**
+     * 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;
+};
+declare 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"
+}
+declare enum PChainTransactionType {
+    ADD_VALIDATOR_TX = "AddValidatorTx",
+    ADD_SUBNET_VALIDATOR_TX = "AddSubnetValidatorTx",
+    ADD_DELEGATOR_TX = "AddDelegatorTx",
+    CREATE_CHAIN_TX = "CreateChainTx",
+    CREATE_SUBNET_TX = "CreateSubnetTx",
+    IMPORT_TX = "ImportTx",
+    EXPORT_TX = "ExportTx",
+    ADVANCE_TIME_TX = "AdvanceTimeTx",
+    REWARD_VALIDATOR_TX = "RewardValidatorTx",
+    REMOVE_SUBNET_VALIDATOR_TX = "RemoveSubnetValidatorTx",
+    TRANSFORM_SUBNET_TX = "TransformSubnetTx",
+    ADD_PERMISSIONLESS_VALIDATOR_TX = "AddPermissionlessValidatorTx",
+    ADD_PERMISSIONLESS_DELEGATOR_TX = "AddPermissionlessDelegatorTx",
+    BASE_TX = "BaseTx",
+    TRANSFER_SUBNET_OWNERSHIP_TX = "TransferSubnetOwnershipTx",
+    UNKNOWN = "UNKNOWN"
+}
+declare enum XChainTransactionType {
+    BASE_TX = "BaseTx",
+    CREATE_ASSET_TX = "CreateAssetTx",
+    OPERATION_TX = "OperationTx",
+    IMPORT_TX = "ImportTx",
+    EXPORT_TX = "ExportTx",
+    UNKNOWN = "UNKNOWN"
+}
+
+export { GetTransactionHistory, PChainTransactionType, Transaction, TransactionHistoryResponse, TransactionType, TxToken, XChainTransactionType };

package/dist/transaction-history.d.ts

@@ -0,0 +1,106 @@
+import { Network } from './common.js';
+import { TokenType } from './token.js';
+
+type GetTransactionHistory = {
+    network: Network;
+    address: string;
+    nextPageToken?: string;
+    offset?: number;
+};
+type TransactionHistoryResponse = {
+    transactions: Transaction[];
+    nextPageToken?: string;
+};
+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 | PChainTransactionType | XChainTransactionType;
+    chainId: string;
+    method?: string;
+    explorerLink: string;
+};
+interface TxToken {
+    decimal?: string;
+    name: string;
+    symbol: string;
+    amount: string;
+    imageUri?: string;
+    from?: TokenWithAddress;
+    to?: TokenWithAddress;
+    collectableTokenId?: string;
+    type: TokenType;
+}
+type TokenWithAddress = {
+    /**
+     * 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;
+};
+declare 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"
+}
+declare enum PChainTransactionType {
+    ADD_VALIDATOR_TX = "AddValidatorTx",
+    ADD_SUBNET_VALIDATOR_TX = "AddSubnetValidatorTx",
+    ADD_DELEGATOR_TX = "AddDelegatorTx",
+    CREATE_CHAIN_TX = "CreateChainTx",
+    CREATE_SUBNET_TX = "CreateSubnetTx",
+    IMPORT_TX = "ImportTx",
+    EXPORT_TX = "ExportTx",
+    ADVANCE_TIME_TX = "AdvanceTimeTx",
+    REWARD_VALIDATOR_TX = "RewardValidatorTx",
+    REMOVE_SUBNET_VALIDATOR_TX = "RemoveSubnetValidatorTx",
+    TRANSFORM_SUBNET_TX = "TransformSubnetTx",
+    ADD_PERMISSIONLESS_VALIDATOR_TX = "AddPermissionlessValidatorTx",
+    ADD_PERMISSIONLESS_DELEGATOR_TX = "AddPermissionlessDelegatorTx",
+    BASE_TX = "BaseTx",
+    TRANSFER_SUBNET_OWNERSHIP_TX = "TransferSubnetOwnershipTx",
+    UNKNOWN = "UNKNOWN"
+}
+declare enum XChainTransactionType {
+    BASE_TX = "BaseTx",
+    CREATE_ASSET_TX = "CreateAssetTx",
+    OPERATION_TX = "OperationTx",
+    IMPORT_TX = "ImportTx",
+    EXPORT_TX = "ExportTx",
+    UNKNOWN = "UNKNOWN"
+}
+
+export { GetTransactionHistory, PChainTransactionType, Transaction, TransactionHistoryResponse, TransactionType, TxToken, XChainTransactionType };

package/dist/transaction-history.js

@@ -0,0 +1,3 @@
+export { b as PChainTransactionType, a as TransactionType, c as XChainTransactionType } from './chunk-H6ZZE5M7.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=transaction-history.js.map

package/dist/transaction-history.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avalabs/vm-module-types",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -12,8 +12,13 @@
   },
   "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.2"
+    "eslint-config-custom": "0.0.3"
   },
   "peerDependencies": {
     "ethers": "^6.8.1"

package/src/balance.ts

@@ -0,0 +1,118 @@
+import type { Storage, Network } from './common';
+import type { NetworkContractToken, NetworkToken, TokenType } from './token';
+import type BN from 'bn.js';
+import type { PChainBalance, XChainBalances } from '@avalabs/glacier-sdk';
+
+export type GetBalancesParams = {
+  addresses: string[];
+  network: Network;
+  customTokens?: NetworkContractToken[];
+  currency: string;
+  storage?: Storage;
+};
+
+export type TokenBalanceData = {
+  type: TokenType;
+  name: string;
+  symbol: string;
+  balance: BN;
+  balanceInCurrency: number;
+  balanceDisplayValue: string;
+  balanceCurrencyDisplayValue: string;
+  priceInCurrency: number;
+  priceChanges?: {
+    percentage?: number;
+    value?: number;
+  };
+};
+
+type TokenMarketData = {
+  marketCap: number;
+  change24: number;
+  vol24: number;
+};
+
+export type NetworkTokenWithBalance = TokenBalanceDataWithDecimals &
+  NetworkToken &
+  TokenMarketData & {
+    coingeckoId: string;
+    type: TokenType.NATIVE;
+  };
+
+interface TokenBalanceDataWithDecimals extends TokenBalanceData {
+  decimals: number;
+}
+
+/**
+ * EVM TokenWithBalance interface.
+ */
+export type TokenWithBalanceERC20 = TokenBalanceDataWithDecimals &
+  TokenMarketData &
+  NetworkContractToken & {
+    type: TokenType.ERC20;
+  };
+
+export 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;
+}
+
+export interface TokenWithBalanceBTC extends NetworkTokenWithBalance {
+  logoUri: string;
+  utxos: BitcoinInputUTXOWithOptionalScript[];
+  utxosUnconfirmed?: BitcoinInputUTXOWithOptionalScript[];
+  unconfirmedBalance?: BN;
+  unconfirmedBalanceDisplayValue?: string;
+  unconfirmedBalanceCurrencyDisplayValue?: string;
+  unconfirmedBalanceInCurrency?: number;
+}
+
+/**
+ * Avalanche TokenWithBalance interface.
+ */
+export interface TokenWithBalancePVM extends NetworkTokenWithBalance {
+  available?: BN;
+  availableInCurrency?: number;
+  availableDisplayValue?: string;
+  availableCurrencyDisplayValue?: string;
+  utxos?: PChainBalance;
+  lockedStaked: number;
+  lockedStakeable: number;
+  lockedPlatform: number;
+  atomicMemoryLocked: number;
+  atomicMemoryUnlocked: number;
+  unlockedUnstaked: number;
+  unlockedStaked: number;
+  pendingStaked: number;
+}
+
+export interface TokenWithBalanceAVM extends NetworkTokenWithBalance {
+  available?: BN;
+  availableInCurrency?: number;
+  availableDisplayValue?: string;
+  availableCurrencyDisplayValue?: string;
+  utxos?: XChainBalances;
+  locked: number;
+  unlocked: number;
+  atomicMemoryUnlocked: number;
+  atomicMemoryLocked: number;
+}
+
+export type TokenWithBalance = TokenWithBalanceEVM | TokenWithBalanceBTC | TokenWithBalancePVM | TokenWithBalanceAVM;
+
+export type GetBalancesResponse = Record<string, Record<string, TokenWithBalance>>;

package/src/coingecko.ts

@@ -0,0 +1,15 @@
+import { number, object, record, z } from 'zod';
+
+const SimplePriceInCurrency = object({
+  price: number().optional().nullable(),
+  change24: number().optional().nullable(),
+  marketCap: number().optional().nullable(),
+  vol24: number().optional().nullable(),
+});
+
+const SimplePriceInCurrencyResponseSchema = record(SimplePriceInCurrency);
+export const SimplePriceResponseSchema = record(SimplePriceInCurrencyResponseSchema);
+export type SimplePriceResponse = z.infer<typeof SimplePriceResponseSchema>;
+
+export const RawSimplePriceResponseSchema = record(record(number().nullable().optional()));
+export type RawSimplePriceResponse = z.infer<typeof RawSimplePriceResponseSchema>;

package/src/common.ts

@@ -0,0 +1,34 @@
+import type { NetworkToken } from './token';
+
+export type Network = {
+  isTestnet?: boolean;
+  chainId: number;
+  chainName: string;
+  rpcUrl: string;
+  utilityAddresses?: {
+    multicall: string;
+  };
+  networkToken: NetworkToken;
+  pricingProviders?: {
+    coingecko: {
+      assetPlatformId?: string;
+      nativeTokenId?: string;
+    };
+  };
+  explorerUrl?: string;
+  logoUri?: string;
+};
+
+export type Storage = {
+  get: <T>(id: string) => T | undefined;
+  set: <T>(id: string, data: T) => void;
+};
+
+export type Caip2ChainId = string;
+
+export type Hex = `0x${string}`;
+
+export enum Environment {
+  PRODUCTION = 'production',
+  DEV = 'dev',
+}

package/src/index.ts

@@ -1 +1,9 @@
-export * from './types';
+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';

package/src/manifest.ts

@@ -0,0 +1,40 @@
+import { boolean, object, string, z } from 'zod';
+
+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/src/module.ts

@@ -0,0 +1,17 @@
+import type { GetBalancesParams, GetBalancesResponse } from './balance';
+import type { Network } from './common';
+import type { Manifest } from './manifest';
+import type { NetworkFees } from './network-fee';
+import type { RpcRequest, RpcResponse } from './rpc';
+import type { NetworkContractToken } from './token';
+import type { GetTransactionHistory, TransactionHistoryResponse } from './transaction-history';
+
+export interface Module {
+  getManifest: () => Manifest | undefined;
+  getBalances: (params: GetBalancesParams) => Promise<GetBalancesResponse>;
+  getTransactionHistory: (params: GetTransactionHistory) => Promise<TransactionHistoryResponse>;
+  getNetworkFee: (network: Network) => Promise<NetworkFees>;
+  getAddress: () => Promise<string>;
+  getTokens: (network: Network) => Promise<NetworkContractToken[]>;
+  onRpcRequest: (request: RpcRequest, chain: Network) => Promise<RpcResponse>;
+}

package/src/network-fee.ts

@@ -0,0 +1,7 @@
+export type NetworkFees = {
+  low: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
+  medium: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
+  high: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
+  baseFee: bigint;
+  isFixedFee: boolean;
+};

package/src/rpc.ts

@@ -0,0 +1,117 @@
+import type { TransactionRequest } from 'ethers';
+import type { Caip2ChainId, Hex } from './common';
+import type { JsonRpcError, EthereumProviderError, OptionalDataWithOptionalCause } from '@metamask/rpc-errors';
+
+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 DappInfo = {
+  name: string;
+  url: string;
+  icon: string;
+};
+
+export type RpcRequest = {
+  requestId: string;
+  sessionId: string;
+  method: RpcMethod;
+  chainId: Caip2ChainId;
+  params: unknown;
+  dappInfo: DappInfo;
+  context?: Record<string, unknown>; // for storing additional context information that's only relevant to the consumer
+};
+
+export type RpcError =
+  | JsonRpcError<OptionalDataWithOptionalCause>
+  | EthereumProviderError<OptionalDataWithOptionalCause>;
+
+export type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWithOptionalCause>> =
+  | {
+      result: R;
+    }
+  | {
+      error: E;
+    };
+
+export type DisplayData = {
+  title: string;
+  network: {
+    chainId: number;
+    name: string;
+    logoUri?: string;
+  };
+  messageDetails?: string;
+  transactionDetails?: {
+    website: string;
+    from: string;
+    to: string;
+    data?: string;
+  };
+  networkFeeSelector?: boolean;
+};
+
+/**
+ * Enum for different types of signing data.
+ */
+export enum SigningDataType {
+  // EVM signing data types
+  EVM_TRANSACTION = 'evm_transaction',
+  EVM_MESSAGE_ETH_SIGN = 'evm_message_eth_sign',
+  EVM_MESSAGE_PERSONAL_SIGN = 'evm_message_personal_sign',
+  EVM_MESSAGE_ETH_SIGN_TYPED_DATA = 'evm_message_eth_sign_typed_data',
+  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V1 = 'evm_message_eth_sign_typed_data_v1',
+  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V3 = 'evm_message_eth_sign_typed_data_v3',
+  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V4 = 'evm_message_eth_sign_typed_data_v4',
+
+  // Avalanche signing data types
+  AVALANCHE_TRANSACTION = 'avalanche_transaction',
+  AVALANCHE_MESSAGE = 'avalanche_message',
+
+  // Bitcoin signing data types
+  BTC_TRANSACTION = 'btc_transaction',
+}
+
+export type SigningData =
+  | {
+      type: SigningDataType.EVM_TRANSACTION;
+      account: string;
+      chainId: number;
+      data: TransactionRequest;
+    }
+  | {
+      type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+      account: string;
+      chainId: number;
+      data: string;
+    };
+
+export type ApprovalParams = {
+  request: RpcRequest;
+  displayData: DisplayData;
+  signingData: SigningData;
+};
+
+export type ApprovalResponse =
+  | {
+      result: Hex;
+    }
+  | {
+      error: RpcError;
+    };
+
+export interface ApprovalController {
+  requestApproval: (params: ApprovalParams) => Promise<ApprovalResponse>;
+  onTransactionConfirmed: (txHash: Hex) => void;
+  onTransactionReverted: (txHash: Hex) => void;
+}

package/src/token.ts

@@ -0,0 +1,25 @@
+export interface NetworkToken {
+  name: string;
+  symbol: string;
+  decimals: number;
+  logoUri?: string;
+  description?: string;
+}
+
+export interface NetworkContractToken {
+  address: string;
+  chainId?: number;
+  color?: string;
+  contractType: string;
+  decimals: number;
+  logoUri?: string;
+  name: string;
+  symbol: string;
+}
+
+export enum TokenType {
+  NATIVE = 'NATIVE',
+  ERC20 = 'ERC20',
+  ERC721 = 'ERC721',
+  ERC1155 = 'ERC1155',
+}