@lydianpay/lydianconnect 1.0.0 → 1.0.1

package/README.md

@@ -1,9 +1,7 @@
 # @lydianpay/lydianconnect
 
-Wallet-connection library for Lydian frontends. It connects to a user's wallet
-through the wallet's **native SDK** when one exists (MetaMask, Coinbase) and
-falls back to **WalletConnect** for everything else — behind a single uniform
-API, so your app never branches on which path was used.
+One API for every wallet. LydianConnect abstracts the messy differences between
+wallet connection methods into a single, uniform interface.
 
 ## Install
 
@@ -14,70 +12,39 @@ npm install @lydianpay/lydianconnect
 ## Usage
 
 ```ts
-import {
-  LydianConnect,
-  WalletConnectConnector,
-  MetaMaskConnector,
-  CoinbaseConnector,
-} from '@lydianpay/lydianconnect';
+import { LydianConnect } from '@lydianpay/lydianconnect';
 
 const lc = new LydianConnect({
-  connectors: [
-    new MetaMaskConnector({ dappMetadata: { name: 'My App', url: location.origin } }),
-    new CoinbaseConnector({ appName: 'My App' }),
-  ],
-  fallback: new WalletConnectConnector({
-    projectId: 'your-walletconnect-project-id',
-    metadata: {
-      name: 'My App',
-      description: 'My App',
-      url: location.origin,
-      icons: ['https://my.app/icon.png'],
-    },
-  }),
-});
-
-// One call — the result is identical whether it routes to a native SDK or
-// to WalletConnect. Your app never branches on the source.
-const conn = await lc.connect({
-  walletId: 'metamask',
-  namespace: {
-    name: 'eip155',
-    value: { chains: ['eip155:1'], methods: ['eth_sendTransaction'], events: [] },
-  },
+  appName: 'My App',
+  walletConnectProjectId: 'your-wc-project-id',
+  icon: 'https://my.app/icon.png',   // optional
+  description: 'My App checkout',     // optional
 });
 
+const conn = await lc.connect({ walletId: 'metamask', chainId: 137 });
 const txHash = await conn.request({ method: 'eth_sendTransaction', params: [tx] });
 
 lc.on((event) => {
-  // 'connect' | 'disconnect' | 'chainChanged' | 'accountsChanged'
-  // | 'display_uri' | 'wallet_open_failed'
+  // 'connect' | 'disconnect' | 'chainChanged' | 'accountsChanged' | 'display_uri' | 'wallet_open_failed'
 });
 ```
 
-`conn` is the uniform handle: `{ walletId, account, chainId, request, disconnect }`.
-Encoding/signing (ethers, viem, …) stays in your app — this library only moves
-opaque RPC requests.
-
-## Supported wallets
-
-- **Native SDK:** MetaMask, Coinbase
-- **WalletConnect fallback:** every other WalletConnect-compatible wallet, with
-  per-wallet deep-linking generated from the WalletConnect explorer registry
+## Config
 
-## Development
+| Field | Required | Notes |
+|-------|----------|-------|
+| `appName` | yes | Display name shown in the wallet's connect prompt. |
+| `walletConnectProjectId` | yes | WalletConnect Cloud project id. |
+| `icon` | no | Icon shown in the connect prompt. |
+| `description` | no | Defaults to `appName`. |
 
-See [CLAUDE.md](./CLAUDE.md) for architecture, conventions, and the wallet-link
-registry generator (`scripts/build-wallet-links.mjs`).
+`connect({ walletId, chainId })` — `chainId` is the chain the user is paying on (a number like `137`, or a CAIP-2 id like `'eip155:137'`).
 
-```bash
-npm install
-npm run build        # ESM + CJS + d.ts
-npm run lint
-npm run typecheck
-npm test
-```
+## Supported wallets
 
-## License
+**Native SDK:** MetaMask, Coinbase Wallet.
 
-MIT
+**WalletConnect:** Rainbow, Trust Wallet, OKX Wallet, Crypto.com, Phantom, Zerion,
+Argent, Ledger, 1inch, SafePal, imToken, TokenPocket, Blockchain.com, Exodus,
+Ronin Wallet, Coin98, Bitget Wallet, Infinity Wallet, Atomic Wallet, AlphaWallet,
+MathWallet, BitPay — each with native deep-linking.