Skip to content

Typescript library to interact with the GEB framework

License

Notifications You must be signed in to change notification settings

money-god/geb.js

 
 

Repository files navigation

geb.js

Typescript library to interact with the GEB protocol.

IMPORTANT

This is a dev repo that is being regularly updated.

Library users can check the following to get a general idea of the functionality: packages/geb/README.md

You can also use this library with NPM: https://www.npmjs.com/package/geb.js

Overview

geb.js adopted a monorepo structure to allow for more flexibility when using the different sub-packages. The packages are managed by Lerna and published on NPM.

geb.js consist of the following packages:

Build & Publish

Install npm dependencies:

npm i -d

To build the library run:

npm run build

To update internal dependencies between the different packages you can run:

npm run bootstrap

To build the typed contract interface in packages/geb-contract-api/src/generated and packages/geb-admin-api/src/generated using the custom typechain template in the geb-typechain package, run:

npm run api-codegen

Generate docs from natspec comments and push them to the Gitbook repo, run:

npm run docs
npm run docs-publish

Tests

The testsuite currently requires seth to be installed and available on your machine.

Run all tests:

npm run test Test

Run a specific test using a keyword from the test description:

npm run test <keyword>

About

Typescript library to interact with the GEB framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • JavaScript 0.7%