Smart Contract Support #68

kurotaky · 2022-04-02T03:49:12Z

I plan to create a smart contract feature that will allow for the following.

[1] pry(main)> contract = Eth::Contract.create(file: 'spec/fixtures/contracts/greeter.sol')
=> #<Eth::Contract::Greeter:0x00007faf95142b88>
[2] pry(main)> address = contract.deploy_and_wait("Hello from eth.rb!")
=> "0x351f54cdc59570c99b577b272b98b8eef5e8a6f6"

I am currently building:

Smart contract functionality like ethereum.rb
Support for Ethereum transactions (EIP-1559)
Add testing
Add documentation

codecov-commenter · 2022-04-02T03:51:51Z

Codecov Report

Merging #68 (fd58fe8) into main (f243cd4) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
+ Coverage   99.70%   99.73%   +0.02%     
==========================================
  Files          55       67      +12     
  Lines        3409     3753     +344     
==========================================
+ Hits         3399     3743     +344     
  Misses         10       10

Impacted Files	Coverage Δ
lib/eth.rb	`100.00% <100.00%> (ø)`
lib/eth/client.rb	`100.00% <100.00%> (ø)`
lib/eth/contract.rb	`100.00% <100.00%> (ø)`
lib/eth/contract/event.rb	`100.00% <100.00%> (ø)`
lib/eth/contract/function.rb	`100.00% <100.00%> (ø)`
lib/eth/contract/function_input.rb	`100.00% <100.00%> (ø)`
lib/eth/contract/function_output.rb	`100.00% <100.00%> (ø)`
lib/eth/contract/initializer.rb	`100.00% <100.00%> (ø)`
spec/eth/client_spec.rb	`100.00% <100.00%> (ø)`
spec/eth/contract/event_spec.rb	`100.00% <100.00%> (ø)`
... and 5 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

q9f

Hey, thanks.

I left some early comments, mainly to avoid redundancy with existing code (abi, units, utils).

One thing that bothered me in Ethereum.rb is that the Contract always contains a client. It should be the other way around; you have a client and pass a contract to deploy (just like transactions). What do you think?

In general, I would suggest writing tests first and building everything against the spec so that we know what does what and what functions how. A nice side effect would be 100% coverage 😁

q9f · 2022-04-02T07:59:48Z

lib/eth/contract.rb

+      @name = name
+      @code = code
+      @abi = abi
+      @client = client


This is a reverse dependency. A contract should not contain a client but rather a client should be able to deploy and wait.

I plan to implement deploy_and_wait in client.

I consider the following plan & interface.

before

@contract.deploy_and_wait @contract.transact_and_wait.function_name(params) @contract.call.function_name(params)

after

@client.deploy_and_wait(contract) @client.transact_and_wait(contract, function_name, params) @client.call(contract, function_name, params)

q9f · 2022-04-02T08:01:24Z

lib/eth/contract.rb

+    end
+
+    def address=(addr)
+      @address = addr


address should always be an Eth::Address for security reasons.

I now use Eth::Address 📝

q9f · 2022-04-02T08:02:50Z

lib/eth/contract.rb

+      @deployment = Eth::Contract::Deployment.new(tx, @client)
+    end
+
+    def deploy_and_wait(*params, **args, &block)


All these functions should be implemented for the client not the contract. See transfer_and_wait.

q9f · 2022-04-02T08:03:49Z

lib/eth/contract.rb

+    end
+
+    def estimate(*params)
+      result = @client.eth_estimate_gas(deploy_args(params))


This or use Tx.estimate_intrinsic_gas().

q9f · 2022-04-02T08:04:30Z

lib/eth/contract.rb

+      else
+        tx = send_transaction(call_args(fun, args))
+      end
+      return Ethereum::Transaction.new(tx, @client, call_payload(fun, args), args)


q9f · 2022-04-02T08:12:54Z

lib/eth/contract/encoder.rb

@@ -0,0 +1,115 @@
+module Eth
+  class Contract::Encoder
+    def encode(type, value)


