XChainBridge Docs #2305

oeggert · 2023-12-15T23:18:15Z

Adding docs for 2.0 release.

Updated branch from #2277 to avoid merge conflicts.

github-actions · 2023-12-15T23:33:06Z

Link check report. 619960 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

content/concepts/networks-and-servers/parallel-networks.md

mvadari · 2023-12-21T23:47:52Z

content/concepts/xrpl-sidechains/cross-chain-bridges.md

+
+A locking chain is where the digital asset originates from. These assets are locked in a trust when sent across a bridge to an issuing chain.
+
+An issuing chain is an independent ledger with its own consensus algorithm and transaction types and rules. A wrapped version of the digital asset is minted and burned, depending on if an asset is received or sent from the locking chain.


Should this mention a sidechain as an example?

I don't think we need to mention it here, since we've got examples in the parent sidechains page.

content/concepts/xrpl-sidechains/cross-chain-bridges.md

github-actions · 2024-01-04T00:54:55Z

Link check report. 619930 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

mDuo13

Didn't get all the way through this large diff, but I spotted a few things that could use some attention in the first few sections. Largely it looks good though.

content/concepts/xrpl-sidechains/witness-servers.md

content/concepts/xrpl-sidechains/cross-chain-bridges.md

content/concepts/xrpl-sidechains/witness-servers.md

mDuo13 · 2024-01-09T02:48:26Z

content/concepts/xrpl-sidechains/witness-servers.md

+
+| Field Name | JSON Type | Required? | Description |
+|------------|-----------|-----------|-------------|
+| `Host`     | `string`  | Yes       | The IP address of the witness server for RPC requests. **Note:** This doesn't accept URLs |


Same question about the Host of the above table, although bigger question:

Is it necessary to define these separately? Couldn't we just call them both an "Endpoint Object" and have the top-level table say that both fields take an Endpoint Object as specified below?

I think I'd prefer these spilt since they are pointing to different endpoints that serve different functions.

content/concepts/xrpl-sidechains/xrpl-sidechains.md

content/references/protocol/ledger-data/ledger-entry-types/bridge.md

…v-portal into xchain-bridge-docs

github-actions · 2024-01-09T23:51:21Z

Link check report. 619940 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

github-actions · 2024-01-09T23:58:53Z

Link check report. 619946 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

content/@i18n/ja/resources/known-amendments.md

Co-authored-by: Rome Reginelli <[email protected]>

github-actions · 2024-01-10T00:25:38Z

Link check report. 619952 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

github-actions · 2024-01-10T00:38:14Z

Link check report. 619952 links checked.
Success! No broken links found.

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xchain-bridge-docs/

Style Report

DennisDawson

One thing that really should be resolved is the use of the term IOU for tokens. It would require a change to our style guidelines.

DennisDawson · 2024-01-09T22:48:48Z

content/concepts/networks-and-servers/parallel-networks.md

