使用truffle來練習撰寫認養寵物的智能合約

pragma solidity ^0.4.4;
// 告訴compiler 現在要用哪個版本編譯

contract Adoption { //宣告一個 contract的class 叫 Adoption
  // 存放領養飼主的地址（預設是有16隻狗等待被認養）
  address[16] public adopters; 
  

  // 有人要認養某隻寵物(petId)，判斷是否可以認養，
  // 回傳該認養的寵物ID以證明該寵物成功被某用戶認養
  function adopt(uint petId) public returns (uint) {
     
      require(petId >= 0 && petId <= 15);
      // 判斷petId，若不符合結束該函式，不再往下執行
       
      adopters[petId] = msg.sender;
      // 透過msg.sender取得呼叫該函式的使用者
      // 也就是認養該寵物的用戶ID

    return petId;
  }
  
  // 回傳所有的認養者，回傳值的型態為address[16]
  function getAdopters() public returns (address[16]) {
    return adopters;
  }
  
}

// 引入編譯合約的內容
var Migrations = artifacts.require("./Migrations.sol");

module.exports = function(deployer) {
  deployer.deploy(Migrations);
};

var Adoption = artifacts.require("./Adoption.sol");

module.exports = function(deployer) {
  deployer.deploy(Adoption);
};

pragma solidity ^0.4.11;

// 引用truffle內建的檔案 
// Assert.sol用來做Unit test (判斷function input ?= output)
import "truffle/Assert.sol";
// 當測試執行，truffle會在testrpc中測試該合約，
// 該DeployedAddresses用來取得被部署合約的address
import "truffle/DeployedAddresses.sol";
// 要被測試的合約
import "../contracts/Adoption.sol";

contract TestAdoption {
    Adoption adoption = Adoption(DeployedAddresses.Adoption());

    // Testing The adopt() Function

    function testUserCanAdoptPet() {
      // 呼叫Adoption中的adopt方法
      uint returnedId = adoption.adopt(8);

      uint expected = 8;
      
      // 判斷returnID 是否等於 expected的值
      Assert.equal(returnedId, expected, "Adoption of pet ID 8 should be recorded.");
    }
    
    // Testing Retrieval of a Single Pet's Owner
    
    function testGetAdopterAddressByPetId() {
      // 透過this取得目前合約的地址
      address expected = this;

      address adopter = adoption.adopters(8);

      Assert.equal(adopter, expected, "Owner of pet ID 8 should be recorded.");
    }
    
    // Testing Retrieval of All Pet Owners
    
   function testGetAdopterAddressByPetIdInArray() {
      address expected = this;

      address[16] memory adopters = adoption.getAdopters();

      Assert.equal(adopters[8], expected, "Owner of pet ID 8 should be recorded.");
    }
    
}

App = {
  web3Provider: null,
  contracts: {},

   
  init: function() {
    // 載入寵物的資料
    $.getJSON('../pets.json', function(data) {
      var petsRow = $('#petsRow');
      var petTemplate = $('#petTemplate');

      for (i = 0; i < data.length; i ++) {
        petTemplate.find('.panel-title').text(data[i].name);
        petTemplate.find('img').attr('src', data[i].picture);
        petTemplate.find('.pet-breed').text(data[i].breed);
        petTemplate.find('.pet-age').text(data[i].age);
        petTemplate.find('.pet-location').text(data[i].location);
        petTemplate.find('.btn-adopt').attr('data-id', data[i].id);

        petsRow.append(petTemplate.html());
      }
    });

    return App.initWeb3();
  },

  initWeb3: function() {
  // 初始化web3.js並且設置provider連接testrpc
   
     // 如果偵測到有metamask注入在瀏覽器的web3 instance
    if (typeof web3 !== 'undefined') {
      App.web3Provider = web3.currentProvider;
       // 將currentProvider = metamask
       // 
      web3 = new Web3(web3.currentProvider);
    } else {
      // 若沒有metamask or mist等等之類的，
      // 那就用自己開啟testrpc當成是provider
      App.web3Provider = new web3.providers.HttpProvider('http://localhost:8545');
      web3 = new Web3(App.web3Provider);
    }

    return App.initContract();
  },
  
  initContract: function() {
  
   $.getJSON('Adoption.json', function(data) {
   
      // 取得contract的artifact(Adoption.json) 
      // 例如contract address, ABI (Application Binary Interface)：
      // 即如何使用contract的變數、函式等等
      var AdoptionArtifact = data;
      
      // truffle提供`truffle-contract`來幫助我們監聽已經被migrate的contract
      // 並把contract的artifact傳給truffle-contract'，好讓我們可以跟合約溝通
      App.contracts.Adoption = TruffleContract(AdoptionArtifact);

      // 為contract設置Provider(我們是用metamask)
      App.contracts.Adoption.setProvider(App.web3Provider);

      // 從Adpotion.json的合約資料中，判斷寵物的是否已被認養並做標示
      return App.markAdopted();
    });

    return App.bindEvents();
  },

  bindEvents: function() {
    $(document).on('click', '.btn-adopt', App.handleAdopt);
  },

  handleAdopt: function() {
    event.preventDefault();

    var petId = parseInt($(event.target).data('id'));

    var adoptionInstance;

    // 使用web3來取得user's accounts
    // 這時metamask會跳出交易訊息出來
    web3.eth.getAccounts(function(error, accounts) {
      if (error) {
        console.log(error);
      }
      
      // 選擇第一個accounts作為我們的用戶
      var account = accounts[0];

      App.contracts.Adoption.deployed().then(function(instance) {
        adoptionInstance = instance;

        // 在這裡要執行會花費gas的transaction
        // 取得認養用戶的account，以及點選欲認養的petId
        return adoptionInstance.adopt(petId, {from: account});
      }).then(function(result) {
        // 若回傳結果正常執行markAdopted刷新UI上寵物認養中的狀態
        return App.markAdopted();
      }).catch(function(err) {
        console.log(err.message);
      });
    });
  },

  markAdopted: function(adopters, account) {
   var adoptionInstance;

    App.contracts.Adoption.deployed().then(function(instance) {
      // 取得Adpotion合約的內容
      adoptionInstance = instance;

      // 呼叫合約中的getAdopters方法
      // 利用`call`可以直接讀取Blockchain上的資料，不用花費ether(gas)
      return adoptionInstance.getAdopters.call();
    }).then(function(adopters) {
      for (i = 0; i < adopters.length; i++) {
        if (adopters[i] !== '0x0000000000000000000000000000000000000000') {
          $('.panel-pet').eq(i).find('button').text('Pending...').attr('disabled', true);
        }
      }
    }).catch(function(err) {
      console.log(err.message);
    });
  }
};

$(function() {
  $(window).load(function() {
    App.init();
  });
});