Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Refresh six classic guides #723

Draft
wants to merge 46 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
a125983
🔁 Channel accounts: explain resolutions
JFWooten4 Jun 20, 2024
01424db
🔁 Channel accounts: simplify narrative
JFWooten4 Jun 22, 2024
37e38c3
🔁 Channel accounts: specify cards
JFWooten4 Jun 23, 2024
9ed2a0a
🔁 Channel accounts: finalize visuals
JFWooten4 Jun 23, 2024
44309a2
🔁 Channel accounts: simplify narrative
JFWooten4 Jun 26, 2024
dd7d761
🔁 Channel accounts: expand details
JFWooten4 Jun 26, 2024
c4a46dc
Merge branch 'stellar:main' into refresh-classic-guides
JFWooten4 Jul 5, 2024
68f165d
🔁 Channel accounts: hyperlinks, context
JFWooten4 Jul 7, 2024
07e613a
🔁 Channel accounts: initial diagrams
JFWooten4 Jul 9, 2024
bf6e15f
🔁 Channel accounts: reference configuration
JFWooten4 Jul 9, 2024
15d1288
🔁 Channel accounts: KaTeX formatting
JFWooten4 Jul 10, 2024
b874bc7
🔁 Channel accounts: context, links
JFWooten4 Jul 10, 2024
e290fb3
🔁 Channel accounts: conceptual images
JFWooten4 Jul 12, 2024
1f8a904
🔁 Channel accounts: simplify image
JFWooten4 Jul 12, 2024
46f49c6
🔁 Channel accounts: prioritize readability
JFWooten4 Jul 14, 2024
3f2e731
🔁 Channel accounts: overload example
JFWooten4 Jul 14, 2024
8a3d963
🔁 Channel accounts: configuration example
JFWooten4 Jul 15, 2024
cd7f447
🫴🏽 Claimable balances: first example
JFWooten4 Jul 18, 2024
e2248db
🫴🏽 Claimable balances: second example
JFWooten4 Jul 29, 2024
1992240
🫴🏽 Claimable balances: third example
JFWooten4 Jul 29, 2024
ee6175a
🫴🏽 Claimable balances: expand precomputation
JFWooten4 Aug 2, 2024
95ffe3c
🔎 Refresh: asset design considerations
JFWooten4 Aug 5, 2024
d93ae63
🦞 Clawbacks: confer readable diction
JFWooten4 Aug 5, 2024
e1611fc
🦞 Clawbacks: minor example diction
JFWooten4 Aug 5, 2024
03ac66d
🦞 Clawbacks: format account names
JFWooten4 Aug 5, 2024
86f3ca8
🦞 Clawbacks: format more names
JFWooten4 Aug 5, 2024
d1a9252
🦞 Clawbacks: apply name diction
JFWooten4 Aug 5, 2024
eb0e9be
🦞 Clawbacks: translate preamble example
JFWooten4 Aug 6, 2024
f4ad468
🦞 Clawbacks: expand example one
JFWooten4 Aug 6, 2024
e72e4a8
🦞 Clawbacks: translate next instances
JFWooten4 Aug 6, 2024
09fa456
🦞 Clawbacks: continue example dev
JFWooten4 Aug 6, 2024
b3e3230
💱 Trading examples: add lumenaut
JFWooten4 Aug 8, 2024
ee66e13
⏬ Prep for GH sync
JFWooten4 Aug 12, 2024
364f656
Merge remote-tracking branch 'upstream/main' into refresh-classic-guides
JFWooten4 Aug 12, 2024
6e866b7
Merge remote-tracking branch 'upstream/main' into refresh-classic-guides
JFWooten4 Aug 21, 2024
080ec03
💱 Trading examples: clarify narrative
JFWooten4 Sep 13, 2024
b529869
💱 Trading examples: contextualize sources
JFWooten4 Sep 13, 2024
127142e
↕️ Merge branch with self
JFWooten4 Sep 13, 2024
fea178f
🙌 Missed a reference link
JFWooten4 Sep 13, 2024
1a12877
💱 Trading examples: sell offers
JFWooten4 Sep 16, 2024
550b941
💱 Trading examples: level two
JFWooten4 Sep 16, 2024
fff2713
💱 Trading examples: time & sales
JFWooten4 Sep 16, 2024
06d249d
Merge remote-tracking branch 'upstream/main' into refresh-classic-guides
JFWooten4 Sep 30, 2024
4658706
🔁 Sync, move work items
JFWooten4 Sep 30, 2024
760d423
🔁 Clarify channel context links
JFWooten4 Oct 1, 2024
3d30353
🔁 Further advance text flow
JFWooten4 Oct 4, 2024
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: retrieve-an-order-book
title: "Retrieve an Order Book"
description: "The order book endpoint provides an order book's bids and asks and can be used in [streaming](https://developers.stellar.org/docs/data/horizon/api-reference/structure/streaming) mode."
description: "The order book endpoint provides an order book's bids and asks and can be used in streaming mode."
sidebar_label: "Retrieve an Order Book"
hide_title: true
hide_table_of_contents: true
Expand Down

Large diffs are not rendered by default.

871 changes: 838 additions & 33 deletions docs/learn/encyclopedia/transactions-specialized/channel-accounts.mdx

Large diffs are not rendered by default.

609 changes: 383 additions & 226 deletions docs/learn/encyclopedia/transactions-specialized/claimable-balances.mdx

Large diffs are not rendered by default.

914 changes: 841 additions & 73 deletions docs/learn/encyclopedia/transactions-specialized/clawbacks.mdx

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions docs/learn/fundamentals/stellar-data-structures/accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,13 @@ A base reserve is a unit of measurement used to calculate an account’s minimum

Account data is stored in subentries, each of which increases an account’s minimum balance by one base reserve (0.5 XLM). An account cannot have more than 1,000 subentries. Possible subentries are:

- Trustlines (includes traditional assets and pool shares)
- Trustlines
- Includes traditional assets and pool shares
- Offers
- Additional signers
- Data entries (includes data made with the `manageData` operation, not smart contract ledger entries)
- Data entries
- Includes data made with the `manageData` operation
- Does not include smart contract ledger entries

## Trustlines

Expand Down
14 changes: 11 additions & 3 deletions docs/learn/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Fiat, physical, or other tokens of value that are tracked, held, or transferred

See the [Assets section](./fundamentals/stellar-data-structures/assets.mdx) to learn more.

### Atomic Swap

An atomic swap is a decentralized method of exchanging one asset for another without the need for a trusted third-party intermediary. The process ensures that the interchange will either be completed fully by both parties or not at all—hence the term “atomic,” meaning indivisible. If one party fails to fulfill the required conditions, the trade is automatically canceled, and both parties retain their assets.

### Balance

The amount of a given asset an account holds. Each asset has its own balance and these balances are stored in trustlines for every asset except XLM, which is held directly by the account.
Expand Down Expand Up @@ -87,7 +91,7 @@ A payment that automatically handles the conversion of dissimilar assets.

### Decentralized exchange

A distributed exchange that allows the trading and conversion of assets on the network.
A distributed exchange that allows the trading and conversion of assets on the network through atomic swaps.

Learn more in our [Liquidity on Stellar](./encyclopedia/sdex/liquidity-on-stellar-sdex-liquidity-pools.mdx#sdex) Encyclopedia Entry.

Expand Down Expand Up @@ -263,12 +267,16 @@ The smart contract platform on the Stellar network. The name "Soroban" comes fro

### Source account

The account that originates a transaction. This account also provides the fee and sequence number for the transaction.
The account from which assets are consumed.

### Starlight

Stellar’s layer 2 protocol that allows for bi-directional payment channels.

See the [initial release](https://github.com/stellar-deprecated/starlight), [design considerations](https://youtu.be/LI_M6rWPCgQ), and [implimentation details](https://stellar.org/blog/developers/starlight-a-layer-2-payment-channel-protocol-for-stellar).

Starlight relies on [CAP-21](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0021.md) and [CAP-40](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0040.md), both of which were introduced in [Protocol 19](https://stellar.org/blog/developers/protocol-19-upgrade-guide).

### Stellar

A decentralized, federated peer-to-peer network that allows people to send payments in any asset anywhere in the world instantaneously, and with minimal fees.
Expand Down Expand Up @@ -325,7 +333,7 @@ Read more in the [Operations and Transactions section](./fundamentals/transactio

### Transaction envelope

A wrapper for a transaction that carries signatures.
A transaction plus its signature(s) is called a transaction envelope.

### Transaction fee

Expand Down
177 changes: 116 additions & 61 deletions docs/tokens/control-asset-access.mdx

Large diffs are not rendered by default.

34 changes: 34 additions & 0 deletions src/components/YouTube.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react';
import PropTypes from 'prop-types';

const YouTube = ({ ID }) => (
<div style={{
position: "relative",
width: "100%",
paddingBottom: "56.25%", // Make 16 x 9
height: 0,
marginBottom: "23px"
}}>
<iframe
src={`https://www.youtube-nocookie.com/embed/${ID}?controls=0`}
title="Informational explainer"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
style={{
position: "absolute",
top: 0,
left: 0,
width: "100%",
height: "100%",
borderRadius: "25pt"
}}
></iframe>
</div>
);

YouTube.propTypes = {
ID: PropTypes.string.isRequired,
};

export default YouTube;
Binary file added static/assets/channel-accounts/custody.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/channel-accounts/layering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/channel-accounts/segregation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/channel-accounts/signers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading