Code Monkey home page Code Monkey logo

bap-junglebus's Introduction

bap-junglebus

BAP transaction indexer for JungleBus

BAP-junglebus is a JungleBus compatible Bitcoin Attestation Protocol indexer. It scans all BAP transactions and processes them into a global BAP state using GorillaPool's JungleBus.

global installation

npm install -g bap-junglebus

Set the environment variables. You must at least set a JungleBus subscription.

export BAP_SUBSCRIPTION_ID=""

And optionally overwrite the defaults for the database:

export BAP_MONGO_URL="mongodb://localhost:27017/bap"

Indexing BAP blocks can now be done by running

bap-junglebus

The arguments to the bap-junglebus cli are:

arg Description
-s <subscription id> JungleBus subscription ID

local installation

git clone https://github.com/icellan/bap-junglebus.git

BAP-junglebus can run either with settings from a config file (config.json) or from environment variables.

config.json

{
  "subscriptionId": "...",
  "mongoUrl": "mongodb://..."
}

environment

export BAP_SUBSCRIPTION_ID="..."
export BAP_MONGO_URL="mongo://..."

run

To run the indexer:

./start.sh

testing

yarn test

or

yarn testwatch

Including in your own package or site

npm install bap-junglebus
or
yarn add bap-junglebus

Make sure you set the environment variables before running any scripts:

export BAP_SUBSCRIPTION_ID = '<junglebus subscription id>';
export BAP_MONGO_URL = 'mongodb://localhost:27017/bap';

Index all BAP transactions (also from mempool):

import { watchBAPTransactions } from 'bap-junglebus/src/bap';

(async function() {
  await watchBAPTransactions();
})();

Babel

Make sure babel is set up properly or that es6 is supported by your own package.

bap-junglebus's People

Contributors

icellan avatar

Stargazers

Mr. Z avatar

Watchers

 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.