diff --git a/README.md b/README.md index ed266273..cfa3c2be 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_assets/img/InterBTC_Icon_BLK.svg b/docs/_assets/img/InterBTC_Icon_BLK.svg new file mode 100644 index 00000000..78b68cf7 --- /dev/null +++ b/docs/_assets/img/InterBTC_Icon_BLK.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_assets/img/InterBTC_Icon_RGB.svg b/docs/_assets/img/InterBTC_Icon_RGB.svg new file mode 100644 index 00000000..23f4519b --- /dev/null +++ b/docs/_assets/img/InterBTC_Icon_RGB.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_assets/img/background.png b/docs/_assets/img/background.png deleted file mode 100644 index 5accc83c..00000000 Binary files a/docs/_assets/img/background.png and /dev/null differ diff --git a/docs/_assets/img/developers/components.svg b/docs/_assets/img/developers/components.svg index feb7dffe..7e610298 100644 --- a/docs/_assets/img/developers/components.svg +++ b/docs/_assets/img/developers/components.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/_assets/img/interBTC_black.png b/docs/_assets/img/interBTC_black.png deleted file mode 100644 index 73efbf15..00000000 Binary files a/docs/_assets/img/interBTC_black.png and /dev/null differ diff --git a/docs/_assets/img/interBTC_black.svg b/docs/_assets/img/interBTC_black.svg deleted file mode 100644 index f038b7de..00000000 --- a/docs/_assets/img/interBTC_black.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/_assets/img/interBTC_color.png b/docs/_assets/img/interBTC_color.png deleted file mode 100644 index 1601501f..00000000 Binary files a/docs/_assets/img/interBTC_color.png and /dev/null differ diff --git a/docs/_assets/img/interBTC_white.svg b/docs/_assets/img/interBTC_white.svg deleted file mode 100644 index a3f0f7b8..00000000 --- a/docs/_assets/img/interBTC_white.svg +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - diff --git a/docs/_navbar.md b/docs/_navbar.md index 792ce79f..b41d4c0b 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,5 +1,5 @@ -* [Go to App](https://beta.polkabtc.io) -* [:uk:](/) +* [Go to App](https://bridge.interlay.io) + diff --git a/docs/developers/documentation.md b/docs/developers/documentation.md index c66594e7..1c2ebf68 100644 --- a/docs/developers/documentation.md +++ b/docs/developers/documentation.md @@ -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 @@ -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) diff --git a/docs/developers/integration.md b/docs/developers/integration.md index 1047e65a..c1ffd006 100644 --- a/docs/developers/integration.md +++ b/docs/developers/integration.md @@ -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') diff --git a/docs/favicon.ico b/docs/favicon.ico index ae54d079..a8c4042d 100644 Binary files a/docs/favicon.ico and b/docs/favicon.ico differ diff --git a/docs/index.html b/docs/index.html index 65006fed..1fb5f0e1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -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', } diff --git a/docs/start/beta.md b/docs/start/beta.md index ce458642..071632ff 100644 --- a/docs/start/beta.md +++ b/docs/start/beta.md @@ -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) @@ -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) @@ -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 @@ -82,7 +82,7 @@ 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. @@ -90,7 +90,7 @@ The lottery will run for four weeks and each week a payout of 50 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. diff --git a/docs/start/faq.md b/docs/start/faq.md index 5126d8a5..de76d52d 100644 --- a/docs/start/faq.md +++ b/docs/start/faq.md @@ -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. @@ -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). diff --git a/docs/start/issue.md b/docs/start/issue.md index 63ea23c1..07d39577 100644 --- a/docs/start/issue.md +++ b/docs/start/issue.md @@ -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. diff --git a/docs/start/overview.md b/docs/start/overview.md index 422e9a19..7a8d7f03 100644 --- a/docs/start/overview.md +++ b/docs/start/overview.md @@ -10,7 +10,7 @@ Funded by a [Web3 Foundation grant](https://web3.foundation/grants/), the BTC-Pa - [Polkadot's blog post explaining interBTC](https://polkadot.network/bitcoin-is-coming-to-polkadot/) -- [BTC Parachain specification](https://interlay.gitlab.io/polkabtc-spec/) +- [BTC Parachain specification](https://interlay.gitlab.io/interbtc-spec/) - [BTC Parachain open-source code](https://github.com/interlay/btc-parachain) diff --git a/docs/start/prereq.md b/docs/start/prereq.md index 7340cfa6..a9882668 100644 --- a/docs/start/prereq.md +++ b/docs/start/prereq.md @@ -25,7 +25,7 @@ You can also use your hardware wallet. The following are tested and have Bitcoin ### 2. Getting testnet BTC Make sure you have at least some tBTC in your wallet. -You can get testnet BTC by clicking on the faucet link in the top bar of beta.polkabtc.io, or from one of the following faucets: +You can get testnet BTC by clicking on the faucet link in the top bar of bridge.interlay.io, or from one of the following faucets: - [https://testnet-faucet.mempool.co/](https://testnet-faucet.mempool.co/) - [https://bitcoinfaucet.uo1.net/](https://bitcoinfaucet.uo1.net/) @@ -39,13 +39,13 @@ You will need the polkadot-js browser extension to test interBTC. 1. Install the polkadot-js extension in your browser: [https://github.com/polkadot-js/extension](https://github.com/polkadot-js/extension). 2. Create a new account. -3. Connect account to polkabtc.io via the polkadot-js pop-up. +3. Connect account to bridge.interlay.io via the polkadot-js pop-up. -?> Please make sure to first create an account before connecting your wallet to polkabtc.io!. +?> Please make sure to first create an account before connecting your wallet to bridge.interlay.io!. ### 4. Getting testnet DOT -You can get testnet DOT by clicking on the faucet link in the top bar of beta.polkabtc.io. +You can get testnet DOT by clicking on the faucet link in the top bar of bridge.interlay.io. !> **Note:** these testnet DOT are only usable on interBTC. They are **not real DOT and have no economic value**! diff --git a/docs/start/redeem.md b/docs/start/redeem.md index 90edba76..2a289ff4 100644 --- a/docs/start/redeem.md +++ b/docs/start/redeem.md @@ -19,7 +19,7 @@ Make sure you have the required [polkadot-js extension and a Bitcoin wallet](sta ## Redeem 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 Redeem tab. diff --git a/docs/vault/faq.md b/docs/vault/faq.md index f3d6adc5..82b4c914 100644 --- a/docs/vault/faq.md +++ b/docs/vault/faq.md @@ -60,7 +60,7 @@ The Vault client uses a separate wallet file, specified upon start-up, which is ### How are deposit addresses generated? -Each time a user requests to issue new interBTC, the interBTC bridge uses the master key of the selected Vault to derive Bitcoin addresses (controlled by this Vault) via an on [on-chain key derivation scheme](https://interlay.gitlab.io/polkabtc-spec/security_performance/security-analysis.html). This address is used by the user for the BTC deposit. +Each time a user requests to issue new interBTC, the interBTC bridge uses the master key of the selected Vault to derive Bitcoin addresses (controlled by this Vault) via an on [on-chain key derivation scheme](https://interlay.gitlab.io/interbtc-spec/security_performance/security-analysis.html). This address is used by the user for the BTC deposit. ### What if all Relayers go offline? diff --git a/docs/vault/guide.md b/docs/vault/guide.md index 978c6cb0..dbae030a 100644 --- a/docs/vault/guide.md +++ b/docs/vault/guide.md @@ -30,7 +30,7 @@ Setup the Vault client using docker-compose. Best if you want to quickly try out ```shell mkdir vault && cd vault -wget https://raw.githubusercontent.com/interlay/polkabtc-docs/master/scripts/vault/docker-compose.yml +wget https://raw.githubusercontent.com/interlay/interbtc-docs/master/scripts/vault/docker-compose.yml ``` ### 2. Add your Polkadot account to use with your Vault @@ -110,7 +110,7 @@ mkdir vault && cd vault Download the vault binary: ```shell -wget https://github.com/interlay/polkabtc-clients/releases/download/0.7.11/vault +wget https://github.com/interlay/interbtc-clients/releases/download/0.7.11/vault ``` Make the binary executable: @@ -145,29 +145,29 @@ If the Vault spends funds from another wallet this may be marked as theft. ?> Some of the most common Linux systems support this approach (see [systemd](https://en.wikipedia.org/wiki/Systemd)). ```shell -wget https://raw.githubusercontent.com/interlay/polkabtc-docs/master/scripts/vault/setup -wget https://raw.githubusercontent.com/interlay/polkabtc-docs/master/scripts/vault/polkabtc-vault.service +wget https://raw.githubusercontent.com/interlay/interbtc-docs/master/scripts/vault/setup +wget https://raw.githubusercontent.com/interlay/interbtc-docs/master/scripts/vault/interbtc-vault.service chmod +x ./setup && sudo ./setup sudo systemctl daemon-reload -sudo systemctl start polkabtc-vault.service +sudo systemctl start interbtc-vault.service ``` You can then check the status of your service by running: ```shell -journalctl --follow _SYSTEMD_UNIT=polkabtc-vault.service +journalctl --follow _SYSTEMD_UNIT=interbtc-vault.service ``` Or by streaming the logs to the `vault.log` file in the current directory: ```shell -journalctl --follow _SYSTEMD_UNIT=polkabtc-vault.service &> vault.log +journalctl --follow _SYSTEMD_UNIT=interbtc-vault.service &> vault.log ``` To stop the service, run: ```shell -sudo systemctl stop polkabtc-vault.service +sudo systemctl stop interbtc-vault.service ``` ### 5.B. OPTIONAL: Start the Vault client directly @@ -218,8 +218,8 @@ bitcoind -testnet -server -par=1 -maxuploadtarget=200 -blocksonly -rpcuser=rpcus Clone the Vault code, checkout release `0.7.11`, and build the client: ```shell -git clone git@github.com:interlay/polkabtc-clients.git -cd polkabtc-clients +git clone git@github.com:interlay/interbtc-clients.git +cd interbtc-clients git checkout 0.7.11 cargo build -p vault ``` @@ -258,21 +258,21 @@ RUST_LOG=info cargo run -p vault -- \ --bitcoin-rpc-pass rpcpassword \ --keyfile keyfile.json \ --keyname interbtcvault \ - --auto-register-with-faucet-url 'https://beta.polkabtc.io/api/faucet' \ - --telemetry-url 'https://beta.polkabtc.io/api/telemetry' \ - --btc-parachain-url 'wss://beta.polkabtc.io/api/parachain' \ + --auto-register-with-faucet-url 'https://bridge.interlay.io/api/faucet' \ + --telemetry-url 'https://bridge.interlay.io/api/telemetry' \ + --btc-parachain-url 'wss://bridge.interlay.io/api/parachain' \ --network=testnet ``` ### For a local development setup, check the README -Go to the Vault client [README](https://github.com/interlay/polkabtc-clients/tree/master/vault). +Go to the Vault client [README](https://github.com/interlay/interbtc-clients/tree/master/vault). ## Upgrading -We will announce on public channels when a new release is made available for the Vault client. The changelog and binaries will be published on the [release page](https://github.com/interlay/polkabtc-clients/releases). Depending on the method of installation; +We will announce on public channels when a new release is made available for the Vault client. The changelog and binaries will be published on the [release page](https://github.com/interlay/interbtc-clients/releases). Depending on the method of installation;
@@ -290,7 +290,7 @@ docker-compose down ```shell rm docker-compose.yaml -wget https://raw.githubusercontent.com/interlay/polkabtc-docs/master/scripts/vault/docker-compose.yml -O docker-compose.yml +wget https://raw.githubusercontent.com/interlay/interbtc-docs/master/scripts/vault/docker-compose.yml -O docker-compose.yml docker-compose up ``` @@ -305,7 +305,7 @@ Standard ### 1. Stop the service ```shell -sudo systemctl stop polkabtc-vault.service +sudo systemctl stop interbtc-vault.service ``` OR terminate the process with `Ctrl+C`. @@ -313,10 +313,10 @@ OR terminate the process with `Ctrl+C`. ### 2. Re-download the binary and setup script ```shell -wget https://github.com/interlay/polkabtc-clients/releases/download/0.7.11/vault -O vault -wget https://raw.githubusercontent.com/interlay/polkabtc-docs/master/scripts/vault/setup -O setup +wget https://github.com/interlay/interbtc-clients/releases/download/0.7.11/vault -O vault +wget https://raw.githubusercontent.com/interlay/interbtc-docs/master/scripts/vault/setup -O setup chmod +x ./setup && sudo ./setup -sudo systemctl start polkabtc-vault.service +sudo systemctl start interbtc-vault.service ```
@@ -344,9 +344,9 @@ RUST_LOG=info ./vault \ --bitcoin-rpc-pass rpcpassword \ --keyfile keyfile.json \ --keyname interbtcvault \ - --auto-register-with-faucet-url 'https://beta.polkabtc.io/api/faucet' \ - --telemetry-url 'https://beta.polkabtc.io/api/telemetry' \ - --btc-parachain-url 'wss://beta.polkabtc.io/api/parachain' \ + --auto-register-with-faucet-url 'https://bridge.interlay.io/api/faucet' \ + --telemetry-url 'https://bridge.interlay.io/api/telemetry' \ + --btc-parachain-url 'wss://bridge.interlay.io/api/parachain' \ --network=testnet ``` @@ -357,21 +357,21 @@ On startup, the Vault will automatically create or load the Bitcoin wallet using ### Registering your Vault -The default behaviour on Beta is **automatic registration** using Interlay's DOT faucet as set in the `auto-register-with-faucet-url` arg. Another option for registering is the `auto-register-with-collateral` flag, as described in the [README](https://github.com/interlay/polkabtc-clients/tree/master/vault). +The default behaviour on Beta is **automatic registration** using Interlay's DOT faucet as set in the `auto-register-with-faucet-url` arg. Another option for registering is the `auto-register-with-collateral` flag, as described in the [README](https://github.com/interlay/interbtc-clients/tree/master/vault). You can also register your Vault through our web UI, going to the "Vault" tab, clicking the `Register` button and completing the steps. -Moreover, you can interact with the Vault pallet directly using [polkabtc-js](https://github.com/interlay/polkabtc-js). +Moreover, you can interact with the Vault pallet directly using [interbtc-js](https://github.com/interlay/interbtc-js). ```js -import { createPolkabtcAPI } from "@interlay/polkabtc"; +import { createinterbtcAPI } from "@interlay/interbtc"; -const polkaBTC = await createPolkabtcAPI("ws://127.0.0.1:9944", "testnet"); -polkaBTC.setAccount(KEYRING); +const interbtc = await createinterbtcAPI("ws://127.0.0.1:9944", "testnet"); +interbtc.setAccount(KEYRING); // 100 DOT denominated in Planck const collateralInPlanck = "1000000000000"; -await polkaBTC.vaults.register(collateralInPlanck, BTC_PUBLIC_KEY); +await interbtc.vaults.register(collateralInPlanck, BTC_PUBLIC_KEY); ``` ### Increasing Collateral @@ -380,19 +380,19 @@ await polkaBTC.vaults.register(collateralInPlanck, BTC_PUBLIC_KEY); Go to the Vault tab and click on button next to the `Collateral: X DOT for Y BTC` text (above the Issue Requests table). Then, follow the isntructions. -**Polkabtc-js library** +**interbtc-js library** -You can use [polkabtc-js](https://github.com/interlay/polkabtc-js) to lock additional collateral. +You can use [interbtc-js](https://github.com/interlay/interbtc-js) to lock additional collateral. ```js -import { createPolkabtcAPI } from "@interlay/polkabtc"; +import { createinterbtcAPI } from "@interlay/interbtc"; -const polkaBTC = await createPolkabtcAPI("ws://127.0.0.1:9944", "testnet"); -polkaBTC.setAccount(KEYRING); +const interbtc = await createinterbtcAPI("ws://127.0.0.1:9944", "testnet"); +interbtc.setAccount(KEYRING); // 100 DOT denominated in Planck const additionalCollateralInPlanck = "1000000000000"; -await polkaBTC.vaults.lockAdditionalCollateral(additionalCollateralInPlanck); +await interbtc.vaults.lockAdditionalCollateral(additionalCollateralInPlanck); ``` ### Withdrawing Collateral @@ -401,19 +401,19 @@ await polkaBTC.vaults.lockAdditionalCollateral(additionalCollateralInPlanck); Go to the Vault tab and click on the button next to the `Collateral: X DOT for Y BTC` text (above the Issue Requests table). Then, follow the isntructions. -**Polkabtc-js library** +**interbtc-js library** -You can use [polkabtc-js](https://github.com/interlay/polkabtc-js) to withdraw collateral. +You can use [interbtc-js](https://github.com/interlay/interbtc-js) to withdraw collateral. ```js -import { createPolkabtcAPI } from "@interlay/polkabtc"; +import { createinterbtcAPI } from "@interlay/interbtc"; -const polkaBTC = await createPolkabtcAPI("ws://127.0.0.1:9944", "testnet"); -polkaBTC.setAccount(KEYRING); +const interbtc = await createinterbtcAPI("ws://127.0.0.1:9944", "testnet"); +interbtc.setAccount(KEYRING); // 100 DOT denominated in Planck const collateralToWithdrawInPlanck = "1000000000000"; -await polkaBTC.vaults.withdrawCollateral(collateralToWithdrawInPlanck); +await interbtc.vaults.withdrawCollateral(collateralToWithdrawInPlanck); ``` ### Earning Fees @@ -430,10 +430,10 @@ The process to leave interBTC depends on whether or not your Vault client holds If you Vault has _no BTC in custody_, you can withdraw all your DOT collateral at any time and leave the system. It is safe to stop the Vault client without risking being penalized. You will not participate in any issue or redeem requests once you have removed your DOT collateral. -If your Vault clients holds at least _some BTC in custody_, you have two options to leave the system. Both options require that the BTC that you have in custody is moved. Option A, leaving through _replace_, requires you to request being replaced by another Vault. You can request to be replaced through the [Vault dashboard](https://beta.polkabtc.io/vault). Option B, leaving through _redeem_ requires you to wait for a user to redeem the entire amount of BTC that the Vault has in custody. Only after you have 0 BTC, can the Vault client withdraw its entire collateral. +If your Vault clients holds at least _some BTC in custody_, you have two options to leave the system. Both options require that the BTC that you have in custody is moved. Option A, leaving through _replace_, requires you to request being replaced by another Vault. You can request to be replaced through the [Vault dashboard](https://bridge.interlay.io/vault). Option B, leaving through _redeem_ requires you to wait for a user to redeem the entire amount of BTC that the Vault has in custody. Only after you have 0 BTC, can the Vault client withdraw its entire collateral. ## Dashboard You can monitor the operation of your Vault on the Vault dashboard by adding the key to the [polkadot{.js} extension](https://polkadot.js.org/extension/). -Once the Vault is up and running, a "Vault" tab will appear in the topbar of the app at [beta.polkabtc.io](https://beta.polkabtc.io/) (or you can access directly at [beta.polkabtc.io/vault](https://beta.polkabtc.io/vault)). +Once the Vault is up and running, a "Vault" tab will appear in the topbar of the app at [bridge.interlay.io](https://bridge.interlay.io/) (or you can access directly at [bridge.interlay.io/vault](https://bridge.interlay.io/vault)). diff --git a/docs/vault/overview.md b/docs/vault/overview.md index 5207c409..e1213e82 100644 --- a/docs/vault/overview.md +++ b/docs/vault/overview.md @@ -29,7 +29,7 @@ To support the integrity of the parachain, Vaults are also able to assume the ro ### What do I need to become a Vault? -1. Vault client ([source](https://github.com/interlay/polkabtc-clients)) +1. Vault client ([source](https://github.com/interlay/interbtc-clients)) 2. Bitcoin full node ([instructions](https://bitcoin.org/en/full-node)) 3. Polkadot account ([public/private keypair](https://wiki.polkadot.network/docs/en/learn-keys)) 4. Some DOTs to provide as collateral and pay for transaction fees @@ -53,7 +53,7 @@ Each time a user issues or redeems interBTC, they pay the following fees to a ** From this fee pool, `77%` is distributed among all active Vaults based on the following two factors: -- 90% based on the Vault's **BTC in custody** ( = issued interBTC) in proportion to the total locked BTC ( = issued PolkaBtc) across all Vaults +- 90% based on the Vault's **BTC in custody** ( = issued interBTC) in proportion to the total locked BTC ( = issued interbtc) across all Vaults - 10% based on the Vault's **locked DOT collateral** in proportion to the total locked DOT collateral across all Vaults Specifically, each Vault's fee is calculated according to the following formula: @@ -239,9 +239,9 @@ Specifically, the user's payout is calculated as follows: burn_dot_payout = - (total_liquidated_dot_collateral / total_liquidated_polkabtc) - * user_burned_polkabtc + (total_liquidated_dot_collateral / total_liquidated_interbtc) + * user_burned_interbtc -As long as the economic value of `burn_dot_payout` is higher than that of `user_burned_polkabtc`, which may include private information of the user (that is, the user may think that DOT will become worth more soon), users are incentivized to burn interBTC in return for DOT and to re-balance the system. +As long as the economic value of `burn_dot_payout` is higher than that of `user_burned_interbtc`, which may include private information of the user (that is, the user may think that DOT will become worth more soon), users are incentivized to burn interBTC in return for DOT and to re-balance the system. This Burn Event continues until the 1:1 ratio of BTC to interBTC is restored. diff --git a/scripts/beta.json b/scripts/beta.json index 9801b6ab..faf65501 100644 --- a/scripts/beta.json +++ b/scripts/beta.json @@ -1,11 +1,11 @@ { - "name": "PolkaBTC", + "name": "interbtc", "id": "beta_testnet", "chainType": "Live", "bootNodes": [ - "/dns4/lb-ams3.do.polkabtc.io/tcp/30337/p2p/12D3KooWQgh9z6TuD7H5ixMPsa2RR6FoKp35SToCD1c2DNJqyEjU", - "/dns4/lb-ams3.do.polkabtc.io/tcp/30338/p2p/12D3KooWFxfTef4uTR98jKrGueQkjth4RutuvrpB2hHUpHoYX6fd", - "/dns4/lb-ams3.do.polkabtc.io/tcp/30339/p2p/12D3KooWKNFAxB7b19JDfdyDnTKHMmTJqhDD5jqXUysWN27Nnz2R" + "/dns4/lb-ams3.do.interbtc.io/tcp/30337/p2p/12D3KooWQgh9z6TuD7H5ixMPsa2RR6FoKp35SToCD1c2DNJqyEjU", + "/dns4/lb-ams3.do.interbtc.io/tcp/30338/p2p/12D3KooWFxfTef4uTR98jKrGueQkjth4RutuvrpB2hHUpHoYX6fd", + "/dns4/lb-ams3.do.interbtc.io/tcp/30339/p2p/12D3KooWKNFAxB7b19JDfdyDnTKHMmTJqhDD5jqXUysWN27Nnz2R" ], "telemetryEndpoints": null, "protocolId": null, @@ -17,7 +17,7 @@ ], "tokenSymbol": [ "DOT", - "PolkaBTC" + "interbtc" ] }, "consensusEngine": null, @@ -139,4 +139,4 @@ "childrenDefault": {} } } -} \ No newline at end of file +} diff --git a/scripts/vault/docker-compose.yml b/scripts/vault/docker-compose.yml index 974611d3..9626bdc0 100644 --- a/scripts/vault/docker-compose.yml +++ b/scripts/vault/docker-compose.yml @@ -19,7 +19,7 @@ services: - ./cache:/home/bitcoin/.bitcoin/testnet3 restart: unless-stopped vault: - image: "registry.gitlab.com/interlay/polkabtc-clients/vault:0.7.11" + image: "registry.gitlab.com/interlay/interbtc-clients/vault:0.7.11" command: - vault - --bitcoin-rpc-url @@ -35,11 +35,11 @@ services: - --keyname - interbtcvault - --auto-register-with-faucet-url - - "https://beta.polkabtc.io/api/faucet" + - "https://bridge.interlay.io/api/faucet" - --telemetry-url - - "https://beta.polkabtc.io/api/telemetry" + - "https://bridge.interlay.io/api/telemetry" - --btc-parachain-url - - "wss://beta.polkabtc.io/api/parachain" + - "wss://bridge.interlay.io/api/parachain" environment: RUST_LOG: info volumes: diff --git a/scripts/vault/polkabtc-vault.service b/scripts/vault/polkabtc-vault.service index 4626ed98..ab808287 100644 --- a/scripts/vault/polkabtc-vault.service +++ b/scripts/vault/polkabtc-vault.service @@ -5,15 +5,15 @@ After=network.target [Service] Environment="RUST_LOG=info" Type=simple -ExecStart=/opt/polkabtc/vault/vault \ +ExecStart=/opt/interbtc/vault/vault \ --bitcoin-rpc-url http://localhost:18332 \ --bitcoin-rpc-user rpcuser \ --bitcoin-rpc-pass rpcpassword \ - --keyfile /opt/polkabtc/vault/keyfile.json \ + --keyfile /opt/interbtc/vault/keyfile.json \ --keyname interbtcvault \ - --auto-register-with-faucet-url 'https://beta.polkabtc.io/api/faucet' \ - --telemetry-url 'https://beta.polkabtc.io/api/telemetry' \ - --btc-parachain-url 'wss://beta.polkabtc.io/api/parachain' \ + --auto-register-with-faucet-url 'https://bridge.interlay.io/api/faucet' \ + --telemetry-url 'https://bridge.interlay.io/api/telemetry' \ + --btc-parachain-url 'wss://bridge.interlay.io/api/parachain' \ --network=testnet Restart=on-failure RestartSec=5 diff --git a/scripts/vault/setup b/scripts/vault/setup index 93c07bbb..5576aec9 100755 --- a/scripts/vault/setup +++ b/scripts/vault/setup @@ -1,8 +1,8 @@ #!/bin/sh -[ -d /opt/polkabtc ] || mkdir /opt/polkabtc -[ -d /opt/polkabtc/vault ] || mkdir /opt/polkabtc/vault -cp ./vault /opt/polkabtc/vault/ -cp ./keyfile.json /opt/polkabtc/vault/ +[ -d /opt/interbtc ] || mkdir /opt/interbtc +[ -d /opt/interbtc/vault ] || mkdir /opt/interbtc/vault +cp ./vault /opt/interbtc/vault/ +cp ./keyfile.json /opt/interbtc/vault/ [ -d /usr/lib/systemd/system/ ] || mkdir /usr/lib/systemd/system/ -cp polkabtc-vault.service /usr/lib/systemd/system/ +cp interbtc-vault.service /usr/lib/systemd/system/