Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Commit

Permalink
Phase 1 updates to Soroban docs (#747)
Browse files Browse the repository at this point in the history
* Adding Mainnet to Networks section

-Need help with Mainnet information for Horizon API, Validator, and History Archive
-Also getting errors when clicking on Testnet and Futurenet History Archive links

* Add Mainnet information to Block Explorers

* Add Releases section for Phase 1

* put in version numbers for (most) software

* add changelong for soroban rpc

* add changelog for soroban cli

* add mainnet passphrase to protocol 20 release notes

* try another title for this version

* remove unnecessary headings

* update Horizon link for Mainnet

* add resource limits and fees to releases page

* shifting some things around in resource limits for phase 1

* use `TBD` for soroban react version placeholders

* networks placeholders

* add validator and history urls for Mainnet

---------

Co-authored-by: Elliot Voris <[email protected]>
  • Loading branch information
briwylde08 and ElliotFriend authored Feb 27, 2024
1 parent 4dcc806 commit 53ed8bf
Show file tree
Hide file tree
Showing 4 changed files with 169 additions and 102 deletions.
14 changes: 7 additions & 7 deletions docs/reference/data-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ To power your applications, a range of data services will be available from data

## Block Explorers

Block explorers exist to publicly display blockchain data in an easily digestbible way. They can be browsed with an ordinary web browser, and do not require any special developer skills to use. The block explorers available for Soroban index data related to payments, accounts, deployed contracts, transaction history, and more. The following block explorers are available for the Testnet and Futurenet (Mainnet coming with launch).
Block explorers exist to publicly display blockchain data in an easily digestbible way. They can be browsed with an ordinary web browser, and do not require any special developer skills to use. The block explorers available for Soroban index data related to payments, accounts, deployed contracts, transaction history, and more. The following block explorers are available for Mainnet, Testnet, and Futurenet.

| Provider | Testnet | Futurenet |
| :----------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------- |
| [StellarExpert](https://stellar.expert) | [Testnet Explorer](https://stellar.expert/explorer/testnet) | n/a |
| [StellarChain](https://stellarchain.io/) | [Testnet Explorer](https://testnet.stellarchain.io/) | [Futurenet Explorer](https://futurenet.stellarchain.io/) |
| [Soroban Scan](https://soroban.nownodes.io/info) | [Testnet Explorer](https://soroban.nownodes.io/testnet) | [Futurenet Explorer](https://soroban.nownodes.io/) |
| [StellarExplorer](https://steexp.com/) | [Testnet Explorer](https://testnet.steexp.com/) | [Futurenet Explorer](https://futurenet.steexp.com/) |
| Provider | Mainnet | Testnet | Futurenet |
| :----------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------- |
| [StellarExpert](https://stellar.expert) | [Mainnet Explorer](https://stellar.expert/explorer/public) | [Testnet Explorer](https://stellar.expert/explorer/testnet) | N/A |
| [StellarChain](https://stellarchain.io/) | [Mainnet Explorer](https://stellarchain.io/) | [Testnet Explorer](https://testnet.stellarchain.io/) | [Futurenet Explorer](https://futurenet.stellarchain.io/) |
| [Soroban Scan](https://soroban.nownodes.io/info) | N/A | [Testnet Explorer](https://soroban.nownodes.io/testnet) | [Futurenet Explorer](https://soroban.nownodes.io/) |
| [StellarExplorer](https://steexp.com/) | [Mainnet Explorer](https://steexp.com/) | [Testnet Explorer](https://testnet.steexp.com/) | [Futurenet Explorer](https://futurenet.steexp.com/) |
18 changes: 9 additions & 9 deletions docs/reference/networks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ title: Networks
description: The shared Soroban test networks.
---

Testnet and Futurenet have been made available as the first shared test networks to enable developers to learn, tinker, and build applications on Soroban while being able to interact with other participants.
Read more about the different networks in the [Networks section](https://developers.stellar.org/docs/fundamentals-and-concepts/networks) in the Stellar docs.

| Testnet | Testnet | Futurenet |
| :----------------- | ----------------------------------- | ---------------------------------------- |
| Network Passphrase | `Test SDF Network ; September 2015` | `Test SDF Future Network ; October 2022` |
| Horizon API | https://horizon-testnet.stellar.org | https://horizon-futurenet.stellar.org |
| Friendbot API | https://friendbot.stellar.org | https://friendbot-futurenet.stellar.org |
| Validator | `core-live-testnet.stellar.org` | `core-live-futurenet.stellar.org` |
| History Archive | https://history-testnet.stellar.org | https://history-futurenet.stellar.org |
| | Mainnet | Testnet | Futurenet |
| :----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------- |
| Network Passphrase | `Public Global Stellar Network ; September 2015` | `Test SDF Network ; September 2015` | `Test SDF Future Network ; October 2022` |
| Horizon API | https://horizon.stellar.org/ | https://horizon-testnet.stellar.org | https://horizon-futurenet.stellar.org |
| Friendbot API | N/A | https://friendbot.stellar.org | https://friendbot-futurenet.stellar.org |
| Validator | `core-live-a.stellar.org` `core-live-b.stellar.org` `core-live-c.stellar.org` | `core-live-testnet.stellar.org` | `core-live-futurenet.stellar.org` |
| History Archive | http://history.stellar.org/prd/core-live/core_live_001/ http://history.stellar.org/prd/core-live/core_live_002/ http://history.stellar.org/prd/core-live/core_live_003/ | https://history-testnet.stellar.org | https://history-futurenet.stellar.org |

:::caution

Testnet can be reset at any time. A reset erases all accounts, contract data, and contract deployments from the network.
Testnet and Futurenet can be reset at any time. A reset erases all accounts, contract data, and contract deployments from the network.

:::

Expand Down
52 changes: 26 additions & 26 deletions docs/reference/resource-limits-fees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Resource Limits & Fees

Soroban introduces smart contracts, marking the most transformative upgrade to the Stellar network to date. To maintain network performance, the ecosystem has decided to upgrade the network in a phased approach where network capacity is increased gradually over time. See [this blog post](https://stellar.org/blog/developers/the-stellar-network-s-phased-rollout-of-smart-contracts-the-road-to-mainnet) for more details and [discord](https://discord.com/invite/zVYdY3ktTn) for current status.

| Network Setting | Phase 0 (current) | Phase 1 |
| Network Setting | Phase 0 | Phase 1 (current) |
| :------------------------------------------------- | :----------------------------------------- | :----------------------------------------------------------------------------------------------------- |
| Soroban Txn per ledger | 1 | 100 |
| Max CPU Instructions per Txn | 2.5 million (2M instructions for max Wasm) | 100 million (VM instantiation consumes up to 23M for a 64KB Wasm, and 46M for multiple Wasms of 130KB) |
Expand All @@ -27,30 +27,7 @@ Note, that write fees grow linearly from empty ledger to ledger "target size", a

The ledger rent cost ('Write 1KB' entries in the table) is based on the write fee, rent period and some coefficient. For the temporary storage, the coefficient is 10 months (in ledgers), thus 1 month of temporary entry rent is 1/10 of the rent fee. For persistent storage the coefficient is 1 month (in ledgers) and thus 1 month of rent is equivalent to the write fee.

### Phase 0 (current)

Phase 0 is meant for network operators to observe and ensure network stability. While you may be able to deploy simple contracts, Mainnet in Phase 0 is not designed for contract development or deployment. Testnet is better suited for this purpose.

| Network Setting | Phase 0 Cost (stroops) |
| :-------------------------------------------- | :---------------------- |
| 10,000 instructions | 100 (1,000,000/tx) |
| Read 1 ledger entry | 1,000 (20,000/tx) |
| Write 1 ledger entry | 3,000 (30,000/tx) |
| Read 1KB from ledger | 1,000 (127,000/tx) |
| 1KB of transaction (bandwidth) | 500 (34,000/tx) |
| 1KB of transaction (history) | 5,000 (340,000/tx) |
| 1KB of Events/return value | 300 (1,500/tx) |
| “Target” ledger size | 14.5 GB |
| Fee multiplier after reaching the target size | 1,000 |
| Write 1KB to ledger (empty) | 1,000 |
| Write 1KB to ledger (current, 12 GB) | 0.356 XLM (17.4 XLM/tx) |
| Write 1KB to ledger (target, 14 GB) | 0.4 XLM (2.26 XLM/tx) |
| Temp entry rent period | 10 months |
| Persistent entry rent period | 1 month |
| 1 KB of temp storage per month | 400,000 |
| 1 KB of persistent storage per month | 4,000,000 |

### Phase 1
### Phase 1 (current) {#phase-1}

Phase 1 is meant for network operators to monitor network performance under use. While you'll be able to deploy contracts, Mainnet in Phase 1 has limited throughput. You should not expect more than 1 smart contract transaction per ledger. You can expect throughput to be gradually increased based on network performance and user (your) feedback. See [this blog post](https://stellar.org/blog/developers/the-stellar-network-s-phased-rollout-of-smart-contracts-the-road-to-mainnet) for more details and share your feedback in [discord](https://discord.com/invite/zVYdY3ktTn).

Expand All @@ -73,7 +50,7 @@ Phase 1 is meant for network operators to monitor network performance under use.
| Minimum persistent entry TTL, ledgers | 2,073,600 (120 days) |
| Minimum temp entry TTL, ledgers | 17,280 (~1 day) |

## Phase 1 Examples
#### Phase 1 Examples

Here are some examples to put things in perspective (the fees are computed at "current" ledger size and would grow as ledger size increases):

Expand All @@ -86,3 +63,26 @@ Here are some examples to put things in perspective (the fees are computed at "c
| Create 100 byte contract data entry, e.g. user balance (includes 120 day rent payment) | 0.17 XLM |
| 1 year of 100 byte storage rent | 0.512 XLM |
| Modify 100 byte contract data entry without increasing the size | 1150 stroops |

### Phase 0

Phase 0 is meant for network operators to observe and ensure network stability. While you may be able to deploy simple contracts, Mainnet in Phase 0 is not designed for contract development or deployment. Testnet is better suited for this purpose.

| Network Setting | Phase 0 Cost (stroops) |
| :-------------------------------------------- | :---------------------- |
| 10,000 instructions | 100 (1,000,000/tx) |
| Read 1 ledger entry | 1,000 (20,000/tx) |
| Write 1 ledger entry | 3,000 (30,000/tx) |
| Read 1KB from ledger | 1,000 (127,000/tx) |
| 1KB of transaction (bandwidth) | 500 (34,000/tx) |
| 1KB of transaction (history) | 5,000 (340,000/tx) |
| 1KB of Events/return value | 300 (1,500/tx) |
| “Target” ledger size | 14.5 GB |
| Fee multiplier after reaching the target size | 1,000 |
| Write 1KB to ledger (empty) | 1,000 |
| Write 1KB to ledger (current, 12 GB) | 0.356 XLM (17.4 XLM/tx) |
| Write 1KB to ledger (target, 14 GB) | 0.4 XLM (2.26 XLM/tx) |
| Temp entry rent period | 10 months |
| Persistent entry rent period | 1 month |
| 1 KB of temp storage per month | 400,000 |
| 1 KB of persistent storage per month | 4,000,000 |
Loading

0 comments on commit 53ed8bf

Please sign in to comment.