Skip to content
Core Library for XYO Network in Nodejs
TypeScript
Branch: master
Clone or download

README.md

logo

XYO CORE SDK (sdk-core-nodejs)

NPM

Build Status Maintainability BCH compliance DepShield Badge Sonarcloud Status

Table of Contents

Project Overview

Scope of features

Core functionality for the XYO NodeJS projects. This repository implements the core objects and services used in the XYO protocol. Additionally it provides core XYO features like performing bound-witnesses, hashing, signing, serialization, origin-chain management and TCP Network services. Alas, it exposes a number of CLI applications for running archivists and diviners.

Yellow Paper

The XYO protocol for creating origin-blocks is specified in the XYO Yellow Paper. In it, it describes the behavior of how a node on the XYO network should create bound-witnesses. Note, the behavior is not coupled with any particular technology constraints around transport layers, cryptographic algorithms, or hashing algorithms.

Architecture and Design

As such, the design of the system is aimed at abstracting these concepts so that the concrete implementations of these components can be swapped out so long as they conform to the correct interfaces.

Practically, this library uses TypeScript, which transpiles to JavaScript. Additionally, a TCP network provider has been implemented. Furthermore, some of the most popular public-key cryptography algorithms and hashing algorithms have been wrapped and made available to the core library. If you're favorite crypto signing algorithm is not yet supported, we welcome pull-requests and suggestions.

Here is a link to the core object model that contains an index of major/minor values and their respective objects.

Getting started

Clone repository

git clone https://github.com/XYOracleNetwork/sdk-core-nodejs

Install dependencies

After cloning the repository, change directory to the folder that houses the repository.

  cd sdk-core-nodejs

You will have to run Lerna to setup the links

  lerna bootstrap

Once you've switched to the repository directory, install the dependencies. We prefer yarn but npm works just as well.

  yarn install

Build

Once the dependencies are installed run

  yarn build

Testing

Run all tests

  yarn test

Developer Guide

Developers should conform to git flow workflow. Additionally, we should try to make sure every commit builds. Commit messages should be meaningful serve as a meta history for the repository. Please squash meaningless commits before submitting a pull-request.

There is git hook on commits to validate the project builds. If you'd like to commit your changes while developing locally and want to skip this step you can use the --no-verify commit option.

i.e.

  git commit --no-verify -m "COMMIT MSG"

Development Tools

NVM (Node Version Manager)

A number of the libraries that this project depends on may fail at install-time because they need to be built from C++ source where the output is specific to the host system. The underlying issue is that it is trying to modify files in protected areas of the file-system.

This is all to say that nvm is strongly recommended for developers. Additionally you will find a .nvmrc file at the root-level of the project that specifies the currently supported version of Node.

Workflow

The project structure was designed to support and encourage a modular architecture. This project uses a typical Lerna layout. That is, all modules are located in the packages folder. This allows for a couple of things that are conducive to an efficient development and release process:

  • Local linking of modules during development
  • Ability to release patches, minor, and major version upgrades to npm with ease
  • TypeScript linking using project references

That said, since this is a TypeScript project, the source must be transpiled to JavaScript before execution. So, if a change is made to one or more modules in the package directory yarn build must be run from the project root for the changes to reflect.

So a typical workflow might look like this:

  • Developer pulls down repository and changes directory in project root
  • Developer runs yarn install to install all dependencies of all the packages in accordance with yarn workspace feature
  • Developer runs yarn build to transpile TypeScript source to JavaScript
  • Developer makes changes in one or more packages
  • Developer runs yarn build to see those changes reflected and linked accordingly
  • On occasion, running yarn clean may prove useful for resetting the project to clean state
  • When a change-set is complete and has gone through the proper code-review etc, a release can be made running yarn release. Release versions should follow SemVer standards.
Set the first account in ganache as environment variable for config
  eval `./scripts/manage-ganache.js set-account`

Maintainers

  • Carter Harrison
  • Arie Trouw
  • Kevin Weiler
  • Phillip Lorenzo

License

See the LICENSE.md file for license details.

Credits

Made with 🔥and ❄️ by XY - The Persistent Company

You can’t perform that action at this time.