klay 0.0.2 → 0.0.5

data/lib/klay/tx/eip2930.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
 
   # Provides the `Tx` module supporting various transaction types.
@@ -75,8 +75,8 @@ module Klay
       # @option params [Integer] :nonce the signer nonce.
       # @option params [Integer] :gas_price the gas price.
       # @option params [Integer] :gas_limit the gas limit.
-      # @option params [Eth::Address] :from the sender address.
-      # @option params [Eth::Address] :to the reciever address.
+      # @option params [Klay::Address] :from the sender address.
+      # @option params [Klay::Address] :to the reciever address.
       # @option params [Integer] :value the transaction value.
       # @option params [String] :data the transaction data payload.
       # @option params [Array] :access_list an optional access list.
@@ -124,11 +124,11 @@ module Klay
       # Overloads the constructor for decoding raw transactions and creating unsigned copies.
       konstructor :decode, :unsigned_copy
 
-      # Decodes a raw transaction hex into an {Eth::Tx::Eip2930}
+      # Decodes a raw transaction hex into an {Klay::Tx::Eip2930}
       # transaction object.
       #
       # @param hex [String] the raw transaction hex-string.
-      # @return [Eth::Tx::Eip2930] transaction payload.
+      # @return [Klay::Tx::Eip2930] transaction payload.
       # @raise [TransactionTypeError] if transaction type is invalid.
       # @raise [ParameterError] if transaction is missing fields.
       # @raise [DecoderError] if transaction decoding fails.
@@ -189,8 +189,8 @@ module Klay
 
       # Creates an unsigned copy of a transaction payload.
       #
-      # @param tx [Eth::Tx::Eip2930] an EIP-2930 transaction payload.
-      # @return [Eth::Tx::Eip2930] an unsigned EIP-2930 transaction payload.
+      # @param tx [Klay::Tx::Eip2930] an EIP-2930 transaction payload.
+      # @return [Klay::Tx::Eip2930] an unsigned EIP-2930 transaction payload.
       # @raise [TransactionTypeError] if transaction type does not match.
       def unsigned_copy(tx)
 
@@ -219,7 +219,7 @@ module Klay
 
       # Sign the transaction with a given key.
       #
-      # @param key [Eth::Key] the key-pair to use for signing.
+      # @param key [Klay::Key] the key-pair to use for signing.
       # @return [String] a transaction hash.
       # @raise [Signature::SignatureError] if transaction is already signed.
       # @raise [Signature::SignatureError] if sender address does not match signing key.

data/lib/klay/tx/legacy.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
 
   # Provides the `Tx` module supporting various transaction types.
@@ -67,8 +67,8 @@ module Klay
       # @option params [Integer] :nonce the signer nonce.
       # @option params [Integer] :gas_price the gas price.
       # @option params [Integer] :gas_limit the gas limit.
-      # @option params [Eth::Address] :from the sender address.
-      # @option params [Eth::Address] :to the reciever address.
+      # @option params [Klay::Address] :from the sender address.
+      # @option params [Klay::Address] :to the reciever address.
       # @option params [Integer] :value the transaction value.
       # @option params [String] :data the transaction data payload.
       # @param chain_id [Integer] the EIP-155 Chain ID.
@@ -113,11 +113,11 @@ module Klay
       # overloads the constructor for decoding raw transactions and creating unsigned copies
       konstructor :decode, :unsigned_copy
 
-      # Decodes a raw transaction hex into an {Eth::Tx::Legacy}
+      # Decodes a raw transaction hex into an {Klay::Tx::Legacy}
       # transaction object.
       #
       # @param hex [String] the raw transaction hex-string.
-      # @return [Eth::Tx::Legacy] transaction object.
+      # @return [Klay::Tx::Legacy] transaction object.
       # @raise [ParameterError] if transaction misses fields.
       def decode(hex)
         bin = Util.hex_to_bin hex
@@ -170,8 +170,8 @@ module Klay
 
       # Creates an unsigned copy of a transaction.
       #
-      # @param tx [Eth::Tx::Legacy] an legacy transaction object.
-      # @return [Eth::Tx::Legacy] an unsigned transaction object.
+      # @param tx [Klay::Tx::Legacy] an legacy transaction object.
+      # @return [Klay::Tx::Legacy] an unsigned transaction object.
       # @raise [TransactionTypeError] if transaction type does not match.
       def unsigned_copy(tx)
 
@@ -199,7 +199,7 @@ module Klay
 
       # Sign the transaction with a given key.
       #
-      # @param key [Eth::Key] the key-pair to use for signing.
+      # @param key [Klay::Key] the key-pair to use for signing.
       # @return [String] a transaction hash.
       # @raise [Signature::SignatureError] if transaction is already signed.
       # @raise [Signature::SignatureError] if sender address does not match signing key.

data/lib/klay/tx.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.
@@ -20,7 +20,7 @@ require "klay/tx/eip2930"
 require "klay/tx/legacy"
 require "klay/unit"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Provides the `Tx` module supporting various transaction types.
@@ -39,8 +39,8 @@ module Klay
     # The minimum transaction gas limit required for a value transfer.
     DEFAULT_GAS_LIMIT = 21_000.freeze
 
-    # The "default" transaction gas price of 20 GWei. Do not use.
-    DEFAULT_GAS_PRICE = (20 * Unit::GWEI).freeze
+    # The "default" transaction gas price of 25 GPeb.
+    DEFAULT_GAS_PRICE = (25 * Unit::GPEB).freeze
 
     # The calldata gas cost of a non-zero byte as per EIP-2028.
     COST_NON_ZERO_BYTE = 16.freeze
