platon 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b21ae9984ff18a3127a41dcdf874b2faf09e0a5894ff76f6a1cb8c2f0bdabd4
-  data.tar.gz: 9e7fa8d362e19aa6a242c102dcf4ec9f26ca82d4766294e0e1bcb50c23cad4d8
+  metadata.gz: 5b74aa93e42dc1018e37a97771b504ce6f9afd8e54cd71d2356878e7a0b96d6f
+  data.tar.gz: 27c316fccb2c0e8a794e743ccd4c5f9f9bddac9510ad5d0e5060f351333e54ab
 SHA512:
-  metadata.gz: 47433d9c023943de1c279ce43628f127670085f48e5f01d5af85a002d129d680c8401ae29330e1a481cb2192e2540879f38f5757d7b589ed3a922d72c7f247d1
-  data.tar.gz: d24a4404809cb945d595d869d701fe6542065b352143174583cf00bf59e8a9cdae4fdc94b8623f21f3a956a1952eb40fb2774ae1321eaf8892463647d2e1c5a0
+  metadata.gz: 25d498145373bbcc9e769208eebbd37cfbbdfa3abdcb2f4ef1fb0d6abe3fe4ac3831ac05adb578b70a1c27bc4fdd682647b7a6e9be6af44e904bbddabaa28b7d
+  data.tar.gz: 96195888ad12015a29f3cf5da1d15ec7ffd2ccf8c9241eabd74308121c2a3dac14bab565c52c1ae2f5622704dcf462d6db044a1129b286ae6b88989b3715d65a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    platon (0.2.6)
+    platon (0.2.8)
       activesupport (>= 4.0)
       digest-sha3 (~> 1.1)
       ffi (~> 1.0)
@@ -18,7 +18,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     digest-sha3 (1.1.0)
     ffi (1.15.1)

data/README.md

@@ -1,7 +1,6 @@
 # Ruby SDK for Platon & Alaya 
 
 
-
 <p align="center">
     <img src="./platon-ruby-logo.png" width="80" title="platon ruby SDK" alt="platon ruby SDK">
 </p>
@@ -29,7 +28,7 @@ Or install it yourself as:
 
 ## Quick Start
 
-```
+```ruby
 ## generate new key 
 key = Platon::Key.new  
 
@@ -53,7 +52,7 @@ client.transfer key,"atpxxxxxxxxxxxxxxx",10**16
 
 Create a new public/private key and get its address
 
-```
+```ruby
 key = Platon::Key.new
 key.private_hex ## private key
 => "08bb093d6184cb06a3f80507953ba6768c03d8114a429b0ec7875bb6b6e1a8a6"
@@ -61,11 +60,11 @@ key.private_hex ## private key
 key.public_hex ## public key
 => "04641129e66399310ce4a41098d3b3fc4d722edf423dfdc0a76eba5d6e2155bbe611ee2a5c06011ab76040ca53b9ead4c5061d8cc8a89afa3f45af5830661d4b34"
 
-key.bech32_address  ## bech32 address ,default "atp"
-=> "atp1ls87d3mqfhxadjsmn0ns844tj8ljlsq89k95cn" 
+key.bech32_address  ## bech32 address ,default "lat"
+=> "lat1ls87d3mqfhxadjsmn0ns844tj8ljlsq8uqnv8u" 
 
-key.bech32_address(hrp: "lat") 
-=> "lat1ls87d3mqfhxadjsmn0ns844tj8ljlsq8uqnv8u"
+key.bech32_address(hrp: "atp") 
+=> "atp1ls87d3mqfhxadjsmn0ns844tj8ljlsq89k95cn"
 
 key.address ## EIP55 checksummed address
 => "0xFc0Fe6c7604dcDd6ca1B9be703D6AB91fF2fC007"
@@ -73,14 +72,19 @@ key.address ## EIP55 checksummed address
 
 Encrypt keys to json file
 
-```
+```ruby
+## default address hrp:"lat"
 encrypted_key_info = Platon::Key.encrypt key,"your_password"
 
+## set address hrp
+
+encrypted_key_info = Platon::Key.encrypt key,"your_password",{hrp:"atp"}
+
 ## or save to location
 
-Platon::Key.encrypt_and_save key,"your_password",'./some/path.json'
+Platon::Key.encrypt_and_save key,"your_password",{hrp:"atp",keypath:'./some/path.json'}
 
-## or default:  ~/.platon/keystore
+## or default keypath: "~/.platon/keystore" ,and use default hrp:"lat"
 
 Platon::Key.encrypt_and_save key,"your_password" 
 
