@metamask/client-utils 1.0.0

package/dist/types.d.mts

@@ -0,0 +1,73 @@
+import type { ValueTransfer as _ValueTransfer } from "@metamask/core-backend";
+import type { CaipChainId } from "@metamask/utils";
+export type ActivityKind = 'receive' | 'sell' | 'buy' | 'deposit' | 'swap' | 'claim' | 'claimMusdBonus' | 'send' | 'wrap' | 'unwrap' | 'approveSpendingCap' | 'revokeSpendingCap' | 'increaseSpendingCap' | 'contractInteraction' | 'contractDeployment' | 'bridge' | 'convert' | 'nftBuy' | 'nftMint' | 'nftSell' | 'smartAccountUpgrade' | 'lendingDeposit' | 'lendingWithdrawal' | 'predictionsAddFunds' | 'predictionsWithdrawFunds' | 'predictionClaimWinnings' | 'predictionCashedOut' | 'predictionPlaced' | 'perpsAddFunds' | 'perpsWithdraw' | 'perpsOpenLong' | 'perpsCloseLong' | 'perpsCloseLongLiquidated' | 'perpsCloseLongStopLoss' | 'perpsOpenShort' | 'perpsCloseShort' | 'perpsCloseShortLiquidated' | 'perpsCloseShortStopLoss' | 'perpsPaidFundingFees' | 'perpsReceivedFundingFees' | 'perpsCloseShortTakeProfit' | 'perpsCloseLongTakeProfit' | 'marketShort' | 'stopMarketCloseShort' | 'marketCloseShort';
+export type Status = 'pending' | 'success' | 'failed' | 'cancelled';
+export type TokenAmount = {
+    amount?: string;
+    decimals?: number;
+    symbol?: string;
+    assetId?: string;
+    direction: 'in' | 'out';
+};
+export type FiatAmount = {
+    amount: string;
+    currency?: string;
+};
+export type Fee = {
+    type: string;
+    amount?: string;
+    decimals?: number;
+    symbol?: string;
+    assetId?: string;
+};
+type ActivityData<Type extends ActivityKind, Data> = {
+    type: Type;
+    chainId: CaipChainId;
+    status: Status;
+    timestamp: number;
+    hash?: string;
+    data: Data;
+};
+export type ActivityItem = ActivityData<'approveSpendingCap' | 'revokeSpendingCap' | 'increaseSpendingCap', {
+    from?: string;
+    token?: TokenAmount;
+    fees?: Fee[];
+}> | ActivityData<'send' | 'receive', {
+    from: string;
+    to: string;
+    token?: TokenAmount;
+    fees?: Fee[];
+}> | ActivityData<'nftBuy' | 'nftMint' | 'nftSell', {
+    from?: string;
+    to?: string;
+    token?: TokenAmount;
+    paymentToken?: TokenAmount;
+}> | ActivityData<'swap' | 'bridge' | 'convert' | 'lendingDeposit' | 'lendingWithdrawal' | 'wrap' | 'unwrap', {
+    from?: string;
+    sourceToken?: TokenAmount;
+    destinationToken?: TokenAmount;
+    fees?: Fee[];
+}> | ActivityData<'buy' | 'claim' | 'deposit' | 'claimMusdBonus', {
+    from?: string;
+    token?: TokenAmount;
+}> | ActivityData<'perpsAddFunds' | 'perpsWithdraw', {
+    from?: string;
+    fiat?: FiatAmount;
+    networkFee?: FiatAmount;
+    token?: TokenAmount;
+}> | ActivityData<'contractInteraction', {
+    from: string;
+    to: string;
+    token?: TokenAmount;
+    fees?: Fee[];
+    methodId?: string;
+    transactionCategory?: string;
+    transactionProtocol?: string;
+}>;
+export type ValueTransfer = _ValueTransfer & {
+    contractAddress: string;
+    symbol: string;
+    name: string;
+};
+export {};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,IAAI,cAAc,EAAE,+BAA+B;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAwB;AAEnD,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,MAAM,GACN,KAAK,GACL,SAAS,GACT,MAAM,GACN,OAAO,GACP,gBAAgB,GAChB,MAAM,GACN,MAAM,GACN,QAAQ,GACR,oBAAoB,GACpB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,SAAS,GACT,SAAS,GACT,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,qBAAqB,GACrB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,0BAA0B,GAC1B,wBAAwB,GACxB,gBAAgB,GAChB,iBAAiB,GACjB,2BAA2B,GAC3B,yBAAyB,GACzB,sBAAsB,GACtB,0BAA0B,GAC1B,2BAA2B,GAC3B,0BAA0B,GAC1B,aAAa,GACb,sBAAsB,GACtB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEpE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,IAAI,GAAG,KAAK,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,YAAY,CAAC,IAAI,SAAS,YAAY,EAAE,IAAI,IAAI;IACnD,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,YAAY,CACV,oBAAoB,GAAG,mBAAmB,GAAG,qBAAqB,EAClE;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd,CACF,GACD,YAAY,CACV,MAAM,GAAG,SAAS,EAClB;IACE,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd,CACF,GACD,YAAY,CACV,QAAQ,GAAG,SAAS,GAAG,SAAS,EAChC;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,YAAY,CAAC,EAAE,WAAW,CAAC;CAC5B,CACF,GACD,YAAY,CACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,gBAAgB,GAChB,mBAAmB,GACnB,MAAM,GACN,QAAQ,EACV;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAC/B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd,CACF,GACD,YAAY,CACV,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,gBAAgB,EAC9C;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB,CACF,GACD,YAAY,CACV,eAAe,GAAG,eAAe,EACjC;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB,CACF,GACD,YAAY,CACV,qBAAqB,EACrB;IACE,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CACF,CAAC;AAGN,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ValueTransfer as _ValueTransfer } from '@metamask/core-backend';\nimport type { CaipChainId } from '@metamask/utils';\n\nexport type ActivityKind =\n  | 'receive'\n  | 'sell'\n  | 'buy'\n  | 'deposit'\n  | 'swap'\n  | 'claim'\n  | 'claimMusdBonus'\n  | 'send'\n  | 'wrap'\n  | 'unwrap'\n  | 'approveSpendingCap'\n  | 'revokeSpendingCap'\n  | 'increaseSpendingCap'\n  | 'contractInteraction'\n  | 'contractDeployment'\n  | 'bridge'\n  | 'convert'\n  | 'nftBuy'\n  | 'nftMint'\n  | 'nftSell'\n  | 'smartAccountUpgrade'\n  | 'lendingDeposit'\n  | 'lendingWithdrawal'\n  | 'predictionsAddFunds'\n  | 'predictionsWithdrawFunds'\n  | 'predictionClaimWinnings'\n  | 'predictionCashedOut'\n  | 'predictionPlaced'\n  | 'perpsAddFunds'\n  | 'perpsWithdraw'\n  | 'perpsOpenLong'\n  | 'perpsCloseLong'\n  | 'perpsCloseLongLiquidated'\n  | 'perpsCloseLongStopLoss'\n  | 'perpsOpenShort'\n  | 'perpsCloseShort'\n  | 'perpsCloseShortLiquidated'\n  | 'perpsCloseShortStopLoss'\n  | 'perpsPaidFundingFees'\n  | 'perpsReceivedFundingFees'\n  | 'perpsCloseShortTakeProfit'\n  | 'perpsCloseLongTakeProfit'\n  | 'marketShort'\n  | 'stopMarketCloseShort'\n  | 'marketCloseShort';\n\nexport type Status = 'pending' | 'success' | 'failed' | 'cancelled';\n\nexport type TokenAmount = {\n  amount?: string;\n  decimals?: number;\n  symbol?: string;\n  assetId?: string;\n  direction: 'in' | 'out';\n};\n\nexport type FiatAmount = {\n  amount: string;\n  currency?: string;\n};\n\nexport type Fee = {\n  type: string;\n  amount?: string;\n  decimals?: number;\n  symbol?: string;\n  assetId?: string;\n};\n\ntype ActivityData<Type extends ActivityKind, Data> = {\n  type: Type;\n  chainId: CaipChainId;\n  status: Status;\n  timestamp: number;\n  hash?: string;\n  data: Data;\n};\n\nexport type ActivityItem =\n  | ActivityData<\n      'approveSpendingCap' | 'revokeSpendingCap' | 'increaseSpendingCap',\n      {\n        from?: string;\n        token?: TokenAmount;\n        fees?: Fee[];\n      }\n    >\n  | ActivityData<\n      'send' | 'receive',\n      {\n        from: string;\n        to: string;\n        token?: TokenAmount;\n        fees?: Fee[];\n      }\n    >\n  | ActivityData<\n      'nftBuy' | 'nftMint' | 'nftSell',\n      {\n        from?: string;\n        to?: string;\n        token?: TokenAmount;\n        paymentToken?: TokenAmount;\n      }\n    >\n  | ActivityData<\n      | 'swap'\n      | 'bridge'\n      | 'convert'\n      | 'lendingDeposit'\n      | 'lendingWithdrawal'\n      | 'wrap'\n      | 'unwrap',\n      {\n        from?: string;\n        sourceToken?: TokenAmount;\n        destinationToken?: TokenAmount;\n        fees?: Fee[];\n      }\n    >\n  | ActivityData<\n      'buy' | 'claim' | 'deposit' | 'claimMusdBonus',\n      {\n        from?: string;\n        token?: TokenAmount;\n      }\n    >\n  | ActivityData<\n      'perpsAddFunds' | 'perpsWithdraw',\n      {\n        from?: string;\n        fiat?: FiatAmount;\n        networkFee?: FiatAmount;\n        token?: TokenAmount;\n      }\n    >\n  | ActivityData<\n      'contractInteraction',\n      {\n        from: string;\n        to: string;\n        token?: TokenAmount;\n        fees?: Fee[];\n        methodId?: string;\n        transactionCategory?: string;\n        transactionProtocol?: string;\n      }\n    >;\n\n// Note: Update core-backend\nexport type ValueTransfer = _ValueTransfer & {\n  contractAddress: string;\n  symbol: string;\n  name: string;\n};\n"]}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@metamask/client-utils",
+  "version": "1.0.0",
+  "description": "Shared functions and utilities used across MetaMask clients (extension and mobile)",
+  "keywords": [
+    "Ethereum",
+    "MetaMask"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/client-utils#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "license": "(MIT OR Apache-2.0)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/client-utils",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/client-utils",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/contract-metadata": "^2.4.0",
+    "@metamask/controller-utils": "^12.3.0",
+    "@metamask/core-backend": "^6.5.0",
+    "@metamask/keyring-api": "^23.5.0",
+    "@metamask/transaction-controller": "^68.3.0",
+    "@metamask/utils": "^11.11.0"
+  },
+  "devDependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@metamask/auto-changelog": "^6.1.0",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^29.5.14",
+    "deepmerge": "^4.2.2",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "tsx": "^4.20.5",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  }
+}