Skip to content

Commit

Permalink
GITBOOK-333: Updated Docs June 2024 - new branding
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Emsley authored and gitbook-bot committed Jul 8, 2024
1 parent 6dddb6e commit e2f266c
Show file tree
Hide file tree
Showing 94 changed files with 1,296 additions and 293 deletions.
Binary file added docs/.gitbook/assets/B (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/B.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Header (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Header (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Header (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Header (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Slide 16_9 - 9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
129 changes: 129 additions & 0 deletions docs/.gitbook/assets/getting a quote

Large diffs are not rendered by default.

37 changes: 28 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
# Introduction
---
cover: .gitbook/assets/Header (2).png
coverY: 0
layout:
cover:
visible: true
size: hero
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---

<figure><img src=".gitbook/assets/New Cover.png" alt=""><figcaption></figcaption></figure>
# Introduction

**deBridge is** **a high-performance and** **secure interoperability layer for Web3** that enables decentralized transfers of arbitrary messages and value between blockchains. The validation of cross-chain transactions is performed by a network of independent validators who are elected by and work for deBridge governance. Validators maintain the blockchain infrastructure and each run a deBridge node to sign all transactions that pass through deBridge smart contracts in different blockchains.&#x20;
**deBridge is DeFi's internet of liquidity**, enabling real-time movement of assets and information across the DeFi landscape. Without the bottlenecks and risks of liquidity pools, deBridge can power all type of cross-chain interactions with deep liquidity, tight spreads, and guaranteed rates.\
\
The validation of cross-chain transactions is performed by a network of independent validators who are elected by and work for deBridge governance. Validators maintain the blockchain infrastructure and each run a deBridge node to sign all transactions that pass through deBridge smart contracts on different supported blockchains.&#x20;

[Delegated staking and slashing](the-core-protocol/slashing-and-delegated-staking.md) mechanics act as a backbone for protocol security and provide economic disincentives for validators to collude.
[Delegated staking and slashing](the-debridge-messaging-protocol/slashing-and-delegated-staking.md) mechanics act as a backbone for protocol security and provide economic disincentives for validators to collude.

The deBridge protocol is an infrastructure platform and a framework for:

Expand All @@ -22,7 +41,7 @@ Projects can integrate with deBridge infrastructure to tap into the various cros
* Build new types of cross-chain applications and primitives
* Enable global accessibility by letting users and protocols from other chains seamlessly interact with the protocol

Our [getting-started.md](build-with-debridge/getting-started.md "mention") guide is a great starting point that covers all topics needed to start building cross-chain interactions through the deBridge protocol and its infrastructure.
Our [building-an-evm-based-dapp](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/ "mention") guide is a great starting point that covers all topics needed to start building cross-chain interactions through the deBridge protocol and its infrastructure.

The deBridge protocol will be controlled by a DAO with decentralized governance which allows all token holders to participate in future growth, have a word in the future decisions regarding protocol parameters, and participate in treasury management.

Expand All @@ -45,10 +64,10 @@ Facebook: [https://www.facebook.com/deBridgeFinance](https://www.facebook.com/de

## Quick Start

{% content-ref url="the-core-protocol/protocol-overview.md" %}
[protocol-overview.md](the-core-protocol/protocol-overview.md)
{% content-ref url="the-debridge-messaging-protocol/protocol-overview.md" %}
[protocol-overview.md](the-debridge-messaging-protocol/protocol-overview.md)
{% endcontent-ref %}

{% content-ref url="build-with-debridge/getting-started.md" %}
[getting-started.md](build-with-debridge/getting-started.md)
{% content-ref url="the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/" %}
[building-an-evm-based-dapp](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/)
{% endcontent-ref %}
112 changes: 62 additions & 50 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,68 @@

* [Introduction](README.md)

## The Core Protocol

* [Protocol Overview](the-core-protocol/protocol-overview.md)
* [Slashing and Delegated Staking](the-core-protocol/slashing-and-delegated-staking.md)
* [Fees and supported chains](the-core-protocol/fees-and-supported-chains.md)
* [Security](the-core-protocol/security.md)

## 🛠️ Build with deBridge

* [Getting started](build-with-debridge/getting-started.md)
* [Getting started with Solana](build-with-debridge/getting-started-with-solana/README.md)
* [On-Chain external call preparation for Solana](build-with-debridge/getting-started-with-solana/on-chain-external-call-preparation-for-solana.md)
* [Off-chain external call preparation for Solana](build-with-debridge/getting-started-with-solana/off-chain-external-call-preparation-for-solana.md)
* [Lifecycle of a cross-chain call](build-with-debridge/lifecycle-of-a-cross-chain-call.md)
* [Advanced topics](build-with-debridge/advanced-topics/README.md)
* [Gathering data for the claim](build-with-debridge/advanced-topics/gathering-data-for-the-claim.md)
* [Smart contract interface](build-with-debridge/smart-contract-interface.md)
* [Development tools](build-with-debridge.md)

## 🔁 Cross-chain bridging and value transfers

* [deBridge API Quick Start Guide](cross-chain-bridging-and-value-transfers/debridge-api-quick-start-guide.md)
* [Cross-Chain Swaps Liquidity](cross-chain-bridging-and-value-transfers/cross-chain-swaps-liquidity.md)
* [Custom Linking](cross-chain-bridging-and-value-transfers/custom-linking.md)
* [deBridge Widget](cross-chain-bridging-and-value-transfers/debridge-widget.md)
## The deBridge Messaging Protocol

* [Protocol Overview](the-debridge-messaging-protocol/protocol-overview.md)
* [Fees and Supported Chains](the-debridge-messaging-protocol/fees-and-supported-chains.md)
* [🟢 Deployed Contracts](the-debridge-messaging-protocol/deployed-contracts.md)
* [Development Guides](the-debridge-messaging-protocol/development-guides/README.md)
* [Building an EVM-based dApp](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/README.md)
* [EVM smart contract interfaces](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/README.md)
* [Interfaces](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/README.md)
* [ICallProxy](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/icallproxy.md)
* [IDeBridgeGate](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/idebridgegate.md)
* [IDeBridgeToken](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/idebridgetoken.md)
* [IDeBridgeTokenDeployer](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/idebridgetokendeployer.md)
* [IOraclesManager](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/ioraclesmanager.md)
* [ISignatureVerifier](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/isignatureverifier.md)
* [IWethGate](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/interfaces/iwethgate.md)
* [Libraries](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/libraries/README.md)
* [Flags](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/libraries/flags.md)
* [Periphery](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/periphery/README.md)
* [CallProxy](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/periphery/callproxy.md)
* [DeBridgeToken](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/periphery/debridgetoken.md)
* [DeBridgeTokenProxy](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/periphery/debridgetokenproxy.md)
* [SimpleFeeProxy](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/periphery/simplefeeproxy.md)
* [Transfers](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/README.md)
* [DeBridgeGate](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/debridgegate.md)
* [DeBridgeTokenDeployer](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/debridgetokendeployer.md)
* [OraclesManager](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/oraclesmanager.md)
* [SignatureVerifier](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/signatureverifier.md)
* [WethGate](the-debridge-messaging-protocol/development-guides/building-an-evm-based-dapp/evm-smart-contract-interfaces/transfers/wethgate.md)
* [Sending cross-chain messages from Solana](the-debridge-messaging-protocol/development-guides/sending-cross-chain-messages-from-solana/README.md)
* [On-Chain external call preparation for Solana](the-debridge-messaging-protocol/development-guides/sending-cross-chain-messages-from-solana/on-chain-external-call-preparation-for-solana.md)
* [Off-chain external call preparation for Solana](the-debridge-messaging-protocol/development-guides/sending-cross-chain-messages-from-solana/off-chain-external-call-preparation-for-solana.md)
* [Lifecycle of a cross-chain call](the-debridge-messaging-protocol/development-guides/lifecycle-of-a-cross-chain-call.md)
* [Gathering data for the claim](the-debridge-messaging-protocol/development-guides/gathering-data-for-the-claim.md)
* [Development Tools](the-debridge-messaging-protocol/development-tools.md)
* [Security](the-debridge-messaging-protocol/security.md)
* [Slashing and Delegated Staking](the-debridge-messaging-protocol/slashing-and-delegated-staking.md)

## 🔁 DLN: The deBridge Liquidity Network Protocol

* [Introduction](dln-the-debridge-liquidity-network-protocol/introduction.md)
* [Protocol Overview](dln-the-debridge-liquidity-network-protocol/protocol-overview.md)
* [Fees and Supported Chains](dln-the-debridge-liquidity-network-protocol/fees-and-supported-chains.md)
* [🟢 Deployed Contracts](dln-the-debridge-liquidity-network-protocol/deployed-contracts.md)
* [Market and Limit Orders](dln-the-debridge-liquidity-network-protocol/market-and-limit-orders.md)
* [Interacting with smart contracts](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/README.md)
* [Introduction](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/introduction.md)
* [Placing orders](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/placing-orders.md)
* [Filling orders](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/filling-orders.md)
* [Withdrawing Affiliate Fees](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/withdrawing-affiliate-fees.md)
* [Creating Calldata for Solana](dln-the-debridge-liquidity-network-protocol/interacting-with-smart-contracts/creating-calldata-for-solana.md)
* [Interacting with the API](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/README.md)
* [Quick Start Guide](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/quick-start-guide.md)
* [Getting a Quote](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/getting-a-quote.md)
* [Requesting Order Creation Transaction](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/requesting-order-creation-transaction.md)
* [Submitting an Order Creation Transaction](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/submitting-an-order-creation-transaction.md)
* [Tracking a Status of the Order](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/tracking-a-status-of-the-order.md)
* [Cancelling the Order](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/cancelling-the-order.md)
* [Affiliate fees](dln-the-debridge-liquidity-network-protocol/interacting-with-the-api/affiliate-fees.md)
* [Interacting with the deBridge App](dln-the-debridge-liquidity-network-protocol/interacting-with-the-debridge-app/README.md)
* [Custom Linking](dln-the-debridge-liquidity-network-protocol/interacting-with-the-debridge-app/custom-linking.md)
* [deBridge Widget](dln-the-debridge-liquidity-network-protocol/debridge-widget.md)

## 💸 dePort

Expand All @@ -42,31 +79,6 @@

* [Getting started](debridge-iaas/getting-started.md)

## Contracts

* [📑 Mainnet Addresses](contracts/mainnet-addresses.md)
* [Interfaces](contracts/interfaces/README.md)
* [ICallProxy](contracts/interfaces/ICallProxy.md)
* [IDeBridgeGate](contracts/interfaces/IDeBridgeGate.md)
* [IDeBridgeToken](contracts/interfaces/IDeBridgeToken.md)
* [IDeBridgeTokenDeployer](contracts/interfaces/IDeBridgeTokenDeployer.md)
* [IOraclesManager](contracts/interfaces/IOraclesManager.md)
* [ISignatureVerifier](contracts/interfaces/ISignatureVerifier.md)
* [IWethGate](contracts/interfaces/IWethGate.md)
* [Libraries](contracts/libraries/README.md)
* [Flags](contracts/libraries/Flags.md)
* [Periphery](contracts/periphery/README.md)
* [CallProxy](contracts/periphery/CallProxy.md)
* [DeBridgeToken](contracts/periphery/DeBridgeToken.md)
* [DeBridgeTokenProxy](contracts/periphery/DeBridgeTokenProxy.md)
* [SimpleFeeProxy](contracts/periphery/SimpleFeeProxy.md)
* [Transfers](contracts/transfers/README.md)
* [DeBridgeGate](contracts/transfers/DeBridgeGate.md)
* [DeBridgeTokenDeployer](contracts/transfers/DeBridgeTokenDeployer.md)
* [OraclesManager](contracts/transfers/OraclesManager.md)
* [SignatureVerifier](contracts/transfers/SignatureVerifier.md)
* [WethGate](contracts/transfers/WethGate.md)

## External Links

* [deBridge Use Cases](external-links/debridge-use-cases.md)
Expand Down
2 changes: 0 additions & 2 deletions docs/build-with-debridge/advanced-topics/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/contracts/interfaces/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/contracts/libraries/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/contracts/periphery/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/contracts/transfers/README.md

This file was deleted.

Loading

0 comments on commit e2f266c

Please sign in to comment.