@charterlabs/rhinestone-sdk 0.1.13 → 0.2.1

package/README.md

@@ -1,107 +1,214 @@
-# @charterlabs/rhinestone-sdk
+# Rhinestone SDK
 
-A production-ready fork of the Rhinestone SDK with enhanced WebAuthn support for Charter Labs.
+End-to-end chain abstraction and modularity toolkit
 
-## 🚀 Enhanced Features
+## Usage
 
-### Superior WebAuthn Implementation
-- **Multi-credential support** - Register multiple WebAuthn devices per account
-- **Threshold signatures** - M-of-N security model for enterprise use
-- **User verification control** - Configurable UV requirements per credential
-- **WebAuthn standard compliance** - Proper credential ID handling
-- **Production-ready** - Handles real-world multi-device scenarios
+### Installation
 
-### Key Improvements Over Upstream
-- ✅ **Multi-device support** vs single credential limitation
-- ✅ **WebAuthn standard compliance** vs non-standard hashing
-- ✅ **Security flexibility** vs fixed UV policies
-- ✅ **Enterprise features** vs demo/MVP approach
+```bash
+npm install viem @rhinestone/sdk
+```
 
-## Installation
+```bash
+pnpm install viem @rhinestone/sdk
+```
 
 ```bash
-npm install @charterlabs/rhinestone-sdk viem
-# or
-bun add @charterlabs/rhinestone-sdk viem
+yarn add viem @rhinestone/sdk
 ```
 
-## Quick Start
+```bash
+bun install viem @rhinestone/sdk
+```
+
+## Quickstart
+
+You'll need a Rhinestone API key, as well as an existing account with some testnet ETH on the source chain.
+
+### Creating a Wallet
 
-```typescript
-import { createRhinestoneAccount } from '@charterlabs/rhinestone-sdk'
+Let's create a smart account with a single owner:
+
+```ts
+import { createRhinestoneAccount } from '@rhinestone/sdk'
 import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts'
+import { baseSepolia, arbitrumSepolia, optimismSepolia } from 'viem/chains'
+import {
+  Chain,
+  createPublicClient,
+  createWalletClient,
+  encodeFunctionData,
+  erc20Abi,
+  Hex,
+  http,
+  parseEther,
+} from 'viem'
+
+const fundingPrivateKey = process.env.FUNDING_PRIVATE_KEY
+if (!fundingPrivateKey) {
+  throw new Error('FUNDING_PRIVATE_KEY is not set')
+}
+
+const rhinestoneApiKey = process.env.RHINESTONE_API_KEY
+if (!rhinestoneApiKey) {
+  throw new Error('RHINESTONE_API_KEY is not set')
+}
+
+const sourceChain = baseSepolia
+const targetChain = arbitrumSepolia
+
+// You can use an existing PK here
+const privateKey = generatePrivateKey()
+console.info(`Owner private key: ${privateKey}`)
+const account = privateKeyToAccount(privateKey)
 
-// Create account with WebAuthn support
 const rhinestoneAccount = await createRhinestoneAccount({
   owners: {
-    type: 'passkey',
-    account: webAuthnAccount, // Your WebAuthn account
-    credentialIds: ['0x...', '0x...'] // Multiple credential IDs
-  },
-  rhinestoneApiKey: 'your-api-key'
+    type: 'ecdsa',
+    accounts: [account],
+  }
+  rhinestoneApiKey,
 })
