tuffle-config.js的使用教程

/**
 * Use this file to configure your truffle project. It's seeded with some
 * common settings for different networks and features like migrations,
 * compilation, and testing. Uncomment the ones you need or modify
 * them to suit your project as necessary.
 *
 * More information about configuration can be found at:
 *
 * https://trufflesuite.com/docs/truffle/reference/configuration
 *
 * Hands-off deployment with Infura
 * --------------------------------
 *
 * Do you have a complex application that requires lots of transactions to deploy?
 * Use this approach to make deployment a breeze 🏖️:
 *
 * Infura deployment needs a wallet provider (like @truffle/hdwallet-provider)
 * to sign transactions before they're sent to a remote public node.
 * Infura accounts are available for free at 🔍: https://infura.io/register
 *
 * You'll need a mnemonic - the twelve word phrase the wallet uses to generate
 * public/private key pairs. You can store your secrets 🤐 in a .env file.
 * In your project root, run `$ npm install dotenv`.
 * Create .env (which should be .gitignored) and declare your MNEMONIC
 * and Infura PROJECT_ID variables inside.
 * For example, your .env file will have the following structure:
 *
 * MNEMONIC = <Your 12 phrase mnemonic>
 * PROJECT_ID = <Your Infura project id>
 *
 * Deployment with Truffle Dashboard (Recommended for best security practice)
 * --------------------------------------------------------------------------
 *
 * Are you concerned about security and minimizing rekt status 🤔?
 * Use this method for best security:
 *
 * Truffle Dashboard lets you review transactions in detail, and leverages
 * MetaMask for signing, so there's no need to copy-paste your mnemonic.
 * More details can be found at 🔎:
 *
 * https://trufflesuite.com/docs/truffle/getting-started/using-the-truffle-dashboard/
 */

// require('dotenv').config();
// const { MNEMONIC, PROJECT_ID } = process.env;

// const HDWalletProvider = require('@truffle/hdwallet-provider');

module.exports = {
  /**
   * Networks define how you connect to your ethereum client and let you set the
   * defaults web3 uses to send transactions. If you don't specify one truffle
   * will spin up a managed Ganache instance for you on port 9545 when you
   * run `develop` or `test`. You can ask a truffle command to use a specific
   * network from the command line, e.g
   *
   * $ truffle test --network <network-name>
   */

  networks: {
    // Useful for testing. The `development` name is special - truffle uses it by default
    // if it's defined here and no other network is specified at the command line.
    // You should run a client (like ganache, geth, or parity) in a separate terminal
    // tab if you use this network and you must also set the `host`, `port` and `network_id`
    // options below to some value.
    //
    // development: {
    //  host: "127.0.0.1",     // Localhost (default: none)
    //  port: 8545,            // Standard Ethereum port (default: none)
    //  network_id: "*",       // Any network (default: none)
    // },
    //
    // An additional network, but with some advanced options…
    // advanced: {
    //   port: 8777,             // Custom port
    //   network_id: 1342,       // Custom network
    //   gas: 8500000,           // Gas sent with each transaction (default: ~6700000)
    //   gasPrice: 20000000000,  // 20 gwei (in wei) (default: 100 gwei)
    //   from: <address>,        // Account to send transactions from (default: accounts[0])
    //   websocket: true         // Enable EventEmitter interface for web3 (default: false)
    // },
    //
    // Useful for deploying to a public network.
    // Note: It's important to wrap the provider as a function to ensure truffle uses a new provider every time.
    // goerli: {
    //   provider: () => new HDWalletProvider(MNEMONIC, `https://goerli.infura.io/v3/${PROJECT_ID}`),
    //   network_id: 5,       // Goerli's id
    //   confirmations: 2,    // # of confirmations to wait between deployments. (default: 0)
    //   timeoutBlocks: 200,  // # of blocks before a deployment times out  (minimum/default: 50)
    //   skipDryRun: true     // Skip dry run before migrations? (default: false for public nets )
    // },
    //
    // Useful for private networks
    // private: {
    //   provider: () => new HDWalletProvider(MNEMONIC, `https://network.io`),
    //   network_id: 2111,   // This network is yours, in the cloud.
    //   production: true    // Treats this network as if it was a public net. (default: false)
    // }
  },

  // Set default mocha options here, use special reporters, etc.
  mocha: {
    // timeout: 100000
  },

  // Configure your compilers
  compilers: {
    solc: {
      version: "0.8.21",      // Fetch exact version from solc-bin (default: truffle's version)
      // docker: true,        // Use "0.5.1" you've installed locally with docker (default: false)
      // settings: {          // See the solidity docs for advice about optimization and evmVersion
      //  optimizer: {
      //    enabled: false,
      //    runs: 200
      //  },
      //  evmVersion: "byzantium"
      // }
    }
  },

  // Truffle DB is currently disabled by default; to enable it, change enabled:
  // false to enabled: true. The default storage location can also be
  // overridden by specifying the adapter settings, as shown in the commented code below.
  //
  // NOTE: It is not possible to migrate your contracts to truffle DB and you should
  // make a backup of your artifacts to a safe location before enabling this feature.
  //
  // After you backed up your artifacts you can utilize db by running migrate as follows:
  // $ truffle migrate --reset --compile-all
  //
  // db: {
  //   enabled: false,
  //   host: "127.0.0.1",
  //   adapter: {
  //     name: "indexeddb",
  //     settings: {
  //       directory: ".db"
  //     }
  //   }
  // }
};

