@metamask-previews/gator-permissions-controller 0.0.0-preview-2a00636 → 0.1.0-preview-d71561e3

package/dist/types.d.mts

@@ -1,3 +1,4 @@
+import type { PermissionTypes, Signer, BasePermission, NativeTokenStreamPermission, NativeTokenPeriodicPermission, Erc20TokenStreamPermission, Erc20TokenPeriodicPermission, Rule, MetaMaskBasePermissionData } from "@metamask/7715-permission-types";
 import type { Hex } from "@metamask/utils";
 /**
  * Enum for the error codes of the gator permissions controller.
@@ -17,92 +18,24 @@ export declare enum GatorPermissionsSnapRpcMethod {
      */
     PermissionProviderGetGrantedPermissions = "permissionsProvider_getGrantedPermissions"
 }
-type BasePermission = {
-    type: string;
-    /**
-     * Data structure varies by permission type.
-     */
-    data: Record<string, unknown>;
-    /**
-     * set of restrictions or conditions that a signer must abide by when redeeming a Permission.
-     */
-    rules?: Record<string, unknown>;
-};
-export type MetaMaskBasePermissionData = {
-    /**
-     * A human-readable explanation of why the permission is being requested.
-     */
-    justification: string;
-};
-export type NativeTokenStreamPermission = BasePermission & {
-    type: 'native-token-stream';
-    data: MetaMaskBasePermissionData & {
-        initialAmount?: Hex;
-        maxAmount?: Hex;
-        amountPerSecond: Hex;
-        startTime: number;
-    };
-};
-export type NativeTokenPeriodicPermission = BasePermission & {
-    type: 'native-token-periodic';
-    data: MetaMaskBasePermissionData & {
-        periodAmount: Hex;
-        periodDuration: number;
-        startTime: number;
-    };
-};
-export type Erc20TokenStreamPermission = BasePermission & {
-    type: 'erc20-token-stream';
-    data: MetaMaskBasePermissionData & {
-        initialAmount?: Hex;
-        maxAmount?: Hex;
-        amountPerSecond: Hex;
-        startTime: number;
-        tokenAddress: Hex;
-    };
-};
-export type Erc20TokenPeriodicPermission = BasePermission & {
-    type: 'erc20-token-periodic';
-    data: MetaMaskBasePermissionData & {
-        periodAmount: Hex;
-        periodDuration: number;
-        startTime: number;
-        tokenAddress: Hex;
-    };
-};
+/**
+ * Represents a custom permission that are not of the standard ERC-7715 permission types.
+ */
 export type CustomPermission = BasePermission & {
     type: 'custom';
     data: MetaMaskBasePermissionData & Record<string, unknown>;
 };
 /**
- * Represents the type of the ERC-7715 permissions that can be granted.
- */
-export type PermissionTypes = NativeTokenStreamPermission | NativeTokenPeriodicPermission | Erc20TokenStreamPermission | Erc20TokenPeriodicPermission | CustomPermission;
-/**
- * Represents an ERC-7715 account signer type.
+ * Represents the type of the ERC-7715 permissions that can be granted including custom permissions.
  */
-export type AccountSigner = {
-    type: 'account';
-    data: {
-        address: Hex;
-    };
-};
-/**
- * Represents an ERC-7715 wallet signer type.
- *
- */
-export type WalletSigner = {
-    type: 'wallet';
-    data: Record<string, unknown>;
-};
-export type SignerParam = AccountSigner | WalletSigner;
+export type PermissionTypesWithCustom = PermissionTypes | CustomPermission;
 /**
  * Represents a ERC-7715 permission request.
  *
  * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.
  * @template Permission - The type of the permission provided.
  */
-export type PermissionRequest<TSigner extends SignerParam, TPermission extends PermissionTypes> = {
+export type PermissionRequest<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     /**
      * hex-encoding of uint256 defined the chain with EIP-155
      */
@@ -113,14 +46,6 @@ export type PermissionRequest<TSigner extends SignerParam, TPermission extends P
      * It is optional to let the user choose which account to grant permission from.
      */
     address?: Hex;
-    /**
-     * unix timestamp in seconds
-     */
-    expiry: number;
-    /**
-     * Boolean value that allows DApp to define whether the permission can be attenuated–adjusted to meet the user’s terms.
-     */
-    isAdjustmentAllowed: boolean;
     /**
      * An account that is associated with the recipient of the granted 7715 permission or alternatively the wallet will manage the session.
      */
@@ -129,6 +54,7 @@ export type PermissionRequest<TSigner extends SignerParam, TPermission extends P
      * Defines the allowed behavior the signer can do on behalf of the account.
      */
     permission: TPermission;
+    rules?: Rule[] | null;
 };
 /**
  * Represents a ERC-7715 permission response.
@@ -136,20 +62,20 @@ export type PermissionRequest<TSigner extends SignerParam, TPermission extends P
  * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.
  * @template Permission - The type of the permission provided.
  */
