@rareprotocol/rare-cli 0.2.2 → 0.4.1

package/README.md

@@ -1,6 +1,6 @@
 # RARE Protocol CLI
 
-Command-line tool for the [RARE Protocol](https://superrare.com) on Ethereum. Deploy NFT contracts, mint tokens, run auctions, and search the network — all from your terminal.
+Command-line tool for the [RARE Protocol](https://superrare.com) on Ethereum. Deploy NFT contracts, mint tokens, run auctions, create offers and listings, and search the network — all from your terminal.
 
 ## Install
 
@@ -149,6 +149,56 @@ rare auction cancel --contract 0x... --token-id 1
 rare auction status --contract 0x... --token-id 1
 ```
 
+### Offers
+
+```bash
+# Create an offer on a token
+rare offer create --contract 0x... --token-id 1 --amount 0.5
+
+# Create an offer with ERC20 currency
+rare offer create --contract 0x... --token-id 1 --amount 100 --currency usdc
+
+# Accept an offer on a token you own
+rare offer accept --contract 0x... --token-id 1 --amount 0.5
+
+# Cancel your offer
+rare offer cancel --contract 0x... --token-id 1
+
+# Check offer status (read-only)
+rare offer status --contract 0x... --token-id 1
+```
+
+### Listings
+
+```bash
+# List a token for sale at a fixed price
+rare listing create --contract 0x... --token-id 1 --price 1.0
+
+# List with ERC20 currency or a targeted buyer
+rare listing create --contract 0x... --token-id 1 --price 100 --currency rare --target 0x...buyer
+
+# Buy a listed token
+rare listing buy --contract 0x... --token-id 1 --amount 1.0
+
+# Cancel a listing
+rare listing cancel --contract 0x... --token-id 1
+
+# Check listing status (read-only)
+rare listing status --contract 0x... --token-id 1
+```
+
+### Currencies
+
+All marketplace commands (`auction`, `offer`, `listing`) accept `--currency` to specify a payment token. Named currencies (`eth`, `usdc`, `rare`) are resolved per-chain automatically. You can also pass any ERC20 address directly.
+
+ERC20 allowances are auto-approved when needed for bids, offers, and purchases.
+
+```bash
+# List supported currencies and their addresses
+rare currencies
+rare currencies --chain mainnet
+```
+
 ### Search
 
 ```bash
@@ -191,6 +241,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.