-
Notifications
You must be signed in to change notification settings - Fork 155
[sdks] Add orderless docs for TypeScript #994
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for orderless transactions in the TypeScript SDK and updates the navigation metadata to include these new pages.
- Added a new MDX page detailing orderless transactions with code examples.
- Updated meta files for both building-transactions and guides to include orderless transactions.
- Modified the transactions overview list to incorporate orderless signature details.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
apps/nextra/pages/en/build/sdks/ts-sdk/building-transactions/orderless-transactions.mdx | New documentation page with examples for orderless transactions. |
apps/nextra/pages/en/build/sdks/ts-sdk/building-transactions/_meta.tsx | Added orderless transactions entry in the navigation meta. |
apps/nextra/pages/en/build/sdks/ts-sdk/building-transactions.mdx | Updated the transaction features list to include orderless signatures. |
apps/nextra/pages/en/build/guides/orderless-transactions.mdx | New guide document explaining orderless transactions. |
apps/nextra/pages/en/build/guides/_meta.tsx | Added orderless transactions to the guides navigation meta. |
Comments suppressed due to low confidence (2)
apps/nextra/pages/en/build/sdks/ts-sdk/building-transactions.mdx:208
- [nitpick] The ordered list numbering skips from 5 to 7. Consider adjusting the numbering for clarity or add a comment if the sequence is intentional.
7. [Composing multiple Move calls with ScriptComposer](building-transactions/script-composer.mdx) - (Experimental) Building more complex transaction payload that calls into multiple Move functions dynamically.
apps/nextra/pages/en/build/guides/orderless-transactions.mdx:8
- The sentence starting with 'Replay is protected in' appears incomplete. Please clarify or complete the sentence to enhance documentation clarity.
outcome of the transaction or matter to the creator. Replay is protected in
3. [Batch Submit Transactions](building-transactions/batching-transactions.mdx) - How to send multiple transactions quickly from a single account. | ||
4. [Binary Canonical Serialization (BCS)](building-transactions/bcs-format.mdx) - The format used to serialize data for Aptos transactions. | ||
5. [Composing multiple Move calls with ScriptComposer](building-transactions/script-composer.mdx) - (Experimental) Building more complex transaction payload that calls into multiple Move functions dynamically. | ||
2. [Orderless Signatures](building-transactions/orderless-transactions.mdx) - Allowing for transactions to be executed out of order for easier management. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be Orderless Transaction?
orderless transactions allow for transactions to be executed out of order, which | ||
is particularly useful in scenarios where multiple machines need to sign for a | ||
single sending account, but the order in which they sign does not affect the | ||
outcome of the transaction or matter to the creator. Replay is protected in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Sentence not complete yet.
|
||
1. Build a transaction with a `replayProtectionNonce` and a `TransactionPayload::TransactionPayloadPayload` that defines the operation to be executed. | ||
2. Sign and submit the transaction as any other transaction, but with the | ||
`replayProtectionNonce` set. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Good to ask the users to pick the nonce randomly from u64 size.
Description
Checklist
pnpm fmt
?pnpm lint
?