@metamask-previews/gator-permissions-controller 0.3.0-preview-607c80f8 → 0.4.0-preview-a345102

package/dist/types.cjs

@@ -22,5 +22,9 @@ var GatorPermissionsSnapRpcMethod;
      * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.
      */
     GatorPermissionsSnapRpcMethod["PermissionProviderGetGrantedPermissions"] = "permissionsProvider_getGrantedPermissions";
+    /**
+     * This method is used by the metamask to submit a revocation to the permissions provider.
+     */
+    GatorPermissionsSnapRpcMethod["PermissionProviderSubmitRevocation"] = "permissionsProvider_submitRevocation";
 })(GatorPermissionsSnapRpcMethod || (exports.GatorPermissionsSnapRpcMethod = GatorPermissionsSnapRpcMethod = {}));
 //# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,IAAY,mCAOX;AAPD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;IACnF,4FAAqD,CAAA;IACrD,yFAAkD,CAAA;AACpD,CAAC,EAPW,mCAAmC,mDAAnC,mCAAmC,QAO9C;AAED;;GAEG;AACH,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACvC;;OAEG;IACH,sHAAqF,CAAA;AACvF,CAAC,EALW,6BAA6B,6CAA7B,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 { Delegation } from '@metamask/delegation-core';\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  PermissionDecodingError = 'permission-decoding-error',\n  OriginNotAllowedError = 'origin-not-allowed-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\n/**\n * Represents the details of a delegation, that are required to decode a permission.\n */\nexport type DelegationDetails = Pick<\n  Delegation<Hex>,\n  'caveats' | 'delegator' | 'delegate' | 'authority'\n>;\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,IAAY,mCAOX;AAPD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;IACnF,4FAAqD,CAAA;IACrD,yFAAkD,CAAA;AACpD,CAAC,EAPW,mCAAmC,mDAAnC,mCAAmC,QAO9C;AAED;;GAEG;AACH,IAAY,6BASX;AATD,WAAY,6BAA6B;IACvC;;OAEG;IACH,sHAAqF,CAAA;IACrF;;OAEG;IACH,4GAA2E,CAAA;AAC7E,CAAC,EATW,6BAA6B,6CAA7B,6BAA6B,QASxC","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 { Delegation } from '@metamask/delegation-core';\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  PermissionDecodingError = 'permission-decoding-error',\n  OriginNotAllowedError = 'origin-not-allowed-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   * This method is used by the metamask to submit a revocation to the permissions provider.\n   */\n  PermissionProviderSubmitRevocation = 'permissionsProvider_submitRevocation',\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   * Flag indicating whether this permission has been revoked.\n   */\n  isRevoked?: boolean;\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   * Flag indicating whether this permission has been revoked.\n   */\n  isRevoked?: boolean;\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\n/**\n * Represents the details of a delegation, that are required to decode a permission.\n */\nexport type DelegationDetails = Pick<\n  Delegation<Hex>,\n  'caveats' | 'delegator' | 'delegate' | 'authority'\n>;\n\n/**\n * Represents the parameters for submitting a revocation.\n */\nexport type RevocationParams = {\n  /**\n   * The permission context as a hex string that identifies the permission to revoke.\n   */\n  permissionContext: Hex;\n};\n\n/**\n * Represents the parameters for adding a pending revocation.\n */\nexport type PendingRevocationParams = {\n  /**\n   * The transaction metadata ID to monitor.\n   */\n  txId: string;\n  /**\n   * The permission context as a hex string that identifies the permission to revoke.\n   */\n  permissionContext: Hex;\n};\n"]}

package/dist/types.d.cts

@@ -19,7 +19,11 @@ export declare enum GatorPermissionsSnapRpcMethod {
     /**
      * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.
      */
-    PermissionProviderGetGrantedPermissions = "permissionsProvider_getGrantedPermissions"
+    PermissionProviderGetGrantedPermissions = "permissionsProvider_getGrantedPermissions",
+    /**
+     * This method is used by the metamask to submit a revocation to the permissions provider.
+     */
+    PermissionProviderSubmitRevocation = "permissionsProvider_submitRevocation"
 }
 /**
  * Represents a custom permission that are not of the standard ERC-7715 permission types.
@@ -106,6 +110,10 @@ export type PermissionResponseSanitized<TSigner extends Signer, TPermission exte
 export type StoredGatorPermission<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponse<TSigner, TPermission>;
     siteOrigin: string;
+    /**
+     * Flag indicating whether this permission has been revoked.
+     */
+    isRevoked?: boolean;
 };
 /**
  * Represents a sanitized version of the StoredGatorPermission type. Some fields have been removed but the fields are still present in profile sync.
@@ -116,6 +124,10 @@ export type StoredGatorPermission<TSigner extends Signer, TPermission extends Pe
 export type StoredGatorPermissionSanitized<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponseSanitized<TSigner, TPermission>;
     siteOrigin: string;
+    /**
+     * Flag indicating whether this permission has been revoked.
+     */
+    isRevoked?: boolean;
 };
 /**
  * Represents a map of gator permissions by chainId and permission type.
@@ -153,4 +165,26 @@ export type GatorPermissionsListByPermissionTypeAndChainId<TPermissionType exten
  * Represents the details of a delegation, that are required to decode a permission.
  */
 export type DelegationDetails = Pick<Delegation<Hex>, 'caveats' | 'delegator' | 'delegate' | 'authority'>;
