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 in Documentation Files #4

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/API/importing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
ChainParams
} from "xp.network";
```
Connecting to the mainntets of all the integrated chains:
Connecting to the mainnets of all the integrated chains:
```javascript
// MAINNET Factory object creation
const mainnetConfig = await ChainFactoryConfigs.MainNet()
Expand All @@ -40,4 +40,4 @@ const testnetFactory: ChainFactory = ChainFactory(
// Switching between the mainnets & the testnets:
const factory: ChainFactory = mainnetFactory;
const CONFIG: Partial<ChainParams> = mainnetConfig;
```
```
2 changes: 1 addition & 1 deletion docs/API/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The JS API library is used by the Bridge UI in the background ensuring that eve

The library was designed to help dApps seamlessly integrate the bridge functionality and use it from the frontends of the existing marketplaces or NFT based games turning them into cross-chain scalable applications.

To transfer NFTs accross networks developers have to take the following steps:
To transfer NFTs across networks developers have to take the following steps:
## Bridging steps

- [x] [1. Installing the library](./installation.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/DigitalSignatures/1.ots.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Specialists distinguish two most widely known types of digital signatures:

## 1.1 LOTS (Lamport One-Time Signature)[^1]

In 1979 Leslie Lamport suggested an improvement of M.Rabin's digital signature algorithm (1978) and introduced the concept of OTS that can be built from any one-way function, for example, a hash function. Lamport defined the one-way function as easy to compute but hard to revert. By contrast, with **RSA** (an algorithm suggested in 1977 by Ron **R**ivers, Adi **S**hamir, and Leonard **A**dleman), LOTS' hash is longer and, thus, believed to be more secure.
In 1979 Leslie Lamport suggested an improvement of M.Rabin's digital signature algorithm (1978) and introduced the concept of OTS that can be built from any one-way function, for example, a hash function. Lamport defined the one-way function as easy to compute but hard to revert. By contrast, with **RSA** (an algorithm suggested in 1977 by Ron **R**ivest, Adi **S**hamir, and Leonard **A**dleman), LOTS' hash is longer and, thus, believed to be more secure.

Since OTS belongs to Asymmetric Cryptography, the first step in using the algorithm is Public & private key pair generation.

Expand Down Expand Up @@ -55,7 +55,7 @@ $$

### 1.1.4 LOTS Signature Verification

Since the public key is a compilation of hashes of the $(X||Y)$ values of the secret key, we can run the signature trough the same hashing algorithm and if the hashes match, the signature is valid.
Since the public key is a compilation of hashes of the $(X||Y)$ values of the secret key, we can run the signature through the same hashing algorithm and if the hashes match, the signature is valid.

$$
hash(SIG_0(X_0)) == hash(X_0) || hash(Y_0) \\
Expand Down Expand Up @@ -146,4 +146,4 @@ OTS can be used quite securely to sign messages only once. However, they cannot

[^1]: https://www.microsoft.com/en-us/research/uploads/prod/2016/12/Constructing-Digital-Signatures-from-a-One-Way-Function.pdf

[^2]: https://huelsing.net/wordpress/wp-content/uploads/2013/05/wotsspr.pdf
[^2]: https://huelsing.net/wordpress/wp-content/uploads/2013/05/wotsspr.pdf
4 changes: 2 additions & 2 deletions docs/Multibridge/relay-validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Verifies the following transactions:

## What types of events do validators listen for?

Validators are responsible for monitoring a number of events and coordinating subsequent actions based on those events. Normal events are known simply as "events" where as events relating to NFTs are known as Unique Events.
Validators are responsible for monitoring a number of events and coordinating subsequent actions based on those events. Normal events are known simply as "events" whereas events relating to NFTs are known as Unique Events.

The following are some examples of the main types of events:

Expand Down Expand Up @@ -263,4 +263,4 @@ for (const chain of chains) {
map[chain.chainNonce] = chain;
listenEvents(chain);
}
```
```
4 changes: 2 additions & 2 deletions docs/Multibridge/substrate-pallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ Transactions on the XP.NETWORK blockchain are executed via a number of LocalActi

## Available local transactions
1. Unfreezing the locked fungible & non-fungible tokens to a designated account in XP.network
2. Transfering wrapped foreign fungible & non-fungible tokens
3. Calling the functions of other smart contracts
2. Transferring wrapped foreign fungible & non-fungible tokens
3. Calling the functions of other smart contracts
4 changes: 2 additions & 2 deletions docs/Multibridge2.0/collection_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Signing happens locally, so there's no danger of the private key compromise.

## Temporary step - Debugging

Becasue the App reliaes on external libraries and they have their dependencies that we cannot get rid of.
Because the App reliaes on external libraries and they have their dependencies that we cannot get rid of.

We've openned an issue an one of such libraries that does not let the App build and launch: https://github.com/LedgerHQ/ledger-live/issues/763

Expand All @@ -92,4 +92,4 @@ import hidFraming from "@ledgerhq/devices/lib/hid-framing";

## Alternatively

Use the following link: https://batch-transfers.bridge.xp.network/
Use the following link: https://batch-transfers.bridge.xp.network/