+const address = await rhinestoneAccount.getAddress()
+console.info(`Smart account address: ${address}`)
 ```
 
-## WebAuthn Features
+### Funding the Account
+
+We will send some ETH from the funding account to the created smart account. The Orchestrator will use some of that ETH to deploy the account on the target chain, as well as to convert it to USDC for a transfer transaction.
+
+```ts
+const publicClient = createPublicClient({
+  chain: sourceChain,
+  transport: http(),
+});
+const fundingAccount = privateKeyToAccount(fundingPrivateKey as Hex);
+const fundingClient = createWalletClient({
+  account: fundingAccount,
+  chain: sourceChain,
+  transport: http(),
+});
+
+const txHash = await fundingClient.sendTransaction({
+  to: address,
+  value: parseEther('0.001'),
+});
+await publicClient.waitForTransactionReceipt({ hash: txHash });
+```
 
-### Multi-Credential Support
-```typescript
-// Register multiple devices
-const config = {
-  owners: {
-    type: 'passkey',
-    account: webAuthnAccount,
-    credentialIds: [
-      '0x1234...', // Phone
-      '0x5678...', // Laptop
-      '0x9abc...'  // Security key
-    ]
-  }
-}
+### Sending a Cross-chain Transaction
+
+Finally, let's make a cross-chain token transfer:
+
+```ts
+const usdcTarget = '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d';
+const usdcAmount = 1n;
+
+const transaction = await rhinestoneAccount.sendTransaction({
+  sourceChain,
+  targetChain,
+  calls: [
+    {
+      to: usdcTarget,
+      value: 0n,
+      data: encodeFunctionData({
+        abi: erc20Abi,
+        functionName: 'transfer',
+        args: ['0xd8da6bf26964af9d7eed9e03e53415d37aa96045', usdcAmount],
+      }),
+    },
+  ],
+  tokenRequests: [
+    {
+      address: usdcTarget,
+      amount: usdcAmount,
+    },
+  ],
+});
+console.info('Transaction', transaction);
+
+const transactionResult = await rhinestoneAccount.waitForExecution(transaction);
+console.info('Result', transactionResult);
 ```
 
