Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/interlay/interbtc-clients
interBTC Clients | Vault, Oracle, Faucet
https://github.com/interlay/interbtc-clients
bitcoin interbtc polkadot rust substrate vault
Last synced: 24 days ago
JSON representation
interBTC Clients | Vault, Oracle, Faucet
- Host: GitHub
- URL: https://github.com/interlay/interbtc-clients
- Owner: interlay
- License: apache-2.0
- Created: 2021-01-20T12:02:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T12:14:08.000Z (7 months ago)
- Last Synced: 2025-01-01T13:06:37.086Z (about 1 month ago)
- Topics: bitcoin, interbtc, polkadot, rust, substrate, vault
- Language: Rust
- Homepage:
- Size: 25.5 MB
- Stars: 52
- Watchers: 8
- Forks: 31
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
interBTC Clients
Faucet, Oracle & Vault / Relayer
_This project is currently under active development_.
## Getting started
### Prerequisites
```
curl https://sh.rustup.rs -sSf | sh
```
Please also install the following dependencies:
- `cmake`
- `clang` (>=10.0.0)
- `clang-dev`
- `libc6-dev`
- `libssl-dev`
- `pkg-config` (on Ubuntu)
### Installation
#### Faucet
The testnet may use a faucet to allow users and vaults to self-fund up to a daily limit.
To start the Faucet follow the instructions contained in the [Faucet README](./faucet/README.md).
#### Oracle
The interBTC bridge requires a price oracle to calculate collateralization rates, for local development we can run this client
to automatically update the exchange rate at a pre-determined time interval.
To start the Oracle follow the instructions contained in the [Oracle README](./oracle/README.md).
#### Vault
The Vault client is used to intermediate assets between Bitcoin and the BTC Parachain.
It is also capable of submitting Bitcoin block headers to the BTC Parachain.
To start the Vault follow the instructions contained in the [Vault README](./vault/README.md).
### Development
Building requires a specific rust toolchain and nightly compiler version. The
requirements are specified in the [./rust-toolchain.toml](./rust-toolchain.toml)
[override file](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file).
Running `rustup show` from the root directory of this repo should be enough to
set up the toolchain and you can inspect the output to verify that it matches
the version specified in the override file.
Use the following command to fetch the newest metadata from a live chain:
```shell
curl -sX POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"state_getMetadata", "id": 1}' localhost:9933 | jq .result | cut -d '"' -f 2 | xxd -r -p > runtime/metadata.scale
```
To build, one of the following mutually-exclusive features must be specified:
- parachain-metadata-interlay
- parachain-metadata-kintsugi
The default command for building the clients, assuming a Kintsugi chain, is:
```shell
cargo run --features=parachain-metadata-kintsugi --bin runner -- --parachain-ws 'ws://localhost:9944' --vault-config-file args.txt
```
## Troubleshooting
**Too many open files**
On `cargo test` the embedded parachain node in the integration tests can consume a lot of resources. Currently the best workaround is to increase the resource limits of the current user.
Use `ulimit -a` to list the current resource limits. To increase the maximum number of files set `ulimit -n 4096` or some other reasonable limit.