+/**
+ * Represents the parameters for submitting a revocation.
+ */
+export type RevocationParams = {
+    /**
+     * The permission context as a hex string that identifies the permission to revoke.
+     */
+    permissionContext: Hex;
+};
+/**
+ * Represents the parameters for adding a pending revocation.
+ */
+export type PendingRevocationParams = {
+    /**
+     * The transaction metadata ID to monitor.
+     */
+    txId: string;
+    /**
+     * The permission context as a hex string that identifies the permission to revoke.
+     */
+    permissionContext: Hex;
+};
 //# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","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,UAAU,EAAE,kCAAkC;AAC5D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;IACnF,uBAAuB,8BAA8B;IACrD,qBAAqB,6BAA6B;CACnD;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;AAE9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CACnD,CAAC"}
+{"version":3,"file":"types.d.cts","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,UAAU,EAAE,kCAAkC;AAC5D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;IACnF,uBAAuB,8BAA8B;IACrD,qBAAqB,6BAA6B;CACnD;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,uCAAuC,8CAA8C;IACrF;;OAEG;IACH,kCAAkC,yCAAyC;CAC5E;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;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,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;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,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;AAE9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CAAC"}

package/dist/types.d.mts

@@ -19,7 +19,11 @@ export declare enum GatorPermissionsSnapRpcMethod {
     /**
      * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.
      */
-    PermissionProviderGetGrantedPermissions = "permissionsProvider_getGrantedPermissions"
+    PermissionProviderGetGrantedPermissions = "permissionsProvider_getGrantedPermissions",
+    /**
+     * This method is used by the metamask to submit a revocation to the permissions provider.
+     */
+    PermissionProviderSubmitRevocation = "permissionsProvider_submitRevocation"
 }
 /**
  * Represents a custom permission that are not of the standard ERC-7715 permission types.
@@ -106,6 +110,10 @@ export type PermissionResponseSanitized<TSigner extends Signer, TPermission exte
 export type StoredGatorPermission<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponse<TSigner, TPermission>;
     siteOrigin: string;
+    /**
+     * Flag indicating whether this permission has been revoked.
+     */
+    isRevoked?: boolean;
 };
 /**
  * Represents a sanitized version of the StoredGatorPermission type. Some fields have been removed but the fields are still present in profile sync.
@@ -116,6 +124,10 @@ export type StoredGatorPermission<TSigner extends Signer, TPermission extends Pe
 export type StoredGatorPermissionSanitized<TSigner extends Signer, TPermission extends PermissionTypesWithCustom> = {
     permissionResponse: PermissionResponseSanitized<TSigner, TPermission>;
     siteOrigin: string;
+    /**
+     * Flag indicating whether this permission has been revoked.
+     */
+    isRevoked?: boolean;
 };
 /**
  * Represents a map of gator permissions by chainId and permission type.
@@ -153,4 +165,26 @@ export type GatorPermissionsListByPermissionTypeAndChainId<TPermissionType exten
  * Represents the details of a delegation, that are required to decode a permission.
  */
 export type DelegationDetails = Pick<Delegation<Hex>, 'caveats' | 'delegator' | 'delegate' | 'authority'>;
+/**
+ * Represents the parameters for submitting a revocation.
+ */
+export type RevocationParams = {
+    /**
+     * The permission context as a hex string that identifies the permission to revoke.
+     */
+    permissionContext: Hex;
+};
+/**
+ * Represents the parameters for adding a pending revocation.
+ */
+export type PendingRevocationParams = {
+    /**
+     * The transaction metadata ID to monitor.
+     */
+    txId: string;
+    /**
+     * The permission context as a hex string that identifies the permission to revoke.
+     */
+    permissionContext: Hex;
+};
 //# 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,EACV,eAAe,EACf,MAAM,EACN,cAAc,EACd,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,IAAI,EACJ,0BAA0B,EAC3B,wCAAwC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,kCAAkC;AAC5D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;IACnF,uBAAuB,8BAA8B;IACrD,qBAAqB,6BAA6B;CACnD;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;AAE9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CACnD,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,UAAU,EAAE,kCAAkC;AAC5D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,mCAAmC;IAC7C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,6BAA6B,qCAAqC;IAClE,qCAAqC,8CAA8C;IACnF,uBAAuB,8BAA8B;IACrD,qBAAqB,6BAA6B;CACnD;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,uCAAuC,8CAA8C;IACrF;;OAEG;IACH,kCAAkC,yCAAyC;CAC5E;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;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,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;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,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;AAE9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CAAC"}

