Skip to content

Write to chain docs#1205

Merged
HarshRajat merged 38 commits intomainfrom
write-to-chain-docs
Apr 13, 2026
Merged

Write to chain docs#1205
HarshRajat merged 38 commits intomainfrom
write-to-chain-docs

Conversation

@HarshRajat
Copy link
Copy Markdown
Contributor

No description provided.

- Update RPC endpoint URLs from `evm.rpc-testnet-donut-node1.push.org` to `evm.donut.rpc.push.org`
- Change hotbuild script to use `yarn` instead of `npx`
- Enable track universal transaction and sign universal message docs in sidebar
- Fix package.json newline
- Reorder `getSupportedChainsByName` before `getSupportedChains` for better logical flow
- Add `options.chain` parameter to `convertExecutorToOrigin` to support CEA conversion
- Enhance `convertOriginToExecutor` description to mention both UEA and CEA
- Add `options.chain` parameter to `getTransactionUrl` for external chain explorer URLs
- Rename `listUrls` to support chain-specific queries with `options.chain` parameter
- Add new
- Add comprehensive constants reference documentation covering PUSH_NETWORK, CHAIN, and LIBRARY constants
- Include usage examples, common patterns, and type safety guidance
- Add constants reference to build section sidebar
- Fix punctuation in universal transaction overview description
- Add comprehensive Chain Executor Accounts (CEAs) documentation explaining their role in cross-chain execution
- Enhance UEA and UOA descriptions with clearer execution vs identity distinctions
- Add mental model section to clarify relationship between UOA, UEA, and CEA
- Update @pushchain/core from 5.0.0 to 5.1.3
- Update @pushchain/ui-kit from 5.0.0 to 5.1.0
…tion/resolution APIs

- Deprecate `convertOriginToExecutor` in favor of `deriveExecutorAccount`
- Deprecate `convertExecutorToOriginAccount` in favor of `resolveControllerAccount`
- Add `deriveExecutorAccount` function supporting UOA→UEA and Push account→CEA derivation
- Add `resolveControllerAccount` function with recursive resolution from UEA/CEA to UOA
- Rename `onlyCompute` parameter to `skipNetworkCheck` for clarity
- Add comprehensive
…ken constants reference

- Change `deriveExecutorAccount` parameter from generic `account` string to `UniversalAccount` type
- Update all examples to use `toUniversal()` for creating UniversalAccount objects
- Add Solana account derivation examples for both UEA and CEA
- Enhance use case description to include "Push account / UOA → CEA" flow
- Add comprehensive moveable and payable token constants documentation
- Include usage
…nt across build documentation

- Replace `<Details>` components with `<ConstantsDropdown>` for PUSH_NETWORK, CHAIN, CHAIN_FULL, LIBRARY, MOVEABLE_TOKEN, and PAYABLE_TOKEN constants
- Add ConstantsDropdown import to Initialize Push Chain Client, Universal Send Transaction, and Utility Functions pages
- Update Universal Send Transaction parameter documentation to clarify `tx.to` supports both string and object formats for external
…d organization and enhanced clarity

- Add universal transaction routes table explaining Route 1 (External/Push → Push), Route 2 (Push → External via CEA), and Route 3 (External via CEA → Push)
- Reorganize examples section into route-based subsections for better navigation
- Replace nested Tabs with individual Details dropdowns for Route 2 and Route 3 examples
- Update `tx.value` parameter description to clarify native asset
…al transaction guides

- Add comprehensive "Understanding Universal Transactions" page explaining UOA, UEA, CEA, routing architecture, and transaction lifecycle
- Add "Send Multichain Transactions" page covering prepareTransaction, executeTransactions, multi-hop flows, and cross-chain composition patterns
- Rename and reorder "Send Universal Transaction" from position 5 to 6
- Update universal transaction routes table descriptions
…ased examples and enhanced clarity

