Soroban RPC: Add document for getVersionInfo RPC #661
Merged
Conversation
This file contains 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
|
Preview is available here: |
|
Preview is available here: |
|
Nit: My only suggestion is to define what captive core is in the description. It is a stellar-core that's managed by another piece of software. Maybe you could describe it better since it is a nomenclature that is only meaningful to some people, not all developers in the ecosystem. |
janewang
approved these changes
Jun 7, 2024
|
Preview is available here: |
philipliu
pushed a commit
to philipliu/stellar-docs
that referenced
this pull request
Jun 10, 2024
* Add dapps challenge (stellar#487) * Add Dapps Challenge to Docs Todo: user dashboard visibility * add hide unless dapps * update user card * update checkpoints * add user dashboard to dapps challenges * Update Dapp Challenge Description * Update tsconfig.json * fix tsconfig.json * small grammar fixes * small grammar fixes * small grammar fixes * small grammar fixes * small grammar fixes * update challenge 0 and 1 ; add images for challenge 2 * Capitalize Futurenet; lowercase Dapp when needed * disclaimer; nit crowdfunding -> crowdfund * Update challenge-0-crowdfund.mdx * update layout and guides * Update smart-contracts.mdx * update content * add links * nit update soroban quickstart * Update react.mdx * Update challenge-0-crowdfund.mdx * update start course redirect * we -> you * update wrangler endpoint to stellar cloudflare * update wrangler endpoint * add module resolution and jsx * add wrong network page; remove unused code; add vercel.app checking * update wallets conclusion * nit Update wallets.mdx * nit update broken link * Freighter -> WalletData Component * update crowdfund dapps challenge for P10 * Fix Setup * update docker workflow; add better notes * nit standalone docker requirement * re-enable .vercel.app check; move ParentChallengeForm * move Login function * fixed automatic log in problem * comment out connection check * comment out auto connect hook; nit Login -> Connect * removed unused setLoading() changed order of operations * update to checkout challenge branch * completed challenge message = clickable url * remember user is logged in * setup `BrowserOnly` * Update yarn.lock * Update yarn.lock * merge main into dapps challenge * Update yarn.lock * nit: refresh message * add disconnect button comment; better connection insight * update contract initialization to use strings * auto populate url; add resubmit; fix broken invoke * add setSavedUrl; improve url auto populate * improve local storage for pubkey --------- Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> * Update initialization.mdx (stellar#518) * editorial nits for dapps challenge (stellar#544) * editorial nits on crowdfund dapp * editorial nits in payment dapp challenge * Add scaffold soroban (stellar#545) * Create scaffold-soroban.mdx * add video embed * reformat code call outs; add conclusion * Update scaffold-soroban.mdx * nit: link sc * nit add rpc link * add definition to soroban RPC * update deep dive section * dApp -> dapp * remove atomic swap description * update simulate txn section; copy edits * update intro to dapps * nit:fix link * update links; edit copy * nit:typo * SDC UI upgrades (stellar#542) * Update index.tsx * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues * Merge Development into main (stellar#2) * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues --------- Co-authored-by: Iryna Telesheva <iryna.telesheva@intellecteu.com> Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> * Add Dashboard for Dapps challenges (stellar#3) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues * Add Dashboard for Dapps challenges (stellar#3) (stellar#4) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> * Merge SDC from julian-dev28:main to Stellar:SSDC23 (stellar#541) * Update index.tsx * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues * Merge Development into main (stellar#2) * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues --------- Co-authored-by: Iryna Telesheva <iryna.telesheva@intellecteu.com> Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> * Add Dashboard for Dapps challenges (stellar#3) (stellar#4) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> --------- Co-authored-by: Iryna Telesheva <iryna.telesheva@intellecteu.com> Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> * Update the user workflow for the challenges with CI/CD (stellar#5) * Update the Crowdfund challenge with pull request validation step info * Refactor * Add isPullRequestRequired field handling * Update text for Crowdfund checkpoint 8 * Make isPullRequestRequired required * Fix issue with dates * Merge branch 'main' into SSDC23 * Update challenge-0-crowdfund.mdx --------- Co-authored-by: Iryna Telesheva <iryna.telesheva@intellecteu.com> Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> * Updated mdx files on dapps (stellar#525) * Fixed typos in dapps section * Fixed typos in fundamentals-and-concepts section * Add lp dapp challenge (stellar#543) * Create challenge-2-liquidity-pool * update lp dapp challenge * complete lp-dapp challenge * nit spelling * Update challenge-2-liquidity-pool.mdx * nit spelling * nit add steps to workflow * nit update workflow * update workflow again * add diff * edit diff * more diff editing * editorial edits * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <elliot@stellar.org> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <elliot@stellar.org> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <elliot@stellar.org> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <elliot@stellar.org> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <elliot@stellar.org> * add reference to earlier step; fix conflict in crowdfund dapp page * update quickstart version * small wording change --------- Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@stellar.org> * Update Futurenet to Testnet Across Documentation (stellar#577) * Futurenet -> Testnet * fix broken links * update-rpc-page * Update testnet.mdx * Pass 1 * format * update table in testnet.mdx * update state expiration example script to use testnet * replacing futurenet with testnet in contract deployment example * revert SDC contnet * include testnet network passphrase on releases page * update freighter to include testnet alongside futurenet * revert SDC to Use Futurenet for the time being * style: fix up markdown syntax and style in `rpc.mdx` Also adds some small linguistic and grammer changes, as well as more updates from Futurenet to Testnet * docs: include Testnet when describing what RPC servers SDF maintains * style: changing a single ellipsis character with three periods * docs: include gh repo links to the software that runs in quickstart * add the Testnet network to the example `initialize.sh` script * change contract-invoking transaction example code to use Testnet * change to valid futurenet URLs in dapp challenges * Apply suggestions from code review minor tweaks that slipped through the cracks --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Soroban Dapps Challenge: Update Sidebar and Remove Local Deployment (stellar#597) * remove challenges top level dropdown; remove local deployment * update Soroban version * Prevent Popup for Testnet * Leaderboard and Freighter API integration (stellar#598) * Add leaderboard with wallet integration feature * Update index.tsx * Add total value locked logic with reseting user data * Refactor reset logic * Refactor sorting * Revert TVL for payment * Update resubmit contract id logic * Fix resubmiting contractId * Add pagination and wallet address to leaderboard * Change columns order * Allow payment be completed * User submit ContractID * use GH token * use npm instead of yarn * Update main.yml * revert back to yarn * use https for wallets kit * try access token * use new github token * set up to use git https * last random try * Update main.yml * use default settings * set origin for wallets-kit * trying npm again * nit: use npm for scripts * Remove stellar wallets kit; add support for users w no progredd * nit: phrasing * Use Original GH Action * Show user address * nit: phrasing * nit: connect message * add missing cd --------- Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> * update leaderboard ranking toggle (stellar#609) * Corrected calculation of total pages so that 'Prev' and 'Next' buttons are disabled when table contains less than 10 rows. (stellar#611) * Add tabs to dapps challenge checkpoints (stellar#610) * Update challenge-0-crowdfund.mdx * Add tabs to interaction step * add tabs to checkpoints * feat: provide a means of receiving simple feedback from users (stellar#587) * feat: provide a means of receiving simple feedback from users Here, we have swizzled (ejected) the `DocItem/Footer` component from docusaurus, and are inserting our own `ReaderFeedback` component into it before the rest of the doc footer content. Also, the `custom.scss` file has been used to style this element in a consistent manner with the rest of the site. This is the first step to resolve stellar#586: The user interaction can now take place. From here, we will work on integrating the custom events into Google analytics. Ultimately, we will like to implment this feature into the `stellar-docs` repository, as well. Refs: stellar#586 * Moving some React state things around * Including an `alt` tag for the like/dislike buttons * use the `pageId` for `eventLabel` in the send event * style: Linting the code * style: changing inline svg tag to be on newlines, changine filename to `jsx` * feat: Inserting the `DocItem/Footer` components on `dapps` and `api` pages * feat: migrating to the GA4 plugin in docusaurus * Testing with a new ga4 tracking id for preview domain * add some console statements to test what's happening * add configuration for test gtag container for this pr preview * feat: use `gtag` over the deprecated `ga` function * adding my own test gtag? * Remove the `gtag` function call, and just register state * removing the old-style google analytics tag for good * remove staging tag manager containers in preparation for production * replace staging ga4 tracking id with production tracking id * use `@site/static` for feedback button imports, rename file extension * Remove docker image hashes (stellar#628) * remove mentions of specific image hashes in docker commands * update docker image hash to most recent version on releases page * Update Soroban Dapps Challenge copy (stellar#631) * update redeployment section * add description for deployment * update links * add note about building `target` * Update challenge-0-crowdfund.mdx * Update challenge-2-liquidity-pool.mdx * Sdc mental models: payment dapp upgrades (stellar#641) * bringing sdc-mental-models branch up to date (stellar#632) * feat: provide a means of receiving simple feedback from users (stellar#587) * feat: provide a means of receiving simple feedback from users Here, we have swizzled (ejected) the `DocItem/Footer` component from docusaurus, and are inserting our own `ReaderFeedback` component into it before the rest of the doc footer content. Also, the `custom.scss` file has been used to style this element in a consistent manner with the rest of the site. This is the first step to resolve stellar#586: The user interaction can now take place. From here, we will work on integrating the custom events into Google analytics. Ultimately, we will like to implment this feature into the `stellar-docs` repository, as well. Refs: stellar#586 * Moving some React state things around * Including an `alt` tag for the like/dislike buttons * use the `pageId` for `eventLabel` in the send event * style: Linting the code * style: changing inline svg tag to be on newlines, changine filename to `jsx` * feat: Inserting the `DocItem/Footer` components on `dapps` and `api` pages * feat: migrating to the GA4 plugin in docusaurus * Testing with a new ga4 tracking id for preview domain * add some console statements to test what's happening * add configuration for test gtag container for this pr preview * feat: use `gtag` over the deprecated `ga` function * adding my own test gtag? * Remove the `gtag` function call, and just register state * removing the old-style google analytics tag for good * remove staging tag manager containers in preparation for production * replace staging ga4 tracking id with production tracking id * use `@site/static` for feedback button imports, rename file extension * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (stellar#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Remove docker image hashes (stellar#628) * remove mentions of specific image hashes in docker commands * update docker image hash to most recent version on releases page * Update WASM retrieval tutorial (stellar#627) * docs: explain the diagnostic events that are emitted in sandbox (stellar#593) * docs: explain the diagnostic events that are emitted in sandbox Perhaps this approach is too verbose? I think having the explanation of what is being seen right there in the tutorial is useful at this early step in the "getting started" section. A new developer is more likely to understand what they see, and remember what it is in the future if we don't try to interrupt their flow at this point by sending them to another page for some (possibly irrelevant) info. I may be incorrect there, and I'm happy to hear opinions from others. Refs: stellar#521 * docs: add a space between two words * editorial in Update hello-world.mdx --------- Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> * Fix a couple typos in rust-dialect.mdx (stellar#630) --------- Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Sapo-Dorado <nobrown@sbcglobal.net> * Crowdfund dapp copy updates v1 Added in some (minimal) context throughout. Tidied up a few grammatical/spelling inconsistencies. * add description and update "ship it" workflow * update soroban-cli install * Update challenge-0-crowdfund.mdx * remove extra vercel link * Merge branch 'main' into sdc-mental-models * Add intro to dapps * nit formatting * Payment dapp copy updates Updates to Checkpoints 0-4 of the Payment dapp challenge, including added copy and a few very minor grammatical upgrades. * add more context * Merge Payment dapp fix (stellar#643) * Update latest testnet-compatible JavaScript release versions (stellar#634) * Update latest testnet-compatible JavaScript release versions * Add links to release notes for each version * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <elliot@stellar.org> * Switch Ubuntu base image to 22.04 from 20.04 (stellar#638) Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com> * Update getting-started for 20.0.0-rc.4.1 cli (stellar#636) * Updates to setup.mdx * Add CLI for testnet configuration to Setup * Updates to hello-world.mdx Reorder some code snippets to be after the description * Small edits in storing-data.mdx * Add high_expiration_watermark argument to bump in incrementor * Move deploy-to-testnet after hello-world to allow the user to interact with their contract on testnet * Add Optimizing Builds to hello-world * Update storing-data to remove sandbox interation * Add a deploy-incrementor-to-testnet step * Update position of Create an App * Apply suggestions from code review Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> * Update create-an-app.mdx * Fix typo * Add a mv command for .soroban dir when reorganizing to a multi-contract project * Apply mdx prettier updates * Update astro port in create-an-app.mdx * Apply suggestions from code review Co-authored-by: Elliot Voris <elliot@voris.me> * Add .mdx to end of internal markdown links for docusaurus magic * Make sure there are new lines before and after ::: tags * Some additional edits/improvements * Mention that Freighter is available as a firefox add-on * Update the deploy-incrementor url * Apply prettier updates --------- Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@voris.me> * docs: change preflight wording to simulate transaction (stellar#585) * docs: change preflight wording to simulate transaction A first attempt to resolve stellar#478, there may be more work to be done. I've used a few different phrases, depending on how the sentence structure works, perhaps taking some liberties in the process. I've also left alone the `releases` page for preview releases older than 11. It seems unnecessary to rewrite the development history too far into the past. Refs: stellar#478 * editorial on Update interacting-with-contracts.mdx * added a couple "the"s Update state-expiration.mdx * fix wording about ledger entries to be less confusing * clearing up some other language surrounding footprints --------- Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> * Create data-providers.mdx (stellar#629) * Create data-providers.mdx Adding new page for data providers to cover indexers and block explorers * Update data-providers.mdx updated explanation text * style: fixing some markdown styles and formatting * Adding some more verbose descriptions and links --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * docs: change sitewide wording from "preview release" to "release candidate" (stellar#639) * docs: update welcome page "preview release" > "release candidate" * docs: change "preview release" > "release candidate" on releases page * update payment challenge; add styles * add clickable object to localhost:9000 example * Update challenge-1-payment.mdx * Squashed commit of the following: commit 76c48ccd8049bca6bb11f131cefb35253dad86b2 Author: Julian Martinez <julian_martinez28@outlook.com> Date: Wed Nov 8 10:10:12 2023 -0800 add more context --------- Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Satyam Zode <5508956+satyamz@users.noreply.github.com> Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Elizabeth <emengelman@gmail.com> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@voris.me> Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> Co-authored-by: jcx120 <91218921+jcx120@users.noreply.github.com> * format image * Squashed commit of the following: commit 308444d93d4f7133107ca499a6d255fe5ae302d4 Author: Julian Martinez <julian_martinez28@outlook.com> Date: Wed Nov 8 14:55:06 2023 -0800 update copy commit ec062702a5a900ff890bf5cc99dfd9b6dbe1915a Author: Julian Martinez <julian_martinez28@outlook.com> Date: Wed Nov 8 12:34:07 2023 -0800 add styles for lp commit f7bbf2e61a262aa6dd76bed2f43cd26aafce075b Author: Julian Martinez <julian_martinez28@outlook.com> Date: Wed Nov 8 12:13:49 2023 -0800 add image styles * update copy for production deployment * caution -> tip * add commas, add soroban-cli install to payment dapp * fix broken link * Squashed commit of the following: commit 7de8a99ec32065376ea4fd2f42a14194cdda6e49 Author: Elliot Voris <elliot@stellar.org> Date: Thu Nov 9 15:47:49 2023 -0600 docs: move data providers page out of sdks directory (stellar#645) commit 55e0a866c6dbbe2b4dd38f38816915d59c962584 Author: Elliot Voris <elliot@stellar.org> Date: Tue Nov 7 11:40:20 2023 -0600 docs: change sitewide wording from "preview release" to "release candidate" (stellar#639) * docs: update welcome page "preview release" > "release candidate" * docs: change "preview release" > "release candidate" on releases page commit 2ae107280eb4bfee7192e7bdabf704c80ffab43c Author: jcx120 <91218921+jcx120@users.noreply.github.com> Date: Tue Nov 7 08:48:50 2023 -0800 Create data-providers.mdx (stellar#629) * Create data-providers.mdx Adding new page for data providers to cover indexers and block explorers * Update data-providers.mdx updated explanation text * style: fixing some markdown styles and formatting * Adding some more verbose descriptions and links --------- Co-authored-by: Elliot Voris <elliot@stellar.org> commit 0054011876a8273788a5bf6de16623683c9159d2 Author: Elliot Voris <elliot@stellar.org> Date: Mon Nov 6 11:00:02 2023 -0600 docs: change preflight wording to simulate transaction (stellar#585) * docs: change preflight wording to simulate transaction A first attempt to resolve stellar#478, there may be more work to be done. I've used a few different phrases, depending on how the sentence structure works, perhaps taking some liberties in the process. I've also left alone the `releases` page for preview releases older than 11. It seems unnecessary to rewrite the development history too far into the past. Refs: stellar#478 * editorial on Update interacting-with-contracts.mdx * added a couple "the"s Update state-expiration.mdx * fix wording about ledger entries to be less confusing * clearing up some other language surrounding footprints --------- Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> commit b9710ea0ea6c4652aea2019504534197195a2b3a Author: Elizabeth <emengelman@gmail.com> Date: Mon Nov 6 11:59:21 2023 -0500 Update getting-started for 20.0.0-rc.4.1 cli (stellar#636) * Updates to setup.mdx * Add CLI for testnet configuration to Setup * Updates to hello-world.mdx Reorder some code snippets to be after the description * Small edits in storing-data.mdx * Add high_expiration_watermark argument to bump in incrementor * Move deploy-to-testnet after hello-world to allow the user to interact with their contract on testnet * Add Optimizing Builds to hello-world * Update storing-data to remove sandbox interation * Add a deploy-incrementor-to-testnet step * Update position of Create an App * Apply suggestions from code review Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> * Update create-an-app.mdx * Fix typo * Add a mv command for .soroban dir when reorganizing to a multi-contract project * Apply mdx prettier updates * Update astro port in create-an-app.mdx * Apply suggestions from code review Co-authored-by: Elliot Voris <elliot@voris.me> * Add .mdx to end of internal markdown links for docusaurus magic * Make sure there are new lines before and after ::: tags * Some additional edits/improvements * Mention that Freighter is available as a firefox add-on * Update the deploy-incrementor url * Apply prettier updates --------- Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@voris.me> commit 61054dcad82dbf77c28aa1819ad08b6fa132ad70 Author: Satyam Zode <5508956+satyamz@users.noreply.github.com> Date: Fri Nov 3 20:26:27 2023 +0530 Switch Ubuntu base image to 22.04 from 20.04 (stellar#638) Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com> commit d6091131996ab81e42dff57f4bccaad3f5d56b3e Author: George <Shaptic@users.noreply.github.com> Date: Thu Nov 2 12:53:52 2023 -0700 Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <elliot@stellar.org> commit 228e4bfed691effa58a07b664abfd78b04e6dcd4 Author: George <Shaptic@users.noreply.github.com> Date: Thu Nov 2 09:18:50 2023 -0700 Update latest testnet-compatible JavaScript release versions (stellar#634) * Update latest testnet-compatible JavaScript release versions * Add links to release notes for each version * add SEO logic --------- Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Bri Wylde <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Sapo-Dorado <nobrown@sbcglobal.net> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Co-authored-by: Satyam Zode <5508956+satyamz@users.noreply.github.com> Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Elizabeth <emengelman@gmail.com> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@voris.me> Co-authored-by: jcx120 <91218921+jcx120@users.noreply.github.com> * Add oracle dapp challenge (stellar#664) * add oracle dapp * update endpoint * add images * Update http-client.ts * update challenge list * add last checkpoint to oracle dapp * Update http-client.ts * update meta tag * update title (stellar#665) * Liquidity Pool Dapp copy updates v2 (stellar#651) * Update challenge-2-liquidity-pool.mdx * Update challenge-2-liquidity-pool.mdx * Squashed commit of the following: commit 1864016f07b4f91a0cd9656ca55c2d8c568a0d02 Author: Dmytro Kozhevin <dmytro@stellar.org> Date: Tue Dec 5 12:09:24 2023 -0500 Remove some outdated cautions from the docs, now that Soroban should be stable. (stellar#672) commit 816e2a0e1f4e0f1e30c909b92b74b75081d3d3d7 Author: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue Dec 5 08:48:10 2023 -0800 Remove git init from hello world steps (stellar#666) commit 19b10a8f4c24e495f9dc04f10c694449e4f5a333 Author: Anuxhya <36203801+achallagundla@users.noreply.github.com> Date: Tue Dec 5 11:43:19 2023 -0500 Update fees-and-metering.mdx (stellar#654) * Update fees-and-metering.mdx Cleaning up the docs challenge 1 of the word s o r o b e r r y. * Update fees-and-metering.mdx Syntax error commit 36cc17fca85efc1471e3aadfb29b0ca1687e536b Author: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Sat Dec 2 21:01:14 2023 -0800 Update soroban-sdk to v20.0.0-rc2.2 (stellar#667) commit c5b01369ede0b78c2626013f2b43683f69db2905 Author: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Fri Dec 1 09:41:37 2023 -0800 Remove step adding target dir to gitignore (stellar#660) commit 214a207 Author: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Date: Fri Dec 1 09:07:49 2023 -0800 update title (stellar#665) commit 4b91088 Author: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Date: Fri Dec 1 08:36:59 2023 -0800 Add oracle dapp challenge (stellar#664) * add oracle dapp * update endpoint * add images * Update http-client.ts * update challenge list * add last checkpoint to oracle dapp * Update http-client.ts * update meta tag commit 595d591e97b946a971a51f73520deb3341be6476 Author: Bri Wylde <92327786+briwylde08@users.noreply.github.com> Date: Thu Nov 30 11:53:53 2023 -0700 clearer Soroban favicon (stellar#662) commit dc14811ded524a6f2d0026b5d1cce19ad4df7827 Author: Elliot Voris <elliot@stellar.org> Date: Wed Nov 29 16:11:19 2023 -0600 synchronize api example tabs across pages (stellar#661) commit 4f1198cfde2df402c0e74f1145828423c39e29ea Author: Elliot Voris <elliot@stellar.org> Date: Wed Nov 29 13:01:38 2023 -0600 Revert "Update getting started tutorial to use an Astro template (stellar#642)" (stellar#658) This reverts commit 512b1f46506b7edc788bc6e93a0e1f6d101d22ae. commit 81cac0d3524a1a80ce2fadd88e93aa40ffde791b Author: Elliot Voris <elliot@stellar.org> Date: Mon Nov 27 16:29:57 2023 -0600 build: a couple small fixes to get the build to work (stellar#657) * build: a couple small fixes to get the build to work * style: changing the way a couple codefences work commit 512b1f46506b7edc788bc6e93a0e1f6d101d22ae Author: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon Nov 27 13:00:32 2023 -0500 Update getting started tutorial to use an Astro template (stellar#642) * Update create-an-app.mdx to use an Astro template * Apply prettier formatting * Add some additional gotchas to the troubleshooting section * Reworks hello-world.mdx using the Astro template * Rework deploy-to-testnet.mdx to interact with the contarct via the frontend * Update storing-data.mdx * Update deploy-incrementor.mdx * Change create-an-app.mdx to wrapping-up.mdx * Apply prettier updates * Apply suggestions from code review Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> * Address PR feedback - move "???" bummer to "taking it further" - add command expansion note to deploy-to-testnet - remove mention of incrementor in deploy-to-testnet * Small cleanup * Address PR feedback * Remove release-with-logs section * Update code snippets to match updated tutorial code * Apply suggestions from code review Co-authored-by: Elliot Voris <elliot@voris.me> * Address PR feedback * Check in prettier updates * update getting started links on the landing page * redirect the old create an app page to the hello world page --------- Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@voris.me> Co-authored-by: Elliot Voris <elliot@stellar.org> commit f04a865b519d05495932fbaaf5bd075c8438c4ef Author: jcx120 <91218921+jcx120@users.noreply.github.com> Date: Mon Nov 27 09:23:53 2023 -0800 Update rpc-list.mdx (stellar#653) * Update rpc-list.mdx Added Gateway FM (and removed BlockEden since they are in the Data providers list) * style: linting mdx file --------- Co-authored-by: Elliot Voris <elliot@stellar.org> commit a9e0d34f61080bf456219e68c018432370bf3bf0 Author: Elliot Voris <elliot@stellar.org> Date: Mon Nov 27 11:22:58 2023 -0600 undo some changes from the docs scavenger hunt (stellar#656) * Revert "Squashed commit of the following:" This reverts commit ada22fee5da3073cc3e4daee60a2c4f3ffc3e378. * Update challenge-2-liquidity-pool.mdx * add context to price setting * Add v20.0.0 (stellar#668) * add P12 Release * formatting * Update releases.mdx * formatting * update horizon,stellar-base,cli * add stellar sdk + base, soroban-client, Quickstart, changelog * remove http from quickstart endpoint * v20.0.0-rc2 -> v20.0.0 * Preview 12 -> Stable v20.0.0 * update CLI, RPC, Core Versions * update stellar cor version * Content updates to go along with the preview 12 version updates (stellar#682) * update the token interface to reflect the Rust SDK * feat: get Getting Started ready for v20.0.x I don't know what the exact version of the CLI will be out by next Monday. In the source here, I've guessed that maybe it will be `20.0.3`. * update `openrpc.json` file to reflect new updates * Update static/openrpc.json Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> --------- Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> * Update token-interface.mdx * nit:formatting --------- Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (stellar#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Pre mainnet restructure (stellar#644) * docs: rename "fundamentals and concepts" to "soroban internals" * docs: remove old "under the hood" section * docs: add tags to the various tutorials * docs: move tutorials into one main directory * fix broken links to old pages * docs: renaming soroban internals in category file * docs: remove old "command line reference" category * docs: add tokens directory, rearrange sidebars * docs: rearrange migration from evm guide * docs: remove unused reference/interfaces category * docs: move "reference" section to "resources" * docs: move "releases" page up a level * docs: move FAQ page up one level * docs: move dev tools into resources directory * docs: move testnet.mdx to networks.mdx * docs: rearrange items in resources directory * docs: collapse various SDK pages into two pages * docs: move data-providers up one level * docs: remove some empty categories, move the tutorial template * docs: add a new getting-started page, reorganize that section * docs: change sidebar position integers in soroban-internals * docs: shuffling contract interaction around in soroban-internals * style: fixing a couple small markdown nits in dapps directory * docs: fix a broken link * feat: start to the "guides" page(s) * style(lint): fixing a small linting error * remove guides placeholder * fixing broken links * work on guides listing. might revert this * formatting mdx * docs: fixing a broken link to tutorials * style: crack at making the tutorials filterable and hidden in the sidebar * customizing some components for the `/guides` pages and layouts * rename index page for guides to README * remove commented configuration option * remove some console logging in components * change name of index page in guides sidebar * remove commented sidebar generation code * remove comments and add description to sidebar generator * rename sidebar generator file * more work on how the 'guides' pages might look. * docs: adjusting sidebar positions of new getting started pages * fix some broken links in the getting-started section * prefer "README.mdx" files where possible * some more guides placeholder stubs * docs(guides): More placeholder stubs for guides and categories * feat: don't display "guides in category" page on `/guides` * build: check/fix MDX formatting in more directories than just docs * style: add a larger margin before more category guides * style: more selectively increase that top margin * docs(guides): a quick stab at a "publishing" events guide * docs(guides): first stab at the "publish events" guide * docs: updating tutorial descriptions * fix a few broken links * docs: add note about a tuple with one element * style: couple link changes and reformats * move fuzzing tutorial back * change to README file in contract interactions category * docs(guides): give a better title for the wasm metadata guide * fixing some broken markdown links * fix (another!) broken link * move the guides back into the main layout of the docs directory * add placeholder for testnet reset automation stuff * some initial content for some guides * markdown formatting and fixing broken links * moving "resources" back to "reference" to fit the definition better More like "technical reference" rather than a "reference encyclopedia" * change some styles of the tutorial list * removing most category pages * some more first-drafts of guides * fixing some category links * include a period at the end of each tutorial description * simplify tutorial search box placeholder text * better description for the tutorials page * making the pre-commit script executable * flesh out some of the state archival guides * first effort for some rpc ledger key guides * fix some broken links * add a guide on ingesting events into a db * first effort at storage type guides * Some more stubs, marking drafts, and a couple additions * make not a draft to fix a broken link * guides category descriptions in README.mdx files * marking incomplete chain migration docs as drafts * change some tutorial difficulty levels * fine-tune the tutorials component styling a bit * improving some guides organization * fix linting errors and broken links * include wrap instructions for native lumens * fix broken link in contract metadata guide * final changes to existing guides * moving developer tools into the main sidebar * create real redirects instead of just notes * fix broken links in a dapps challenge page * fix a redirect syntax error * fix a tutorials redirect * update SDC leaderboard (stellar#712) * update leaderboard style * update font color * Refactor wrap/deploy of SAC (stellar#718) Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@stellar.org> * Refactor deprecated calls to `soroban config` (stellar#731) * Update the community RPC list (stellar#744) * Update RPC list with network info * Add run your own RPC * Fix urls for soroban cli * Fix path to cli * Fix relative link * Add formatted mdx --------- Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local> * move dapps challenge directory into place * install new packages for dapps-challenge * delete mispelled constants file * fix relative imports * move challenges to pages directory, and use README files * correct markdown link * fix broken links in dapps challenge docs * fix link routes in dapps challenge dashboard * add /src/pages dir to markdown formatting checks; format markdown * fix relative imports on dapps challenge dashboard * move the dashboard location into the dapps URLs * add dapps challenge dashboard to the sidebar using a customized sidebar generator for this. * remove soroban events provider component from challenge forms * fix dashboard links on dapp challenge pages * change some frontmater and remove head items from dapps challenges * move the docker guide from dapps challenge to guides * move the rest of the dapps challenge guides * update and move around the dapps guides * lint and format markdown * redirect /dapps requests, just in case * remove link to guide content that no longer exists * add link to dapps challenge in footer * add link to freighter guide on dapps challenge intro page * Update Dapps Challenge name in sidebar --------- Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Iryna Telesheva <iryna.telesheva@intellecteu.com> Co-authored-by: Iryna Telesheva <131377033+itelesheva@users.noreply.github.com> Co-authored-by: Alejandro Criado-Pérez <alejandro@criadoperez.com> Co-authored-by: illiassmalashchuk <145133100+illiassmalashchuk@users.noreply.github.com> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> Co-authored-by: MazurakIhor <131388095+MazurakIhor@users.noreply.github.com> Co-authored-by: nmadadair <109177652+nmadadair@users.noreply.github.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Sapo-Dorado <nobrown@sbcglobal.net> Co-authored-by: Satyam Zode <5508956+satyamz@users.noreply.github.com> Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com> Co-authored-by: Elizabeth <emengelman@gmail.com> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: jcx120 <91218921+jcx120@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Pamphile Roy <roy.pamphile@gmail.com> Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: Jane Wang <janelwang2008@gmail.com> Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local>
philipliu
pushed a commit
to philipliu/stellar-docs
that referenced
this pull request
Jun 11, 2024
* API documentation for Soroban-RPC (stellar#253) * Adding the `/api` route to the config, and basic intro content For the moment, I'm essentially copying from the Google Doc. Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getAccount` method Stubbing in basic file structure for all other methods. Signed-off-by: Elliot Voris <elliot@voris.me> * Expanding the methods in the sidebar by default Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for `getHealth` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getHealth` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getLatestLedger` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getLedgerEntry` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getContractData` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getEvents` method Signed-off-by: Elliot Voris <elliot@voris.me> * Un-commenting a TODO item Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getNetwork` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `getTransactionStatus` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `requestAirdrop` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for the `sendTransaction` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding content for `simulateTransaction` method Signed-off-by: Elliot Voris <elliot@voris.me> * Changing the appearance of a WIP note Signed-off-by: Elliot Voris <elliot@voris.me> * Breaking each of the intro sections into their own pages Signed-off-by: Elliot Voris <elliot@voris.me> * Hand-writing (most) of the sidebar It's easier to accomplish what I'm after this way. Or, at least, I figured out how to accomplish it this way first. Signed-off-by: Elliot Voris <elliot@voris.me> * Adding a "description" field to the intro category Signed-off-by: Elliot Voris <elliot@voris.me> * Fixing a link reference to `pagination` Signed-off-by: Elliot Voris <elliot@voris.me> * Capitalizing `Stellar` more consistently Signed-off-by: Elliot Voris <elliot@voris.me> * Update api/methods/getEvents.mdx Soroban-RPC supports querying up to 24 hours of recent ledgers. Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Update api/methods/getTransactionStatus.mdx Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * `sendTransaction` *does* support all Stellar transactions. Signed-off-by: Elliot Voris <elliot@voris.me> * Removing the question about auto-calculating footprints Signed-off-by: Elliot Voris <elliot@voris.me> * All questions have been answered. Sweet!! Signed-off-by: Elliot Voris <elliot@voris.me> * Update api/pagination.mdx Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Removing the "Outstanding Questions" page from the sidebar Signed-off-by: Elliot Voris <elliot@voris.me> * denoting `getNetwork` as a work-in-progress Signed-off-by: Elliot Voris <elliot@voris.me> * Moving the (WIP) methods to their own sidebar section Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response to the `getAccount` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `getHealth` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `sendTransaction` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `getTransactionStatus` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `getContractData` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `getLedgerEntry` method Signed-off-by: Elliot Voris <elliot@voris.me> * Changing the `balance` field into a "TODO" Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `getEvents` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding a note about the events that are returned Signed-off-by: Elliot Voris <elliot@voris.me> * Adding example request/response for the `simulateTransaction` method. Signed-off-by: Elliot Voris <elliot@voris.me> * Adding a pending example to the `getTransactionStatus` method Signed-off-by: Elliot Voris <elliot@voris.me> * Adding a more useful success example to `getTransactionStatus` Signed-off-by: Elliot Voris <elliot@voris.me> * Using a soroban transaction in the `sendTransaction` method Don't forget the footprint, friends! Signed-off-by: Elliot Voris <elliot@voris.me> * Removing the `getContractData` method This method is being deprecated. See stellar/stellar-cli#316 for more details. Please use the `getLedgerEntry` method instead. Signed-off-by: Elliot Voris <elliot@voris.me> Signed-off-by: Elliot Voris <elliot@voris.me> Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Clarify encoding of hash in the api docs (stellar#282) * Providing an example for retrieving contract code using `getLedgerEntry` (stellar#281) * Providing a (long-winded?) example for retrieving contract code Is this too detailed? Is this even needed? Signed-off-by: Elliot Voris <elliot@voris.me> * Adding a link to lab to help with decoding XDR Signed-off-by: Elliot Voris <elliot@voris.me> * Fine-tuning the explanation of the `ContractCode` LedgerEntry Shuffling some things around a bit, and giving a better overview of the contract deployment process for Soroban. Co-authored-by: Paul Bellamy <paul@paulbellamy.com> Signed-off-by: Elliot Voris <elliot@voris.me> Signed-off-by: Elliot Voris <elliot@voris.me> Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * update all admonitions such that prettier doesn't yell * Reorg (stellar#290) * Change SDK section to Reference section * Adding JS SDK to list of SDKs * Adding Overcat's Python SDK to list of SDKs * Moving Networks -> Futurenet to Reference section * Moving Releases to Reference section * Delete Networks from main nav Networks now lives under Reference section * Deleting as Releases now live in Reference section * Changing sidebar position Temporary, this will eventually move to How-To Guides * Update byo.mdx * Edited Quick Start to 1. Hello World Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds * Move Storing Data from Examples to Getting Started * Move Deploy to Local Network to Getting Started Moved this section from Tutorials to Getting Started * Move Freighter wallet tutorial to Getting Started * Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet * Move Deploy to Futurenet to Getting Started * Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx * Moved to Getting Started * Moved to Getting Started Removing this section * Moved to Getting Started Removing this as it has been moved to Getting Started * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started Removing due to this section being moved * Update Examples to How-To Guides * Move BYO SDK to How-To Guides * Moved to How-To Guides * Moved invoking contracts with transactions to How-To Guides * Removing because it's moved to How-To Guides * Moved Token Interface to Token How-To Guide * Remove Token Interface Token Interface has been moved to How-To Guides -> Token * Move Stellar Asset Contract to How-To Guides * Delete docs/built-in-contracts directory Moved to How-To Guides * Move Stellar FAQs to Learn * Delete faq.mdx Moved to Learn * Update authorization.mdx Alphabetize sidebar * Update contract-lifecycle.mdx Alphabetizing sidebar * Update custom-types.mdx Alphabetizing sidebar * Update rust-dialect.mdx Alphabetizing sidebar * Update debugging.mdx Alphabetizing sidebar * Update environment-concepts.mdx Alphabetizing sidebar * Update errors.mdx Alphabetizing sidebar * Update events.mdx Alphabetizing sidebar * Update gas-and-metering.mdx Alphabetizing sidebar * Update interacting-with-contracts.mdx Alphabetizing sidebar * Update persisting-data.mdx Alphabetizing sidebar * Update high-level-overview.mdx Update spelling * formatting * formatting * formatting * formatting * Update faq.mdx * fixed broken links * fix broken links * fix broken links * moar link fixes * fixed some broken links * added sorobanathon homepage * add google tag manager * Content edits made * back to original * Content Edit * button location * Content & Eligibility guidelines added * Update sorobanathon.js * update all admonitions such that prettier doesn't yell * Lots of formatting * --prose-wrap preserve * Update releases.mdx * update prettier * fixed the callouts * formatting * fix module import * Update sorobanathon.js * Fixed Reorg PR Fixed links, moved sections, deleted double sections * Update index.js * Updating Sorobanathon Info * Fixed links Many links. * Formatting * Change SDK section to Reference section * Adding JS SDK to list of SDKs * Adding Overcat's Python SDK to list of SDKs * Moving Networks -> Futurenet to Reference section * Moving Releases to Reference section * Delete Networks from main nav Networks now lives under Reference section * Deleting as Releases now live in Reference section * Changing sidebar position Temporary, this will eventually move to How-To Guides * Update byo.mdx * formatting * fix broken links * Edited Quick Start to 1. Hello World Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds * Move Storing Data from Examples to Getting Started * Move Deploy to Local Network to Getting Started Moved this section from Tutorials to Getting Started * Move Freighter wallet tutorial to Getting Started * Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet * Move Deploy to Futurenet to Getting Started * Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx * Moved to Getting Started Removing this as it has been moved to Getting Started * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * formatting * fix broken links * moar link fixes * Update Examples to How-To Guides * Move BYO SDK to How-To Guides * Moved invoking contracts with transactions to How-To Guides * Moved Token Interface to Token How-To Guide * Remove Token Interface Token Interface has been moved to How-To Guides -> Token * Move Stellar Asset Contract to How-To Guides * Delete docs/built-in-contracts directory Moved to How-To Guides * formatting * fixed broken links * Move Stellar FAQs to Learn * Update authorization.mdx Alphabetize sidebar * Update contract-lifecycle.mdx Alphabetizing sidebar * Update custom-types.mdx Alphabetizing sidebar * Update rust-dialect.mdx Alphabetizing sidebar * Update debugging.mdx Alphabetizing sidebar * Update environment-concepts.mdx Alphabetizing sidebar * Update errors.mdx Alphabetizing sidebar * Update events.mdx Alphabetizing sidebar * Update gas-and-metering.mdx Alphabetizing sidebar * Update interacting-with-contracts.mdx Alphabetizing sidebar * Update persisting-data.mdx Alphabetizing sidebar * Update high-level-overview.mdx Update spelling * formatting * Update faq.mdx * fixed some broken links * Update releases.mdx * update prettier * fixed the callouts * formatting * fix module import * Fixed Reorg PR Fixed links, moved sections, deleted double sections * Fixed links Many links. * Formatting * Merge cleanup * More cleanup * Formatting * some small design tweaks * copy tweaks --------- Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Anuxhya <36203801+achallagundla@users.noreply.github.com> * Update documentation to reflect recent getEvents changes (stellar#293) In stellar/stellar-cli#385 we modified the getEvents endpoint to remove the endLedger param and changed the behavior of pagination * Merge dev docs to main (stellar#316) * proposed auth-next support for simulateTransaction method * Add note about multiple results * auth is an array * Updated example docs for Auth Next. (stellar#306) * Updated example docs for Auth Next. * Update token documentation for Auth Next (stellar#307) * Update token doc to use auth next. * Add AUTH_REQUIRED section * Mention set_auth and link to classic docs * feat: update for upcoming CLI version * feat: CLI reference page * Update optimize contracts section (stellar#310) * Update hello-world.mdx * Update hello-world.mdx * don't need to manually install wasm-opt via binaryen * remove the -Z flags * More Auth Next docs updates (stellar#311) * Remove rust-auth.mdx * Update authorization docs and `Address` type info. * Added auth info to transactions doc. * Added a document about migrating to auth next. * Add some high-level docs for Auth Next preflight (stellar#312) * Add some preflight information for Auth Next * Update docs/reference/command-line.mdx * Update docs/reference/releases.mdx * Update docs/reference/releases.mdx * Update simulateTransaction.mdx * Update examples to point to 0.6.0 * Update releases page to current state * Add change log for cli and rpc * Added a note on the breaking auth changes to the release notes. (stellar#315) --------- Co-authored-by: Paul Bellamy <paul@stellar.org> Co-authored-by: Siddharth Suresh <siddharth@stellar.org> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Willem Wyndham <willem@ahalabs.dev> Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Update documentation for getTransaction() and sendTransaction() (stellar#336) * Clean up page descriptions in category indexes (stellar#348) * Add descriptions to docs that appear in generated category indexes. * Add category indexes and descriptions for SDKs and interfaces * Clean up descriptions of API documents. * compile -> create * remove apostrophe * added oxford comma * capitalization * added oxford comma --------- Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> * Add new diagnostic filter type to getEvents method (stellar#349) --------- Co-authored-by: tamirms <tamirms@gmail.com> * Update getEvents documentation to include event type csv (stellar#353) * Add `events` response field to simulateTransaction method (stellar#354) * Merge pull request stellar#319 from paulbellamy/dev Soroban-RPC updates for the release * Remove out of date file * Remove the deprecated (and now removed) getAccount soroban-rpc method * Updated docs for getLatestLedger * Update return obj descriptions * API: Update simulateTransaction RPC method to include fee support (stellar#439) * API: Update simulateTransaction RPC method to include fee support * stop using the increment example * Update api/methods/simulateTransaction.mdx Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Address review feedback --------- Co-authored-by: Paul Bellamy <paul@paulbellamy.com> * Update API method documentation (stellar#445) * Update XDR in JSON examples * replace `getLedgerEntry` by `getLedgerEntries` * Update API method documentation (stellar#445) * Update XDR in JSON examples * replace `getLedgerEntry` by `getLedgerEntries` * API: fix parameter description in getLedgerEntries (stellar#457) * API: fix parameter description in getLedgerEntries (stellar#457) * Update getLedgerEntries docs. (stellar#472) * Update getLedgerEntries docs. (stellar#472) * Release Preview 10 (stellar#480) * Change command recommended for building .wasm files for deployment (stellar#476) * Fix logging example (stellar#481) * Update docs with auth XDR changes. (stellar#483) * Update docs with auth XDR changes. * WASM->Wasm rename. Wasm is the official abbreviation of WebAssembly. * Typo fixes (stellar#484) * Add fuzzing docs. (stellar#486) * State expiration operations and token updates (stellar#485) * Add docs for state expiration operations * Updates * update token * Update custom account * More token updates * Update atomic swap * More detailed state expiration docs (stellar#492) * More fixes (stellar#489) * More fixes * Add approve warning * Update releases page * Fix link * Update example links from 0.8.4 to 0.9.2 * fix link * Fixed instance bump bug in docs (stellar#493) --------- Co-authored-by: Dmytro Kozhevin <dmytro@stellar.org> Co-authored-by: Brian Anderson <andersrb@gmail.com> Co-authored-by: Siddharth Suresh <siddharth@stellar.org> Co-authored-by: Garand Tyson <garand@stellar.org> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> * Release Preview 10 (stellar#480) * Change command recommended for building .wasm files for deployment (stellar#476) * Fix logging example (stellar#481) * Update docs with auth XDR changes. (stellar#483) * Update docs with auth XDR changes. * WASM->Wasm rename. Wasm is the official abbreviation of WebAssembly. * Typo fixes (stellar#484) * Add fuzzing docs. (stellar#486) * State expiration operations and token updates (stellar#485) * Add docs for state expiration operations * Updates * update token * Update custom account * More token updates * Update atomic swap * More detailed state expiration docs (stellar#492) * More fixes (stellar#489) * More fixes * Add approve warning * Update releases page * Fix link * Update example links from 0.8.4 to 0.9.2 * fix link * Fixed instance bump bug in docs (stellar#493) --------- Co-authored-by: Dmytro Kozhevin <dmytro@stellar.org> Co-authored-by: Brian Anderson <andersrb@gmail.com> Co-authored-by: Siddharth Suresh <siddharth@stellar.org> Co-authored-by: Garand Tyson <garand@stellar.org> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> * Clarify that there is always 0 or 1 item in `results` (stellar#506) Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Add javascript example to get the WASM content (stellar#473) * Add javascript example to get the WASM content * Update to preview 10 * Add javascript example to get the WASM content (stellar#473) * Add javascript example to get the WASM content * Update to preview 10 * Update soroban-rpc docs (stellar#551) * Add new fields * Move optionality explanations to the ends * Make the documention of every field consistent * Remove multiple results from the example (since multiop transactions are not supported) * Update simulateTransaction.mdx (stellar#567) Improved readability for the description of the `restorePreamble` in the RPC response * feat: Display example RPC requests as a useable CURL command (stellar#568) Also displaying generic code snippets for popular languages, as well as in raw JSON format. A new `ExampleRequest` component has been made to facilitate this, as well. This component takes a `method` prop for the name of the RPC method being called, as well as an optional `params` prop which can pass the object that should be used to populate the RPC request object. Refs: stellar#565 * feat: Display example RPC requests as a useable CURL command (stellar#568) Also displaying generic code snippets for popular languages, as well as in raw JSON format. A new `ExampleRequest` component has been made to facilitate this, as well. This component takes a `method` prop for the name of the RPC method being called, as well as an optional `params` prop which can pass the object that should be used to populate the RPC request object. Refs: stellar#565 * Update Futurenet to Testnet Across Documentation (stellar#577) * Futurenet -> Testnet * fix broken links * update-rpc-page * Update testnet.mdx * Pass 1 * format * update table in testnet.mdx * update state expiration example script to use testnet * replacing futurenet with testnet in contract deployment example * revert SDC contnet * include testnet network passphrase on releases page * update freighter to include testnet alongside futurenet * revert SDC to Use Futurenet for the time being * style: fix up markdown syntax and style in `rpc.mdx` Also adds some small linguistic and grammer changes, as well as more updates from Futurenet to Testnet * docs: include Testnet when describing what RPC servers SDF maintains * style: changing a single ellipsis character with three periods * docs: include gh repo links to the software that runs in quickstart * add the Testnet network to the example `initialize.sh` script * change contract-invoking transaction example code to use Testnet * change to valid futurenet URLs in dapp challenges * Apply suggestions from code review minor tweaks that slipped through the cracks --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Update Futurenet to Testnet Across Documentation (stellar#577) * Futurenet -> Testnet * fix broken links * update-rpc-page * Update testnet.mdx * Pass 1 * format * update table in testnet.mdx * update state expiration example script to use testnet * replacing futurenet with testnet in contract deployment example * revert SDC contnet * include testnet network passphrase on releases page * update freighter to include testnet alongside futurenet * revert SDC to Use Futurenet for the time being * style: fix up markdown syntax and style in `rpc.mdx` Also adds some small linguistic and grammer changes, as well as more updates from Futurenet to Testnet * docs: include Testnet when describing what RPC servers SDF maintains * style: changing a single ellipsis character with three periods * docs: include gh repo links to the software that runs in quickstart * add the Testnet network to the example `initialize.sh` script * change contract-invoking transaction example code to use Testnet * change to valid futurenet URLs in dapp challenges * Apply suggestions from code review minor tweaks that slipped through the cracks --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Clarify that IDs are strkeys, plus minor lang cleanup (stellar#605) * update getLedgerEntries documentation (stellar#614) * update * update per feedback, * update getLedgerEntries documentation (stellar#614) * update * update per feedback, * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API (stellar#603) * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API * Merged latest changes from main and adjusted descriptions * Updated docs for getLedgerEntries RPC call. Fixed typescript error. * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API (stellar#603) * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API * Merged latest changes from main and adjusted descriptions * Updated docs for getLedgerEntries RPC call. Fixed typescript error. * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (stellar#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (stellar#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Update WASM retrieval tutorial (stellar#627) * Update WASM retrieval tutorial (stellar#627) * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <elliot@stellar.org> * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <elliot@stellar.org> * Integrate a complete `openrpc.json` document (stellar#647) * docs: move data providers page out of sdks directory * restarting effort to integrate a full openrpc.json spec file * more random stuff... some of it is good and works well * docs: put everything into one `openrpc.json` document - modify the metamask package to display things a little nicer - generate openrpc.json file from a compound schema (in another repo soon) - add more react components to the `<Method />` component * style: customize metamask style for examples select box * docs: remove examples from within the mdx pages * docs: add descriptions to each of the method pages * docs: including a description of the OpenRPC spec * docs: rename sidebar category to simply "Methods" * Integrate a complete `openrpc.json` document (stellar#647) * docs: move data providers page out of sdks directory * restarting effort to integrate a full openrpc.json spec file * more random stuff... some of it is good and works well * docs: put everything into one `openrpc.json` document - modify the metamask package to display things a little nicer - generate openrpc.json file from a compound schema (in another repo soon) - add more react components to the `<Method />` component * style: customize metamask style for examples select box * docs: remove examples from within the mdx pages * docs: add descriptions to each of the method pages * docs: including a description of the OpenRPC spec * docs: rename sidebar category to simply "Methods" * Fix openrpc playground urls (stellar#649) * docs: use a github link for OpenRPC json file * docs: use gh url instead of static file * synchronize api example tabs across pages (stellar#661) * State archival refactor (stellar#678) * State archival refactor * Small fixes * Add v20.0.0 (stellar#668) * add P12 Release * formatting * Update releases.mdx * formatting * update horizon,stellar-base,cli * add stellar sdk + base, soroban-client, Quickstart, changelog * remove http from quickstart endpoint * v20.0.0-rc2 -> v20.0.0 * Preview 12 -> Stable v20.0.0 * update CLI, RPC, Core Versions * update stellar cor version * Content updates to go along with the preview 12 version updates (stellar#682) * update the token interface to reflect the Rust SDK * feat: get Getting Started ready for v20.0.x I don't know what the exact version of the CLI will be out by next Monday. In the source here, I've guessed that maybe it will be `20.0.3`. * update `openrpc.json` file to reflect new updates * Update static/openrpc.json Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> --------- Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> * Update token-interface.mdx * nit:formatting --------- Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> * soroban-docs: Update simulateTransaction Docs With New resourceConfig Parameter (stellar#683) * Update docs for new resourceConfig param in simulateTransaction * add examples for `resourceConfig` param --------- Co-authored-by: Elliot Voris <elliot@stellar.org> * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (stellar#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (stellar#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Update the state archival JavaScript tutorial (stellar#698) * Update the state archival JavaScript tutorial (stellar#698) * api: add new diagnosticEventsXdr field in sendTransaction response (stellar#700) * Pre mainnet restructure (stellar#644) * docs: rename "fundamentals and concepts" to "soroban internals" * docs: remove old "under the hood" section * docs: add tags to the various tutorials * docs: move tutorials into one main directory * fix broken links to old pages * docs: renaming soroban internals in category file * docs: remove old "command line reference" category * docs: add tokens directory, rearrange sidebars * docs: rearrange migration from evm guide * docs: remove unused reference/interfaces category * docs: move "reference" section to "resources" * docs: move "releases" page up a level * docs: move FAQ page up one level * docs: move dev tools into resources directory * docs: move testnet.mdx to networks.mdx * docs: rearrange items in resources directory * docs: collapse various SDK pages into two pages * docs: move data-providers up one level * docs: remove some empty categories, move the tutorial template * docs: add a new getting-started page, reorganize that section * docs: change sidebar position integers in soroban-internals * docs: shuffling contract interaction around in soroban-internals * style: fixing a couple small markdown nits in dapps directory * docs: fix a broken link * feat: start to the "guides" page(s) * style(lint): fixing a small linting error * remove guides placeholder * fixing broken links * work on guides listing. might revert this * formatting mdx * docs: fixing a broken link to tutorials * style: crack at making the tutorials filterable and hidden in the sidebar * customizing some components for the `/guides` pages and layouts * rename index page for guides to README * remove commented configuration option * remove some console logging in components * change name of index page in guides sidebar * remove commented sidebar generation code * remove comments and add description to sidebar generator * rename sidebar generator file * more work on how the 'guides' pages might look. * docs: adjusting sidebar positions of new getting started pages * fix some broken links in the getting-started section * prefer "README.mdx" files where possible * some more guides placeholder stubs * docs(guides): More placeholder stubs for guides and categories * feat: don't display "guides in category" page on `/guides` * build: check/fix MDX formatting in more directories than just docs * style: add a larger margin before more category guides * style: more selectively increase that top margin * docs(guides): a quick stab at a "publishing" events guide * docs(guides): first stab at the "publish events" guide * docs: updating tutorial descriptions * fix a few broken links * docs: add note about a tuple with one element * style: couple link changes and reformats * move fuzzing tutorial back * change to README file in contract interactions category * docs(guides): give a better title for the wasm metadata guide * fixing some broken markdown links * fix (another!) broken link * move the guides back into the main layout of the docs directory * add placeholder for testnet reset automation stuff * some initial content for some guides * markdown formatting and fixing broken links * moving "resources" back to "reference" to fit the definition better More like "technical reference" rather than a "reference encyclopedia" * change some styles of the tutorial list * removing most category pages * some more first-drafts of guides * fixing some category links * include a period at the end of each tutorial description * simplify tutorial search box placeholder text * better description for the tutorials page * making the pre-commit script executable * flesh out some of the state archival guides * first effort for some rpc ledger key guides * fix some broken links * add a guide on ingesting events into a db * first effort at storage type guides * Some more stubs, marking drafts, and a couple additions * make not a draft to fix a broken link * guides category descriptions in README.mdx files * marking incomplete chain migration docs as drafts * change some tutorial difficulty levels * fine-tune the tutorials component styling a bit * improving some guides organization * fix linting errors and broken links * include wrap instructions for native lumens * fix broken link in contract metadata guide * final changes to existing guides * moving developer tools into the main sidebar * create real redirects instead of just notes * fix broken links in a dapps challenge page * fix a redirect syntax error * fix a tutorials redirect * Pre mainnet restructure (stellar#644) * docs: rename "fundamentals and concepts" to "soroban internals" * docs: remove old "under the hood" section * docs: add tags to the various tutorials * docs: move tutorials into one main directory * fix broken links to old pages * docs: renaming soroban internals in category file * docs: remove old "command line reference" category * docs: add tokens directory, rearrange sidebars * docs: rearrange migration from evm guide * docs: remove unused reference/interfaces category * docs: move "reference" section to "resources" * docs: move "releases" page up a level * docs: move FAQ page up one level * docs: move dev tools into resources directory * docs: move testnet.mdx to networks.mdx * docs: rearrange items in resources directory * docs: collapse various SDK pages into two pages * docs: move data-providers up one level * docs: remove some empty categories, move the tutorial template * docs: add a new getting-started page, reorganize that section * docs: change sidebar position integers in soroban-internals * docs: shuffling contract interaction around in soroban-internals * style: fixing a couple small markdown nits in dapps directory * docs: fix a broken link * feat: start to the "guides" page(s) * style(lint): fixing a small linting error * remove guides placeholder * fixing broken links * work on guides listing. might revert this * formatting mdx * docs: fixing a broken link to tutorials * style: crack at making the tutorials filterable and hidden in the sidebar * customizing some components for the `/guides` pages and layouts * rename index page for guides to README * remove commented configuration option * remove some console logging in components * change name of index page in guides sidebar * remove commented sidebar generation code * remove comments and add description to sidebar generator * rename sidebar generator file * more work on how the 'guides' pages might look. * docs: adjusting sidebar positions of new getting started pages * fix some broken links in the getting-started section * prefer "README.mdx" files where possible * some more guides placeholder stubs * docs(guides): More placeholder stubs for guides and categories * feat: don't display "guides in category" page on `/guides` * build: check/fix MDX formatting in more directories than just docs * style: add a larger margin before more category guides * style: more selectively increase that top margin * docs(guides): a quick stab at a "publishing" events guide * docs(guides): first stab at the "publish events" guide * docs: updating tutorial descriptions * fix a few broken links * docs: add note about a tuple with one element * style: couple link changes and reformats * move fuzzing tutorial back * change to README file in contract interactions category * docs(guides): give a better title for the wasm metadata guide * fixing some broken markdown links * fix (another!) broken link * move the guides back into the main layout of the docs directory * add placeholder for testnet reset automation stuff * some initial content for some guides * markdown formatting and fixing broken links * moving "resources" back to "reference" to fit the definition better More like "technical reference" rather than a "reference encyclopedia" * change some styles of the tutorial list * removing most category pages * some more first-drafts of guides * fixing some category links * include a period at the end of each tutorial description * simplify tutorial search box placeholder text * better description for the tutorials page * making the pre-commit script executable * flesh out some of the state archival guides * first effort for some rpc ledger key guides * fix some broken links * add a guide on ingesting events into a db * first effort at storage type guides * Some more stubs, marking drafts, and a couple additions * make not a draft to fix a broken link * guides category descriptions in README.mdx files * marking incomplete chain migration docs as drafts * change some tutorial difficulty levels * fine-tune the tutorials component styling a bit * improving some guides organization * fix linting errors and broken links * include wrap instructions for native lumens * fix broken link in contract metadata guide * final changes to existing guides * moving developer tools into the main sidebar * create real redirects instead of just notes * fix broken links in a dapps challenge page * fix a redirect syntax error * fix a tutorials redirect * Generate the `openrpc.json` specification file in this repo (stellar#692) * move specfile generation into this repo * add a readme to the openrpc directory, ignore transitional files * add spec generation to docker file * test change to `getEvents` method * Revert "test change to `getEvents` method" This reverts commit 978b8b0f54c794fe59b83f2f1e866794bfc7b917. * remove console statements in build script * add note about the build process at deploy time * updating build with newest fields * Update RPC docs for clarify on deprecation of postional array and costs (stellar#721) * Update RPC docs for clarify on deprecation of postional array and costs * Update description on costs * Update in JSON-RPC info * Update transaction desc * Add build file * remove an extra file * modify the patch for the openrpc react package this will display our custom note following the parameters heading and before any of the named parameters are listed * remove the notes about by-name parameters in transaction params * add `deprecated` to the `cost` object in the tx simulation result * add the built `openrpc.json` file --------- Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local> Co-authored-by: Elliot Voris <elliot@stellar.org> * Fix case of parameter (stellar#727) * use by-name params in pagination example (stellar#743) Refs: stellar#728 * create platforms section of docs - move a `/api` directory to be `/platforms` - move admin guides for horizon, anchor platform, sdp into their respective "platform" sections * modify sidebars * rename sidebar generator for api/platforms docs * re-order admin guides for the various platforms * fix broken links * custom css for dropdown "sections" in the platforms navbar item * change `/api` -> `/platforms` in custom sidebar component * docusaurus config changes * fix typo in sdp filepath * fix more broken links * change rpc filepath to reflect "platforms" language * fix broken links and setup soroban-rpc sidebar * install required packages for soroban rpc methods * modify custom RpcMethod component to handle a single rpc doc * specify `platform=soroban` for these methods * add soroban-rpc to Platforms dropdown menu * remove sdp from the docs sidebar, since it is now in platforms * custom css for metmask openrpc package * fix a broken link * update URLs in openrpc specfile * rename admin guide directories * use the default layout for admin guide pages * fix some broken links * Add Hubble to Platforms tab * display admin guide docs with default DocItem component * specify the slug for the hubble overview page * include hubble pages in the default DocItem component check * remove unnecessary console statement * fix broken links * move soroban rpc intro files into a consisten folder * move new anchor platform events docs into place * fix broken links * improve text in platforms index page * Add Introduction to Horizon -Change original "Introduction" to "Structure" -Include Introduction for Horizon * fix broken links * use the default DocItem component for soroban-rpc pages, too * Add RPC providers and usage to RPC section * Change Hubble Overview to Introduction to align * Add Horizon Introduction content * Shuffle RPC sections * use README.mdx conventions in anchor platform admin guide * fix broken links * use README.mdx conventions in horizon * use README.mdx convention for soroban-rpc * fix link, formatting * fix more broken links * use README.mdx conventions in sdp * fix a whole bunch of broken links * Horizon structural changes * Update outdated code. (stellar#759) * nicer look for menu dropdown subtitles * expand soroban rcp methods category by default * move core node docs to "Network" section * rename platforms to network * fix broken links, styles, etc. * use default DocItem for core-node docs * add link to Network dropdown and style the active dropdown item * more README.mdx uses in anchor platform * fix broken links * change filepaths in redocly scripts `api/` -> `network/` * first stab at nginx redirects * use more README.mdx in horizon * more README.mdx files in horizon * more README.mdx files (almost done i think?) * final batch of README.mdx files * change platforms to network in soroban-rpc openrpc URLs * fix a broken link * add the rpcspec command to the docker build file * move updated getLedgerEntries page into the correct location --------- Signed-off-by: Elliot Voris <elliot@voris.me> Co-authored-by: Paul Bellamy <paul@paulbellamy.com> Co-authored-by: Paul Bellamy <paul@stellar.org> Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> Co-authored-by: Anuxhya <36203801+achallagundla@users.noreply.github.com> Co-authored-by: tamirms <tamirms@gmail.com> Co-authored-by: Dmytro Kozhevin <dmytro@stellar.org> Co-authored-by: Siddharth Suresh <siddharth@stellar.org> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: Willem Wyndham <willem@ahalabs.dev> Co-authored-by: Brian Anderson <andersrb@gmail.com> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> Co-authored-by: Tyler.S <tyler.sanderson@stellar.org> Co-authored-by: stellarsaur <126507441+stellarsaur@users.noreply.github.com> Co-authored-by: Jun Luo <4catcode@gmail.com> Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: Garand Tyson <garand@stellar.org> Co-authored-by: Julian Martinez <julian_martinez28@outlook.com> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Vincent Amouret <vincent.amouret@gmail.com> Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Co-authored-by: Tsachi Herman <24438559+tsachiherman@users.noreply.github.com> Co-authored-by: MazurakIhor <131388095+MazurakIhor@users.noreply.github.com> Co-authored-by: Molly Karcher <mdarkar@gmail.com> Co-authored-by: Jane Wang <janelwang2008@gmail.com> Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local>
janewang
pushed a commit
that referenced
this pull request
Jun 18, 2024
* Changing "Soroban CLI" to "Stellar CLI" * Update soroban-cli version. (#634) * Update some CLI commands * Remove Deadlink - Stellar Authenticator (#637) * Update setup.mdx (#644) The soroban-cli version in this doc is outdated and will give the following error when invoking a deployed contract: "error: xdr processing error: xdr value invalid" As specified here an update of the CLI version is needed: https://stellar.org/blog/developers/protocol-21-upgrade-guide * Update smart-contract-deployment.mdx (#645) The it is an issue in the vault contract's withdraw function which will incorrectly update the value of Reserve. In this line let balance = get_token_balance(&e); balance is updated AFTER the transfer of the user deposit + yield has already occurred. Thus the balance fetched is already the current "reserve" balance of the Vault. So when the following line of code executes: put_reserve(&e, balance - amount); the Reserve is updated to the balance of the Vault contract - the amount withdrawn by the user, so it will count the withdrawn 2 times. Indeed when following the test the result from "get_rsrvs" in the first scenario will be : "-1" Initial balance of the Vault: 200 - amount: 100 + yield: 1 (from the transfer) - amount: 100 (from the put_reserve input). For further improvements the get_rsrvs should only account for the amount of reward tokens that the vault is holding which can be useful to obtain the deposited amount (vault balance - reserves). Additionally the --wasm argument in the "invoke" command is not needed and it was removed. * [SDP-1054] Updating Stellar Docs for SDP multi-tenant (#407) * [SDP-1139] sdp: add SDP multi-tenant migration doc (#394) * feat: add SDP multi-tenant migration doc * chore: address PR comments * [SDP-1056] sdp: add SDP Admin API spec (#397) * feat: add SDP Admin API spec * chore: address PR comments * fix: remove distribution_account field * SDP-1054 update design and architecture docs * Update the "Getting Started" section. * chore: update SDP docs build (#440) When running the `yarn api` these files are rebuilt due to a new authenticate method added (`Basic Auth`). This PR only updates these files to the latest version. The changes are related to this #397. * [SDP-1100] Default tenant endpoint (#455) This PR adds the default tenant endpoint that sets a tenant as the default in the system. --------- Authored-by: Caio Teixeira <caio.xd63@hotmail.com> * [SDP-1151] Update single-tenant to multi-tenant migration guide (#496) ### What Update the single-tenant to multi-tenant migration guide with the following changes: * Update the status requirements saying that the only payments/submitter_transactions statuses that need to be solved before the migration are PENDING/PROCESSING * Reorganize the content * Add extra sections with more info * Include new commands and SQL queries to make the migration easier. * Add TODOs: - [x] stellar/stellar-disbursement-platform-backend#262 - [ ] stellar/stellar-disbursement-platform-backend#266 - [ ] https://stellarorg.atlassian.net/browse/SDP-1148 * [SDP-1151] Polish the single-tenant to multi-tenant migration guide (#511) * [SDP-1157] add `Configuring the SDP` page (#512) * SDP-1157 adding `Configuring the SDP` page * SDP-1157 adding `Configuring the SDP` page * SDP-1157 address PR comments * SDP-1157 move sdp API under api-reference folder * Fix broken link * Change architecture diagram * Update instructions with the updated field name. * add tenant resolution and multi-tenant subdomain info. (#578) * add tenant resolution and multi-tenant subdomain info. * address PR comments * Enforce the necessity to include the home domain in the SDP SEP-10 challenge GET request (#654) ### Why To keep the docs up to date with the code. This is now required in the multitenant instance. * [SDP] Polish the docs for the multitenant 2.0.0 release (#656) ### Changes - Add the missing DELETE /tenants/:id API documentation - Update the request and response bodies in the /tenants API. - Updated the checksum on the .api.mdx files by running `yarn api` --------- Co-authored-by: Caio Teixeira <caio.xd63@hotmail.com> Co-authored-by: Erica <erica.liu@stellar.org> Co-authored-by: Marcelo Salloum dos Santos <marcelosalloum@gmail.com> Co-authored-by: Marcelo Salloum <marcelo@stellar.org> * Rewriting scaling documentation (#659) * rpc: add getFeeStats method documentation (#660) * rpc: add getFeeStats method * Address review feedback * Remove unneeded stop * Add some description updates --------- Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local> * Soroban RPC: Add document for getVersionInfo RPC (#661) * Add document for getVersionInfo RPC * update info * Add captive core info * Add a table of hardware requirements for various node types (#568) * add a doc with a requirements comparison table * add some sidebar content for new-ish section * adjust some heading config for platforms pages * Fix command for adding new networks. (#667) * Adding Tokens Overview (wayfinding) (#570) * Adding Tokens Overview (wayfinding) * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * formatting * more updates * update copy * couple nits * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Jake Urban <10968980+JakeUrban@users.noreply.github.com> * update wording * update note * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * G & C addresses * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> * wording * formatting --------- Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: Jake Urban <10968980+JakeUrban@users.noreply.github.com> * Categorize Learn Section (#646) * Categorize Learn Section * moving things around * fix links * more links * mas links * beaucoup links * mais links * authorization heading fix * message * little nits * Fix link (#675) * Learn section redirects (#678) * Add examples of invoking contracts using Python SDK and Java SDK. (#643) * Add examples of calling contracts using Python SDK and Java SDK * rename file * fix js example * Add hubble diagrams and data dicts (#670) Add hubble diagrams and data dicts * Add Passkey Library session to meeting notes (#681) * update meeting notes * Update 2024-06-13.mdx * Update 2024-06-13.mdx * Update 2024-06-13.mdx --------- Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Add Ortege to Block Explorers (#671) * Add Ortege to Block Explorers * Update developer-tools.mdx * Update Software Versions for Protocol 21: Mainnet (#685) * Update Software Versions for Protocol 21: Mainnet * adding versions back to be updated * rpc: Add `getTransactions` documentation (#636) * Add getTransactions documenation - 1 * Add getTransactions documentation - 2 * Add getTransactions documentation - 4 * Refactor Pagination changes * Refactor the params object in getTransactions examples * Change naming to only RPC * Change description of diagnosticEventsXdr * Add "items" * Update openrpc/src/methods/getTransactions.json Co-authored-by: George <Shaptic@users.noreply.github.com> * Update openrpc/src/schemas/Cursor.json Co-authored-by: George <Shaptic@users.noreply.github.com> * Update openrpc/src/schemas/Pagination.json Co-authored-by: George <Shaptic@users.noreply.github.com> * Small changes - 1 * Remove links - 1 * Remove links - 2 * Fix broken TOID link --------- Co-authored-by: George <Shaptic@users.noreply.github.com> * Updates to Getting Started Docs (#674) * Update soroban output to current 21.x state * Fix naming for HelloContractClient * Consistent directory names * formatting and link --------- Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> * Add more detail to overlay survey instructions (#653) * Add more detail to overlay survey instructions This change adds some additional instructions to the overlay survey section of the admin guide. Specifically, it adds: * Instructions on how to use the overlay survey script. * Information about the `nonce` field in the "start/stop collecting" messages. * Explicit instructions on how to opt-out of the survey. * Recommendations for collecting phase durations. * Small tweaks to fix grammar/formatting/example errors found while editing the section * Add links * Add admin-guide for hubble (#669) Add admin-guide for hubble * typo fix in cli guid (#693) * Update docs/smart-contracts/getting-started/setup.mdx Co-authored-by: Nando Vieira <me@fnando.com> * Changing "Soroban CLI" to "Stellar CLI" * Update some CLI commands * Add more cli updates * Update to stellar cli * Fix path --------- Co-authored-by: Nando Vieira <me@fnando.com> Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local> Co-authored-by: Ricky Lindenhovius <1669379+xiv@users.noreply.github.com> Co-authored-by: FrankFourier <84725957+Frank-Fourier@users.noreply.github.com> Co-authored-by: Marwen Abid <marwen.abid@stellar.org> Co-authored-by: Caio Teixeira <caio.xd63@hotmail.com> Co-authored-by: Erica <erica.liu@stellar.org> Co-authored-by: Marcelo Salloum dos Santos <marcelosalloum@gmail.com> Co-authored-by: Marcelo Salloum <marcelo@stellar.org> Co-authored-by: Molly Karcher <molly@stellar.org> Co-authored-by: Alfonso Acosta <fons@syntacticsugar.consulting> Co-authored-by: Prit Sheth <124409873+psheth9@users.noreply.github.com> Co-authored-by: Elliot Voris <elliot@stellar.org> Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: Jake Urban <10968980+JakeUrban@users.noreply.github.com> Co-authored-by: Jun Luo <4catcode@gmail.com> Co-authored-by: chowbao <simon.chow765@gmail.com> Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com> Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> Co-authored-by: Aditya Vyas <adityavyas17@gmail.com> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Pam S <pamela.selle@gmail.com> Co-authored-by: Brett Boston <bboston7@users.noreply.github.com> Co-authored-by: Rahul Soshte <rahul.soshte4771@gmail.com>
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.
Title says it all
Fixes #632