Getting Started

Installation

Install the package with npm or yarn

1
2
3
4
5
npm install @daostack/client

# Or

yarn add @daostack/client

Import

Once installed, import the module in your project

1
2
3
4
5
import { Arc } from '@daostack/client'

//Or

const { Arc } = require('@daostack/client')

General Structure

The client library provides a number of Classes that represent the DAOstack entities and configuration.

  • Configuration
    • Arc: holds the basic configuration i.e. which services to connect to. Any use of the library will start with instantiating a new Arc instance
  • Entities represents information of DAOstack basic blocks.
    • DAO: the DAOstack DAO and all its information.
    • Reputation: native reputation contract of the DAO.
    • Token: token contracts, including the native token of the DAO.
    • Member: holders of reputation i.e. who have voting power in the DAO.
    • Proposal: Proposal made in the DAO. Proposals belong to Schemes registered in the DAO.
    • Vote: votes made on the proposal.
    • Stake: stake made on the outcome of a proposal.
    • Reward: rewards awarded by the DAO for a given proposal.
    • Scheme: the various schemes (ContributionReward, SchemeRegistrar, GenericScheme etc) registered to the DAO and to which a proposal can be made. Scheme determines the conditions and effects of executing the proposal.
    • Queue: queues for each scheme registered to the DAO. The proposal is ordered in queue upon submission.

Follow the How to use guide for working details of client library.