Skip to content
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.

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

fix: typos, grammar #16

Merged
merged 13 commits into from
Sep 8, 2023
2 changes: 1 addition & 1 deletion content/docs/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ multicolumn = true
RGB FAQ is an external resource maintained by our team which gives a
high-level introduction into RGB and provides a detailed glossary.

<a href="https://rgbfaq.com" class="button button-secondary">Visit FAQ website</a>
<a href="https://www.rgbfaq.com" class="button button-secondary">Visit FAQ website</a>


* ### Videos
Expand Down
6 changes: 3 additions & 3 deletions content/governance/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sort_by = "weight"

Unlike in blockchain smart contract systems, where blockchain governance
severely affects contract governance (contract transactions can be rolled back),
in RGB and client-side validation contracts are immutable, fully governed
in RGB the client-side validation contracts are **immutable**, fully governed
according to the terms specified by contract issuers in contract genesis &
schema and can't be changed/updated via changes to RGB protocol stack.
schema and can't be changed/updated via changes to the RGB protocol stack.

### Blockchain governance model
![Blockchain governance](governance-blockchain.png)
Expand All @@ -16,6 +16,6 @@ schema and can't be changed/updated via changes to RGB protocol stack.
![RGB governance](governance-rgb.png)

RGB is a stack of protocols abstracted into a layered design with different
governance structure and update policy:
governance structures and update policies:

![Governance layers](governance-layers.svg)
2 changes: 1 addition & 1 deletion content/governance/association.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ bg-color = "white"
+++

This organization plays an important role in bootstrapping RGB adoption and
development of RGB ecosystem. It runs as a Swiss non-profit association under
development of the RGB ecosystem. It runs as a Swiss non-profit association under
article 40 of Swiss Civil Codex and governed by its members and member-elected
persons. For the details of organization governance please refer to the
[official website](LNP/BP).
Expand Down
4 changes: 2 additions & 2 deletions content/governance/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ weight = 40
bg-color = "white"
+++

Developers use RGB toolchain, which include compilers, linkers and packet
Developers use the RGB toolchain, which include compilers, linkers and packet
managers. [LNP/BP Standard Association](LNP/BP) currently develops and will be
maintaining one of toolchain implementations, which include **Contractum
maintaining one of toolchain implementations, which include the **Contractum
language** compiler and packager; however alternative toolchains may be
independently created and used by other providers.
2 changes: 1 addition & 1 deletion content/learn/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ introduction of tokens.

<a href="/program" class="button button-secondary">Learn to program</a>

[FAQ]: https://rgbfaq.com
[FAQ]: https://www.rgbfaq.com
[YouTube channel]: https://youtube.com/LNP-BP
[RGB whitepaper]: https://blackpaper.rgb.tech
16 changes: 8 additions & 8 deletions content/program/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@ sort_by = "weight"

RGB is a full-fledged smart contract system which operates on top of Bitcoin
and Lightning network. If you think about blockchain as a settlement layer and
Lightning as a scaling layers, *RGB is the programmability layer*, finally
Lightning as a scaling layer, *RGB is the programmability layer*, finally
adding to the first and most censorship-resistant cryptographic-based store of
value properties which were absent and desired for many years.

RGB achieves this through a separation of abstraction layers: the bitcoin
blockchain (layer 1) becomes a cryptographic commitment layer, which holds
*no data* but a compact commitments to the smart contract state, which is
now kept off-chain. These commitments do not occupy block space, since they
*no data* but compact commitments to the smart contract state, which is
kept off-chain. These commitments do not occupy block space, since they
are kept inside taproot tree and not directly visible on-chain.

Such approach also allows RGB to operate on top of the Lightning network, since
it can work with any bitcoin transaction, including transactions incorporated
into a channel. RGB scripts and state fully exists in the client-side world,
not seen from outside (hence privacy) - and are not required to be validated by
anyone else than the contract participants (hence scalability).
into a channel. RGB scripts and state fully exist in the client-side world, are
not seen from the outside (hence privacy) - and are not required to be validated by
anyone other than the contract participants (hence scalability).

