catapultar 0.1.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,161 @@
+## Catapultar Typescript Library
+
+Catapultar is a compact TypeScript library for managing Catapultar smart accounts. It provides a reliable and portable wrapper around account and transaction flows to build, sign, and execute account-level operations reliably.
+
+## Key Features
+- Utilities for interacting with the Catapultar smart account
+- Ethers and viem compatibility.
+- Natural language transaction creation.
+- Helpers for account and factory interactions to simplify common tasks
+
+### Library Structure
+
+4 Main classes are exported:
+- **BaseTransaction** — Minimal transaction interface without validation.
+- **CatapultarAccount** — Catapultar Smart Account management.
+- **CatapultarTx** — Creating transaction for existing smart accounts.
+- **MetaCatapultarTx** — High level batch transactions.
+
+Depending on your use case, you may prefer either a high level or low level transaction creation.
+
+- **CatapultarTx** depends on **BaseTransaction** and **CatapultarAccount**.
+- **MetaCatapultarTx** depends on **CatapultarTx**
+
+## Installation
+This repository uses Bun. From the project root, install dependencies with:
+
+```bash
+bun install
+```
+
+## Usage (Overview)
+Catapultar is RPC-less by default. If an RPC is provided to the library, validation will be enhanced with on-chain information including:
+- Nonce validation
+- Account version selection
+- Simulation
+- EIP-1271 signature validation
+- Get deployed transactions in transaction.
+
+Catapultar is verioned, meaning accounts can be versioned to their respective version. Unless an RPC is provided to the library, it is important that the version of the account is provided to explicitly enable or disable flows.
+
+### Actionables (Signables and Executables)
+While Catapultar uses viem under-the-hood, you need to bring your own execution and signing service / library. Catapultar exports actionable objects as either `Signable`-ish or `Executable` which are directly compatible with viem and almost directly compatible into Ethers. If you are using external signers, you need to port these objects.
+
+Signable objects are exported as:
+```typescript
+type Signable = {
+  domain: {
+      name: string;
+      version: string;
+      chainId?: bigint;
+      verifyingContract: `0x${string}`;
+  };
+  types: { /** Universal typed const */ };
+  primaryType: string;
+  message: { /** Typed Message */};
+}
+```
+Note that Ether's "`Signable`" looks like:
+```typescript
+type EthersSignable = {
+  domain: {
+      name: string;
+      version: string;
+      chainId?: bigint;
+      verifyingContract: `0x${string}`;
+  };
+  types: { /** Universal typed const */ };
+  data: { /** Typed Message */};
+}
+```
+
+Executable objects are exported as: 
+```typescript
+type Executable = {
+  to: `0x${string}`;
+  value: bigint;
+  data: `0x${string}`;
+}
+```
+
+### Account deploy
+
+TODO
+
+### Transaction Creation
+
+```typescript
+const account = {
+  address,
+  chainId,
+  owner,
+}
+CatapultarTx;
+
+const tx = new CatapultarTx({account});
+const call = (await tx.addCalls(...calls).sign((v) => viemWalletClient.signTypedData({account, ...v}))).asCall();
+
+viemWalletClient.sendTransaction({
+  account,
+  ...call // unpack call into viem. 
+});
+```
+
+### Embed
+
+In some cases, you may want to execute an action on behalf of another user — they are the primary custodian but a pre-approved call has been configured.
+Catapultar can be configured for this use case by embedded a call (or signature) digest.
+
+To create embedded accounts, use **BaseTransaction**.
+
+```typescript
+const embeddedCalls: {to: `0x${string}`, data: `0x${string}`, value: bigint}[];
+
+const tx = new BaseTransaction();
+
+tx.setRandomNonce();
+tx.setMode(ExecutionMode.RaiseRevert);
+tx.addCalls(...embeddedCalls);
+
+
+const context = tx.asAccount(...);
+// {
+//   deployCall // Call to deploy the account. Save, if lost account may not be recoverable.
+//   actionCall, // Call to call on the account.
+//   callDigest, // Digest of the embedded call. Can be ignored.
+//   address, // Address of the contract once deployed.
+// }
+```
+
+### Constrained Asset Transaction (CAT)
+
+CATs are transactions that can be executed using an account's assets given a certain output. In an intent factory use case, you may want to generate an account with a CAT embedded to later execute arbitrary data against it.
+
+To create a CAT use **ConstrainedAssetTransaction**. You can then convert it to a **BaseTransaction** to get the embedded account.
+
+```typescript
+const executor: `0x${string}`;
+const allowances: { token: `0x${string}`; amount: bigint; }[];
+const outcomes: { token: `0x${string}`; amount: bigint; destination: `0x${string}` }[];
+
+const cat = new ConstrainedAssetTransaction({executor});
+cat.addAllowances(...allowances);
+cat.addOutcomes(...outcomes);
+
+const tx = tx.asCatapultarAllowanceTransaction();
+const context = tx.asAccount(...);
+
+const entryCall = tx.asExecuteCall({address: context.address, ...})
+
+// then you need to execute [context.deployCall, context.actionCall, entryCall]
+```
+
+See `src/transaction/constrainedtransaction.spec.ts::create account and execute contained constraints` for an example.
+
+## Project Layout
+- `src/catapultar/` — core account and factory logic
+- `src/transaction/` — low level transaction logic
+- `src/abi/` — Contract ABIs
+- `src/types/` — shared TypeScript types
+- `src/utils/` — helper utilities
+

package/dist/abi/CATValidator.d.ts

@@ -0,0 +1,174 @@
+export declare const CAT_VALIDATOR_ABI: readonly [{
+    readonly type: "constructor";
+    readonly inputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "CALL_PROXY";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "DOMAIN_SEPARATOR";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "eip712Domain";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "fields";
+        readonly type: "bytes1";
+        readonly internalType: "bytes1";
+    }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "version";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "chainId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "verifyingContract";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "extensions";
+        readonly type: "uint256[]";
+        readonly internalType: "uint256[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "entry";
+    readonly inputs: readonly [{
+        readonly name: "execTarget";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "execPayload";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }, {
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "allowances";
+        readonly type: "tuple[]";
+        readonly internalType: "struct AllowanceSpend[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "allocated";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "spend";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }];
+    }, {
+        readonly name: "outcomes";
+        readonly type: "tuple[]";
+        readonly internalType: "struct Outcome[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "destination";
+            readonly type: "address";
+            readonly internalType: "address";
+        }];
+    }, {
+        readonly name: "signature";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "spentNonces";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "error";
+    readonly name: "AllocationTooSmall";
+    readonly inputs: readonly [{
+        readonly name: "allocated";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "spend";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "BadSignature";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidTokenAmount";
+    readonly inputs: readonly [{
+        readonly name: "expected";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "received";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "NonceAlreadySpent";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "Reentrancy";
+    readonly inputs: readonly [];
+}];
+//# sourceMappingURL=CATValidator.d.ts.map

package/dist/abi/CATValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CATValidator.d.ts","sourceRoot":"","sources":["../../src/abi/CATValidator.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+NpB,CAAC"}