Skip to content

Commit

Permalink
Rename reference section to networks (#789)
Browse files Browse the repository at this point in the history
* Rename reference section to networks

* fixes

* fix

* fix

* fix

* fix

* fixes
  • Loading branch information
leighmcculloch authored Jul 23, 2024
1 parent 9183560 commit 23d3d3e
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 20 deletions.
4 changes: 2 additions & 2 deletions docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Discover various data availability options: RPC, Hubble, and Horizon.

Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform.

### [Reference](/docs/reference/networks.mdx)
### [Networks](/docs/networks/README.mdx)

A quick look at useful information such as the various network data (for Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees.
Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees.

### [Validators](/docs/validators/README.mdx)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/guides/archival/test-ttl-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ env.ledger().with_mut(|li| {
});
```

You could also use the current [network settings](../../../reference/resource-limits-fees.mdx#resource-fees) when setting up the tests, but keep in mind that these are subject to change, and the contract should be able to work with any values of these settings.
You could also use the current [network settings](../../../networks/resource-limits-fees.mdx#resource-fees) when setting up the tests, but keep in mind that these are subject to change, and the contract should be able to work with any values of these settings.

Now we run a test scenario that verifies the TTL extension logic (see [`test_extend_ttl_behavior`](https://github.com/stellar/soroban-examples/blob/f595fb5df06058ec0b9b829e9e4d0fe0513e0aa8/ttl/src/test.rs#L38) test for the full scenario). First, we setup the data and ensure that the initial TTL values correspond to the network settings we've defined above:

Expand Down
4 changes: 2 additions & 2 deletions docs/data/rpc/admin-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ stellar contract invoke \

When you're done with your Standalone node, you can close it with <kbd>ctrl</kbd><kbd>c</kbd> (not <kbd>cmd</kbd>). This will fully remove the container (that's what the `--rm` option to the `docker` command does), which means you will need to re-deploy your contract and re-fund your identity the next time you start it. If you work with local nodes often, you may want to create scripts to make these initialization steps easier. For example, see the [example dapp's `initialize.sh`](https://github.com/stellar/soroban-example-dapp/blob/abdac3afdb6c410cc426831ece93371c1a27347d/initialize.sh).

[Testnet]: ../../reference/networks.mdx
[Testnet]: ../../networks/README.mdx

### Testnet

Expand Down Expand Up @@ -194,7 +194,7 @@ helm install my-rpc stellar/soroban-rpc \

This example of Helm chart usage highlights some key aspects:

- Set the `global.image.sorobanRpc.tag` to a tag from the [soroban-rpc dockerhub repo](https://hub.docker.com/r/stellar/soroban-rpc) for the image version you want to run. Refer to [the software versions page](/docs/reference/software-versions) to find the correct tag for the Soroban release you are running.
- Set the `global.image.sorobanRpc.tag` to a tag from the [soroban-rpc dockerhub repo](https://hub.docker.com/r/stellar/soroban-rpc) for the image version you want to run. Refer to [the software versions page](/docs/networks/software-versions) to find the correct tag for the Soroban release you are running.

- The RPC server stores a revolving window of recent data from network ledgers to disk. The size of that data varies depending on the network and its transaction volumes, but it has an estimated range between 10 to 100 MB. To ensure the RPC pod has consistent access to disk storage space and read/write throughput, this example demonstrates how to optionally enable the Helm chart deployment to use a `PersistentVolumeClaim` (PVC) of 100MB from `default` storage class on Kubernetes by enabling these persistence parameters:

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/encyclopedia/storage/persisting-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ In addition to the types of state, it is also helpful to consider the type of co
### Best Practices

- Prefer `Temporary` over `Persistent` and `Instance` storage
- Anything that can have a timeout should be `Temporary` with TTL set to the timeout. See the [resource limits table](../../../reference/resource-limits-fees.mdx) for the current maximum TTL/timeout.
- Anything that can have a timeout should be `Temporary` with TTL set to the timeout. See the [resource limits table](../../../networks/resource-limits-fees.mdx) for the current maximum TTL/timeout.
- Ideally, `Temporary` entries should be associated with an absolute ledger boundary and thus never need a TTL extension
- Example: Soroban Auth signatures have an absolute expiration ledger, so nonces can be stored in `Temporary` entries without security risks
- Example: SAC allowance that lives only until a given ledger (so that some old allowance signature can not be used in the future if not exhausted)
Expand Down
4 changes: 2 additions & 2 deletions docs/learn/encyclopedia/storage/state-archival.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ An entry's Time To Live (TTL) is defined as how many ledgers remain until the en

For each entry type, there is a minimum TTL that the entry will have when being created or restored. This TTL minimum is enforced automatically at the protocol level.

Minimum TTL is a network parameter. Refer to the [resource reference](../../../reference/resource-limits-fees.mdx) to find the current values.
Minimum TTL is a network parameter. Refer to the [resource reference](../../../networks/resource-limits-fees.mdx) to find the current values.

### Maximum TTL

On any given ledger, an entry's TTL can be extended up to the maximum TTL. This is a network parameter (see the [resource limits table](../../../reference/resource-limits-fees.mdx) for the current maximum TTL). Maximum TTL is not enforced based on when an entry was created, but based on the current ledger. For example, if an entry is created on January 1st, 2024, its TTL could initially be extended up to January 1st, 2025. After this initial TTL extension, if the entry received another TTL extension later on January 10th, 2024, the TTL could be extended up to January 10th, 2025. The `max_ttl()` function can be used to determine the current maximum allowed TTL.
On any given ledger, an entry's TTL can be extended up to the maximum TTL. This is a network parameter (see the [resource limits table](../../../networks/resource-limits-fees.mdx) for the current maximum TTL). Maximum TTL is not enforced based on when an entry was created, but based on the current ledger. For example, if an entry is created on January 1st, 2024, its TTL could initially be extended up to January 1st, 2025. After this initial TTL extension, if the entry received another TTL extension later on January 10th, 2024, the TTL could be extended up to January 10th, 2025. The `max_ttl()` function can be used to determine the current maximum allowed TTL.

## Operations

Expand Down
6 changes: 3 additions & 3 deletions docs/learn/fundamentals/fees-resource-limits-metering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ All smart contract transactions require a resource fee in addition to an inclusi

![Soroban Fees](/assets/soroban_fees.png) _\* Diagram: Solid line boxes are what is actually present in the transaction, while dotted lines are derivable._

Smart contracts on Stellar use a multidimensional resource fee model that charges fees for several resource types using [network-defined rates](../../reference/resource-limits-fees.mdx). The resource fee is calculated based on the resource consumption declared in the transaction and can fluctuate based on a mutable storage write fee (more on that in the [Storage Dynamic Pricing section](#dynamic-pricing-for-storage) below). If the transaction attempts to exceed the declared resource limits, it will fail. If the transaction uses fewer resources than declared, there will be no refunds [(with a couple of exceptions)](#refundable-and-non-refundable-resource-fees).
Smart contracts on Stellar use a multidimensional resource fee model that charges fees for several resource types using [network-defined rates](../../networks/resource-limits-fees.mdx). The resource fee is calculated based on the resource consumption declared in the transaction and can fluctuate based on a mutable storage write fee (more on that in the [Storage Dynamic Pricing section](#dynamic-pricing-for-storage) below). If the transaction attempts to exceed the declared resource limits, it will fail. If the transaction uses fewer resources than declared, there will be no refunds [(with a couple of exceptions)](#refundable-and-non-refundable-resource-fees).

The resource fee depends on the following resources:

Expand All @@ -46,7 +46,7 @@ Some parameters may contribute to multiple fee components. For example, the tran

The implementation details for fee computation are provided by the following [library](https://github.com/stellar/rs-soroban-env/blob/main/soroban-env-host/src/fees.rs). This library is used by the protocol to compute the fees and thus can be considered canonical. The resource fee rates may be updated based on consensus from the network validators.

Find current resource fees in the [Resource Limits & Fees](../../reference/resource-limits-fees.mdx) page in the Reference section.
Find current resource fees in the [Resource Limits & Fees](../../networks/resource-limits-fees.mdx) page in the Networks section.

### Refundable and non-refundable resource fees

Expand All @@ -72,7 +72,7 @@ Stellar’s ledger close time is constrained to a few seconds, preventing the ex

Resource limits are determined by a validator vote and can be adjusted based on network usage and ecosystem needs with a validator consensus.

Find current resource limits in the [Resource Limits & Fees](../../reference/resource-limits-fees.mdx) page in the Reference section.
Find current resource limits in the [Resource Limits & Fees](../../networks/resource-limits-fees.mdx) page in the Networks section.

## Inclusion fee

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Release candidates are software releases that are also released to the [Testnet]

:::

[testnet]: ./networks.mdx
[testnet]: ./README.mdx

## Protocol 21 (Mainnet, June 18, 2024)

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ const config: Config = {
},
{
type: 'docSidebar',
sidebarId: 'reference',
label: 'Reference',
sidebarId: 'networks',
label: 'Networks',
position: 'left',
},
{
Expand Down
5 changes: 3 additions & 2 deletions nginx/includes/redirects.conf
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ rewrite ^/docs/learn/smart-contract-internals/high-level-overview(.*)$ "/docs/le
rewrite ^/docs/smart-contracts/tokens/token-interface.mdx$ "/docs/tokens/token-interface" permanent;
rewrite ^/network/anchor-platformanchor$ "/platforms/anchor-platform" permanent;
rewrite ^/docs/examples/auth$ "/docs/build/smart-contracts/example-contracts/auth" permanent;
rewrite ^/docs/reference$ "/docs/reference/networks" permanent;
rewrite ^/docs/reference/futurenet$ "/docs/reference/networks" permanent;
rewrite ^/docs/reference$ "/docs/networks" permanent;
rewrite ^/docs/reference/futurenet$ "/docs/networks" permanent;
rewrite ^/docs/reference/(.*)$ "/docs/networks/$1" permanent;
rewrite ^/docs/SDKs/rust-auth$ "/docs/tools/sdks/library#soroban-rust-sdk" permanent;
rewrite ^/docs/category/cross-border-payments$ "/platforms/anchor-platform/admin-guide/sep31" permanent;
rewrite ^/docs/category/hosted-deposits-and-withdrawals$ "/platforms/anchor-platform/admin-guide/sep24" permanent;
Expand Down
4 changes: 2 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ const sidebars: SidebarsConfig = {
{ type: 'link', href: '/platforms/anchor-platform', label: 'Anchor Platform'},
{ type: 'link', href: '/platforms/stellar-disbursement-platform', label: 'Stellar Disbursement Platform'},
],
reference: [
networks: [
{
type: 'autogenerated',
dirName: 'reference',
dirName: 'networks',
},
],
validators: [
Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Discover various data availability options: RPC, Hubble, and Horizon.

Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform.

### [Reference](/docs/reference/networks)
### [Networks](/docs/networks)

A quick look at useful information such as the various network data (for Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees.
Information about delpoyed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees.

### [Validators](/docs/validators)

Expand Down

0 comments on commit 23d3d3e

Please sign in to comment.