truffle使用笔记

编译

truffle compile仅默认编译自上次编译后被修改过的文件,来减少不必要的编译。如果你想编译全部文件,可以使用--compile-all选项

truffle compile --compile-all

Truffle需要定义的合约名称和文件名准确匹配。举例来说,如果文件名为MyContract.sol,那么合约文件须为如下两者之一(区分大小写):

contract MyContract {
  ...
}
// or
library MyContract {
  ...
}

依赖

你可以通过使用import来声明依赖。Truffle将会按正确顺序依次编译合约,并在需要的时候自动关联库。

部署合约

如果你之前的移植是成功执行的。truffle migrate仅会执行新创建的移植。如果没有新的移植脚本,这个命令不同执行任何操作。可以使用选项--reset来从头执行移植脚本。
例如migrations目录下的移植脚本是4_example_migration.js文件名以数字开头,一个描述性的后缀结尾。数字前缀是必须的,用于记录移植是否成功。后缀仅是为了提高可读性,以方便理解。

部署器(deployer)

你的移植文件会使用部署器来缓存部署任务。所以,你可以按一定顺序排列发布任务,他们会按正确顺序执行

// Stage deploying A before B 先部署A再部署B
deployer.deploy(A);
deployer.deploy(B);

另一选中可选的部署方式是使用Promise。将部署任务做成一个队列,是否部署依赖于前一个合约的执行情况

// Deploy A, then deploy B, passing in A's newly deployed address
deployer.deploy(A).then(function() {
  return deployer.deploy(B, A.address);
});

要实现不同条件的不同部署步骤,移植代码中需要第二个参数network。示例如下:

module.exports = function(deployer, network) {
  // Add demo data if we're not deploying to the live network.
  if (network != "live") {
    deployer.exec("add_demo_data.js");  
  }
}
// Deploy a single contract without constructor arguments
deployer.deploy(A);

// Deploy a single contract with constructor arguments
deployer.deploy(A, arg1, arg2, ...);  //部署合约A构造函数传入的参数

// Deploy multiple contracts, some with arguments and some without.
// This is quicker than writing three `deployer.deploy()` statements as the deployer
// can perform the deployment as a batched request.
//依次部署多个合约
deployer.deploy([
  [A, arg1, arg2, ...],
  B,
  [C, arg1]
]);
DEPLOYER.LINK(LIBRARY, DESTINATIONS)

联接一个已经发布的库到一个或多个合约。destinations可以是一个合约或多个合约组成的一个数组。如果目标合约并不依赖这个库,部署器会忽略掉这个合约。

DEPLOYER.AUTOLINK(CONTRACT)

关联合约依赖的所有库。这需要所依赖的库已经部署,或在其前一步部署。
例子:

// Assume A depends on a LibB and LibC
deployer.deploy([LibB, LibC]);
deployer.autolink(A);

另外你可以省略参数来调用函数autolink()。这会自动关联合约依赖的所有库。需要保证在调用这个函数前,所有被需要的库已经部署了。
例子:

// Link *all* libraries to all available contracts
deployer.autolink();
DEPLOYER.THEN(FUNCTION() {...})

Promise语法糖,执行做生意的部署流程。
例子:

deployer.then(function() {
  // Create a new version of A
  return A.new();
}).then(function(instance) {  //这里的instance就是上边A.new()返回的合约A的实例
  // Set the new instance of A's address on B.
  var b = B.deployed();
  return b.setA(instance.address);
});
DEPLOYER.EXEC(PATHTOFILE)

执行truffle exec做为部署的一部分。查看10. 外部脚本章节了解更多。
例子:

// Run the script, relative to the migrations file.
deployer.exec("../path/to/file/demo_data.js");

捕捉事件(Catching Events)

你的合约可以触发事件,你可以进行捕捉以进行更多的控制。事件API与Web3一样。可以参考Web3 documentation来了解更多。

var meta = MetaCoin.deployed();
var transfers = meta.Transfer({fromBlock: "latest"});
transfers.watch(function(error, result) {
  // This will catch all Transfer events, regardless of how they originated.
  if (error == null) {
    console.log(result.args);
  }
}
METHOD:DEPLOYED()

每一个抽象出来的合约接口都有一个deployed()方法,上述例子中,你已经见到过。调用这个函数返回一个实例,这个实例代表的是之前部署到网络的合约所对应的抽象接口的实例。

var meta = MetaCoin.deployed();

警告:这仅对使用truffle deploy部署的合约,且一定是在project configuration中配置发布的才有效。如果不是这样,这个函数执行时会抛出异常。

METHOD:AT()

类似于deployed(),你可以通过一个地址来得到一个代表合约的抽象接口实例。当然这个地址一定是这个合约的部署地址。

var meta = MetaCoin.at("0x1234...")

警告:当你的地址不正确,或地址对应的合约不正确时,这个函数并不会抛出异常。但调用接口时会报错。请保证在使用at()时输入正确的地址。

METHOD:NEW()

你可以通过这个方法来部署一个完全全新的合约到网络中。

MetaCoin.new().then(function(instance) {
  // `instance` is a new instance of the abstraction.
  // If this callback is called, the deployment was successful.
  console.log(instance.address);
}).catch(function(e) {
  // There was an error! Handle it.
});

需要注意的是这是一个交易,会改变网络的状态。

你可能感兴趣的:(truffle使用笔记)