Giter VIP home page Giter VIP logo

fulcrum-wrapper's Introduction

Wrapper for fulcrum

Fulcrum is a drop-in replacement for ElectronX/ElectrumX server that runs on embassyOS. This repository creates the s9pk package that is installed to run fulcrum on embassyOS. Learn more about service packaging in the Developer Docs.

Dependencies

Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.

Build environment

Prepare your embassyOS build environment. In this example we are using Ubuntu 20.04.

  1. Install docker
curl -fsSL https://get.docker.com -o- | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER
  1. Set buildx as the default builder
docker buildx install
docker buildx create --use
  1. Enable cross-arch emulated builds in docker
docker run --privileged --rm linuxkit/binfmt:v0.8
  1. Install yq
sudo snap install yq
  1. Install deno
sudo snap install deno
  1. Install essentials build packages
sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
  1. Install Rust
curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env
  1. Build and install embassy-sdk
cd ~/ && git clone --recursive https://github.com/Start9Labs/embassy-os.git
cd embassy-os/backend/
./install-sdk.sh
embassy-sdk init

Now you are ready to build the fulcrum package!

Cloning

Clone the project locally:

git clone https://github.com/Start9Labs/fulcrum-wrapper.git
cd fulcrum-wrapper
git submodule update --init --recursive

Building

To build the fulcrum package for all platforms using embassy-sdk version

=0.3.3, run the following command:

make

To build the fulcrum package for a single platform using embassy-sdk version <=0.3.2, run:

# for amd64
make ARCH=x86_64

or

# for arm64
make ARCH=aarch64

Installing (on embassyOS)

Run the following commands to determine successful install:

ℹī¸ Change embassy-server-name.local to your Embassy address

embassy-cli auth login
# Enter your embassy password
embassy-cli --host https://embassy-server-name.local package install fulcrum.s9pk

If you already have your embassy-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the fulcrum.s9pk using Sideload Service under the System > Manage section.

Verify Install

Go to your Embassy Services page, select Fulcrum, configure and start the service. Then, verify its interfaces are accessible.

Done!

fulcrum-wrapper's People

Contributors

bitcoinmechanic avatar chrisguida avatar k0gen avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤ī¸ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.