6dc3084c30
* Update cci scrptisdas * Add github action workflow for installing the solution * Add building the solution to github actions * Add linting and formatting checks to github action * Add deps to list of prettier ignore * Add tests for @0x/contracts* * Add dependency checker tests in CI * Add checks for markdown issues to CI * Add foundry tests to CI * Add Test local @0x/contracts-* to CI * Add tests for doc generation to CI * Surgeon out leftover circle references and config * Fix foundry working-directory * Switch order of generate docs and checks in CI * Add dependabot action to github * Run ci on push ot development branch
@0x/protocol-utils
0x protocol-related utilities for the V4/Exchange Proxy constellation of contracts, with tooling related to:
- Limit orders
- Rfq orders
- Transformers
- Signatures
- EIP712 hashing
Read the Documentation.
Installation
yarn add @0x/protocol-utils
If your project is in TypeScript, add the following to your tsconfig.json:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
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=@0x/protocol-utils yarn build
Or continuously rebuild on change:
PKG=@0x/protocol-utils yarn watch
Clean
yarn clean
Lint
yarn lint