@metamask-previews/chain-agnostic-permission 0.1.0-preview-b69c669

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- Initial release
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/chain-agnostic-permission@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/chain-agnostic-permission@0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/chain-agnostic-permission`
+
+Defines an endowment type permission designed to persist the account and chain components of a [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request. This package also includes adapters and utility functions for interfacing with this permission.
+
+## Installation
+
+`yarn add @metamask/chain-agnostic-permission`
+
+or
+
+`npm install @metamask/chain-agnostic-permission`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/adapters/caip-permission-adapter-eth-accounts.cjs

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setEthAccounts = exports.getEthAccounts = void 0;
+const utils_1 = require("@metamask/utils");
+const constants_1 = require("../scope/constants.cjs");
+const transform_1 = require("../scope/transform.cjs");
+const types_1 = require("../scope/types.cjs");
+/**
+ * Checks if a scope string is either an EIP155 or wallet namespaced scope string.
+ *
+ * @param scopeString - The scope string to check.
+ * @returns True if the scope string is an EIP155 or wallet namespaced scope string, false otherwise.
+ */
+const isEip155ScopeString = (scopeString) => {
+    const { namespace } = (0, types_1.parseScopeString)(scopeString);
+    return (namespace === utils_1.KnownCaipNamespace.Eip155 ||
+        // We are trying to discern the type of `scopeString`.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        scopeString === constants_1.KnownWalletScopeString.Eip155);
+};
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from internal scopes.
+ *
+ * @param scopes - The internal scopes from which to get the Ethereum accounts.
+ * @returns An array of Ethereum accounts.
+ */
+const getEthAccountsFromScopes = (scopes) => {
+    const ethAccounts = [];
+    Object.entries(scopes).forEach(([_, { accounts }]) => {
+        accounts?.forEach((account) => {
+            const { address, chainId } = (0, utils_1.parseCaipAccountId)(account);
+            if (isEip155ScopeString(chainId)) {
+                // This address should always be a valid Hex string because
+                // it's an EIP155/Ethereum account
+                (0, utils_1.assertIsStrictHexString)(address);
+                ethAccounts.push(address);
+            }
+        });
+    });
+    return ethAccounts;
+};
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.
+ * @returns An array of Ethereum accounts.
+ */
+const getEthAccounts = (caip25CaveatValue) => {
+    const { requiredScopes, optionalScopes } = caip25CaveatValue;
+    const ethAccounts = [
+        ...getEthAccountsFromScopes(requiredScopes),
+        ...getEthAccountsFromScopes(optionalScopes),
+    ];
+    return (0, transform_1.getUniqueArrayItems)(ethAccounts);
+};
+exports.getEthAccounts = getEthAccounts;
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given scopes object.
+ *
+ * @param scopesObject - The scopes object to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated scopes object with the Ethereum accounts set.
+ */
+const setEthAccountsForScopesObject = (scopesObject, accounts) => {
+    const updatedScopesObject = {};
+    Object.entries(scopesObject).forEach(([key, scopeObject]) => {
+        // Cast needed because index type is returned as `string` by `Object.entries`
+        const scopeString = key;
+        const isWalletNamespace = scopeString === utils_1.KnownCaipNamespace.Wallet;
+        const { namespace, reference } = (0, types_1.parseScopeString)(scopeString);
+        if (!isEip155ScopeString(scopeString) && !isWalletNamespace) {
+            updatedScopesObject[scopeString] = scopeObject;
+            return;
+        }
+        let caipAccounts = [];
+        if (namespace && reference) {
+            caipAccounts = accounts.map((account) => `${namespace}:${reference}:${account}`);
+        }
+        updatedScopesObject[scopeString] = {
+            ...scopeObject,
+            accounts: caipAccounts,
+        };
+    });
+    return updatedScopesObject;
+};
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.
+ * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because
+ * we do not provide UI/UX flows for selecting different accounts across different chains.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.
+ */
+const setEthAccounts = (caip25CaveatValue, accounts) => {
+    return {
+        ...caip25CaveatValue,
+        requiredScopes: setEthAccountsForScopesObject(caip25CaveatValue.requiredScopes, accounts),
+        optionalScopes: setEthAccountsForScopesObject(caip25CaveatValue.optionalScopes, accounts),
+    };
+};
+exports.setEthAccounts = setEthAccounts;
+//# sourceMappingURL=caip-permission-adapter-eth-accounts.cjs.map

package/dist/adapters/caip-permission-adapter-eth-accounts.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-eth-accounts.cjs","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-eth-accounts.ts"],"names":[],"mappings":";;;AAAA,2CAMyB;AAGzB,sDAA4D;AAC5D,sDAAyD;AAEzD,8CAAkD;AAElD;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,CAAC,WAAgC,EAAE,EAAE;IAC/D,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;IAEpD,OAAO,CACL,SAAS,KAAK,0BAAkB,CAAC,MAAM;QACvC,sDAAsD;QACtD,wEAAwE;QACxE,WAAW,KAAK,kCAAsB,CAAC,MAAM,CAC9C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,wBAAwB,GAAG,CAAC,MAA4B,EAAE,EAAE;IAChE,MAAM,WAAW,GAAU,EAAE,CAAC;IAE9B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE;QACnD,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAAE;gBAChC,2DAA2D;gBAC3D,kCAAkC;gBAClC,IAAA,+BAAuB,EAAC,OAAO,CAAC,CAAC;gBACjC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAC5B,iBAGC,EACM,EAAE;IACT,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,iBAAiB,CAAC;IAE7D,MAAM,WAAW,GAAU;QACzB,GAAG,wBAAwB,CAAC,cAAc,CAAC;QAC3C,GAAG,wBAAwB,CAAC,cAAc,CAAC;KAC5C,CAAC;IAEF,OAAO,IAAA,+BAAmB,EAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAdW,QAAA,cAAc,kBAczB;AAEF;;;;;;GAMG;AACH,MAAM,6BAA6B,GAAG,CACpC,YAAkC,EAClC,QAAe,EACf,EAAE;IACF,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE;QAC1D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,GAAgC,CAAC;QACrD,MAAM,iBAAiB,GAAG,WAAW,KAAK,0BAAkB,CAAC,MAAM,CAAC;QACpE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3D,mBAAmB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;YAC/C,OAAO;SACR;QAED,IAAI,YAAY,GAAoB,EAAE,CAAC;QACvC,IAAI,SAAS,IAAI,SAAS,EAAE;YAC1B,YAAY,GAAG,QAAQ,CAAC,GAAG,CACzB,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,SAAS,IAAI,OAAO,EAAE,CACpD,CAAC;SACH;QAED,mBAAmB,CAAC,WAAW,CAAC,GAAG;YACjC,GAAG,WAAW;YACd,QAAQ,EAAE,YAAY;SACvB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,mBAAmB,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACI,MAAM,cAAc,GAAG,CAC5B,iBAAoC,EACpC,QAAe,EACI,EAAE;IACrB,OAAO;QACL,GAAG,iBAAiB;QACpB,cAAc,EAAE,6BAA6B,CAC3C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;QACD,cAAc,EAAE,6BAA6B,CAC3C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;KACF,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,cAAc,kBAezB","sourcesContent":["import {\n  assertIsStrictHexString,\n  type CaipAccountId,\n  type Hex,\n  KnownCaipNamespace,\n  parseCaipAccountId,\n} from '@metamask/utils';\n\nimport type { Caip25CaveatValue } from '../caip25Permission';\nimport { KnownWalletScopeString } from '../scope/constants';\nimport { getUniqueArrayItems } from '../scope/transform';\nimport type { InternalScopeString, InternalScopesObject } from '../scope/types';\nimport { parseScopeString } from '../scope/types';\n\n/**\n * Checks if a scope string is either an EIP155 or wallet namespaced scope string.\n *\n * @param scopeString - The scope string to check.\n * @returns True if the scope string is an EIP155 or wallet namespaced scope string, false otherwise.\n */\nconst isEip155ScopeString = (scopeString: InternalScopeString) => {\n  const { namespace } = parseScopeString(scopeString);\n\n  return (\n    namespace === KnownCaipNamespace.Eip155 ||\n    // We are trying to discern the type of `scopeString`.\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison\n    scopeString === KnownWalletScopeString.Eip155\n  );\n};\n\n/**\n * Gets the Ethereum (EIP155 namespaced) accounts from internal scopes.\n *\n * @param scopes - The internal scopes from which to get the Ethereum accounts.\n * @returns An array of Ethereum accounts.\n */\nconst getEthAccountsFromScopes = (scopes: InternalScopesObject) => {\n  const ethAccounts: Hex[] = [];\n\n  Object.entries(scopes).forEach(([_, { accounts }]) => {\n    accounts?.forEach((account) => {\n      const { address, chainId } = parseCaipAccountId(account);\n\n      if (isEip155ScopeString(chainId)) {\n        // This address should always be a valid Hex string because\n        // it's an EIP155/Ethereum account\n        assertIsStrictHexString(address);\n        ethAccounts.push(address);\n      }\n    });\n  });\n\n  return ethAccounts;\n};\n\n/**\n * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.\n * @returns An array of Ethereum accounts.\n */\nexport const getEthAccounts = (\n  caip25CaveatValue: Pick<\n    Caip25CaveatValue,\n    'requiredScopes' | 'optionalScopes'\n  >,\n): Hex[] => {\n  const { requiredScopes, optionalScopes } = caip25CaveatValue;\n\n  const ethAccounts: Hex[] = [\n    ...getEthAccountsFromScopes(requiredScopes),\n    ...getEthAccountsFromScopes(optionalScopes),\n  ];\n\n  return getUniqueArrayItems(ethAccounts);\n};\n\n/**\n * Sets the Ethereum (EIP155 namespaced) accounts for the given scopes object.\n *\n * @param scopesObject - The scopes object to set the Ethereum accounts for.\n * @param accounts - The Ethereum accounts to set.\n * @returns The updated scopes object with the Ethereum accounts set.\n */\nconst setEthAccountsForScopesObject = (\n  scopesObject: InternalScopesObject,\n  accounts: Hex[],\n) => {\n  const updatedScopesObject: InternalScopesObject = {};\n  Object.entries(scopesObject).forEach(([key, scopeObject]) => {\n    // Cast needed because index type is returned as `string` by `Object.entries`\n    const scopeString = key as keyof typeof scopesObject;\n    const isWalletNamespace = scopeString === KnownCaipNamespace.Wallet;\n    const { namespace, reference } = parseScopeString(scopeString);\n    if (!isEip155ScopeString(scopeString) && !isWalletNamespace) {\n      updatedScopesObject[scopeString] = scopeObject;\n      return;\n    }\n\n    let caipAccounts: CaipAccountId[] = [];\n    if (namespace && reference) {\n      caipAccounts = accounts.map<CaipAccountId>(\n        (account) => `${namespace}:${reference}:${account}`,\n      );\n    }\n\n    updatedScopesObject[scopeString] = {\n      ...scopeObject,\n      accounts: caipAccounts,\n    };\n  });\n\n  return updatedScopesObject;\n};\n\n/**\n * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.\n * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because\n * we do not provide UI/UX flows for selecting different accounts across different chains.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.\n * @param accounts - The Ethereum accounts to set.\n * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.\n */\nexport const setEthAccounts = (\n  caip25CaveatValue: Caip25CaveatValue,\n  accounts: Hex[],\n): Caip25CaveatValue => {\n  return {\n    ...caip25CaveatValue,\n    requiredScopes: setEthAccountsForScopesObject(\n      caip25CaveatValue.requiredScopes,\n      accounts,\n    ),\n    optionalScopes: setEthAccountsForScopesObject(\n      caip25CaveatValue.optionalScopes,\n      accounts,\n    ),\n  };\n};\n"]}

package/dist/adapters/caip-permission-adapter-eth-accounts.d.cts

@@ -0,0 +1,20 @@
+import { type Hex } from "@metamask/utils";
+import type { Caip25CaveatValue } from "../caip25Permission.cjs";
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.
+ * @returns An array of Ethereum accounts.
+ */
+export declare const getEthAccounts: (caip25CaveatValue: Pick<Caip25CaveatValue, 'requiredScopes' | 'optionalScopes'>) => Hex[];
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.
+ * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because
+ * we do not provide UI/UX flows for selecting different accounts across different chains.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.
+ */
+export declare const setEthAccounts: (caip25CaveatValue: Caip25CaveatValue, accounts: Hex[]) => Caip25CaveatValue;
+//# sourceMappingURL=caip-permission-adapter-eth-accounts.d.cts.map

package/dist/adapters/caip-permission-adapter-eth-accounts.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-eth-accounts.d.cts","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-eth-accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,GAAG,EAGT,wBAAwB;AAEzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAgD7D;;;;;GAKG;AACH,eAAO,MAAM,cAAc,sBACN,KACjB,iBAAiB,EACjB,gBAAgB,GAAG,gBAAgB,CACpC,KACA,GAAG,EASL,CAAC;AAwCF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,sBACN,iBAAiB,YAC1B,GAAG,EAAE,KACd,iBAYF,CAAC"}

package/dist/adapters/caip-permission-adapter-eth-accounts.d.mts

@@ -0,0 +1,20 @@
+import { type Hex } from "@metamask/utils";
+import type { Caip25CaveatValue } from "../caip25Permission.mjs";
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.
+ * @returns An array of Ethereum accounts.
+ */
+export declare const getEthAccounts: (caip25CaveatValue: Pick<Caip25CaveatValue, 'requiredScopes' | 'optionalScopes'>) => Hex[];
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.
+ * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because
+ * we do not provide UI/UX flows for selecting different accounts across different chains.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.
+ */
+export declare const setEthAccounts: (caip25CaveatValue: Caip25CaveatValue, accounts: Hex[]) => Caip25CaveatValue;
+//# sourceMappingURL=caip-permission-adapter-eth-accounts.d.mts.map

package/dist/adapters/caip-permission-adapter-eth-accounts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-eth-accounts.d.mts","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-eth-accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,GAAG,EAGT,wBAAwB;AAEzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAgD7D;;;;;GAKG;AACH,eAAO,MAAM,cAAc,sBACN,KACjB,iBAAiB,EACjB,gBAAgB,GAAG,gBAAgB,CACpC,KACA,GAAG,EASL,CAAC;AAwCF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,sBACN,iBAAiB,YAC1B,GAAG,EAAE,KACd,iBAYF,CAAC"}

package/dist/adapters/caip-permission-adapter-eth-accounts.mjs

@@ -0,0 +1,98 @@
+import { assertIsStrictHexString, KnownCaipNamespace, parseCaipAccountId } from "@metamask/utils";
+import { KnownWalletScopeString } from "../scope/constants.mjs";
+import { getUniqueArrayItems } from "../scope/transform.mjs";
+import { parseScopeString } from "../scope/types.mjs";
+/**
+ * Checks if a scope string is either an EIP155 or wallet namespaced scope string.
+ *
+ * @param scopeString - The scope string to check.
+ * @returns True if the scope string is an EIP155 or wallet namespaced scope string, false otherwise.
+ */
+const isEip155ScopeString = (scopeString) => {
+    const { namespace } = parseScopeString(scopeString);
+    return (namespace === KnownCaipNamespace.Eip155 ||
+        // We are trying to discern the type of `scopeString`.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        scopeString === KnownWalletScopeString.Eip155);
+};
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from internal scopes.
+ *
+ * @param scopes - The internal scopes from which to get the Ethereum accounts.
+ * @returns An array of Ethereum accounts.
+ */
+const getEthAccountsFromScopes = (scopes) => {
+    const ethAccounts = [];
+    Object.entries(scopes).forEach(([_, { accounts }]) => {
+        accounts?.forEach((account) => {
+            const { address, chainId } = parseCaipAccountId(account);
+            if (isEip155ScopeString(chainId)) {
+                // This address should always be a valid Hex string because
+                // it's an EIP155/Ethereum account
+                assertIsStrictHexString(address);
+                ethAccounts.push(address);
+            }
+        });
+    });
+    return ethAccounts;
+};
+/**
+ * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.
+ * @returns An array of Ethereum accounts.
+ */
+export const getEthAccounts = (caip25CaveatValue) => {
+    const { requiredScopes, optionalScopes } = caip25CaveatValue;
+    const ethAccounts = [
+        ...getEthAccountsFromScopes(requiredScopes),
+        ...getEthAccountsFromScopes(optionalScopes),
+    ];
+    return getUniqueArrayItems(ethAccounts);
+};
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given scopes object.
+ *
+ * @param scopesObject - The scopes object to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated scopes object with the Ethereum accounts set.
+ */
+const setEthAccountsForScopesObject = (scopesObject, accounts) => {
+    const updatedScopesObject = {};
+    Object.entries(scopesObject).forEach(([key, scopeObject]) => {
+        // Cast needed because index type is returned as `string` by `Object.entries`
+        const scopeString = key;
+        const isWalletNamespace = scopeString === KnownCaipNamespace.Wallet;
+        const { namespace, reference } = parseScopeString(scopeString);
+        if (!isEip155ScopeString(scopeString) && !isWalletNamespace) {
+            updatedScopesObject[scopeString] = scopeObject;
+            return;
+        }
+        let caipAccounts = [];
+        if (namespace && reference) {
+            caipAccounts = accounts.map((account) => `${namespace}:${reference}:${account}`);
+        }
+        updatedScopesObject[scopeString] = {
+            ...scopeObject,
+            accounts: caipAccounts,
+        };
+    });
+    return updatedScopesObject;
+};
+/**
+ * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.
+ * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because
+ * we do not provide UI/UX flows for selecting different accounts across different chains.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.
+ * @param accounts - The Ethereum accounts to set.
+ * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.
+ */
+export const setEthAccounts = (caip25CaveatValue, accounts) => {
+    return {
+        ...caip25CaveatValue,
+        requiredScopes: setEthAccountsForScopesObject(caip25CaveatValue.requiredScopes, accounts),
+        optionalScopes: setEthAccountsForScopesObject(caip25CaveatValue.optionalScopes, accounts),
+    };
+};
+//# sourceMappingURL=caip-permission-adapter-eth-accounts.mjs.map

package/dist/adapters/caip-permission-adapter-eth-accounts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-eth-accounts.mjs","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-eth-accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EAGvB,kBAAkB,EAClB,kBAAkB,EACnB,wBAAwB;AAGzB,OAAO,EAAE,sBAAsB,EAAE,+BAA2B;AAC5D,OAAO,EAAE,mBAAmB,EAAE,+BAA2B;AAEzD,OAAO,EAAE,gBAAgB,EAAE,2BAAuB;AAElD;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,CAAC,WAAgC,EAAE,EAAE;IAC/D,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAEpD,OAAO,CACL,SAAS,KAAK,kBAAkB,CAAC,MAAM;QACvC,sDAAsD;QACtD,wEAAwE;QACxE,WAAW,KAAK,sBAAsB,CAAC,MAAM,CAC9C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,wBAAwB,GAAG,CAAC,MAA4B,EAAE,EAAE;IAChE,MAAM,WAAW,GAAU,EAAE,CAAC;IAE9B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE;QACnD,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAAE;gBAChC,2DAA2D;gBAC3D,kCAAkC;gBAClC,uBAAuB,CAAC,OAAO,CAAC,CAAC;gBACjC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,iBAGC,EACM,EAAE;IACT,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,iBAAiB,CAAC;IAE7D,MAAM,WAAW,GAAU;QACzB,GAAG,wBAAwB,CAAC,cAAc,CAAC;QAC3C,GAAG,wBAAwB,CAAC,cAAc,CAAC;KAC5C,CAAC;IAEF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,6BAA6B,GAAG,CACpC,YAAkC,EAClC,QAAe,EACf,EAAE;IACF,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE;QAC1D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,GAAgC,CAAC;QACrD,MAAM,iBAAiB,GAAG,WAAW,KAAK,kBAAkB,CAAC,MAAM,CAAC;QACpE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3D,mBAAmB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;YAC/C,OAAO;SACR;QAED,IAAI,YAAY,GAAoB,EAAE,CAAC;QACvC,IAAI,SAAS,IAAI,SAAS,EAAE;YAC1B,YAAY,GAAG,QAAQ,CAAC,GAAG,CACzB,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,SAAS,IAAI,OAAO,EAAE,CACpD,CAAC;SACH;QAED,mBAAmB,CAAC,WAAW,CAAC,GAAG;YACjC,GAAG,WAAW;YACd,QAAQ,EAAE,YAAY;SACvB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,mBAAmB,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,iBAAoC,EACpC,QAAe,EACI,EAAE;IACrB,OAAO;QACL,GAAG,iBAAiB;QACpB,cAAc,EAAE,6BAA6B,CAC3C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;QACD,cAAc,EAAE,6BAA6B,CAC3C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;KACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import {\n  assertIsStrictHexString,\n  type CaipAccountId,\n  type Hex,\n  KnownCaipNamespace,\n  parseCaipAccountId,\n} from '@metamask/utils';\n\nimport type { Caip25CaveatValue } from '../caip25Permission';\nimport { KnownWalletScopeString } from '../scope/constants';\nimport { getUniqueArrayItems } from '../scope/transform';\nimport type { InternalScopeString, InternalScopesObject } from '../scope/types';\nimport { parseScopeString } from '../scope/types';\n\n/**\n * Checks if a scope string is either an EIP155 or wallet namespaced scope string.\n *\n * @param scopeString - The scope string to check.\n * @returns True if the scope string is an EIP155 or wallet namespaced scope string, false otherwise.\n */\nconst isEip155ScopeString = (scopeString: InternalScopeString) => {\n  const { namespace } = parseScopeString(scopeString);\n\n  return (\n    namespace === KnownCaipNamespace.Eip155 ||\n    // We are trying to discern the type of `scopeString`.\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison\n    scopeString === KnownWalletScopeString.Eip155\n  );\n};\n\n/**\n * Gets the Ethereum (EIP155 namespaced) accounts from internal scopes.\n *\n * @param scopes - The internal scopes from which to get the Ethereum accounts.\n * @returns An array of Ethereum accounts.\n */\nconst getEthAccountsFromScopes = (scopes: InternalScopesObject) => {\n  const ethAccounts: Hex[] = [];\n\n  Object.entries(scopes).forEach(([_, { accounts }]) => {\n    accounts?.forEach((account) => {\n      const { address, chainId } = parseCaipAccountId(account);\n\n      if (isEip155ScopeString(chainId)) {\n        // This address should always be a valid Hex string because\n        // it's an EIP155/Ethereum account\n        assertIsStrictHexString(address);\n        ethAccounts.push(address);\n      }\n    });\n  });\n\n  return ethAccounts;\n};\n\n/**\n * Gets the Ethereum (EIP155 namespaced) accounts from the required and optional scopes.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to get the Ethereum accounts from.\n * @returns An array of Ethereum accounts.\n */\nexport const getEthAccounts = (\n  caip25CaveatValue: Pick<\n    Caip25CaveatValue,\n    'requiredScopes' | 'optionalScopes'\n  >,\n): Hex[] => {\n  const { requiredScopes, optionalScopes } = caip25CaveatValue;\n\n  const ethAccounts: Hex[] = [\n    ...getEthAccountsFromScopes(requiredScopes),\n    ...getEthAccountsFromScopes(optionalScopes),\n  ];\n\n  return getUniqueArrayItems(ethAccounts);\n};\n\n/**\n * Sets the Ethereum (EIP155 namespaced) accounts for the given scopes object.\n *\n * @param scopesObject - The scopes object to set the Ethereum accounts for.\n * @param accounts - The Ethereum accounts to set.\n * @returns The updated scopes object with the Ethereum accounts set.\n */\nconst setEthAccountsForScopesObject = (\n  scopesObject: InternalScopesObject,\n  accounts: Hex[],\n) => {\n  const updatedScopesObject: InternalScopesObject = {};\n  Object.entries(scopesObject).forEach(([key, scopeObject]) => {\n    // Cast needed because index type is returned as `string` by `Object.entries`\n    const scopeString = key as keyof typeof scopesObject;\n    const isWalletNamespace = scopeString === KnownCaipNamespace.Wallet;\n    const { namespace, reference } = parseScopeString(scopeString);\n    if (!isEip155ScopeString(scopeString) && !isWalletNamespace) {\n      updatedScopesObject[scopeString] = scopeObject;\n      return;\n    }\n\n    let caipAccounts: CaipAccountId[] = [];\n    if (namespace && reference) {\n      caipAccounts = accounts.map<CaipAccountId>(\n        (account) => `${namespace}:${reference}:${account}`,\n      );\n    }\n\n    updatedScopesObject[scopeString] = {\n      ...scopeObject,\n      accounts: caipAccounts,\n    };\n  });\n\n  return updatedScopesObject;\n};\n\n/**\n * Sets the Ethereum (EIP155 namespaced) accounts for the given CAIP-25 caveat value.\n * We set the same accounts for all the scopes that are EIP155 or Wallet namespaced because\n * we do not provide UI/UX flows for selecting different accounts across different chains.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to set the Ethereum accounts for.\n * @param accounts - The Ethereum accounts to set.\n * @returns The updated CAIP-25 caveat value with the Ethereum accounts set.\n */\nexport const setEthAccounts = (\n  caip25CaveatValue: Caip25CaveatValue,\n  accounts: Hex[],\n): Caip25CaveatValue => {\n  return {\n    ...caip25CaveatValue,\n    requiredScopes: setEthAccountsForScopesObject(\n      caip25CaveatValue.requiredScopes,\n      accounts,\n    ),\n    optionalScopes: setEthAccountsForScopesObject(\n      caip25CaveatValue.optionalScopes,\n      accounts,\n    ),\n  };\n};\n"]}

package/dist/adapters/caip-permission-adapter-permittedChains.cjs

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setPermittedEthChainIds = exports.addPermittedEthChainId = exports.getPermittedEthChainIds = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("@metamask/utils");
+const transform_1 = require("../scope/transform.cjs");
+const types_1 = require("../scope/types.cjs");
+/**
+ * Gets the Ethereum (EIP155 namespaced) chainIDs from internal scopes.
+ *
+ * @param scopes - The internal scopes from which to get the Ethereum chainIDs.
+ * @returns An array of Ethereum chainIDs.
+ */
+const getPermittedEthChainIdsFromScopes = (scopes) => {
+    const ethChainIds = [];
+    Object.keys(scopes).forEach((scopeString) => {
+        const { namespace, reference } = (0, types_1.parseScopeString)(scopeString);
+        if (namespace === utils_1.KnownCaipNamespace.Eip155 && reference) {
+            ethChainIds.push((0, controller_utils_1.toHex)(reference));
+        }
+    });
+    return ethChainIds;
+};
+/**
+ * Gets the Ethereum (EIP155 namespaced) chainIDs from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value from which to get the Ethereum chainIDs.
+ * @returns An array of Ethereum chainIDs.
+ */
+const getPermittedEthChainIds = (caip25CaveatValue) => {
+    const { requiredScopes, optionalScopes } = caip25CaveatValue;
+    const ethChainIds = [
+        ...getPermittedEthChainIdsFromScopes(requiredScopes),
+        ...getPermittedEthChainIdsFromScopes(optionalScopes),
+    ];
+    return (0, transform_1.getUniqueArrayItems)(ethChainIds);
+};
+exports.getPermittedEthChainIds = getPermittedEthChainIds;
+/**
+ * Adds an Ethereum (EIP155 namespaced) chainID to the optional scopes if it is not already present
+ * in either the pre-existing required or optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to add the Ethereum chainID to.
+ * @param chainId - The Ethereum chainID to add.
+ * @returns The updated CAIP-25 caveat value with the added Ethereum chainID.
+ */
+const addPermittedEthChainId = (caip25CaveatValue, chainId) => {
+    const scopeString = `eip155:${(0, utils_1.hexToBigInt)(chainId).toString(10)}`;
+    if (Object.keys(caip25CaveatValue.requiredScopes).includes(scopeString) ||
+        Object.keys(caip25CaveatValue.optionalScopes).includes(scopeString)) {
+        return caip25CaveatValue;
+    }
+    return {
+        ...caip25CaveatValue,
+        optionalScopes: {
+            ...caip25CaveatValue.optionalScopes,
+            [scopeString]: {
+                accounts: [],
+            },
+        },
+    };
+};
+exports.addPermittedEthChainId = addPermittedEthChainId;
+/**
+ * Filters the scopes object to only include:
+ * - Scopes without references (e.g. "wallet:")
+ * - EIP155 scopes for the given chainIDs
+ * - Non EIP155 scopes (e.g. "bip122:" or any other non ethereum namespaces)
+ *
+ * @param scopesObject - The scopes object to filter.
+ * @param chainIds - The chainIDs to filter EIP155 scopes by.
+ * @returns The filtered scopes object.
+ */
+const filterEthScopesObjectByChainId = (scopesObject, chainIds) => {
+    const updatedScopesObject = {};
+    Object.entries(scopesObject).forEach(([key, scopeObject]) => {
+        // Cast needed because index type is returned as `string` by `Object.entries`
+        const scopeString = key;
+        const { namespace, reference } = (0, types_1.parseScopeString)(scopeString);
+        if (!reference) {
+            updatedScopesObject[scopeString] = scopeObject;
+            return;
+        }
+        if (namespace === utils_1.KnownCaipNamespace.Eip155) {
+            const chainId = (0, controller_utils_1.toHex)(reference);
+            if (chainIds.includes(chainId)) {
+                updatedScopesObject[scopeString] = scopeObject;
+            }
+        }
+        else {
+            updatedScopesObject[scopeString] = scopeObject;
+        }
+    });
+    return updatedScopesObject;
+};
+/**
+ * Sets the permitted Ethereum (EIP155 namespaced) chainIDs for the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the permitted Ethereum chainIDs for.
+ * @param chainIds - The Ethereum chainIDs to set as permitted.
+ * @returns The updated CAIP-25 caveat value with the permitted Ethereum chainIDs.
+ */
+const setPermittedEthChainIds = (caip25CaveatValue, chainIds) => {
+    let updatedCaveatValue = {
+        ...caip25CaveatValue,
+        requiredScopes: filterEthScopesObjectByChainId(caip25CaveatValue.requiredScopes, chainIds),
+        optionalScopes: filterEthScopesObjectByChainId(caip25CaveatValue.optionalScopes, chainIds),
+    };
+    chainIds.forEach((chainId) => {
+        updatedCaveatValue = (0, exports.addPermittedEthChainId)(updatedCaveatValue, chainId);
+    });
+    return updatedCaveatValue;
+};
+exports.setPermittedEthChainIds = setPermittedEthChainIds;
+//# sourceMappingURL=caip-permission-adapter-permittedChains.cjs.map

package/dist/adapters/caip-permission-adapter-permittedChains.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-permittedChains.cjs","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-permittedChains.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAEnD,2CAAkE;AAGlE,sDAAyD;AAEzD,8CAAkD;AAElD;;;;;GAKG;AACH,MAAM,iCAAiC,GAAG,CAAC,MAA4B,EAAE,EAAE;IACzE,MAAM,WAAW,GAAU,EAAE,CAAC;IAE9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,0BAAkB,CAAC,MAAM,IAAI,SAAS,EAAE;YACxD,WAAW,CAAC,IAAI,CAAC,IAAA,wBAAK,EAAC,SAAS,CAAC,CAAC,CAAC;SACpC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,uBAAuB,GAAG,CACrC,iBAGC,EACD,EAAE;IACF,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,iBAAiB,CAAC;IAE7D,MAAM,WAAW,GAAU;QACzB,GAAG,iCAAiC,CAAC,cAAc,CAAC;QACpD,GAAG,iCAAiC,CAAC,cAAc,CAAC;KACrD,CAAC;IAEF,OAAO,IAAA,+BAAmB,EAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAdW,QAAA,uBAAuB,2BAclC;AAEF;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CACpC,iBAAoC,EACpC,OAAY,EACO,EAAE;IACrB,MAAM,WAAW,GAAG,UAAU,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;IAClE,IACE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EACnE;QACA,OAAO,iBAAiB,CAAC;KAC1B;IAED,OAAO;QACL,GAAG,iBAAiB;QACpB,cAAc,EAAE;YACd,GAAG,iBAAiB,CAAC,cAAc;YACnC,CAAC,WAAW,CAAC,EAAE;gBACb,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,sBAAsB,0BAqBjC;AAEF;;;;;;;;;GASG;AACH,MAAM,8BAA8B,GAAG,CACrC,YAAkC,EAClC,QAAe,EACO,EAAE;IACxB,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IAErD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE;QAC1D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,GAAgC,CAAC;QACrD,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,EAAE;YACd,mBAAmB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;YAC/C,OAAO;SACR;QACD,IAAI,SAAS,KAAK,0BAAkB,CAAC,MAAM,EAAE;YAC3C,MAAM,OAAO,GAAG,IAAA,wBAAK,EAAC,SAAS,CAAC,CAAC;YACjC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC9B,mBAAmB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;aAChD;SACF;aAAM;YACL,mBAAmB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;SAChD;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,mBAAmB,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,MAAM,uBAAuB,GAAG,CACrC,iBAAoC,EACpC,QAAe,EACI,EAAE;IACrB,IAAI,kBAAkB,GAAsB;QAC1C,GAAG,iBAAiB;QACpB,cAAc,EAAE,8BAA8B,CAC5C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;QACD,cAAc,EAAE,8BAA8B,CAC5C,iBAAiB,CAAC,cAAc,EAChC,QAAQ,CACT;KACF,CAAC;IAEF,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,kBAAkB,GAAG,IAAA,8BAAsB,EAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AArBW,QAAA,uBAAuB,2BAqBlC","sourcesContent":["import { toHex } from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\nimport { hexToBigInt, KnownCaipNamespace } from '@metamask/utils';\n\nimport type { Caip25CaveatValue } from '../caip25Permission';\nimport { getUniqueArrayItems } from '../scope/transform';\nimport type { InternalScopesObject } from '../scope/types';\nimport { parseScopeString } from '../scope/types';\n\n/**\n * Gets the Ethereum (EIP155 namespaced) chainIDs from internal scopes.\n *\n * @param scopes - The internal scopes from which to get the Ethereum chainIDs.\n * @returns An array of Ethereum chainIDs.\n */\nconst getPermittedEthChainIdsFromScopes = (scopes: InternalScopesObject) => {\n  const ethChainIds: Hex[] = [];\n\n  Object.keys(scopes).forEach((scopeString) => {\n    const { namespace, reference } = parseScopeString(scopeString);\n    if (namespace === KnownCaipNamespace.Eip155 && reference) {\n      ethChainIds.push(toHex(reference));\n    }\n  });\n\n  return ethChainIds;\n};\n\n/**\n * Gets the Ethereum (EIP155 namespaced) chainIDs from the required and optional scopes.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value from which to get the Ethereum chainIDs.\n * @returns An array of Ethereum chainIDs.\n */\nexport const getPermittedEthChainIds = (\n  caip25CaveatValue: Pick<\n    Caip25CaveatValue,\n    'requiredScopes' | 'optionalScopes'\n  >,\n) => {\n  const { requiredScopes, optionalScopes } = caip25CaveatValue;\n\n  const ethChainIds: Hex[] = [\n    ...getPermittedEthChainIdsFromScopes(requiredScopes),\n    ...getPermittedEthChainIdsFromScopes(optionalScopes),\n  ];\n\n  return getUniqueArrayItems(ethChainIds);\n};\n\n/**\n * Adds an Ethereum (EIP155 namespaced) chainID to the optional scopes if it is not already present\n * in either the pre-existing required or optional scopes.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to add the Ethereum chainID to.\n * @param chainId - The Ethereum chainID to add.\n * @returns The updated CAIP-25 caveat value with the added Ethereum chainID.\n */\nexport const addPermittedEthChainId = (\n  caip25CaveatValue: Caip25CaveatValue,\n  chainId: Hex,\n): Caip25CaveatValue => {\n  const scopeString = `eip155:${hexToBigInt(chainId).toString(10)}`;\n  if (\n    Object.keys(caip25CaveatValue.requiredScopes).includes(scopeString) ||\n    Object.keys(caip25CaveatValue.optionalScopes).includes(scopeString)\n  ) {\n    return caip25CaveatValue;\n  }\n\n  return {\n    ...caip25CaveatValue,\n    optionalScopes: {\n      ...caip25CaveatValue.optionalScopes,\n      [scopeString]: {\n        accounts: [],\n      },\n    },\n  };\n};\n\n/**\n * Filters the scopes object to only include:\n * - Scopes without references (e.g. \"wallet:\")\n * - EIP155 scopes for the given chainIDs\n * - Non EIP155 scopes (e.g. \"bip122:\" or any other non ethereum namespaces)\n *\n * @param scopesObject - The scopes object to filter.\n * @param chainIds - The chainIDs to filter EIP155 scopes by.\n * @returns The filtered scopes object.\n */\nconst filterEthScopesObjectByChainId = (\n  scopesObject: InternalScopesObject,\n  chainIds: Hex[],\n): InternalScopesObject => {\n  const updatedScopesObject: InternalScopesObject = {};\n\n  Object.entries(scopesObject).forEach(([key, scopeObject]) => {\n    // Cast needed because index type is returned as `string` by `Object.entries`\n    const scopeString = key as keyof typeof scopesObject;\n    const { namespace, reference } = parseScopeString(scopeString);\n    if (!reference) {\n      updatedScopesObject[scopeString] = scopeObject;\n      return;\n    }\n    if (namespace === KnownCaipNamespace.Eip155) {\n      const chainId = toHex(reference);\n      if (chainIds.includes(chainId)) {\n        updatedScopesObject[scopeString] = scopeObject;\n      }\n    } else {\n      updatedScopesObject[scopeString] = scopeObject;\n    }\n  });\n\n  return updatedScopesObject;\n};\n\n/**\n * Sets the permitted Ethereum (EIP155 namespaced) chainIDs for the required and optional scopes.\n *\n * @param caip25CaveatValue - The CAIP-25 caveat value to set the permitted Ethereum chainIDs for.\n * @param chainIds - The Ethereum chainIDs to set as permitted.\n * @returns The updated CAIP-25 caveat value with the permitted Ethereum chainIDs.\n */\nexport const setPermittedEthChainIds = (\n  caip25CaveatValue: Caip25CaveatValue,\n  chainIds: Hex[],\n): Caip25CaveatValue => {\n  let updatedCaveatValue: Caip25CaveatValue = {\n    ...caip25CaveatValue,\n    requiredScopes: filterEthScopesObjectByChainId(\n      caip25CaveatValue.requiredScopes,\n      chainIds,\n    ),\n    optionalScopes: filterEthScopesObjectByChainId(\n      caip25CaveatValue.optionalScopes,\n      chainIds,\n    ),\n  };\n\n  chainIds.forEach((chainId) => {\n    updatedCaveatValue = addPermittedEthChainId(updatedCaveatValue, chainId);\n  });\n\n  return updatedCaveatValue;\n};\n"]}

package/dist/adapters/caip-permission-adapter-permittedChains.d.cts

@@ -0,0 +1,27 @@
+import type { Hex } from "@metamask/utils";
+import type { Caip25CaveatValue } from "../caip25Permission.cjs";
+/**
+ * Gets the Ethereum (EIP155 namespaced) chainIDs from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value from which to get the Ethereum chainIDs.
+ * @returns An array of Ethereum chainIDs.
+ */
+export declare const getPermittedEthChainIds: (caip25CaveatValue: Pick<Caip25CaveatValue, 'requiredScopes' | 'optionalScopes'>) => `0x${string}`[];
+/**
+ * Adds an Ethereum (EIP155 namespaced) chainID to the optional scopes if it is not already present
+ * in either the pre-existing required or optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to add the Ethereum chainID to.
+ * @param chainId - The Ethereum chainID to add.
+ * @returns The updated CAIP-25 caveat value with the added Ethereum chainID.
+ */
+export declare const addPermittedEthChainId: (caip25CaveatValue: Caip25CaveatValue, chainId: Hex) => Caip25CaveatValue;
+/**
+ * Sets the permitted Ethereum (EIP155 namespaced) chainIDs for the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the permitted Ethereum chainIDs for.
+ * @param chainIds - The Ethereum chainIDs to set as permitted.
+ * @returns The updated CAIP-25 caveat value with the permitted Ethereum chainIDs.
+ */
+export declare const setPermittedEthChainIds: (caip25CaveatValue: Caip25CaveatValue, chainIds: Hex[]) => Caip25CaveatValue;
+//# sourceMappingURL=caip-permission-adapter-permittedChains.d.cts.map

package/dist/adapters/caip-permission-adapter-permittedChains.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-permittedChains.d.cts","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-permittedChains.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAG3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAwB7D;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,sBACf,KACjB,iBAAiB,EACjB,gBAAgB,GAAG,gBAAgB,CACpC,oBAUF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,sBACd,iBAAiB,WAC3B,GAAG,KACX,iBAkBF,CAAC;AAuCF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,sBACf,iBAAiB,YAC1B,GAAG,EAAE,KACd,iBAkBF,CAAC"}

package/dist/adapters/caip-permission-adapter-permittedChains.d.mts

@@ -0,0 +1,27 @@
+import type { Hex } from "@metamask/utils";
+import type { Caip25CaveatValue } from "../caip25Permission.mjs";
+/**
+ * Gets the Ethereum (EIP155 namespaced) chainIDs from the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value from which to get the Ethereum chainIDs.
+ * @returns An array of Ethereum chainIDs.
+ */
+export declare const getPermittedEthChainIds: (caip25CaveatValue: Pick<Caip25CaveatValue, 'requiredScopes' | 'optionalScopes'>) => `0x${string}`[];
+/**
+ * Adds an Ethereum (EIP155 namespaced) chainID to the optional scopes if it is not already present
+ * in either the pre-existing required or optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to add the Ethereum chainID to.
+ * @param chainId - The Ethereum chainID to add.
+ * @returns The updated CAIP-25 caveat value with the added Ethereum chainID.
+ */
+export declare const addPermittedEthChainId: (caip25CaveatValue: Caip25CaveatValue, chainId: Hex) => Caip25CaveatValue;
+/**
+ * Sets the permitted Ethereum (EIP155 namespaced) chainIDs for the required and optional scopes.
+ *
+ * @param caip25CaveatValue - The CAIP-25 caveat value to set the permitted Ethereum chainIDs for.
+ * @param chainIds - The Ethereum chainIDs to set as permitted.
+ * @returns The updated CAIP-25 caveat value with the permitted Ethereum chainIDs.
+ */
+export declare const setPermittedEthChainIds: (caip25CaveatValue: Caip25CaveatValue, chainIds: Hex[]) => Caip25CaveatValue;
+//# sourceMappingURL=caip-permission-adapter-permittedChains.d.mts.map

package/dist/adapters/caip-permission-adapter-permittedChains.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-permission-adapter-permittedChains.d.mts","sourceRoot":"","sources":["../../src/adapters/caip-permission-adapter-permittedChains.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAG3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAwB7D;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,sBACf,KACjB,iBAAiB,EACjB,gBAAgB,GAAG,gBAAgB,CACpC,oBAUF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,sBACd,iBAAiB,WAC3B,GAAG,KACX,iBAkBF,CAAC;AAuCF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,sBACf,iBAAiB,YAC1B,GAAG,EAAE,KACd,iBAkBF,CAAC"}