@0xproject/connect
v3.0.1
Published
A javascript library for interacting with the standard relayer api
Downloads
422
Readme
@0xproject/connect
This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the Standard Relayer API
Installation
yarn add @0xproject/connect
If your project is in TypeScript, add the following to your tsconfig.json
:
"compilerOptions": {
"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
Usage
Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0xproject/connect yarn build
Or continuously rebuild on change:
PKG=@0xproject/connect yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test