Skip to content

Commit

Permalink
Merge pull request #345 from criadoperez/fix/20231213
Browse files Browse the repository at this point in the history
Typos in documentation
  • Loading branch information
sander2 authored Feb 20, 2024
2 parents 14b925e + 94852d7 commit 3411a10
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/about/research.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Decentralized Finance (DeFi), a blockchain powered peer-to-peer financial system
</details>

- Werner S, Perez D, Gudgeon L, Klages-Mundt A, **Harz D**, Knottenbelt WJ
- In colaboration with Imperial College London, Cornell University
- In collaboration with Imperial College London, Cornell University

### [Stablecoins 2.0: Economic Foundations and Risk-based Models](https://arxiv.org/pdf/2006.12388.pdf)
<details>
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ In a simplified view, the Interlay and Kintsugi networks have four core roles:
- **BTC Bridge**: The bridge is based on the [XCLAIM](https://xclaim.io) protocol. A specification of the implemented protocol can be found [here](https://spec.interlay.io). The on-chain implementation is split up across multiple pallets including [btc-relay](https://github.com/interlay/interbtc/tree/master/crates/btc-relay), [issue](https://github.com/interlay/interbtc/tree/master/crates/issue), [redeem](https://github.com/interlay/interbtc/tree/master/crates/redeem), [replace](https://github.com/interlay/interbtc/tree/master/crates/replace), [vault registry](https://github.com/interlay/interbtc/tree/master/crates/vault-registry), [nomination](https://github.com/interlay/interbtc/tree/master/crates/nomination), [fee](https://github.com/interlay/interbtc/tree/master/crates/fee),
- **Oracle Network**: The oracles consists of a [pallet in the runtime](https://github.com/interlay/interbtc/tree/master/crates/oracle) and off-chain oracle clients.
- **Multi-chain connectors**
- *Polkadot/Kusama/HydraDX/Moonbeam...*: Assets and cross-chain interactions are enabled by [XCM](https://medium.com/polkadot-network/xcm-the-cross-consensus-message-format-3b77b1373392) with a homogenous consensus security provided by the Polkadot and Kusama relay chains to facility communication across all Polkadot and Kusama parachains.
- *Cosmos*: [IBC](https://ibcprotocol.org/) allows transfering of assets and other cross-chain interactions in the Cosmos ecosystem and any chain that enables IBC. It follows a heterogenous security model with each chain providing their own consensus security.
- *Polkadot/Kusama/HydraDX/Moonbeam...*: Assets and cross-chain interactions are enabled by [XCM](https://medium.com/polkadot-network/xcm-the-cross-consensus-message-format-3b77b1373392) with a homogeneous consensus security provided by the Polkadot and Kusama relay chains to facility communication across all Polkadot and Kusama parachains.
- *Cosmos*: [IBC](https://ibcprotocol.org/) allows transferring of assets and other cross-chain interactions in the Cosmos ecosystem and any chain that enables IBC. It follows a heterogeneous security model with each chain providing their own consensus security.
- *Ethereum and other EVM chains*: Bridges to Ethereum, other EVM chains, and connected L2s are a work in progress. Initial bridging will be enabled through a centralized provider such as [Wormhole](https://wormholebridge.com/). The goal is to switch to the decentralized [Snowbridge](https://snowbridge.network/) bridge once it is ready.

### DeFi
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/interbtc.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Read more about the collateral system and re-balancing in the [Collateral sectio
Vaults may be liquidated, i.e., have their collateral slashed and used to re-balance the system or to reimburse users, if:

- they fail to execute redeem requests,
- or are severly under-collateralized
- or are severely under-collateralized

Read more about liquidations in the [Liquidations section of the Vault page](/vault/overview?id=liquidations).

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/interlay-101.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Substrate chain, secured by Polkadot's PoS as a parachain. 12-second block times
- [Talisman (browser)](https://talisman.xyz/)
- [Nova (mobile)](https://novawallet.io/)
- [Fearless (mobile)](https://fearlesswallet.io/)
- [Subscan multisig (multisig tool, needs another brower wallet)](https://multisig.subscan.io/)
- [Subscan multisig (multisig tool, needs another browser wallet)](https://multisig.subscan.io/)
- Ledger (hardware, coming soon)
- [Testnet](https://testnet.interlay.io/)

Expand All @@ -67,6 +67,6 @@ Canary network (experimental network with real economic value). Substrate chain,
- [Talisman (browser)](https://talisman.xyz/)
- [Nova (mobile)](https://novawallet.io/)
- [Fearless (mobile)](https://fearlesswallet.io/)
- [Subscan multisig (multisig tool, needs another brower wallet)](https://multisig.subscan.io/)
- [Subscan multisig (multisig tool, needs another browser wallet)](https://multisig.subscan.io/)
- Ledger (hardware, coming soon)
- [Testnet](https://kintnet.interlay.io/)
8 changes: 4 additions & 4 deletions docs/guides/bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ Use your Bitcoin wallet to transfer the specified `amount` to the given `address

You can find your issue request in the table below the issue form.

![Tansactions page](../_assets/img/guide/bridge-issue-table.png)
![Transactions page](../_assets/img/guide/bridge-issue-table.png)

Find your pending issue request in the **"Issue Requests"** table and click on it. There you will find the details of the Bitcoin transaction you need to make.

![Tansactions page](../_assets/img/guide/bridge-issue-tx-request.png)
![Transactions page](../_assets/img/guide/bridge-issue-tx-request.png)

?> Optional: you can use a hardware wallet

Expand Down Expand Up @@ -168,7 +168,7 @@ Once you've made the payment, the app will automatically locate your transaction

If you sent more BTC than was necessary, one of two things will happen.

1. If the vault had sufficient capacity to accomodate your larger request, it will be executed automatically, and no further action on your part is required.
1. If the vault had sufficient capacity to accommodate your larger request, it will be executed automatically, and no further action on your part is required.
2. If the vault does not have sufficient capacity, then a **Refund request** will be automatically created, giving the vault the option to return the excess BTC to you. However, since IBTC is a decentralized system, there is no way to ensure that the vault fulfils this.

**I've accidentally sent less BTC than required**
Expand All @@ -185,7 +185,7 @@ You can check the status of your issue request in the Transactions view in the *

If your Bitcoin transaction has enough confirmations but has not been executed by a Vault yet, click on the issue request that is "Pending". This will open a modal, where you will see a **"Claim KBTC"** (or **"Claim IBTC"**) button. To finalize the Issue process and claim your IBTC/KBTC, either wait for a Vault to auto-execute your request, or click **"Claim"** yourself.

![Tansactions page](../_assets/img/guide/bridge-issue-complete-tx.png)
![Transactions page](../_assets/img/guide/bridge-issue-complete-tx.png)

## Redeem

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ This involves two steps:

?> We recommend you reach out the community on [Discord](https://discord.gg/interlay) in the #product-feedback channel before creating a proposal.

#### Option A for simple proposals: Submiting a Preimage and a Proposal in two transactions
#### Option A for simple proposals: Submitting a Preimage and a Proposal in two transactions

##### 1. Create and submit a Preimage

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/lending.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The above is implemented in `getUndercollateralizedBorrowers` in the [interbtc-a
1. Select `Token` for INTR, DOT, IBTC, KINT, KBTC, KSM
2. Select `ForeignAsset` for other tokens
1. see [here](developers/assets?id=foreignasset-assets) for `id:token` mapping
5. **repayAmount:** `amount_to_be_repaid`. The maxium that can be repaid is the `shortfall` equivalent of one of the collateral currencies as described in [discover undercollateralized loans](#_1-discover-under-collateralized-loans). Note that the amount depends on the number of decimals the token uses.
5. **repayAmount:** `amount_to_be_repaid`. The maximum that can be repaid is the `shortfall` equivalent of one of the collateral currencies as described in [discover undercollateralized loans](#_1-discover-under-collateralized-loans). Note that the amount depends on the number of decimals the token uses.
6. **collateralAssetId:** The currency to receive in exchange for liquidating the borrower's loan. The liquidation premium is also paid in this currency. Note that this currency has to be one of the collateral currencies used by the liquidated borrower (as described [above](#_1-discover-under-collateralized-loans)). Also note that while `collateralAssetId` represents the underlying currency of a lending market (e.g. KBTC), the liquidator receives its qToken version instead (e.g., qKBTC), which can be redeemed for KBTC from the lending market (see [withdraw collateral](#_7-withdraw-a-deposit)).
1. Select `Token` for INTR, DOT, IBTC, KINT, KBTC, KSM
2. Select `ForeignAsset` for other tokens
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/stake.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Make sure you connect to the correct parachain in [polkadot.js.org/apps](https:/

#### 2. Check locked KINT/INTR

- Go to Developer -> Chain Sate -> escrow -> locked
- Go to Developer -> Chain State -> escrow -> locked
- The `amount` is the KINT locked in planck KINT
- The `end` is the block number at which all KINT can be withdrawn

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/wallets-explorers.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Supports Android and iOS.

#### Ledger (soon)

The Interlay Ledger app is currenty under review and will appear in the Ledger Live store soon.
The Interlay Ledger app is currently under review and will appear in the Ledger Live store soon.

The Kintsugi Ledger app is being developed.

Expand Down
8 changes: 4 additions & 4 deletions docs/vault/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ The threshold is an optional parameter - submitting with an empty threshold will

Including this parameter will instead set a custom threshold, provided it is higher than the default global one. Enter a number equal to the percentage (e.g., 300%) multiplied by 10^16 (e.g, 3000000000000000000).

### Activate/Deactive the Vault for new Issue Requests
### Activate/Deactivate the Vault for new Issue Requests

You can decide if your Vault should accept new issue requests by users.

Expand All @@ -261,7 +261,7 @@ You can decide if your Vault should accept new issue requests by users.

If you don't use the full [monitoring](#monitoring) described below, you should still check once in a while if your Vault client has equal or more BTC in its Bitcoin wallet than the amount of BTC locked on the Interlay or Kintsugi chains. You can compare the two as follows:

1. Navigate to your Vault dashboard and check the "Remaining `IBTC/KBTC` capacity". This gives you the amount of `IBTC/KBTC` that can minted, as well how much % of the overall vault amount that it represents. In the example bellow, the vault can still mint approx. `0.4 IBTC`.
1. Navigate to your Vault dashboard and check the "Remaining `IBTC/KBTC` capacity". This gives you the amount of `IBTC/KBTC` that can minted, as well how much % of the overall vault amount that it represents. In the example below, the vault can still mint approx. `0.4 IBTC`.

![BTC_locked](../_assets/img/guide/vault-guide-capacity.png)\
2. Connect to the system running the Bitcoin node for your Vault client. You can list the BTC balance of the `DOT/IBTC` Vault by running the following command on the CLI with the keyname you specified when running the Vault client (from the [installation instructions](vault/installation?id=_5-start-the-vault-client)):
Expand All @@ -279,7 +279,7 @@ $ bitcoin-cli -rpcwallet=0x0e5aabe5ff862d66bcba0912bf1b3d4364df0eeec0a8137704e2c

In the example given here, the Vault client is healthy: the Vault client has `7.8678` BTC in its Bitcoin wallet and the Interlay chain assumes that it has `7.85948385` BTC locked. That means, even if the Vault is requested to return all BTC, it will have enough BTC to fulfill those requests.

?> If you are unsure about the Bitcoin wallets or you used an alternative for specifiying the Vault keyfile, you can run `bitcoin-cli listwalletdir` to see all your Vault wallets. You can then insert each item of the returned rpc wallets to check their balance.
?> If you are unsure about the Bitcoin wallets or you used an alternative for specifying the Vault keyfile, you can run `bitcoin-cli listwalletdir` to see all your Vault wallets. You can then insert each item of the returned rpc wallets to check their balance.

### What if my BTC balance in the Bitcoin wallet is higher than the BTC Locked on the App Dashboard?

Expand Down Expand Up @@ -314,7 +314,7 @@ This will return a new address for your Vault. You can then use any Bitcoin wall

## Setting an Identity

All networks inlcude the `identity` pallet. This allows anyone to set an identity. Follow the guide here: https://support.polkadot.network/support/solutions/articles/65000181981-how-to-set-and-clear-an-identity.
All networks include the `identity` pallet. This allows anyone to set an identity. Follow the guide here: https://support.polkadot.network/support/solutions/articles/65000181981-how-to-set-and-clear-an-identity.

## Self-Minting

Expand Down
2 changes: 1 addition & 1 deletion docs/vault/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Please check the [README](https://github.com/interlay/interbtc-clients/tree/mast

Move the Runner binary into your `$PATH`.

Pass Vault CLI arguments as positional arguments (preceeded by double dashes: `--`), after passing the command options of the runner executable.
Pass Vault CLI arguments as positional arguments (preceded by double dashes: `--`), after passing the command options of the runner executable.

<!-- tabs:start -->
#### **Testnet (Kintsugi)**
Expand Down
4 changes: 2 additions & 2 deletions docs/vault/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,10 +219,10 @@ Where `Secure Collateral Threshold = 1.5` (`150%`) according to our example.

### Vault-Level Collateral Re-balancing

To protect against short and long term exchange rate fluctuations, Vaults are *adviced to keep their collateralization rate up to date*.
To protect against short and long term exchange rate fluctuations, Vaults are *advised to keep their collateralization rate up to date*.
This is achieved in three ways:

- **Increase Collateral** - *instant collateral increase*: the Vault can add more collateral to the system. This increases the collateralization immediatly.
- **Increase Collateral** - *instant collateral increase*: the Vault can add more collateral to the system. This increases the collateralization immediately.
- **Redeem** - *collateral increase after 1 to 48 hours* (up to the redeem period): if users redeem with the Vault, the collateralization ratio increases. However, the collateral only increases when the redeem request is executed. The lower bound for this are the required Bitcoin and parachain confirmation. In practice, it will take at least 1 hour until such a request is processed. The Vault can also maintain an IBTC/KBTC reserve and execute self-redeems for quick rebalancing.
- **Replace** - *possible collateral increase*: A Vault can request to be replaced by another Vault. By sending such a request to the parachain, the Vault offers other Vaults to take over the locked BTC. This strategy should work well when there is free capacity to issue new BTC in the system as Vaults will try to maximize their locked BTC to increase their share of fees and block rewards. However, there is no guarantee that a Vault will accept the replace request. Especially, when the bridge has little to no capacity to issue new BTC all Vaults are saturated and it is unlikely that other Vaults will accept the replace request.

Expand Down

0 comments on commit 3411a10

Please sign in to comment.