Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.09 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.09 KB
Raw

AVABOX

AVA is an open-source platform for launching highly decentralized applications, financial primitives, and interoperable blockchains.

AVABOX repo is a playground for exploring the AVA platform including the slopes lib.

Installation

You can drop AVABOX in to your app via npm or yarn or you can clone the repo and run it locally.

NPM or Yarn

AVABOX is available as a package on npm. You can drop it in to your app with npm or yarn.

With npm

npm install avabox --save

With yarn

yarn add avabox

Localhost

First clone the repo

git clone https://github.com/cgcardona/AVABOX.git
cd AVABOX

Install the dependencies

yarn install

Run a script

ts-node examples/get_node_id.ts

Usage

Check out the examples/ directory to see how to use AVABOX.

For example to create a basic AVA wallet located at ./wallet.json.

ts-node examples/create_wallet.ts
wallet.json written successfully.

cat wallet.json
{
  "private_key": "2sVnjPaFRZoYy5NF4UJoGsDNKyTK2MPGDCvFSfgHghbdiVzS1E",
  "public_key": "8h3duPX9UBqHK5Xo3DnA5xB2DTnfzNddHMctDqM3BaGsHWYW9r",
  "chain_address": "X-ErsdCatjgehBa8Ao1LVuZW11WKEL2FeJV"
}

Running your own full node

AVABOX requires a full node. Here are the steps for firing up your own AVA full node.

More Info

Credits

The ever amazing Chris @Trout Troutner inspired me to do a deep dive on AVA. His ava-examples repo was the inpiration for this work.

This library is influenced by Slopes from AVA Labs but is not a direct fork. However that library deserves credit.

License

AVABOX is licensed under the MIT Open Source License