docs: simplify and clarify TypeDoc comments

[ryanio]

Summary

Simplified and clarified TypeDoc comments throughout the SDK to improve developer experience. All documentation is now more concise while maintaining accuracy.

Key Improvements

1. Fixed Confusing Amount Parameter (Most Critical)

Before:

Value in units, not base units e.g. not wei, of the payment token...

After:

Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.

2. Simplified Verbose Descriptions

• Domain: "Optional domain for on-chain attribution. Hashed and included in salt."
• Salt: "Arbitrary salt. Auto-generated if not provided."
• Zone: "Zone for order protection. Defaults to chain's signed zone."
• Quantity: "Number of assets to bid for. Defaults to 1."

3. Fixed Syntax Error

• Changed @side to @param side in src/api/api.ts

4. Streamlined Method Descriptions

Example:

Create and validate a listing onchain. Combines order building with onchain validation.
Validation costs gas upfront but makes fulfillment cheaper (no signature verification needed).

Changes

• src/sdk.ts - Main SDK class method documentation
• src/sdk/orders.ts - Order creation method documentation
• src/sdk/fulfillment.ts - Fulfillment method documentation
• src/api/api.ts - API method documentation fix

Impact

• Documentation is ~50% shorter while maintaining clarity
• No breaking changes to functionality
• All changes verified with successful TypeScript compilation
• Improved developer experience with clearer, more concise docs

🤖 Generated with Claude Code