https://github.com/diamondhands-dev/shiro-backend

Wallet server for the RGB protocol (that is defined by LNP/BP)
https://github.com/diamondhands-dev/shiro-backend

Last synced: about 1 month ago
JSON representation

Wallet server for the RGB protocol (that is defined by LNP/BP)

• Host: GitHub
• URL: https://github.com/diamondhands-dev/shiro-backend
• Owner: diamondhands-dev
• License: mit
• Created: 2022-09-10T04:52:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-28T04:59:07.000Z (about 1 year ago)
• Last Synced: 2024-08-01T13:20:38.508Z (4 months ago)
• Language: Rust
• Homepage:
• Size: 74.2 KB
• Stars: 18
• Watchers: 2
• Forks: 5
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rgb-protocol - Shiro

README

        
# shiro-backend

Wallet server for the RGB protocol (that is defined LNP/BP)

# Prequisite

* Electrum and bitcoin-node that sync on your bitcoin network. (`mainnet`, `testnet`, `signet`, or `regtest`).

* rgb-proxy-server.  One of the rgb-proxy-server is https://github.com/grunch/rgb-proxy-server .

* Some more shared libraries like libcrypt1.so.

And you want to develop Shiro-backend itself.

# How to run

## Docker

You shall specify `{network_name}`. (`mainnet`, `testnet`, `signet`, or `regtest`).

```

docker run -d -p 8080:8080 -e BITCOIN_NETWORK={network_name} ghcr.io/diamondhands-dev/shiro-backend:latest

```

## From sources

```

git clone https://github.com/diamondhands-dev/shiro-backend.git

cd shiro-backend

cargo install --path .

export BITCOIN_NETWORK_NAME={network_name}

export ELECTRUM_URL={electrum_url}

export RGB_PROXY_URL={rgb_proxy_url}

mkdir -p /tmp/shiro-wallet

shiro-backend

```

Environment variables will be fixed for your runtime environment.

# How to test

## Prequisite

* Linux runs on 64bit architecture.

  * You'll get a build error on 32bit versions of Linux (like i386, armv7).

  * I've not checked yet on Windows, macOS. I guess Shiro-backend won't work with them.

* Rust/Cargo (>= 1.66.0 ).

* C++ toolchain (Shiro itself doesn't need but some dependencies require it).

* Some additional `*.a` library files. It depends your development environment.

## Steps.

```

git clone https://github.com/diamondhands-dev/shiro-backend.git

cd shiro-backend

mkdir -p /tmp/shiro-wallet

test-mocks/start_services.sh

RUST_TEST_THREADS=1 BITCOIN_NETWORK_NAME={network_name} cargo test

```

# How to release docker images

```

git tag v{semantic version}

git push origin v{semantic version}

```

A GitHub action will be build new image with tags.

You'll find the rule of `{semantic version}` is https://semver.org/

# Help wanted?

https://github.com/diamondhands-dev/shiro-backend/issues