@metamask-previews/keyring-api 23.3.0-e51c895 → 23.4.0-5951828

package/dist/v2/api/keyring-snap-rpc.d.mts

@@ -0,0 +1,545 @@
+import type { AccountId, JsonRpcRequest } from "@metamask/keyring-utils";
+import type { Infer } from "@metamask/superstruct";
+import type { ResolvedAccountAddress } from "../../api/address.mjs";
+import type { Balance } from "../../api/balance.mjs";
+import type { CaipAssetType, CaipAssetTypeOrId, CaipChainId } from "../../api/caip.mjs";
+import type { Pagination } from "../../api/pagination.mjs";
+import type { TransactionsPage } from "../../api/transaction.mjs";
+import type { KeyringRpc, KeyringRpcRequests } from "./keyring-rpc.mjs";
+/**
+ * All keyring RPC methods available to a Snap - includes the base
+ * {@link KeyringRpcMethod} set plus snap-specific extensions.
+ */
+export declare const KeyringSnapRpcMethod: {
+    readonly SetSelectedAccounts: "keyring_setSelectedAccounts";
+    readonly GetAccountTransactions: "keyring_getAccountTransactions";
+    readonly GetAccountAssets: "keyring_getAccountAssets";
+    readonly GetAccountBalances: "keyring_getAccountBalances";
+    readonly ResolveAccountAddress: "keyring_resolveAccountAddress";
+    readonly GetAccounts: "keyring_getAccounts";
+    readonly CreateAccounts: "keyring_createAccounts";
+    readonly GetAccount: "keyring_getAccount";
+    readonly DeleteAccount: "keyring_deleteAccount";
+    readonly ExportAccount: "keyring_exportAccount";
+    readonly SubmitRequest: "keyring_submitRequest";
+};
+/**
+ * All keyring RPC methods available to a Snap.
+ */
+export type KeyringSnapRpcMethod = (typeof KeyringSnapRpcMethod)[keyof typeof KeyringSnapRpcMethod];
+/**
+ * Check if a method is a Snap keyring RPC method (v2).
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a Snap keyring RPC method (v2).
+ */
+export declare function isKeyringSnapRpcMethod(method: string): method is KeyringSnapRpcMethod;
+export declare const SetSelectedAccountsRequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_setSelectedAccounts";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        accounts: string[];
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_setSelectedAccounts", "keyring_setSelectedAccounts">;
+    params: import("@metamask/superstruct").Struct<{
+        accounts: string[];
+    }, {
+        accounts: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type SetSelectedAccountsRequest = Infer<typeof SetSelectedAccountsRequestStruct>;
+export declare const SetSelectedAccountsResponseStruct: import("@metamask/superstruct").Struct<null, null>;
+export type SetSelectedAccountsResponse = Infer<typeof SetSelectedAccountsResponseStruct>;
+export declare const GetAccountTransactionsRequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_getAccountTransactions";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+        pagination: {
+            limit: number;
+            next?: string | null;
+        };
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_getAccountTransactions", "keyring_getAccountTransactions">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+        pagination: {
+            limit: number;
+            next?: string | null;
+        };
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        pagination: import("@metamask/superstruct").Struct<{
+            limit: number;
+            next?: string | null;
+        }, {
+            limit: import("@metamask/superstruct").Struct<number, null>;
+            next: import("@metamask/superstruct").ExactOptionalStruct<string | null, null>;
+        }>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type GetAccountTransactionsRequest = Infer<typeof GetAccountTransactionsRequestStruct>;
+export declare const GetAccountTransactionsResponseStruct: import("@metamask/superstruct").Struct<{
+    data: {
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "token:disapprove";
+        id: string;
+        from: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        account: string;
+        timestamp: number | null;
+        to: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        fees: {
+            type: "base" | "priority";
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            };
+        }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+            typeLabel?: string;
+        };
+    }[];
+    next: string | null;
+}, {
+    data: import("@metamask/superstruct").Struct<{
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "token:disapprove";
+        id: string;
+        from: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        account: string;
+        timestamp: number | null;
+        to: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        fees: {
+            type: "base" | "priority";
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            };
+        }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+            typeLabel?: string;
+        };
+    }[], import("@metamask/superstruct").Struct<{
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "token:disapprove";
+        id: string;
+        from: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        account: string;
+        timestamp: number | null;
+        to: {
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[];
+        fees: {
+            type: "base" | "priority";
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            };
+        }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+            typeLabel?: string;
+        };
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        chain: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+        account: import("@metamask/superstruct").Struct<string, null>;
+        status: import("@metamask/superstruct").Struct<"submitted" | "unconfirmed" | "confirmed" | "failed", {
+            submitted: "submitted";
+            unconfirmed: "unconfirmed";
+            confirmed: "confirmed";
+            failed: "failed";
+        }>;
+        timestamp: import("@metamask/superstruct").Struct<number | null, null>;
+        type: import("@metamask/superstruct").Struct<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "token:disapprove", {
+            unknown: "unknown";
+            send: "send";
+            receive: "receive";
+            swap: "swap";
+            "bridge:send": "bridge:send";
+            "bridge:receive": "bridge:receive";
+            "stake:deposit": "stake:deposit";
+            "stake:withdraw": "stake:withdraw";
+            "token:approve": "token:approve";
+            "token:disapprove": "token:disapprove";
+        }>;
+        from: import("@metamask/superstruct").Struct<{
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[], import("@metamask/superstruct").Struct<{
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }, {
+            address: import("@metamask/superstruct").Struct<string, null>;
+            asset: import("@metamask/superstruct").Struct<{
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null, null>;
+        }>>;
+        to: import("@metamask/superstruct").Struct<{
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }[], import("@metamask/superstruct").Struct<{
+            address: string;
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null;
+        }, {
+            address: import("@metamask/superstruct").Struct<string, null>;
+            asset: import("@metamask/superstruct").Struct<{
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            } | null, null>;
+        }>>;
+        fees: import("@metamask/superstruct").Struct<{
+            type: "base" | "priority";
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            };
+        }[], import("@metamask/superstruct").Struct<{
+            type: "base" | "priority";
+            asset: {
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            };
+        }, {
+            type: import("@metamask/superstruct").Struct<"base" | "priority", {
+                base: "base";
+                priority: "priority";
+            }>;
+            asset: import("@metamask/superstruct").Struct<{
+                unit: string;
+                type: `${string}:${string}/${string}:${string}`;
+                amount: string;
+                fungible: true;
+            } | {
+                id: `${string}:${string}/${string}:${string}/${string}`;
+                fungible: false;
+            }, null>;
+        }>>;
+        events: import("@metamask/superstruct").Struct<{
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[], import("@metamask/superstruct").Struct<{
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }, {
+            status: import("@metamask/superstruct").Struct<"submitted" | "unconfirmed" | "confirmed" | "failed", {
+                submitted: "submitted";
+                unconfirmed: "unconfirmed";
+                confirmed: "confirmed";
+                failed: "failed";
+            }>;
+            timestamp: import("@metamask/superstruct").Struct<number | null, null>;
+        }>>;
+        details: import("@metamask/superstruct").ExactOptionalStruct<{
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+            typeLabel?: string;
+        }, {
+            origin: import("@metamask/superstruct").ExactOptionalStruct<string, null>;
+            securityAlertResponse: import("@metamask/superstruct").ExactOptionalStruct<"Benign" | "Warning" | "Malicious", {
+                Benign: "Benign";
+                Warning: "Warning";
+                Malicious: "Malicious";
+            }>;
+            typeLabel: import("@metamask/superstruct").ExactOptionalStruct<string, null>;
+        }>;
+    }>>;
+    next: import("@metamask/superstruct").Struct<string | null, null>;
+}>;
+export type GetAccountTransactionsResponse = Infer<typeof GetAccountTransactionsResponseStruct>;
+export declare const GetAccountAssetsRequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_getAccountAssets";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_getAccountAssets", "keyring_getAccountAssets">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type GetAccountAssetsRequest = Infer<typeof GetAccountAssetsRequestStruct>;
+export declare const GetAccountAssetsResponseStruct: import("@metamask/superstruct").Struct<(`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[], import("@metamask/superstruct").Struct<`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`, null>>;
+export type GetAccountAssetsResponse = Infer<typeof GetAccountAssetsResponseStruct>;
+export declare const GetAccountBalancesRequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_getAccountBalances";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+        assets: `${string}:${string}/${string}:${string}`[];
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_getAccountBalances", "keyring_getAccountBalances">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+        assets: `${string}:${string}/${string}:${string}`[];
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        assets: import("@metamask/superstruct").Struct<`${string}:${string}/${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}/${string}:${string}`, null>>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type GetAccountBalancesRequest = Infer<typeof GetAccountBalancesRequestStruct>;
+export declare const GetAccountBalancesResponseStruct: import("@metamask/superstruct").Struct<Record<`${string}:${string}/${string}:${string}`, {
+    unit: string;
+    amount: string;
+}>, null>;
+export type GetAccountBalancesResponse = Infer<typeof GetAccountBalancesResponseStruct>;
+export declare const ResolveAccountAddressRequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_resolveAccountAddress";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        request: {
+            method: string;
+            id: string | number | null;
+            jsonrpc: "2.0";
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        };
+        scope: `${string}:${string}`;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_resolveAccountAddress", "keyring_resolveAccountAddress">;
+    params: import("@metamask/superstruct").Struct<{
+        request: {
+            method: string;
+            id: string | number | null;
+            jsonrpc: "2.0";
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        };
+        scope: `${string}:${string}`;
+    }, {
+        scope: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+        request: import("@metamask/superstruct").Struct<{
+            method: string;
+            id: string | number | null;
+            jsonrpc: "2.0";
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        }, {
+            jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+            id: import("@metamask/superstruct").Struct<string | number | null, null>;
+            method: import("@metamask/superstruct").Struct<string, null>;
+            params: import("@metamask/superstruct").ExactOptionalStruct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[], null>;
+        }>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type ResolveAccountAddressRequest = Infer<typeof ResolveAccountAddressRequestStruct>;
+export declare const ResolveAccountAddressResponseStruct: import("@metamask/superstruct").Struct<{
+    address: `${string}:${string}:${string}`;
+} | null, {
+    address: import("@metamask/superstruct").Struct<`${string}:${string}:${string}`, null>;
+}>;
+export type ResolveAccountAddressResponse = Infer<typeof ResolveAccountAddressResponseStruct>;
+/**
+ * All keyring RPC requests available to a Snap - includes base
+ * {@link KeyringRpcRequests} plus snap-specific request types.
+ */
+export type KeyringSnapRpcRequests = KeyringRpcRequests | SetSelectedAccountsRequest | GetAccountTransactionsRequest | GetAccountAssetsRequest | GetAccountBalancesRequest | ResolveAccountAddressRequest;
+/**
+ * Extract the proper request type for a given {@link KeyringSnapRpcMethod}.
+ */
+export type KeyringSnapRpcRequest<RpcMethod extends KeyringSnapRpcMethod> = Extract<KeyringSnapRpcRequests, {
+    method: `${RpcMethod}`;
+}>;
+/**
+ * Snap keyring RPC interface - extends the base {@link KeyringRpc} with
+ * optional snap-specific methods that a Snap may expose.
+ */
+export type KeyringSnapRpc = KeyringRpc & {
+    /**
+     * Notify the Snap of the currently selected accounts.
+     * Maps to `keyring_setSelectedAccounts`.
+     */
+    setSelectedAccounts?: (accounts: AccountId[]) => Promise<void>;
+    /**
+     * Get transactions for an account with pagination.
+     * Maps to `keyring_getAccountTransactions`.
+     */
+    getAccountTransactions?: (id: AccountId, pagination: Pagination) => Promise<TransactionsPage>;
+    /**
+     * Get the asset types supported by an account.
+     * Maps to `keyring_getAccountAssets`.
+     */
+    getAccountAssets?: (id: AccountId) => Promise<CaipAssetTypeOrId[]>;
+    /**
+     * Get balances for an account for the requested asset types.
+     * Maps to `keyring_getAccountBalances`.
+     */
+    getAccountBalances?: (id: AccountId, assets: CaipAssetType[]) => Promise<Record<CaipAssetType, Balance>>;
+    /**
+     * Resolve the account address to use for routing a signing request.
+     * Maps to `keyring_resolveAccountAddress`.
+     */
+    resolveAccountAddress?: (scope: CaipChainId, request: JsonRpcRequest) => Promise<ResolvedAccountAddress | null>;
+};
+//# sourceMappingURL=keyring-snap-rpc.d.mts.map

package/dist/v2/api/keyring-snap-rpc.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-snap-rpc.d.mts","sourceRoot":"","sources":["../../../src/v2/api/keyring-snap-rpc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,gCAAgC;AAEzE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAanD,OAAO,KAAK,EAAE,sBAAsB,EAAE,8BAA0B;AAEhE,OAAO,KAAK,EAAE,OAAO,EAAE,8BAA0B;AAMjD,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EACjB,WAAW,EACZ,2BAAuB;AAExB,OAAO,KAAK,EAAE,UAAU,EAAE,iCAA6B;AAEvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,kCAA8B;AAE9D,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,0BAAsB;AAEpE;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;CAOvB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC9B,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,GACb,MAAM,IAAI,oBAAoB,CAIhC;AAYD,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;EAM3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAC5C,OAAO,gCAAgC,CACxC,CAAC;AAEF,eAAO,MAAM,iCAAiC,oDAAgB,CAAC;AAE/D,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAKF,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAO9C,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAC/C,OAAO,mCAAmC,CAC3C,CAAC;AAEF,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyB,CAAC;AAE3E,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAChD,OAAO,oCAAoC,CAC5C,CAAC;AAKF,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;EAMxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,8BAA8B,4RAAiC,CAAC;AAE7E,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAC1C,OAAO,8BAA8B,CACtC,CAAC;AAKF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;EAO1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF,eAAO,MAAM,gCAAgC;;;SAG5C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAC5C,OAAO,gCAAgC,CACxC,CAAC;AAKF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAO7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF,eAAO,MAAM,mCAAmC;;;;EAE/C,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAC/C,OAAO,mCAAmC,CAC3C,CAAC;AAIF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,0BAA0B,GAC1B,6BAA6B,GAC7B,uBAAuB,GACvB,yBAAyB,GACzB,4BAA4B,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,SAAS,SAAS,oBAAoB,IACtE,OAAO,CAAC,sBAAsB,EAAE;IAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE,CAAC,CAAC;AAI9D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG;IACxC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CACvB,EAAE,EAAE,SAAS,EACb,UAAU,EAAE,UAAU,KACnB,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE/B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,KAAK,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAEnE;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CACnB,EAAE,EAAE,SAAS,EACb,MAAM,EAAE,aAAa,EAAE,KACpB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CACtB,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;CAC7C,CAAC"}

package/dist/v2/api/keyring-snap-rpc.mjs

@@ -0,0 +1,88 @@
+import { UuidStruct, JsonRpcRequestStruct } from "@metamask/keyring-utils";
+import { array, literal, nullable, number, object, record, string, union } from "@metamask/superstruct";
+import { ResolvedAccountAddressStruct } from "../../api/address.mjs";
+import { BalanceStruct } from "../../api/balance.mjs";
+import { CaipAssetTypeOrIdStruct, CaipAssetTypeStruct, CaipChainIdStruct } from "../../api/caip.mjs";
+import { PaginationStruct } from "../../api/pagination.mjs";
+import { TransactionsPageStruct } from "../../api/transaction.mjs";
+import { KeyringRpcMethod } from "./keyring-rpc.mjs";
+/**
+ * All keyring RPC methods available to a Snap - includes the base
+ * {@link KeyringRpcMethod} set plus snap-specific extensions.
+ */
+export const KeyringSnapRpcMethod = {
+    ...KeyringRpcMethod,
+    SetSelectedAccounts: 'keyring_setSelectedAccounts',
+    GetAccountTransactions: 'keyring_getAccountTransactions',
+    GetAccountAssets: 'keyring_getAccountAssets',
+    GetAccountBalances: 'keyring_getAccountBalances',
+    ResolveAccountAddress: 'keyring_resolveAccountAddress',
+};
+/**
+ * Check if a method is a Snap keyring RPC method (v2).
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a Snap keyring RPC method (v2).
+ */
+export function isKeyringSnapRpcMethod(method) {
+    return Object.values(KeyringSnapRpcMethod).includes(method);
+}
+// ----------------------------------------------------------------------------
+const CommonHeader = {
+    jsonrpc: literal('2.0'),
+    id: union([string(), number(), literal(null)]),
+};
+// ----------------------------------------------------------------------------
+// Set selected accounts
+export const SetSelectedAccountsRequestStruct = object({
+    ...CommonHeader,
+    method: literal(`${KeyringSnapRpcMethod.SetSelectedAccounts}`),
+    params: object({
+        accounts: array(string()),
+    }),
+});
+export const SetSelectedAccountsResponseStruct = literal(null);
+// ----------------------------------------------------------------------------
+// Get account transactions
+export const GetAccountTransactionsRequestStruct = object({
+    ...CommonHeader,
+    method: literal(`${KeyringSnapRpcMethod.GetAccountTransactions}`),
+    params: object({
+        id: UuidStruct,
+        pagination: PaginationStruct,
+    }),
+});
+export const GetAccountTransactionsResponseStruct = TransactionsPageStruct;
+// ----------------------------------------------------------------------------
+// Get account assets
+export const GetAccountAssetsRequestStruct = object({
+    ...CommonHeader,
+    method: literal(`${KeyringSnapRpcMethod.GetAccountAssets}`),
+    params: object({
+        id: UuidStruct,
+    }),
+});
+export const GetAccountAssetsResponseStruct = array(CaipAssetTypeOrIdStruct);
+// ----------------------------------------------------------------------------
+// Get account balances
+export const GetAccountBalancesRequestStruct = object({
+    ...CommonHeader,
+    method: literal(`${KeyringSnapRpcMethod.GetAccountBalances}`),
+    params: object({
+        id: UuidStruct,
+        assets: array(CaipAssetTypeStruct),
+    }),
+});
+export const GetAccountBalancesResponseStruct = record(CaipAssetTypeStruct, BalanceStruct);
+// ----------------------------------------------------------------------------
+// Resolve account address
+export const ResolveAccountAddressRequestStruct = object({
+    ...CommonHeader,
+    method: literal(`${KeyringSnapRpcMethod.ResolveAccountAddress}`),
+    params: object({
+        scope: CaipChainIdStruct,
+        request: JsonRpcRequestStruct,
+    }),
+});
+export const ResolveAccountAddressResponseStruct = nullable(ResolvedAccountAddressStruct);
+//# sourceMappingURL=keyring-snap-rpc.mjs.map

package/dist/v2/api/keyring-snap-rpc.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-snap-rpc.mjs","sourceRoot":"","sources":["../../../src/v2/api/keyring-snap-rpc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,gCAAgC;AAE3E,OAAO,EACL,KAAK,EACL,OAAO,EACP,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACN,8BAA8B;AAE/B,OAAO,EAAE,4BAA4B,EAAE,8BAA0B;AAEjE,OAAO,EAAE,aAAa,EAAE,8BAA0B;AAElD,OAAO,EACL,uBAAuB,EACvB,mBAAmB,EACnB,iBAAiB,EAClB,2BAAuB;AAMxB,OAAO,EAAE,gBAAgB,EAAE,iCAA6B;AAExD,OAAO,EAAE,sBAAsB,EAAE,kCAA8B;AAE/D,OAAO,EAAE,gBAAgB,EAAE,0BAAsB;AAGjD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,GAAG,gBAAgB;IACnB,mBAAmB,EAAE,6BAA6B;IAClD,sBAAsB,EAAE,gCAAgC;IACxD,gBAAgB,EAAE,0BAA0B;IAC5C,kBAAkB,EAAE,4BAA4B;IAChD,qBAAqB,EAAE,+BAA+B;CAC9C,CAAC;AAQX;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc;IAEd,OAAO,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CACjD,MAA8B,CAC/B,CAAC;AACJ,CAAC;AAED,+EAA+E;AAE/E,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;IACvB,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;CAC/C,CAAC;AAEF,+EAA+E;AAC/E,wBAAwB;AAExB,MAAM,CAAC,MAAM,gCAAgC,GAAG,MAAM,CAAC;IACrD,GAAG,YAAY;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,mBAAmB,EAAE,CAAC;IAC9D,MAAM,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;KAC1B,CAAC;CACH,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAM/D,+EAA+E;AAC/E,2BAA2B;AAE3B,MAAM,CAAC,MAAM,mCAAmC,GAAG,MAAM,CAAC;IACxD,GAAG,YAAY;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,sBAAsB,EAAE,CAAC;IACjE,MAAM,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,UAAU;QACd,UAAU,EAAE,gBAAgB;KAC7B,CAAC;CACH,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,oCAAoC,GAAG,sBAAsB,CAAC;AAM3E,+EAA+E;AAC/E,qBAAqB;AAErB,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC;IAClD,GAAG,YAAY;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,gBAAgB,EAAE,CAAC;IAC3D,MAAM,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,UAAU;KACf,CAAC;CACH,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,8BAA8B,GAAG,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAM7E,+EAA+E;AAC/E,uBAAuB;AAEvB,MAAM,CAAC,MAAM,+BAA+B,GAAG,MAAM,CAAC;IACpD,GAAG,YAAY;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,UAAU;QACd,MAAM,EAAE,KAAK,CAAC,mBAAmB,CAAC;KACnC,CAAC;CACH,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,gCAAgC,GAAG,MAAM,CACpD,mBAAmB,EACnB,aAAa,CACd,CAAC;AAMF,+EAA+E;AAC/E,0BAA0B;AAE1B,MAAM,CAAC,MAAM,kCAAkC,GAAG,MAAM,CAAC;IACvD,GAAG,YAAY;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,qBAAqB,EAAE,CAAC;IAChE,MAAM,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,iBAAiB;QACxB,OAAO,EAAE,oBAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,mCAAmC,GAAG,QAAQ,CACzD,4BAA4B,CAC7B,CAAC","sourcesContent":["import type { AccountId, JsonRpcRequest } from '@metamask/keyring-utils';\nimport { UuidStruct, JsonRpcRequestStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  literal,\n  nullable,\n  number,\n  object,\n  record,\n  string,\n  union,\n} from '@metamask/superstruct';\n\nimport { ResolvedAccountAddressStruct } from '../../api/address';\nimport type { ResolvedAccountAddress } from '../../api/address';\nimport { BalanceStruct } from '../../api/balance';\nimport type { Balance } from '../../api/balance';\nimport {\n  CaipAssetTypeOrIdStruct,\n  CaipAssetTypeStruct,\n  CaipChainIdStruct,\n} from '../../api/caip';\nimport type {\n  CaipAssetType,\n  CaipAssetTypeOrId,\n  CaipChainId,\n} from '../../api/caip';\nimport { PaginationStruct } from '../../api/pagination';\nimport type { Pagination } from '../../api/pagination';\nimport { TransactionsPageStruct } from '../../api/transaction';\nimport type { TransactionsPage } from '../../api/transaction';\nimport { KeyringRpcMethod } from './keyring-rpc';\nimport type { KeyringRpc, KeyringRpcRequests } from './keyring-rpc';\n\n/**\n * All keyring RPC methods available to a Snap - includes the base\n * {@link KeyringRpcMethod} set plus snap-specific extensions.\n */\nexport const KeyringSnapRpcMethod = {\n  ...KeyringRpcMethod,\n  SetSelectedAccounts: 'keyring_setSelectedAccounts',\n  GetAccountTransactions: 'keyring_getAccountTransactions',\n  GetAccountAssets: 'keyring_getAccountAssets',\n  GetAccountBalances: 'keyring_getAccountBalances',\n  ResolveAccountAddress: 'keyring_resolveAccountAddress',\n} as const;\n\n/**\n * All keyring RPC methods available to a Snap.\n */\nexport type KeyringSnapRpcMethod =\n  (typeof KeyringSnapRpcMethod)[keyof typeof KeyringSnapRpcMethod];\n\n/**\n * Check if a method is a Snap keyring RPC method (v2).\n *\n * @param method - Method to check.\n * @returns Whether the method is a Snap keyring RPC method (v2).\n */\nexport function isKeyringSnapRpcMethod(\n  method: string,\n): method is KeyringSnapRpcMethod {\n  return Object.values(KeyringSnapRpcMethod).includes(\n    method as KeyringSnapRpcMethod,\n  );\n}\n\n// ----------------------------------------------------------------------------\n\nconst CommonHeader = {\n  jsonrpc: literal('2.0'),\n  id: union([string(), number(), literal(null)]),\n};\n\n// ----------------------------------------------------------------------------\n// Set selected accounts\n\nexport const SetSelectedAccountsRequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringSnapRpcMethod.SetSelectedAccounts}`),\n  params: object({\n    accounts: array(string()),\n  }),\n});\n\nexport type SetSelectedAccountsRequest = Infer<\n  typeof SetSelectedAccountsRequestStruct\n>;\n\nexport const SetSelectedAccountsResponseStruct = literal(null);\n\nexport type SetSelectedAccountsResponse = Infer<\n  typeof SetSelectedAccountsResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Get account transactions\n\nexport const GetAccountTransactionsRequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringSnapRpcMethod.GetAccountTransactions}`),\n  params: object({\n    id: UuidStruct,\n    pagination: PaginationStruct,\n  }),\n});\n\nexport type GetAccountTransactionsRequest = Infer<\n  typeof GetAccountTransactionsRequestStruct\n>;\n\nexport const GetAccountTransactionsResponseStruct = TransactionsPageStruct;\n\nexport type GetAccountTransactionsResponse = Infer<\n  typeof GetAccountTransactionsResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Get account assets\n\nexport const GetAccountAssetsRequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringSnapRpcMethod.GetAccountAssets}`),\n  params: object({\n    id: UuidStruct,\n  }),\n});\n\nexport type GetAccountAssetsRequest = Infer<\n  typeof GetAccountAssetsRequestStruct\n>;\n\nexport const GetAccountAssetsResponseStruct = array(CaipAssetTypeOrIdStruct);\n\nexport type GetAccountAssetsResponse = Infer<\n  typeof GetAccountAssetsResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Get account balances\n\nexport const GetAccountBalancesRequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringSnapRpcMethod.GetAccountBalances}`),\n  params: object({\n    id: UuidStruct,\n    assets: array(CaipAssetTypeStruct),\n  }),\n});\n\nexport type GetAccountBalancesRequest = Infer<\n  typeof GetAccountBalancesRequestStruct\n>;\n\nexport const GetAccountBalancesResponseStruct = record(\n  CaipAssetTypeStruct,\n  BalanceStruct,\n);\n\nexport type GetAccountBalancesResponse = Infer<\n  typeof GetAccountBalancesResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Resolve account address\n\nexport const ResolveAccountAddressRequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringSnapRpcMethod.ResolveAccountAddress}`),\n  params: object({\n    scope: CaipChainIdStruct,\n    request: JsonRpcRequestStruct,\n  }),\n});\n\nexport type ResolveAccountAddressRequest = Infer<\n  typeof ResolveAccountAddressRequestStruct\n>;\n\nexport const ResolveAccountAddressResponseStruct = nullable(\n  ResolvedAccountAddressStruct,\n);\n\nexport type ResolveAccountAddressResponse = Infer<\n  typeof ResolveAccountAddressResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n\n/**\n * All keyring RPC requests available to a Snap - includes base\n * {@link KeyringRpcRequests} plus snap-specific request types.\n */\nexport type KeyringSnapRpcRequests =\n  | KeyringRpcRequests\n  | SetSelectedAccountsRequest\n  | GetAccountTransactionsRequest\n  | GetAccountAssetsRequest\n  | GetAccountBalancesRequest\n  | ResolveAccountAddressRequest;\n\n/**\n * Extract the proper request type for a given {@link KeyringSnapRpcMethod}.\n */\nexport type KeyringSnapRpcRequest<RpcMethod extends KeyringSnapRpcMethod> =\n  Extract<KeyringSnapRpcRequests, { method: `${RpcMethod}` }>;\n\n// ----------------------------------------------------------------------------\n\n/**\n * Snap keyring RPC interface - extends the base {@link KeyringRpc} with\n * optional snap-specific methods that a Snap may expose.\n */\nexport type KeyringSnapRpc = KeyringRpc & {\n  /**\n   * Notify the Snap of the currently selected accounts.\n   * Maps to `keyring_setSelectedAccounts`.\n   */\n  setSelectedAccounts?: (accounts: AccountId[]) => Promise<void>;\n\n  /**\n   * Get transactions for an account with pagination.\n   * Maps to `keyring_getAccountTransactions`.\n   */\n  getAccountTransactions?: (\n    id: AccountId,\n    pagination: Pagination,\n  ) => Promise<TransactionsPage>;\n\n  /**\n   * Get the asset types supported by an account.\n   * Maps to `keyring_getAccountAssets`.\n   */\n  getAccountAssets?: (id: AccountId) => Promise<CaipAssetTypeOrId[]>;\n\n  /**\n   * Get balances for an account for the requested asset types.\n   * Maps to `keyring_getAccountBalances`.\n   */\n  getAccountBalances?: (\n    id: AccountId,\n    assets: CaipAssetType[],\n  ) => Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Resolve the account address to use for routing a signing request.\n   * Maps to `keyring_resolveAccountAddress`.\n   */\n  resolveAccountAddress?: (\n    scope: CaipChainId,\n    request: JsonRpcRequest,\n  ) => Promise<ResolvedAccountAddress | null>;\n};\n"]}