klay 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8986fd6d80e3681e563bd7e54150159d8f4d5f965c2c78f1a20cd3bf8d6ba57c
-  data.tar.gz: aa908017c60bd2ca4655a08763aaec318de7aaabf5a064d9bab624ba3d0c9c56
+  metadata.gz: 3ea9c15c1513dcc85173e2d227930d6cc8359c65aa6679edab4778b9aa186696
+  data.tar.gz: 4f703b56159737e8fc9f59217a56ec8f61069756db6bf6e900749736b1b98d86
 SHA512:
-  metadata.gz: 60d093d6d7c16a96cf453ce2303d1098bb00b8171f88b55d09aa4e2d0772c250fbb185da0946d6ff420a2c6c56d4eb5dd87931d8261a998c2e939c73b32765f8
-  data.tar.gz: 57e532d640d093d7049c71b66b110567ada2626cb2f03b69ca731c209968eecd02e96f136053b342cc7755407b6c05ed4790a929239b100810946189b31bc3f0
+  metadata.gz: 0a9550b4ce05cb34cc05e115b4ce3571de89fdabe0974412a2eaf1bb50be66ae1942c5c14f0c2ca83693cd563929e747e21b118966af7be040bd9f1ecd73af1e
+  data.tar.gz: c516d72d741edcc3b051f0cc808b34f1777017f4fbab081664d144bf69a85fa0a4adef7d8225adb09d09170c5a40698aa52a06a791a296936b068de2f6e18565

data/AUTHORS.txt

@@ -1,10 +1,6 @@
-The Ruby-Eth Contributors are:
+Ruby Klay Contributors are:
 * Sehan Park @noMacGuffins
 
-The Ruby-Klay project is maintained by Sehan Park's (@noMacGuffins)
-repository licenced under MIT conditions:
-* https://github.com/noMacGuffins/ruby-klay
-
 The Ruby-Eth project was maintained 2016-2020 in Steve Ellis's (@se3000)
 repository licensed under MIT conditions:
 * https://github.com/se3000/ruby-eth

data/LICENSE.txt

@@ -1,4 +1,3 @@
-A
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

data/README.md

@@ -1,58 +1,38 @@
 # Klay for Ruby
 
-A simple library to build and sign Klayereum transactions. Allows separation of key and node management. Sign transactions and handle keys anywhere you can run ruby, broadcast transactions through any node. Sign messages and recover signatures for authentication.
+A simple library to build and sign Klaytn transactions. Allows separation of key and node management. Sign transactions and handle keys anywhere you can run ruby, broadcast transactions through any node. Sign messages and recover signatures for authentication.
 
 What you get:
-- [x] Secp256k1 Key-Pairs and Encrypted Klayereum Key-Stores (JSON)
-- [x] EIP-55 Checksummed Klayereum Addresses
+- [x] Secp256k1 Key-Pairs and Encrypted Klaytn Key-Stores (JSON)
+- [x] EIP-55 Checksummed Klaytn Addresses
 - [x] EIP-155 Replay protection with Chain IDs (with presets)
-- [x] EIP-191 Klayereum Signed Messages (with prefix and type)
-- [x] EIP-712 Klayereum Signed Type Data
-- [x] EIP-1559 Klayereum Type-2 Transactions (with priority fee and max gas fee)
+- [x] EIP-191 Klaytn Signed Messages (with prefix and type)
+- [x] EIP-712 Klaytn Signed Type Data
+- [x] EIP-1559 Klaytn Type-2 Transactions (with priority fee and max gas fee)
 - [x] EIP-2028 Call-data intrinsic gas cost estimates (plus access lists)
-- [x] EIP-2718 Klayereum Transaction Envelopes (and types)
-- [x] EIP-2930 Klayereum Type-1 Transactions (with access lists)
+- [x] EIP-2718 Klaytn Transaction Envelopes (and types)
+- [x] EIP-2930 Klaytn Type-1 Transactions (with access lists)
 - [x] ABI-Encoder and Decoder (including type parser)
 - [x] RLP-Encoder and Decoder (including sedes)
 - [x] RPC-Client (IPC/HTTP) for Execution-Layer APIs
 
