Анатомія смарт-контрактів

// Приклад 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 {

    // Оголошує змінну стану `message` типу `string`.
    // Змінні стану — це змінні, значення яких постійно зберігаються у сховищі контракту.
    // Ключове слово `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`.
    function update(string memory newMessage) public {
        message = newMessage;
    }
}

pragma solidity ^0.5.10;

contract Token {
    // Адресу (`address`) можна порівняти з адресою електронної пошти — вона використовується для ідентифікації облікового запису в Етеріум.
    // Адреси можуть представляти смарт-контракт або зовнішні (користувацькі) облікові записи.
    // Дізнатися більше: 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) public 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.");

        // Коригує баланси токенів двох адрес
        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 {
    // Використовує бібліотеку SafeMath від OpenZeppelin для безпечного виконання арифметичних операцій.
    // Дізнатися більше: 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;

    // Ви можете вкладати відображення (mappings), цей приклад відображає власника на схвалення оператора
    mapping(address => mapping(address => bool)) private operatorApprovals;

    // Внутрішня функція для створення випадкової Pizza з рядка (name) та 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)
    {
        // Додає Pizza до масиву Pizzas та отримує id
        uint256 id = SafeMath.sub(pizzas.push(Pizza(_name, _dna)), 1);

        // Перевіряє, що власник Pizza є тим самим, що й поточний користувач
        // Дізнатися більше: 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));

        // Відображає Pizza на власника
        pizzaToOwner[id] = msg.sender;
        ownerPizzaCount[msg.sender] = SafeMath.add(
            ownerPizzaCount[msg.sender],
            1
        );
    }

    // Створює випадкову Pizza з рядка (name)
    function createRandomPizza(string memory _name) public {
        uint256 randDna = generateRandomDna(_name, msg.sender);
        _createPizza(_name, randDna);
    }

    // Генерує випадкову DNA з рядка (name) та адреси власника (творця)
    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 з рядка (name) + адреси (owner)
        uint256 rand = uint256(keccak256(abi.encodePacked(_str))) +
            uint256(_owner);
        rand = rand % dnaModulus;
        return rand;
    }

    // Повертає масив Pizzas, знайдених за власником
    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;
    }

    // Передає Pizza та право власності на іншу адресу
    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);
    }

    // Спалює Pizza — повністю знищує токен
    // Модифікатор функції `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);
    }

    // Повертає кількість Pizzas за адресою
    function balanceOf(address _owner) public view returns (uint256 _balance) {
        return ownerPizzaCount[_owner];
    }

    // Повертає власника Pizza, знайденої за id
    function ownerOf(uint256 _pizzaId) public view returns (address _owner) {
        address owner = pizzaToOwner[_pizzaId];
        require(owner != address(0), "Invalid Pizza ID.");
        return owner;
    }

    // Схвалює іншу адресу для передачі права власності на Pizza
    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);
    }

    // Повертає схвалену адресу для конкретної Pizza
    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];
    }

    // Бере на себе право власності на Pizza — лише для схвалених користувачів
    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);
    }

    // Перевіряє, чи існує Pizza
    function _exists(uint256 pizzaId) internal view returns (bool) {
        address owner = pizzaToOwner[pizzaId];
        return owner != address(0);
    }

    // Перевіряє, чи є адреса власником або чи схвалена вона для передачі Pizza
    function _isApprovedOrOwner(address spender, uint256 pizzaId)
        internal
        view
        returns (bool)
    {
        address owner = pizzaToOwner[pizzaId];
        // Вимкнути перевірку solium через
        // https://github.com/duaraghav8/Solium/issues/175
        // solium-disable-next-line operator-whitespace
        return (spender == owner ||
            this.getApproved(pizzaId) == spender ||
            this.isApprovedForAll(owner, spender));
    }

    // Перевірити, чи є Pizza унікальною і чи ще не існує
    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;
    }
}