ShadeJS

What is ShadeJS?

ShadeJS is a typescript SDK for interacting with Shade Protocol and Secret Network smart contracts. It is designed as a wrapper for Secret.js and abstracts the complexity of secret client management (for queries), as well as providing simple-to-use typescript interfaces for the inputs and outputs of contracts. In addition, it implements multi-query optimizations in order to obtain large on-chain data sets in a highly efficient manner.

Docs >>

Out of Scope

In its current state, ShadeJS does NOT include services to execute contracts via a Secret Signing Client. This is because signing transactions requires a complex integration with multiple types of wallets. However, ShadeJS DOES include message creator functions for executions that can be easily imported into your project, so that you can call them from your own signing client manager.

Contributing

Interested in contributing to this repository? Check our Contributing Guide.

Yarn

Yarn is the default package manager.

Install

$ yarn

Test

$ yarn test

Build

$ yarn build

Docs

Docs will be available on a vitepress site. You can run the site locally with this command:

$ yarn docs:dev