Welcome,
Bifrost is a Web3 derivatives protocol that provides decentralized cross-chain liquidity for staked assets. By leveraging on the cross-consensus message (XCM) it can provide cross-chain liquid staking services for multiple chains.
Our mission is to provide standardized cross-chain interest-bearing derivatives for Polkadot relay chains, parachains, and heterogeneous chains bridged with Polkadot.
👉 Discover the Bifrost at bifrost.io.
👉 Learn to use the Bifrost with our docs.
To see a list of all available make commands and their descriptions:
make helpcurl https://sh.rustup.rs -sSf | sh
make initmake build-all-releasemake formatmake clippymake test-allif runtime logic change we may do the benchmarking to regenerate WeightInfo for dispatch calls
make generate-all-weightsIf modify the storage, should test the data migration before production upgrade.
# bifrost kusama
make try-kusama-runtime-upgrade
# bifrost polkadot
make try-polkadot-runtime-upgraderun node with --chain=bifrost-polkadot-local to start a local development parachain (not Substrate’s standalone --dev mode).
Bifrost does not support --dev. Always use this chain spec instead of Substrate’s --dev mode.
Before run local development parachain You need to modify OnTimestampSet in the runtime to allow instant block production:
impl pallet_timestamp::Config for Runtime {
type MinimumPeriod = ConstU64<{ SLOT_DURATION / 2 }>;
/// A timestamp: milliseconds since the unix epoch.
type Moment = Moment;
-type OnTimestampSet = Aura;
+type OnTimestampSet = ();
type WeightInfo = pallet_timestamp::weights::SubstrateWeight<Runtime>;
}yarn global add polkadot-launch
cd -# replace version with your target polkadot version
cargo install --git https://github.com/paritytech/polkadot --tag <version> polkadot --lockedcd -
polkadot-launch ./scripts/bifrost-launch.jsonIt will take about 1-2 minutes for the parachain to start producing blocks.
yarn global add @open-web3/parachain-launchparachain-launch generate --config=scripts/bifrost-docker-launch.yml --yesIt will pull images and generate required docker files in a folder called output in your current working directory
To start the nodes, navigate to the output folder that the generated docker scripts in and start containers:
cd ./output
docker-compose up -d --buildmkdir -p ~/node-key
subkey generate-node-key --file ~/node-key/bifrost.keyReplace your-fullnode-name
docker pull bifrostnetwork/bifrost:latest
docker run -d \
-v ~/node-key:/node-key \
-p 9944:9944 \
-p 9933:9933 \
-p 30333:30333 \
bifrostnetwork/bifrost:latest \
--name your-fullnode-name \
--base-path "/data" \
--node-key-file "/node-key/bifrost.key" \
--chain "/spec/bifrost.json" \
--pruning=archive \
--rpc-external \
--ws-external \
--rpc-cors all \
--trie-cache-size 0 \
--execution wasmThere are also some snapshots you can use to quickly get started, these are provided by the community.
-
Pre-req .
zstd and aria2
sudo apt install zstd sudo apt install aria2
- relay-chain data
# download dict
wget https://snapshot-1258776962.cos.ap-hongkong.myqcloud.com/bifrost-kusama/relay.dict
# download zst data
aria2c -x10 https://snapshot-1258776962.cos.ap-hongkong.myqcloud.com/bifrost-kusama/relay.tar.zst
# decompress: node is basepath, you can replace any dicrectory you like
mkdir node
tar -I 'zstd -vd -T0 -D relay.dict' -xvf relay.tar.zst -C node/.- parachain data
wget https://snapshot-1258776962.cos.ap-hongkong.myqcloud.com/bifrost-kusama/para.dict
aria2c -x10 https://snapshot-1258776962.cos.ap-hongkong.myqcloud.com/bifrost-kusama/para.tar.zst
tar -I 'zstd -vd -T0 -D para.dict' -xvf para.tar.zst -C node/.link: