@rareprotocol/rare-cli 1.0.0 → 1.0.2

package/README.md

@@ -19,6 +19,7 @@ rare --help
 ```
 
 See [CHANGELOG.md](./CHANGELOG.md) for release notes and migration guidance.
+For generated reference maps, see [rare-cli-commands.md](./rare-cli-commands.md) and [rare-cli-sdk-client-functions.md](./rare-cli-sdk-client-functions.md).
 
 ## Getting Started
 
@@ -80,13 +81,29 @@ rare configure --show
 
 Private keys are masked in the output. Configured account addresses are shown.
 
+### 4. Configure Uniswap fallback routes (optional)
+
+`rare swap buy-token` and `rare swap sell-token` can fall back to the hosted Uniswap API when `--route auto` cannot build a local route, or when you force `--route uniswap`. Those routes require a Uniswap API key in rare's per-chain wallet config:
+
+```bash
+rare configure --chain sepolia --uniswap-api-key your-uniswap-api-key
+```
+
+You can store the API key in 1Password instead:
+
+```bash
+rare configure --chain sepolia --uniswap-api-key-ref op://Private/uniswap/api-key
+```
+
+The CLI verifies the 1Password reference during configuration, then resolves it only if a hosted Uniswap route is actually needed. Normal user workflows do not read Uniswap keys from `.env` files.
+
 ## Usage
 
 Most chain-aware commands accept `--chain` or `--chain-id` to select a network. Defaults to the configured default chain, or `sepolia` when no default is configured.
 
 Supported chains: `mainnet`, `sepolia`, `base`, `base-sepolia`
 
-Feature deployment varies by chain. Batch listing, batch offer, RareMinter release, Liquid Edition, and swap flows are currently available on `mainnet` and `sepolia`; batch auction addresses are also configured for `base` and `base-sepolia`.
+Feature deployment varies by chain. Batch listing, batch offer, batch auction, RareMinter release, Liquid Edition, and swap flows are currently available on `mainnet` and `sepolia`.
 
 ### Deploy an NFT Collection
 
@@ -575,6 +592,8 @@ rare swap tokens \
 
 `buy-token` and `sell-token` accept `--route auto`, `--route local`, `--route uniswap`, or `--route raw`. Raw route execution requires `--commands`, `--inputs-file`, and `--min-amount-out`.
 
+With `--route auto`, the CLI tries the local liquid-router path first. If no canonical local route is available, it uses the hosted Uniswap API and requires `uniswapApiKey` or `uniswapApiKeyRef` in the selected chain config.
+
 ### Search
 
 ```bash
