Home

Welcome to the Gnosis JavaScript library wiki! gnosis.js is a JavaScript library designed to make developing dapps over the Gnosis contracts easier and more ergonomic. It is natively written in ES6, and the project is configured for writing dapps in both "server-side" Node.js and "client-side" browser JS.

Developer's Guide

Getting Started

Prerequisites

In order to follow this guide, you will need to be comfortable working in your OS's shell, writing JavaScript, and working with npm. A working knowledge of Ethereum, Solidity, and Truffle would greatly ease the use of this library, but is not strictly necessary for getting started. The usage of a VCS such as Git is also encouraged, but is not explained here.

Setting up a project using npm

1. Create a project directory, open a terminal or command line, and change directory into the project directory.

2. Use npm init to set up your project.

3. Install gnosis.js into your project as a dependency using:

       npm install --save @gnosis.pm/gnosisjs
   

   Be sure to issue this command with the exact spelling.

   This command installs the Gnosis JavaScript library and its dependencies into the node_modules directory. The @gnosis.pm/gnosisjs package contains the ES6 source of the library in src which can also be found on the repository, compiled versions of the modules which can be run on Node.js as well as webpacked standalone gnosis[.min].js files ready for use by web clients in the dist directory, and API documentation in docs directory.