Refine Stellar dev skill docs and integrate PR #3 content - #4
Conversation
There was a problem hiding this comment.
Pull request overview
Integrates content inspired by #3 while “de-dating” volatile details (endpoints, versions, partnership timelines) and adding new routing/reference docs for advanced Soroban patterns and SEP/CAP lookup.
Changes:
- Added two new docs: advanced Soroban architecture patterns and a SEP/CAP standards reference map.
- Refreshed endpoint/provider guidance (Mainnet RPC) and removed/softened time-sensitive claims (partnership dates, library versions, “best practices” timestamping).
- Expanded Soroban contract docs with constructor guidance and made ZK crypto coverage status-sensitive.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| skill/standards-reference.md | New quick-reference routing map for commonly used SEPs/CAPs and use-case mappings. |
| skill/advanced-patterns.md | New advanced patterns guide (upgradeability, factories, governance, DeFi, optimization). |
| skill/contracts-soroban.md | Added constructor section; reframed ZK crypto section to be status-/network-dependent. |
| skill/api-rpc-horizon.md | Updated Mainnet RPC guidance to be provider-selected; updated example config. |
| skill/frontend-stellar-sdk.md | Updated Mainnet RPC URL example to prefer env override + default provider URL. |
| skill/security.md | Removed date-specific partnership heading; reframed as overview. |
| skill/ecosystem.md | Removed pinned OpenZeppelin contracts version/date; advised tracking release tags. |
| skill/SKILL.md | Added freshness policy + new routing links/keywords. |
| README.md | Removed date-stamping; updated repo install instructions and listed new docs in structure. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // For Mainnet | ||
| const server = new StellarSdk.Horizon.Server("https://horizon.stellar.org"); | ||
| const rpc = new StellarSdk.rpc.Server("https://soroban.stellar.org"); | ||
| const rpc = new StellarSdk.rpc.Server(process.env.NEXT_PUBLIC_STELLAR_MAINNET_RPC_URL || "https://mainnet.sorobanrpc.com"); | ||
| const networkPassphrase = StellarSdk.Networks.PUBLIC; |
There was a problem hiding this comment.
In the “Basic Setup” snippet, server, rpc, and networkPassphrase are declared twice with const (Testnet and Mainnet), which makes the TypeScript example invalid as-written. Consider showing two separate code blocks, or model this as a single NETWORK-selected config object so the snippet compiles/can be copy‑pasted.
| > Note: SDF directly provides Futurenet public RPC. For Mainnet RPC, select a provider from the RPC providers directory. | ||
|
|
||
| | Network | RPC URL | | ||
| |---------|---------| | ||
| | Mainnet | `https://soroban.stellar.org` | | ||
| | Mainnet | Provider-specific endpoint (see RPC providers doc) | |
There was a problem hiding this comment.
This section references an “RPC providers directory/doc” but doesn’t link to it, and “directory” vs “doc” are inconsistent. Please add an explicit URL (e.g., the Stellar docs RPC providers directory) so readers can actually find the provider list.
| const configs: Record<string, NetworkConfig> = { | ||
| mainnet: { | ||
| rpcUrl: "https://soroban.stellar.org", | ||
| rpcUrl: process.env.STELLAR_MAINNET_RPC_URL || "https://mainnet.sorobanrpc.com", |
There was a problem hiding this comment.
The table says Mainnet RPC is “provider-specific”, but the later environment config defaults to https://mainnet.sorobanrpc.com (a specific third-party endpoint). To keep the guidance consistent (and avoid baking in a provider), consider removing the hardcoded default or replacing it with a clearly marked placeholder/example plus a link to the providers directory.
| rpcUrl: process.env.STELLAR_MAINNET_RPC_URL || "https://mainnet.sorobanrpc.com", | |
| // Set STELLAR_MAINNET_RPC_URL based on your chosen Mainnet RPC provider (see the RPC providers directory). | |
| rpcUrl: process.env.STELLAR_MAINNET_RPC_URL || "https://YOUR_MAINNET_RPC_URL", |
e5377d4 to
51cf40e
Compare
Implements valid Copilot feedback: (1) fix duplicate const declarations in frontend basic setup snippet, (2) add explicit linked RPC providers directory references in API docs. Retains prior status-safe provider policy and env-var requirement for mainnet RPC.
Integrates and hardens the intent of #3 with maintainability and freshness improvements.
This PR is the consolidated successor to #3 and intentionally supersedes its content.
Closes #3.
Source PR reviewed: #3