Add ability to generate ERC20 tokens #1116

mederic-p · 2019-07-15T09:45:03Z

Issue/Task Number: 703
Closes #703

Overview

This PR adds the ability to deploy 2 types of ERC20 tokens via a new endpoint token.deploy_erc20.
The 2 types are:

A non mintable ERC20 token with a total supply defined during the contract creation.
A mintable ERC20 token that has a mint function which can be called until finishMinting is called.

This implementation does not require the solidity compiler to work. Indeed the 2 contracts are already pre-compiled and their binary/ABI has been extracted (source files can be found under apps/eth_blockchain/contracts/ERC20 and compiled files under apps/eth_blockchain/contracts/compiled).

This feature is not production ready

Changes

New endpoint: token.deploy_erc20

Implementation Details

Contract sources were taken from https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts and were not modified except for:

ERC20EWalletMintable.sol
ERC20EWallet.sol
ERC20MintableLocked.sol

Contracts were compiled using solidity compiler 0.5.0+commit.1d4f565a, more info here.

Usage

The easiest way to test is by using the updated swagger spec. To test the creation of a mintable token, the param locked needs to be false and true for a non-mintable token.

Impact

Run migrations.

unnawut · 2019-07-24T03:09:26Z

This feature is not production ready

Can you mention a bit what's needed to make it production ready?

mederic-p · 2019-07-24T04:33:53Z

This feature is not production ready

Can you mention a bit what's needed to make it production ready?

It's mostly because I wrote some of the smart contract myself and they obviously need to be audited (even if it's quite straightforward and nothing complicated).

Also it's missing quite a few steps/check to make it fully usable, like monitoring blocks to check for contract validity. For now a contract will be created in a pending state, this state will need to be changed to confirmed in order to make transactions with the contract. This state change should be done after receiving XX block confirmation for the tx_hash of the contract deployment.

There are a couple of todo that will need to be cleared as well. We will need to make a cleanup PR once Tibo's PR is merged.

Plus, this will need to be heavily tested.

unnawut

Looks pretty straightforward. Nice internal API design. 💯

I'm submitting my elixir-related comments first. For the solidity ones, I'll try compile them and see if we have the same result (I hope they are reproducible builds).

apps/ewallet_db/priv/repo/migrations/20190715072907_add_blockchain_fields_1_to_token.exs

apps/ewallet_db/lib/ewallet_db/token.ex

apps/eth_blockchain/lib/eth_blockchain/transaction.ex

apps/eth_blockchain/contracts/ERC20/README.md

T-Dnzt

Nice work! 🕺

T-Dnzt · 2019-07-24T09:49:07Z

apps/eth_blockchain/config/config.exs

@@ -11,6 +11,7 @@ config :eth_blockchain,
  default_gas_price: 20_000_000_000,
  default_eth_transaction_gas_limit: 21_000,
  default_contract_transaction_gas_limit: 90_000,
+  default_contract_creation_gas_limit: 1_500_000,


We should probably move all those values in the confg system.

Ok, I think this can be done in a new PR with the blockchain config system.

T-Dnzt · 2019-07-24T10:01:19Z

apps/eth_blockchain/lib/eth_blockchain/token.ex

+      |> Base.encode16(case: :lower)
+
+    contract_binary =
+      :eth_blockchain


Could prob extract this to another function, or even another module.

T-Dnzt · 2019-07-24T10:01:37Z

apps/eth_blockchain/lib/eth_blockchain/token.ex