RGB allows Bitcoin to pass beyond the limitations of [CIA triad] via achieving
different properties on different layers:
RGB allows Bitcoin to pass beyond the limitations of the [CIA triad] (confidentiality,
integrity, and availability) by achieving different properties on different layers:
* **Blockchain** provides integrity & availability;
* **Lightning network** – integrity & confidentiality;
* **RGB** – confidentiality & availability.
Expand Down
24 changes: 12 additions & 12 deletions content/program/components.md
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix: typos, grammar **

Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,38 @@ anchor = "components"
+++

In RGB, there is no such thing as "program a smart contract"; instead, contracts
themselves are issued with no code. This helps to simplify life of asset
themselves are issued with no code. This helps to simplify the life of asset
issuers and normies, who just need to issue a token, create their self-sovereign
identity, run a DAO etc.

This is achieved through separation of concerns, where the development work is
kept outside contracts, thanks to things named **schema** and **interface**.
kept outside contracts, thanks to things called **schema** and **interface**.

* ### Contract

The contract is a contract genesis plus a history of operations on the
contract. Together they are used by RGB to compute a deterministic contract
state. To create a contract means to issue a contract genesis, which
requires no code at all. Contract issuer just needs to pick a **schema**
which has all features he needs in a contract – and use it during the
issuance. If the schema with the required properties doesn't exist, issuer
can hire a developer to implement such schema.
requires no code at all. The Contract issuer just needs to pick a **schema**
which has all features needed in a contract – and use it during the
issuance. If the schema with the required properties doesn't exist, the issuer
can hire a developer to implement such a schema.

* ### Schema

If you think in terms of objective-oriented programming (OOP), contract is
If you think in terms of object-oriented programming (OOP), a contract is
an *instance* of some *class*, and in RGB terms this *class* is named
**schema**. Schema contains all contract business logic, scripts,
**schema**. Schema contains all the contract business logic, scripts,
definitions of state types (owned and global), allowed operations, rules
for validation, data type system etc. Schema by its nature is declarative,
this it can be easily read or written with rust macros, YAML, TOML and other
declarative languages. Once created, schema may be used by many contracts
it can be easily read or written with Rust macros, YAML, TOML and other
declarative languages. Once created, a schema may be used by many contracts
of the same type.

* ### Interface

An interface defines a way how user-facing software (wallets etc) can
interact with a contract. Interface provides **semantic** information about
An interface defines how a user-facing software (wallets etc) can
interact with a contract. Interfaces provide **semantic** information about
the contract and defines how its state can be presented to the user.
If one can compare schema to a *class* in OOP, than **contract interface**
should be compared to Java *interface* or Rust *trait*. As classes can
Expand Down
8 changes: 4 additions & 4 deletions content/software/exchanges.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ anchor = "exchanges"
bg-color = "red"
+++

A number of exchanges has announced their plans to support RGB. These include
large players as Bitfinex, HodlHodl, as well as new startups, created around
A number of exchanges have announced their plans to support RGB. These include
large players as: Bitfinex, HodlHodl, as well as new startups, created around
RGB, like ColorShift. We will update this section once the first
exchanges will start trading RGB assets.
exchanges start trading RGB assets.

Server teams are also working on providing DEX facilities for trading RGB assets
on lightning. Most of these teams are working in the stealth mode.
on lightning. Most of these teams are working in private.
8 changes: 4 additions & 4 deletions content/software/registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ bg-color = "purple"

[RGBEx.io](rgbex.io) is the first resource which allows contract issuers
to anonymously list their assets and contracts. It doesn't require any
registration and operates with a public keys and signatures.
registration and operates with public keys and signatures.

* ### [Storm]

[Storm] is a decentralized data network created by
[LNP/BP Standards Association][LNP/BP], the creators of RGB protocol.
You may store your assets in Lightning network and access them in fully
You may store your assets in the Lightning Network and access them in fully
decentralized and censorship-resistant way.

* ### [Schemata registry](https://github.com/RGB-WG/schemata-registry)

Schemata registry run by [LNP/BP Standards Association][LNP/BP] lists
known schema and interfaces for RGB contracts. Schema is a "template" which
known schema and interfaces for RGB contracts. A schema is a "template" which
simplifies creation of contracts, such that issuers do not need to learn
programming.

Expand All @@ -32,4 +32,4 @@ You can learn more about governance of the different registries in our