Networks（网络配置）

• development: 这是默认的本地开发网络。如果你在命令行没有指定其他网络，Truffle 会使用这个网络。你需要在另一个终端运行一个以太坊客户端，并设置 host、port 和 network_id。
• JavaScript

  development: {
    host: "127.0.0.1",     // 本地主机
    port: 8545,            // 以太坊标准端口
    network_id: "*",       // 任意网络
  },
  

• advanced: 这是一个包含自定义设置的网络配置示例，你可以设置自定义端口、网络ID、gas限制、gas价格和指定交易发送账户。
• JavaScript

  advanced: {
    port: 8777,             // 自定义端口
    network_id: 1342,       // 自定义网络ID
    gas: 8500000,           // 每笔交易发送的gas量
    gasPrice: 20000000000,  // gas价格（单位：wei）
    from: <address>,        // 发送交易的账户
    websocket: true         // 启用web3的EventEmitter接口
  },
  

• goerli: 这是用于部署到 Goerli 测试网络的配置。它使用 HDWalletProvider 和 Infura 服务来签署和发送交易。
• JavaScript

  goerli: {
    provider: () => new HDWalletProvider(MNEMONIC, `https://goerli.infura.io/v3/${PROJECT_ID}`),
    network_id: 5,          // Goerli网络的ID
    confirmations: 2,       // 部署之间等待的确认数
    timeoutBlocks: 200,     // 部署超时前的区块数
    skipDryRun: true        // 是否跳过公共网络的干运行
  },
  

Mocha（测试框架配置）

• mocha: 这里可以设置 Mocha 测试框架的默认选项，例如特殊的报告器或超时设置。
• JavaScript

  mocha: {
    timeout: 100000 // 测试超时时间
  },
  

Compilers（编译器配置）

• solc: 这里配置 Solidity 编译器的选项，例如指定版本号、是否使用 Docker、优化设置和 EVM 版本。
• JavaScript

  compilers: {
    solc: {
      version: "0.8.21",    // 从solc-bin获取确切版本号
      settings: {
        optimizer: {
          enabled: false,   // 是否启用优化器
          runs: 200         // 优化器执行的次数
        },
        evmVersion: "byzantium" // EVM版本
      }
    }
  },
  

Truffle DB（数据库配置）

• db: 这是 Truffle DB 的配置，用于存储和管理智能合约的构建和迁移数据。默认情况下是禁用的，但可以启用并配置存储位置。
• JavaScript

  db: {
    enabled: false, // 是否启用 Truffle DB
    host: "127.0.0.1",
    adapter: {
      name: "indexeddb",
      settings: {
        directory: ".db" // 数据库存储位置
      }
    }
  }
  

这个配置文件是 Truffle 项目的核心，它告诉 Truffle 如何与以太坊网络交互，以及如何编译和测试智能合约。