Skip to content

Comments

Align ENS verification docs with SDK behavior and clarify commons version naming#10

Merged
GsCommand merged 1 commit intomainfrom
codex/fix-ens-verification-and-readme-examples
Feb 16, 2026
Merged

Align ENS verification docs with SDK behavior and clarify commons version naming#10
GsCommand merged 1 commit intomainfrom
codex/fix-ens-verification-and-readme-examples

Conversation

@GsCommand
Copy link
Contributor

Motivation

  • Ensure README examples match the actual VerifyOptions shape used by the TypeScript SDK so ENS-based verification works end-to-end.
  • Document the real ENS TXT resolution chain used by the SDK (cl.receipt.signercl.sig.pub / cl.sig.kid) and how to configure runtime.commandlayer.eth as a self-describing signer.
  • Avoid confusing the Commons schema version with the SDK package version by making the naming explicit in the TS exports.

Description

  • Updated README examples so ENS verification uses the exact shape ens: { name, rpcUrl } instead of ens: true, and added a minimal working TypeScript snippet showing createClient({ verify: { ens: { name, rpcUrl } } }) and direct verifyReceipt(...) usage.
  • Replaced outdated TXT-record guidance in README with the implemented resolver chain and an ENS Setup section recommending cl.receipt.signer = runtime.commandlayer.eth plus the existing cl.sig.pub / cl.sig.kid records.
  • Renamed the exported Commons schema constant in typescript-sdk/src/index.ts from version to commonsVersion, and preserved version as a deprecated alias (export const version = commonsVersion;) for compatibility.
  • Verified that Receipt<T = any> is already generic-safe in the current source and left it unchanged.

Testing

  • Ran TypeScript type checking in the typescript-sdk package with npm run typecheck, which completed successfully.
  • No other automated tests were changed or executed as part of this PR.

Codex Task

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@GsCommand GsCommand merged commit d87cc3d into main Feb 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant