Skip to content

fix typos #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix typos #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8982eb0
fix typo
omahs Dec 28, 2023
08b56f8
fix typos
omahs Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Yellow Network is a project in development. Not all solutions presented in the f
This document hub is currently in the editing stage. come back after Dec 20, 2023 if you'd like to read the new version fully.
{% endhint %}

> "Today, t_rading and speculation are the #1 use case for cryptocurrency, but most trading does not use any benefits of the blockchain. This is about to change."_
> "Today, trading and speculation are the #1 use case for cryptocurrency, but most trading does not use any benefits of the blockchain. This is about to change."_
>
> **– Louis Bellet, CEO of Yellow**

Expand Down
14 changes: 7 additions & 7 deletions design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Mesh network

#### Retail brokers

A small exchange, located on a specific country or region, comply with local regulations. In our network we define brokers as non-custodial business.
A small exchange, located in a specific country or region, complies with local regulations. In our network we define brokers as non-custodial business.

#### Market makers

Market makers are providing liquidity to the network, they create and maintain open orders to allow users to access to the best offers possible. They are getting fees from trades.
Market makers are providing liquidity to the network, they create and maintain open orders to allow users access to the best offers possible. They are getting fees from trades.

#### Exchanges

Expand Down Expand Up @@ -47,11 +47,11 @@ Yellow network allows brokers to peer liquidity from one to another. A broker pe

#### Collateral

Both exchanges have to lock a collateral in order to guaranty they are solvable for the other peer. Different currencies can be used as collateral, a mix of stable coins and major crypto-currencies tokens is probably a good choice for the platform in order to keep a relative stability of this collateral value while the market swings.
Both exchanges have to lock a collateral in order to guarantee they are solvable for the other peer. Different currencies can be used as collateral, a mix of stable coins and major crypto-currencies tokens is probably a good choice for the platform in order to keep a relative stability of this collateral value while the market swings.

#### B2B (Broker to Broker) liquidity channel

Brokers are using a state channel protocol \[@perun2] to keep track of assets owned from one broker to another. This technology allows a secure track of funds without the need of on-chain transaction for every trade. It makes the trading process between two brokers very fast and secure.
Brokers are using a state channel protocol \[@perun2] to keep track of assets owned from one broker to another. This technology allows a secure track of funds without the need for on-chain transaction for every trade. It makes the trading process between two brokers very fast and secure.

To open a state-channel, brokers need to agree on an amount of YELLOW tokens to be used as collateral. Once they have an agreement on the amount and they both deposited the tokens, the state-channel is active and they can start trading.

Expand All @@ -64,7 +64,7 @@ To open a state-channel, brokers need to agree on an amount of YELLOW tokens to
| channel\_nonce | uint64 | Unique identifier of the channel for all participants |
| app\_definition | string | Address of the smart contract of the adjudicator application |
| challenge\_duration | uint64 | |
| app\_data | bytes | See bellow the definition of the app\_data for Yellow Network liquidity channel |
| app\_data | bytes | See below the definition of the app\_data for Yellow Network liquidity channel |
| outcome | bytes | |
| turn\_num | uint64 | Turn number, this number is incrementing at every turn, it allows to easily identify the latest version of a state |
| is\_final | bool | Once true and signed by all participant the channel is closed and the final outcome can be applied on the blockchain safely by any participant |
Expand All @@ -75,11 +75,11 @@ When a user's order matches an order from a peer-broker, the platform will use t

#### Settlement

Every once for a while brokers will perform a settlement process to finally transfer assets owns to each other. A settlement process can be triggered by any broker at any time. A broker can decide to settle if it needs some asset liquidity, to honor a withdrawal request for example. An other reason of triggering a settlement is the value of assets being hold from one to another getting unbalanced, if the difference of assets value between two brokers reach the value of the collateral it's getting urgent for one broker to trigger the settlement.
Every once in a while brokers will perform a settlement process to finally transfer assets owns to each other. A settlement process can be triggered by any broker at any time. A broker can decide to settle if it needs some asset liquidity, to honor a withdrawal request for example. An other reason of triggering a settlement is the value of assets being hold from one to another getting unbalanced, if the difference of assets value between two brokers reach the value of the collateral it's getting urgent for one broker to trigger the settlement.

#### Multi-chain & Multi-custody support

The broker can connect to many custodians solutions, each custody solution have a different list of supported blockchains. The broker will benefit from supported blockchains of his custodies. Once connected to a custody, users will be able to deposit and withdraw funds from all supported blockchains.
The broker can connect to many custodians solutions, each custody solution has a different list of supported blockchains. The broker will benefit from supported blockchains of his custodies. Once connected to a custody, users will be able to deposit and withdraw funds from all supported blockchains.

#### Comparison

Expand Down