- Rename "What is a Universal Transaction?" to "Overview" in Understanding Universal Transactions
- Update universal transaction definition to clarify "supported external chain" instead of "any supported external chain"
- Rename `options.progress` parameter to `options.progressHook` for consistency
- Update `trackTransaction()` return type from `TransactionReceipt` to `UniversalTxResponse`
- Add `
…s and restructured content flow

- Add mermaid diagrams for UOA→UEA derivation, CEA mapping, transaction routes, and route-specific flows
- Restructure Overview section to lead with user pain point before introducing universal transactions
- Expand Key Account Types section with visual diagrams and clearer property descriptions
- Add transaction lifecycle table with 8-step breakdown and progress event context
- Add "Why Universal Transactions Matter" section highlighting key benefits
- Reorganize route documentation
…ransaction page

- Remove routes table (Route 1, Route 2, Route 3) from Send Universal Transaction documentation
- Routes documentation moved to Understanding Universal Transactions page
- Change "mapped with" to "mapped to" in CEA definition for grammatical accuracy
- Update UEA mental model from "originating from" to "interacting from" for clarity
- Expand Route 3 description with concrete Solana→Push→Ethereum→Push example
- Clarify Route 3 use case focuses on preserving external chain identity after interaction
- Replace viem wallet/client setup with ethers Wallet and JsonRpcProvider across all examples
- Update Route 1 examples to use ethers for Sepolia account creation and transaction signing
- Simplify Route 2 examples by removing viem imports and using ethers Contract interface
- Update multicall example to use ethers for both Sepolia origin and Push Chain contract reads
- Change token constant references from `client.moveable.token.*` to `PushChain.CONSTANTS.
- Include full staking contract example demonstrating outbound triggers and inbound payload handling
- Add execution lifecycle diagram and comparison table with universal transactions
- Document `UniversalOutboundTxRequest` struct, `IUniversalGatew
…s in universal transaction documentation

- Change "Under the hood" description to emphasize no manual bridging required
- Add "How Routing Works" section explaining Route 1, 2, and 3 selection logic
- Update `tx.to` description from "passing only address" to "Passing a plain address"
- Change `tx.data` description to clarify string vs Array usage for single/batched calls
- Replace "UEA (Universal Execution Address)" with "UEA (Universal
…ction documentation for clarity

- Add UI Kit (React) tab to intro page with live example demonstrating PushUniversalWalletProvider, PushUniversalAccountButton, and sendTransaction usage
- Reorganize send transaction parameter documentation by moving advanced arguments (gasLimit, maxFeePerGas, maxPriorityFeePerGas, payGasWith, deadline) to collapsible Details section
- Update progressHook parameter description and move from advanced to main
…larity in Universal Transaction Scenarios

- Consolidate Route 1 "Interact with Smart Contract" example from three tabs (Push Chain, Sepolia, Solana) into single streamlined example
- Simplify counter contract ABI to only include necessary increment and countPC functions
- Add inline comment explaining origin chain flexibility ("Works from any origin chain — Push Chain, Ethereum, Solana, BNB, etc.")
- Update prompt text from "Please
… tracking across IDE components

- Add tooltip wrappers with hover states to copy and share buttons in both EditorWithHeader and ResultWithHeader components
- Implement global `window.__playgroundLiveCode` tracking to capture user-edited code in NodeJSVirtualIDE and React Live playground
- Update copy/share handlers to use live-edited code when available, falling back to original code
- Fix unicode escape sequences in console.log statements (🔑, ✅, 📦, ❌) in Universal
…xamples, comment out pay-gas-with-USDC example, and update @pushchain/core to 5.1.4-alpha.6

- Add progressHook logging to all Route 1, 2, and 3 sendTransaction calls for consistent progress tracking
- Reorder Route 2 examples to show native value transfer before ERC20 asset transfer
- Comment out "Pay Gas with USDC" example in Route 1 section
- Update Route 1 origin chain comment from "Works from any origin chain" to clarify Push Chain as example origin
… add executeTransactions live playground examples

- Change "Contract-Initiated Multichain Execution" to "Contract Initiated Multichain Execution" in Send Universal Transaction and Universal Transaction Scenarios next steps links
- Restructure Send Multichain Transactions page with mental model section and improved overview
- Add prepareTransaction API reference with PreparedUniversalTx return type documentation
- Add executeTransactions API reference
…n/core to 5.1.4-alpha.7

- Change "cascade" terminology to "multichain flow" throughout Send Multichain Transactions page
- Update overview to emphasize single user-signed transaction coordination
- Clarify PreparedUniversalTx as intermediate object in info callout
- Add note that each prepared transaction becomes one ordered step in multichain flow
- Fix console.log from "🔑 Push Chain account" to "🔑 Sepolia account" in example
- Change "Execute a Series of Multichain Transactions" to "Execute Multiple Transactions in One Flow" in Details summary
… Smart Contract Address Book

- Add descriptive introductions to Push Chain Core Functionalities, PRC-20 Supported Tokens, Core AMM & Helpers, and AMM Pools sections
- Add Universal Executor Module contract entry with address and description to Push Chain Core Functionalities table
- Add CEA Contracts and Vault Contracts sections for Ethereum Sepolia, Arbitrum Sepolia, Base Sepolia, and BNB Testnet with complete address tables
- Add chain ID context to external
…ntries across all chains

- Remove bold markdown from CEAFactory (proxy) entries in Ethereum Sepolia, Arbitrum Sepolia, Base Sepolia, and BNB Testnet CEA contract tables
- Remove bold markdown from CEAMigration entries in Ethereum Sepolia, Arbitrum Sepolia, and Base Sepolia CEA contract tables
- Remove bold markdown from Vault Proxy entry in BNB Testnet Vault Contracts table
…details, precompiles section, and collapsible metadata

- Add Details import from @theme/Details for collapsible contract information
- Expand Push Chain Core Functionalities table with Universal Core, Universal Gateway PC, VaultPC, UProxyAdmin entries including proxy/implementation/admin addresses and purpose descriptions
- Add EVM Default Precompiles section with standard Cosmos EVM precompiles (p256, bech32, staking, distribution
…details, precompiles section, and collapsible metadata

- Add Details import from @theme/Details for collapsible contract information
- Expand Push Chain Core Functionalities table with Universal Core, Universal Gateway PC, VaultPC, UProxyAdmin entries including proxy/implementation/admin addresses and purpose descriptions
- Add EVM Default Precompiles section with standard Cosmos EVM precompiles (p256, bech32, staking, distribution
…arity, terminology fixes, and parameter descriptions

- Remove commented-out summary section
- Clarify universal transactions vs contract-initiated execution comparison with improved "Who initiates" and "When it happens" descriptions
- Change "cascade" to "trigger" in key distinction paragraph
- Update Contract CEA section to clarify it is "scoped to the contract" rather than "funded and managed independently"
- Fix trailing space
… terminology refinements

- Change "trigger external chain execution" to "trigger execution on an external chain" for clarity
- Capitalize "txids" to "TxIds" in executeUniversalTx warning for consistency
… terminology refinements and formatting fixes

- Update comparison table header from "Contract Initiated Execution" to "Contract-Initiated Multichain Execution" for consistency
- Remove extra space before "Any call into your Push contract" in key distinction paragraph
- Change "the UGPC" to "UGPC" in gasLimit parameter description for consistency
- Update warning from "CEA inbound needs $PC for execution" to "Inbound execution requires $PC" for clarity
HarshRajat and others added 8 commits April 11, 2026 06:15
…a devnet chain constant, and hidden anchor headings for deep linking

- Change SOLANA_TESTNET to SOLANA_DEVNET in Important Concepts example
- Rewrite overview to clarify tracking works from any origin chain (Push Chain or external)
- Add note that trackTransaction() can be used independently with any stored hash
- Reorder trackTransaction() parameters table to show txHash, chain, progressHook, waitForCompletion
- Update txHash parameter
…ent and UEA migration flow

- Add new Upgrade Universal Account advanced guide with overview, API reference, and live playground
- Add getAccountStatus() method documentation to Initialize Push Chain Client with AccountStatus return type
- Add Manage Account section with Access Account Information and Get Account Status subsections
- Update deriveExecutorAccount examples with new addresses and clarify UEA vs CEA terminology
- Add progress hook documentation with ProgressEvent type and UEA-
…cumentation, live playground updates, and terminology clarifications

- Change overview from "no gas fees are charged on the origin chain" to "done automatically via the SDK without requiring gas"
- Replace Details component with hidden anchor heading for progress hook section for deep linking
- Restructure progress hook documentation from code block to table format with Field/Type/Description columns
- Add level column (INFO/SUCCESS/ERROR) to progress events table
- Update progress
… MDX parsing and SDK method detection

- Add AGENTS_GENERATION_AI_CLAUDE and AI_AGENTS_MODEL environment variables to .env.sample for agents generation configuration
- Add build.agents.examples.mjs script to extract code examples from MDX documentation into static/agents/examples/ files
- Implement extractTemplateLiterals() to parse SDK page template literals with customPropGTagEvent markers
- Implement extractTutorialBlocks() to combine
…scenarios

- Remove advance-hopping.spec.ts containing Route 1/2/3 cascade tests
- Remove single hop funds transfer tests (Route 1)
- Remove 3-leg cascade tests with Route 2 payload/funds + Route 3 inbound + Route 1
- Remove 4-leg cascade tests with BNB + Solana multi-hop scenarios
- Remove 5-leg cascade tests with BSC payable counter and Solana CPI flows
- Remove StakingExample contract-initiated execution tests
- Remove test utilities
…ew images, and dependency updates

- Add empty upgrade-universal-.md workflow file
- Fix quote style in Smart Contract Address Book image path
- Update Upgrade Universal Account slug from ./upgrade-account to ./upgrade-universal-account and update preview image path
- Convert relative links to absolute paths in Understanding Universal Transactions, Send Multichain Transactions, and Contract-Initiated Multichain Execution next steps
@HarshRajat HarshRajat merged commit 5f554ca into main Apr 13, 2026
1 check failed
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