Repository navigation
docs: document on-chain contract integration and testnet setup - #1696
Open
maxx-GENIUS wants to merge 1 commit into
Open
maxx-GENIUS wants to merge 1 commit into
maxx-GENIUS wants to merge 1 commit into
Conversation
Add `docs/onchain-integration.md` detailing how the backend and frontend integrate with the Soroban smart contracts (`assetsup`, `contrib`, `multisig-wallet`, `multisig-transfer`, `asset-maintenance`). Include Mermaid sequence diagrams for asset registration, governed transfer, and tokenization, environment configuration tables, deployment manifest consumption, error code mapping to `contracts/ERRORS.md`, dual-signer architecture (Freighter wallet vs backend operator), and a step-by-step testnet walkthrough for registering an asset. Closes DistinctCodes#1657
|
@maxx-GENIUS is attempting to deploy a commit to the naijabuz's projects Team on Vercel. A member of the Team first needs to authorize it. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Currently, there is no comprehensive documentation connecting how the backend and frontend interact with the Soroban contracts. Contributors lacked clear guidance on:
ASSETSUP_CONTRACT_ID,STELLAR_SECRET_KEY,SOROBAN_RPC_URL, network passphrases).contracts/deployments/<network>.jsonis consumed across services.contracts/ERRORS.md.Solution
Added
docs/onchain-integration.md:assetsup,contrib,multisig-wallet,multisig-transfer,asset-maintenance).multisig-transfer, and (3) Asset Tokenization.STELLAR_SECRET_KEY) and user-authenticated wallet signing (Freighter).backend/.envandfrontend/.env.local.deployments/<network>.json.Error(Contract, #XYZ)status codes tocontracts/ERRORS.mdblocks.register_asset, and verifying on testnet.Updated Root
README.md:Documentationsection linking directly todocs/onchain-integration.md,contracts/README.md, andcontracts/ERRORS.md.Closes #1657