黄道球
此软件包包括基数 黄道 衍生出黄道组件的合同和接口。 它还包括一个用于编码模块部署的浏览器安全TypeScript SDK和一个用于部署和验证工作流程的单独的工具输入点.
基地合同
模块是由一个执行某种决策逻辑的"神通"所促成的合同. 他们应该导入模块. sol.
启用带有守护功能的模块, 可以检查执行前后的交易 。 用于限制模块可以调用或确保某个状态的地址和功能范围,绝不被模块所改变.
修饰者是坐落在模块和"神通"之间的合同来修改模块的行为. 例如,它们可能会对模块试图执行的所有职能造成延误。 修改器应该导入修改器. sol, 并且必须曝光像 IAvatar. sol 这样的接口
带有守护功能的修改器可以检查执行前后的交易. 用于限制修饰者可以调用或确保某一状态的地址和功能范围,从不被修饰者所改变.
SDK 软件
SDK提供编码,部署和验证黄道模块的功能.
编码
本节中的功能产生(但不执行)有效载荷,当执行时会产生主复制和模块实例. 这些功能通常用于应用软件中,用于部署与黄道兼容的模块或修改器的新实例,因为其有效载荷可以通过任何连接的账户来部署.
encodeDeployProxy
生成用于部署模块/修改器新实例的有效载荷 -- -- 新的实例是一个最小的代用,通过黄道模块ProxyFactory部署,并指代模块/修改器的主复制.
import { encodeDeployProxy } from "@gnosis-guild/zodiac-core";
const transaction = await encodeDeployProxy({
mastercopy: "0x<address>",
setupArgs: { types: ["address", "uint256"], values: ["0x<address>", 0] },
salt: "0x<bytes32>",
});
predictProxyAddress
预估通过黄道分泌分泌分泌法部署的新模块实例的地址。 用于在一个多端交易中部署和调用模块或修改器.
import { predictProxyAddress } from "@gnosis-guild/zodiac-core";
const transaction = await predictProxyAddress({
mastercopy: "0x<address>",
setupArgs: { types: ["address", "uint256"], values: ["0x<address>", 0] },
salt: "0x<bytes32>",
});
部署
本节中的功能接受符合EIP1193的提供者,并进行创建主复制和模块实例的交易. 在开发新的模块或修改器时,通常用于与Hardhat等供应商的合同基础设施.
deployFactories
在指定的网络内部署所有工厂。 通常,这些工厂已经跨网络部署;然而,这一功能对于测试设置是有用的.
import { deployFactories } from "@gnosis-guild/zodiac-core/tooling";
await deployFactories({
provider, // an EIP1193 compliant provider
});
deployMastercopy
使用ERC2470工厂安装了总拷贝. 如果主副本已经部署, 此脚本将不执行操作 。 返回包含主复制地址和布尔符的物体,以显示主复制是否先前已部署.
import { deployMastercopy } from "@gnosis-guild/zodiac-core/tooling";
await deployMastercopy({
bytecode, // the mastercopy bytecode
constructorArgs: { // mastercopy creation args
types: ["uint256", "...more constructor types"]
values: ["0", "...more constructor values"]
},
salt, // create2 salt
provider, // an EIP1193 compliant provider
});
deployProxy
使用 ZodiacMuduleProxy Factory 作为代理服务器部署模块实例 。 如果同一盐诺斯的一例已经存在,则此函数无济于事. 返回包含模块实例地址的对象和显示主副本是否先前已部署的布尔 .
import { deployProxy } from "@gnosis-guild/zodiac-core/tooling";
await deployProxy({
mastercopy, // the mastercopy address
setupArgs: { // instance setup args
types: ["uint256", "...more setup types"]
values: ["0", "...more setup values"]
},
saltNonce, // an integer, used to salt proxy deployment
provider, // an EIP1193 compliant provider
});
核查
核查功能使您能够确认已部署的合同源代码和元数据与区块链探险者(如以太斯干)的预期相符。 这些功能确保API URL可以被到达,所提供API 密钥是有效的,并检查合同是否已经核实. 他们还支持为不属于默认配置的探索者设置一个可选的自定义API URL.
校验磁盘
通过检查勘探者是否已经核实了总复制合同,验证合同,如果没有,则提交合同的源代码和元数据进行核查.
import { verifyMastercopy } from "@gnosis-guild/zodiac-core/tooling";
const result = await verifyMastercopy({
chainId: 1,
apiKey: "YourEtherscanApiKey",
artifact: {
contractName: "MyContract",
sourceName: "MyContract.sol",
compilerVersion: "v0.8.0+commit.c7dfd78e",
compilerInput: {},
address: "0x1234567890abcdef1234567890abcdef12345678",
constructorArgs: {
types: ["uint256"],
values: [42],
},
},
apiUrl: "https://api.customnet.io/api", // Optional custom API URL
});
console.log(result);