@acdi/efem-crowdfunding 中文文档教程

Question

Crowdfunding Smart Contract

智能合约去众筹。

使用 Buidler como herramienta de las tareas de compilación，测试您的智能合约。

En la sección Architectural Decision Log se encuentran los registros de decisiones de arquitectura que han sido tomadas。

Requisitos sobre sistema operativo

Windows

安装 Python。

Instalación de dependencias

Primero deben instalarse las dependencias del proyecto con el siguiente comando:

npm install

Compilación

Para compilar el smart contract, debe ejecutarse el siguiente comando。

npm run compile

Se requiere mantener reducido el bytecode generado por el smart contract para no superar la restricción EIP 170。 El siguiente comando mide la cantidad de bytes generados para cada contrato compilado。

grep \"bytecode\" artifacts/* | awk '{print $1 " " length($3)/2}'

Testing

Para ejecutar los tests del smart contract, debe ejecutarse el siguiente comando。

npm run test

Los test se ejecutan por defect sobre la blockchain buidlerevm。

Publicar en NPM

Para que el módulo quede públicamente accecible y pueda utilizarse por los demás módulos de la applicación, es necesario publicar de la siguiente manera:

npm login
npm publish --access public

El módulo se publica con el scope de la organización @acdi。

Despliegue

Para desplegar el smart contract sobre la blockchain de RSK, debe ejecutarse el siguiente comando con el nodo RSK accesible desde http://localhost:4444。

npm run deploy:rsk

Junto con el smart contract de Crowdfunding se despliegan los smart contract de Aragon y librerías por lo que este proceso puede demandar algunos minutos。

Las direcciones que aparecen en el log deben utilizarse para configurar la applicación de Crowdfunding。

Algunas veces el script anterior falla al no encontrar algunos smart contracts de Aragon desplegados, por ejemplo, es posible encontrarse con el siguiente error: Error: BDLR700: Artifact for contract "Kernel" not found. En este caso ejecutamos <代码>npm 开始。 Esto último 一个 menudo muestra algún 错误，pero lo que nos interesa es que despliegue los smart contracts faltantes。 Una vez hecho esto volver a ejecutar npm run deploy:rsk

Principios de desarrollo

Para el desarrollo del smart contract se deben seguir los siguientes principios:

• Seguir la guía de estilos de desarrollo de Solidity.
• El orden los metodos debe ser: external, public, internal y private; Deben seguir un orden de relevancia.
• Siempre que sea posible, el tratamiento sobre las entidades debe delegarse en las librerías para mantener el bytecode del smart contract reducido.
• Sebe realizarse testing automático de las funcionalidades expuestas al exterior.

Running your app

要在具有前端和合同热重载的浏览器中运行应用程序，只需运行 <代码>npm 开始。

1. Add code quality tools, like JS and contract linting. You may also want to check existing buidler plugins.
2. Develop your AragonApp contract
3. Develop your frontend
4. Publish!

What's in this boilerplate?

npm Scripts

• postinstall: Runs after installing dependencies.
• build-app: Installs front end project (app/) dependencies.
• start Runs your app inside a DAO.
• compile: Compiles the smart contracts.
• test: Runs tests for the contracts.
• publish:major: Releases a major version to aragonPM.
• publish:minor: Releases a minor version to aragonPM.
• publish:patch: Releases a patch version to aragonPM.

Hooks

这些钩子在启动任务的生命周期中由 Aragon Buidler 插件调用。 使用它们在开发构建过程的某些入口点执行自定义任务，例如在初始化代理之前部署令牌等。

将它们链接到 aragon 中的主构建器配置文件 (buidler.config.js)。钩子属性。

所有挂钩都接收两个参数：1) 一个 params 对象，它可能包含属于特定挂钩的其他对象。 2) 一个“bre”或 BuidlerRuntimeEnvironment 对象，其中包含 web3、Truffle 工件等环境对象。

// Called before a dao is deployed.
preDao: async ({ log }, { web3, artifacts }) => {},

// Called after a dao is deployed.
postDao: async ({ dao, _experimentalAppInstaller, log }, { web3, artifacts }) => {},

// Called after the app's proxy is created, but before it's initialized.
preInit: async ({ proxy, _experimentalAppInstaller, log  }, { web3, artifacts }) => {},

// Called after the app's proxy is initialized.
postInit: async ({ proxy, _experimentalAppInstaller, log  }, { web3, artifacts }) => {},

// Called when the start task needs to know the app proxy's init parameters.
// Must return an array with the proxy's init parameters.
getInitParams: async ({ log }, { web3, artifacts }) => {
  return []
}

如果您想了解如何使用这些挂钩的示例，请参阅 示例项目的插件自己的测试。

Structure

该样板文件具有以下结构：

root
├── app
├ ├── src
├ └── package.json
├── contracts
├ └── CounterApp.sol
├── test
├── arapp.json
├── manifest.json
├── buidler.config.js
└── package.json

• app: Frontend folder. Completely encapsulated: has its own package.json and dependencies.
• src: Source files.
• package.json: Frontend npm configuration file.
• contracts: Smart contracts folder.
• CounterApp.sol: AragonApp contract example.
• test: Tests folder.
• arapp.json: Aragon configuration file. Includes Aragon-specific metadata for your app.
• manifest.json: Aragon configuration file. Includes web-specific configuration.
• buidler.config.js: Buidler configuration file.
• package.json: Main npm configuration file.

Libraries

• @aragon/os: AragonApp smart contract interfaces.
• @aragon/api: Aragon client application API.
• @aragon/ui: Aragon UI components (in React).
• @aragon/buidler-aragon: Aragon Buidler plugin.