Skip to content

Commit 157a037

Browse files
authored
Merge pull request #1 from jtobin/rfq-multi-repo-docs
docs: fix up section titles in rfq arch doc
2 parents ec5dabd + b7172c9 commit 157a037

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/rfq_architecture.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@
2121
- [Buy Order Processing](#buy-order-processing)
2222
- [Sell Order Processing](#sell-order-processing)
2323
- [Quote Storage and Lifecycle](#quote-storage-and-lifecycle)
24-
- [Auxiliary Interfaces: Bridging Two Worlds](#auxiliary-interfaces-bridging-two-worlds)
24+
- [Auxiliary Interfaces](#auxiliary-interfaces)
2525
- [AuxTrafficShaper: Routing Control](#auxtrafficshaper-routing-control)
2626
- [Traffic Shaper Decision Flow](#traffic-shaper-decision-flow)
2727
- [Asset Unit Bandwidth Calculation](#asset-unit-bandwidth-calculation)
2828
- [RFQ-Based Bandwidth Calculation](#rfq-based-bandwidth-calculation)
2929
- [AuxHTLCModifier: Payment Transformation Engine](#auxhtlcmodifier-payment-transformation-engine)
3030
- [HTLC Modification Flow](#htlc-modification-flow)
3131
- [Data Flow Integration](#data-flow-integration)
32-
- [Fixed-Point Arithmetic: Precision in Every Calculation](#fixed-point-arithmetic-precision-in-every-calculation)
33-
- [The Architecture of Precision](#the-architecture-of-precision)
32+
- [Fixed-Point Arithmetic](#fixed-point-arithmetic)
33+
- [The FixedPoint Type](#the-fixedpoint-type)
3434
- [Precision and Scale Management](#precision-and-scale-management)
3535
- [Scale Alignment and Conversion](#scale-alignment-and-conversion)
3636
- [MilliSatoshi Conversion Operations](#millisatoshi-conversion-operations)
3737
- [Converting MilliSatoshi to Asset Units](#converting-millisatoshi-to-asset-units)
3838
- [Converting Asset Units to MilliSatoshi](#converting-asset-units-to-millisatoshi)
3939
- [Rate Quote Lifecycle](#rate-quote-lifecycle)
4040
- [Rate Conversion and Tolerance Mechanics](#rate-conversion-and-tolerance-mechanics)
41-
- [HTLC Transformation: The Heart of Asset Payments](#htlc-transformation-the-heart-of-asset-payments)
41+
- [HTLC Transformation](#htlc-transformation)
4242
- [Policy-Driven Interception](#policy-driven-interception)
4343
- [The NoOp Settlement Pattern](#the-noop-settlement-pattern)
4444
- [HTLC Interception Flow](#htlc-interception-flow)
@@ -47,12 +47,12 @@
4747
- [TLV Record Structure for Asset HTLCs](#tlv-record-structure-for-asset-htlcs)
4848
- [NoOp Implementation Details](#noop-implementation-details)
4949
- [Multi-Hop Coordination](#multi-hop-coordination)
50-
- [Asset Invoice Flows: Bridging the Payment Gap](#asset-invoice-flows-bridging-the-payment-gap)
51-
- [Creating an Asset Invoice: The Receiver's Journey](#creating-an-asset-invoice-the-receivers-journey)
52-
- [Paying an Asset Invoice: The Sender's Perspective](#paying-an-asset-invoice-the-senders-perspective)
50+
- [Asset Invoice Flows](#asset-invoice-flows)
51+
- [Creating an Asset Invoice](#creating-an-asset-invoice)
52+
- [Paying an Asset Invoice](#paying-an-asset-invoice)
5353
- [Handling Disconnected Parties](#handling-disconnected-parties)
5454
- [Rate Arbitrage and Market Making](#rate-arbitrage-and-market-making)
55-
- [Security Architecture: Defense in Depth](#security-architecture-defense-in-depth)
55+
- [Security Architecture](#security-architecture)
5656
- [Cryptographic Integrity](#cryptographic-integrity)
5757
- [Rate Manipulation Prevention](#rate-manipulation-prevention)
5858
- [Temporal Security and Expiry Management](#temporal-security-and-expiry-management)
@@ -625,7 +625,7 @@ quotes are used when initiating payments, while local accepted quotes govern
625625
incoming HTLC acceptance. The Manager implements automatic expiry management,
626626
removing stale quotes during access to prevent execution at outdated rates.
627627

628-
## Auxiliary Interfaces: Bridging Two Worlds
628+
## Auxiliary Interfaces
629629

630630
The auxiliary interface system enables taproot-assets to extend lnd's behavior
631631
without requiring modifications to Lightning's core protocol. Each interface
@@ -869,13 +869,13 @@ performance crucial. The implementations use caching and pre-computation where
869869
possible to minimize latency impact. For example, asset compatibility matrices
870870
are pre-computed when channels are opened rather than checked for each HTLC.
871871

872-
## Fixed-Point Arithmetic: Precision in Every Calculation
872+
## Fixed-Point Arithmetic
873873

874874
The fixed-point arithmetic system ensures precise financial calculations
875875
throughout the RFQ protocol. This system maintains exact precision while
876876
performing rate calculations and conversions.
877877

878-
### The Architecture of Precision
878+
### The FixedPoint Type
879879

880880
At the heart of the system lies the `FixedPoint` type, a generic structure that
881881
encapsulates an integer coefficient and a scale factor. The coefficient
@@ -1084,7 +1084,7 @@ system follows deterministic rounding rules that all nodes can reproduce. This
10841084
prevents discrepancies where different nodes might calculate slightly different
10851085
values for the same conversion.
10861086

1087-
## HTLC Transformation: The Heart of Asset Payments
1087+
## HTLC Transformation
10881088

10891089
The HTLC transformation pipeline intercepts standard Lightning HTLCs and
10901090
transforms them to carry asset transfer semantics while maintaining
@@ -1479,13 +1479,13 @@ it performs rate conversion and record injection. If transitioning from an asset
14791479
channel to a Bitcoin channel, it extracts the asset information and ensures
14801480
proper settlement of the asset portion while forwarding the Bitcoin value.
14811481

1482-
## Asset Invoice Flows: Bridging the Payment Gap
1482+
## Asset Invoice Flows
14831483

14841484
The RFQ protocol enables two invoice flows that allow users to send and receive
14851485
asset payments even when they're not directly connected. These flows coordinate
14861486
multi-party interactions for asset payments.
14871487

1488-
### Creating an Asset Invoice: The Receiver's Journey
1488+
### Creating an Asset Invoice
14891489

14901490
When a user wants to receive assets through Lightning, they create an asset
14911491
invoice that encodes all the information necessary for a payer to route assets
@@ -1560,7 +1560,7 @@ route through the edge node to reach the receiver. This hop hint provides the
15601560
bridge between the standard Lightning Network and the asset channel, even though
15611561
the payer may have no awareness that assets are involved.
15621562

1563-
### Paying an Asset Invoice: The Sender's Perspective
1563+
### Paying an Asset Invoice
15641564

15651565
When a user wants to pay an asset invoice, they need to send assets to a
15661566
receiver who may be multiple hops away, potentially through nodes they've never
@@ -1701,7 +1701,7 @@ quotes prevents edge nodes from changing terms after acceptance. The atomic
17011701
nature of HTLCs ensures that edge nodes cannot steal funds during conversion.
17021702
The automatic expiry of quotes limits the risk exposure from rate fluctuations.
17031703

1704-
## Security Architecture: Defense in Depth
1704+
## Security Architecture
17051705

17061706
The RFQ protocol implements multiple layers of security controls that protect
17071707
against both technical attacks and economic manipulation. This defense-in-depth

0 commit comments

Comments
 (0)