See Eth::Abi.encode()

Removed dependency on Contract::Encoder using Eth::Abi.encode().

q9f · 2022-04-02T08:14:39Z

lib/eth/contract/formatter.rb

+module Eth
+  class Contract::Formatter
+
+    UNITS = {


See Eth::Unit::

q9f · 2022-04-02T08:16:21Z

lib/eth/contract/formatter.rb

+      tether:     1000000000000000000000000000000
+    }
+
+    def valid_address?(address_string)


Eth::Address.new(...).valid?

q9f · 2022-04-02T08:17:17Z

lib/eth/contract/formatter.rb

+      return !(address.match(/[0-9a-fA-F]+/).nil?)
+    end
+
+    def from_bool(boolval)


Wondering what this is used for? Might want to live in Eth::Util

q9f · 2022-04-02T08:20:52Z

eth.gemspec

@@ -48,4 +48,7 @@ Gem::Specification.new do |spec|

  # scrypt for encrypted key derivation
  spec.add_dependency "scrypt", "~> 3.0"
+
+  # activesupport for smart contract support
+  spec.add_dependency "activesupport", "~> 7.0"


where is this used?

It was used in present? and underscore methods.
I will probably remove it later when it is no longer needed.

I think those are both one-line methods that could be copied and pasted into Eth::Util or similar rather than pull in the entirety of activesupport

Yes, that's what I was thinking. Keep dependencies as low as possible.

Remove the dependency on activesupport and use the methods of Ruby itself.

kurotaky · 2022-04-02T09:59:11Z

Thank you for your comment. I will write a test and try to avoid redundancy 😄
Certainly, having a client and passing Contract to the client for deployment seems like a good idea.

q9f · 2022-04-17T12:21:10Z

Also, add yourself to the AUTHORS file :)

w4ll3 · 2022-04-25T14:15:26Z

Hi there, checking in on the status of this PR, would be very helpful to implement EIP-1271 for Sign-In with Ethereum spruceid/siwe-ruby#15, let me know if there is anything I can do to help!

kurotaky · 2022-04-26T07:23:57Z

@w4ll3 Thank you. I'll call you when I need help!

kurotaky · 2022-05-05T15:43:03Z

@q9f
Thank you for your waiting 😄 spec and docs now have 100% coverage.
I have implemented the functionality to interact with a minimum of smart contract.

q9f

This is beautiful, thank you for taking the time to merge it in!

q9f · 2022-05-06T09:06:57Z

lib/eth/contract.rb

+
+# -*- encoding : ascii-8bit -*-
+
+require "forwardable"


do we need this as dependency in the gemspec?

Removed as not needed here.

q9f · 2022-05-06T09:14:23Z

lib/eth/client.rb

+    #   @param address [String] contract address.
+    # @return [Object] returns the result of the call.
+    def transact(contract, function_name, *args, **kwargs)
+      gas_limit = Tx.estimate_intrinsic_gas(contract.bin) - Tx::DEFAULT_GAS_LIMIT + 53000


just a tiny nitpick: let's create a Tx::CREATE_GAS = 32_000 constant that we can use here.

OK, I'll try to fix it.

lib/eth/client.rb

spec/fixtures/contracts/test_contract.sol

Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>

…rt-contract-support

kurotaky · 2022-05-06T13:05:28Z

@q9f I have corrected the points you just reviewed!

q9f · 2022-05-06T13:12:15Z

Epic!

kurotaky added 2 commits April 2, 2022 12:36

Smart Contract Support

82860b1

moved files

954430f

q9f reviewed Apr 2, 2022

View reviewed changes

kurotaky added 9 commits April 2, 2022 20:32

remove unused truffle functions

2bb80b1

add contract spec

fa2f97a

deploy and deploy_and_wait

c5d7731

Secure the address

e5fc104

fix Contract::Initializer

c685768

Enable create from file

54fa9eb

fix create contract spec

0ca13e2

fix Contract::Event

72f8987