@@ -88,7 +92,7 @@ Platon::Key.encrypt_and_save key,"your_password"
 
 Decrypt keys from json file
 
-```
+```ruby
 decrypted_key = Platon::Key.decrypt encrypted_key_info,"your_password"
 
 or
@@ -100,7 +104,7 @@ decrypted_key = Platon::Key.decrypt File.read('./some/path.json'), 'your_passwor
 
 Build a transcation :
 
-```
+```ruby
 args = { 
     from: key.address,
     to: key2.address,
@@ -116,13 +120,13 @@ tx = Platon::Tx.new args
 
 Or decode from an encoded raw transaction
 
-```
+```ruby
 tx = Platon::Tx.decode hex
 ```
 
 You can sign the transaction:
 
-```
+```ruby
 tx.sign key
 platon_send_raw_transaction(tx.hex)
 ```
@@ -133,7 +137,7 @@ Get the raw transaction with `tx.hex`, and broadcast it through any PlatON node
 
 By default methods interactiong with contracts&PPOS will use default JSON RPC Client that will handle connection to platon node. 
 
-```
+```ruby
 client = Platon::HttpClient.new("http://127.0.0.1:6789",:alayadev)
 ```
 
@@ -146,7 +150,7 @@ Default setting:
 
 You can use `client.update_setting` to change chain configs:
 
-```
+```ruby
 client.update_setting(hrp:"atx",chain_id: 1234)
 ```
 
@@ -154,12 +158,12 @@ client.update_setting(hrp:"atx",chain_id: 1234)
 
 You can get contract from blockchain. To do so you need a contract name ,contract address and ABI definition:
 
-```
+```ruby
 contract = Platon::Contract.create(client: client ,name: "MyContract", address: "atpxxxx_your_bench32_address", abi: abi)
 ```
 
 Alternatively you can obtain abi definition and name from contract source file:
-```
+```ruby
 contract = Platon::Contract.create(client: client , file: "MyContract.sol", address: "atpxxxx_your_bench32_address")
 ```
 
@@ -167,7 +171,7 @@ Interacting with contracts:
 
 You can `call` contract read-only method , no transaction will be sent to the network. If method changes contract state ,`transact` method can be used .
 
-```
+```ruby
 contract.call.[function_name](params)
 
 contract.transact.[function_name](params)
@@ -181,7 +185,7 @@ All PPOS methods have been implemented. See [Docs](./doc/zh-cn.md)
 
 #### Utils
 
-```
+```ruby
 Platon::Utils.is_bech32_address?("atp1tfm3e44jwdjmelcc9yacus700wcts0zhgw6425")
 => true
 

data/doc/zh-cn.md

@@ -66,13 +66,18 @@ key.address ## EIP55 checksummed address
 将key加密保存至json文件
 
 ```ruby
+## default address hrp:"lat"
 encrypted_key_info = Platon::Key.encrypt key,"your_password"
 
+## set address hrp
+
+encrypted_key_info = Platon::Key.encrypt key,"your_password",{hrp:"atp"}
+
 ## or save to location
 
-Platon::Key.encrypt_and_save key,"your_password",'./some/path.json'
+Platon::Key.encrypt_and_save key,"your_password",{hrp:"atp",keypath:'./some/path.json'}
 
-## or default:  ~/.platon/keystore
+## or default keypath: "~/.platon/keystore" ,and use default hrp:"lat"
 
 Platon::Key.encrypt_and_save key,"your_password" 
 
@@ -929,11 +934,11 @@ key.public_hex ## 公钥
 key.address
 => "0xFc0Fe6c7604dcDd6ca1B9be703D6AB91fF2fC007"
 
-key.bech32_address  ## bech32 格式公钥 ,默认是 "atp"
-=> "atp1ls87d3mqfhxadjsmn0ns844tj8ljlsq89k95cn" 
+key.bech32_address  ## bech32 格式公钥 ,默认是 "lat"
+=> "lat1ls87d3mqfhxadjsmn0ns844tj8ljlsq8uqnv8u" 
 
-key.bech32_address(hrp: "lat") 
-=> "lat1ls87d3mqfhxadjsmn0ns844tj8ljlsq8uqnv8u"
+key.bech32_address(hrp: "atp") 
+=> "atp1ls87d3mqfhxadjsmn0ns844tj8ljlsq89k95cn"
 ```
 
 ### 使用已有私钥导入创建key
@@ -945,40 +950,53 @@ key = Platon::Key.new priv: private_key
 
 ### 备份钱包 encrypt
 
-备份钱包，输入密码加密得到json字符串
+备份钱包，输入密码加密得到json字符串。第三个参数为options,hash类型，可传参数有:  hrp
 
 ```ruby
+# 默认使用的hrp为"lat"
 encrypted_key_info = Platon::Key.encrypt key,"your_password"
 
-# or
+#or
 
-Platon::Key.encrypt_and_save key,"your_password",'./some/path.json'
+encrypted_key_info = Platon::Key.encrypt key,"your_password",{hrp:"atp"}
+
+```
+### 备份钱包且存储
 
-# or 使用默认地址:  ~/.platon/keystore
+备份钱包，输入密码加密得到json字符串,并存储于指定路径或默认路径。第三个参数为options,hash类型，可传参数有:  hrp ,keypath
 
+```ruby
+#使用默认地址:  ~/.platon/keystore ,默认hrp: "lat"
 Platon::Key.encrypt_and_save key,"your_password" 
 
+# or 
+
+Platon::Key.encrypt_and_save key,"your_password",{hrp:"atp",keypath:'./some/path.json'}
+
 ```
 
+
 ### 恢复钱包 decrypt
-恢复钱包，输入密码得到key对象
+恢复钱包，输入密码得到key对象, 恢复钱包可适配任意hrp，无需指定hrp
 
 ```ruby
 decrypted_key = Platon::Key.decrypt encrypted_key_info,"your_password"
 
-# or
+# or 先读取指定路径的钱包文件
 
 decrypted_key = Platon::Key.decrypt File.read('./some/path.json'), 'your_password'
 ```
 
 ###查询本地钱包 list_wallets
 
+可传参数options,默认路径为 "~/.platon/keystore"
+
 ```ruby
 Platon::Key.list_wallets
 
 # or
 
-Platon::Key.list_wallets("/your/wallet/path/")
+Platon::Key.list_wallets(keypath:"/your/wallet/path/")
 ```
 
 
@@ -1040,7 +1058,7 @@ rake 'platon:contract:compile[./spec/fixtures/greeter.sol]'
 
 * 参数
     * `Object`: 发起方的 Key 实例，通过 Platon::Key.new 创建或导入
-    * `Integer`: typ, 表示使用账户自由金额还是账户的锁仓金额做质押，0: 自由金额； 1: 锁仓金额
+    * `Integer`: typ, 表示使用账户自由金额还是账户的锁仓金额做质押，0: 自由金额； 1: 锁仓金额 2:优先使用锁仓余额，锁仓余额不足，则剩下使用自由金额
     * `String`: benefitAddress,用于接受出块奖励和质押奖励的收益账户
     * `String`: nodeId,被质押的节点Id(也叫候选人的节点Id)
     * `String`: externalId,外部Id(有长度限制，给第三方拉取节点描述的Id)

data/examples/generate_keys.rb

@@ -0,0 +1,17 @@
+require "platon"
+
+puts "Example : generate key , print address and private_key"
+
+while true
+	puts ""
+	puts "Press any key to Generate keys.."
+	STDIN.readline
+
+
+	key = Platon::Key.new
+	puts "Address on PlatON: #{key.bech32_address(hrp: "lat")}"
+	puts "Address on Alaya: #{key.bech32_address(hrp: "atp")}"
+	puts "EIP55 address: #{key.address}"
+	puts "PrivateKey: #{key.private_hex}"
+	puts "===================================="
+end

data/examples/get_balance.rb

@@ -0,0 +1,33 @@
+### Get Core Token(lat or atp) balance  
+### Get Arc20/Prc20 balance
+
+require "platon"
+
+### Example on Alaya:
+
+RPC = "http://127.0.0.1:6789" # change to your rpc address
+
+TARGET_ADDRESS_1 = "atp1lsds5k5wys93vhm8gvkvepyx5e9hxtfz8w4r5x"
+TARGET_ADDRESS_2 = "atp1djc6dvd2y2kj04hhy30rmctkc9nnqmmzlk42uv"
+
+
+client = Platon::HttpClient.new(RPC,"alaya")
+
+###Get Core Token(lat or atp) balance
+res =  client.platon_get_balance(TARGET_ADDRESS_1,"latest")
+balance = res / 10**18.to_f
+puts "#{TARGET_ADDRESS_1} #{client.hrp.upcase} balance: #{balance} "
+
+###Get Arc20/Prc20 balance
+client.default_account = Platon::Key.new.bech32_address  # 随机生成地址并指定即可。 因platon节点要求call也必须传入from参数
+minABI=[{"constant":true,"inputs":[{"name":"_owner","type":"address"}],"name":"balanceOf","outputs":[{"name":"balance","type":"uint256"}],"type":"function"},{"constant":true,"inputs":[],"name":"decimals","outputs":[{"name":"","type":"uint8"}],"type":"function"}];
+contract = Platon::Contract.create(
+	client:client, 
+	name: "MyContract", 
+	address: "atp16lellpkrv894hmg8am7ns3p2qny2vqj85ud8s6",  #ARC20 contract address
+	abi:minABI # Arc20 contract abi
+	)
+
+res2 =  contract.call.balance_of(TARGET_ADDRESS_2)
+aETH_balance = res2 / 10**18.to_f
+puts "#{TARGET_ADDRESS_2} aETH balance: #{aETH_balance}"

data/lib/platon.rb

@@ -9,8 +9,6 @@ require 'ffi'
 require 'money-tree'
 require 'rlp'
 
-require 'bech32'
-
 module Platon
 
   BYTE_ZERO = "\x00".freeze
@@ -38,28 +36,29 @@ module Platon
     end
   end
 
-  require 'platon/abi'
-  require 'platon/client'
-  require 'platon/ipc_client'
-  require 'platon/http_client'
-  require 'platon/singleton'
-  require 'platon/solidity'
-  require 'platon/initializer'
-  require 'platon/contract'
-  require 'platon/explorer_url_helper'
-  require 'platon/function'
-  require 'platon/function_input'
-  require 'platon/function_output'
-  require 'platon/contract_event'
-  require 'platon/encoder'
-  require 'platon/decoder'
-  require 'platon/formatter'
-  require 'platon/transaction'
-  require 'platon/deployment'
-  require 'platon/contract_initializer'
-  require 'platon/railtie' if defined?(Rails)
-
-  require 'platon/ppos'
+  require_relative 'platon/bech32'
+  require_relative 'platon/abi'
+  require_relative 'platon/client'
+  require_relative 'platon/ipc_client'
+  require_relative 'platon/http_client'
+  require_relative 'platon/singleton'
+  require_relative 'platon/solidity'
+  require_relative 'platon/initializer'
+  require_relative 'platon/contract'
+  require_relative 'platon/explorer_url_helper'
+  require_relative 'platon/function'
+  require_relative 'platon/function_input'
+  require_relative 'platon/function_output'
+  require_relative 'platon/contract_event'
+  require_relative 'platon/encoder'
+  require_relative 'platon/decoder'
+  require_relative 'platon/formatter'
+  require_relative 'platon/transaction'
+  require_relative 'platon/deployment'
+  require_relative 'platon/contract_initializer'
+  require_relative 'platon/railtie' if defined?(Rails)
+
+  require_relative 'platon/ppos'
 
   autoload :Address, 'platon/address'
   autoload :Gas, 'platon/gas'

data/lib/platon/client.rb

@@ -138,7 +138,7 @@ module Platon
       # end
       
       payload = {jsonrpc: "2.0", method: command, params: encode_params(args), id: get_id}
-      # puts payload
+      puts payload
       @logger.info("Sending #{payload.to_json}") if @log
       if @batch
         @batch << payload
@@ -146,7 +146,7 @@ module Platon
       else
         # tmp = send_single(payload.to_json)
         # output = JSON.parse(tmp)
-        output = JSON.parse(send_single(payload.to_json))
+        p output = JSON.parse(send_single(payload.to_json))
         @logger.info("Received #{output.to_json}") if @log
         reset_id
         raise IOError, output["error"]["message"] if output["error"]

data/lib/platon/contract.rb

@@ -11,10 +11,6 @@ module Platon
     attr_accessor :call_raw_proxy, :call_proxy, :transact_proxy, :transact_and_wait_proxy
     attr_accessor :new_filter_proxy, :get_filter_logs_proxy, :get_filter_change_proxy
 
-    def self.hello
-      puts 111
-    end
-
     def initialize(name, code, abi, client = Platon::Singleton.instance)
       @name = name
       @code = code

data/lib/platon/key.rb

@@ -5,10 +5,10 @@ module Platon
 
     attr_reader :private_key, :public_key
 
-    def self.encrypt(key, password)
+    def self.encrypt(key, password,options={})
       key = new(priv: key) unless key.is_a?(Key)
 
-      Encrypter.perform key.private_hex, password
+      Encrypter.perform key.private_hex, password ,options
     end
 
     def self.decrypt(data, password)
@@ -16,9 +16,10 @@ module Platon
       new priv: priv
     end
 
-    def self.encrypt_and_save(key,password,keypath=nil)
-      encrypted_key_info = encrypt(key,password)
+    def self.encrypt_and_save(key,password,options={})
+      encrypted_key_info = encrypt(key,password,options)
       ## PlatON似乎打算兼容以太地址, 暂时默认以 0x 地址命名 
+      keypath = options[:keypath]
       if keypath==nil || keypath=="" 
         address = key.address
         dirname = "#{ENV['HOME']}/.platon/keystore/"
@@ -30,7 +31,8 @@ module Platon
       return encrypted_key_info
     end
 
-    def self.list_wallets(keypath=nil)
+    def self.list_wallets(options={})
+      keypath = options[:keypath]
       if keypath==nil || keypath=="" 
         Dir.glob("#{ENV['HOME']}/.platon/keystore/*").select { |e| File.file? e }
       else
@@ -64,8 +66,8 @@ module Platon
       Utils.public_key_to_address public_hex
     end
 
-    def bech32_address(hrp:"atp")
-      Utils.to_bech32_address(hrp,address) ##TODO
+    def bech32_address(hrp:"lat")
+      Utils.to_bech32_address(hrp,address)
     end
     alias_method :to_address, :address
 

data/lib/platon/key/encrypter.rb

@@ -122,7 +122,7 @@ class Platon::Key::Encrypter
   end
 
   def address
-    Platon::Key.new(priv: key).address
+    Platon::Key.new(priv: key).bech32_address(hrp: options[:hrp] ? options[:hrp]:"atp")
   end
 
 end

data/lib/platon/open_ssl.rb

@@ -9,7 +9,7 @@ module Platon
       ffi_lib 'libeay32', 'ssleay32'
     else
       ffi_lib [
-        'libssl.so.1.1.0', 'libssl.so.1.1',
+        'libssl.so.1.1.0', 'libssl.so.1.1', 'libssl.1.1',
         'libssl.so.1.0.0', 'libssl.so.10',
         'ssl'
       ]
@@ -55,22 +55,21 @@ module Platon
     # @return [Integer] version number as an integer.
     def self.version
       if self.respond_to?(:OpenSSL_version_num)
-        OpenSSL_version_num()
+        OpenSSL_version_num()    
       else
-        SSLeay()
+        # Hardcode here: OpenSSL verson > 1.1 should < 269484032 . But on MacOS ,version 1.0.2 ,SSLeay returns 536870912 ,that is v2.0.0  
+        [SSLeay(),269484031].min
       end
     end
 
-    # if version >= VERSION_1_1_0_NUM
-
-    #   # Initialization procedure for the library was changed in OpenSSL 1.1.0
-    #   attach_function :OPENSSL_init_ssl, [:uint64, :pointer], :int
-    # else
-
+    if version >= VERSION_1_1_0_NUM
+      # Initialization procedure for the library was changed in OpenSSL 1.1.0
+      attach_function :OPENSSL_init_ssl, [:uint64, :pointer], :int
+    else
       attach_function :SSL_library_init, [], :int
       attach_function :ERR_load_crypto_strings, [], :void
       attach_function :SSL_load_error_strings, [], :void
-    # end
+    end
 
     attach_function :RAND_poll, [], :int
     attach_function :BN_CTX_free, [:pointer], :int
@@ -227,16 +226,16 @@ module Platon
       def init_ffi_ssl
         return if @ssl_loaded
 
-        # if version >= VERSION_1_1_0_NUM
-          # OPENSSL_init_ssl(
-          #   OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_ENGINE_ALL_BUILTIN,
-          #   nil
-          # )
-        # else
+        if version >= VERSION_1_1_0_NUM
+          OPENSSL_init_ssl(
+            OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_ENGINE_ALL_BUILTIN,
+            nil
+          )
+        else
           SSL_library_init()
           ERR_load_crypto_strings()
           SSL_load_error_strings()
-        # end
+        end
 
         RAND_poll()
         @ssl_loaded = true

data/lib/platon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Platon
-  VERSION = "0.2.7"
+  VERSION = "0.2.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: platon
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - vianull
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,10 +169,12 @@ files:
 - bin/console
 - bin/setup
 - doc/zh-cn.md
-- lib/bech32.rb
+- examples/generate_keys.rb
+- examples/get_balance.rb
 - lib/platon.rb
 - lib/platon/abi.rb
 - lib/platon/address.rb
+- lib/platon/bech32.rb
 - lib/platon/client.rb
 - lib/platon/contract.rb
 - lib/platon/contract_event.rb
@@ -207,7 +209,6 @@ files:
 - lib/tasks/platon_contract.rake
 - platon-ruby-logo.png
 - platon.gemspec
-- platon.gemspec.bak
 homepage:
 licenses:
 - MIT