-Soon (TM):
-- [ ] Smart Contracts and Solidity Support
-- [ ] EIP-1271 Smart-Contract Authentification
-- [ ] HD-Wallets (BIP-32) and Mnemonics (BIP-39)
-
-Contents:
-- [1. Installation](#1-installation)
-- [2. Usage](#2-usage)
-  - [2.1. Klayereum Keys and Addresses (EIP-55)](#21-ethereum-keys-and-addresses-eip-55)
-  - [2.2. Klayereum Signatures (EIP-191, EIP-712)](#22-ethereum-signatures-eip-191-eip-712)
-  - [2.3. Klayereum Chains (EIP-155)](#23-ethereum-chains-eip-155)
-  - [2.4. Klayereum Transactions (EIP-1559, EIP-2718, EIP-2930)](#24-ethereum-transactions-eip-1559-eip-2718-eip-2930)
-  - [2.5. Klayereum ABI Encoder and Decoder](#25-ethereum-abi-encoder-and-decoder)
-  - [2.6. Klayereum RLP Encoder and Decoder](#26-ethereum-rlp-encoder-and-decoder)
-  - [2.7. Klayereum RPC-Client](#27-ethereum-rpc-client)
-- [3. Documentation](#3-documentation)
-- [4. Testing](#4-testing)
-- [5. Contributing](#5-contributing)
-- [6. License and Credits](#6-license-and-credits)
-
 ## 1. Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "eth"
+gem "klay"
 ```
 
 Or install it yourself as:
 
 ```shell
-gem install eth
+gem install klay
 ```
 
 ## 2. Usage
 
-### 2.1. Klayereum Keys and Addresses (EIP-55)
+### 2.1. Klaytn Keys and Addresses (EIP-55)
 
 Generate a random Secp256k1 key-pair.
 
@@ -61,7 +41,7 @@ key = Klay::Key.new
 # => #<Klay::Key:0x00005574a6ba80b8 @private_key=#<Secp256k1::PrivateKey:0x00005574a6b9a0a8 @data=")&\x86P\xB5\x16\xD9]\xFA;\x1F\xF6\xD9\xCF\xE3Vj/\xE2\x81\xC0\x9D\xE9\x05o!q\x82G\x9A\x10Q">, @public_key=#<Secp256k1::PublicKey:0x00005574a6b9bf98>>
 ```
 
-Create an password-encrypted Klayereum key-store.
+Create an password-encrypted Klaytn key-store.
 
 ```ruby
 my_key = Klay::Key.new priv: "30137644b564785d01420f8043f043d74dcca64008e57c59f8ce713a0005a54b"
@@ -71,7 +51,7 @@ restored_key = Klay::Key::Decrypter.perform key_store, "secret-password-1337"
 # => "30137644b564785d01420f8043f043d74dcca64008e57c59f8ce713a0005a54b"
 ```
 
-Manage Klayereum address objects adhering to EIP-55 checksum format.
+Manage Klaytn address objects adhering to EIP-55 checksum format.
 
 ```ruby
 address = Klay::Address.new "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"
@@ -84,7 +64,7 @@ address.checksummed # EIP 55
 
 See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for more details about key-pairs, encrypting/decrypting key-stores with a secret, and checksummed addresses.
 
-### 2.2. Klayereum Signatures (EIP-191, EIP-712)
+### 2.2. Klaytn Signatures (EIP-191, EIP-712)
 
 Manage keypairs to sign messages in EIP-191 (`personal_sign`) format or typed data in EIP-712 (`sign_typed_data`) format.
 
@@ -116,9 +96,9 @@ Klay::Signature.verify "Hello World!", signature, address, Klay::Chain::GOERLI
 
 See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for signing typed data as per EIP-712.
 
-### 2.3. Klayereum Chains (EIP-155)
+### 2.3. Klaytn Chains (EIP-155)
 
-Manage Klayereum chain IDs for EIP-155 replay protection.
+Manage Klaytn chain IDs for EIP-155 replay protection.
 
 ```ruby
 chain_id = Klay::Chain::OPTIMISM
@@ -131,7 +111,7 @@ chain_id = Klay::Chain.to_chain_id v
 # => 10
 ```
 
-### 2.4. Klayereum Transactions (EIP-1559, EIP-2718, EIP-2930)
+### 2.4. Klaytn Transactions (EIP-1559, EIP-2718, EIP-2930)
 
 Create an EIP-1559-conform transaction:
 
@@ -139,11 +119,11 @@ Create an EIP-1559-conform transaction:
 payload = {
   chain_id: Klay::Chain::GOERLI,
   nonce: 5,
-  priority_fee: 3 * Klay::Unit::GWEI,
-  max_gas_fee: 69 * Klay::Unit::GWEI,
+  priority_fee: 3 * Klay::Unit::GPEB,
+  max_gas_fee: 69 * Klay::Unit::GPEB,
   gas_limit: 230_420,
   to: "0xCaA29806044A08E533963b2e573C1230A2cd9a2d",
-  value: 0.069423 * Klay::Unit::ETHER,
+  value: 0.069423 * Klay::Unit::KLAY,
 }
 # => {:chain_id=>5, :nonce=>5, :priority_fee=>0.3e10, :max_gas_fee=>0.69e11, :gas_limit=>230420, :to=>"0xCaA29806044A08E533963b2e573C1230A2cd9a2d", :value=>0.69423e17}
 tx = Klay::Tx.new payload
@@ -158,9 +138,9 @@ tx.hex
 
 This gem also supports access lists and ABI-encoded data payloads. See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for more details about the various supported transaction types (legacy, type-1, type-2), payload parameters, and how to estimate intrinsic gas costs.
 
-### 2.5. Klayereum ABI Encoder and Decoder
+### 2.5. Klaytn ABI Encoder and Decoder
 
-Encode and decode Klayereum application binary interface data (ABI).
+Encode and decode Klaytn application binary interface data (ABI).
 
 ```ruby
 Klay::Util.bin_to_hex Klay::Abi.encode(["string", "address"], ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"])
@@ -169,9 +149,9 @@ Klay::Abi.decode(["string", "address"], "000000000000000000000000000000000000000
 # => ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
 ```
 
-### 2.6. Klayereum RLP Encoder and Decoder
+### 2.6. Klaytn RLP Encoder and Decoder
 
-Serialize and deserialize Klayereum recursive-length prefix data (RLP).
+Serialize and deserialize Klaytn recursive-length prefix data (RLP).
 
 ```ruby
 Klay::Util.bin_to_hex Klay::Rlp.encode ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
@@ -187,7 +167,7 @@ Klay::Rlp.decode "c7c0c1c0c3c0c1c0"
 # => [[], [[]], [[], [[]]]]
 ```
 
-### 2.7. Klayereum RPC-Client
+### 2.7. Klaytn RPC-Client
 
 Create an IPC- or HTTP-RPC-API client to seamlessly query the chain state, e.g., Infura over HTTPS with access token:
 
@@ -207,7 +187,7 @@ cli = Klay::Client.create "/tmp/geth.ipc"
 # => #<Klay::Client::Ipc:0x000055d43f51c390 @gas_limit=21000, @id=0, @max_fee_per_gas=0.2e11, @max_priority_fee_per_gas=0, @path="/tmp/geth.ipc">
 cli.eth_coinbase
 # => {"jsonrpc"=>"2.0", "id"=>1, "result"=>"0x6868074fb21c48dfad0c448fbabd99383a6598e4"}
-tx = cli.transfer_and_wait(Klay::Key.new.address, 1337 * Klay::Unit::ETHER)
+tx = cli.transfer_and_wait(Klay::Key.new.address, 1337 * Klay::Unit::KLAY)
 # => "0x141c6dff40df34fe4fce5a65588d2161dab3e0e977fb8049ff7d79bc901034f7"
 cli.eth_get_transaction_by_hash tx
 # => {"jsonrpc"=>"2.0", "id"=>8, "result"=> {"blockHash"=>"0x47e742038c75851348dbda87b15fde044d54c442c371f43bea881a44d5589de3", "blockNumber"=>"0x1", "from"=>"0x6868074fb21c48dfad0c448fbabd99383a6598e4", "gas"=>"0x5208", "gasPrice"=>"0x342770c1", "maxFeePerGas"=>"0x77359401", "maxPriorityFeePerGas"=>"0x1", "hash"=>"0x141c6dff40df34fe4fce5a65588d2161dab3e0e977fb8049ff7d79bc901034f7", "input"=>"0x", "nonce"=>"0x0", "to"=>"0x311c61e5dc6123ad016bb7fd687d283c327bcd5f", "transactionIndex"=>"0x0", "value"=>"0x487a9a304539440000", "type"=>"0x2", "accessList"=>[], "chainId"=>"0x539", "v"=>"0x0", "r"=>"0xb42477d69eae65a3a3d91d9cb173e4a45a403fb0a15fa729dbfdc9d13211d7b5", "s"=>"0x4a2f98fc2b61c2d7c907520bc8c6ebe42ea6fe1cb6824f95e4b30e9464395100"}}
@@ -217,46 +197,10 @@ cli.get_nonce cli.eth_coinbase["result"]
 # => 1
 ```
 
-## 3. Documentation
-
-For any specific version, docs can be generated by `yard`:
-
-```shell
-gem install bundler rdoc yard
-git checkout v0.0.1
-yard doc
-```
-
-The goal is to have 100% API documentation available.
-
-## 4. Testing
-
-To run tests, simply use `rspec`. Note, that the Klayereum tests fixtures are required.
-
-```shell
-git submodule update --init --recursive
-bundle install
-rspec
-```
-
-The goal is to have 100% specification coverage for all code inside this gem.
-
-## 5. Contributing
+## 3. Contributing
 
 Pull requests are welcome! To contribute, please consider the following:
 * Code should be fully documented. Run `yard doc` and make sure it does not yield any warnings or undocumented sets.
 * Code should be fully covered by tests. Run `rspec` to make sure all tests pass. The CI has an integration that will assis you to identify uncovered lines of code and get coverage up to 100%.
 * Code should be formatted properly. Try to eliminate the most common issues such as trailing white-spaces or duplicate new-lines. Usage of the `rufo` gem is recommended.
-* Submit pull requests, questions, or issues to Github: https://github.com/noMacGuffins/klay.rb
-
-## 6. License and Credits
-The `eth` gem is licensed under the conditions of [Apache 2.0](./LICENSE.txt). Please see [AUTHORS](./AUTHORS.txt) for contributors and copyright notices.
-
-This gem is a complete rewrite of the old `eth` gem by Steve Ellis.
-* https://github.com/se3000/ruby-eth/ (MIT)
-
-It also contains a revised version the ABI gem by Jan Xie and Zhang Yaning.
-* https://github.com/cryptape/ruby-ethereum-abi (MIT)
-
-It also contains a revised version the RLP gem by Jan Xie and Zhang Yaning.
-* https://github.com/cryptape/ruby-rlp (MIT)
+* Submit pull requests, questions, or issues to Github: https://github.com/noMacGuffins/klay

data/bin/setup

@@ -6,4 +6,4 @@ rufo .
 yard doc
 rspec
 
-echo "Tests fail? Run \`geth --dev --http --ipcpath /tmp/geth.ipc\` in background and try again."
+# echo "Tests fail? Run \`geth --dev --http --ipcpath /tmp/geth.ipc\` in background and try again."

data/klay.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = ">= 2.6", "< 4.0"
 
-  # keccak for hashing everything in ethereum
+  # keccak for hashing everything in klaytn
   spec.add_dependency "keccak", "~> 1.3"
 
   # konstructor gem for overloading constructors

data/lib/klay/abi/type.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,10 +14,10 @@
 
 # -*- encoding : ascii-8bit -*-
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
+  # Provides a Ruby implementation of the Klaytn Applicatoin Binary Interface (ABI).
   module Abi
 
     # Provides a class to handle and parse common ABI types.
@@ -41,7 +41,7 @@ module Klay
       # @param base_type [String] the base-type attribute.
       # @param sub_type [String] the sub-type attribute.
       # @param dimensions [Array] the dimension attribute.
-      # @return [Eth::Abi::Type] an ABI type object.
+      # @return [Klay::Abi::Type] an ABI type object.
       def initialize(base_type, sub_type, dimensions)
         sub_type = sub_type.to_s
         @base_type = base_type
@@ -56,7 +56,7 @@ module Klay
       # Creates a new Type upon success (using konstructor).
       #
       # @param type [String] a common Solidity type.
-      # @return [Eth::Abi::Type] a parsed Type object.
+      # @return [Klay::Abi::Type] a parsed Type object.
       # @raise [ParseError] if it fails to parse the type.
       def parse(type)
         _, base_type, sub_type, dimension = /([a-z]*)([0-9]*x?[0-9]*)((\[[0-9]*\])*)/.match(type).to_a
@@ -77,14 +77,14 @@ module Klay
 
       # Creates a new uint256 type used for size.
       #
-      # @return [Eth::Abi::Type] a uint256 size type.
+      # @return [Klay::Abi::Type] a uint256 size type.
       def self.size_type
         @size_type ||= new("uint", 256, [])
       end
 
       # Compares two types for their attributes.
       #
-      # @param another_type [Eth::Abi::Type] another type to be compared.
+      # @param another_type [Klay::Abi::Type] another type to be compared.
       # @return [Boolean] true if all attributes match.
       def ==(another_type)
         base_type == another_type.base_type and
@@ -120,7 +120,7 @@ module Klay
 
       # Types can have nested sub-types in arrays.
       #
-      # @return [Eth::Abi::Type] nested sub-type.
+      # @return [Klay::Abi::Type] nested sub-type.
       def nested_sub
         @nested_sub ||= self.class.new(base_type, sub_type, dimensions[0...-1])
       end

data/lib/klay/abi.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,10 +18,10 @@ require "konstructor"
 
 require "klay/abi/type"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
+  # Provides a Ruby implementation of the Klaytn Applicatoin Binary Interface (ABI).
   # ref: https://docs.soliditylang.org/en/develop/abi-spec.html
   module Abi
     extend self
@@ -68,7 +68,7 @@ module Klay
 
     # Encodes a specific value, either static or dynamic.
     #
-    # @param type [Eth::Abi::Type] type to be encoded.
+    # @param type [Klay::Abi::Type] type to be encoded.
     # @param arg [String|Number] value to be encoded.
     # @return [String] the encoded type.
     # @raise [EncodingError] if value does not match type.
@@ -110,7 +110,7 @@ module Klay
 
     # Encodes primitive types.
     #
-    # @param type [Eth::Abi::Type] type to be encoded.
+    # @param type [Klay::Abi::Type] type to be encoded.
     # @param arg [String|Number] value to be encoded.
     # @return [String] the encoded primitive type.
     # @raise [EncodingError] if value does not match type.
@@ -198,7 +198,7 @@ module Klay
 
     # Decodes a specific value, either static or dynamic.
     #
-    # @param type [Eth::Abi::Type] type to be decoded.
+    # @param type [Klay::Abi::Type] type to be decoded.
     # @param arg [String] encoded type data string.
     # @return [String] the decoded data for the type.
     # @raise [DecodingError] if decoding fails for type.
@@ -234,7 +234,7 @@ module Klay
 
     # Decodes primitive types.
     #
-    # @param type [Eth::Abi::Type] type to be decoded.
+    # @param type [Klay::Abi::Type] type to be decoded.
     # @param data [String] encoded primitive type data string.
     # @return [String] the decoded data for the type.
     # @raise [DecodingError] if decoding fails for type.

data/lib/klay/address.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,19 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # The {Eth::Address} class to handle checksummed Ethereum addresses.
+  # The {Klay::Address} class to handle checksummed Klaytn addresses.
   class Address
 
     # Provides a special checksum error if EIP-55 is violated.
     class CheckSumError < StandardError; end
 
-    # The prefixed and checksummed Ethereum address.
+    # The prefixed and checksummed Klaytn address.
     attr_reader :address
 
-    # Constructor of the {Eth::Address} class. Creates a new hex
+    # Constructor of the {Klay::Address} class. Creates a new hex
     # prefixed address.
     #
     # @param address [String] hex string representing an ethereum address.

data/lib/klay/api.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,10 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # Provides the `Eth::Api` module grouping known RPC commands.
+  # Provides the `Klay::Api` module grouping known RPC commands.
   module Api
 
     # Implements the available RPC-APIs provided by Geth version 1.10.15.
@@ -189,7 +189,7 @@ module Klay
       "les_setClientParams",
       "les_setDefaultParams",
       "miner_getHashrate",
-      "miner_setEtherbase",
+      "miner_setKlayerbase",
       "miner_setExtra",
       "miner_setGasLimit",
       "miner_setGasPrice",

data/lib/klay/chain.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Encapsulates {Eth::Chain} IDs and utilities for EIP-155 compatibility.
@@ -108,7 +108,7 @@ module Klay
     # @param chain_id [Integer] the chain id the signature was generated on.
     # @return [Integer] the recovery id corresponding to `v`.
     # @raise [ReplayProtectionError] if the given `v` is invalid.
-    def to_recovery_id(v, chain_id = ETHEREUM)
+    def to_recovery_id(v, chain_id = CYPRESS)
       e = 0 + 2 * chain_id + 35
       i = 1 + 2 * chain_id + 35
       if [0, 1].include? v

data/lib/klay/client/http.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 
 require "net/http"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Provides an HTTP/S-RPC client.

data/lib/klay/client/ipc.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 
 require "socket"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Provides an IPC-RPC client.

data/lib/klay/client.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,10 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # Provides the {Eth::Client} super-class to connect to Ethereum
+  # Provides the {Klay::Client} super-class to connect to Klaytn
   # network's RPC-API endpoints (IPC or HTTP).
   class Client
 
@@ -41,8 +41,8 @@ module Klay
     # an IPC path.
     #
     # @param host [String] either an HTTP/S host or an IPC path.
-    # @return [Eth::Client::Ipc] an IPC client.
-    # @return [Eth::Client::Http] an HTTP client.
+    # @return [Klay::Client::Ipc] an IPC client.
+    # @return [Klay::Client::Http] an HTTP client.
     # @raise [ArgumentError] in case it cannot determine the client type.
     def self.create(host)
       return Client::Ipc.new host if host.end_with? ".ipc"
@@ -50,7 +50,7 @@ module Klay
       raise ArgumentError, "Unable to detect client type!"
     end
 
-    # Constructor for the {Eth::Client} super-class. Should not be used;
+    # Constructor for the {Klay::Client} super-class. Should not be used;
     # use {Client.create} intead.
     def initialize(_)
       @id = 0
@@ -61,7 +61,7 @@ module Klay
 
     # Gets the default account (coinbase) of the connected client.
     #
-    # @return [Eth::Address] the coinbase account address.
+    # @return [Klay::Address] the coinbase account address.
     def default_account
       @default_account ||= Address.new eth_coinbase["result"]
     end
@@ -75,7 +75,7 @@ module Klay
 
     # Gets the balance for an address.
     #
-    # @param address [Eth::Address] the address to get the balance for.
+    # @param address [Klay::Address] the address to get the balance for.
     # @return [Integer] the balance in Wei.
     def get_balance(address)
       eth_get_balance(address)["result"].to_i 16
@@ -83,32 +83,32 @@ module Klay
 
     # Gets the next nonce for an address used to draft new transactions.
     #
-    # @param address [Eth::Address] the address to get the nonce for.
+    # @param address [Klay::Address] the address to get the nonce for.
     # @return [Integer] the next nonce to be used.
     def get_nonce(address)
       eth_get_transaction_count(address, "pending")["result"].to_i 16
     end
 
-    # Simply transfer Ether to an account and waits for it to be mined.
+    # Simply transfer Klay to an account and waits for it to be mined.
     # Uses `eth_coinbase` and external signer if no  sender key is
     # provided.
     #
-    # @param destination [Eth::Address] the destination address.
+    # @param destination [Klay::Address] the destination address.
     # @param amount [Integer] the transfer amount in Wei.
-    # @param sender_key [Eth::Key] the sender private key.
+    # @param sender_key [Klay::Key] the sender private key.
     # @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     # @return [String] the transaction hash.
     def transfer_and_wait(destination, amount, sender_key = nil, legacy = false)
       wait_for_tx(transfer(destination, amount, sender_key, legacy))
     end
 
-    # Simply transfer Ether to an account without any call data or
+    # Simply transfer Klay to an account without any call data or
     # access lists attached. Uses `eth_coinbase` and external signer
     # if no sender key is provided.
     #
-    # @param destination [Eth::Address] the destination address.
+    # @param destination [Klay::Address] the destination address.
     # @param amount [Integer] the transfer amount in Wei.
-    # @param sender_key [Eth::Key] the sender private key.
+    # @param sender_key [Klay::Key] the sender private key.
     # @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     # @return [String] the transaction hash.
     def transfer(destination, amount, sender_key = nil, legacy = false)
@@ -135,7 +135,7 @@ module Klay
           from: sender_key.address,
           nonce: get_nonce(sender_key.address),
         })
-        tx = Eth::Tx.new(params)
+        tx = Klay::Tx.new(params)
         tx.sign sender_key
         return eth_send_raw_transaction(tx.hex)["result"]
       else
@@ -183,7 +183,7 @@ module Klay
     end
 
     # Metafunction to provide all known RPC commands defined in
-    # Eth::Api as snake_case methods to the Eth::Client classes.
+    # Klay::Api as snake_case methods to the Klay::Client classes.
     Api::COMMANDS.each do |cmd|
       method_name = cmd.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
       define_method method_name do |*args|

data/lib/klay/constant.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 
 #  -*- encoding : ascii-8bit -*-
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Provides commonly used constants, such as zero bytes or zero keys.

data/lib/klay/eip712.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+# Copyright (c) 2016-2022 The Ruby-Klay Contributors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Defines handy tools for encoding typed structured data as per EIP-712.