@@ -847,7 +866,7 @@ await rare.import.erc721({
 
 ## Configuration
 
-Config is stored at `~/.rare/config.json`. Each chain has its own key source and RPC URL. A key source can be a plaintext `privateKey` or a 1Password `privateKeyRef` plus a derived public address. `rare configure --show` prints the account address for configured key sources.
+Config is stored at `~/.rare/config.json`. Each chain has its own key source, RPC URL, and optional Uniswap API key source. A wallet key source can be a plaintext `privateKey` or a 1Password `privateKeyRef` plus a derived public address. A Uniswap API key source can be a plaintext `uniswapApiKey` or a 1Password `uniswapApiKeyRef`. `rare configure --show` prints the account address for configured key sources and masks plaintext secrets.
 
 ```bash
 # Set private key and RPC for a chain
@@ -856,6 +875,12 @@ rare configure --chain sepolia --private-key 0x... --rpc-url https://...
 # Set a 1Password-backed private key reference and RPC for a chain
 rare configure --chain sepolia --private-key-ref op://Private/rare-sepolia/private-key --rpc-url https://...
 
+# Set a Uniswap API key for hosted swap fallback routes
+rare configure --chain sepolia --uniswap-api-key your-uniswap-api-key
+
+# Or keep the Uniswap API key in 1Password
+rare configure --chain sepolia --uniswap-api-key-ref op://Private/uniswap/api-key
+
 # Configure multiple chains
 rare configure --chain base --rpc-url https://your-base-rpc.com
 rare configure --chain base-sepolia --private-key 0x... --rpc-url https://your-base-sepolia-rpc.com
@@ -884,6 +909,7 @@ RARE_API_BASE_URL=https://rare-api.example.com rare listing batch buy --contract
 - **Use sepolia for testing.** Default to sepolia and only switch to mainnet when you're ready.
 - **Set a reliable RPC endpoint.** Public endpoints throttle and drop requests. Services like Alchemy or Infura provide free tiers.
 - **Prefer 1Password for private keys.** Install the 1Password CLI, run `op signin`, and configure keys with `--private-key-ref` to avoid storing plaintext keys in rare config.
+- **Prefer 1Password for Uniswap API keys.** Configure hosted swap fallback routes with `--uniswap-api-key-ref` when you do not want API keys stored in plaintext config.
 - **Don't share your private key.** If you use `--private-key` or generated saved wallets, keep `~/.rare/config.json` secure and never commit it to version control.
 - **Check status before transacting.** Use `rare status` and `rare auction status` to inspect on-chain state before sending transactions.
 - **Back up your wallet.** If you lose your private key, you lose access to your assets. Store a copy somewhere safe.
@@ -916,8 +942,8 @@ Batch, approval, Liquid Edition, and swap infrastructure:
 |---|---|---|---|---|---|---|---|---|---|
 | Sepolia | `0xF2bE72d4343beD375Cb6d0E799a3c003163860e0` | `0x371cca54ef859bb0c7b910581a528ee47773fd56` | `0x293AE7701A7830B1d38A7608EdF86A106d9E2645` | `0x972dEe8fa339ad2D9c6cbDA31b67f98Fac242d13` | `0x4619eB29e84392CE91C27FC936A5c94d1D14b93f` | `0x5fa0a461d3a2Ea3bFDf03e8BD37CAbB4ae84205E` | `0xb1777091C953fa2aC1fD67f2b3e2f61343F5Ce5e` | `0x429c3Ee66E7f6CDA12C5BadE4104aF3277aA2305` | `0x61B3f2011A92d183C7dbaDBdA940a7555Ccf9227` |
 | Mainnet | `0x6a190885A806D39A0A8C348bfA1ac762D72E608d` | `0xe15cf80b25272ade261532efdb7912f9104851d4` | `0x71742c7196f1c334C4c038ce6dcDcEE98097F9Da` | `0x61DBF87164d33FD3695256DC8Ba74D3B1d304170` | `0xa837a7eAff154Ab837617Cf7250648D3Ec0A4436` | `0x4bb0Deea6d1A30C601338aAB776d394C2AE5c0F8` | `0xbb4341CFd588a098e9aCE1D224178836426c4a8E` | `0xEBd58EdA8408d9EA409f2c2bE8898BD9738f3583` | `0x52F0E24D1c21C8A0cB1e5a5dD6198556BD9E1203` |
-| Base Sepolia | — | — | `0x2b181ae0f1aea6fed75591b04991b1a3f9868d51` | — | — | — | — | — | — |
-| Base | — | — | `0xf776204233bfb52ba0ddff24810cbdbf3dbf94dd` | — | — | — | — | — | — |
+| Base Sepolia | — | — | — | — | — | — | — | — | — |
+| Base | — | — | — | — | — | — | — | — | — |
 
 ## Underlying Solidity Contracts
 

package/dist/client.d.ts

@@ -1960,6 +1960,46 @@ type CollectionRoyaltyInfoResult = {
     defaultReceiver?: Address;
     defaultPercentage?: bigint;
 };
+type CollectionStatusParams = {
+    contract: Address;
+    tokenId?: IntegerInput;
+    price?: IntegerInput;
+};
+type CollectionStatusResult = {
+    contract: Address;
+    name?: string;
+    symbol?: string;
+    owner?: Address;
+    totalSupply?: bigint;
+    maxTokens?: bigint;
+    disabled?: boolean;
+    tokenUrisLocked?: boolean;
+    batchCount?: bigint;
+    defaultReceiver?: Address;
+    defaultPercentage?: bigint;
+    interfaces?: {
+        erc165?: boolean;
+        erc721?: boolean;
+        erc721Metadata?: boolean;
+        erc2981?: boolean;
+    };
+    mintConfig?: {
+        tokenCount: bigint;
+        baseUri: string;
+        lockedMetadata: boolean;
+    };
+    token?: {
+        tokenId: bigint;
+        owner?: Address;
+        tokenUri?: string;
+        creator?: Address;
+        royalty?: {
+            salePrice: bigint;
+            receiver: Address;
+            amount: bigint;
+        };
+    };
+};
 type CollectionSetDefaultRoyaltyReceiverParams = {
     contract: Address;
     receiver: Address;
@@ -1991,9 +2031,9 @@ type CollectionMintConfigParams = {
 };
 type CollectionMintConfigResult = {
     contract: Address;
-    tokenCount: bigint;
-    baseUri: string;
-    lockedMetadata: boolean;
+    tokenCount?: bigint;
+    baseUri?: string;
+    lockedMetadata?: boolean;
 };
 type CollectionUpdateBaseUriParams = {
     contract: Address;
@@ -2036,6 +2076,7 @@ type CollectionDeployNamespace = {
 };
 type CollectionNamespace = {
     get: (id: string) => Promise<Collection>;
+    status: (params: CollectionStatusParams) => Promise<CollectionStatusResult>;
     deploy: CollectionDeployNamespace;
     mint: (params: CollectionMintParams) => Promise<CollectionMintResult>;
     mintBatch: (params: CollectionMintBatchParams) => Promise<CollectionMintBatchResult>;
@@ -2215,6 +2256,7 @@ type ReleaseConfigureParams = {
     maxMints: IntegerInput;
     splitAddresses?: Address[];
     splitRatios?: number[];
+    autoApprove?: boolean;
 };
 type ReleaseConfigureResult = {
     rareMinter: Address;
@@ -2225,6 +2267,7 @@ type ReleaseConfigureResult = {
     maxMints: bigint;
     splitRecipients: Address[];
     splitRatios: number[];
+    approvalTxHash?: Hash;
 } & TransactionResult;
 type ReleaseMintDirectSaleParams = {
     contract: Address;
@@ -2747,6 +2790,17 @@ type RareClientConfig = {
      * Optional fetch implementation for API-backed SDK methods.
      */
     apiFetch?: typeof fetch;
+    /**
+     * Optional Uniswap Trade API key used when token trades require the hosted
+     * Uniswap route.
+     */
+    uniswapApiKey?: string;
+    /**
+     * Optional lazy Uniswap Trade API key resolver. Prefer this when the key
+     * lives in an external secret manager and should only be read if a hosted
+     * Uniswap route is actually needed.
+     */
+    resolveUniswapApiKey?: () => Promise<string | undefined>;
 };
 type RareClientNftSearchParams = Omit<NftSearchParams, 'chainId'>;
 type RareClientCollectionSearchParams = Omit<CollectionSearchParams, 'chainId'>;
@@ -2888,4 +2942,4 @@ declare class PaymentApprovalRequiredError extends Error {
     });
 }
 
-export { AmountInput, type AuctionBidParams, type AuctionBidResult, type AuctionCancelParams, type AuctionCreateParams, type AuctionCreateResult, type AuctionMarketplaceNamespace, type AuctionNamespace, type AuctionSettleParams, type AuctionStatus, type AuctionStatusParams, type BatchAuctionBidParams, type BatchAuctionBidResult, type BatchAuctionCancelParams, type BatchAuctionCancelResult, type BatchAuctionCreateParams, type BatchAuctionCreateResult, type BatchAuctionNamespace, type BatchAuctionRootSource, type BatchAuctionRootsParams, type BatchAuctionSettleParams, type BatchAuctionSettleResult, type BatchAuctionStatus, type BatchAuctionStatusParams, BatchListingNamespace, type BatchOfferAcceptParams, type BatchOfferAcceptResult, type BatchOfferCreateParams, type BatchOfferCreateResult, type BatchOfferNamespace, type BatchOfferRevokeParams, type BatchOfferRevokeResult, type BatchOfferRootSource, type BatchOfferStatus, type BatchOfferStatusParams, BuildUtilsTreeParams, type BuyRareParams, type BuyRareQuote, type BuyRareResult, type BuyTokenParams, type Collection, type CollectionDeployNamespace, type CollectionLockBaseUriParams, type CollectionLockBaseUriResult, type CollectionMintBatchParams, type CollectionMintBatchResult, type CollectionMintConfigParams, type CollectionMintConfigResult, type CollectionMintParams, type CollectionMintResult, type CollectionNamespace, type CollectionPrepareLazyMintParams, type CollectionPrepareLazyMintResult, type CollectionRoyaltyInfoParams, type CollectionRoyaltyInfoResult, type CollectionSearchParams, type CollectionSetDefaultRoyaltyPercentageParams, type CollectionSetDefaultRoyaltyPercentageResult, type CollectionSetDefaultRoyaltyReceiverParams, type CollectionSetDefaultRoyaltyReceiverResult, type CollectionSetTokenRoyaltyReceiverParams, type CollectionSetTokenRoyaltyReceiverResult, type CollectionTokenCreatorParams, type CollectionTokenCreatorResult, type CollectionUpdateBaseUriParams, type CollectionUpdateBaseUriResult, type CollectionUpdateTokenUriParams, type CollectionUpdateTokenUriResult, CurrencyInfo, CurrencyInput, type CurrencyNamespace, type CurvePresetKey, type DeployErc721Params, type DeployErc721Result, type DeployLazyBatchMintParams, type DeployLazyBatchMintResult, type DeployLazyErc721Params, type DeployLazyErc721Result, type DeployLiquidEditionParams, type DeployLiquidEditionResult, type EventSearchParams, type GeneratePresetCurvesParams, type GeneratePresetCurvesResult, type ImportErc721Params, type ImportNamespace, IntegerInput, type LiquidCurvePreview, type LiquidCurveSegment, type LiquidEditionCurrentPrice, type LiquidEditionMarketState, type LiquidEditionNamespace, type LiquidEditionPoolInfo, type LiquidEditionPoolKey, type LiquidEditionTelemetry, type LiquidFactoryConfig, type LiquidRouterTokenTradeQuote, type ListingBuyParams, type ListingBuyResult, type ListingCancelParams, type ListingCreateParams, type ListingCreateResult, type ListingMarketplaceNamespace, type ListingNamespace, type ListingStatus, type ListingStatusParams, type MediaNamespace, type Nft, NftApprovalRequiredError, type NftAttribute, type NftEvent, type NftMediaEntry, type NftNamespace, type NftSearchParams, type OfferAcceptParams, type OfferAcceptResult, type OfferCancelParams, type OfferCreateParams, type OfferCreateResult, type OfferMarketplaceNamespace, type OfferNamespace, type OfferStatus, type OfferStatusParams, type Pagination, PaymentApprovalRequiredError, type PinMetadataParams, type RareClient, type RareClientCollectionSearchParams, type RareClientConfig, type RareClientContracts, type RareClientEventSearchParams, type RareClientNftGetParams, type RareClientNftSearchParams, type ReleaseAllowlistArtifact, type ReleaseAllowlistConfig, type ReleaseAllowlistInputFormat, type ReleaseAllowlistNamespace, type ReleaseAllowlistWalletProof, type ReleaseConfigureParams, type ReleaseConfigureResult, type ReleaseLimitConfig, type ReleaseLimitsNamespace, type ReleaseMintDirectSaleParams, type ReleaseMintDirectSaleResult, type ReleaseNamespace, type ReleaseSetAllowlistConfigParams, type ReleaseSetAllowlistConfigResult, type ReleaseSetLimitParams, type ReleaseSetLimitResult, type ReleaseStatus, type ReleaseStatusParams, ResolvedCurrency, ResolvedCurrencyWithDecimals, type RouterBuyParams, type RouterSellParams, type RouterSwapTokensParams, type SearchNamespace, type SearchPageResponse, type SellTokenParams, type SetLiquidEditionRenderContractParams, type SetLiquidEditionRenderContractResult, type SwapNamespace, TimestampInput, type TokenContractInfo, type TokenInfo, type TokenNamespace, type TokenStatus, type TokenTradeBaseParams, type TokenTradeExecution, type TokenTradeExecutionRoute, type TokenTradeQuote, type TokenTradeQuoteBase, type TokenTradeQuoteParams, type TokenTradeRawRouteParams, type TokenTradeResult, type TokenTradeRouteMode, type TokenTradeRouteSource, TransactionResult, type UniswapApiTokenTradeQuote, type UserNamespace, type UserProfile, UtilsMerkleProofArtifact, UtilsMerkleProofParams, type UtilsNamespace, UtilsTreeArtifact, UtilsTreeProofArtifact, UtilsTreeProofParams, UtilsTreeProofVerifyParams, type ValidateLiquidCurvesParams, createRareClient };
+export { AmountInput, type AuctionBidParams, type AuctionBidResult, type AuctionCancelParams, type AuctionCreateParams, type AuctionCreateResult, type AuctionMarketplaceNamespace, type AuctionNamespace, type AuctionSettleParams, type AuctionStatus, type AuctionStatusParams, type BatchAuctionBidParams, type BatchAuctionBidResult, type BatchAuctionCancelParams, type BatchAuctionCancelResult, type BatchAuctionCreateParams, type BatchAuctionCreateResult, type BatchAuctionNamespace, type BatchAuctionRootSource, type BatchAuctionRootsParams, type BatchAuctionSettleParams, type BatchAuctionSettleResult, type BatchAuctionStatus, type BatchAuctionStatusParams, BatchListingNamespace, type BatchOfferAcceptParams, type BatchOfferAcceptResult, type BatchOfferCreateParams, type BatchOfferCreateResult, type BatchOfferNamespace, type BatchOfferRevokeParams, type BatchOfferRevokeResult, type BatchOfferRootSource, type BatchOfferStatus, type BatchOfferStatusParams, BuildUtilsTreeParams, type BuyRareParams, type BuyRareQuote, type BuyRareResult, type BuyTokenParams, type Collection, type CollectionDeployNamespace, type CollectionLockBaseUriParams, type CollectionLockBaseUriResult, type CollectionMintBatchParams, type CollectionMintBatchResult, type CollectionMintConfigParams, type CollectionMintConfigResult, type CollectionMintParams, type CollectionMintResult, type CollectionNamespace, type CollectionPrepareLazyMintParams, type CollectionPrepareLazyMintResult, type CollectionRoyaltyInfoParams, type CollectionRoyaltyInfoResult, type CollectionSearchParams, type CollectionSetDefaultRoyaltyPercentageParams, type CollectionSetDefaultRoyaltyPercentageResult, type CollectionSetDefaultRoyaltyReceiverParams, type CollectionSetDefaultRoyaltyReceiverResult, type CollectionSetTokenRoyaltyReceiverParams, type CollectionSetTokenRoyaltyReceiverResult, type CollectionStatusParams, type CollectionStatusResult, type CollectionTokenCreatorParams, type CollectionTokenCreatorResult, type CollectionUpdateBaseUriParams, type CollectionUpdateBaseUriResult, type CollectionUpdateTokenUriParams, type CollectionUpdateTokenUriResult, CurrencyInfo, CurrencyInput, type CurrencyNamespace, type CurvePresetKey, type DeployErc721Params, type DeployErc721Result, type DeployLazyBatchMintParams, type DeployLazyBatchMintResult, type DeployLazyErc721Params, type DeployLazyErc721Result, type DeployLiquidEditionParams, type DeployLiquidEditionResult, type EventSearchParams, type GeneratePresetCurvesParams, type GeneratePresetCurvesResult, type ImportErc721Params, type ImportNamespace, IntegerInput, type LiquidCurvePreview, type LiquidCurveSegment, type LiquidEditionCurrentPrice, type LiquidEditionMarketState, type LiquidEditionNamespace, type LiquidEditionPoolInfo, type LiquidEditionPoolKey, type LiquidEditionTelemetry, type LiquidFactoryConfig, type LiquidRouterTokenTradeQuote, type ListingBuyParams, type ListingBuyResult, type ListingCancelParams, type ListingCreateParams, type ListingCreateResult, type ListingMarketplaceNamespace, type ListingNamespace, type ListingStatus, type ListingStatusParams, type MediaNamespace, type Nft, NftApprovalRequiredError, type NftAttribute, type NftEvent, type NftMediaEntry, type NftNamespace, type NftSearchParams, type OfferAcceptParams, type OfferAcceptResult, type OfferCancelParams, type OfferCreateParams, type OfferCreateResult, type OfferMarketplaceNamespace, type OfferNamespace, type OfferStatus, type OfferStatusParams, type Pagination, PaymentApprovalRequiredError, type PinMetadataParams, type RareClient, type RareClientCollectionSearchParams, type RareClientConfig, type RareClientContracts, type RareClientEventSearchParams, type RareClientNftGetParams, type RareClientNftSearchParams, type ReleaseAllowlistArtifact, type ReleaseAllowlistConfig, type ReleaseAllowlistInputFormat, type ReleaseAllowlistNamespace, type ReleaseAllowlistWalletProof, type ReleaseConfigureParams, type ReleaseConfigureResult, type ReleaseLimitConfig, type ReleaseLimitsNamespace, type ReleaseMintDirectSaleParams, type ReleaseMintDirectSaleResult, type ReleaseNamespace, type ReleaseSetAllowlistConfigParams, type ReleaseSetAllowlistConfigResult, type ReleaseSetLimitParams, type ReleaseSetLimitResult, type ReleaseStatus, type ReleaseStatusParams, ResolvedCurrency, ResolvedCurrencyWithDecimals, type RouterBuyParams, type RouterSellParams, type RouterSwapTokensParams, type SearchNamespace, type SearchPageResponse, type SellTokenParams, type SetLiquidEditionRenderContractParams, type SetLiquidEditionRenderContractResult, type SwapNamespace, TimestampInput, type TokenContractInfo, type TokenInfo, type TokenNamespace, type TokenStatus, type TokenTradeBaseParams, type TokenTradeExecution, type TokenTradeExecutionRoute, type TokenTradeQuote, type TokenTradeQuoteBase, type TokenTradeQuoteParams, type TokenTradeRawRouteParams, type TokenTradeResult, type TokenTradeRouteMode, type TokenTradeRouteSource, TransactionResult, type UniswapApiTokenTradeQuote, type UserNamespace, type UserProfile, UtilsMerkleProofArtifact, UtilsMerkleProofParams, type UtilsNamespace, UtilsTreeArtifact, UtilsTreeProofArtifact, UtilsTreeProofParams, UtilsTreeProofVerifyParams, type ValidateLiquidCurvesParams, createRareClient };