[LNP/BP]: https://lnp-bp.org
[Storm]: https://github.com/Storm-WG
[governance]: /governance
[governance]: /governance
16 changes: 8 additions & 8 deletions content/software/wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ anchor = "wallets"
bg-color = "green"
+++

RGB wallets are developed by community and independent vendors. Please keep
RGB wallets are developed by the community and independent vendors. Please keep
in mind that there is no "official" RGB GUI wallet.

**NB: All existing wallets were not yet updated to the latest RGB protocol
version v0.10 and are not compatible with the modern RGB contracts. If you are
interested in trying the new RGB v0.10 features please use [command-line tool].**
**NB: All existing wallets are not yet updated to the latest RGB protocol
version v0.10 and are not compatible with modern RGB contracts. If you are
interested in trying the new RGB v0.10 features please use the [command-line tool].**

* ### [MyCitadel](https://mycitadel.io)

The first GUI wallet supporting RGB, created back in 2021 by people who
developed RGB. It provides cross-platform desktop wallet and iOS/iPad
wallet. Mobile wallet allows to work with fungible RGB assets.
The first GUI wallet supporting RGB, was created back in 2021 by people who
developed RGB. It provides a cross-platform desktop wallet and an iOS/iPad
wallet. Mobile wallets are able to work with fungible RGB assets.

* ### [BitMask](https://bitmask.app)

Expand All @@ -28,7 +28,7 @@ interested in trying the new RGB v0.10 features please use [command-line tool].*

* ### [Iris](https://play.google.com/store/apps/details?id=com.iriswallet.testnet&pli=1)

The first Android wallet made by team at [Bitfinex](https://bitfinex.com)
The first Android wallet made by the team at [Bitfinex](https://bitfinex.com)
working on RGB integration and RGB-related tools. Supports both fungible
and non-fungible assets.

Expand Down
16 changes: 8 additions & 8 deletions content/use.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ title = "Use RGB"
Install one of the wallets supporting RGB and start using RGB assets or interact
with RGB contracts.

<a href="/software#wallets" class="button button-secondary">Check wallets</a>
<a href="/content/software#wallets" class="button button-secondary">Check wallets</a>

* ### Trade

Several exchanges already support RGB assets; use one of them to start trading
existing assets.

<a href="/software#exchanges" class="button button-secondary">Check exchanges</a>
<a href="/content/software#exchanges" class="button button-secondary">Check exchanges</a>

* ### Issue

Issuing assets, NFTs and many other standard RGB contracts doesn't require
programming skills.

<a href="/power-user/#issue" class="button button-secondary">Issuer guides</a>
<a href="/content/power-user/#issue" class="button button-secondary">Issuer guides</a>

<!--
* ### Earn

Join one of the existing liquidity pools for DEXes and start
earning money.

<a href="/software#pools" class="button button-secondary">Check pools</a>
<a href="/content/software#pools" class="button button-secondary">Check pools</a>
-->

Install any of the existing [RGB wallets] and start using RGB today.
Expand All @@ -41,8 +41,8 @@ server or in a [private cloud].
If you are looking at integrating RGB into your software, check our
[integration page][SDKs].

[RGB wallets]: /software#wallets
[RGB command-line]: /install#rgb
[RGB Node]: /install#node
[SDKs]: /integrate
[RGB wallets]: /content/software#wallets
[RGB command-line]: /content/install#rgb
[RGB Node]: /content/install#node
[SDKs]: /content/integrate
[private cloud]: https://mycitadel.io/cloud
6 changes: 3 additions & 3 deletions content/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ title = "Why RGB?"

No chain analysis is possible due to the absence of a transaction graph in
blockchain. RGB uses zero-knowledge to protect the history of a fungible state.
With RGB, user is always in-charge what and when to disclosure parts of the
history and state, if needed.
With RGB, the user is always in-charge of when, and what parts of the
history and state to disclose, if needed.

* ### Bitcoin & Lightning

RGB is a native member of Bitcoin and Lightning network ecosystem, bringing
RGB is a native member of Bitcoin and the Lightning Network ecosystem, bringing
rich smart contracts in a scalable way to the World's most secure and
censorship-resistant cryptocurrency.