Revise README for EHEPS Stellar Wallet integration - #2747
Conversation
Updated the README for the Horizon API to reflect the integration with the EHEPS Stellar wallet, including changes to the title, description, and content structure.
|
docs: document EHEPS Stellar Wallet integration with Horizon
|
There was a problem hiding this comment.
Pull request overview
Reworks the general Horizon landing page into an EHEPS wallet integration guide.
Changes:
- Adds EHEPS donation account and architecture details.
- Adds Horizon request examples and transaction data.
- Replaces general Horizon guidance and navigation.
Recommendation: NEEDS-CHANGES — restore the general landing page, align lifecycle guidance, and fix broken Markdown formatting.
Suppressed comments (4)
docs/data/apis/horizon/README.mdx:11
- This new production recommendation omits the repository’s current API lifecycle guidance:
docs/data/apis/README.mdx:24,32says RPC is recommended for real-time access and Horizon is nearing end-of-life. A new integration should acknowledge that status, explain which indexed capabilities still require Horizon/Portfolio APIs, and provide a migration strategy rather than presenting Horizon as the default long-term data layer.
The EHEPS Stellar donation account is `GDQ75AS5VSH3ZHZI3P4TAVAOOSNHN346KXJOPZVQMMS27KNCC5TOQEXP`. EHEPS applications should use Horizon as the blockchain data-access layer for reading Stellar account, transaction, payment, and operation data while maintaining an independent database for donation reconciliation, audit records, and historical retention. The publicly accessible SDF-hosted Horizon historical dataset was reduced to approximately one year beginning August 1, 2024; therefore, production EHEPS systems that require long-term financial or audit history should persist relevant blockchain records independently or use an appropriate data provider.
docs/data/apis/horizon/README.mdx:45
- This starts an unterminated code fence and combines the language identifier with the command (
textcurl). Everything through end-of-file is therefore rendered as one code block rather than as the intended transaction details and examples. Use a valid language identifier and close the fence after the command.
```textcurl "https://horizon.stellar.org/transactions/f9d806e098ddb4596e56e2e60a776dbae0c6ca2329f5a276b9abf8edf3fa99ce/operations"
docs/data/apis/horizon/README.mdx:24
- The architecture diagram is plain Markdown, so its lines and spacing will not render as a single preformatted diagram. Fence the whole diagram as text to preserve the intended layout.
Stellar Network
docs/data/apis/horizon/README.mdx:20
- The sentence says the donation account follows, but this line is a
/paymentscollection URL rather than the account address. Show the address as the account value and label the URL separately so readers do not mistake an endpoint for an account identifier.
https://horizon.stellar.org/accounts/GDQ75AS5VSH3ZHZI3P4TAVAOOSNHN346KXJOPZVQMMS27KNCC5TOQEXP/payments?limit=50&order=desc
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -1,42 +1,73 @@ | |||
| --- | |||
| title: "Access Blockchain Data with Horizon API: Query Transactions, Accounts & More" | |||
| title: "EHEPS Stellar Wallet: Access Blockchain Data with Horizon API" | |||
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 109370fd6c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Secure Signing Service | ||
|
|
||
| Horizon can be accessed via cURL, a browser, or one of the [Stellar SDKs](../../../tools/sdks/README.mdx). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls. | ||
| ```textcurl "https://horizon.stellar.org/transactions/f9d806e098ddb4596e56e2e60a776dbae0c6ca2329f5a276b9abf8edf3fa99ce/operations" |
There was a problem hiding this comment.
With this opening fence, Markdown treats the rest of line 45 as the code-block info string, so the /operations curl example is not rendered as code content; because there is also no closing fence, the remainder of the page is swallowed into one code block. Put the curl command on the next line and close the fence so the example and following content render correctly.
Useful? React with 👍 / 👎.
EHESPO
left a comment
EHESPO
left a comment
There was a problem hiding this comment.
docs: document EHEPS Stellar Wallet integration with Horizon
- Update Horizon documentation to include EHEPS Stellar Wallet integration
- Document the EHEPS Stellar donation account as an integration example
- Add account, transaction, payment, and operation query examples
- Document Mainnet and Testnet Horizon endpoints
- Add production guidance for donation reconciliation and idempotent processing
- Clarify wallet security and protection of Stellar signing credentials
- Preserve Horizon's role as a general Stellar blockchain data API
- Add guidance for failed transaction investigation and operational monitoring
- Avoid representing EHEPS as an official Stellar Development Foundation product
Approving workflow runs from forksYou can manually approve workflow runs triggered by a contributor's pull request. Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a repository, organization, or enterprise. Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. Approving workflow runs on a pull request from a public forkMaintainers with write access to a repository can use the following procedure to review and run workflows on pull requests from contributors that require approval.
|
EHESPO
left a comment
EHESPO
left a comment
There was a problem hiding this comment.
Approving workflow runs from forks
You can manually approve workflow runs triggered by a contributor's pull request.
Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a repository, organization, or enterprise.
Workflow runs that have been awaiting approval for more than 30 days are automatically deleted.
Approving workflow runs on a pull request from a public fork
Maintainers with write access to a repository can use the following procedure to review and run workflows on pull requests from contributors that require approval.
-
Under your repository name, click Pull requests.
-
In the list of pull requests, click the pull request you'd like to review.
-
On the pull request, click Files changed.
-
Inspect the proposed changes in the pull request and ensure that you are comfortable running your workflows on the pull request branch. You should be especially alert to any proposed changes in the
.github/workflows/directory that affect workflow files. -
If you are comfortable with running workflows on the pull request branch, click the button in the upper right corner labeled Awaiting approval, which will open the Merge status panel.
-
Find and click Approve workflows to run.
Updated the README for the Horizon API to reflect the integration with the EHEPS Stellar wallet, including changes to the title, description, and content structure.