docs: update API reference

[tolgahan-arikan]

Summary

• Update API.md so indexer method signatures include the current contractStatus and metadataOptions parameters.
• Add concise API reference coverage for exported helper, request/result, fee, transaction, and indexer types from the SDK public surface.
• Trim implementation-specific API reference details and make small wording fixes in the docs.
• Add root README entries for the Node and Node contract deploy examples so the example list matches the workspace scripts.
• Clarify the wallet request signing test so it exercises the generated WaaS client path used by the SDK.

Why

API.md had fallen behind the latest public exports and indexer parameter shapes on master. The root README also skipped the Node examples that are present in the workspace. The signing test now avoids looking like a standalone vector fixture while still checking the real generated-client signing path.

Validation

• git diff --check
• pnpm exec tsc --noEmit
• pnpm test

[claude]

Claude finished @tolgahan-arikan's task —— View job

---

PR Review — docs: update API reference

I reviewed API.md and README.md against the SDK source (src/index.ts, src/clients/indexerClient.ts, package.json, pnpm-workspace.yaml). This is a docs-only change — no SDK behavior, no .js import changes, no secrets, no source .ts edits — so the behavior/test-coverage review items don't apply. Doc accuracy is what matters here, and it holds up well.

Verified correct ✅

• Indexer signatures match source. getBalances contractStatus?: ContractVerificationStatus and getTransactionHistory metadataOptions?: MetadataOptions in API.md (API.md:746, API.md:807) match GetBalancesParams/GetTransactionHistoryParams in indexerClient.ts:110 and indexerClient.ts:154.
• New type docs match exported types. ContractVerificationStatus (indexerClient.ts:11), MetadataOptions (indexerClient.ts:104), IndexerNetworkType (indexerClient.ts:10), SortBy, Transaction, TransactionTransfer, TokenMetadataAsset etc. all match. Every type documented in the new "Types" entries is actually exported from src/index.ts (src/index.ts:74-103).
• README example list matches workspace scripts. New "Node Example" / "Node Contract Deploy Example" sections align with dev:node-example / dev:node-contract-deploy-example (package.json:46-49). Env-var usage (OMS_PUBLISHABLE_KEY) is consistent with AGENTS.md.
• No secrets committed — only placeholder keys (your-publishable-key).

Minor / optional (non-blocking)

1. MetadataOptions interaction not documented. getBalances exposes contractStatus while getTransactionHistory exposes metadataOptions with verifiedOnly/unverifiedOnly. Since both relate to verification filtering, a one-line note on how they differ could help, but it's optional.
2. SortBy is exported and now documented (API.md:1583), but no public method references it except via TokenBalancesPage.sort. That's fine — just confirming it's intentionally part of the public surface (it is exported at src/index.ts:81).
3. getTransactionHistory table omitted. Unlike getBalances, the new getTransactionHistory section (API.md:792) documents the signature but no per-parameter table. Consider adding one for parity, though the GetTransactionHistoryParams type section (API.md:1525) covers the fields.
4. Pre-existing typo 'some message to sing' (should be "sign") appears in examples (API.md:465, README.md multiple). Not introduced by this PR; ignore unless doing a sweep.

Note on validation

The PR lists pnpm exec tsc --noEmit and pnpm test as validation. For a docs-only change these aren't strictly required, but since the docs mirror the public type surface, they're a reasonable sanity check that nothing drifted.

Conclusion: Accurate, well-scoped docs update that brings API.md back in sync with the public exports and indexer parameter shapes. No correctness issues found. The minor items above are optional polish.

---

• Read changed files (API.md, README.md)
• Verify indexer signatures (contractStatus, metadataOptions) match source
• Verify documented public types match src/index.ts exports
• Verify README example list matches workspace scripts
• Check for committed secrets
• Post review feedback
  • Branch: update-api-docs-indexer-types