Implement call to client

dbc7cb7

kurotaky added 7 commits April 20, 2022 21:06

AUTHORS

67f7aad

delete create_function_proxies

27714b4

remove unused methods

e8fe30d

fixed args

0551b49

remove Contract::Deployment

87b7a2e

Avoid active_support dependency

0f5e704

remove dependency activesupport

d4e7a09

q9f mentioned this pull request Apr 25, 2022

Eip 1271 support #44

Closed

kurotaky added 2 commits April 26, 2022 16:00

add spec: deploy the contract with key

b3329f9

add spec: legacy transactions

6024436

kurotaky added 3 commits April 26, 2022 16:27

use Eth::Util

b978ae4

Use Eth::Contract for deploy

6f1e9d7

set and return the contract address

38b8146

kurotaky added 14 commits May 2, 2022 16:24

add test for Contract::Function

a85fdc2

use Eth::Abi::Type

ccbc18b

add test for contract

667635b

Documentation of contract class

eee4f83

add test cases for transact and call methods

3808c6f

rufo

8af23c2

Move parse_abi() into contract class

dfe9d57

100.00% documented

91e758a

use Eth::Address

34bb681

encoded_function_signature

3f19d12

add docs for client methods

8225138

add test for call()

f4663ed

If contract.address is set, use it.

55cddb7

update README

7610742

kurotaky requested a review from q9f May 5, 2022 15:32

kurotaky self-assigned this May 5, 2022

kurotaky marked this pull request as ready for review May 5, 2022 15:32

q9f approved these changes May 6, 2022

View reviewed changes

kurotaky and others added 6 commits May 6, 2022 21:21

Update lib/eth/client.rb

c2c2783

Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>

Update lib/eth/client.rb

45ac899

Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>

Update spec/fixtures/contracts/test_contract.sol

d6c733c

Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>

forwardable does not require

1d803e5

Merge remote-tracking branch 'origin/smart-contract-support' into sma…

fd58fe8

…rt-contract-support

Use constant values for smart contract costs

8bc7289

q9f merged commit 07befbe into main May 6, 2022

q9f deleted the smart-contract-support branch May 6, 2022 13:12

q9f added the enhancement New feature or request label May 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Smart Contract Support #68

Smart Contract Support #68

kurotaky commented Apr 2, 2022 •

edited

Loading

codecov-commenter commented Apr 2, 2022 •

edited

Loading

q9f left a comment

q9f Apr 2, 2022

kurotaky Apr 3, 2022

kurotaky Apr 9, 2022

q9f Apr 2, 2022

kurotaky Apr 3, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

kurotaky May 1, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

q9f Apr 2, 2022

kurotaky Apr 3, 2022

mculp Apr 16, 2022

q9f Apr 16, 2022

kurotaky Apr 26, 2022

kurotaky commented Apr 2, 2022 •

edited

Loading

q9f commented Apr 17, 2022

w4ll3 commented Apr 25, 2022

kurotaky commented Apr 26, 2022

kurotaky commented May 5, 2022

q9f left a comment

q9f May 6, 2022

kurotaky May 6, 2022

q9f May 6, 2022

kurotaky May 6, 2022

kurotaky commented May 6, 2022

q9f commented May 6, 2022

Smart Contract Support #68

Smart Contract Support #68

Conversation

kurotaky commented Apr 2, 2022 • edited Loading

codecov-commenter commented Apr 2, 2022 • edited Loading

Codecov Report

q9f 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

before

after

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

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

kurotaky commented Apr 2, 2022 • edited Loading

q9f commented Apr 17, 2022

w4ll3 commented Apr 25, 2022

kurotaky commented Apr 26, 2022

kurotaky commented May 5, 2022

q9f 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

kurotaky commented May 6, 2022

q9f commented May 6, 2022

kurotaky commented Apr 2, 2022 •

edited

Loading

codecov-commenter commented Apr 2, 2022 •

edited

Loading

kurotaky commented Apr 2, 2022 •

edited

Loading