@aa-sdk/core 4.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alchemy Insights, 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, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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,54 @@
+# `@aa-sdk/core`
+
+This package contains the core interfaces and components for interacting with 4337 infrastructure. The primary interfaces that it exports are the `SmartAccountProvider` and `BaseSmartContractAccount`.
+
+The `SmartAccountProvider` is an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant Provider that wraps JSON RPC methods and some Wallet Methods (signing, sendTransaction, etc). With this Provider, you can submit User Operations to RPC providers, estimate gas, configure a Paymaster, send standard JSON RPC requests, and more. It is not opinionated about which RPC provider you are using and is configurable to work with any RPC provider. Because it implements EIP-1193, it can be used with any web3 library.
+
+The `BaseSmartContractAccount` interface defines how you would interact with your Smart Contract Account. Any class that extends `BaseSmartContractAccount` may also expose additional methods that allow its connecting `SmartAccountProvider` to provide ergonomic utilities for building and submitting `User Operation`s.
+
+## Getting started
+
+To get started, first install the package:
+
+```bash [yarn]
+yarn add @aa-sdk/core
+```
+
+```bash [npm]
+npm i -s @aa-sdk/core
+```
+
+```bash [pnpm]
+pnpm i @aa-sdk/core
+```
+
+## Usage
+
+You can create a provider like so:
+
+```typescript
+import { createMultiOwnerModularAccount } from "@alchemy/aa-accounts";
+import {
+  LocalAccountSigner,
+  SmartAccountSigner,
+  createSmartAccountClient,
+  polygonMumbai,
+} from "@aa-sdk/core";
+import { http } from "viem";
+
+const chain = polygonMumbai;
+const signer: SmartAccountSigner = LocalAccountSigner.mnemonicToAccountSigner(
+  "YOUR_OWNER_MNEMONIC"
+);
+const rpcTransport = http("https://polygon-mumbai.g.alchemy.com/v2/demo");
+
+export const smartAccountClient = createSmartAccountClient({
+  transport: rpcTransport,
+  chain,
+  account: await createMultiOwnerModularAccount({
+    transport: rpcTransport,
+    chain,
+    signer,
+  }),
+});
+```