Skip to content
Merged
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ docsify serve ./docs

## Usage

You can browse the documentation locally or directly on [docs.polkabtc.io](docs.polkabtc.io).
You can browse the documentation locally or directly on [docs.interlay.io](docs.interlay.io).


### Adding content
Expand Down
1 change: 1 addition & 0 deletions docs/_assets/img/InterBTC_Icon_BLK.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_assets/img/InterBTC_Icon_RGB.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_assets/img/background.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_assets/img/developers/components.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_assets/img/interBTC_black.png
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_assets/img/interBTC_black.svg

This file was deleted.

Binary file removed docs/_assets/img/interBTC_color.png
Binary file not shown.
27 changes: 0 additions & 27 deletions docs/_assets/img/interBTC_white.svg

This file was deleted.

4 changes: 2 additions & 2 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- _navbar.md -->

* [Go to App](https://beta.polkabtc.io)
* [:uk:](/)
* [Go to App](https://bridge.interlay.io)
<!-- * [:us:](/) -->
<!-- * [:cn:](/zh-cn/) -->
12 changes: 4 additions & 8 deletions docs/developers/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ At the heart of interBTC lies the BTC Parachain.
The functionality, protocols, and security aspects are all detailed in the specification.
If you want to get started working on interBTC, understand how the system works, and eventually contribute to it, this is the primary starting point.

- [Specification](https://interlay.gitlab.io/polkabtc-spec/)
- [Specification as PDF](https://interlay.gitlab.io/polkabtc-spec/polkabtc-spec.pdf)
- [Specification](https://interlay.gitlab.io/interbtc-spec/)
- [Specification as PDF](https://interlay.gitlab.io/interbtc-spec/interbtc-spec.pdf)
- [Source](https://github.com/interlay/btc-parachain-spec)

### BTC Parachain
Expand All @@ -18,13 +18,9 @@ If you want to get started working on interBTC, understand how the system works,
### Vaults

- [Documentation](https://www.interlay.io/interbtc-clients/)
- [Source](https://github.com/interlay/polkabtc-clients/tree/dev/vault)
- [Source](https://github.com/interlay/interbtc-clients/tree/dev/vault)

### interbtc-js

- [Documentation](https://www.interlay.io/interbtc-js/)
- [Source](https://github.com/interlay/polkabtc-js)

### interbtc-ui

- [Source](https://github.com/interlay/polkabtc-ui)
- [Source](https://github.com/interlay/interbtc-js)
65 changes: 1 addition & 64 deletions docs/developers/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,67 +8,4 @@ The interBTC system consists of a range of different components.

*Overview of interBTC bridge components.*

## JavaScript

Building new apps directly on interBTC is enabled by using a dedicated TypeScript SDK.

### Installation

Follow the instructions at [polkabtc-js](https://github.com/interlay/polkabtc-js).

### Usage

Create an API instance to the interBTC chain with:

```js
import { createPolkabtcAPI } from "@interlay/polkabtc";

const defaultParachainEndpoint = "wss://beta.polkabtc.io/api/parachain";
const isMainnet = false;
const api = await createPolkabtcAPI(defaultParachainEndpoint, isMainnet);
```

You are now able to issue and redeem new interBTC.

### Examples

#### 1. Attach an account

Most actions require you to use an account on the interBTC bridge. Add either a default one or import your own:

```js
keyring = new Keyring({ type: "sr25519" });
alice = keyring.addFromUri("//Alice");
api.setAccount(alice);
```

#### 2. Display existing issue requests

Once you have instantiated the API and attached the account, loading issue requests is as simple as:

```js
const issueRequests = await issueAPI.list();
```

#### 3. Issue interBTC

After you instantiated the interBTC API as described above, you can request to issue interBTC:

```js
// denoted in satoshi
const amount = api.createType("Balance", 100000) as interBTC;
const requestResult = await issueAPI.request(amount);
```

Next, you need to send BTC to the vault. You could use [bitcoinlib-js](https://github.com/bitcoinjs/bitcoinjs-lib) to achieve this programmatically or use the data from the `issueRequest` object to display the Vault's BTC address and the required amount.

After you have sent, the BTC you can execute the request by fetching the required BTC transaction inclusion proof and sending this information to the interBTC bridge:

```js
const btcTxId = await api.btcCore.getTxIdByRecipientAddress(issueRequest.vaultBTCAddress);
await api.issue.execute(requestResult.id, btcTxId);
```

### More Examples

For fully working examples, head over to our [integration tests](https://github.com/interlay/polkabtc-js/tree/master/test/integration). These are automated and fully integrated with Bitcoin test clients and the interBTC bridge.
[interbtc-js](https://raw.githubusercontent.com/interlay/interbtc-js/master/README.md ':include')
Binary file modified docs/favicon.ico
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
subMaxLevel: 2,
loadNavbar: true,
name: 'Docs',
logo: './_assets/img/interBTC_black.svg',
logo: './_assets/img/InterBTC_Icon_BLK.svg',
repo: 'https://github.com/interlay/interbtc-docs',
search: 'auto',
}
Expand Down
26 changes: 13 additions & 13 deletions docs/start/beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Polkadot Council has approved **1300 DOT** treasury funding for the interBTC tes
### Stay up-to-date with the Latest Updates

- Join our [Discord](https://discord.gg/KgCYK3MKSf)
- Follow [interBTC](https://twitter.com/polkaBTC) on Twitter
- Follow [interBTC](https://twitter.com/interbtc) on Twitter
- Follow [Interlay](https://twitter.com/InterlayHQ) on Twitter

## Treasure Hunt (900 DOT)
Expand All @@ -31,24 +31,24 @@ Users must perform a list of actions to receive a small amount of DOT. To claim
1. Get testnet DOT from the interBTC faucet
1. Issue interBTC
1. Redeem interBTC
1. Fill in the user feedback form provided at [https://beta.polkabtc.io/feedback](https://beta.polkabtc.io/feedback)
1. Fill in the user feedback form provided at [https://bridge.interlay.io/feedback](https://bridge.interlay.io/feedback)

### Vault (award: 4 DOT for the first 50, 200 DOT in total)

1. Download, build and run the Vault client [based on the guide](https://docs.polkabtc.io/#/vault/guide)
1. Register as a Vault and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Vault dashboard](https://beta.polkabtc.io/dashboard/vaults))
1. Download, build and run the Vault client [based on the guide](https://docs.interlay.io/#/vault/guide)
1. Register as a Vault and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Vault dashboard](https://bridge.interlay.io/dashboard/vaults))
1. Run the Vault
1. Serve at least 5 issue and 5 redeem requests
1. Maintain an SLA of 99% or higher for at least 24h
1. Fill in the Vault feedback form provided at [https://beta.polkabtc.io/feedback](https://beta.polkabtc.io/feedback)
1. Fill in the Vault feedback form provided at [https://bridge.interlay.io/feedback](https://bridge.interlay.io/feedback)

### Staked Relayer (award: 4 DOT for the first 50, 200 DOT in total)

1. Download, build and run the Staked Relayer client [based on the guide](https://docs.polkabtc.io/#/relayer/guide)
1. Download, build and run the Staked Relayer client [based on the guide](https://docs.interlay.io/#/relayer/guide)
1. Run the Staked Relayer
1. Submit at least 1 Bitcoin testnet block
1. Maintain an SLA of 99% or higher for at least 24h
1. Fill in the Staked Relayer feedback form provided at [https://beta.polkabtc.io/feedback](https://beta.polkabtc.io/feedback)
1. Fill in the Staked Relayer feedback form provided at [https://bridge.interlay.io/feedback](https://bridge.interlay.io/feedback)

## King of the Hill: Vaults and Relayers (200 DOT)

Expand All @@ -59,16 +59,16 @@ In the King of the Hill challenge, the top 10 Vaults and Relayers are rewarded w

### Vaults (award: 150 DOT for the top 5 according to their SLA score starting on June 2, 2021)

1. Download, build and run the Vault client [based on the guide](https://docs.polkabtc.io/#/vault/guide)
1. Register as a Vault and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Vault dashboard](https://beta.polkabtc.io/dashboard/vaults))
1. Download, build and run the Vault client [based on the guide](https://docs.interlay.io/#/vault/guide)
1. Register as a Vault and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Vault dashboard](https://bridge.interlay.io/dashboard/vaults))
1. Run the Vault and automatically earn SLA points
1. Fill in the form to receive DOT: [https://forms.gle/V6LsUb3J9qR6oJCN8](https://forms.gle/V6LsUb3J9qR6oJCN8)
1. Week 1-2: The top 5 Vaults will be selected and a total of 75 DOT is distributed to them each week

### Staked Relayer (award: 50 DOT for the top 5 according to their SLA score starting on June 2, 2021)

1. Download, build and run the Staked Relayer client [based on the guide](https://docs.polkabtc.io/#/relayer/guide)
1. Register as a Staked Relayer and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Relayer dashboard](https://beta.polkabtc.io/dashboard/parachain))
1. Download, build and run the Staked Relayer client [based on the guide](https://docs.interlay.io/#/relayer/guide)
1. Register as a Staked Relayer and provide testnet DOT as collateral (automatically done on starting the client - verify on the [Relayer dashboard](https://bridge.interlay.io/dashboard/parachain))
1. Run the Staked Relayer and automatically earn SLA points
1. Fill in the form to receive DOT: [https://forms.gle/V6LsUb3J9qR6oJCN8](https://forms.gle/V6LsUb3J9qR6oJCN8)
1. Week 1-2: The top 5 Staked Relayers will be selected and a total of 25 DOT is distributed to them each week
Expand All @@ -82,15 +82,15 @@ The lottery will run for four weeks and each week a payout of 50 DOT is made.

### Users

1. Create issue and redeem requests via the [interBTC app](https://beta.polkabtc.io/app) or feel free to automate this process using the [polkabtc js library](https://github.com/interlay/polkabtc-js) (size doesn't matter - create as many as you like to increase your chance of winning)
1. Create issue and redeem requests via the [interBTC app](https://bridge.interlay.io/app) or feel free to automate this process using the [interbtc-js library](https://github.com/interlay/interbtc-js) (size doesn't matter - create as many as you like to increase your chance of winning)
1. Make sure that the requests are completed (issue and redeem requests executed). Only executed requests qualify for the lottery.
1. Fill in the form to receive DOT: [https://forms.gle/V6LsUb3J9qR6oJCN8](https://forms.gle/V6LsUb3J9qR6oJCN8)
1. Week 1-4: Interlay will select one issue and one redeem request at random.
1. For each randomly selected request, a reward of 20 DOT is made.

### Vaults

1. Create replace requests via the [Vault dashboard](https://beta.polkabtc.io/vault) ("Replace my Vault" button)
1. Create replace requests via the [Vault dashboard](https://bridge.interlay.io/vault) ("Replace my Vault" button)
1. Make sure that the requests are at least partially completed (one other vault has accepted your request). Only executed requests qualify for the lottery.
1. Fill in the form to receive DOT: [https://forms.gle/V6LsUb3J9qR6oJCN8](https://forms.gle/V6LsUb3J9qR6oJCN8)
1. Week 1-4: Interlay will select one replace request at random.
Expand Down
4 changes: 2 additions & 2 deletions docs/start/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This will also be the case in production. Since the bridge is decentralized and

There can be two reasons for this:

- **Reached maximum capacity**: If the capacity indicated on the [dashboard](https://beta.polkabtc.io/dashboard) shows that the number of issued interBTC is equal to the capacity, you cannot issue more interBTC. Each interBTC must be backed by 150% worth of DOT collateral and this represents the upper limit.
- **Reached maximum capacity**: If the capacity indicated on the [dashboard](https://bridge.interlay.io/dashboard) shows that the number of issued interBTC is equal to the capacity, you cannot issue more interBTC. Each interBTC must be backed by 150% worth of DOT collateral and this represents the upper limit.
- **Connection to interBTC bridge lost**: In case the connection to the bridge is lost, the UI will fallback to 0 interBTC being able to be issued.

?> Testnet Note: The number of concurrent connections to our chain instances is restricted to monitor the load. Best course of action is to retry after some time/reload the website. We are looking to increase the load.
Expand Down Expand Up @@ -66,4 +66,4 @@ interBTC is based on XCLAIM - a top-tier, peer-reviewed research paper. interBTC

## More questions?

Reach out on [Discord](https://discord.gg/KgCYK3MKSf) or [open an issue](https://github.com/interlay/polkabtc-docs/issues).
Reach out on [Discord](https://discord.gg/KgCYK3MKSf) or [open an issue](https://github.com/interlay/interbtc-docs/issues).
2 changes: 1 addition & 1 deletion docs/start/issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Make sure you have the required [polkadot-js extension and a Bitcoin wallet](sta

## Issue interBTC

### 1. Go to [ beta.polkabtc.io](https://beta.polkabtc.io)
### 1. Go to [ bridge.interlay.io](https://bridge.interlay.io)

The app has 3 tabs: Issue, Redeem, and Transfer. Ensure you are on the Issue tab.

Expand Down
Loading