@skalenetwork/privacy-sdk 0.1.0-develop.1 → 0.1.0-develop.2

package/README.md

@@ -10,9 +10,12 @@ npm install @skalenetwork/privacy-sdk
 
 ## Quick Start
 
+The SDK accepts any signer that implements `{ address, sendTransaction }`. Here's how to initialize with popular web3 libraries:
+
+### With viem
+
 ```typescript
 import { ConfidentialWrapper } from "@skalenetwork/privacy-sdk";
-import { deriveViewerKeypair } from "@skalenetwork/privacy-sdk/utils";
 import { createWalletClient, http } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 
@@ -27,6 +30,56 @@ const token = new ConfidentialWrapper({
     sendTransaction: (tx) => walletClient.sendTransaction({ ...tx, chain: null }),
   },
 });
+```
+
+### With ethers v6
+
+```typescript
+import { ConfidentialWrapper } from "@skalenetwork/privacy-sdk";
+import { Wallet, JsonRpcProvider } from "ethers";
+
+const provider = new JsonRpcProvider(RPC_URL);
+const wallet = new Wallet("0x...", provider);
+
+const token = new ConfidentialWrapper({
+  rpcUrl: RPC_URL,
+  address: WRAPPER_ADDRESS,
+  signer: {
+    address: wallet.address as `0x${string}`,
+    sendTransaction: async (tx) => {
+      const resp = await wallet.sendTransaction(tx);
+      return resp.hash as `0x${string}`;
+    },
+  },
+});
+```
+
+### With web3.js
+
+```typescript
+import { ConfidentialWrapper } from "@skalenetwork/privacy-sdk";
+import Web3 from "web3";
+
+const web3 = new Web3(RPC_URL);
+const account = web3.eth.accounts.privateKeyToAccount("0x...");
+
+const token = new ConfidentialWrapper({
+  rpcUrl: RPC_URL,
+  address: WRAPPER_ADDRESS,
+  signer: {
+    address: account.address as `0x${string}`,
+    sendTransaction: async (tx) => {
+      const receipt = await web3.eth.sendTransaction({ from: account.address, ...tx });
+      return receipt.transactionHash as `0x${string}`;
+    },
+  },
+});
+```
+
+### Usage
+
+```typescript
+import { deriveViewerKeypair } from "@skalenetwork/privacy-sdk/utils";
 
 // Derive viewer keypair from a signed message (do this once per account)
 const sig = await walletClient.signMessage({ message: "SKALE Privacy Viewer Key", account });
@@ -35,11 +88,10 @@ token.setViewerPrivateKey(privateKey);
 await token.registerViewerPublicKey(publicKey);
 
 // Wrap underlying ERC-20 → confidential token (approve underlying first)
-const { ctxHash } = await token.wrap(account.address, 1000n).waitForCtx();
+const { ctxHash: wrapCtxHash } = await token.wrap(account.address, 1000n).waitForCtx();
 
-// Confidential transfer — await for origin hash, .waitForCtx() for the full CTX result
-const hash = await token.transfer(recipient, 500n);
-const { originHash, ctxHash } = await token.transfer(recipient, 500n).waitForCtx();
+// Confidential transfer
+const { ctxHash: transferCtxHash, ctxReceipt } = await token.transfer(recipient, 500n).waitForCtx();
 
 // Decrypt balance
 const balance = await token.decryptBalance();
@@ -50,7 +102,7 @@ await token.unwrap(account.address, 500n).waitForCtx();
 
 ## Docs
 
-- [Concepts](https://github.com/skalenetwork/private-pay/blob/main/packages/privacy-sdk/docs/concepts.md) — CTX lifecycle, viewer keys, CtxPromise pattern
-- [Architecture](https://github.com/skalenetwork/private-pay/blob/main/packages/privacy-sdk/docs/architecture.md) — three-layer design (facades / actions / utils)
-- [API Reference](https://github.com/skalenetwork/private-pay/blob/main/packages/privacy-sdk/docs/api.md) — full method tables for all exports
+- [Concepts](https://github.com/skalenetwork/privacy-sdk/blob/develop/docs/concepts.md) — CTX lifecycle, viewer keys, CtxPromise pattern
+- [Architecture](https://github.com/skalenetwork/privacy-sdk/blob/develop/docs/architecture.md) — three-layer design (facades / actions / utils)
+- [API Reference](https://github.com/skalenetwork/privacy-sdk/blob/develop/docs/api.md) — full method tables for all exports