XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
XRP Ledger Protocol Reference
/
Ledger Data Formats
/
Ledger Entry Types
/
Bridge
Last updated
Edit

Bridge

(Requires the XChainBridge amendment )

[Source]

The Bridge ledger entry represents a single cross-chain bridge that connects the XRP Ledger with another blockchain, such as its sidechain, and enables value in the form of XRP and other tokens (IOUs) to move efficiently between the two blockchains.

Example Bridge JSON

{
  "Account": "r3nCVTbZGGYoWvZ58BcxDmiMUU7ChMa1eC",
  "Flags": 0,
  "LedgerEntryType": "Bridge",
  "MinAccountCreateAmount": "2000000000",
  "OwnerNode": "0",
  "PreviousTxnID": "67A8A1B36C1B97BE3AAB6B19CB3A3069034877DE917FD1A71919EAE7548E5636",
  "PreviousTxnLgrSeq": 102,
  "SignatureReward": "204",
  "XChainAccountClaimCount": "0",
  "XChainAccountCreateCount": "0",
  "XChainBridge": {
    "IssuingChainDoor": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "IssuingChainIssue": {
      "currency": "XRP"
    },
    "LockingChainDoor": "r3nCVTbZGGYoWvZ58BcxDmiMUU7ChMa1eC",
    "LockingChainIssue": {
      "currency": "XRP"
    }
  },
  "XChainClaimID": "1",
  "index": "9F2C9E23343852036AFD323025A8506018ABF9D4DBAA746D61BF1CFB5C297D10"
}

Bridge Fields

In addition to the common fields, Bridge entries have the following fields:

FieldJSON TypeInternal TypeRequired?Description
AccountStringAccountYesThe account that submitted the XChainCreateBridge transaction on the blockchain.
MinAccountCreateAmountCurrency AmountAmountNoThe minimum amount, in XRP, required for an XChainAccountCreateCommit transaction. If this isn't present, the XChainAccountCreateCommit transaction will fail. This field can only be present on XRP-XRP bridges.
SignatureRewardCurrency AmountAmountYesThe total amount, in XRP, to be rewarded for providing a signature for cross-chain transfer or for signing for the cross-chain reward. This amount will be split among the signers.
XChainAccountClaimCountNumberUInt64YesA counter used to order the execution of account create transactions. It is incremented every time a XChainAccountCreateCommit transaction is "claimed" on the destination chain. When the "claim" transaction is run on the destination chain, the XChainAccountClaimCount must match the value that the XChainAccountCreateCount had at the time the XChainAccountClaimCount was run on the source chain. This orders the claims so that they run in the same order that the XChainAccountCreateCommit transactions ran on the source chain, to prevent transaction replay.
XChainAccountCreateCountNumberUInt64YesA counter used to order the execution of account create transactions. It is incremented every time a successful XChainAccountCreateCommit transaction is run for the source chain.
XChainBridgeXChainBridgeXChain_BridgeYesThe door accounts and assets of the bridge this object correlates to.
XChainClaimIDNumberUInt64YesThe value of the next XChainClaimID to be created.

XChainBridge Fields

FieldJSON TypeInternal TypeRequired?Description
IssuingChainDoorStringAccountYesThe 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).
IssuingChainIssueIssueIssueYesThe 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.
LockingChainDoorStringAccountYesThe door account on the locking chain.
LockingChainIssueIssueIssueYesThe asset that is locked and unlocked on the locking chain.