スマートコントラクトの解剖学

// Solidityの例
// コントラクトのデータを初期化し、`owner`を
// コントラクト作成者のアドレスに設定します。
constructor() public {
    // すべてのスマートコントラクトは、その関数をトリガーするために外部トランザクションに依存します。
    // `msg`は、送信者のアドレスやトランザクションに含まれるETHの量など、
    // 特定のトランザクションに関する関連データを含むグローバル変数です。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/units-and-global-variables.html#block-and-transaction-properties
    owner = msg.sender;
}

pragma solidity >=0.4.0 <=0.6.0;

contract ExampleDapp {
    string dapp_name; // 状態変数

    // コントラクトがデプロイされたときに呼び出され、値を初期化します
    constructor() public {
        dapp_name = "My Example dapp";
    }

    // Get関数
    function read_name() public view returns(string) {
        return dapp_name;
    }

    // Set関数
    function update_name(string value) public {
        dapp_name = value;
    }
}

// セマンティックバージョニングを使用して、Solidityのバージョンを指定します。
// 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/layout-of-source-files.html#pragma
pragma solidity ^0.5.10;

// `HelloWorld`という名前のコントラクトを定義します。
// コントラクトは、関数とデータ(その状態)のコレクションです。
// デプロイされると、コントラクトはイーサリアムブロックチェーン上の特定のアドレスに配置されます。
// 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/structure-of-a-contract.html
contract HelloWorld {

    // `string`型の状態変数`message`を宣言します。
    // 状態変数は、その値がコントラクトのストレージに永続的に保存される変数です。
    // `public`キーワードは、変数をコントラクトの外部からアクセス可能にし、
    // 他のコントラクトやクライアントが値をアクセスするために呼び出すことができる関数を作成します。
    string public message;

    // 多くのクラスベースのオブジェクト指向言語と同様に、コンストラクタは
    // コントラクトの作成時にのみ実行される特別な関数です。
    // コンストラクタは、コントラクトのデータを初期化するために使用されます。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#constructors
    constructor(string memory initMessage) public {
        // 文字列引数`initMessage`を受け入れ、その値を
        // コントラクトの`message`ストレージ変数に設定します)。
        message = initMessage;
    }

    // 文字列引数を受け入れ、
    // `message`ストレージ変数を更新するpublic関数です。
    function update(string memory newMessage) public {
        message = newMessage;
    }
}

pragma solidity ^0.5.10;

contract Token {
    // `address`はEメールアドレスに似ています - イーサリアム上のアカウントを識別するために使用されます。
    // アドレスは、スマートコントラクトまたは外部(ユーザー)アカウントを表すことができます。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/types.html#address
    address public owner;

    // `mapping`は、本質的にハッシュテーブルのデータ構造です。
    // この`mapping`は、符号なし整数(トークン残高)をアドレス(トークン保有者)に割り当てます。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/types.html#mapping-types
    mapping (address => uint) balances;

    // イベントにより、ブロックチェーン上のアクティビティをログに記録できます。
    // イーサリアムクライアントは、コントラクトの状態変更に反応するためにイベントをリッスンできます。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#events
    event Transfer(address from, address to, uint amount);

    // コントラクトのデータを初期化し、`owner`を
    // コントラクト作成者のアドレスに設定します。
    constructor() public {
        // すべてのスマートコントラクトは、その関数をトリガーするために外部トランザクションに依存します。
        // `msg`は、送信者のアドレスやトランザクションに含まれるETHの量など、
        // 特定のトランザクションに関する関連データを含むグローバル変数です。
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/units-and-global-variables.html#block-and-transaction-properties
        owner = msg.sender;
    }

    // 新しいトークンを作成し、アドレスに送信します。
    function mint(address receiver, uint amount) public {
        // `require`は、特定の条件を強制するために使用される制御構造です。
        // `require`ステートメントが`false`と評価された場合、例外がトリガーされ、
        // 現在の呼び出し中に行われた状態へのすべての変更が元に戻されます。
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/control-structures.html#error-handling-assert-require-revert-and-exceptions

        // コントラクトのオーナーのみがこの関数を呼び出すことができます
        require(msg.sender == owner, "You are not the owner.");

        // トークンの最大量を強制します
        require(amount < 1e60, "Maximum issuance exceeded");

        // `receiver`の残高を`amount`だけ増やします
        balances[receiver] += amount;
    }

    // 任意の呼び出し元からアドレスに既存のトークンを送信します。
    function transfer(address receiver, uint amount) public {
        // 送信者は送信するのに十分なトークンを持っている必要があります
        require(amount <= balances[msg.sender], "Insufficient balance.");

        // 2つのアドレスのトークン残高を調整します
        balances[msg.sender] -= amount;
        balances[receiver] += amount;

        // 先に定義されたイベントを発行します
        emit Transfer(msg.sender, receiver, amount);
    }
}

pragma solidity ^0.5.10;

// 他のファイルから現在のコントラクトにシンボルをインポートします。
// このケースでは、OpenZeppelinの一連のヘルパーコントラクトです。
// 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/layout-of-source-files.html#importing-other-source-files

import "../node_modules/@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "../node_modules/@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
import "../node_modules/@openzeppelin/contracts/introspection/ERC165.sol";
import "../node_modules/@openzeppelin/contracts/math/SafeMath.sol";

// `is`キーワードは、外部コントラクトから関数とキーワードを継承するために使用されます。
// このケースでは、`CryptoPizza`は`IERC721`と`ERC165`コントラクトから継承します。
// 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#inheritance
contract CryptoPizza is IERC721, ERC165 {
    // OpenZeppelinのSafeMathライブラリを使用して、算術演算を安全に実行します。
    // 詳細はこちら: https://docs.openzeppelin.com/contracts/2.x/api/math#SafeMath
    using SafeMath for uint256;

    // Solidityの定数状態変数は他の言語に似ていますが、
    // コンパイル時に定数である式から代入する必要があります。
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#constant-state-variables
    uint256 constant dnaDigits = 10;
    uint256 constant dnaModulus = 10 ** dnaDigits;
    bytes4 private constant _ERC721_RECEIVED = 0x150b7a02;

    // Struct型を使用すると、独自の型を定義できます
    // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/types.html#structs
    struct Pizza {
        string name;
        uint256 dna;
    }

    // Pizza構造体の空の配列を作成します
    Pizza[] public pizzas;

    // ピザIDからそのオーナーのアドレスへのマッピング
    mapping(uint256 => address) public pizzaToOwner;

    // オーナーのアドレスから所有トークン数へのマッピング
    mapping(address => uint256) public ownerPizzaCount;

    // トークンIDから承認済みアドレスへのマッピング
    mapping(uint256 => address) pizzaApprovals;

    // マッピングをネストすることができます。この例では、オーナーをオペレーターの承認にマッピングします
    mapping(address => mapping(address => bool)) private operatorApprovals;

    // 文字列(名前)とDNAからランダムなピザを作成する内部関数
    function _createPizza(string memory _name, uint256 _dna)
        // `internal`キーワードは、この関数がこのコントラクトおよび
        // このコントラクトを派生するコントラクト内でのみ参照可能であることを意味します
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#visibility-and-getters
        internal
        // `isUnique`は、ピザがすでに存在するかどうかをチェックする関数修飾子です
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/structure-of-a-contract.html#function-modifiers
        isUnique(_name, _dna)
    {
        // ピザをピザ配列に追加し、IDを取得します
        uint256 id = SafeMath.sub(pizzas.push(Pizza(_name, _dna)), 1);

        // ピザのオーナーが現在のユーザーと同じであることを確認します
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/control-structures.html#error-handling-assert-require-revert-and-exceptions

        // address(0)はゼロアドレスであり、
        // pizza[id]がまだ特定のユーザーに割り当てられていないことを示します。

        assert(pizzaToOwner[id] == address(0));

        // ピザをオーナーにマッピングします
        pizzaToOwner[id] = msg.sender;
        ownerPizzaCount[msg.sender] = SafeMath.add(
            ownerPizzaCount[msg.sender],
            1
        );
    }

    // 文字列(名前)からランダムなピザを作成します
    function createRandomPizza(string memory _name) public {
        uint256 randDna = generateRandomDna(_name, msg.sender);
        _createPizza(_name, randDna);
    }

    // 文字列(名前)とオーナーのアドレス(作成者)からランダムなDNAを生成します
    function generateRandomDna(string memory _str, address _owner)
        public
        // `pure`とマークされた関数は、状態の読み取りや変更を行わないことを約束します
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#pure-functions
        pure
        returns (uint256)
    {
        // 文字列(名前) + アドレス(オーナー)からランダムなuintを生成します
        uint256 rand = uint256(keccak256(abi.encodePacked(_str))) +
            uint256(_owner);
        rand = rand % dnaModulus;
        return rand;
    }

    // オーナーによって見つかったピザの配列を返します
    function getPizzasByOwner(address _owner)
        public
        // `view`とマークされた関数は、状態を変更しないことを約束します
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/contracts.html#view-functions
        view
        returns (uint256[] memory)
    {
        // `memory`ストレージの場所を使用して、この関数呼び出しの
        // ライフサイクル中のみ値を格納します。
        // 詳細はこちら: https://solidity.readthedocs.io/en/v0.5.10/introduction-to-smart-contracts.html#storage-memory-and-the-stack
        uint256[] memory result = new uint256[](ownerPizzaCount[_owner]);
        uint256 counter = 0;
        for (uint256 i = 0; i < pizzas.length; i++) {
            if (pizzaToOwner[i] == _owner) {
                result[counter] = i;
                counter++;
            }
        }
        return result;
    }

    // ピザと所有権を他のアドレスに転送します
    function transferFrom(address _from, address _to, uint256 _pizzaId) public {
        require(_from != address(0) && _to != address(0), "Invalid address.");
        require(_exists(_pizzaId), "Pizza does not exist.");
        require(_from != _to, "Cannot transfer to the same address.");
        require(_isApprovedOrOwner(msg.sender, _pizzaId), "Address is not approved.");

        ownerPizzaCount[_to] = SafeMath.add(ownerPizzaCount[_to], 1);
        ownerPizzaCount[_from] = SafeMath.sub(ownerPizzaCount[_from], 1);
        pizzaToOwner[_pizzaId] = _to;

        // インポートされたIERC721コントラクトで定義されたイベントを発行します
        emit Transfer(_from, _to, _pizzaId);
        _clearApproval(_to, _pizzaId);
    }

    /**
     * 指定されたトークンIDの所有権を別のアドレスに安全に転送します
     * ターゲットアドレスがコントラクトの場合、`onERC721Received`を実装する必要があります。
     * これは安全な転送時に呼び出され、マジック値を返します
     * `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`;
     * そうでない場合、転送は取り消されます。
    */
    function safeTransferFrom(address from, address to, uint256 pizzaId)
        public
    {
        // solium-disable-next-line arg-overflow
        this.safeTransferFrom(from, to, pizzaId, "");
    }

    /**
     * 指定されたトークンIDの所有権を別のアドレスに安全に転送します
     * ターゲットアドレスがコントラクトの場合、`onERC721Received`を実装する必要があります。
     * これは安全な転送時に呼び出され、マジック値を返します
     * `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`;
     * そうでない場合、転送は取り消されます。
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 pizzaId,
        bytes memory _data
    ) public {
        this.transferFrom(from, to, pizzaId);
        require(_checkOnERC721Received(from, to, pizzaId, _data), "Must implement onERC721Received.");
    }

    /**
     * ターゲットアドレスで`onERC721Received`を呼び出す内部関数
     * ターゲットアドレスがコントラクトでない場合、呼び出しは実行されません
     */
    function _checkOnERC721Received(
        address from,
        address to,
        uint256 pizzaId,
        bytes memory _data
    ) internal returns (bool) {
        if (!isContract(to)) {
            return true;
        }

        bytes4 retval = IERC721Receiver(to).onERC721Received(
            msg.sender,
            from,
            pizzaId,
            _data
        );
        return (retval == _ERC721_RECEIVED);
    }

    // ピザを燃やす - トークンを完全に破壊する
    // `external`関数修飾子は、この関数が
    // コントラクトインターフェースの一部であり、他のコントラクトがそれを呼び出すことができることを意味します
    function burn(uint256 _pizzaId) external {
        require(msg.sender != address(0), "Invalid address.");
        require(_exists(_pizzaId), "Pizza does not exist.");
        require(_isApprovedOrOwner(msg.sender, _pizzaId), "Address is not approved.");

        ownerPizzaCount[msg.sender] = SafeMath.sub(
            ownerPizzaCount[msg.sender],
            1
        );
        pizzaToOwner[_pizzaId] = address(0);
    }

    // アドレスごとのピザの数を返します
    function balanceOf(address _owner) public view returns (uint256 _balance) {
        return ownerPizzaCount[_owner];
    }

    // IDで見つかったピザのオーナーを返します
    function ownerOf(uint256 _pizzaId) public view returns (address _owner) {
        address owner = pizzaToOwner[_pizzaId];
        require(owner != address(0), "Invalid Pizza ID.");
        return owner;
    }

    // 他のアドレスがピザの所有権を転送することを承認します
    function approve(address _to, uint256 _pizzaId) public {
        require(msg.sender == pizzaToOwner[_pizzaId], "Must be the Pizza owner.");
        pizzaApprovals[_pizzaId] = _to;
        emit Approval(msg.sender, _to, _pizzaId);
    }

    // 特定のピザの承認済みアドレスを返します
    function getApproved(uint256 _pizzaId)
        public
        view
        returns (address operator)
    {
        require(_exists(_pizzaId), "Pizza does not exist.");
        return pizzaApprovals[_pizzaId];
    }

    /**
     * 指定されたトークンIDの現在の承認をクリアするプライベート関数
     * 指定されたアドレスがトークンのオーナーでない場合、取り消されます
     */
    function _clearApproval(address owner, uint256 _pizzaId) private {
        require(pizzaToOwner[_pizzaId] == owner, "Must be pizza owner.");
        require(_exists(_pizzaId), "Pizza does not exist.");
        if (pizzaApprovals[_pizzaId] != address(0)) {
            pizzaApprovals[_pizzaId] = address(0);
        }
    }

    /*
     * 指定されたオペレーターの承認を設定または解除します
     * オペレーターは、送信者に代わってすべてのトークンを転送することが許可されます
     */
    function setApprovalForAll(address to, bool approved) public {
        require(to != msg.sender, "Cannot approve own address");
        operatorApprovals[msg.sender][to] = approved;
        emit ApprovalForAll(msg.sender, to, approved);
    }

    // オペレーターが指定されたオーナーによって承認されているかどうかを通知します
    function isApprovedForAll(address owner, address operator)
        public
        view
        returns (bool)
    {
        return operatorApprovals[owner][operator];
    }

    // ピザの所有権を取得する - 承認されたユーザーのみ
    function takeOwnership(uint256 _pizzaId) public {
        require(_isApprovedOrOwner(msg.sender, _pizzaId), "Address is not approved.");
        address owner = this.ownerOf(_pizzaId);
        this.transferFrom(owner, msg.sender, _pizzaId);
    }

    // ピザが存在するかどうかを確認します
    function _exists(uint256 pizzaId) internal view returns (bool) {
        address owner = pizzaToOwner[pizzaId];
        return owner != address(0);
    }

    // アドレスがオーナーであるか、ピザの転送が承認されているかを確認します
    function _isApprovedOrOwner(address spender, uint256 pizzaId)
        internal
        view
        returns (bool)
    {
        address owner = pizzaToOwner[pizzaId];
        // 以下によるソリウムチェックの無効化
        // https://github.com/duaraghav8/Solium/issues/175
        // solium-disable-next-line operator-whitespace
        return (spender == owner ||
            this.getApproved(pizzaId) == spender ||
            this.isApprovedForAll(owner, spender));
    }

    // ピザがユニークでまだ存在しないかを確認します
    modifier isUnique(string memory _name, uint256 _dna) {
        bool result = true;
        for (uint256 i = 0; i < pizzas.length; i++) {
            if (
                keccak256(abi.encodePacked(pizzas[i].name)) ==
                keccak256(abi.encodePacked(_name)) &&
                pizzas[i].dna == _dna
            ) {
                result = false;
            }
        }
        require(result, "Pizza with such name already exists.");
        _;
    }

    // ターゲットアドレスがコントラクトであるかどうかを返します
    function isContract(address account) internal view returns (bool) {
        uint256 size;
        // 現在、アドレスにコントラクトがあるかどうかを確認するのに、
        // そのアドレスのコードのサイズを確認するより良い方法はありません。
        // これがどのように機能するかについての詳細は、https://ethereum.stackexchange.com/a/14016/36603
        // を参照してください。
        // TODO Serenityリリースの前にこれを再確認してください。すべての
        // アドレスがコントラクトになるためです。
        // solium-disable-next-line security/no-inline-assembly
        assembly {
            size := extcodesize(account)
        }
        return size > 0;
    }
}