@rareprotocol/rare-cli 0.2.1 → 0.3.0

package/README.md

@@ -70,9 +70,7 @@ Private keys are masked in the output.
 
 All commands accept `--chain` to select a network. Defaults to `sepolia`.
 
-Supported chains: `mainnet`, `sepolia`, `base`, `base-sepolia`
-
-> **Note:** RARE Protocol deploy and auction commands are currently available on `mainnet` and `sepolia` only.
+Supported chains (including deploy, mint, import, and auction flows): `mainnet`, `sepolia`, `base`, `base-sepolia`
 
 ### Deploy an NFT Collection
 
@@ -193,6 +191,82 @@ rare status --contract 0x...
 rare status --contract 0x... --token-id 1
 ```
 
+## SDK Client Usage
+
+Use the client export when integrating RARE flows directly in your app code.
+
+```bash
+npm install @rareprotocol/rare-cli viem
+```
+
+### Create a client
+
+```ts
+import { createPublicClient, createWalletClient, http } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+import { sepolia } from 'viem/chains';
+import { createRareClient } from '@rareprotocol/rare-cli/client';
+
+const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`);
+const publicClient = createPublicClient({
+  chain: sepolia,
+  transport: http(process.env.RPC_URL),
+});
+
+const walletClient = createWalletClient({
+  account,
+  chain: sepolia,
+  transport: http(process.env.RPC_URL),
+});
+
+const rare = createRareClient({ publicClient, walletClient });
+```
+
+### Search
+
+`search.nfts` auto-applies the client chain unless you pass `chainIds`.
+
+```ts
+const nfts = await rare.search.nfts({ query: 'portrait', take: 10 });
+const collections = await rare.search.collections({ ownerAddresses: [account.address] });
+```
+
+### Upload media and mint
+
+`media.upload` accepts a `Uint8Array` (Node `Buffer` works directly).
+
+```ts
+import { readFile } from 'node:fs/promises';
+
+const imageBytes = await readFile('./art.png');
+const image = await rare.media.upload(imageBytes, 'art.png');
+
+const tokenUri = await rare.media.pinMetadata({
+  name: 'My NFT',
+  description: 'Minted with the SDK client',
+  image,
+  tags: ['art'],
+});
+
+const minted = await rare.mint.mintTo({
+  contract: '0xYourContractAddress',
+  tokenUri,
+  to: '0xRecipientAddress',
+});
+
+console.log(minted.tokenId);
+```
+
+### Import an ERC-721 collection
+
+`import.erc721` derives `chainId` from the client. If `owner` is omitted, it defaults to the configured account.
+
+```ts
+await rare.import.erc721({
+  contract: '0xYourContractAddress',
+});
+```
+
 ## Configuration
 
 Config is stored at `~/.rare/config.json`. Each chain has its own private key and RPC URL.
@@ -203,7 +277,7 @@ rare configure --chain sepolia --private-key 0x... --rpc-url https://...
 
 # Configure multiple chains
 rare configure --chain base --rpc-url https://your-base-rpc.com
-rare configure --chain arbitrum --private-key 0x... --rpc-url https://your-arb-rpc.com
+rare configure --chain base-sepolia --private-key 0x... --rpc-url https://your-base-sepolia-rpc.com
 
 # Change default network
 rare configure --default-chain mainnet
@@ -226,6 +300,8 @@ rare configure --show
 |---|---|---|
 | Sepolia | `0x3c7526a0975156299ceef369b8ff3c01cc670523` | `0xC8Edc7049b233641ad3723D6C60019D1c8771612` |
 | Mainnet | `0xAe8E375a268Ed6442bEaC66C6254d6De5AeD4aB1` | `0x6D7c44773C52D396F43c2D511B81aa168E9a7a42` |
+| Base Sepolia | `0x2b181ae0f1aea6fed75591b04991b1a3f9868d51` | `0x1f0c946f0ee87acb268d50ede6c9b4d010af65d2` |
+| Base | `0xf776204233bfb52ba0ddff24810cbdbf3dbf94dd` | `0x51c36ffb05e17ed80ee5c02fa83d7677c5613de2` |
 
 ## Underlying Solidity Contracts