Interface XChainBridge

All Known Implementing Classes:
ImmutableXChainBridge

@Beta @Immutable public interface XChainBridge
Represents a cross-chain bridge.

This interface will be marked Beta until the featureXChainBridge amendment is enabled on mainnet. Its API is subject to change.

  • Method Details

    • builder

      Construct a XChainBridge builder.
      Returns:
      An ImmutableXChainBridge.Builder.
    • issuingChainDoor

      Address issuingChainDoor()
      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).
      Returns:
      The Address of the door account.
    • issuingChainIssue

      Issue issuingChainIssue()
      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.
      Returns:
      An Issue.
    • lockingChainDoor

      Address lockingChainDoor()
      The door account on the locking chain.
      Returns:
      The Address of the door account.
    • lockingChainIssue

      Issue lockingChainIssue()
      The asset that is locked and unlocked on the locking chain.
      Returns:
      An Issue.