Beta SoftwareThis documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested.
Getting started with an XYO Archivist
An archivist in the XYO network serves as the data-layer component between the bridge and the diviner. It accepts and aggregates data from bridges and makes that data available to Diviners via a GraphQL API. In essence it is the scribe node of the XYO network.
As long as an archivist follows the protocols of the XYO network specified in the yellow paper they may implement the component however they wish.
- You must have node installed
If you don't, the easiest way to get
This is a package manager for Apple systems, for Linux systems use the package manager for your distro
We also recommend in most cases to use
This will allow you to manage multiple active node.js versions. This may also save you some installation headaches
Note We use the stable
10.15.3 node.js release.
If you are using linux on ubuntu, you should use commands as the root by entering
sudo suor you could run
sudoprior to key commands. This guide will also prompt you for entering
You must have yarn installed:
brew install yarnor your Linux package manager
You must have Lerna installed globally to use its CLI tool:
npm install --global lerna
Note if you are using ubuntu, you can install
yarnwith these helpful articles:
You must have docker installled and running
This node app wizard works macOS and Linux, and at this time this app is not Windows compatible
Installation and Setup
Install the alpha archivist from the XYO app
npm install @xyo-network/app-xyo-nodejs@alpha -g
Run the package
Note This will prompt you to create a configuration and path
Options: -i, --install installs the plugins -r, --run runs node -f, --fetch <string> fetch from url -h, --help output usage information