Skip to content

Commit f511818

Browse files
JFWooten4ElliotFriend
authored andcommitted
🐛 compilation bug fixes, hrefs
I understand there's more to do in `docs\data\READ_FIRST.md`, but I'm just not going to deal with that until stellar#1044
1 parent 5f4618e commit f511818

8 files changed

Lines changed: 33447 additions & 2522 deletions

File tree

docs/build/guides/transactions/channel-accounts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Submitting transactions quickly [often requires](https://github.com/stellar/stel
1616

1717
## Background Motivation
1818

19-
Channel accounts take advantage of the fact that the [source account](../../glossary.mdx#source-account) of a [transaction](../../../data/horizon/api-reference/resources/transactions/README.mdx) ($S_T$) can be different than the source account of the [operations](../../../data/horizon/api-reference/resources/operations/README.mdx) inside a transaction ($S_O$).
19+
Channel accounts take advantage of the fact that the [source account](../../glossary.mdx#source-account) of a [transaction](../../../data/apis/horizon/api-reference/resources/transactions/README.mdx) ($S_T$) can be different than the source account of the [operations](../../../data/apis/horizon/api-reference/resources/operations/README.mdx) inside a transaction ($S_O$).
2020

2121
![Separate Sources](/assets/channel-accounts/layering.png)
2222

2323
<!-- edit all imgs at https://www.canva.com/design/DAGKequMtSI/X8aIKrg76X8M-Ik69RAHiQ/view -->
2424

2525
:::info Packet Propogation
2626

27-
Stellar validators are spread across the globe, making it challenging to garauntee immediate order of arrival from one source. Only by sequencing [a validator](../../../validators/README.mdx) can you control physical delays for your transactions, as signals vary in [network lag](https://stellarbeat.io/nodes/GARYGQ5F2IJEBCZJCBNPWNWVDOFK7IBOHLJKKSG2TMHDQKEEC6P4PE4V?center=1#:~:text=Externalize,lag) to reach [other nodes](../../../data/horizon/admin-guide/ingestion.mdx). Accordingly, channel accounts are the only way to guarantee layer-1 settlement for many consecutive transactions.
27+
Stellar validators are spread across the globe, making it challenging to garauntee immediate order of arrival from one source. Only by sequencing [a validator](../../../validators/README.mdx) can you control physical delays for your transactions, as signals vary in [network lag](https://stellarbeat.io/nodes/GARYGQ5F2IJEBCZJCBNPWNWVDOFK7IBOHLJKKSG2TMHDQKEEC6P4PE4V?center=1#:~:text=Externalize,lag) to reach [other nodes](../../../data/apis/horizon/admin-guide/ingestion.mdx). Accordingly, channel accounts are the only way to guarantee layer-1 settlement for many consecutive transactions.
2828

2929
:::
3030

@@ -984,7 +984,7 @@ You must sign the transaction with both the primary-account and channel-account
984984
985985
### Receiving Node
986986
987-
Horizon instances limit [request frequency](../../../data/horizon/api-reference/structure/rate-limiting.mdx) by default. If you both submit transactions and read data quickly, then your channel accounts can exceed a public validator's request threshold. If you consistently have excessive queries, you may need your [own node](../../../validators/admin-guide/README.mdx) to submit transaction sets quickly.
987+
Horizon instances limit [request frequency](../../../data/apis/horizon/api-reference/structure/rate-limiting.mdx) by default. If you both submit transactions and read data quickly, then your channel accounts can exceed a public validator's request threshold. If you consistently have excessive queries, you may need your [own node](../../../validators/admin-guide/README.mdx) to submit transaction sets quickly.
988988
989989
### Fee Sponsorships
990990

docs/data/apis/horizon/api-reference/retrieve-an-order-book.api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: retrieve-an-order-book
33
title: "Retrieve an Order Book"
4-
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/apis/horizon/api-reference/structure/streaming) mode."
4+
description: "The order book endpoint provides an order book's bids and asks and can be used in [streaming](./structure/streaming.mdx) mode."
55
sidebar_label: "Retrieve an Order Book"
66
hide_title: true
77
hide_table_of_contents: true
@@ -36,7 +36,7 @@ import Heading from "@theme/Heading";
3636

3737

3838

39-
The order book endpoint provides an order book's bids and asks and can be used in [streaming](https://developers.stellar.org/docs/data/apis/horizon/api-reference/structure/streaming) mode.
39+
The order book endpoint provides an order book's bids and asks and can be used in [streaming](./structure/streaming.mdx) mode.
4040

4141
When filtering for a specific order book, you must use use all six of these arguments: `base_asset_type`, `base_asset_issuer`, `base_asset_code`, `counter_asset_type`, `counter_asset_issuer`, and `counter_asset_code`. If the base or counter asset is XLM, you only need to indicate the asset type as `native` and do not need to designate the code or the issuer.
4242

docs/data/apis/rpc/api-reference/structure/pagination.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 50
33
title: Pagination
44
---
55

6-
Pagination in stellar-rpc is similar to pagination in Horizon.
6+
Pagination in stellar-rpc is similar to [pagination in Horizon](../../../horizon/api-reference/structure/pagination/README.mdx).
77

88
For methods which support it, the pagination arguments are passed as a final object argument with two values:
99

docs/learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ While legacy playfomrs route trades through a myriad of middlemen, the Stellar l
2424

2525
## The Price-Time Orderbook
2626

27-
Markets form onthe basis of a [limit order book](https://wikipedia.org/wiki/Order_book) where individuals decide how much they will bid to purchase or ask for to sell an asset. By keeping these orders concentraded on the SDEX's public [Horizon endpoints](../../../data/horizon/api-reference/resources/README.mdx), everyone can see the going going market exchange rate. This tranpsarent universal marketplace has the added benefit of obviating price oracles, proprietary contracts, or off-chain systems.
27+
Markets form onthe basis of a [limit order book](https://wikipedia.org/wiki/Order_book) where individuals decide how much they will bid to purchase or ask for to sell an asset. By keeping these orders concentraded on the SDEX's public [Horizon endpoints](../../../data/apis/horizon/api-reference/resources/README.mdx), everyone can see the going going market exchange rate. This tranpsarent universal marketplace has the added benefit of obviating price oracles, proprietary contracts, or off-chain systems.
2828

2929
A priced order only expires whe nyou remove it from the ledger, offering supporting liquidity in down markets or rational selling in exuberant ones. More offers between pairs add volume to the market depth, promoting stable conversaion rates. If ypou've traded on an investment platform, the terminology here will be fairly familiar.
3030

31-
The ledger's innovation lies in _where_ these offers get stored, matched, and disclosed. To submit directly to network nodes, you can use the [Manage Buy Offer](../../../data/horizon/api-reference/resources/operations/object/buy-offer.mdx) operation, specifying how much \mathcal{X} you want to purchase with \mathcal{Y} at \mathcal{Z} price. The protocol calculates the cost of the trade in terms of `amount * price` and locks up the `selling` asset you offer in exchange as collateral, until the trade is (partially) executed or cancelled.
31+
The ledger's innovation lies in _where_ these offers get stored, matched, and disclosed. To submit directly to network nodes, you can use the [Manage Buy Offer](../../../data/apis/horizon/api-reference/resources/operations/object/buy-offer.mdx) operation, specifying how much \mathcal{X} you want to purchase with \mathcal{Y} at \mathcal{Z} price. The protocol calculates the cost of the trade in terms of `amount * price` and locks up the `selling` asset you offer in exchange as collateral, until the trade is (partially) executed or cancelled.
3232

33-
Alternatively, you can specify exactly how much of an asset you want to seel at a specific price using the [Manage Sell Offer](../../../data/horizon/api-reference/resources/operations/object/sell-offer.mdx) operation. Anyone vieweing this public Horizon interface to the ledger will see your orders as validators first based on price. For orders placed at the same price, the order that was received earlier is given priority and is executed before the newer one.
33+
Alternatively, you can specify exactly how much of an asset you want to seel at a specific price using the [Manage Sell Offer](../../../data/apis/horizon/api-reference/resources/operations/object/sell-offer.mdx) operation. Anyone vieweing this public Horizon interface to the ledger will see your orders as validators first based on price. For orders placed at the same price, the order that was received earlier is given priority and is executed before the newer one.
3434

3535
### Free Market Data
3636

@@ -173,7 +173,7 @@ func newTxBuilder(publicKey string) (*txnbuild.Transaction, error) {
173173

174174
</CodeExample>
175175

176-
This setup gives us a simple keypair, transaction constructor, and trading assets. You cancel swap the [server URL](../../../data/horizon/horizon-providers.mdx) or [asset codes](../../fundamentals/stellar-data-structures/assets.mdx#asset-code) to follow along with live exchange markets. Next, we'll read the current market price between AstroDollars and AstroPesos:
176+
This setup gives us a simple keypair, transaction constructor, and trading assets. You cancel swap the [server URL](../../../data/apis/api-providers.mdx) or [asset codes](../../fundamentals/stellar-data-structures/assets.mdx#asset-code) to follow along with live exchange markets. Next, we'll read the current market price between AstroDollars and AstroPesos:
177177

178178
<CodeExample>
179179

@@ -332,7 +332,7 @@ func getMidpointPrice(orderbook horizon.OrderBookSummary) (*float64, error) {
332332

333333
:::note
334334

335-
We have now found the price of `AstroDollar` as the response item's `base` asset. We can invert `price_r` from the [query response](../../../data/horizon/api-reference/retrieve-an-order-book.api.mdx) to find the `counter` `AstroPeso` exchange rate. If you'd like to keep your view of the orderbook up to date, you can also [stream](../../data/horizon/api-reference/structure/streaming) updates.
335+
We have now found the price of `AstroDollar` as the response item's `base` asset. We can invert `price_r` from the [query response](../../../data/apis/horizon/api-reference/retrieve-an-order-book.api.mdx) to find the `counter` `AstroPeso` exchange rate. If you'd like to keep your view of the orderbook up to date, you can also [stream](../../data/apis/horizon/api-reference/structure/streaming) updates.
336336

337337
:::
338338

@@ -450,7 +450,7 @@ func sanityCheck(midpointPrice, averageRecentPrice *float64) bool {
450450

451451
:::tip Scanning
452452

453-
Ths example examines orders using the default [paging token limit](../../../data/horizon/api-reference/structure/pagination/README.mdx#larger-queries). For more oinsight into the depth of a amrket, you cna increase the request limit and even continue paging through results. For very liquid assets, there can be thousands of active offers awaiting exchange.
453+
Ths example examines orders using the default [paging token limit](../../../data/apis/horizon/api-reference/structure/pagination/README.mdx#larger-queries). For more oinsight into the depth of a amrket, you cna increase the request limit and even continue paging through results. For very liquid assets, there can be thousands of active offers awaiting exchange.
454454

455455
:::
456456

@@ -550,7 +550,7 @@ func main() {
550550

551551
## Operating Principles
552552

553-
At no point in this exacmple did assets leave your custody. And, since no other entities control (intermediate) funds, conversions happen with equal preference as [offer operations](../../../data/horizon/api-reference/resources/operations/object/sell-offer.mdx) enter [transaction sets](../../fundamentals/stellar-consensus-protocol.mdx#nomination-protocol) via [consensus reputation](../../fundamentals/stellar-consensus-protocol.mdx#quorum-set). This new breakthrough introcudes a few worthwhile design implications.
553+
At no point in this exacmple did assets leave your custody. And, since no other entities control (intermediate) funds, conversions happen with equal preference as [offer operations](../../../data/apis/horizon/api-reference/resources/operations/object/sell-offer.mdx) enter [transaction sets](../../fundamentals/stellar-consensus-protocol.mdx#nomination-protocol) via [consensus reputation](../../fundamentals/stellar-consensus-protocol.mdx#quorum-set). This new breakthrough introcudes a few worthwhile design implications.
554554

555555
### Converting Path Paymtns
556556

@@ -608,7 +608,7 @@ When withdrawing from the AMM, the issuer will burn returned NANAs while keeping
608608

609609
### Market Depth
610610

611-
The more orders available to transact against, the more currency you can convert at any time without moving the market. Stellar stores these open orders as `offer` [objects](https://developers.stellar.org/docs/data/horizon/api-reference/resources/offers/object) directly on chain. This transparency allows anyone to analyze the order book and understand the trading activity for any asset pair.
611+
The more orders available to transact against, the more currency you can convert at any time without moving the market. Stellar stores these open orders as `offer` [objects](https://developers.stellar.org/docs/data/apis/horizon/api-reference/resources/offers/object) directly on chain. This transparency allows anyone to analyze the order book and understand the trading activity for any asset pair.
612612

613613
### Fill Prices
614614

@@ -714,7 +714,7 @@ A couple of notes on order books on Stellar:
714714
- Order books contain all orders that are acceptable to parties on either side to make a trade.
715715
- Some assets will have a small or nonexistent order book between them. In these cases, Stellar facilitates path payments, which we’ll discuss later.
716716

717-
[^buys]: When you create a buy offer using the [`createBuyOffer`](../../../data/horizon/api-reference/resources/operations/object/buy-offer.mdx) operation, it is internally converted and stored as a sell offer.
717+
[^buys]: When you create a buy offer using the [`createBuyOffer`](../../../data/apis/horizon/api-reference/resources/operations/object/buy-offer.mdx) operation, it is internally converted and stored as a sell offer.
718718

719719
To view an order book chart, see the [Order Book Wikipedia Page](https://en.wikipedia.org/wiki/Order_book). In addition, there are also plenty of video tutorials and articles out there that can help you understand how order books work in greater detail.
720720

docs/learn/fundamentals/transactions/list-of-operations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ Transfers the XLM balance of one account to another account and removes the sour
366366

367367
## Manage data
368368

369-
Adds, modifies, or deletes a data entry ([name-value pair](../../../data/horizon/api-reference/resources/operations/object/manage-data.mdx)) attached to an account.
369+
Adds, modifies, or deletes a data entry ([name-value pair](../../../data/apis/horizon/api-reference/resources/operations/object/manage-data.mdx)) attached to an account.
370370

371371
Learn more about entries and subentries: [Accounts section](../stellar-data-structures/accounts.mdx#subentries)
372372

0 commit comments

Comments
 (0)