README.md

NATIVE Relayer

Summary

A software that monitors and relayers:

• CometBFT blocks to update Native light client on Ika
• Bitcoin blocks to update Bitcoin light client on Native
• Bitcoin SPV proofs to verify dWallet holdings
• Native -> Bitcoin transaction relayer

Status

Status scheme:

Mock -> WIP -> alpha -> beta -> production

Service	status
Native->Ika	(done through workers)
Native->Bitcoin	✔️
Bitcoin->Native	✔️
Bitcoin SPV	✔️

Documentation

1. Database
   • interacitons
   • schema diagram
2. Flow diagram

Contributing

Participating in open source is often a highly collaborative experience. We’re encouraged to create in public view, and we’re incentivized to welcome contributions of all kinds from people around the world.

Check out contributing repo for our guidelines & policies for how to contribute. Note: we require DCO! Thank you to all those who have contributed!

After cloning the repository, make sure to run make setup-hooks.

Security

Check out SECURITY.md for security concerns.

Setup

1. Make sure you have go, make installed
2. Copy and update your env file: cp .env.example .env
3. Update the env variables like NATIVE_BTCINDEXER_BEARER_TOKEN etc
4. Build the project: make build

To build and start you can run: make build start

In order to run Native -> Bitcoin relayer PoC:

1. Copy and update .env.example file to .env cp env.example .env
2. Run script with path of transaction file as command line argument: go run main.go transaction.txt

Development

1. Run make setup (will setup git hooks)
2. Install and make sure it is in your PATH:
   • markdownlint-cli2
   • revive

Coding notes

1. Use env.Init() to setup logger and load ENV variables.

2. Use zerolog.log logger, eg:

   import "github.com/rs/zerolog/log"
   //...
   log.Info().Int("block", minimumBlockHeight).Msg("Start relaying msgs")

Talk to us

• Follow the Native team's activities on the Native X/Twitter account.
• Join the conversation on Native Discord.