Fix params for docs (#1309)

* Fix params for docs

* small code cleanup

* fix base client src

Author: iainnash

.changeset/rotten-candles-confess.md

@@ -0,0 +1,5 @@
+---
+"@zoralabs/coins-sdk": patch
+---
+
+Small trade types fixes

docs/pages/coins/sdk/create-coin.mdx

@@ -17,7 +17,7 @@ import { DeployCurrency, InitialPurchaseCurrency, ValidMetadataURI } from "@zora
 type CreateCoinArgs = {
   name: string;             // The name of the coin (e.g., "My Awesome Coin")
   symbol: string;           // The trading symbol for the coin (e.g., "MAC")
-  uri: ValidMetadataURI;              // Metadata URI (an IPFS URI is recommended)
+  uri: ValidMetadataURI;    // Metadata URI (an IPFS URI is recommended)
   chainId?: number;         // The chain ID (defaults to base mainnet)
   owners?: Address[];       // Optional array of owner addresses, defaults to [payoutRecipient]
   payoutRecipient: Address; // Address that receives creator earnings
@@ -163,8 +163,9 @@ If you're using WAGMI in your frontend application, you can use the lower-level
 ```typescript
 import * as React from "react";
 import { createCoinCall, DeployCurrency, InitialPurchaseCurrency, ValidMetadataURI } from "@zoralabs/coins-sdk";
-import { Address } from "viem";
+import { Address, parseEther } from "viem";
 import { useWriteContract, useSimulateContract } from "wagmi";
+import { base } from "viem/chains";
 
 // Define coin parameters
 const coinParams = {
@@ -173,12 +174,12 @@ const coinParams = {
   uri: "ipfs://bafybeigoxzqzbnxsn35vq7lls3ljxdcwjafxvbvkivprsodzrptpiguysy" as ValidMetadataURI,
   payoutRecipient: "0xYourAddress" as Address,
   platformReferrer: "0xOptionalPlatformReferrerAddress" as Address,
-  // chainId: base.id, // Optional: defaults to base.id
-  // currency: DeployCurrency.ZORA, // Optional: ZORA or ETH
-  // initialPurchase: { // Optional: Purchase initial supply during creation
-  //   currency: InitialPurchaseCurrency.ETH,
-  //   amount: 0.01n * 10n ** 18n, // 0.01 ETH in wei
-  // },
+  chainId: base.id, // Optional: defaults to base.id
+  currency: DeployCurrency.ZORA, // Optional: ZORA or ETH
+  initialPurchase: { // Optional: Purchase initial supply during creation
+    currency: InitialPurchaseCurrency.ETH,
+    amount: parseEther("0.01"), // 0.01 ETH in wei
+  },
 };
 
 // Create configuration for wagmi

docs/pages/coins/sdk/trade-coin.mdx

@@ -43,12 +43,12 @@ const tradeParameters: TradeParameters = {
   sender: account.address,
 };
 
-const receipt = await tradeCoin(
+const receipt = await tradeCoin({
   tradeParameters,
   walletClient,
   account,
-  publicClient
-);
+  publicClient,
+});
 ```
 
 ### Trading Creator Coin for ETH
@@ -65,12 +65,12 @@ const tradeParameters: TradeParameters = {
   sender: account.address,
 };
 
-const receipt = await tradeCoin(
+const receipt = await tradeCoin({
   tradeParameters,
   walletClient,
   account,
-  publicClient
-);
+  publicClient,
+});
 ```
 
 ### Trading USDC for Creator Coin (with Permits)
@@ -94,12 +94,12 @@ const tradeParameters: TradeParameters = {
   sender: account.address,
 };
 
-const receipt = await tradeCoin(
+const receipt = await tradeCoin({
   tradeParameters,
   walletClient,
   account,
-  publicClient
-);
+  publicClient,
+});
 ```
 
 ### Trading Between ERC20 Tokens
@@ -124,12 +124,44 @@ const tradeParameters: TradeParameters = {
   sender: account.address,
 };
 
-const receipt = await tradeCoin(
+const receipt = await tradeCoin({
+  tradeParameters,
+  walletClient,
+  account,
+  publicClient,
+});
+```
+
+### Disabling Transaction Validation
+
+By default, `tradeCoin` validates transactions before execution. You can disable this for faster execution:
+
+```typescript
+const receipt = await tradeCoin({
+  tradeParameters,
+  walletClient,
+  account,
+  publicClient,
+  validateTransaction: false, // Skip validation and gas estimation
+});
+```
+
+## Function Signature
+
+```typescript
+async function tradeCoin({
   tradeParameters,
   walletClient,
   account,
-  publicClient
-);
+  publicClient,
+  validateTransaction = true,
+}: {
+  tradeParameters: TradeParameters;
+  walletClient: WalletClient;
+  account: Account;
+  publicClient: GenericPublicClient;
+  validateTransaction?: boolean;
+})
 ```
 
 ## Trade Parameters

packages/coins-sdk/src/actions/tradeCoin.ts

@@ -92,20 +92,32 @@ export type TradeParameters = {
   permitActiveSeconds?: number;
 };
 
-export async function tradeCoin(
-  tradeParameters: TradeParameters,
-  walletClient: WalletClient,
-  account: Account,
-  publicClient: GenericPublicClient,
+export async function tradeCoin({
+  tradeParameters,
+  walletClient,
+  account,
+  publicClient,
   validateTransaction = true,
-) {
+}: {
+  tradeParameters: TradeParameters;
+  walletClient: WalletClient;
+  account: Account;
+  publicClient: GenericPublicClient;
+  validateTransaction?: boolean;
+}) {
   const quote = await createTradeCall(tradeParameters);
 
+  // Set default recipient to wallet sender address if not provided
+  if (!tradeParameters.recipient) {
+    tradeParameters.recipient = account.address;
+  }
+
   // todo replace any
   const signatures: { signature: Hex; permit: any }[] = [];
   if (quote.permits) {
     for (const permit of quote.permits) {
-      const [, nonce] = await publicClient.readContract({
+      // return values: amount, expiration, nonce
+      const [, , nonce] = await publicClient.readContract({
         abi: permit2ABI,
         address: permit2Address[base.id],
         functionName: "allowance",
@@ -120,7 +132,7 @@ export async function tradeCoin(
         abi: erc20Abi,
         address: permitToken,
         functionName: "allowance",
-        args: [permitToken, permit2Address[base.id]],
+        args: [account.address, permit2Address[base.id]],
       });
       if (allowance < BigInt(permit.permit.details.amount)) {
         const approvalTx = await walletClient.writeContract({
@@ -223,6 +235,7 @@ export async function createTradeCall(
   });
 
   if (!quote.data) {
+    console.error(quote);
     throw new Error("Quote failed");
   }