@@ -101,7 +101,7 @@ module Klay
     # Decodes a transaction hex of any known type (2, 1, or legacy).
     #
     # @param hex [String] the raw transaction hex-string.
-    # @return [Eth::Tx] transaction payload.
+    # @return [Klay::Tx] transaction payload.
     # @raise [TransactionTypeError] if the transaction type is unknown.
     def decode(hex)
       hex = Util.remove_hex_prefix hex
@@ -128,8 +128,8 @@ module Klay
 
     # Creates an unsigned copy of any transaction object.
     #
-    # @param tx [Eth::Tx] any transaction payload.
-    # @return [Eth::Tx] an unsigned transaction payload of the same type.
+    # @param tx [Klay::Tx] any transaction payload.
+    # @return [Klay::Tx] an unsigned transaction payload of the same type.
     # @raise [TransactionTypeError] if the transaction type is unknown.
     def unsigned_copy(tx)
       case tx.type

data/lib/klay/unit.rb

@@ -14,36 +14,24 @@
 
 require "bigdecimal"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
   # Provides constants for common Ethereum units.
   module Unit
     extend self
 
-    # Ethereum unit 1 wei := 0.000000000000000001 Ether.
-    WEI = BigDecimal("1e0").freeze
+    # Ethereum unit 1 peb := 0.000000000000000001 Klay.
+    PEB = BigDecimal("1e0").freeze
 
-    # Ethereum unit 1 babbage := 0.000000000000001 Ether or 1_000 wei.
-    BABBAGE = BigDecimal("1e3").freeze
+    # Ethereum unit 1 ston := 0.000000001 Klay or 1_000_000_000 peb.
+    STON = BigDecimal("1e9").freeze
 
-    # Ethereum unit 1 lovelace := 0.000000000001 Ether or 1_000_000 wei.
-    LOVELACE = BigDecimal("1e6").freeze
-
-    # Ethereum unit 1 shannon := 0.000000001 Ether or 1_000_000_000 wei.
-    SHANNON = BigDecimal("1e9").freeze
-
-    # Ethereum unit 1 szabo := 0.000_001 Ether or 1_000_000_000_000 wei.
-    SZABO = BigDecimal("1e12").freeze
-
-    # Ethereum unit 1 finney := 0.001 Ether or 1_000_000_000_000_000 wei.
-    FINNEY = BigDecimal("1e15").freeze
-
-    # Ethereum unit 1 Ether := 1_000_000_000_000_000_000 wei.
+    # Ethereum unit 1 Klay := 1_000_000_000_000_000_000 peb.
     ETHER = BigDecimal("1e18").freeze
 
-    # Ethereum unit 1 Gwei := 0.000000001 Ether or 1_000_000_000 wei.
-    # Same as shannon, but more commonly used (billion wei).
-    GWEI = SHANNON.freeze
+    # Ethereum unit 1 Gpeb := 0.000000001 Ether or 1_000_000_000 peb.
+    # Same as shannon, but more commonly used (billion peb).
+    GPEB = STON.freeze
   end
 end

data/lib/klay/util.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,18 +14,18 @@
 
 require "digest/keccak"
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 
-  # Defines handy tools for the {Eth} gem for convenience.
+  # Defines handy tools for the {Klay} gem for convenience.
   module Util
     extend self
 
-    # Generates an Ethereum address from a given compressed or
+    # Generates an Klaytn address from a given compressed or
     # uncompressed binary or hexadecimal public key string.
     #
     # @param str [String] the public key to be converted.
-    # @return [Eth::Address] an Ethereum address.
+    # @return [Klay::Address] an Klaytn address.
     def public_key_to_address(str)
       str = hex_to_bin str if is_hex? str
       bytes = keccak256(str[1..-1])[-20..-1]

data/lib/klay/version.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,9 +12,9 @@
 # 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 the version of the {Eth} module.
-  VERSION = "0.0.2".freeze
+  # Defines the version of the {Klay} module.
+  VERSION = "0.0.5".freeze
 end

data/lib/klay.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,11 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the {Eth} module.
+# Provides the {Klay} module.
 module Klay
 end
 
-# Loads the {Eth} module classes.
+# Loads the {Klay} module classes.
 require "klay/abi"
 require "klay/api"
 require "klay/address"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Sehan Park
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -87,8 +87,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/codeql.yml"
-- ".github/workflows/docs.yml"
 - ".github/workflows/spec.yml"
 - ".gitignore"
 - ".gitmodules"

data/.github/workflows/codeql.yml

@@ -1,48 +0,0 @@
----
-name: CodeQL
-
-on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-    strategy:
-      fail-fast: false
-      matrix:
-        language:
-          - ruby
-    steps:
-      - name: "Checkout repository"
-        uses: actions/checkout@v2
-      - name: "Initialize CodeQL"
-        uses: github/codeql-action/init@v1
-        with:
-          languages: "${{ matrix.language }}"
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
-      - name: "Perform CodeQL Analysis"
-        uses: github/codeql-action/analyze@v1
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.7'
-          bundler-cache: true
-      - name: "Run rufo code formatting checks"
-        run: |
-          gem install rufo
-          rufo --check ./lib
-          rufo --check ./spec
-      - name: "Run yard documentation checks"
-        run: |
-          gem install yard
-          yard doc --fail-on-warning

data/.github/workflows/docs.yml

@@ -1,26 +0,0 @@
----
-name: Docs
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '2.7'
-        bundler-cache: true
-    - name: Run Yard Doc
-      run: |
-        gem install yard
-        yard doc
-    - name: Deploy GH Pages
-      uses: JamesIves/github-pages-deploy-action@4.1.7
-      with:
-          branch: gh-pages
-          folder: doc/