Skip to content

docs: automated updates for api_change#1088

Open
jessiemongeon1 wants to merge 1 commit into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260611-213518
Open

docs: automated updates for api_change#1088
jessiemongeon1 wants to merge 1 commit into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260611-213518

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Contributor

Summary

Automated documentation updates triggered by recent release notes.

Changes

Triggered by MystenLabs/ts-sdks#1082: zklogin: reject claim inputs with JSON escapes in genAddressSeed

  • 🔴 packages/docs/content/sui/zklogin.mdx

Review details

packages/docs/content/sui/zklogin.mdx

The documentation page needs updating to document the new input validation behavior of genAddressSeed.

What needs updating

The page references genAddressSeed in the "Legacy addresses" section but never documents it independently or describes its input constraints.

Missing information

The genAddressSeed function now throws an error if the claimName, claimValue, or aud parameters contain a backslash (\), double-quote ("), or control character (codepoint < 0x20). This validation rejects inputs that reveal JSON escaping, and it's a behavioral change users need to be aware of since previously-accepted inputs will now throw.

Suggested update

Add a section (or a note near the existing usage of genAddressSeed) that documents this function and its validation behavior. For example, after the computeZkLoginAddress example and before the "Legacy addresses" section, something like:


Suggested addition:

A new subsection or paragraph:

## Computing the address seed

To compute the address seed directly, use `genAddressSeed`:

```typescript
import { genAddressSeed } from '@mysten/sui/zklogin';

const addressSeed = genAddressSeed(userSalt, claimName, claimValue, aud);

The claimName, claimValue, and aud parameters must not contain backslashes (\), double-quotes ("), or control characters (codepoints below 0x20). genAddressSeed will throw an error if any of these characters are present, as they indicate improperly escaped JSON values. Ensure you pass the raw, unescaped claim values (e.g., as decoded from the JWT payload), not JSON-encoded strings.


---

This is important because `genAddressSeed` is a public utility that also underlies `computeZkLoginAddress` and `jwtToAddress`, and users who call it directly need to understand the new validation constraints.

</details>

---

This PR was automatically generated by the **Docs Impact Monitor**. Please review the changes carefully before merging.

Each file edit was generated by Claude based on the release notes and a review of the existing documentation content.

…1082

Automated update based on: genAddressSeed now throws an error if the key claim name, value, or aud contains a backslash, double-quote, or control character (< 0x20), rejecting inputs that reveal JSON escaping. This is a behavioral change to a public zkLogin utility function.
@jessiemongeon1 jessiemongeon1 requested a review from a team as a code owner June 11, 2026 21:35
@vercel

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sui-typescript-docs Ready Ready Preview, Comment Jun 11, 2026 9:37pm

Request Review

@jessiemongeon1 jessiemongeon1 had a problem deploying to sui-typescript-aws-kms-test-env June 11, 2026 21:35 — with GitHub Actions Failure
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ 🦋 Changesets Warning: This PR has changes to public npm packages, but does not contain a changeset. You can create a changeset easily by running pnpm changeset in the root of the Sui repo, and following the prompts. If your change does not need a changeset (e.g. a documentation-only change), you can ignore this message. This warning will be removed when a changeset is added to this pull request.

Learn more about Changesets.

@jessiemongeon1

Copy link
Copy Markdown
Contributor Author

Style Guide Audit

All 1 file(s) pass the style guide audit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants