@metamask/delegation-core 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Changed
+
+- Add @metamask/delegation-core package, providing utility types, delegation hashing, and terms encoding for a limited set of caveat enforcers.
+
+[Unreleased]: https://github.com/metamask/delegation-toolkit/compare/@metamask/delegation-core@0.1.0...HEAD
+[0.1.0]: https://github.com/metamask/delegation-toolkit/releases/tag/@metamask/delegation-core@0.1.0

package/LICENSE.APACHE2

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 ConsenSys Software Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE.MIT0

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

package/README.md

@@ -0,0 +1,384 @@
+# @metamask/delegation-core
+
+Core utilities for creating and managing delegation terms and caveats in the MetaMask Delegation Framework.
+
+## Installation
+
+```bash
+npm install @metamask/delegation-core
+```
+
+or
+
+```bash
+yarn add @metamask/delegation-core
+```
+
+## Overview
+
+This package provides utilities for:
+- Creating caveat terms for various delegation constraints
+- Encoding and decoding delegations
+- Type definitions for delegation structures
+
+## API Reference
+
+### Caveat Terms Builders
+
+Caveat terms builders create encoded parameters for different types of delegation constraints.
+
+#### `createValueLteTerms(terms, options?)`
+
+Creates terms for a ValueLte caveat that limits the maximum value of native tokens that can be spent.
+
+**Parameters:**
+- `terms: ValueLteTerms`
+  - `maxValue: bigint` - The maximum value allowed for the transaction
+- `options?: EncodingOptions` - Optional encoding options (`'hex'` | `'bytes'`)
+
+**Returns:** `Hex | Uint8Array` - 32-byte encoded terms
+
+**Example:**
+```typescript
+import { createValueLteTerms } from '@metamask/delegation-core';
+
+// Limit to 1 ETH maximum
+const terms = createValueLteTerms({
+  maxValue: 1000000000000000000n // 1 ETH in wei
+});
+// Returns: '0x0000000000000000000000000000000000000000000000000de0b6b3a7640000'
+
+// Get as Uint8Array
+const bytesTerms = createValueLteTerms({
+  maxValue: 1000000000000000000n
+}, { out: 'bytes' });
+```
+
+#### `createTimestampTerms(terms, options?)`
+
+Creates terms for a Timestamp caveat that enforces time-based constraints on delegation usage.
+
+**Parameters:**
+- `terms: TimestampTerms`
+  - `timestampAfterThreshold: number` - Timestamp (seconds) after which delegation can be used
+  - `timestampBeforeThreshold: number` - Timestamp (seconds) before which delegation can be used
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - 32-byte encoded terms (16 bytes per timestamp)
+
+**Example:**
+```typescript
+import { createTimestampTerms } from '@metamask/delegation-core';
+
+// Valid between Jan 1, 2022 and Jan 1, 2023
+const terms = createTimestampTerms({
+  timestampAfterThreshold: 1640995200,  // 2022-01-01 00:00:00 UTC
+  timestampBeforeThreshold: 1672531200  // 2023-01-01 00:00:00 UTC
+});
+
+// Only valid after a certain time (no end time)
+const openEndedTerms = createTimestampTerms({
+  timestampAfterThreshold: 1640995200,
+  timestampBeforeThreshold: 0
+});
+```
+
+#### `createExactCalldataTerms(terms, options?)`
+
+Creates terms for an ExactCalldata caveat that ensures execution calldata matches exactly.
+
+**Parameters:**
+- `terms: ExactCalldataTerms`
+  - `callData: BytesLike` - The expected calldata (hex string or Uint8Array)
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - The calldata itself (variable length)
+
+**Example:**
+```typescript
+import { createExactCalldataTerms } from '@metamask/delegation-core';
+
+// Exact calldata for a specific function call
+const terms = createExactCalldataTerms({
+  callData: '0xa9059cbb000000000000000000000000742d35cc6634c0532925a3b8d40ec49b0e8baa5e0000000000000000000000000000000000000000000000000de0b6b3a7640000'
+});
+
+// From Uint8Array
+const terms2 = createExactCalldataTerms({
+  callData: new Uint8Array([0xa9, 0x05, 0x9c, 0xbb, /* ... */])
+});
+```
+
+#### `createNativeTokenPeriodTransferTerms(terms, options?)`
+
+Creates terms for periodic native token transfer limits with time-based resets.
+
+**Parameters:**
+- `terms: NativeTokenPeriodTransferTerms`
+  - `periodAmount: bigint` - Maximum amount transferable per period (wei)
+  - `periodDuration: number` - Duration of each period (seconds)
+  - `startDate: number` - Unix timestamp when first period begins
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - 96-byte encoded terms (32 bytes per parameter)
+
+**Example:**
+```typescript
+import { createNativeTokenPeriodTransferTerms } from '@metamask/delegation-core';
+
+// Allow 1 ETH per day starting from a specific date
+const terms = createNativeTokenPeriodTransferTerms({
+  periodAmount: 1000000000000000000n,  // 1 ETH in wei
+  periodDuration: 86400,               // 24 hours in seconds
+  startDate: 1640995200                // 2022-01-01 00:00:00 UTC
+});
+```
+
+#### `createNativeTokenStreamingTerms(terms, options?)`
+
+Creates terms for linear streaming allowance of native tokens.
+
+**Parameters:**
+- `terms: NativeTokenStreamingTerms`
+  - `initialAmount: bigint` - Amount available immediately (wei)
+  - `maxAmount: bigint` - Maximum total transferable amount (wei)
+  - `amountPerSecond: bigint` - Rate of allowance increase per second (wei)
+  - `startTime: number` - Unix timestamp when streaming begins
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - 128-byte encoded terms (32 bytes per parameter)
+
+**Example:**
+```typescript
+import { createNativeTokenStreamingTerms } from '@metamask/delegation-core';
+
+// Stream 0.5 ETH per second, starting with 1 ETH, max 10 ETH
+const terms = createNativeTokenStreamingTerms({
+  initialAmount: 1000000000000000000n,   // 1 ETH available immediately
+  maxAmount: 10000000000000000000n,      // 10 ETH maximum
+  amountPerSecond: 500000000000000000n,  // 0.5 ETH per second
+  startTime: 1640995200                  // Start streaming at this time
+});
+```
+
+#### `createERC20StreamingTerms(terms, options?)`
+
+Creates terms for linear streaming allowance of ERC20 tokens.
+
+**Parameters:**
+- `terms: ERC20StreamingTerms`
+  - `tokenAddress: string` - ERC20 token contract address
+  - `initialAmount: bigint` - Amount available immediately
+  - `maxAmount: bigint` - Maximum total transferable amount
+  - `amountPerSecond: bigint` - Rate of allowance increase per second
+  - `startTime: number` - Unix timestamp when streaming begins
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - 148-byte encoded terms (20 bytes + 32 bytes × 4 parameters)
+
+**Example:**
+```typescript
+import { createERC20StreamingTerms } from '@metamask/delegation-core';
+
+// Stream USDC tokens
+const terms = createERC20StreamingTerms({
+  tokenAddress: '0xA0b86a33E6441E74C65c6BF2A6d73B895B9b34A2',
+  initialAmount: 1000000n,      // 1 USDC (6 decimals)
+  maxAmount: 10000000n,         // 10 USDC maximum
+  amountPerSecond: 100000n,     // 0.1 USDC per second
+  startTime: 1640995200
+});
+```
+
+#### `createERC20TokenPeriodTransferTerms(terms, options?)`
+
+Creates terms for an ERC20TokenPeriodTransfer caveat that validates that ERC20 token transfers do not exceed a specified amount within a given time period.
+
+**Parameters:**
+- `terms: ERC20TokenPeriodTransferTerms`
+  - `tokenAddress: BytesLike` - The address of the ERC20 token.
+  - `periodAmount: bigint` - The maximum amount that can be transferred within each period.
+  - `periodDuration: number` - The duration of each period in seconds.
+  - `startDate: number` - Unix timestamp when the first period begins.
+- `options?: EncodingOptions` - Optional encoding options
+
+**Returns:** `Hex | Uint8Array` - 116-byte encoded terms (20 bytes for address + 32 bytes per parameter)
+
+**Example:**
+```typescript
+import { createERC20TokenPeriodTransferTerms } from '@metamask/delegation-core';
+
+// Allow 100 tokens per day starting from a specific date
+const terms = createERC20TokenPeriodTransferTerms({
+  tokenAddress: '0xA0b86a33E6441E74C65c6BF2A6d73B895B9b34A2',
+  periodAmount: 100n,  // 100 tokens
+  periodDuration: 86400,  // 24 hours in seconds
+  startDate: 1640995200  // 2022-01-01 00:00:00 UTC
+});
+```
+
+### Delegation Utilities
+
+#### `encodeDelegations(delegations)`
+
+Encodes an array of delegations into a format suitable for on-chain submission.
+
+**Parameters:**
+- `delegations: Delegation[]` - Array of delegation objects
+
+**Returns:** Encoded delegation data
+
+**Example:**
+```typescript
+import { encodeDelegations } from '@metamask/delegation-core';
+
+const delegations = [
+  {
+    delegate: '0x742d35Cc6634C0532925a3b8d40EC49b0e8BaA5e',
+    delegator: '0x...',
+    authority: '0x...',
+    caveats: [],
+    salt: 0n,
+    signature: '0x...'
+  }
+];
+
+const encoded = encodeDelegations(delegations);
+```
+
+#### `decodeDelegations(data)`
+
+Decodes encoded delegation data back into delegation objects.
+
+**Parameters:**
+- `data` - Encoded delegation data
+
+**Returns:** `Delegation[]` - Array of decoded delegation objects
+
+**Example:**
+```typescript
+import { decodeDelegations } from '@metamask/delegation-core';
+
+const delegations = decodeDelegations(encodedData);
+```
+
+#### `ROOT_AUTHORITY`
+
+A constant representing the root authority in the delegation hierarchy.
+
+**Example:**
+```typescript
+import { ROOT_AUTHORITY } from '@metamask/delegation-core';
+
+console.log(ROOT_AUTHORITY); // Root authority identifier
+```
+
+#### `hashDelegation(delegation)`
+
+Computes a hash for a given delegation object.
+
+**Parameters:**
+- `delegation: DelegationStruct` - The delegation object to hash
+
+**Returns:** `Hex` - The hash of the delegation
+
+**Example:**
+```typescript
+import { hashDelegation } from '@metamask/delegation-core';
+
+const delegation = {
+  delegate: '0x742d35Cc6634C0532925a3b8d40EC49b0e8BaA5e',
+  delegator: '0x...',
+  authority: '0x...',
+  caveats: [],
+  salt: 0n,
+  signature: '0x...'
+};
+
+const hash = hashDelegation(delegation);
+```
+
+## Type Definitions
+
+### Core Types
+
+```typescript
+export type Hex = `0x${string}`;
+
+export type DelegationStruct = {
+  delegate: string;
+  delegator: string;
+  authority: string;
+  caveats: CaveatStruct[];
+  salt: bigint;
+  signature: string;
+};
+
+export type CaveatStruct = {
+  enforcer: string;
+  terms: string;
+};
+```
+
+### Caveat Terms Types
+
+```typescript
+export type ValueLteTerms = {
+  maxValue: bigint;
+};
+
+export type TimestampTerms = {
+  timestampAfterThreshold: number;
+  timestampBeforeThreshold: number;
+};
+
+export type ExactCalldataTerms = {
+  callData: BytesLike;
+};
+
+export type NativeTokenPeriodTransferTerms = {
+  periodAmount: bigint;
+  periodDuration: number;
+  startDate: number;
+};
+
+export type NativeTokenStreamingTerms = {
+  initialAmount: bigint;
+  maxAmount: bigint;
+  amountPerSecond: bigint;
+  startTime: number;
+};
+
+export type ERC20StreamingTerms = {
+  tokenAddress: BytesLike;
+  initialAmount: bigint;
+  maxAmount: bigint;
+  amountPerSecond: bigint;
+  startTime: number;
+};
+```
+
+## Error Handling
+
+All caveat builders include validation and will throw descriptive errors:
+
+```typescript
+try {
+  const terms = createValueLteTerms({
+    maxValue: -1n // Invalid: negative value
+  });
+} catch (error) {
+  console.error(error.message); // "Invalid maxValue: must be greater than or equal to zero"
+}
+```
+
+## Related Packages
+
+- `@metamask/delegation-toolkit` - Higher-level utilities for delegation management
+- `@metamask/delegation-abis` - Contract ABIs for the delegation framework
+- `@metamask/delegation-deployments` - Contract deployment addresses
+
+## Links
+
+- [MetaMask Delegation Framework](https://github.com/MetaMask/delegation-framework)
+- [EIP-7715: Delegated Authorization](https://eips.ethereum.org/EIPS/eip-7715)