RepositoryCurrent collected state Current
Observed since 20 Oct, 22:26 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
Back to packageRELEASE DETAILS
2.0.38
npm@0x/contracts-staking
Staking contracts used by 0x protocol
Published21 May 2021
Direct dependencies38
Transitive dependenciesNot calculated
README
Current package documentationStaking Contracts
This package implements the stake-based liquidity incentives defined by ZEIP-31.
See the specification here.
Contracts Directory Structure
The contracts can be found in contracts/src.
* Staking.sol | This is a stateless contract that encapsulates all the staking logic.
* StakingProxy.sol | This is a stateful contract that proxies into the Staking contract.
* ReadOnlyProxy.sol | This is a stateless contract the makes read-only calls from the Staking Proxy to the Staking Contract.
* fees/ | This contains mixins that implement the logic for 0x Protocol fees.
* immutable/ | This contains mixins that are generally immutable. Changing these files can result in catastrophic failures. Exercise extreme caution.
* interfaces/ | This contains interfaces used throughout the entire staking system.
* libs/ | This contains libraries used by the staking contract; for example, math and signature validation.
* stake/ | This contains mixins that implement the core staking logic.
* staking_pools/ | This contains mixins that implement logic for creating and managing staking pools.
* sys/ | This contains mixins that implement system-level functionality, like scheduling and finalization.
* vaults/ | This contains the vaults (like the Zrx Token Vault).
Installation
Install
npm install @0x/contracts-staking --save
Contributing
We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the 0x Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.
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/contracts-staking yarn build
Or continuously rebuild on change:
PKG=@0x/contracts-staking yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Declared dependencies 38
Native requirements38 direct targetsNot calculated transitive count
| Package / target | Requirement | Relationship |
|---|---|---|
@0x/utilsEnvironment{
"local_name": "@0x/utils",
"alias": false,
"peer_metadata": null
} | ^6.4.3 | runtime |
ethereum-typesEnvironment{
"local_name": "ethereum-types",
"alias": false,
"peer_metadata": null
} | ^3.5.0 | runtime |
ethereumjs-utilEnvironment{
"local_name": "ethereumjs-util",
"alias": false,
"peer_metadata": null
} | ^7.0.10 | runtime |
@0x/base-contractEnvironment{
"local_name": "@0x/base-contract",
"alias": false,
"peer_metadata": null
} | ^6.4.0 | runtime |
@0x/typescript-typingsEnvironment{
"local_name": "@0x/typescript-typings",
"alias": false,
"peer_metadata": null
} | ^5.2.0 | runtime |
@0x/contracts-test-utilsEnvironment{
"local_name": "@0x/contracts-test-utils",
"alias": false,
"peer_metadata": null
} | ^5.4.1 | runtime |
shxEnvironment{
"local_name": "shx",
"alias": false,
"peer_metadata": null
} | ^0.2.2 | development |
chaiEnvironment{
"local_name": "chai",
"alias": false,
"peer_metadata": null
} | ^4.0.1 | development |
mochaEnvironment{
"local_name": "mocha",
"alias": false,
"peer_metadata": null
} | ^4.1.0 | development |
lodashEnvironment{
"local_name": "lodash",
"alias": false,
"peer_metadata": null
} | ^4.17.11 | development |
tslintEnvironment{
"local_name": "tslint",
"alias": false,
"peer_metadata": null
} | 5.11.0 | development |
solhintEnvironment{
"local_name": "solhint",
"alias": false,
"peer_metadata": null
} | ^1.4.1 | development |
truffleEnvironment{
"local_name": "truffle",
"alias": false,
"peer_metadata": null
} | ^5.0.32 | development |
typedocEnvironment{
"local_name": "typedoc",
"alias": false,
"peer_metadata": null
} | ~0.16.11 | development |
@0x/typesEnvironment{
"local_name": "@0x/types",
"alias": false,
"peer_metadata": null
} | ^3.3.3 | development |
decimal.jsEnvironment{
"local_name": "decimal.js",
"alias": false,
"peer_metadata": null
} | ^10.2.0 | development |
dirty-chaiEnvironment{
"local_name": "dirty-chai",
"alias": false,
"peer_metadata": null
} | ^2.0.1 | development |
typescriptEnvironment{
"local_name": "typescript",
"alias": false,
"peer_metadata": null
} | 4.2.2 | development |
@0x/abi-genEnvironment{
"local_name": "@0x/abi-gen",
"alias": false,
"peer_metadata": null
} | ^5.6.0 | development |
@types/nodeEnvironment{
"local_name": "@types/node",
"alias": false,
"peer_metadata": null
} | 12.12.54 | development |
npm-run-allEnvironment{
"local_name": "npm-run-all",
"alias": false,
"peer_metadata": null
} | ^4.1.2 | development |
@0x/dev-utilsEnvironment{
"local_name": "@0x/dev-utils",
"alias": false,
"peer_metadata": null
} | ^4.2.7 | development |
@types/lodashEnvironment{
"local_name": "@types/lodash",
"alias": false,
"peer_metadata": null
} | 4.14.104 | development |
@0x/ts-doc-genEnvironment{
"local_name": "@0x/ts-doc-gen",
"alias": false,
"peer_metadata": null
} | ^0.0.28 | development |
chai-bignumberEnvironment{
"local_name": "chai-bignumber",
"alias": false,
"peer_metadata": null
} | ^3.0.0 | development |
@0x/order-utilsEnvironment{
"local_name": "@0x/order-utils",
"alias": false,
"peer_metadata": null
} | ^10.4.22 | development |
@0x/sol-compilerEnvironment{
"local_name": "@0x/sol-compiler",
"alias": false,
"peer_metadata": null
} | ^4.7.3 | development |
@0x/web3-wrapperEnvironment{
"local_name": "@0x/web3-wrapper",
"alias": false,
"peer_metadata": null
} | ^7.5.3 | development |
chai-as-promisedEnvironment{
"local_name": "chai-as-promised",
"alias": false,
"peer_metadata": null
} | ^7.1.0 | development |
js-combinatoricsEnvironment{
"local_name": "js-combinatorics",
"alias": false,
"peer_metadata": null
} | ^0.5.3 | development |
@0x/contracts-genEnvironment{
"local_name": "@0x/contracts-gen",
"alias": false,
"peer_metadata": null
} | ^2.0.38 | development |
@0x/tslint-configEnvironment{
"local_name": "@0x/tslint-config",
"alias": false,
"peer_metadata": null
} | ^4.1.4 | development |
make-promises-safeEnvironment{
"local_name": "make-promises-safe",
"alias": false,
"peer_metadata": null
} | ^1.1.0 | development |
@0x/contracts-erc20Environment{
"local_name": "@0x/contracts-erc20",
"alias": false,
"peer_metadata": null
} | ^3.3.9 | development |
@0x/contracts-utilsEnvironment{
"local_name": "@0x/contracts-utils",
"alias": false,
"peer_metadata": null
} | ^4.7.9 | development |
@0x/contracts-dev-utilsEnvironment{
"local_name": "@0x/contracts-dev-utils",
"alias": false,
"peer_metadata": null
} | ^1.3.29 | development |
@0x/contracts-asset-proxyEnvironment{
"local_name": "@0x/contracts-asset-proxy",
"alias": false,
"peer_metadata": null
} | ^3.7.12 | development |
@0x/contracts-exchange-libsEnvironment{
"local_name": "@0x/contracts-exchange-libs",
"alias": false,
"peer_metadata": null
} | ^4.3.30 | development |
Distribution files
1 collectedDistribution 1
Source fileSource distribution
Checksums from source
{
"shasum": "d7266f2451b415ead0aa5e00f4cd0652166354ba",
"tarball": "https://registry.npmjs.org/@0x/contracts-staking/-/contracts-staking-2.0.38.tgz",
"fileCount": 101,
"integrity": "sha512-dgkOw5gCuqNAs3AA23R+mwA8sh3evY5DOcFPQAOlRm36K9DNvpJLqCgES5P2BhMyN9qSql6uz05h/2p9oJC1Cw==",
"signatures": [
{
"sig": "MEYCIQDA3Oz/hNUEbKsGpo6YWqXPVefitMAIC3oOwrYn2qyWmwIhAMSSeXHHuH/k/tM6aMEo+l7CVJAPP3pVA2bTCeyvbpsz",
"keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
}
],
"unpackedSize": 3501327,
"npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgp6m6CRA9TVsSAnZWagAALtQP/31z8NJ4zH8hhY7vy/EM\nT69rPG5kD7NvRWeQCNjfPaARkNGENatcRSttht3usdU+g5yq4kW+ZTmdlOZR\nZg8SAbTLek7S7QzoLqb7qKD8ZOFQPQS66+52rJm6GtwKQqv7NsmzYRjqDIaQ\ng9Jqq6J70WSr8NXIIDOdADpQZGVbv7jRn4EWgDMkzF60bjBJ8uA0VfO8uKrR\n8rZcA9+8BIkiDFzpfJwY6qdJYlX/G4hYF+gKuu41bESXLb1BXiFew8fXIivM\nDasWmPR3yCiP7m8SSbpu6t2/f5yUaWMpM6dOwJhXbEjh346u8Fa5ZslCGDWx\niv151/uypY9NHneBmjVUm6WLi1u/aqYtHNEFOJLTc1kdk6A/9Rnu7zR/T7tU\nQPns0p9n/Y27GmbjDYrWWs/AOOHOeftsOg4SKA/sYDH7tQj9OVsVOazIBE4P\n+iKOnnt6UgA+yCkY17Zyr0BG5VBSnjTZzdQV4wkcU+zhja3hnYhmgTVVAe8B\nXnF/tDgs5Mm1004sf5o1uxS2OVQJyNx/EqEe93pHte7cv76ndX5/zlON6c5C\nNLTyJMd/lOG+b00awUrmZAEMxn2FY0PLUt4PnQ0oIBhQ7CalSqKzmSqJ1oy6\nN/lNdek2WMNsfYAxcivkUeV+MucsQoQ6lAKzazTox12er3P3tzqrYBVWpwfM\nCQBc\r\n=UQ7q\r\n-----END PGP SIGNATURE-----\r\n"
}Repository
PENDINGRepository
PENDINGMetadata history
Meaningful changesRecord identity
package_version:223a31a0e28ecbfafbcd8f2dce1c4339996907c1903e5cf6385d068b304ff7ed