Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Commit

Permalink
fix spin-up-local-network.md and build
Browse files Browse the repository at this point in the history
  • Loading branch information
nkmr-jp committed Aug 1, 2020
1 parent c7488f8 commit 3f510c2
Show file tree
Hide file tree
Showing 21 changed files with 160 additions and 154 deletions.
2 changes: 1 addition & 1 deletion _content/spin-up-local-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ docker pull redis
Run this command to build the Docker image for the Interledger.rs node, which may take a few minutes:

```
docker build -f ./docker/ilp-node.dockerfile -t interledgerrs/ilp-node --build-arg CARGO_BUILD_OPTION="--release --features monitoring --manifest-path ./crates/ilp-node/Cargo.toml" --build-arg RUST_BIN_DIR_NAME="release" https://github.com/interledger-rs/interledger-rs.git#ko-stream-reliability
docker build -f ./docker/ilp-node.dockerfile -t interledgerrs/ilp-node --build-arg CARGO_BUILD_OPTION="--release --features monitoring --manifest-path ./crates/ilp-node/Cargo.toml" --build-arg RUST_BIN_DIR_NAME="release" https://github.com/interledger-rs/interledger-rs.git
```

Next, create a local Docker network so each service can communicate with each other:
Expand Down
2 changes: 1 addition & 1 deletion community.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
<article class="pt-3 p-md-3">
<div class="content doc-content">
<h1 id="main-page-header">Get Involved</h1>
<p class="blurb"></p>
<p class="blurb">Interledger is developed by an open group of companies and individual contributors, loosely organized as part of a Community Group of the World Wide Web Consortium (W3C). See the full list of members here.</p>
<h2 id="who-are-we">Who Are We?</h2>
<p>Interledger is developed by an open group of companies and individual contributors, loosely organized as part of a Community Group of the World Wide Web Consortium (W3C). See the full list of members <a class="external-link" href="https://www.w3.org/community/interledger/participants" target="_blank">here <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
<p>Want to build on Interledger or be part of its development? <br/>
Expand Down
10 changes: 5 additions & 5 deletions rfcs/0003-interledger-protocol/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ <h4 id="message">message</h4>
<pre><code>Invalid destination. destination=example.us.bob
</code></pre>
<p>This field MUST be encoded as UTF-8.</p>
<h4 id="data_1">data</h4>
<h4 id="data-1">data</h4>
<pre><code>OCTET STRING (SIZE(0..32767))
</code></pre>
<p>Machine-readable data. The format is defined for each error code. Implementations MUST follow the correct format for the code given in the <code>code</code> field. When parsing rejection packets, implementations MUST ignore extra bytes in the <code>data</code> field.</p>
Expand Down Expand Up @@ -539,7 +539,7 @@ <h3 id="ilp-error-format">ILP Error Format</h3>
</tr>
</tbody>
</table>
<h4 id="code_1">code</h4>
<h4 id="code-1">code</h4>
<pre><code>IA5String (SIZE(3))
</code></pre>
<p>Error code. For example, <code>F00</code>. See <a href="#ilp-error-codes">ILP Error Codes</a> for the list of error codes and their meanings.</p>
Expand All @@ -548,15 +548,15 @@ <h4 id="name">name</h4>
</code></pre>
<p>Error name. For example, <code>Bad Request</code>. See <a href="#ilp-error-codes">ILP Error Codes</a> for the list of error codes and their meanings.</p>
<p>Implementations of ILP SHOULD NOT depend on the <code>name</code> instead of the <code>code</code>. The name is primarily provided as a convenience to facilitate debugging by humans. If the <code>name</code> does not match the <code>code</code>, the <code>code</code> is the definitive identifier of the error.</p>
<h4 id="triggeredby_1">triggeredBy</h4>
<h4 id="triggeredby-1">triggeredBy</h4>
<p><a href="#account">ILP Address</a> of the entity that originally emitted the error. This MAY be an address prefix if the entity that originally omitted the error is a ledger.</p>
<h4 id="forwardedby">forwardedBy</h4>
<p><a href="#account">ILP Addresses</a> of the connectors that relayed the error message.</p>
<h4 id="triggeredat">triggeredAt</h4>
<pre><code>GeneralizedTime
</code></pre>
<p>Date and time when the error was initially emitted. This MUST be expressed in the UTC + 0 (Z) timezone.</p>
<h4 id="data_2">data</h4>
<h4 id="data-2">data</h4>
<pre><code>OCTET STRING (SIZE(0..8192))
</code></pre>
<p>Error data provided primarily for debugging purposes. Systems that emit errors SHOULD include additional explanation or context about the issue.</p>
Expand Down Expand Up @@ -770,7 +770,7 @@ <h4 id="example">Example</h4>
</tr>
</tbody>
</table>
<h4 id="data_3">data</h4>
<h4 id="data-3">data</h4>
<pre><code>OCTET STRING (SIZE(0..32767))
</code></pre>
<p>Arbitrary data that is attached to the fulfillment. The contents are defined by the transport layer protocol.</p>
Expand Down
58 changes: 29 additions & 29 deletions rfcs/0004-ledger-plugin-interface/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ <h4 id="getaccount">getAccount</h4>
<p><code>ledgerPlugin.getAccount() ⇒ String</code></p>
<p>Get the ledger plugin's ILP address. This is given to senders to receive transfers to this account. Plugin must be connected, otherwise the function should throw.</p>
<p>The mapping from the ILP address to the local ledger address is dependent on the ledger / ledger plugin. An ILP address could be the <code>&lt;ledger prefix&gt;.&lt;account name or number&gt;</code>, or a token could be used in place of the actual account name or number.</p>
<h6 id="example-return-value_1">Example Return Value</h6>
<h6 id="example-return-value-1">Example Return Value</h6>
<p><code>us.fed.some-bank.my-account</code></p>
<h4 id="getbalance">getBalance</h4>
<p><code>ledgerPlugin.getBalance() ⇒ Promise.&lt;String&gt;</code></p>
Expand Down Expand Up @@ -432,7 +432,7 @@ <h4 id="sendtransfer">sendTransfer</h4>
further errors will be in the form of <code>"reject"</code> events.</p>
<p>All plugins MUST implement zero-amount transfers, but some ledger plugins MAY
implement zero-amount transfers differently than other transfers.</p>
<h6 id="parameters_1">Parameters</h6>
<h6 id="parameters-1">Parameters</h6>
<table>
<thead>
<tr>
Expand All @@ -455,7 +455,7 @@ <h6 id="returns">Returns</h6>
<p><strong><code>Promise.&lt;null&gt;</code></strong> A promise which resolves when the transfer has been submitted (but not necessarily accepted.)</p>
<p>Rejects with <code>InvalidFieldsError</code> if required fields are missing from the transfer or malformed. Rejects with <code>DuplicateIdError</code> if a transfer with
the given ID and different already exists. Rejects with <code>InsufficientBalanceError</code> if the transfer is rejected due to the source balance being too low. Rejects with <code>AccountNotFoundError</code> if the destination account does not exist. Rejects with <code>NotAcceptedError</code> if the transfer is otherwise rejected by the ledger.</p>
<h6 id="example_1">Example</h6>
<h6 id="example-1">Example</h6>
<pre><code class="js">p.sendTransfer({
id: 'd86b0299-e2fa-4713-833a-96a6a75271b8',
to: 'example.ledger.connector',
Expand All @@ -471,7 +471,7 @@ <h4 id="sendrequest">sendRequest</h4>
<p>Plugin must be connected, otherwise the promise should reject. Sends a ledger-local message. Returns a promise for a response message from the other side.
If there is a problem with the structure or validity of the message, then <code>sendRequest</code> should reject with an error.</p>
<p>Messaging is used by connectors for <a href="../0008-interledger-quoting-protocol/">quoting</a> and broadcasting routes.</p>
<h6 id="parameters_2">Parameters</h6>
<h6 id="parameters-2">Parameters</h6>
<table>
<thead>
<tr>
Expand All @@ -489,12 +489,12 @@ <h6 id="parameters_2">Parameters</h6>
</tbody>
</table>
<p>When sending messages, the <a href="#messageto">to</a> and <a href="#messageilp">ilp</a> fields are required.</p>
<h6 id="returns_1">Returns</h6>
<h6 id="returns-1">Returns</h6>
<p><strong><code>Promise.&lt;<a href="#class-message">Message</a>&gt;</code></strong> A promise which resolves when a response message has been received.</p>
<p>Rejects with <code>InvalidFieldsError</code> if required fields are missing from the message or malformed.
Rejects with <code>NotAcceptedError</code> if the message is rejected by the ledger.
Rejects with <code>NoSubscriptionsError</code> if the message cannot be delivered because there is nobody listening to messages addressed to the given account.</p>
<h6 id="example_2">Example</h6>
<h6 id="example-2">Example</h6>
<pre><code class="js">p.sendRequest({
to: 'example.ledger.connector',
ilp: '...base64url-encoded data...',
Expand Down Expand Up @@ -715,7 +715,7 @@ <h6 id="fields">Fields</h6>
</tr>
</tbody>
</table>
<h3 id="fields_1">Fields</h3>
<h3 id="fields-1">Fields</h3>
<h4 id="transferid">Transfer#id</h4>
<p><code><strong>id</strong>:String</code></p>
<p>External unique identifier used by the host.</p>
Expand Down Expand Up @@ -759,7 +759,7 @@ <h4 id="transfercustom-optional">Transfer#custom (OPTIONAL)</h4>
<p><code><strong>custom</strong>:Object</code></p>
<p>Optional object that ledger plugins MAY use to accept and/or set additional fields for other features they support. The object MUST be serializable, i.e. only plain JSON types are allowed anywhere in the object or sub-objects.</p>
<p>If the <code>custom</code> data is too large, the ledger plugin MUST reject with a <code>MaximumCustomDataSizeExceededError</code>.</p>
<h6 id="example_3">Example</h6>
<h6 id="example-3">Example</h6>
<pre><code class="js">{
id: '94adc29e-26cd-471b-987e-8d41e8773864',
account: 'example.ledger.bob',
Expand All @@ -777,7 +777,7 @@ <h6 id="example_3">Example</h6>
<h2 id="class-message">Class: Message</h2>
<p><code>class Message</code></p>
<p>The <code>Message</code> class is used to describe local ledger message. All fields are required.</p>
<h6 id="fields_2">Fields</h6>
<h6 id="fields-2">Fields</h6>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -840,7 +840,7 @@ <h4 id="messagecustom-optional">Message#custom (OPTIONAL)</h4>
<p><code><strong>custom</strong>:Object</code></p>
<p>An optional, arbitrary plain JavaScript object containing additional custom data to be sent. The object MUST be serializable to JSON. Ledger plugins SHOULD treat this data as opaque.</p>
<p>If the <code>custom</code> data is too large, the ledger plugin MUST reject with a <code>MaximumCustomDataSizeExceededError</code>.</p>
<h6 id="example_4">Example</h6>
<h6 id="example-4">Example</h6>
<pre><code class="js">{
account: 'example.ledger.bob',
from: 'example.ledger.alice',
Expand All @@ -853,7 +853,7 @@ <h6 id="example_4">Example</h6>
<h2 id="class-ledgerinfo">Class: LedgerInfo</h2>
<p><code>class LedgerInfo</code></p>
<p>Metadata describing the ledger. This data is returned by the <a href="#getinfo"><code>getInfo</code></a> method.</p>
<h6 id="fields_3">Fields</h6>
<h6 id="fields-3">Fields</h6>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -895,7 +895,7 @@ <h6 id="fields_3">Fields</h6>
</tr>
</tbody>
</table>
<h3 id="fields_4">Fields</h3>
<h3 id="fields-4">Fields</h3>
<h4 id="ledgerinfoprefix">LedgerInfo#prefix</h4>
<p><code><strong>prefix</strong>:String</code></p>
<p>The ledger plugin's ILP address prefix. This is used to determine whether a given ILP address is local to this ledger plugin and thus can be reached using this plugin's <code>sendTransfer</code> method.</p>
Expand Down Expand Up @@ -952,13 +952,13 @@ <h6 id="special-fields">Special Fields</h6>
</tr>
</tbody>
</table>
<h3 id="fields_5">Fields</h3>
<h3 id="fields-5">Fields</h3>
<h4 id="pluginoptions_store">PluginOptions#_store</h4>
<p><code><strong>_store</strong>:Object</code></p>
<p>Provides callback hooks to the host's persistence layer.</p>
<p>Persistence MAY be required for internal use by some ledger plugins. For this purpose hosts MAY be configured with a persistence layer.</p>
<p>Method names are based on the popular LevelUP/LevelDOWN packages.</p>
<h6 id="example_5">Example</h6>
<h6 id="example-5">Example</h6>
<pre><code class="js">{
// Store a value under a key
put: (key, value) =&gt; {
Expand All @@ -976,7 +976,7 @@ <h6 id="example_5">Example</h6>
</code></pre>
<h2 id="class-connectoptions">Class: ConnectOptions</h2>
<p><code>class ConnectOptions</code></p>
<h6 id="fields_6">Fields</h6>
<h6 id="fields-6">Fields</h6>
<table>
<thead>
<tr>
Expand All @@ -993,15 +993,15 @@ <h6 id="fields_6">Fields</h6>
</tr>
</tbody>
</table>
<h3 id="fields_7">Fields</h3>
<h3 id="fields-7">Fields</h3>
<h4 id="connectoptionstimeout">ConnectOptions#timeout</h4>
<p><code><strong>timeout</strong>:Number</code></p>
<p>The number of milliseconds that the plugin should spend trying to connect before giving up.</p>
<p>If falsy, use the plugin's default timeout.
If <code>Infinity</code>, there is no timeout.</p>
<h2 id="class-rejectionmessage">Class: RejectionMessage</h2>
<p><code>class RejectionMessage</code></p>
<h6 id="fields_8">Fields</h6>
<h6 id="fields-8">Fields</h6>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1063,23 +1063,23 @@ <h4>On This Page</h4>
<li class="level-3"><a href="#instance-management">Instance Management</a></li>
<li class="level-3"><a href="#connection-management">Connection Management</a></li>
<li class="level-3"><a href="#ledger-transfers">Ledger Transfers</a></li>
<li class="level-3"><a href="#event-_transfer">Event: *_transfer</a></li>
<li class="level-3"><a href="#event-_prepare">Event: *_prepare</a></li>
<li class="level-3"><a href="#event-_fulfill">Event: *_fulfill</a></li>
<li class="level-3"><a href="#event-_reject">Event: *_reject</a></li>
<li class="level-3"><a href="#event-_cancel">Event: *_cancel</a></li>
<li class="level-3"><a href="#event-_request">Event: *_request</a></li>
<li class="level-3"><a href="#event-_response">Event: *_response</a></li>
<li class="level-3"><a href="#event-info_change">Event: info_change</a></li>
<li class="level-3"><a href="#event-_transfer">Event: *_transfer</a></li>
<li class="level-3"><a href="#event-_prepare">Event: *_prepare</a></li>
<li class="level-3"><a href="#event-_fulfill">Event: *_fulfill</a></li>
<li class="level-3"><a href="#event-_reject">Event: *_reject</a></li>
<li class="level-3"><a href="#event-_cancel">Event: *_cancel</a></li>
<li class="level-3"><a href="#event-_request">Event: *_request</a></li>
<li class="level-3"><a href="#event-_response">Event: *_response</a></li>
<li class="level-3"><a href="#event-info_change">Event: info_change</a></li>
<li class="level-2"><a href="#class-transfer">Class: Transfer</a></li>
<li class="level-3"><a href="#fields_1">Fields</a></li>
<li class="level-3"><a href="#fields-1">Fields</a></li>
<li class="level-2"><a href="#class-message">Class: Message</a></li>
<li class="level-2"><a href="#class-ledgerinfo">Class: LedgerInfo</a></li>
<li class="level-3"><a href="#fields_4">Fields</a></li>
<li class="level-3"><a href="#fields-4">Fields</a></li>
<li class="level-2"><a href="#class-pluginoptions">Class: PluginOptions</a></li>
<li class="level-3"><a href="#fields_5">Fields</a></li>
<li class="level-3"><a href="#fields-5">Fields</a></li>
<li class="level-2"><a href="#class-connectoptions">Class: ConnectOptions</a></li>
<li class="level-3"><a href="#fields_7">Fields</a></li>
<li class="level-3"><a href="#fields-7">Fields</a></li>
<li class="level-2"><a href="#class-rejectionmessage">Class: RejectionMessage</a></li>

</ul>
Expand Down
4 changes: 2 additions & 2 deletions rfcs/0009-simple-payment-setup-protocol/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h2 id="specification">Specification</h2>
<li>Raw endpoint URL (Not recommended) <code>https://example.com/spsp/alice</code>. This SHOULD NOT be exposed to users, but SHOULD be supported by SPSP Clients.</li>
</ul>
<p>The SPSP Endpoint MUST respond to HTTPS <code>GET</code> requests in the following manner:</p>
<h3 id="query-get-ltspsp-endpointgt">Query (<code>GET &lt;SPSP Endpoint&gt;</code>)</h3>
<h3 id="query-get-spsp-endpoint">Query (<code>GET &lt;SPSP Endpoint&gt;</code>)</h3>
<p>The client queries the SPSP Endpoint to get information about the server:</p>
<h4 id="request">Request</h4>
<p>(With the identifier <code>$example.com</code>)</p>
Expand Down Expand Up @@ -323,7 +323,7 @@ <h4>On This Page</h4>
<li class="level-3"><a href="#operation">Operation</a></li>
<li class="level-3"><a href="#relation-to-other-protocols">Relation to Other Protocols</a></li>
<li class="level-2"><a href="#specification">Specification</a></li>
<li class="level-3"><a href="#query-get-ltspsp-endpointgt">Query ( GET &lt;SPSP Endpoint&gt; )</a></li>
<li class="level-3"><a href="#query-get-spsp-endpoint">Query (GET &lt;SPSP Endpoint&gt;)</a></li>
<li class="level-2"><a href="#model-of-operation">Model of Operation</a></li>
<li class="level-3"><a href="#establishing-a-connection">Establishing a connection</a></li>
<li class="level-3"><a href="#examples">Examples</a></li>
Expand Down

0 comments on commit 3f510c2

Please sign in to comment.