Skip to content

tinydancer-io/tinydancer

Repository files navigation

Tinydancer (V0)

All Contributors

Architecture

The client is designed to be modular and easily extensible for additional functionality as this is the v0 and with every major version there may be a need for major changes and add-on services.

Bird's Eye View

Architecture Diagram

Getting started

Install Rust MacOS & Linux

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Note: For Windows download rustup from this link

Configure Toolchain

rustup default nightly

Build and Add to Path

cargo b -r && cp ./target/release/tinydancer ~/.local/bin/

Or Install Using Cargo

cargo install --git https://github.com/tinydancer-io/half-baked-client tinydancer

Confirm Installation

tinydancer --help

Testing

Testing is mostly manual, in the future we will implement unit tests but for now we have bash scripts in the scripts folder.

Credits

The rpc_wrapper section of the client used to send rpc requests is borrowed from blockworks-foundation/lite-rpc and we are grateful to their team and the blockworks foundation for their work on it.

Contributors

x19
x19

💻
Pickle Rick
Pickle Rick

💻