Socket
Socket
Sign inDemoInstall

@xyo-network/api-xyo-nodejs

Package Overview
Dependencies
575
Maintainers
4
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @xyo-network/api-xyo-nodejs

Main XYO API Interface


Version published
Weekly downloads
3
decreased by-62.5%
Maintainers
4
Created
Weekly downloads
 

Readme

Source

logo

XYO API (api-xyo-nodejs)

Branches

Master

Build Status BCH compliance Maintainability Greenkeeper badge

Develop

Build Status BCH compliance

Description

The main API for accessing XYO network information using GraphQL.

User Mode

Requirements (Step 1)

Install Node 10.x or later from: NodeJs

Install Diviner (Step 2)

sudo npm install @xyo-network/api-xyo-nodejs -g --unsafe-perm=true

Build Diviner (Step 3)

xyo-api start

Developer Mode

Requirements (Step 1)

Install Node 10.x or later from: NodeJs

Install Diviner (Step 2)

npm install https://github.com/XYOracleNetwork/api-xyo-nodejs

Build Diviner (Step 3)

npm run build

Start Diviner (Step 4)

npm run start

Docker

Install

Install the Xyo Api in a Docker and start the server at the end.

Note: There currently are quite a few build errors/warnings generted from dependencies that can safely be ignored, but should addressed in the future.

docker image build -t xyonetwork-api-xyo-nodejs-install:latest https://raw.githubusercontent.com/XYOracleNetwork/api-xyo-nodejs/master/docker/install/Dockerfile
docker run -p 12001:12001 xyonetwork-api-xyo-nodejs-install:latest

Command Line

Usage

  xyo-api <cmd> [opt]

  <cmd>: commands
  [opt]: options

Commands

  start               Start the Api Server

Options

  -g, --graphql [n]   The http port to listen on for graphql connections
                      (default = 12001)

  -d, --diviner [s]   The url of the seed diviner to contact
                      (default = http://diviners.xyo.network:12002)

Example: Start the API on port 9090 and use port 9099 on your local computer for the diviner

  xyo-api start -g 9090 -d http://localhost:9099

License

Only for internal XY Company use at this time

Credits

Made with ❤️ by XYO

FAQs

Last updated on 08 Nov 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc