-
Notifications
You must be signed in to change notification settings - Fork 111
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
chore: remove mentioning of not spec'ed Route Broadcasting Protocol #597
Open
sabineschaller
wants to merge
4
commits into
main
Choose a base branch
from
s2-routing-protocol
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8a7e4e3
chore: remove mentioning of not spec'ed Route Broadcasting Protocol
sabineschaller 8ff0c2a
Update 0031-dynamic-configuration-protocol/0031-dynamic-configuration…
sabineschaller 483a051
Update 0031-dynamic-configuration-protocol/0031-dynamic-configuration…
sabineschaller 0f5a771
clarify RBP in relationship doc
sabineschaller File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,20 +7,22 @@ draft: 3 | |
# Interledger Dynamic Configuration Protocol (ILDCP) v1 | ||
|
||
## Prerequisites | ||
|
||
This specification assumes the reader is familiar with the following documents: | ||
|
||
- [Interledger Architecture](../0001-interledger-architecture/0001-interledger-architecture.md) | ||
- [Interledger Protocol V4 (ILPv4)](../0027-interledger-protocol-4/0027-interledger-protocol-4.md) | ||
|
||
## Terminology | ||
|
||
- A **node** is a participant in an Interledger network. It may be a [connector](../0001-interledger-architecture/0001-interledger-architecture.md#connectors), a sender or a receiver. | ||
- A **node** is a participant in an Interledger network. It may be a [connector](../0001-interledger-architecture/0001-interledger-architecture.md#connectors), a sender or a receiver. | ||
- Nodes are connected to each other and the relationship between two nodes is either: | ||
- `parent` and `child` (one node is the `parent` of another node that is relatively its `child`), or, | ||
- `peer` and `peer` (two nodes are peered with one another). | ||
|
||
## Overview | ||
Interledger is a protocol suite that consists of several protocols including the [Bilateral Transfer Protocol](../0023-bilateral-transfer-protocol/0023-bilateral-transfer-protocol.md), the Route Broadcasting Protocol and others necessary for establishment, operation and maintenance of the network. Interledger Dynamic Configuration Protocol (ILDCP) is one of these protocols. | ||
|
||
Interledger is a protocol suite that consists of several protocols including the [Bilateral Transfer Protocol](../0023-bilateral-transfer-protocol/0023-bilateral-transfer-protocol.md) or [ILP over HTTP](../0035-ilp-over-http/0035-ilp-over-http.md) and others necessary for establishment, operation and maintenance of the network. Interledger Dynamic Configuration Protocol (ILDCP) is one of these protocols. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added ILP over HTTP and removed Route Broadcasting Protocol. I did wonder what "and others necessary" would include.
sabineschaller marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
In order to participate in the network a node must have an [ILP address](../0015-ilp-addresses/0015-ilp-addresses.md). This address is part of a heirarchical address space where child nodes MAY be allocated addresses within the address space of their parent node. This makes routing on the network more efficient than if all nodes had top-level addresses. | ||
|
||
|
@@ -40,14 +42,16 @@ Future versions of the protocol MAY exchange additional configuration informatio | |
## Protocol Detail | ||
|
||
### Procedure | ||
|
||
An exchange of configuration information is done using the following procedure. | ||
|
||
1. A child node requests configuration information from the parent node | ||
2. The parent node responds with the configuration information to the child node | ||
3. If the request cannot be processed, the parent node responds with an error | ||
|
||
### Packet | ||
The request and the response above are transferred in [ILP packets](../0027-interledger-protocol-4/0027-interledger-protocol-4.md#specification). | ||
|
||
The request and the response above are transferred in [ILP packets](../0027-interledger-protocol-4/0027-interledger-protocol-4.md#specification). | ||
sabineschaller marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The `fulfillment` of the response packet is always a zero-filled 32 byte octet string, therefore the condition is always the SHA-256 hash digest of that, i.e. the Base64 decoded value of `Zmh6rfhivXdsj8GLjp+OIAiXFIVu4jOzkCpZHQ1fKSU=`. | ||
|
||
|
@@ -64,15 +68,13 @@ The packet exchange goes as follows: | |
- The `executionCondition` of the ILP packet is `Zmh6rfhivXdsj8GLjp+OIAiXFIVu4jOzkCpZHQ1fKSU=` in Base64 format | ||
- The `destination` address of the ILP packet is `peer.config` | ||
- The `data` of the ILP packet is empty (size: 0) | ||
|
||
- Response | ||
- The `type` of the ILP packet is `ILP Fulfill` (type id: 13) | ||
- The `fulfillment` of the ILP packet is a 32-byte octet string all filled with zeros | ||
- The `data` of the ILP packet takes a specific format and is described by `DynamicConfigurationResponseData` in the ILDCP [ASN.1 definition](#asn1-definition). It is an OER encoded SEQUENCE of | ||
- `Variable-length octet string`: An ILP address that the child should use, encoded as an `ASCII` string | ||
- `Uint8`: An unsigned 8-bit integer indicating the asset scale that should be used for packets exchanged with the parent | ||
- `Variable-length octet string`: An asset code, encoded as a `UTF-8` string, indicating the settlement asset used between the peers | ||
|
||
- Error | ||
- The `type` of the ILP packet is `ILP Reject` (type id: 14) | ||
- The `code` of the ILP packet is an appropriate error code | ||
|
@@ -81,7 +83,9 @@ The packet exchange goes as follows: | |
- The `data` of the ILP packet is empty (size: 0) or MAY contain further information for debugging the error. | ||
|
||
### ASN.1 Definition | ||
|
||
The ASN.1 definition of ILP packets is described in [InterledgerProtocol.asn](../asn1/InterledgerProtocol.asn) and Dynamic Configuration Protocol data in [DynamicConfigurationProtocol.asn](../asn1/DynamicConfigurationProtocol.asn). | ||
|
||
### Encoding | ||
|
||
All ASN.1 types are encoded using [Octet Encoding Rules](../0030-notes-on-oer-encoding/0030-notes-on-oer-encoding.md) as is the norm with all Interledger protocols. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made it generic and pointed out that it wasn't spec'ed out yet