@@ -17,6 +17,7 @@ To help members of the XRP Ledger community interact with XRP Ledger technology
 | Testnet | Stable releases | An "alternate universe" network that acts as a testing ground for software built on the XRP Ledger, without impacting production XRP Ledger users and without risking real money. The [amendment status](known-amendments.html) of the Testnet is intended to closely mirror the Mainnet, although slight variations in timing may occur due to the unpredictable nature of decentralized systems. |
 | Devnet  | Beta releases   | A preview of coming attractions, where unstable changes to the core XRP Ledger software may be tested out. Developers can use this altnet to interact with and learn about planned new XRP Ledger features and amendments that are not yet enabled on the Mainnet. |
 | [Hooks V3 Testnet](https://hooks-testnet-v3.xrpl-labs.com/) | [Hooks server](https://github.com/XRPL-Labs/xrpld-hooks) | A preview of on-chain smart contract functionality using [hooks](https://xrpl-hooks.readme.io/). |
+| Sidechain-Devnet | Beta releases | A sidechain to test cross-chain bridge features. Devnet is treated as the locking chain and this sidechain is the issuing chain.<br>Library support:<br>- [xrpl.js 2.12.0](https://www.npmjs.com/package/xrpl/v/2.12.0)<br>- [xrpl-py 2.4.0](https://pypi.org/project/xrpl-py/2.4.0/)<br>**Note**: You can also use the [`xbridge-cli`](https://github.com/XRPLF/xbridge-cli) commandline tool to set up a cross-chain bridge on your local machine. |


Devnet is treated as the locking chain, while this sidechain is the issuing chain.

DennisDawson · 2024-01-09T22:55:57Z

content/concepts/xrpl-sidechains/cross-chain-bridges.md

+
+_(Requires the [XChainBridge amendment][] :not_enabled:)_
+
+Cross-chain bridges enable you to move XRP and tokens between the XRP Ledger and other blockchains. When referring to the blockchains connected by a bridge, one is the locking chain and the other the issuing chain.


one is the locking chain and the other is the issuing chain. [Italicize the words being defined]

DennisDawson · 2024-01-09T22:57:33Z

content/concepts/xrpl-sidechains/cross-chain-bridges.md

+
+An issuing chain is an independent ledger with its own consensus algorithm and transaction types and rules. A wrapped version of the digital asset is minted and burned, depending on if an asset is received or sent from the locking chain.
+
+**Note:** Bridges utilize special _door accounts_ when moving assets cross-chain. The door account on a locking chain is used to put assets into trust, and the door account on an issuing chain is used to issue wrapped assets. 


...assets into trust. The door account....

DennisDawson · 2024-01-09T23:02:23Z

content/concepts/xrpl-sidechains/cross-chain-bridges.md

+## How Do Bridges Work?
+
+At a high-level, bridges enable cross-chain transactions through these steps:
+


The four items are not parallel. You start out in second person for items 1 and 2, then move to third person for 3 and 4. I'd name the actor in items 1 and 2 ("The issuing chain creates a cross-chain claim ID"). If that's not accurate, identifying the actual actor in a similar way will make the 4 lines parallel.

DennisDawson · 2024-01-09T23:04:42Z

content/concepts/xrpl-sidechains/witness-servers.md

+---
+html: witness-servers.html
+parent: xrpl-sidechains.html
+blurb: A witness server is a light-weight server that witnesses and signs transactions between the XRP Ledger and another chain.


lightweight [one word]

DennisDawson · 2024-01-10T01:26:43Z

content/references/protocol/transactions/types/xchaincreateclaimid.md

+| Field               | JSON Type | Internal Type     | Required? | Description     |
+|:--------------------|:----------|:------------------|:----------|:----------------|
+| `IssuingChainDoor`  | `string`  | `ACCOUNT`         | Yes       | The door account on the issuing chain. For an XRP-XRP bridge, this must be the genesis account (the account that is created when the network is first started, which contains all of the XRP). |
+| `IssuingChainIssue` | `Issue`   | `ISSUE`           | Yes       | The asset that is minted and burned on the issuing chain. For an IOU-IOU bridge, the issuer of the asset must be the door account on the issuing chain, to avoid supply issues. |


DennisDawson · 2024-01-10T01:28:06Z

content/references/protocol/transactions/types/xchainmodifybridge.md

+| Field                    | JSON Type         | Internal Type | Required? | Description |
+|:-------------------------|:------------------|:------------------|:----------|-------------|
+| `Flags`                  | `number`          | `UINT32`          | Yes       | Specifies the flags for this transaction. |
+| `MinAccountCreateAmount` | `Currency Amount` | `AMOUNT`          | No        | The minimum amount, in XRP, required for a `XChainAccountCreateCommit` transaction. If this is not present, the `XChainAccountCreateCommit` transaction will fail. This field can only be present on XRP-XRP bridges. |


If ... not present.. transaction fails.

DennisDawson · 2024-01-10T01:28:24Z

content/references/protocol/transactions/types/xchainmodifybridge.md

+| Field               | JSON Type | Internal Type     | Required? | Description     |
+|:--------------------|:----------|:------------------|:----------|:----------------|
+| `IssuingChainDoor`  | `string`  | `ACCOUNT`         | Yes       | The door account on the issuing chain. For an XRP-XRP bridge, this must be the genesis account (the account that is created when the network is first started, which contains all of the XRP). |
+| `IssuingChainIssue` | `Issue`   | `ISSUE`           | Yes       | The asset that is minted and burned on the issuing chain. For an IOU-IOU bridge, the issuer of the asset must be the door account on the issuing chain, to avoid supply issues. |


DennisDawson · 2024-01-10T01:30:51Z

content/tutorials/tasks/use-xrpl-sidechains/set-up-iou-iou-bridge.md

+labels:
+  - Interoperability
+---
+# Set Up an IOU-IOU Bridge


Oy. If this goes forward, seriously, we have to change the guidance on the use of the term IOU.

DennisDawson · 2024-01-10T01:48:04Z

content/concepts/xrpl-sidechains/cross-chain-bridges.md

+---
+html: cross-chain-bridges.html
+parent: xrpl-sidechains.html
+blurb: Cross-chain bridges for the XRP Ledger enable value in the form of XRP and other tokens (IOUs) to move efficiently between blockchains.


Usage guidelines say we're trying to get away from the term IOU (though I personally like it). Safe to remove it here.

tequdev · 2024-01-10T04:53:20Z

content/concepts/xrpl-sidechains/witness-servers.md

+  - Interoperability
+---
+# Witness Servers
+[[Source]](https://github.com/seelabs/xbridge_witness "Source")


Will this repository be moved to XRPLF in the future?

migrating commits to clean branch

9b55f56

oeggert mentioned this pull request Dec 15, 2023

2.0 cross chain bridge docs #2277

Closed

oeggert requested review from mvadari, DennisDawson, mDuo13 and amarantha-k December 16, 2023 04:25

mvadari reviewed Dec 21, 2023

View reviewed changes

content/concepts/networks-and-servers/parallel-networks.md Outdated Show resolved Hide resolved

mvadari reviewed Dec 21, 2023

View reviewed changes

content/concepts/xrpl-sidechains/cross-chain-bridges.md Outdated Show resolved Hide resolved

add reviewer suggestions. update sidechain example links

fca358e

tequdev added the needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site label Jan 4, 2024

mDuo13 requested changes Jan 9, 2024

View reviewed changes

mDuo13 and others added 3 commits January 9, 2024 15:36

XChainBridge: more binary format info

5520788

add reviewer suggestion and fix known amendment info

3d01278

Merge branch 'xchain-bridge-docs' of https://github.com/XRPLF/xrpl-de…

4d5db1a

…v-portal into xchain-bridge-docs

fix index file name and bridge object fields

804d09b

oeggert requested a review from mDuo13 January 10, 2024 00:17

mDuo13 approved these changes Jan 10, 2024

View reviewed changes

mDuo13 reviewed Jan 10, 2024

View reviewed changes

content/@i18n/ja/resources/known-amendments.md Outdated Show resolved Hide resolved

Update content/@i18n/ja/resources/known-amendments.md

3a4a117

Co-authored-by: Rome Reginelli <[email protected]>

oeggert merged commit 2594aa3 into master Jan 10, 2024
3 of 4 checks passed

oeggert deleted the xchain-bridge-docs branch January 10, 2024 01:09

DennisDawson reviewed Jan 10, 2024

View reviewed changes

tequdev reviewed Jan 10, 2024

View reviewed changes

tequdev removed the needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site label Jan 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XChainBridge Docs #2305

XChainBridge Docs #2305

oeggert commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

mvadari Dec 21, 2023

oeggert Jan 4, 2024

github-actions bot commented Jan 4, 2024

mDuo13 left a comment

mDuo13 Jan 9, 2024

oeggert Jan 10, 2024

github-actions bot commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

github-actions bot commented Jan 10, 2024

github-actions bot commented Jan 10, 2024

DennisDawson left a comment

DennisDawson Jan 9, 2024

DennisDawson Jan 9, 2024

DennisDawson Jan 9, 2024

DennisDawson Jan 9, 2024

DennisDawson Jan 9, 2024

DennisDawson Jan 10, 2024

DennisDawson Jan 10, 2024

DennisDawson Jan 10, 2024

DennisDawson Jan 10, 2024

DennisDawson Jan 10, 2024

tequdev Jan 10, 2024


		A locking chain is where the digital asset originates from. These assets are locked in a trust when sent across a bridge to an issuing chain.

		An issuing chain is an independent ledger with its own consensus algorithm and transaction types and rules. A wrapped version of the digital asset is minted and burned, depending on if an asset is received or sent from the locking chain.


		_(Requires the [XChainBridge amendment][] :not_enabled:)_

		Cross-chain bridges enable you to move XRP and tokens between the XRP Ledger and other blockchains. When referring to the blockchains connected by a bridge, one is the locking chain and the other the issuing chain.


		An issuing chain is an independent ledger with its own consensus algorithm and transaction types and rules. A wrapped version of the digital asset is minted and burned, depending on if an asset is received or sent from the locking chain.

		Note: Bridges utilize special _door accounts_ when moving assets cross-chain. The door account on a locking chain is used to put assets into trust, and the door account on an issuing chain is used to issue wrapped assets.

		## How Do Bridges Work?

		At a high-level, bridges enable cross-chain transactions through these steps:

XChainBridge Docs #2305

XChainBridge Docs #2305

Conversation

oeggert commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 4, 2024

mDuo13 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

github-actions bot commented Jan 10, 2024

github-actions bot commented Jan 10, 2024

DennisDawson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment