@ 0x/ 合同包装器
0x智能合同的打包机,使用@0x/abi-gen生成.
安装
安装
npm install @0x/contract-wrappers --save
导入
import { ContractWrappers } from '@0x/contract-wrappers';
如果你的项目在 类型脚本中,将以下内容添加到 tsconfig.json数字 :
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
捐款
我们欢迎更广泛的社会作出改进和修正! 要在此包中报告错误, 请在此寄存器中创建一个问题 .
请读我们的 捐款准则 在开始之前.
安装依赖关系
如果您没有启用纱线工作空间( Yarn < v1.0) - 启用它们 :
yarn config set workspaces-experimental true
然后安装依赖关系
yarn install
构建
要构建此软件包和它所依赖的所有其他单列波软件包,请从单列波根目录中运行以下内容:
PKG=@0x/contract-wrappers yarn build
干净
yarn clean
林特
yarn lint
运行测试
yarn test
文档
此套件的文档由TypeDoc生成,使用Solity源代码为0x合同. 每个合同都对应一个全球层面的模块,该模块包含其事件和结构的相关内容和界面。 最重要的是,每个模块输出一个类别, <ContractName>Contract,比如说. ExchangeContract,用于执行相应的合同中定义的所有函数的辅助方法.
需要注意的公约是,这些针对具体合同的帮助方法的定义是: 对象字元,它们与生成文档中的方法相分离。 每种合同方法都有若干子方法,例如:. sendTransactionAsync,或 estimateGasAsync页:1 这是预期的调用签名方法的例子: exchangeContractInstance.fillOrder.sendTransactionAsync(...arguments)。 。 。 .
发展
此软件包包含生成的代码 。 我们使用 abi-gen 用于从编译器中生成包装符 @0x/contract-artifacts重新生成包装,例如何时 @0x/contract-artifacts 已更新, 运行 yarn wrappers:generate && yarn wrappers:prettier。 。 。 .