@metamask/delegation-core 2.1.0 → 2.2.0

package/dist/index.d.cts

@@ -239,6 +239,18 @@ declare function createAllowedTargetsTerms(terms: AllowedTargetsTerms, encodingO
 declare function decodeAllowedTargetsTerms(terms: BytesLike, encodingOptions?: EncodingOptions<'hex'>): AllowedTargetsTerms<DecodedBytesLike<'hex'>>;
 declare function decodeAllowedTargetsTerms(terms: BytesLike, encodingOptions: EncodingOptions<'bytes'>): AllowedTargetsTerms<DecodedBytesLike<'bytes'>>;
 
+type ApprovalRevocationTerms = {
+    erc20Approve: boolean;
+    erc721Approve: boolean;
+    erc721SetApprovalForAll: boolean;
+    permit2ApproveZero: boolean;
+    permit2Lockdown: boolean;
+    permit2InvalidateNonces: boolean;
+};
+declare function createApprovalRevocationTerms(terms: ApprovalRevocationTerms, encodingOptions?: EncodingOptions<'hex'>): Hex;
+declare function createApprovalRevocationTerms(terms: ApprovalRevocationTerms, encodingOptions: EncodingOptions<'bytes'>): Uint8Array;
+declare function decodeApprovalRevocationTerms(terms: BytesLike): ApprovalRevocationTerms;
+
 type ArgsEqualityCheckTerms<TBytesLike extends BytesLike = BytesLike> = {
     args: TBytesLike;
 };
@@ -352,4 +364,4 @@ declare function decodeDelegation(encoded: BytesLike, options: EncodingOptions<'
 declare function hashDelegation(delegation: DelegationStruct, options?: EncodingOptions<'hex'>): Hex;
 declare function hashDelegation(delegation: DelegationStruct, options: EncodingOptions<'bytes'>): Uint8Array;
 
-export { ANY_BENEFICIARY, BalanceChangeType, CAVEAT_TYPEHASH, type CaveatStruct as Caveat, DELEGATION_TYPEHASH, type DelegationStruct as Delegation, ROOT_AUTHORITY, createAllowedCalldataTerms, createAllowedMethodsTerms, createAllowedTargetsTerms, createArgsEqualityCheckTerms, createBlockNumberTerms, createDeployedTerms, createERC1155BalanceChangeTerms, createERC20BalanceChangeTerms, createERC20StreamingTerms, createERC20TokenPeriodTransferTerms, createERC20TransferAmountTerms, createERC721BalanceChangeTerms, createERC721TransferTerms, createExactCalldataBatchTerms, createExactCalldataTerms, createExactExecutionBatchTerms, createExactExecutionTerms, createIdTerms, createLimitedCallsTerms, createLogicalOrWrapperArgs, createLogicalOrWrapperTerms, createMultiTokenPeriodTerms, createNativeBalanceChangeTerms, createNativeTokenPaymentTerms, createNativeTokenPeriodTransferTerms, createNativeTokenStreamingTerms, createNativeTokenTransferAmountTerms, createNonceTerms, createOwnershipTransferTerms, createRedeemerTerms, createSpecificActionERC20TransferBatchTerms, createTimestampTerms, createValueLteTerms, decodeAllowedCalldataTerms, decodeAllowedMethodsTerms, decodeAllowedTargetsTerms, decodeArgsEqualityCheckTerms, decodeBlockNumberTerms, decodeDelegation, decodeDelegations, decodeDeployedTerms, decodeERC1155BalanceChangeTerms, decodeERC20BalanceChangeTerms, decodeERC20StreamingTerms, decodeERC20TokenPeriodTransferTerms, decodeERC20TransferAmountTerms, decodeERC721BalanceChangeTerms, decodeERC721TransferTerms, decodeExactCalldataBatchTerms, decodeExactCalldataTerms, decodeExactExecutionBatchTerms, decodeExactExecutionTerms, decodeIdTerms, decodeLimitedCallsTerms, decodeLogicalOrWrapperArgs, decodeLogicalOrWrapperTerms, decodeMultiTokenPeriodTerms, decodeNativeBalanceChangeTerms, decodeNativeTokenPaymentTerms, decodeNativeTokenPeriodTransferTerms, decodeNativeTokenStreamingTerms, decodeNativeTokenTransferAmountTerms, decodeNonceTerms, decodeOwnershipTransferTerms, decodeRedeemerTerms, decodeSpecificActionERC20TransferBatchTerms, decodeTimestampTerms, decodeValueLteTerms, encodeDelegation, encodeDelegations, hashDelegation };
+export { ANY_BENEFICIARY, type ApprovalRevocationTerms, BalanceChangeType, CAVEAT_TYPEHASH, type CaveatStruct as Caveat, DELEGATION_TYPEHASH, type DelegationStruct as Delegation, ROOT_AUTHORITY, createAllowedCalldataTerms, createAllowedMethodsTerms, createAllowedTargetsTerms, createApprovalRevocationTerms, createArgsEqualityCheckTerms, createBlockNumberTerms, createDeployedTerms, createERC1155BalanceChangeTerms, createERC20BalanceChangeTerms, createERC20StreamingTerms, createERC20TokenPeriodTransferTerms, createERC20TransferAmountTerms, createERC721BalanceChangeTerms, createERC721TransferTerms, createExactCalldataBatchTerms, createExactCalldataTerms, createExactExecutionBatchTerms, createExactExecutionTerms, createIdTerms, createLimitedCallsTerms, createLogicalOrWrapperArgs, createLogicalOrWrapperTerms, createMultiTokenPeriodTerms, createNativeBalanceChangeTerms, createNativeTokenPaymentTerms, createNativeTokenPeriodTransferTerms, createNativeTokenStreamingTerms, createNativeTokenTransferAmountTerms, createNonceTerms, createOwnershipTransferTerms, createRedeemerTerms, createSpecificActionERC20TransferBatchTerms, createTimestampTerms, createValueLteTerms, decodeAllowedCalldataTerms, decodeAllowedMethodsTerms, decodeAllowedTargetsTerms, decodeApprovalRevocationTerms, decodeArgsEqualityCheckTerms, decodeBlockNumberTerms, decodeDelegation, decodeDelegations, decodeDeployedTerms, decodeERC1155BalanceChangeTerms, decodeERC20BalanceChangeTerms, decodeERC20StreamingTerms, decodeERC20TokenPeriodTransferTerms, decodeERC20TransferAmountTerms, decodeERC721BalanceChangeTerms, decodeERC721TransferTerms, decodeExactCalldataBatchTerms, decodeExactCalldataTerms, decodeExactExecutionBatchTerms, decodeExactExecutionTerms, decodeIdTerms, decodeLimitedCallsTerms, decodeLogicalOrWrapperArgs, decodeLogicalOrWrapperTerms, decodeMultiTokenPeriodTerms, decodeNativeBalanceChangeTerms, decodeNativeTokenPaymentTerms, decodeNativeTokenPeriodTransferTerms, decodeNativeTokenStreamingTerms, decodeNativeTokenTransferAmountTerms, decodeNonceTerms, decodeOwnershipTransferTerms, decodeRedeemerTerms, decodeSpecificActionERC20TransferBatchTerms, decodeTimestampTerms, decodeValueLteTerms, encodeDelegation, encodeDelegations, hashDelegation };

package/dist/index.d.ts

@@ -239,6 +239,18 @@ declare function createAllowedTargetsTerms(terms: AllowedTargetsTerms, encodingO
 declare function decodeAllowedTargetsTerms(terms: BytesLike, encodingOptions?: EncodingOptions<'hex'>): AllowedTargetsTerms<DecodedBytesLike<'hex'>>;
 declare function decodeAllowedTargetsTerms(terms: BytesLike, encodingOptions: EncodingOptions<'bytes'>): AllowedTargetsTerms<DecodedBytesLike<'bytes'>>;
 
+type ApprovalRevocationTerms = {
+    erc20Approve: boolean;
+    erc721Approve: boolean;
+    erc721SetApprovalForAll: boolean;
+    permit2ApproveZero: boolean;
+    permit2Lockdown: boolean;
+    permit2InvalidateNonces: boolean;
+};
+declare function createApprovalRevocationTerms(terms: ApprovalRevocationTerms, encodingOptions?: EncodingOptions<'hex'>): Hex;
+declare function createApprovalRevocationTerms(terms: ApprovalRevocationTerms, encodingOptions: EncodingOptions<'bytes'>): Uint8Array;
+declare function decodeApprovalRevocationTerms(terms: BytesLike): ApprovalRevocationTerms;
+
 type ArgsEqualityCheckTerms<TBytesLike extends BytesLike = BytesLike> = {
     args: TBytesLike;
 };
@@ -352,4 +364,4 @@ declare function decodeDelegation(encoded: BytesLike, options: EncodingOptions<'
 declare function hashDelegation(delegation: DelegationStruct, options?: EncodingOptions<'hex'>): Hex;
 declare function hashDelegation(delegation: DelegationStruct, options: EncodingOptions<'bytes'>): Uint8Array;
 
-export { ANY_BENEFICIARY, BalanceChangeType, CAVEAT_TYPEHASH, type CaveatStruct as Caveat, DELEGATION_TYPEHASH, type DelegationStruct as Delegation, ROOT_AUTHORITY, createAllowedCalldataTerms, createAllowedMethodsTerms, createAllowedTargetsTerms, createArgsEqualityCheckTerms, createBlockNumberTerms, createDeployedTerms, createERC1155BalanceChangeTerms, createERC20BalanceChangeTerms, createERC20StreamingTerms, createERC20TokenPeriodTransferTerms, createERC20TransferAmountTerms, createERC721BalanceChangeTerms, createERC721TransferTerms, createExactCalldataBatchTerms, createExactCalldataTerms, createExactExecutionBatchTerms, createExactExecutionTerms, createIdTerms, createLimitedCallsTerms, createLogicalOrWrapperArgs, createLogicalOrWrapperTerms, createMultiTokenPeriodTerms, createNativeBalanceChangeTerms, createNativeTokenPaymentTerms, createNativeTokenPeriodTransferTerms, createNativeTokenStreamingTerms, createNativeTokenTransferAmountTerms, createNonceTerms, createOwnershipTransferTerms, createRedeemerTerms, createSpecificActionERC20TransferBatchTerms, createTimestampTerms, createValueLteTerms, decodeAllowedCalldataTerms, decodeAllowedMethodsTerms, decodeAllowedTargetsTerms, decodeArgsEqualityCheckTerms, decodeBlockNumberTerms, decodeDelegation, decodeDelegations, decodeDeployedTerms, decodeERC1155BalanceChangeTerms, decodeERC20BalanceChangeTerms, decodeERC20StreamingTerms, decodeERC20TokenPeriodTransferTerms, decodeERC20TransferAmountTerms, decodeERC721BalanceChangeTerms, decodeERC721TransferTerms, decodeExactCalldataBatchTerms, decodeExactCalldataTerms, decodeExactExecutionBatchTerms, decodeExactExecutionTerms, decodeIdTerms, decodeLimitedCallsTerms, decodeLogicalOrWrapperArgs, decodeLogicalOrWrapperTerms, decodeMultiTokenPeriodTerms, decodeNativeBalanceChangeTerms, decodeNativeTokenPaymentTerms, decodeNativeTokenPeriodTransferTerms, decodeNativeTokenStreamingTerms, decodeNativeTokenTransferAmountTerms, decodeNonceTerms, decodeOwnershipTransferTerms, decodeRedeemerTerms, decodeSpecificActionERC20TransferBatchTerms, decodeTimestampTerms, decodeValueLteTerms, encodeDelegation, encodeDelegations, hashDelegation };
+export { ANY_BENEFICIARY, type ApprovalRevocationTerms, BalanceChangeType, CAVEAT_TYPEHASH, type CaveatStruct as Caveat, DELEGATION_TYPEHASH, type DelegationStruct as Delegation, ROOT_AUTHORITY, createAllowedCalldataTerms, createAllowedMethodsTerms, createAllowedTargetsTerms, createApprovalRevocationTerms, createArgsEqualityCheckTerms, createBlockNumberTerms, createDeployedTerms, createERC1155BalanceChangeTerms, createERC20BalanceChangeTerms, createERC20StreamingTerms, createERC20TokenPeriodTransferTerms, createERC20TransferAmountTerms, createERC721BalanceChangeTerms, createERC721TransferTerms, createExactCalldataBatchTerms, createExactCalldataTerms, createExactExecutionBatchTerms, createExactExecutionTerms, createIdTerms, createLimitedCallsTerms, createLogicalOrWrapperArgs, createLogicalOrWrapperTerms, createMultiTokenPeriodTerms, createNativeBalanceChangeTerms, createNativeTokenPaymentTerms, createNativeTokenPeriodTransferTerms, createNativeTokenStreamingTerms, createNativeTokenTransferAmountTerms, createNonceTerms, createOwnershipTransferTerms, createRedeemerTerms, createSpecificActionERC20TransferBatchTerms, createTimestampTerms, createValueLteTerms, decodeAllowedCalldataTerms, decodeAllowedMethodsTerms, decodeAllowedTargetsTerms, decodeApprovalRevocationTerms, decodeArgsEqualityCheckTerms, decodeBlockNumberTerms, decodeDelegation, decodeDelegations, decodeDeployedTerms, decodeERC1155BalanceChangeTerms, decodeERC20BalanceChangeTerms, decodeERC20StreamingTerms, decodeERC20TokenPeriodTransferTerms, decodeERC20TransferAmountTerms, decodeERC721BalanceChangeTerms, decodeERC721TransferTerms, decodeExactCalldataBatchTerms, decodeExactCalldataTerms, decodeExactExecutionBatchTerms, decodeExactExecutionTerms, decodeIdTerms, decodeLimitedCallsTerms, decodeLogicalOrWrapperArgs, decodeLogicalOrWrapperTerms, decodeMultiTokenPeriodTerms, decodeNativeBalanceChangeTerms, decodeNativeTokenPaymentTerms, decodeNativeTokenPeriodTransferTerms, decodeNativeTokenStreamingTerms, decodeNativeTokenTransferAmountTerms, decodeNonceTerms, decodeOwnershipTransferTerms, decodeRedeemerTerms, decodeSpecificActionERC20TransferBatchTerms, decodeTimestampTerms, decodeValueLteTerms, encodeDelegation, encodeDelegations, hashDelegation };

package/dist/index.mjs

@@ -975,6 +975,74 @@ function decodeAllowedTargetsTerms(terms, encodingOptions = defaultOptions) {
   return { targets };
 }
 
+// src/caveats/approvalRevocationEnforcer.ts
+var BIT_ERC20_APPROVE_ZERO = 1;
+var BIT_ERC721_PER_TOKEN_CLEAR = 2;
+var BIT_SET_APPROVAL_FOR_ALL_REVOKE = 4;
+var BIT_PERMIT2_APPROVE_ZERO = 8;
+var BIT_PERMIT2_LOCKDOWN = 16;
+var BIT_PERMIT2_INVALIDATE_NONCES = 32;
+var ALLOWED_APPROVAL_REVOCATION_MAX_MASK = BIT_ERC20_APPROVE_ZERO | BIT_ERC721_PER_TOKEN_CLEAR | BIT_SET_APPROVAL_FOR_ALL_REVOKE | BIT_PERMIT2_APPROVE_ZERO | BIT_PERMIT2_LOCKDOWN | BIT_PERMIT2_INVALIDATE_NONCES;
+var NO_FLAGS_SET_ERROR = "Invalid ApprovalRevocation terms: at least one revocation primitive must be enabled";
+function termsToMask(terms) {
+  let mask = 0;
+  if (terms.erc20Approve) {
+    mask |= BIT_ERC20_APPROVE_ZERO;
+  }
+  if (terms.erc721Approve) {
+    mask |= BIT_ERC721_PER_TOKEN_CLEAR;
+  }
+  if (terms.erc721SetApprovalForAll) {
+    mask |= BIT_SET_APPROVAL_FOR_ALL_REVOKE;
+  }
+  if (terms.permit2ApproveZero) {
+    mask |= BIT_PERMIT2_APPROVE_ZERO;
+  }
+  if (terms.permit2Lockdown) {
+    mask |= BIT_PERMIT2_LOCKDOWN;
+  }
+  if (terms.permit2InvalidateNonces) {
+    mask |= BIT_PERMIT2_INVALIDATE_NONCES;
+  }
+  if (mask === 0) {
+    throw new Error(NO_FLAGS_SET_ERROR);
+  }
+  return mask;
+}
+function maskToTerms(mask) {
+  if (mask > ALLOWED_APPROVAL_REVOCATION_MAX_MASK) {
+    throw new Error(
+      "Invalid ApprovalRevocation terms: reserved bits must be zero (only bits 0-5 are defined)"
+    );
+  }
+  if (mask === 0) {
+    throw new Error(NO_FLAGS_SET_ERROR);
+  }
+  return {
+    erc20Approve: (mask & BIT_ERC20_APPROVE_ZERO) !== 0,
+    erc721Approve: (mask & BIT_ERC721_PER_TOKEN_CLEAR) !== 0,
+    erc721SetApprovalForAll: (mask & BIT_SET_APPROVAL_FOR_ALL_REVOKE) !== 0,
+    permit2ApproveZero: (mask & BIT_PERMIT2_APPROVE_ZERO) !== 0,
+    permit2Lockdown: (mask & BIT_PERMIT2_LOCKDOWN) !== 0,
+    permit2InvalidateNonces: (mask & BIT_PERMIT2_INVALIDATE_NONCES) !== 0
+  };
+}
+function createApprovalRevocationTerms(terms, encodingOptions = defaultOptions) {
+  const mask = termsToMask(terms);
+  const hexValue = `0x${toHexString({ value: mask, size: 1 })}`;
+  return prepareResult(hexValue, encodingOptions);
+}
+function decodeApprovalRevocationTerms(terms) {
+  const hexTerms = bytesLikeToHex(terms);
+  assertHexByteExactLength(
+    hexTerms,
+    1,
+    "Invalid ApprovalRevocation terms: must be exactly 1 byte"
+  );
+  const mask = extractNumber(hexTerms, 0, 1);
+  return maskToTerms(mask);
+}
+
 // src/caveats/argsEqualityCheck.ts
 function createArgsEqualityCheckTerms(terms, encodingOptions = defaultOptions) {
   const { args } = terms;
@@ -1513,6 +1581,7 @@ export {
   createAllowedCalldataTerms,
   createAllowedMethodsTerms,
   createAllowedTargetsTerms,
+  createApprovalRevocationTerms,
   createArgsEqualityCheckTerms,
   createBlockNumberTerms,
   createDeployedTerms,
@@ -1546,6 +1615,7 @@ export {
   decodeAllowedCalldataTerms,
   decodeAllowedMethodsTerms,
   decodeAllowedTargetsTerms,
+  decodeApprovalRevocationTerms,
   decodeArgsEqualityCheckTerms,
   decodeBlockNumberTerms,
   decodeDelegation,