-export type PermissionResponse<TSigner extends SignerParam, TPermission extends PermissionTypes> = PermissionRequest<TSigner, TPermission> & {
+export type PermissionResponse<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = PermissionRequest<TSigner, TPermission> & {
     /**
      * Is a catch-all to identify a permission for revoking permissions or submitting
      * Defined in ERC-7710.
      */
     context: Hex;
     /**
-     * The accountMeta field is required and contains information needed to deploy accounts.
+     * The dependencyInfo field is required and contains information needed to deploy accounts.
      * Each entry specifies a factory contract and its associated deployment data.
      * If no account deployment is needed when redeeming the permission, this array must be empty.
      * When non-empty, DApps MUST deploy the accounts by calling the factory contract with factoryData as the calldata.
      * Defined in ERC-4337.
      */
-    accountMeta: {
+    dependencyInfo: {
         factory: Hex;
         factoryData: Hex;
     }[];
@@ -167,14 +93,14 @@ export type PermissionResponse<TSigner extends SignerParam, TPermission extends
  * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.
  * @template Permission - The type of the permission provided.
  */
-export type PermissionResponseSanitized<TSigner extends SignerParam, TPermission extends PermissionTypes> = Omit<PermissionResponse<TSigner, TPermission>, 'isAdjustmentAllowed' | 'accountMeta' | 'signer'>;
+export type PermissionResponseSanitized<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = Omit<PermissionResponse<TSigner, TPermission>, 'dependencyInfo' | 'signer' | 'rules'>;
 /**
  * Represents a gator ERC-7715 granted(ie. signed by an user account) permission entry that is stored in profile sync.
  *
  * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.
  * @template Permission - The type of the permission provided
  */
-export type StoredGatorPermission<TSigner extends SignerParam, TPermission extends PermissionTypes> = {
+export type StoredGatorPermission<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponse<TSigner, TPermission>;
     siteOrigin: string;
 };
@@ -184,7 +110,7 @@ export type StoredGatorPermission<TSigner extends SignerParam, TPermission exten
  * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.
  * @template Permission - The type of the permission provided.
  */
-export type StoredGatorPermissionSanitized<TSigner extends SignerParam, TPermission extends PermissionTypes> = {
+export type StoredGatorPermissionSanitized<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponseSanitized<TSigner, TPermission>;
     siteOrigin: string;
 };
@@ -193,19 +119,19 @@ export type StoredGatorPermissionSanitized<TSigner extends SignerParam, TPermiss
  */
 export type GatorPermissionsMap = {
     'native-token-stream': {
-        [chainId: Hex]: StoredGatorPermissionSanitized<SignerParam, NativeTokenStreamPermission>[];
+        [chainId: Hex]: StoredGatorPermissionSanitized<Signer, NativeTokenStreamPermission>[];
     };
     'native-token-periodic': {
-        [chainId: Hex]: StoredGatorPermissionSanitized<SignerParam, NativeTokenPeriodicPermission>[];
+        [chainId: Hex]: StoredGatorPermissionSanitized<Signer, NativeTokenPeriodicPermission>[];
     };
     'erc20-token-stream': {
-        [chainId: Hex]: StoredGatorPermissionSanitized<SignerParam, Erc20TokenStreamPermission>[];
+        [chainId: Hex]: StoredGatorPermissionSanitized<Signer, Erc20TokenStreamPermission>[];
     };
     'erc20-token-periodic': {
-        [chainId: Hex]: StoredGatorPermissionSanitized<SignerParam, Erc20TokenPeriodicPermission>[];
+        [chainId: Hex]: StoredGatorPermissionSanitized<Signer, Erc20TokenPeriodicPermission>[];
     };
     other: {
-        [chainId: Hex]: StoredGatorPermissionSanitized<SignerParam, CustomPermission>[];
+        [chainId: Hex]: StoredGatorPermissionSanitized<Signer, CustomPermission>[];
     };
 };
 /**
@@ -220,5 +146,4 @@ export type GatorPermissionsMapByPermissionType<TPermissionType extends Supporte
  * Represents an array of gator permissions for a given permission type and chainId.
  */
 export type GatorPermissionsListByPermissionTypeAndChainId<TPermissionType extends SupportedGatorPermissionType> = GatorPermissionsMap[TPermissionType][Hex];
-export {};
 //# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;CACpF;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,uCAAuC,8CAA8C;CACtF;AAED,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,0BAA0B,GAAG;QACjC,aAAa,CAAC,EAAE,GAAG,CAAC;QACpB,SAAS,CAAC,EAAE,GAAG,CAAC;QAChB,eAAe,EAAE,GAAG,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,cAAc,GAAG;IAC3D,IAAI,EAAE,uBAAuB,CAAC;IAC9B,IAAI,EAAE,0BAA0B,GAAG;QACjC,YAAY,EAAE,GAAG,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,cAAc,GAAG;IACxD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,0BAA0B,GAAG;QACjC,aAAa,CAAC,EAAE,GAAG,CAAC;QACpB,SAAS,CAAC,EAAE,GAAG,CAAC;QAChB,eAAe,EAAE,GAAG,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,GAAG,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,cAAc,GAAG;IAC1D,IAAI,EAAE,sBAAsB,CAAC;IAC7B,IAAI,EAAE,0BAA0B,GAAG;QACjC,YAAY,EAAE,GAAG,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,GAAG,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG;IAC9C,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,2BAA2B,GAC3B,6BAA6B,GAC7B,0BAA0B,GAC1B,4BAA4B,GAC5B,gBAAgB,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE;QACJ,OAAO,EAAE,GAAG,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,YAAY,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,WAAW,EAC3B,WAAW,SAAS,eAAe,IACjC;IACF;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,WAAW,EAC3B,WAAW,SAAS,eAAe,IACjC,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG;IAC5C;;;OAGG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;;;;;OAMG;IACH,WAAW,EAAE;QACX,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,GAAG,CAAC;KAClB,EAAE,CAAC;IAEJ;;OAEG;IACH,UAAU,EAAE;QACV,iBAAiB,EAAE,GAAG,CAAC;KACxB,CAAC;CACH,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,CACrC,OAAO,SAAS,WAAW,EAC3B,WAAW,SAAS,eAAe,IACjC,IAAI,CACN,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,EACxC,qBAAqB,GAAG,aAAa,GAAG,QAAQ,CACjD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,OAAO,SAAS,WAAW,EAC3B,WAAW,SAAS,eAAe,IACjC;IACF,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,CACxC,OAAO,SAAS,WAAW,EAC3B,WAAW,SAAS,eAAe,IACjC;IACF,kBAAkB,EAAE,2BAA2B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACtE,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,qBAAqB,EAAE;QACrB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,WAAW,EACX,2BAA2B,CAC5B,EAAE,CAAC;KACL,CAAC;IACF,uBAAuB,EAAE;QACvB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,WAAW,EACX,6BAA6B,CAC9B,EAAE,CAAC;KACL,CAAC;IACF,oBAAoB,EAAE;QACpB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,WAAW,EACX,0BAA0B,CAC3B,EAAE,CAAC;KACL,CAAC;IACF,sBAAsB,EAAE;QACtB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,WAAW,EACX,4BAA4B,CAC7B,EAAE,CAAC;KACL,CAAC;IACF,KAAK,EAAE;QACL,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,WAAW,EACX,gBAAgB,CACjB,EAAE,CAAC;KACL,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,mBAAmB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,mCAAmC,CAC7C,eAAe,SAAS,4BAA4B,IAClD,mBAAmB,CAAC,eAAe,CAAC,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,8CAA8C,CACxD,eAAe,SAAS,4BAA4B,IAClD,mBAAmB,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,MAAM,EACN,cAAc,EACd,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,IAAI,EACJ,0BAA0B,EAC3B,wCAAwC;AACzC,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;CACpF;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,uCAAuC,8CAA8C;CACtF;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG;IAC9C,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,MAAM,EACtB,WAAW,SAAS,yBAAyB,IAC3C;IACF;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,MAAM,EACtB,WAAW,SAAS,yBAAyB,IAC3C,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG;IAC5C;;;OAGG;IACH,OAAO,EAAE,GAAG,CAAC;IAEb;;;;;;OAMG;IACH,cAAc,EAAE;QACd,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,GAAG,CAAC;KAClB,EAAE,CAAC;IAEJ;;OAEG;IACH,UAAU,EAAE;QACV,iBAAiB,EAAE,GAAG,CAAC;KACxB,CAAC;CACH,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,CACrC,OAAO,SAAS,MAAM,EACtB,WAAW,SAAS,yBAAyB,IAC3C,IAAI,CACN,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,EACxC,gBAAgB,GAAG,QAAQ,GAAG,OAAO,CACtC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,OAAO,SAAS,MAAM,EACtB,WAAW,SAAS,yBAAyB,IAC3C;IACF,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,CACxC,OAAO,SAAS,MAAM,EACtB,WAAW,SAAS,yBAAyB,IAC3C;IACF,kBAAkB,EAAE,2BAA2B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACtE,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,qBAAqB,EAAE;QACrB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,MAAM,EACN,2BAA2B,CAC5B,EAAE,CAAC;KACL,CAAC;IACF,uBAAuB,EAAE;QACvB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,MAAM,EACN,6BAA6B,CAC9B,EAAE,CAAC;KACL,CAAC;IACF,oBAAoB,EAAE;QACpB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,MAAM,EACN,0BAA0B,CAC3B,EAAE,CAAC;KACL,CAAC;IACF,sBAAsB,EAAE;QACtB,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAC5C,MAAM,EACN,4BAA4B,CAC7B,EAAE,CAAC;KACL,CAAC;IACF,KAAK,EAAE;QACL,CAAC,OAAO,EAAE,GAAG,GAAG,8BAA8B,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;KAC5E,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,mBAAmB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,mCAAmC,CAC7C,eAAe,SAAS,4BAA4B,IAClD,mBAAmB,CAAC,eAAe,CAAC,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,8CAA8C,CACxD,eAAe,SAAS,4BAA4B,IAClD,mBAAmB,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC"}

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;AACrF,CAAC,EALW,mCAAmC,KAAnC,mCAAmC,QAK9C;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACvC;;OAEG;IACH,sHAAqF,CAAA;AACvF,CAAC,EALW,6BAA6B,KAA7B,6BAA6B,QAKxC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\n/**\n * Enum for the error codes of the gator permissions controller.\n */\nexport enum GatorPermissionsControllerErrorCode {\n  GatorPermissionsFetchError = 'gator-permissions-fetch-error',\n  GatorPermissionsNotEnabled = 'gator-permissions-not-enabled',\n  GatorPermissionsProviderError = 'gator-permissions-provider-error',\n  GatorPermissionsMapSerializationError = 'gator-permissions-map-serialization-error',\n}\n\n/**\n * Enum for the RPC methods of the gator permissions provider snap.\n */\nexport enum GatorPermissionsSnapRpcMethod {\n  /**\n   * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.\n   */\n  PermissionProviderGetGrantedPermissions = 'permissionsProvider_getGrantedPermissions',\n}\n\ntype BasePermission = {\n  type: string;\n\n  /**\n   * Data structure varies by permission type.\n   */\n  data: Record<string, unknown>;\n\n  /**\n   * set of restrictions or conditions that a signer must abide by when redeeming a Permission.\n   */\n  rules?: Record<string, unknown>;\n};\n\nexport type MetaMaskBasePermissionData = {\n  /**\n   * A human-readable explanation of why the permission is being requested.\n   */\n  justification: string;\n};\n\nexport type NativeTokenStreamPermission = BasePermission & {\n  type: 'native-token-stream';\n  data: MetaMaskBasePermissionData & {\n    initialAmount?: Hex;\n    maxAmount?: Hex;\n    amountPerSecond: Hex;\n    startTime: number;\n  };\n};\n\nexport type NativeTokenPeriodicPermission = BasePermission & {\n  type: 'native-token-periodic';\n  data: MetaMaskBasePermissionData & {\n    periodAmount: Hex;\n    periodDuration: number;\n    startTime: number;\n  };\n};\n\nexport type Erc20TokenStreamPermission = BasePermission & {\n  type: 'erc20-token-stream';\n  data: MetaMaskBasePermissionData & {\n    initialAmount?: Hex;\n    maxAmount?: Hex;\n    amountPerSecond: Hex;\n    startTime: number;\n    tokenAddress: Hex;\n  };\n};\n\nexport type Erc20TokenPeriodicPermission = BasePermission & {\n  type: 'erc20-token-periodic';\n  data: MetaMaskBasePermissionData & {\n    periodAmount: Hex;\n    periodDuration: number;\n    startTime: number;\n    tokenAddress: Hex;\n  };\n};\n\nexport type CustomPermission = BasePermission & {\n  type: 'custom';\n  data: MetaMaskBasePermissionData & Record<string, unknown>;\n};\n\n/**\n * Represents the type of the ERC-7715 permissions that can be granted.\n */\nexport type PermissionTypes =\n  | NativeTokenStreamPermission\n  | NativeTokenPeriodicPermission\n  | Erc20TokenStreamPermission\n  | Erc20TokenPeriodicPermission\n  | CustomPermission;\n\n/**\n * Represents an ERC-7715 account signer type.\n */\nexport type AccountSigner = {\n  type: 'account';\n  data: {\n    address: Hex;\n  };\n};\n\n/**\n * Represents an ERC-7715 wallet signer type.\n *\n */\nexport type WalletSigner = {\n  type: 'wallet';\n  data: Record<string, unknown>;\n};\n\nexport type SignerParam = AccountSigner | WalletSigner;\n\n/**\n * Represents a ERC-7715 permission request.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionRequest<\n  TSigner extends SignerParam,\n  TPermission extends PermissionTypes,\n> = {\n  /**\n   * hex-encoding of uint256 defined the chain with EIP-155\n   */\n  chainId: Hex;\n\n  /**\n   *\n   * The account being targeted for this permission request.\n   * It is optional to let the user choose which account to grant permission from.\n   */\n  address?: Hex;\n\n  /**\n   * unix timestamp in seconds\n   */\n  expiry: number;\n\n  /**\n   * Boolean value that allows DApp to define whether the permission can be attenuated–adjusted to meet the user’s terms.\n   */\n  isAdjustmentAllowed: boolean;\n\n  /**\n   * An account that is associated with the recipient of the granted 7715 permission or alternatively the wallet will manage the session.\n   */\n  signer: TSigner;\n\n  /**\n   * Defines the allowed behavior the signer can do on behalf of the account.\n   */\n  permission: TPermission;\n};\n\n/**\n * Represents a ERC-7715 permission response.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionResponse<\n  TSigner extends SignerParam,\n  TPermission extends PermissionTypes,\n> = PermissionRequest<TSigner, TPermission> & {\n  /**\n   * Is a catch-all to identify a permission for revoking permissions or submitting\n   * Defined in ERC-7710.\n   */\n  context: Hex;\n\n  /**\n   * The accountMeta field is required and contains information needed to deploy accounts.\n   * Each entry specifies a factory contract and its associated deployment data.\n   * If no account deployment is needed when redeeming the permission, this array must be empty.\n   * When non-empty, DApps MUST deploy the accounts by calling the factory contract with factoryData as the calldata.\n   * Defined in ERC-4337.\n   */\n  accountMeta: {\n    factory: Hex;\n    factoryData: Hex;\n  }[];\n\n  /**\n   * If the signer type is account then delegationManager is required as defined in ERC-7710.\n   */\n  signerMeta: {\n    delegationManager: Hex;\n  };\n};\n\n/**\n * Represents a sanitized version of the PermissionResponse type.\n * Some fields have been removed but the fields are still present in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionResponseSanitized<\n  TSigner extends SignerParam,\n  TPermission extends PermissionTypes,\n> = Omit<\n  PermissionResponse<TSigner, TPermission>,\n  'isAdjustmentAllowed' | 'accountMeta' | 'signer'\n>;\n\n/**\n * Represents a gator ERC-7715 granted(ie. signed by an user account) permission entry that is stored in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided\n */\nexport type StoredGatorPermission<\n  TSigner extends SignerParam,\n  TPermission extends PermissionTypes,\n> = {\n  permissionResponse: PermissionResponse<TSigner, TPermission>;\n  siteOrigin: string;\n};\n\n/**\n * Represents a sanitized version of the StoredGatorPermission type. Some fields have been removed but the fields are still present in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type StoredGatorPermissionSanitized<\n  TSigner extends SignerParam,\n  TPermission extends PermissionTypes,\n> = {\n  permissionResponse: PermissionResponseSanitized<TSigner, TPermission>;\n  siteOrigin: string;\n};\n\n/**\n * Represents a map of gator permissions by chainId and permission type.\n */\nexport type GatorPermissionsMap = {\n  'native-token-stream': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      SignerParam,\n      NativeTokenStreamPermission\n    >[];\n  };\n  'native-token-periodic': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      SignerParam,\n      NativeTokenPeriodicPermission\n    >[];\n  };\n  'erc20-token-stream': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      SignerParam,\n      Erc20TokenStreamPermission\n    >[];\n  };\n  'erc20-token-periodic': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      SignerParam,\n      Erc20TokenPeriodicPermission\n    >[];\n  };\n  other: {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      SignerParam,\n      CustomPermission\n    >[];\n  };\n};\n\n/**\n * Represents the supported permission type(e.g. 'native-token-stream', 'native-token-periodic', 'erc20-token-stream', 'erc20-token-periodic') of the gator permissions map.\n */\nexport type SupportedGatorPermissionType = keyof GatorPermissionsMap;\n\n/**\n * Represents a map of gator permissions for a given permission type with key of chainId. The value being an array of gator permissions for that chainId.\n */\nexport type GatorPermissionsMapByPermissionType<\n  TPermissionType extends SupportedGatorPermissionType,\n> = GatorPermissionsMap[TPermissionType];\n\n/**\n * Represents an array of gator permissions for a given permission type and chainId.\n */\nexport type GatorPermissionsListByPermissionTypeAndChainId<\n  TPermissionType extends SupportedGatorPermissionType,\n> = GatorPermissionsMap[TPermissionType][Hex];\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,MAAM,CAAN,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;AACrF,CAAC,EALW,mCAAmC,KAAnC,mCAAmC,QAK9C;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACvC;;OAEG;IACH,sHAAqF,CAAA;AACvF,CAAC,EALW,6BAA6B,KAA7B,6BAA6B,QAKxC","sourcesContent":["import type {\n  PermissionTypes,\n  Signer,\n  BasePermission,\n  NativeTokenStreamPermission,\n  NativeTokenPeriodicPermission,\n  Erc20TokenStreamPermission,\n  Erc20TokenPeriodicPermission,\n  Rule,\n  MetaMaskBasePermissionData,\n} from '@metamask/7715-permission-types';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * Enum for the error codes of the gator permissions controller.\n */\nexport enum GatorPermissionsControllerErrorCode {\n  GatorPermissionsFetchError = 'gator-permissions-fetch-error',\n  GatorPermissionsNotEnabled = 'gator-permissions-not-enabled',\n  GatorPermissionsProviderError = 'gator-permissions-provider-error',\n  GatorPermissionsMapSerializationError = 'gator-permissions-map-serialization-error',\n}\n\n/**\n * Enum for the RPC methods of the gator permissions provider snap.\n */\nexport enum GatorPermissionsSnapRpcMethod {\n  /**\n   * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.\n   */\n  PermissionProviderGetGrantedPermissions = 'permissionsProvider_getGrantedPermissions',\n}\n\n/**\n * Represents a custom permission that are not of the standard ERC-7715 permission types.\n */\nexport type CustomPermission = BasePermission & {\n  type: 'custom';\n  data: MetaMaskBasePermissionData & Record<string, unknown>;\n};\n\n/**\n * Represents the type of the ERC-7715 permissions that can be granted including custom permissions.\n */\nexport type PermissionTypesWithCustom = PermissionTypes | CustomPermission;\n\n/**\n * Represents a ERC-7715 permission request.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionRequest<\n  TSigner extends Signer,\n  TPermission extends PermissionTypesWithCustom,\n> = {\n  /**\n   * hex-encoding of uint256 defined the chain with EIP-155\n   */\n  chainId: Hex;\n\n  /**\n   *\n   * The account being targeted for this permission request.\n   * It is optional to let the user choose which account to grant permission from.\n   */\n  address?: Hex;\n\n  /**\n   * An account that is associated with the recipient of the granted 7715 permission or alternatively the wallet will manage the session.\n   */\n  signer: TSigner;\n\n  /**\n   * Defines the allowed behavior the signer can do on behalf of the account.\n   */\n  permission: TPermission;\n\n  rules?: Rule[] | null;\n};\n\n/**\n * Represents a ERC-7715 permission response.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionResponse<\n  TSigner extends Signer,\n  TPermission extends PermissionTypesWithCustom,\n> = PermissionRequest<TSigner, TPermission> & {\n  /**\n   * Is a catch-all to identify a permission for revoking permissions or submitting\n   * Defined in ERC-7710.\n   */\n  context: Hex;\n\n  /**\n   * The dependencyInfo field is required and contains information needed to deploy accounts.\n   * Each entry specifies a factory contract and its associated deployment data.\n   * If no account deployment is needed when redeeming the permission, this array must be empty.\n   * When non-empty, DApps MUST deploy the accounts by calling the factory contract with factoryData as the calldata.\n   * Defined in ERC-4337.\n   */\n  dependencyInfo: {\n    factory: Hex;\n    factoryData: Hex;\n  }[];\n\n  /**\n   * If the signer type is account then delegationManager is required as defined in ERC-7710.\n   */\n  signerMeta: {\n    delegationManager: Hex;\n  };\n};\n\n/**\n * Represents a sanitized version of the PermissionResponse type.\n * Some fields have been removed but the fields are still present in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type PermissionResponseSanitized<\n  TSigner extends Signer,\n  TPermission extends PermissionTypesWithCustom,\n> = Omit<\n  PermissionResponse<TSigner, TPermission>,\n  'dependencyInfo' | 'signer' | 'rules'\n>;\n\n/**\n * Represents a gator ERC-7715 granted(ie. signed by an user account) permission entry that is stored in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided\n */\nexport type StoredGatorPermission<\n  TSigner extends Signer,\n  TPermission extends PermissionTypesWithCustom,\n> = {\n  permissionResponse: PermissionResponse<TSigner, TPermission>;\n  siteOrigin: string;\n};\n\n/**\n * Represents a sanitized version of the StoredGatorPermission type. Some fields have been removed but the fields are still present in profile sync.\n *\n * @template Signer - The type of the signer provided, either an AccountSigner or WalletSigner.\n * @template Permission - The type of the permission provided.\n */\nexport type StoredGatorPermissionSanitized<\n  TSigner extends Signer,\n  TPermission extends PermissionTypesWithCustom,\n> = {\n  permissionResponse: PermissionResponseSanitized<TSigner, TPermission>;\n  siteOrigin: string;\n};\n\n/**\n * Represents a map of gator permissions by chainId and permission type.\n */\nexport type GatorPermissionsMap = {\n  'native-token-stream': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      Signer,\n      NativeTokenStreamPermission\n    >[];\n  };\n  'native-token-periodic': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      Signer,\n      NativeTokenPeriodicPermission\n    >[];\n  };\n  'erc20-token-stream': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      Signer,\n      Erc20TokenStreamPermission\n    >[];\n  };\n  'erc20-token-periodic': {\n    [chainId: Hex]: StoredGatorPermissionSanitized<\n      Signer,\n      Erc20TokenPeriodicPermission\n    >[];\n  };\n  other: {\n    [chainId: Hex]: StoredGatorPermissionSanitized<Signer, CustomPermission>[];\n  };\n};\n\n/**\n * Represents the supported permission type(e.g. 'native-token-stream', 'native-token-periodic', 'erc20-token-stream', 'erc20-token-periodic') of the gator permissions map.\n */\nexport type SupportedGatorPermissionType = keyof GatorPermissionsMap;\n\n/**\n * Represents a map of gator permissions for a given permission type with key of chainId. The value being an array of gator permissions for that chainId.\n */\nexport type GatorPermissionsMapByPermissionType<\n  TPermissionType extends SupportedGatorPermissionType,\n> = GatorPermissionsMap[TPermissionType];\n\n/**\n * Represents an array of gator permissions for a given permission type and chainId.\n */\nexport type GatorPermissionsListByPermissionTypeAndChainId<\n  TPermissionType extends SupportedGatorPermissionType,\n> = GatorPermissionsMap[TPermissionType][Hex];\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/gator-permissions-controller",
-  "version": "0.0.0-preview-2a00636",
+  "version": "0.1.0-preview-d71561e3",
   "description": "Controller for managing gator permissions with profile sync integration",
   "keywords": [
     "MetaMask",
@@ -47,7 +47,8 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.2.0",
+    "@metamask/7715-permission-types": "^0.3.0",
+    "@metamask/base-controller": "^8.3.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@metamask/utils": "^11.4.2"
@@ -75,5 +76,10 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false
+    }
   }
 }