Skip to content

Latest commit

 

History

History

client

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
examples
examples
 
 
scripts
scripts
 
 
src
src
 
 
test
test
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
examples.md
examples.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

Aragon JS SDK Client

@aragon/sdk-client provides easy access to the high level interactions to be made with an Aragon DAO. It consists of three different components:

  • General-purpose DAO client
  • Custom clients for specific DAO plugins
  • Context for holding inheritable configuration

Contributors: See development below

Installation

Use npm or yarn to install @aragon/sdk-client.

npm install @aragon/sdk-client
yarn add @aragon/sdk-client

Usage

An exhaustive list of the SDK features and methods can be found on the examples.md file.

To generate the examples.md file run yarn examples

Development

The building blocks are defined within the src/internal folder. The high level client wrappers are implemented in src/client*.ts

Low level networking

See ClientCore (source):

  • Abstract class implementing primitives for:
    • Web3, contracts, signing
    • IPFS
    • GraphQL
  • Inherited by classes like Client and all plugin classes like ClientErc20.

Common interfaces, types, enum's

When updating a ClientXXX (plugin) class:

  • Update first all affected enum's, types and interfaces in src/internal/interfaces/plugins.ts

When updating the Client class:

  • Update first all affected enum's, types and interfaces in src/internal/interfaces/client.ts

When updating the ClientCore class:

  • Update first all affected enum's, types and interfaces in src/internal/interfaces/core.ts

Developing a new Plugin client

Create a new class that extends from ClientCore, receives a Context on the constructor and follows the structure of ClientErc20.

Testing

To execute library tests just run:

yarn test