@0x/contracts-staking 中文文档教程

Question

Staking Contracts

该软件包实施了 ZEIP-31 定义的基于股权的流动性激励措施。

请参阅此处的规范。

Contracts Directory Structure

合同可以在 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

安装

npm install @0x/contracts-staking --save

Contributing

我们强烈建议社区帮助我们进行改进并确定协议的未来方向。 要报告此包中的错误，请在此存储库中创建一个问题。

有关 0x 协议的智能合约架构、消息格式或附加功能的建议，请转到 0x 改进建议 (ZEIPs) 存储库和遵循其中提供的贡献指南。

请在开始之前阅读我们的贡献指南。

Install Dependencies

如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们：

yarn config set workspaces-experimental true

然后安装依赖

yarn install

Build

项 要构建此包和它所依赖的所有其他 monorepo 包，请从 monorepo 根目录运行以下命令：

PKG=@0x/contracts-staking yarn build

或持续重建关于改变：

PKG=@0x/contracts-staking yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test