Skip to content

Commit

Permalink
[Soroban Merge] Create a "Learn" section of the docs (stellar#354)
Browse files Browse the repository at this point in the history
* initial commit

* example including an image

* add doc on assets-and-authorization, with auth part filled in

* update wordmark

* Add a homepage (stellar#197)

* permit homepage

* progress

* desktop version is donenough

* slight mobile tweaks

* feedback tweaks

* small order and style tweaks

* mobile tweaks

* copy tweak

* moar slight tweaks

* add Sorobanathon links

* slight rename

* z-index tweaks

* USDC -> XLM

* copy tweak

* tweakers for weekers

* copy and zindex tweaks

* appeasing the nit pickers

* added a meta image

* Soroban landing (stellar#396)

* init soroban landing

* Start landing markup

* Add earn section and refine styles

* Add SCF section

* Add Soroban section

* Update hero min-height

* add media section

* add assets v1

* add links to getting started

* update twitter

* add assets v2

* add missing links

* Adjust images

* final

* clean up old home page assets

* cleanup scss colors

* added hello world code

* dark mode

* fixed some minor issues

* updaters

* add a 5. card

---------

Co-authored-by: Jesmar Castillo <32423903+jesmarsc@users.noreply.github.com>
Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>

* Evm to Soroban (#409)

* initial commit

* add code breakdown

* add mdx

* remove mdx

* update Rust SC

* add advanced concepts

* add vault contract and tests

* Update solidity-and-rust-advanced-concepts.mdx

* remove un tabbed code

* update vault.rs; add shell cmds

* update yield amount

* add vault deployment and interaction

* add wdraw message

* fix script sequence

* add EVM comparison

* update error handling

* 1st round review

* Update script descroption

* add solidity to approved languages

* fixed a broken link

* move file folder; add token inheritance

* update links

* fixed broken links

* update Soroban Description

* nit: spelling

* Fix bytes and arrays

* spelling errors

* spelling errors

* no capitalization on build

* grammar spelling errors

* spelling and grammar errors

* fixes; post PR review

* macros description

* Correction: Data Types

* update Symbol Definition

* update traits definition: fix Solidity Contract

* Merge main into evm-to-soroban (stellar#414)

* update code block (stellar#400)

* additional copy changes to site (stellar#401)

* copy edits from Dom (stellar#403)

* update broken link (stellar#404)

* update token interface (stellar#406)

* update token intereface

Interface was referenced from :
https://github.com/stellar/rs-soroban-sdk/blob/main/soroban-sdk/src/token.rs

* update fn description

* nit: update fn description

* nit: format

* nit: bracket format

* fix event topics

* update events

* revert per PR to fix event name

https://github.com/stellar/rs-soroban-env/pull/778/files

* Improve Failure Condition Handling in Token Interface (stellar#394)

* Add Error Handling Section

* update authorization info

* add more context to authorization

* nit: call not specific to callers address

* Add event docs (stellar#375)

* Add event docs

* Remove note

* Add link to events example

* fixes malformed hello world link (stellar#412)

* Remove derive Default (stellar#413)

---------

Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>
Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com>
Co-authored-by: Siddharth Suresh <siddharth@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* fix spelling and add string example

* move evm-to-soroban

* resolve conflict

* add auth section. Add comparison for addresses

* embolden main point about replay prevention

* nit update section

* nit wording

* improve Address and Auth Callouts

* update contract deposit fn. Update ID to addr conversion

* nit: var placeholders

* example vault update

* update vault example to 8.1

* update to align w main

* updates Env:: to env. ; nits

* add section on composability

* nit: update soroban-sdk version

* update example to use sdk 8.4

* remove admin from mint

* nit: grammar; update tx messages

---------

Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>
Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com>
Co-authored-by: Siddharth Suresh <siddharth@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* 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>

* seo-editorial-docs (stellar#547)

* 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>

* 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>

* 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 b6a1a46df7d2b42b340f1331ec52733bc6216725
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>

* undo some changes from the docs scavenger hunt (stellar#656)

* clearer Soroban favicon (stellar#662)

* 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

* add some items for the rollout (stellar#684)

* 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

* docs: make the transaction lifecycle page a draft (stellar#701)

* Fix description of enums supported by contract types (stellar#703)

* Update resource limits and make a new reference page for them (stellar#736)

* add a reference page on resource limits and fees

* remove resource fee/limit tables from "explainer" page

* removing some unnecessary comments and entries

Some of the comments are more applicable in the discussion doc,
than they are for developer documentation. So, let's get rid of
those.

* remove unnecessary "current is..." language from resource fees

* [Stellar Merge] Tools Section (stellar#739)

* create redirects for tools and SDKs pages

* adjust some redirect URLs to better reflect new stellar-docs pages

* forgot a semicolon!

* linking to migrated developer tools page

* fine-tuning some redirects

* add a list of "already migrated" stuff to the sidebar

* remove SDKs content that's being migrated

* fix the resulting broken links

* Revert "remove SDKs content that's being migrated"

This reverts commit 6dd2a28a8f124e876607a9bf30894a420ea6eb08.

* Revert "linking to migrated developer tools page"

This reverts commit fc2340818a08c42fc1f13f6a49d97111610c9100.

* try this method of turning docs into external links

* include soroban-cli page in the tools migration

* change cli links to developer docs

* use by-name params in pagination example (stellar#743)

Refs: stellar#728

* [Stellar Merge] Tools Section (stellar#739)

* create redirects for tools and SDKs pages

* adjust some redirect URLs to better reflect new stellar-docs pages

* forgot a semicolon!

* linking to migrated developer tools page

* fine-tuning some redirects

* add a list of "already migrated" stuff to the sidebar

* remove SDKs content that's being migrated

* fix the resulting broken links

* Revert "remove SDKs content that's being migrated"

This reverts commit 6dd2a28a8f124e876607a9bf30894a420ea6eb08.

* Revert "linking to migrated developer tools page"

This reverts commit fc2340818a08c42fc1f13f6a49d97111610c9100.

* try this method of turning docs into external links

* include soroban-cli page in the tools migration

* change cli links to developer docs

* use by-name params in pagination example (stellar#743)

Refs: stellar#728

* Update fee page, close stellar#710 (stellar#745)

* Update fee page, close stellar#710

* Apply suggestions from code review

Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

---------

Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local>
Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* Update fee page, close stellar#710 (stellar#745)

* Update fee page, close stellar#710

* Apply suggestions from code review

Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

---------

Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local>
Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* [Stellar Merge] Redirects for Soroban RPC pages (stellar#757)

* add a redirect for anything under the `/api` route

* change the API navbar item to an external link

* disable the `/api` plugin-content-docs

* fix some broken links

* updating a couple other misc redirects

* add external links to RPC providers and usage instructions

* add some redirects for RPC information docs

* add an admonition to the rpc usage page

* move some directories into a "learn" directory

* more README.mdx files

* update sidebars

* add a "Learn" item to the top navbar

* fix a boat-load of broken links

* add whitespace back to list of operations

* add more linebreak spaces

* initial nginx redirects

* Add Java SDK Example. (stellar#765)

* Add Java SDK Example.

* Enable Java code highlights.

* use a README file in the stellar data structures section

* pull in changes for soroban-internals section

* use a README file in soroban-internals section

* move the soroban env diagram file location

* fix broken links in soroban internals pages

* run soroban internals pages through linter

* use a README file in soroban types category

* use README for contract interactions section

* move migrate docs into learn directory

* use a README document for the migration section

* fixup some broken links in the migration section

* fix a couple more broken links

* quick placeholders for sq and fca00c, we'll want better copy probably

* try to capture any anchor URLs used in the glossary

* update existing redirects for new learn section

* fix muxed accounts redirect

* better README files in chain migration categories

* rename "soroban-internals" to "smart contract internals"

* fix broken links

* fix canonical links in smart-contract-internals directory

* change title of Smart Contracts Internals category page

* couple tweaks

* capitalization

* fix link

* use `.mdx` links to markdown files in fees encyclopedia page

---------

Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com>
Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>
Co-authored-by: Graydon Hoare <graydon@pobox.com>
Co-authored-by: Alejo Mendoza <alejomendoza@users.noreply.github.com>
Co-authored-by: Jesmar Castillo <32423903+jesmarsc@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: Siddharth Suresh <siddharth@stellar.org>
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@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: 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: Julian Martinez <julian_martinez28@outlook.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: jcx120 <91218921+jcx120@users.noreply.github.com>
Co-authored-by: Jane Wang <janelwang2008@gmail.com>
Co-authored-by: Jane Wang <janewang@Janes-MacBook-Pro.local>
Co-authored-by: Jun Luo <4catcode@gmail.com>
  • Loading branch information
24 people committed Mar 13, 2024
1 parent 0f7a28d commit 52a10f9
Show file tree
Hide file tree
Showing 357 changed files with 25,398 additions and 358 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Welcome to the official home repository for [Documentation][docs] and
[API Reference][api] for the [Stellar Network][stellar].

# Table of Contents <!-- omit in toc -->
## Table of Contents <!-- omit in toc -->

- [Contributing](#contributing)
- [Quick Start](#quick-start)
Expand All @@ -14,7 +14,7 @@ Welcome to the official home repository for [Documentation][docs] and
- [Alert](#alert)
- [Code Example](#code-example)

# Contributing
## Contributing

Contributions are more than welcome! Thank you! 🎉

Expand All @@ -29,8 +29,8 @@ helpful and meaningful way. Markdown is super easy to learn, and will come quite
naturally after only a bit of practice. You can always help fix typos, spelling,
and broken links, too.

# Quick Start
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][codespaces]
## Quick Start
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][codespaces]
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod]

To begin development on the documentation, you will first need [yarn][yarn]
Expand All @@ -55,7 +55,7 @@ npm run check:mdx # this will search for problems in the MDX files
npm run format:mdx # this will fix any problems that were found
```

# Repository Structure
## Repository Structure

- `/docs/` Contains all the documentation content. If you're contributing to the
actual documentation, rather than site functionality, this is likely where you
Expand Down Expand Up @@ -88,9 +88,9 @@ npm run format:mdx # this will fix any problems that were found
case-by-case basis, and it may be determined that a redirect isn't the right
approach in some instances.)

# Using Markdown
## Using Markdown

## Markdown Basics
### Markdown Basics

If you're unfamiliar with Markdown, there are **loads** of good tutorials and
cheat sheets out there. Check out some of these resources to get a handle on the
Expand All @@ -100,24 +100,24 @@ basics:
- [Interactive markdown tutorial][tutorial]
- [The markdown guide][guide]

## Custom Markdown
### Custom Markdown

Our repository uses some custom React components that can be used inside the
`MDX` documents. Use them as follows:

**Make sure that there is an empty line within the wrapper.** For example,

```
```text
<Alert>
<!-- EMPTY LINE AFTER THE COMPONENT'S OPENING TAG IS REQUIRED -->
Note: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../fundamentals-and-concepts/testnet-and-pubnet).
Note: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../learn/fundamentals/networks.mdx).
<!-- EMPTY LINE BEFORE THE COMPONENT'S CLOSING TAG IS REQUIRED -->
</Alert>
```

### Alert
#### Alert

![Testnet reset alert](./readme-imgs/alert.png)

Expand All @@ -134,7 +134,7 @@ Note: the testnet is reset every three months, so when building on it, make sure
</Alert>
```

### Code Example
#### Code Example

![Create account code example](./readme-imgs/code-example.png)

Expand Down
8 changes: 4 additions & 4 deletions docs/building-apps/application-design-considerations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are four custody options to consider:

- Non-custodial service - the user of the application stores their own secret key
- Custodial service - the service provider (application) stores the users’ secret keys
- Mixture of both - with the use of [multisig](../encyclopedia/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery
- Mixture of both - with the use of [multisig](../learn/encyclopedia/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery
- Third-party key management services - integrate a third-party custodial service into your application that can store your users’ secret keys

### Non-custodial service
Expand All @@ -24,13 +24,13 @@ Typically, non-custodial applications create or import a pre-existing Stellar ac

With a custodial service, the service provider (an application such as a centralized exchange) stores the users’ secret keys and delegates usage rights to the user.

Many custodial services choose to use a single pooled Stellar account (called shared, omnibus, or [pooled accounts](https://developers.stellar.org/docs/encyclopedia/pooled-accounts-muxed-accounts-memos)) to handle transactions on behalf of their users instead of creating a new Stellar account for each user. To distinguish between individual users in a pooled account, we encourage the implementation of [muxed accounts](https://developers.stellar.org/docs/encyclopedia/pooled-accounts-muxed-accounts-memos#muxed-accounts).
Many custodial services choose to use a single pooled Stellar account (called shared, omnibus, or [pooled accounts](../learn/encyclopedia/pooled-accounts-muxed-accounts-memos.mdx)) to handle transactions on behalf of their users instead of creating a new Stellar account for each user. To distinguish between individual users in a pooled account, we encourage the implementation of [muxed accounts](../learn/encyclopedia/pooled-accounts-muxed-accounts-memos.mdx#muxed-accounts).

Learn how to set up an application as a custodial service in this [tutorial].

### A mixture of non-custodial and custodial

Building an application with [multi-signature](../encyclopedia/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough.
Building an application with [multi-signature](../learn/encyclopedia/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough.

### Third-party key management services​

Expand Down Expand Up @@ -95,7 +95,7 @@ The flow with Claimable Balances looks like this:

### Option 2: the wallet creates and funds the Stellar account upon user sign-up​

For this option, the wallet creates and funds the Stellar account upon every new user sign-up with the minimum requirement of 1XLM, plus the .5XLM reserve for establishing the first trustline, plus a bit more to cover transaction fees. For more information on minimum balances, check out the [Lumens section](https://developers.stellar.org/docs/fundamentals-and-concepts/lumens#minimum-balance).
For this option, the wallet creates and funds the Stellar account upon every new user sign-up with the minimum requirement of 1XLM, plus the .5XLM reserve for establishing the first trustline, plus a bit more to cover transaction fees. For more information on minimum balances, check out the [Lumens section](../learn/fundamentals/lumens.mdx#minimum-balance).

The flow looks like this:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ Source: https://github.com/stellar/basic-payment-app/blob/main/src/lib/stellar/h

Our `walletStore` is used in a ton of places in our application, especially in the confirmation modal when asking a user to input their pincode. Read on to see how we've done that.

[accounts section]: ../../fundamentals-and-concepts/stellar-data-structures/accounts
[accounts section]: ../../learn/fundamentals/stellar-data-structures/accounts.mdx
[non-custodial application]: ../application-design-considerations#non-custodial-service
[`js-stellar-wallets` sdk]: https://github.com/stellar/js-stellar-wallets
[sponsored reserves]: ../../encyclopedia/sponsored-reserves
[sponsored reserves]: ../../learn/encyclopedia/sponsored-reserves.mdx
[contacts list]: ./contacts-list
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this example, we’ll use an anchor on Stellar’s Testnet to simulate a bank

:::info

SEPs define community-decided standards for interoperability on Stellar. Read more in our [SEPs section](../../../fundamentals-and-concepts/stellar-ecosystem-proposals).
SEPs define community-decided standards for interoperability on Stellar. Read more in our [SEPs section](../../../learn/fundamentals/stellar-ecosystem-proposals.mdx).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ title: Manage Trust
sidebar_position: 30
---

For an account to hold and trade assets other than XLM, it must establish a [trustline](../../fundamentals-and-concepts/stellar-data-structures/accounts#trustlines) with the issuing account of that particular asset. Each trustline increases the account’s [base reserve](../../fundamentals-and-concepts/stellar-data-structures/accounts#base-reserves-and-subentries) by 0.5 XLM, which means the account will have to hold more XLM in its minimum balance.
For an account to hold and trade assets other than XLM, it must establish a [trustline](../../learn/fundamentals/stellar-data-structures/accounts.mdx#trustlines) with the issuing account of that particular asset. Each trustline increases the account’s [base reserve](../../learn/fundamentals/stellar-data-structures/accounts.mdx#base-reserves-and-subentries) by 0.5 XLM, which means the account will have to hold more XLM in its minimum balance.

## User experience

First, we’ll have the user create a trustline for an asset by navigating to the Assets page, selecting an asset, and clicking the “Add Asset” button.

:::info

An asset is displayed as an asset code and issuer address. Learn more in our [Assets section](https://developers.stellar.org/docs/fundamentals-and-concepts/stellar-data-structures/assets).
An asset is displayed as an asset code and issuer address. Learn more in our [Assets section](../../learn/fundamentals/stellar-data-structures/assets.mdx).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Path Payment
sidebar_position: 50
---

A path payment is where the asset sent can be different from the asset received. There are two possible path payment operations: 1) `path_payment_strict_send`, which allows the user to specify the amount of the asset to send, and 2) `path_payment_strict_receive`, which allows the user to specify the amount of the asset received. Read more in the [Path Payments Encyclopedia Entry](../../encyclopedia/path-payments).
A path payment is where the asset sent can be different from the asset received. There are two possible path payment operations: 1) `path_payment_strict_send`, which allows the user to specify the amount of the asset to send, and 2) `path_payment_strict_receive`, which allows the user to specify the amount of the asset received. Read more in the [Path Payments Encyclopedia Entry](../../learn/encyclopedia/path-payments.mdx).

## User experience

Expand All @@ -17,7 +17,7 @@ The user will then preview the transaction, input their pincode, and select the

### The `/dashboard/send` page

Most of this page has been discussed in the [Payment section](./payment#the-dashboardsend-page). Below, we're highlighting the unique pieces that are added to BasicPay to allow for the path payment feature.
Most of this page has been discussed in the [Payment section](./payment.mdx#the-dashboardsend-page). Below, we're highlighting the unique pieces that are added to BasicPay to allow for the path payment feature.

```html title="/src/routes/dashboard/send/+page.svelte"
<script>
Expand Down
4 changes: 2 additions & 2 deletions docs/building-apps/example-application-tutorial/payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ In our BasicPay application, the user will navigate to the Payments page where c

The user clicks the "Confirm Transaction" button. If the destination account exists and is properly funded with XLM, this will trigger a Transaction Preview where they can view the transaction details.

All Stellar transactions require a small fee to make it to the ledger. Read more in our [Fees, Surge Pricing, and Fee Strategies section](../../encyclopedia/fees-surge-pricing-fee-strategies).
All Stellar transactions require a small fee to make it to the ledger. Read more in our [Fees, Surge Pricing, and Fee Strategies section](../../learn/encyclopedia/fees-surge-pricing-fee-strategies.mdx).

In BasicPay, we’ve set it up so that the user always pays a static fee of 100,000 [stroops](../../fundamentals-and-concepts/stellar-data-structures/assets#amount-precision) (one stroop equals 0.0000001 XLM) per operation. Alternatively, you can add a feature to your application that allows the user to set their own fee.
In BasicPay, we’ve set it up so that the user always pays a static fee of 100,000 [stroops](../../learn/fundamentals/stellar-data-structures/assets.mdx#amount-precision) (one stroop equals 0.0000001 XLM) per operation. Alternatively, you can add a feature to your application that allows the user to set their own fee.

![payment](/assets/fees.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/building-apps/wallet/sep30.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ var recoverableWallet = await recovery.createRecoverableWallet(
With the given parameters, this function will create a transaction that will:

1. Set `deviceKp` as the primary account key. Please note that the master key belonging to `accountKp` will be locked. `deviceKp` should be used as a primary signer instead.
2. Set all operation thresholds to 10. You can read more about threshold in the [documentation](https://developers.stellar.org/docs/encyclopedia/signatures-multisig#thresholds)
2. Set all operation thresholds to 10. You can read more about threshold in the [documentation](../../learn/encyclopedia/signatures-multisig.mdx#thresholds)
3. Use identities that were defined earlier on both servers. (That means, both server will accept SEP-10 authentication via `recoveryKp` as an auth method)
4. Set device key weight to 10, and recovery server weight to 5. Given these account thresholds, both servers must be used to recover the account, as transaction signed by one will only have weight of 5, which is not sufficient to change account key.

Expand Down
2 changes: 1 addition & 1 deletion docs/building-apps/wallet/stellar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ bool success = await stellar.submitTransaction(modifyAccountTransaction);

#### Sponsor Operations

Some operations, that modify account reserves can be [sponsored](https://developers.stellar.org/docs/encyclopedia/sponsored-reserves#sponsored-reserves-operations). For sponsored operations, the sponsoring account will be paying for the reserves instead of the account that being sponsored. This allows you to do some operations, even if account doesn't have enough funds to perform such operations. To sponsor a transaction, <LanguageSpecific kt={<span>simply start a <code>sponsoring</code> block:</span>} ts={<span>simply create a building function (describing which operations are to be sponsored) and pass it to the <code>sponsoring</code> method:</span>}/>
Some operations, that modify account reserves can be [sponsored](../../learn/encyclopedia/sponsored-reserves.mdx#sponsored-reserves-operations). For sponsored operations, the sponsoring account will be paying for the reserves instead of the account that being sponsored. This allows you to do some operations, even if account doesn't have enough funds to perform such operations. To sponsor a transaction, <LanguageSpecific kt={<span>simply start a <code>sponsoring</code> block:</span>} ts={<span>simply create a building function (describing which operations are to be sponsored) and pass it to the <code>sponsoring</code> method:</span>}/>

<CodeExample>

Expand Down
7 changes: 0 additions & 7 deletions docs/encyclopedia/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/fundamentals-and-concepts/_category_.json

This file was deleted.

This file was deleted.

Loading

0 comments on commit 52a10f9

Please sign in to comment.