-### Threshold Signatures
-```typescript
-// Require 2-of-3 signatures
-const config = {
+After running that, you will get a smart account deployed on both Base Sepolia and Arbitrum Sepolia, and make a cross-chain USDC transfer.
+
+### Using Smart Sessions
+
+First, define a session you want to use:
+
+```ts
+const session: Session = {
   owners: {
-    type: 'multi-factor',
-    validators: [phoneValidator, laptopValidator, securityKeyValidator],
-    threshold: 2
-  }
+    type: 'ecdsa',
+    accounts: [sessionOwner],
+  },
+  actions: [
+    {
+      target: wethAddress,
+      selector: toFunctionSelector(
+        getAbiItem({
+          abi: wethAbi,
+          name: 'deposit',
+        }),
+      ),
+    },
+    {
+      target: wethAddress,
+      selector: toFunctionSelector(
+        getAbiItem({
+          abi: wethAbi,
+          name: 'transfer',
+        }),
+      ),
+      policies: [
+        {
+          type: 'universal-action',
+          rules: [
+            {
+              condition: 'equal',
+              calldataOffset: 0n,
+              referenceValue: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
+            },
+          ],
+        },
+      ],
+    },
+  ],
 }
 ```
 
-### User Verification Control
-```typescript
-// Configure UV requirements per credential
-const validator = getWebAuthnValidator({
-  pubKey: publicKey,
-  authenticatorId: 'device-id',
-  requireUV: true // Require user verification
+During account initialization, provide the session you've just created. Make sure to also provide a bundler configuration.
+
+```ts
+const rhinestoneAccount = await createRhinestoneAccount({
+  // …
+  sessions: [session],
+  bundler: {
+    // …
+  },
 })
 ```
 
-## Development
-
-```bash
-# Install dependencies
-bun install
+When making a transaction, specify the `signers` object to sign it with the session key:
 
-# Build
-bun run build
+```ts
+const transactionResult = await rhinestoneAccount.sendTransaction({
+  // …
+  signers: {
+    type: 'session',
+    session: session,
+  },
+})
+```
 
-# Test
-bun run test
+## Migrating from Orchestrator SDK
 
-# Create changeset
-bun run changeset
+To migrate from the [Orchestrator SDK](https://github.com/rhinestonewtf/orchestrator-sdk), replace all imports of `@rhinestone/orchestrator-sdk` with `@rhinestone/sdk/orchestrator`.
 
-# Version and publish
-bun run changeset:version
-bun run changeset:release
-```
+Let us know if you encounter any issues!
 
-## License
+## Contributing
 
-MIT - Charter Labs
+For feature or change requests, feel free to open a PR, start a discussion or get in touch with us.

package/dist/src/accounts/index.d.ts

@@ -1,4 +1,4 @@
-import { type Account, type Address, type Chain, type Hex, type PublicClient } from 'viem';
+import { type Chain, type HashTypedDataParameters, type Hex, type PublicClient, type TypedData } from 'viem';
 import type { Module } from '../modules/common';
 import type { EnableSessionData } from '../modules/validators/smart-sessions';
 import type { AccountProviderConfig, Call, OwnerSet, RhinestoneAccountConfig, Session, SignerSet } from '../types';
@@ -17,12 +17,13 @@ declare function getModuleInstallationCalls(config: RhinestoneAccountConfig, mod
 declare function getModuleUninstallationCalls(config: RhinestoneAccountConfig, module: Module): Call[];
 declare function getAddress(config: RhinestoneAccountConfig): `0x${string}`;
 declare function getPackedSignature(config: RhinestoneAccountConfig, signers: SignerSet | undefined, chain: Chain, validator: ValidatorConfig, hash: Hex, transformSignature?: (signature: Hex) => Hex): Promise<`0x${string}`>;
-declare function isDeployed(chain: Chain, config: RhinestoneAccountConfig): Promise<boolean>;
+declare function getTypedDataPackedSignature<typedData extends TypedData | Record<string, unknown> = TypedData, primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData>(config: RhinestoneAccountConfig, signers: SignerSet | undefined, chain: Chain, validator: ValidatorConfig, parameters: HashTypedDataParameters<typedData, primaryType>, transformSignature?: (signature: Hex) => Hex): Promise<`0x${string}`>;
+declare function isDeployed(config: RhinestoneAccountConfig, chain: Chain): Promise<boolean>;
 declare function deploy(config: RhinestoneAccountConfig, chain: Chain, session?: Session): Promise<void>;
-declare function deployStandaloneWithEoa(chain: Chain, config: RhinestoneAccountConfig, deployer: Account): Promise<Address>;
-declare function getSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain): Promise<import("viem/account-abstraction").SmartAccount<import("viem/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
-declare function getSmartSessionSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain, session: Session, enableData: EnableSessionData | null): Promise<import("viem/account-abstraction").SmartAccount<import("viem/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
-declare function getGuardianSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain, guardians: OwnerSet): Promise<import("viem/account-abstraction").SmartAccount<import("viem/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
+declare function toErc6492Signature(config: RhinestoneAccountConfig, signature: Hex, chain: Chain): Promise<Hex>;
+declare function getSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain): Promise<import("viem/_types/account-abstraction").SmartAccount<import("viem/_types/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
+declare function getSmartSessionSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain, session: Session, enableData: EnableSessionData | null): Promise<import("viem/_types/account-abstraction").SmartAccount<import("viem/_types/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
+declare function getGuardianSmartAccount(config: RhinestoneAccountConfig, client: PublicClient, chain: Chain, guardians: OwnerSet): Promise<import("viem/_types/account-abstraction").SmartAccount<import("viem/_types/account-abstraction").SmartAccountImplementation<import("viem").Abi, "0.7">>>;
 declare function getAccountProvider(config: RhinestoneAccountConfig): AccountProviderConfig;
-export { getModuleInstallationCalls, getModuleUninstallationCalls, getAddress, getAccountProvider, getInitCode, signEip7702InitData, getEip7702InitCall, isDeployed, deploy, getSmartAccount, getSmartSessionSmartAccount, getGuardianSmartAccount, getPackedSignature, deployStandaloneWithEoa, isAccountError, AccountError, Eip7702AccountMustHaveEoaError, ExistingEip7702AccountsNotSupportedError, FactoryArgsNotAvailableError, SmartSessionsNotEnabledError, SigningNotSupportedForAccountError, SignMessageNotSupportedByAccountError, Eip7702NotSupportedForAccountError, };
+export { getModuleInstallationCalls, getModuleUninstallationCalls, getAddress, getAccountProvider, getInitCode, signEip7702InitData, getEip7702InitCall, isDeployed, deploy, toErc6492Signature, getSmartAccount, getSmartSessionSmartAccount, getGuardianSmartAccount, getPackedSignature, getTypedDataPackedSignature, isAccountError, AccountError, Eip7702AccountMustHaveEoaError, ExistingEip7702AccountsNotSupportedError, FactoryArgsNotAvailableError, SmartSessionsNotEnabledError, SigningNotSupportedForAccountError, SignMessageNotSupportedByAccountError, Eip7702NotSupportedForAccountError, };
 //# sourceMappingURL=index.d.ts.map

package/dist/src/accounts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../accounts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,KAAK,EAMV,KAAK,GAAG,EACR,KAAK,YAAY,EAOlB,MAAM,MAAM,CAAA;AASb,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAS/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EACV,qBAAqB,EACrB,IAAI,EACJ,QAAQ,EAGR,uBAAuB,EACvB,OAAO,EACP,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,YAAY,EACZ,8BAA8B,EAC9B,kCAAkC,EAClC,wCAAwC,EACxC,4BAA4B,EAC5B,cAAc,EACd,kCAAkC,EAClC,qCAAqC,EACrC,4BAA4B,EAC7B,MAAM,SAAS,CAAA;AAuChB,OAAO,EAAmB,KAAK,eAAe,EAAE,MAAM,SAAS,CAAA;AAoB/D,iBAAS,WAAW,CAAC,MAAM,EAAE,uBAAuB;;;cAanD;AAED,iBAAe,mBAAmB,CAAC,MAAM,EAAE,uBAAuB,0BAgBjE;AAED,iBAAe,kBAAkB,CAC/B,MAAM,EAAE,uBAAuB,EAC/B,SAAS,EAAE,GAAG;;;GAaf;AAED,iBAAS,0BAA0B,CACjC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,MAAM,GACb,IAAI,EAAE,CA2BR;AAED,iBAAS,4BAA4B,CACnC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,MAAM,GACb,IAAI,EAAE,CA6BR;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,uBAAuB,iBAsBlD;AAGD,iBAAe,kBAAkB,CAC/B,MAAM,EAAE,uBAAuB,EAC/B,OAAO,EAAE,SAAS,GAAG,SAAS,EAC9B,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,eAAe,EAC1B,IAAI,EAAE,GAAG,EACT,kBAAkB,GAAE,CAAC,SAAS,EAAE,GAAG,KAAK,GAA8B,0BAoCvE;AAED,iBAAe,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,uBAAuB,oBAiBtE;AAED,iBAAe,MAAM,CACnB,MAAM,EAAE,uBAAuB,EAC/B,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,OAAO,iBAMlB;AAwBD,iBAAe,uBAAuB,CACpC,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,uBAAuB,EAC/B,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,OAAO,CAAC,CAmClB;AAED,iBAAe,eAAe,CAC5B,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,sJA6Cb;AAED,iBAAe,2BAA2B,CACxC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,iBAAiB,GAAG,IAAI,sJAyDrC;AAED,iBAAe,uBAAuB,CACpC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,QAAQ,sJAqDpB;AAqKD,iBAAS,kBAAkB,CACzB,MAAM,EAAE,uBAAuB,GAC9B,qBAAqB,CAOvB;AAuCD,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,UAAU,EACV,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,MAAM,EACN,eAAe,EACf,2BAA2B,EAC3B,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EAEvB,cAAc,EACd,YAAY,EACZ,8BAA8B,EAC9B,wCAAwC,EACxC,4BAA4B,EAC5B,4BAA4B,EAC5B,kCAAkC,EAClC,qCAAqC,EACrC,kCAAkC,GACnC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../accounts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,KAAK,EAKV,KAAK,uBAAuB,EAC5B,KAAK,GAAG,EAER,KAAK,YAAY,EAEjB,KAAK,SAAS,EAEf,MAAM,MAAM,CAAA;AAGb,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAM/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EACV,qBAAqB,EACrB,IAAI,EACJ,QAAQ,EACR,uBAAuB,EACvB,OAAO,EACP,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,YAAY,EACZ,8BAA8B,EAC9B,kCAAkC,EAClC,wCAAwC,EACxC,4BAA4B,EAC5B,cAAc,EACd,kCAAkC,EAClC,qCAAqC,EACrC,4BAA4B,EAC7B,MAAM,SAAS,CAAA;AA2ChB,OAAO,EAAmB,KAAK,eAAe,EAAE,MAAM,SAAS,CAAA;AAoB/D,iBAAS,WAAW,CAAC,MAAM,EAAE,uBAAuB;;;cAanD;AAED,iBAAe,mBAAmB,CAAC,MAAM,EAAE,uBAAuB,0BAgBjE;AAED,iBAAe,kBAAkB,CAC/B,MAAM,EAAE,uBAAuB,EAC/B,SAAS,EAAE,GAAG;;;GAaf;AAED,iBAAS,0BAA0B,CACjC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,MAAM,GACb,IAAI,EAAE,CA2BR;AAED,iBAAS,4BAA4B,CACnC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,MAAM,GACb,IAAI,EAAE,CA6BR;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,uBAAuB,iBAsBlD;AAGD,iBAAe,kBAAkB,CAC/B,MAAM,EAAE,uBAAuB,EAC/B,OAAO,EAAE,SAAS,GAAG,SAAS,EAC9B,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,eAAe,EAC1B,IAAI,EAAE,GAAG,EACT,kBAAkB,GAAE,CAAC,SAAS,EAAE,GAAG,KAAK,GAA8B,0BAwBvE;AAGD,iBAAe,2BAA2B,CACxC,SAAS,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EACjE,WAAW,SAAS,MAAM,SAAS,GAAG,cAAc,GAAG,MAAM,SAAS,EAEtE,MAAM,EAAE,uBAAuB,EAC/B,OAAO,EAAE,SAAS,GAAG,SAAS,EAC9B,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,eAAe,EAC1B,UAAU,EAAE,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,EAC3D,kBAAkB,GAAE,CAAC,SAAS,EAAE,GAAG,KAAK,GAA8B,0BA6BvE;AAED,iBAAe,UAAU,CAAC,MAAM,EAAE,uBAAuB,EAAE,KAAK,EAAE,KAAK,oBAiBtE;AAED,iBAAe,MAAM,CACnB,MAAM,EAAE,uBAAuB,EAC/B,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,OAAO,iBAMlB;AAyBD,iBAAe,kBAAkB,CAC/B,MAAM,EAAE,uBAAuB,EAC/B,SAAS,EAAE,GAAG,EACd,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,GAAG,CAAC,CAwBd;AAED,iBAAe,eAAe,CAC5B,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,oKA6Cb;AAED,iBAAe,2BAA2B,CACxC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,iBAAiB,GAAG,IAAI,oKAyDrC;AAED,iBAAe,uBAAuB,CACpC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,QAAQ,oKAqDpB;AAMD,iBAAS,kBAAkB,CACzB,MAAM,EAAE,uBAAuB,GAC9B,qBAAqB,CAOvB;AAED,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,UAAU,EACV,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,2BAA2B,EAC3B,uBAAuB,EACvB,kBAAkB,EAClB,2BAA2B,EAE3B,cAAc,EACd,YAAY,EACZ,8BAA8B,EAC9B,wCAAwC,EACxC,4BAA4B,EAC5B,4BAA4B,EAC5B,kCAAkC,EAClC,qCAAqC,EACrC,kCAAkC,GACnC,CAAA"}