@walletmesh/aztec-rpc-wallet 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @walletmesh/aztec-rpc-wallet
+
+## 0.1.0
+
+### Minor Changes
+
+- 0597281: Overhaul of (formerly) @walletmesh/aztec-rpc & rename to @walletmesh/aztec-rpc-wallet

package/LICENSE

@@ -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 [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,260 @@
+# WalletMesh Aztec RPC Wallet Library
+
+[@walletmesh/aztec-rpc-wallet](https://github.com/WalletMesh/aztec/tree/main/packages/aztec-rpc-wallet) provides a type-safe RPC interface for interacting with [Aztec](https://aztec.network) wallets. It consists of three main components:
+
+- **AztecProvider**: Client-side provider for dApps to communicate with Aztec wallets
+- **AztecChainWallet**: Server-side implementation that handles RPC requests using an Aztec wallet instance
+- **AztecOperationBuilder**: Fluent API for chaining multiple RPC method calls
+
+The library is built on [@walletmesh/jsonrpc](https://github.com/WalletMesh/wm-core/tree/main/packages/jsonrpc#readme) and [@walletmesh/router](https://github.com/WalletMesh/wm-core/tree/main/packages/router#readme).
+
+## Features
+
+- Connect to multiple Aztec chains simultaneously
+- Flexible chain ID support (any string with 'aztec:' prefix)
+- Type-safe RPC interfaces with comprehensive TypeScript definitions
+- Efficient batching of multiple method calls
+- Fluent chaining API for bulk operations
+- Comprehensive error handling
+- Contract artifact caching
+- Event handling for wallet state changes
+- Serialization support for all Aztec data types
+- Support for encrypted and unencrypted events/logs
+
+## Installation
+
+```bash
+npm install @walletmesh/aztec-rpc-wallet
+```
+
+## Core RPC Methods
+
+The library supports a comprehensive set of RPC methods:
+
+### Chain Operations
+- `aztec_connect`: Connect to Aztec chains
+- `aztec_getBlock`: Get block by number
+- `aztec_getBlockNumber`: Get current block number
+- `aztec_getProvenBlockNumber`: Get proven block number
+- `aztec_getChainId`: Get chain ID
+- `aztec_getVersion`: Get protocol version
+- `aztec_getNodeInfo`: Get node information
+- `aztec_getPXEInfo`: Get PXE information
+- `aztec_getCurrentBaseFees`: Get current base fees
+
+### Account Operations
+- `aztec_getAccount`: Get wallet's account address
+- `aztec_getAddress`: Get wallet's Aztec address
+- `aztec_getCompleteAddress`: Get complete address details
+- `aztec_registerAccount`: Register a new account
+- `aztec_getRegisteredAccounts`: Get all registered accounts
+
+### Transaction Operations
+- `aztec_sendTransaction`: Send one or more transactions
+- `aztec_simulateTransaction`: Simulate transaction without executing
+- `aztec_sendTx`: Send raw transaction
+- `aztec_createTxExecutionRequest`: Create transaction execution request
+- `aztec_proveTx`: Generate transaction proof
+- `aztec_getTxEffect`: Get transaction effect
+- `aztec_getTxReceipt`: Get transaction receipt
+
+### Contract Operations
+- `aztec_registerContract`: Register contract instance
+- `aztec_registerContractClass`: Register contract class
+- `aztec_getContracts`: Get registered contracts
+- `aztec_getContractInstance`: Get contract instance details
+- `aztec_getContractClass`: Get contract class details
+- `aztec_getContractArtifact`: Get contract artifact
+- `aztec_isContractClassPubliclyRegistered`: Check if contract class is publicly registered
+- `aztec_isContractPubliclyDeployed`: Check if contract is publicly deployed
+- `aztec_isContractInitialized`: Check if contract is initialized
+- `aztec_getPublicStorageAt`: Get public storage value
+
+### Authorization & Scope Management
+- `aztec_setScopes`: Set authorization scopes
+- `aztec_getScopes`: Get current scopes
+- `aztec_addAuthWitness`: Add authorization witness
+- `aztec_getAuthWitness`: Get authorization witness
+- `aztec_createAuthWit`: Create authorization witness
+
+### Notes and Events
+- `aztec_getIncomingNotes`: Get incoming notes
+- `aztec_addNote`: Add note
+- `aztec_addNullifiedNote`: Add nullified note
+- `aztec_getUnencryptedLogs`: Get unencrypted logs
+- `aztec_getContractClassLogs`: Get contract class logs
+- `aztec_getEncryptedEvents`: Get encrypted events
+- `aztec_getUnencryptedEvents`: Get unencrypted events
+
+### L1->L2 Bridge Operations
+- `aztec_isL1ToL2MessageSynced`: Check if L1->L2 message is synced
+- `aztec_getL1ToL2MembershipWitness`: Get L1->L2 membership witness
+
+See [src/types.ts](https://github.com/WalletMesh/aztec/blob/main/packages/aztec-rpc-wallet/src/types.ts) for complete method definitions and parameters.
+
+## Usage Examples
+
+### Basic Provider Usage
+
+```typescript
+import { AztecProvider } from '@walletmesh/aztec-rpc-wallet';
+
+// Create provider with transport
+const provider = new AztecProvider(transport);
+
+// Connect to chains
+await provider.connect(['aztec:testnet', 'aztec:devnet']);
+
+// Get account address
+const address = await provider.getAccount('aztec:testnet');
+
+// Send transaction
+const txHash = await provider.sendTransaction('aztec:testnet', {
+  functionCalls: [{
+    contractAddress: "0x1234...",
+    functionName: "transfer",
+    args: [recipient, amount]
+  }]
+});
+
+// Register contract
+await provider.registerContract('aztec:testnet', {
+  instance: contractInstance,
+  artifact: contractArtifact // optional if class already registered
+});
+
+// Listen for chain connection events
+provider.on('chain:connected', ({ chainId }) => {
+  console.log(`Connected to chain: ${chainId}`);
+});
+
+// Listen for chain disconnection events
+provider.on('chain:disconnected', ({ chainId }) => {
+  console.log(`Disconnected from chain: ${chainId}`);
+});
+```
+
+### Chaining API for Bulk Operations
+
+The provider supports a fluent chaining API for executing multiple operations efficiently:
+
+```typescript
+// Multiple reads in single batch
+const [account, contracts, blockNumber] = await provider
+  .chain('aztec:testnet')
+  .call('aztec_getAccount')
+  .call('aztec_getContracts')
+  .call('aztec_getBlockNumber')
+  .execute();
+
+// Contract setup and interaction
+const [classId, instanceId, txHash] = await provider
+  .chain('aztec:testnet')
+  .call('aztec_registerContractClass', { artifact: contractArtifact })
+  .call('aztec_registerContract', { 
+    instance: contractInstance,
+    artifact: contractArtifact
+  })
+  .call('aztec_sendTransaction', {
+    functionCalls: [{
+      contractAddress: contractInstance.address,
+      functionName: 'initialize',
+      args: [param1, param2]
+    }]
+  })
+  .execute();
+
+// Multi-chain operations
+const [testnetData, devnetData] = await Promise.all([
+  provider
+    .chain('aztec:testnet')
+    .call('aztec_getAccount')
+    .call('aztec_getContracts')
+    .execute(),
+  provider
+    .chain('aztec:devnet')
+    .call('aztec_getAccount')
+    .call('aztec_getContracts')
+    .execute()
+]);
+```
+
+### Error Handling
+
+The library provides comprehensive error handling through `AztecWalletError`:
+
+```typescript
+try {
+  await provider.sendTransaction('aztec:testnet', {
+    functionCalls: [{
+      contractAddress: "0x1234...",
+      functionName: "transfer",
+      args: [recipient, amount]
+    }]
+  });
+} catch (error) {
+  if (error instanceof AztecWalletError) {
+    switch (error.code) {
+      case -32001: // User refused
+        console.log('Transaction rejected by user');
+        break;
+      case -32002: // Wallet not connected
+        console.log('Please connect wallet first');
+        break;
+      default:
+        console.error('RPC error:', error.message);
+    }
+  }
+}
+```
+
+### Implementing a Wallet
+
+Server-side implementation using `AztecWallet`:
+
+```typescript
+import { AztecChainWallet } from '@walletmesh/aztec-rpc-wallet';
+import type { PXE, AccountWallet } from '@aztec/aztec.js';
+
+// Create wallet instance
+const wallet = new AztecChainWallet(
+  pxe,           // PXE instance
+  accountWallet, // Aztec AccountWallet instance
+  transport     // Transport layer
+);
+
+// Handle incoming requests
+transport.on('message', async (request) => {
+  const response = await wallet.handleRequest(request);
+  // Send response back to dApp
+});
+
+// Use with WalletMesh router
+const routerClient = wallet.asWalletRouterClient();
+```
+
+## Error Codes
+
+Common error codes returned by the library:
+
+- -32000: Unknown internal error
+- -32001: User refused transaction
+- -32002: Wallet not connected
+- -32003: Contract instance not registered
+- -32004: Contract class not registered
+- -32005: Sender not registered
+- -32006: Invalid response format
+- -32007: Not connected to any chain
+- -32008: Chain not supported
+- -32009: Invalid request format
+- -32010: Invalid parameters
+- -32011: Permission denied
+- -32012: Session not found
+- -32013: Session expired
+- -32014: Transaction not found
+- -32015: Block not found
+- -32016: Authorization witness not found
+
+## Example Project
+
+See the [example project](https://github.com/WalletMesh/aztec/tree/main/packages/example) for a complete implementation using this library.