Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
module.exports = {
...require("@stellar/prettier-config"),
// This is mostly content, and prose wrap has a way of exploding markdown
// diffs. Override the default for a better experience.
overrides: [
{
files: "*.mdx",
options: {
proseWrap: "never",
proseWrap: "never", // Minimize `mdx` diffs with simpler content lines
},
},
],
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As seen above, all contract data is automatically archived when TTL reaches `0`,

Both types `Instance` and `Persistent` are suitable for storing data that cannot be easily recreated, with the nuance that `Instance` shares the same TTL as the contract instance while `Persistent` does not and, if the contract instance is not archived, `Persistent` data may be archived and need to be restored before invoking the contract.

For a detailed explanation of contract data archival, check out the [State Archival section](./../../../learn/fundamentals/contract-development/storage/state-archival.mdx) in the Encyclopedia.
For a detailed explanation of contract data archival, check out the [State Archival section](./../../../learn/fundamentals/contract-development/storage/state-archival.mdx).

```typescript
import {
Expand Down
2 changes: 1 addition & 1 deletion docs/build/guides/transactions/path-payments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Account A sells XLM → [buy XLM / sell ETH → buy ETH / sell BTC → buy BTC /

It is possible for path payments to fail if there are no viable exchange paths.

For more information on the Stellar Decentralized Exchange and Liquidity Pools, see our [Liquidity on Stellar: SDEX and Liquidity Pools Encyclopedia Entry](../../../learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx).
For more information on the Stellar Decentralized Exchange and Liquidity Pools, see the [Liquidity on Stellar section](../../../learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx).

## Operations

Expand Down
2 changes: 1 addition & 1 deletion docs/build/guides/transactions/sponsored-reserves.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To learn more about minimum balance requirements, see our section on [Lumens](..

All claimable balances are sponsored through built-in logic in the claimable balance operations. The account that creates the claimable balance pays the base reserve to get the claimable balance on the ledger. When the claimable balance is claimed by the claimant(s), the claimable balance is removed from the ledger, and the account that created it gets the base reserve back.

Read more about claimable balances in our [Claimable Balances Encyclopedia Entry](./claimable-balances.mdx).
Read more about claimable balances in our [Claimable Balances guide](./claimable-balances.mdx).

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/fundamentals/lumens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For example, an account with one trustline, two offers, and a claimable balance

2 base reserves (1 XLM) + 3 subentries/base reserves (1.5 XLM) + 1 ledger entry/base reserve (1 XLM) = 3.5 XLM

When you close a subentry, the associated base reserve will be added to your available balance. An account must always pay its own minimum balance unless a subentry is being sponsored by another account. For information about this, see our [Sponsored Reserves Encyclopedia Entry](../../build/guides/transactions/sponsored-reserves.mdx).
When you close a subentry, the associated base reserve will be added to your available balance. An account must always pay its own minimum balance unless a subentry is being sponsored by another account. For information about this, see our [Sponsored Reserves guide](../../build/guides/transactions/sponsored-reserves.mdx).

## Rent

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ Account data is stored in subentries, each of which increases an account’s min

Trustlines are an explicit opt-in for an account to hold a particular asset. To hold a specific asset, an account must establish a trustline with the issuing account using the [`change_trust` operation](../transactions/list-of-operations.mdx#change-trust). Trustlines track the balance of an asset and can also limit the amount of an asset that an account can hold.

A trustline must be established for an account to receive any asset except lumens (XLM). You can create a claimable balance to send assets to an account without a trustline, but the recipient has to create a trustline to claim that balance. Learn more here: [Claimable Balances Encyclopedia Entry](../../../build/guides/transactions/claimable-balances.mdx)
A trustline must be established for an account to receive any asset except lumens (XLM). You can create a claimable balance to send assets to an account without a trustline, but the recipient has to create a trustline to claim that balance. Learn more in the [Claimable Balances guide](../../../build/guides/transactions/claimable-balances.mdx).

A trustline also tracks liabilities. Buying liabilities equal the total amount of the asset offered to buy aggregated over all offers owned by an account, and selling liabilities equal the total amount of the asset offered to sell aggregated over all offers owned by an account. A trustline must always have a balance sufficiently large to satisfy its selling liabilities and a balance sufficiently below its limit to accommodate its buying liabilities.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Operations are individual commands that modify the ledger. Operations are used t

All operations fall into one of three threshold categories: low, medium, or high, and each threshold category has a weight between 0 and 255 (which can be determined using set_options). Thresholds determine what signature weight is required for the operation to be accepted. For example, let’s say an account sets the medium threshold weight to 5. If the account wants to successfully establish a trustline with the `changeTrust` operation, the weight of the signature(s) must be greater than or equal to 5.

To learn more about signature weight, see the [Signature and Multisignature Encyclopedia Entry](../../fundamentals/transactions/signatures-multisig.mdx).
To learn more about signature weight, see the [Signatures and Multisig section](../../fundamentals/transactions/signatures-multisig.mdx).

View a comprehensive list of Stellar operations and their threshold levels in the [List of Operations section](./list-of-operations.mdx).

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The public key used to create an account. This key persists across different key

The on and off-ramps on the Stellar network that facilitate one-to-one conversion of off-chain representations to and from tokenized assets, for example, digital tokens representing bank deposits.

Read more in the [Anchor Encyclopedia entry](./fundamentals/anchors.mdx)
Read more in the [Anchors section](./fundamentals/anchors.mdx).

### Application (app)

Expand Down Expand Up @@ -285,7 +285,7 @@ Learn more in our [SEPs section](./fundamentals/stellar-ecosystem-proposals.mdx)

Refers to the master key or to any other signing keys added later. A signer is defined as the pair: public key + weight. Signers can be set with the Set Options operation.

See our [Signature and Multisignature Encyclopedia Entry](./fundamentals/transactions/signatures-multisig.mdx) for more information.
See our [Signatures and Multisig section](./fundamentals/transactions/signatures-multisig.mdx) for more information.

### Smart contract

Expand Down
4 changes: 2 additions & 2 deletions docs/tokens/control-asset-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Using a distribution account is better for auditing because an issuing account c

One thing you must decide when issuing an asset is what to call it. An asset code is the asset’s identifying code. There are three possible formats: Alphanumeric 4, Alphanumeric 12, and liquidity pool shares.

Learn about liquidity pool shares in the [Liquidity Pool Encyclopedia Entry](../learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx).
Learn about liquidity pool shares in the [Liquidity on Stellar section](../learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx).

- Alphanumeric 4-character maximum: Any characters from the set a-z, A-Z, 0-9 are allowed. The code can be shorter than 4 characters, but the trailing characters must all be empty.
- Alphanumeric 12-character maximum: Any characters from the set a-z, A-Z, 0-9 are allowed. The code can be any number of characters from 5 to 12, but the trailing characters must all be empty.
Expand Down Expand Up @@ -221,6 +221,6 @@ This section details how to lock your account with the purpose of limiting the s

With that warning in mind, it is possible to lock down the issuing account of an asset so that the asset’s supply cannot increase. To do this, first set the issuing account’s master weight to 0 using the Set Options operation. This prevents the issuing account from being able to sign transactions and therefore, making the issuer unable to issue any more assets. Be sure to do this only after you’ve issued all desired assets to the distribution account. If the asset has a Stellar Asset Contract, also make sure the admin for the contract was not updated from the default (which is the issuer) using the `set_admin` contract call. If the admin was not the issuer, then the admin would be able to mint the asset even with the issuing account locked.

Learn more about signature weights in the [Signature and Multisig Encyclopedia Entry](../learn/fundamentals/transactions/signatures-multisig.mdx).
Learn more about signature weights in the [Signatures and Multisig section](../learn/fundamentals/transactions/signatures-multisig.mdx).

See how to do this in the optional steps of the [Issuing an Asset Tutorial](./how-to-issue-an-asset.mdx#configure-maximum-supply).
2 changes: 1 addition & 1 deletion docs/tokens/how-to-issue-an-asset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Accounts must establish a [trustline](../learn/fundamentals/stellar-data-structu

:::note

If you’d like to avoid your users having to deal with trustlines or XLM, consider using sponsored reserves. Read more in our [Sponsored Reserves Encyclopedia Entry](../build/guides/transactions/sponsored-reserves.mdx).
If you’d like to avoid your users having to deal with trustlines or XLM, consider using sponsored reserves. Read more in our [Sponsored Reserves guide](../build/guides/transactions/sponsored-reserves.mdx).

:::

Expand Down
Loading