+       ) do
+    constructor_attributes =
+      [{name, symbol, decimals, initial_amount}]
+      |> TypeEncoder.encode(%FunctionSelector{


Can't another module, like ABI, take care of the encoding?

apps/eth_blockchain/lib/eth_blockchain/transaction.ex

T-Dnzt · 2019-07-24T10:04:42Z

apps/eth_blockchain/lib/eth_blockchain/transaction.ex

+  Returns {:ok, tx_hash, contract_address} if success,
+  {:error, code} || {:error, code, message} otherwise
+  """
+  def create_contract(%{from: from, contract_data: init} = attrs, adapter, pid) do


I know this is just sending a transaction to create it, but would it make more sense in a Contract module?

T-Dnzt · 2019-07-24T10:10:21Z

apps/eth_blockchain/test/eth_blockchain/token_test.exs

+      expected_contract_uuid = "3681491a-e8d0-4219-a40a-53d9a47fe64a"
+
+      expected_contract_binary =
+        :eth_blockchain


If this is extract, as suggested above, the new function could be used here instead of duplicating the code.

T-Dnzt · 2019-07-24T10:10:40Z

apps/eth_blockchain/test/eth_blockchain/token_test.exs

+
+      expected_contract_attributes =
+        [{"OMGToken", "OMG", 18, 100}]
+        |> TypeEncoder.encode(%FunctionSelector{


T-Dnzt · 2019-07-24T10:15:54Z

apps/admin_api/lib/admin_api/v1/controllers/token_controller.ex

+  def deploy_erc20(conn, attrs) do
+    with attrs <- Map.put(attrs, "account_uuid", Account.get_master_account().uuid),
+         {:ok, _} <- authorize(:deploy_erc20, conn.assigns, attrs),
+         {:ok, attrs} <- TokenGate.deploy_erc20(attrs),


In a future PR, Token will have a status and the gate should handle the original insert, deployment to Ethereum, tracking of the deployment and finally the update of the token to confirmed.

apps/ewallet_db/lib/ewallet_db/token.ex

unnawut · 2019-07-24T10:43:36Z

Also, could you link the documentations back to somewhere within /docs?

unnawut

I can confirm here that the current solc code in this PR, except for slightly reorganized dir path, is the same as https://github.com/OpenZeppelin/openzeppelin-contracts
I'm getting the same compiled code as in this PR when compiling the solc files myself.
Some usage suggestions below

unnawut · 2019-07-24T11:50:29Z

apps/eth_blockchain/contracts/roles/MinterRole.sol

@@ -0,0 +1,43 @@
+pragma solidity ^0.5.0;


Can we keep these roles code in the same structure as openzepplin's ones? (i.e. contracts/access/Roles.sol and contracts/access/roles/... instead of current contracts/roles/...) just so it's easy to trace back.

It'll also help that our solc code is the exact copy without having to change the import path.

apps/eth_blockchain/contracts/README.md

mederic and others added 30 commits July 4, 2019 11:51

tmp

78574d9

Add tests

d57b9d2

Add scripts and README to facilitate local testnet setup

d5deb95

Fix typo

d53dedd

Add byzantium block to genesis

6e1fdda

Refactor params to maps instead of tuples

b789120

Fix send transaction

60056f0

Get ERC-20 fields for tokens

5e69ac6

Improve/fix existing code

3e4bfce

Add totalSupply as a valid erc20 field

4d59a1c

Refactor get blockchain balance to return nil if invalid contract

932db5d

Fix geth response parsing

0ecdc58

Add token gate

f407a1b

mix format

b2a673e

Add endpoint to verify erc20 capabilities of an address

27be47a

mix format

557c35f

improve error handling

c28ccce

Add endpoint to set a contract address to a token

90db70d

Prepare the dumb adapter for :get_field

7b94ed3

Remove unused files [ci skip]

2549e6b

Add tests

3bca0ed

update tests [ci skip]

157c975

Silence warning

a055e7b

Add blockchain seeds

5fe852f

Update swagger

9a390fd

Update create token to support blockchain address

7109f31

Implement functional blockchain transaction flow

2c8470b

Test and refactor modules on eWallet side

b189407

Add tests for blockchain registry

69c1db7

Add tests / cleanup blockchain tx flow

a3fd3c0

Add missing alias

341d897

mederic-p changed the title ~~[WIP] Add ability to generate ERC20 tokens~~ Add ability to generate ERC20 tokens Jul 23, 2019

mederic-p requested review from T-Dnzt, unnawut, ripzery and jarindr July 23, 2019 07:26

mederic-p added flag/ethereum integration location/backend labels Jul 23, 2019

mederic-p added this to the v2.0 milestone Jul 23, 2019

Merge branch '1091-cold-wallet-reference' into 703-create-erc20

935dc3b

mederic-p added this to Review in eWallet Jul 24, 2019

mederic-p changed the base branch from 1091-cold-wallet-reference to eth-blockchain July 24, 2019 08:30

Merge branch 'eth-blockchain' into 703-create-erc20

1f3c311

unnawut reviewed Jul 24, 2019

View reviewed changes

Mederic added 2 commits July 24, 2019 15:46

Rename migration

848b1c1

Update changeset validation

d16f3da

T-Dnzt suggested changes Jul 24, 2019

View reviewed changes

unnawut reviewed Jul 24, 2019

View reviewed changes

Mederic added 3 commits July 25, 2019 08:15

Re-organize modules

eeaffe1

Update doc / license and re-organize contracts

bd61afa

Remove code from token

791bacc

T-Dnzt approved these changes Jul 26, 2019

View reviewed changes

unnawut approved these changes Jul 26, 2019

View reviewed changes

Merge branch 'eth-blockchain' into 703-create-erc20

49c33dd

mederic-p merged commit 9619fc6 into eth-blockchain Jul 31, 2019

eWallet automation moved this from 4-Review to 5-Done Jul 31, 2019

mederic-p deleted the 703-create-erc20 branch July 31, 2019 08:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ability to generate ERC20 tokens #1116

Add ability to generate ERC20 tokens #1116

mederic-p commented Jul 15, 2019 •

edited

Loading

unnawut commented Jul 24, 2019

mederic-p commented Jul 24, 2019

unnawut left a comment

T-Dnzt left a comment

T-Dnzt Jul 24, 2019

mederic-p Jul 25, 2019

T-Dnzt Jul 24, 2019

T-Dnzt Jul 24, 2019

T-Dnzt Jul 24, 2019

T-Dnzt Jul 24, 2019

T-Dnzt Jul 24, 2019

T-Dnzt Jul 24, 2019

unnawut commented Jul 24, 2019

unnawut left a comment

unnawut Jul 24, 2019

Add ability to generate ERC20 tokens #1116

Add ability to generate ERC20 tokens #1116

Conversation

mederic-p commented Jul 15, 2019 • edited Loading

Overview

Changes

Implementation Details

Usage

Impact

unnawut commented Jul 24, 2019

mederic-p commented Jul 24, 2019

unnawut left a comment

Choose a reason for hiding this comment

T-Dnzt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unnawut commented Jul 24, 2019

unnawut left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mederic-p commented Jul 15, 2019 •

edited

Loading