package/dist/types.mjs

@@ -19,5 +19,9 @@ export var GatorPermissionsSnapRpcMethod;
      * This method is used by the metamask to request a permissions provider to get granted permissions for all sites.
      */
     GatorPermissionsSnapRpcMethod["PermissionProviderGetGrantedPermissions"] = "permissionsProvider_getGrantedPermissions";
+    /**
+     * This method is used by the metamask to submit a revocation to the permissions provider.
+     */
+    GatorPermissionsSnapRpcMethod["PermissionProviderSubmitRevocation"] = "permissionsProvider_submitRevocation";
 })(GatorPermissionsSnapRpcMethod || (GatorPermissionsSnapRpcMethod = {}));
 //# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,CAAN,IAAY,mCAOX;AAPD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;IACnF,4FAAqD,CAAA;IACrD,yFAAkD,CAAA;AACpD,CAAC,EAPW,mCAAmC,KAAnC,mCAAmC,QAO9C;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 { Delegation } from '@metamask/delegation-core';\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  PermissionDecodingError = 'permission-decoding-error',\n  OriginNotAllowedError = 'origin-not-allowed-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\n/**\n * Represents the details of a delegation, that are required to decode a permission.\n */\nexport type DelegationDetails = Pick<\n  Delegation<Hex>,\n  'caveats' | 'delegator' | 'delegate' | 'authority'\n>;\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,CAAN,IAAY,mCAOX;AAPD,WAAY,mCAAmC;IAC7C,mGAA4D,CAAA;IAC5D,mGAA4D,CAAA;IAC5D,yGAAkE,CAAA;IAClE,0HAAmF,CAAA;IACnF,4FAAqD,CAAA;IACrD,yFAAkD,CAAA;AACpD,CAAC,EAPW,mCAAmC,KAAnC,mCAAmC,QAO9C;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,6BASX;AATD,WAAY,6BAA6B;IACvC;;OAEG;IACH,sHAAqF,CAAA;IACrF;;OAEG;IACH,4GAA2E,CAAA;AAC7E,CAAC,EATW,6BAA6B,KAA7B,6BAA6B,QASxC","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 { Delegation } from '@metamask/delegation-core';\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  PermissionDecodingError = 'permission-decoding-error',\n  OriginNotAllowedError = 'origin-not-allowed-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   * This method is used by the metamask to submit a revocation to the permissions provider.\n   */\n  PermissionProviderSubmitRevocation = 'permissionsProvider_submitRevocation',\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   * Flag indicating whether this permission has been revoked.\n   */\n  isRevoked?: boolean;\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   * Flag indicating whether this permission has been revoked.\n   */\n  isRevoked?: boolean;\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\n/**\n * Represents the details of a delegation, that are required to decode a permission.\n */\nexport type DelegationDetails = Pick<\n  Delegation<Hex>,\n  'caveats' | 'delegator' | 'delegate' | 'authority'\n>;\n\n/**\n * Represents the parameters for submitting a revocation.\n */\nexport type RevocationParams = {\n  /**\n   * The permission context as a hex string that identifies the permission to revoke.\n   */\n  permissionContext: Hex;\n};\n\n/**\n * Represents the parameters for adding a pending revocation.\n */\nexport type PendingRevocationParams = {\n  /**\n   * The transaction metadata ID to monitor.\n   */\n  txId: string;\n  /**\n   * The permission context as a hex string that identifies the permission to revoke.\n   */\n  permissionContext: Hex;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/gator-permissions-controller",
-  "version": "0.3.0-preview-607c80f8",
+  "version": "0.4.0-preview-a345102",
   "description": "Controller for managing gator permissions with profile sync integration",
   "keywords": [
     "MetaMask",
@@ -36,6 +36,7 @@
   ],
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/gator-permissions-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/gator-permissions-controller",
@@ -61,7 +62,8 @@
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/snaps-controllers": "^14.0.1",
-    "@ts-bridge/cli": "^0.6.1",
+    "@metamask/transaction-controller": "^61.1.0",
+    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
@@ -71,7 +73,8 @@
     "typescript": "~5.2.2"
   },
   "peerDependencies": {
-    "@metamask/snaps-controllers": "^14.0.1"
+    "@metamask/snaps-controllers": "^14.0.1",
+    "@metamask/transaction-controller": "^61.1.0"
   },
   "engines": {
     "node": "^18.18 || >=20"