ic_agent 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afda8300e3e7767519eb7322d27268d5f486b0201131ef5de7ae786ae9385239
-  data.tar.gz: fc2baeee2c47d76345dfc64d668dd5bd6d68f81a4113aae7b07865f85ba8062d
+  metadata.gz: 872963d331d311c6a940f64445ef0583397885eb9455464f4d865d325f24ee97
+  data.tar.gz: 8b11f6cc71864468b52e66a6577fb3002bcf14cfde2ce93b1dfb6f819eb1df84
 SHA512:
-  metadata.gz: c1fa506bb6e618bfe3f0995b1127c14030a4000fb4b07ee40e0af976d968b5d441c4564ee92bd2c877c9b47430f772a671c245467dc15959ff986ec94fb30723
-  data.tar.gz: e8cf412aeac35f7b37c8fb2a396e0a6d0aa98424e32bc9aadf7f3d84e18a691c8c5cb41f898b458612012bcb6413d82c573e260606b63c5d5b79e7c98b0654ec
+  metadata.gz: 5ead16aeb03ac87caa4620ee9f813e7d79399f95d9cb2424cbedd2af828f9dd06f14a1f9d200ac596783ea3b47fdd88f500256608e972011e1dae01e69452cf4
+  data.tar.gz: d6ebbda49c03f1e2df8fe3e28ffd2b53424a83e04b386841f8874c6b888f4089d8c0150194930ffdab836e81961cfc657168a6e225e0ddd32c665d03159e1cc3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ic_agent (0.1.2)
+    ic_agent (0.1.4)
       base32 (~> 0.3.4)
       bitcoin-ruby (~> 0.0.20)
       cbor (~> 0.5.9.6)

data/README.md

@@ -13,11 +13,13 @@ gem install ic_agent
 
 ### Features
 
-1. candid types encode & decode
-2. support secp256k1 & ed25519 identity, pem file import
-3. canister DID file parsing
-4. canister class, initialized with canister id and DID file
-5. common canister interfaces: ledger, management, nns, cycles wallet
+1. principal create and generate
+2. candid types encode & decode
+3. support secp256k1 & ed25519 identity
+4. canister DID file parsing
+5. canister class, initialized with canister id and DID file
+6. common canister interfaces: ledger, management, nns, cycles wallet
+7. BLS Verify
 
 ### Modules & Usage
 
@@ -140,7 +142,27 @@ subnet_public_key = IcAgent::SyetemState.subnet_public_key(agent, "gvbup-jyaaa-a
 Create a canister instance with candid interface file and canister id, and call canister method with canister instance:
 
 ```ruby
-gov_canister = IcAgent::Canister.new(@agent, @gov_canister_id, @gov_didl)
+agent = IcAgent::Agent.new(iden, client)
+gov_canister_id = 'rrkah-fqaaa-aaaaa-aaaaq-cai'
+gov_didl = <<~DIDL_DOC
+      // type
+      type AccountIdentifier = record { hash : vec nat8 };
+      type Action = variant {
+        RegisterKnownNeuron : KnownNeuron;
+        ManageNeuron : ManageNeuron;
+        ExecuteNnsFunction : ExecuteNnsFunction;
+        RewardNodeProvider : RewardNodeProvider;
+        SetDefaultFollowees : SetDefaultFollowees;
+        RewardNodeProviders : RewardNodeProviders;
+        ManageNetworkEconomics : NetworkEconomics;
+        ApproveGenesisKyc : ApproveGenesisKyc;
+        AddOrRemoveNodeProvider : AddOrRemoveNodeProvider;
+        Motion : Motion;
+      };
+      ......
+DIDL_DOC
+
+gov_canister = IcAgent::Canister.new(agent, gov_canister_id, gov_didl)
 res = gov_canister.get_neuron_ids()
 ```
 

data/lib/ic_agent/ast/assembler.rb

@@ -153,34 +153,10 @@ module IcAgent
       end
 
       def self.get_params_refer_values(type_str)
-        pure_child_code, replaced_hash = replace_multi_type(type_str)
-        key_index = 0
-        value_arr = []
-        pure_child_arr = pure_child_code.strip.split(';').map(&:strip).collect { |item| item.gsub('{', '').gsub('}', '') }.reject(&:empty?)
-        pure_child_arr.each do |item|
-          _, item_value = get_record_key_value(item, ':', key_index)
-          value_arr << item_value.split(' ')
-          key_index += 1
-        end
-
-        replaced_hash.each_key do |key|
-          item_type = key.index('record') ? 'record' : 'variant'
-          item_arr = replaced_hash[key].sub('record', '').sub('variant', '').strip.split(';').map(&:strip).collect { |item| item.gsub('{', '').gsub('}', '') }.reject(&:empty?)
-          item_arr.each do |item|
-            multi_item_arr = item.strip.split(':')
-            if multi_item_arr.size > 1
-              item_value_arr = multi_item_arr[1].strip.split(' ').collect { |v| v.strip.gsub(';', '') }
-              item_value_arr.delete('{')
-              item_value_arr.delete('}')
-              item_value_arr.delete('{}')
-              value_arr << item_value_arr
-            else
-              value_arr << multi_item_arr[0].strip if item_type == 'record'
-            end
-          end
-          value_arr.delete(key)
-        end
-        value_arr.flatten.uniq - IcAgent::Candid::ALL_TYPES - replaced_hash.keys
+        parser = IcAgent::Ast::StatementParser.new
+        parser.parse(type_str)
+        refer_type = parser.source_tree.content[:refer_type]
+        refer_type
       end
 
       def self.recover_type(type_str, multi_types)

data/lib/ic_agent/ast/did_grammar.treetop

@@ -90,19 +90,19 @@ grammar DIDGrammar
   end
 
   rule service_item
-    space? service_method_name space? ":" space? "(" service_method_params? ")" space? "->" space? "(" service_method_return_type ")" space? method_query? ';' end_of_line? <IcAgent::Ast::Nodes::IcServiceItem>
+    space? service_method_name space? ":" space? "(" service_method_params? ")" space? "->" space? "(" service_method_return_type? ")" space? method_query? ';' end_of_line? <IcAgent::Ast::Nodes::IcServiceItem>
   end
 
   rule service_method_params
     source_coding (", " source_coding)* <IcAgent::Ast::Nodes::IcServiceMethodParams>
   end
 
-  rule source_coding
-    [a-zA-Z0-9_{}:;\n ]*
+  rule service_method_return_type
+    source_coding (", " source_coding)* <IcAgent::Ast::Nodes::IcServiceMethodReturn>
   end
 
-  rule service_method_return_type
-    [a-zA-Z0-9_{}:;\n ]* <IcAgent::Ast::Nodes::IcServiceMethodReturn>
+  rule source_coding
+    [a-zA-Z0-9_{}:;\n ]*
   end
 
   rule method_query

data/lib/ic_agent/ast/nested_type_grammar.treetop

@@ -11,8 +11,12 @@ grammar TypeGrammar
     base_type_base / base_type_vec / base_type_record / base_type_record_null / base_type_variant / base_type_opt / base_type_func / base_type_code
   end
 
-  rule statement_content
-    (ic_base_type)+ <IcAgent::Ast::Nodes::StatementContent>
+  rule record_statement_content
+    (ic_base_type_pair / ic_base_type_value)* <IcAgent::Ast::Nodes::StatementContent>
+  end
+
+  rule variant_statement_content
+    (ic_base_type_pair / ic_base_type_key)* <IcAgent::Ast::Nodes::StatementContent>
   end
 
   rule base_type
@@ -24,8 +28,16 @@ grammar TypeGrammar
     'bool' / 'text' / 'null' / 'reserved' / 'empty' / 'principal' / 'nat8' / 'nat16' / 'nat32' / 'nat64' / 'int8' / 'int16' / 'int32' / 'int64' / 'float32' / 'float64' / 'nat' / 'int' / 'blob'
   end
 
-  rule ic_base_type
-    space? base_type_key space? base_type_value? optional_semicolon <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  rule ic_base_type_pair
+    space? base_type_key space? ':' space? base_type_value ';'? <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule ic_base_type_key
+    space? base_type_key space? ';'? <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule ic_base_type_value
+    base_type_value space? ';'? <IcAgent::Ast::Nodes::IcBaseTypeChild>
   end
 
   rule base_type_base
@@ -41,7 +53,7 @@ grammar TypeGrammar
   end
 
   rule base_type_value
-    (':' space ic_all_type)* <IcAgent::Ast::Nodes::IcBaseTypeValue>
+    space? ic_all_type <IcAgent::Ast::Nodes::IcBaseTypeValue>
   end
 
   rule base_type_vec
@@ -53,7 +65,7 @@ grammar TypeGrammar
   end
 
   rule base_type_record
-    'record' space '{' space_and_line statement_content space_and_line '}' <IcAgent::Ast::Nodes::IcBaseTypeRecord>
+    'record' space '{' space_and_line? record_statement_content space_and_line? '}' <IcAgent::Ast::Nodes::IcBaseTypeRecord>
   end
 
   rule base_type_record_null
@@ -61,7 +73,7 @@ grammar TypeGrammar
   end
 
   rule base_type_variant
-    'variant' space '{' space_and_line statement_content space_and_line '}' <IcAgent::Ast::Nodes::IcBaseTypeVariant>
+    'variant' space '{' space_and_line variant_statement_content space_and_line '}' <IcAgent::Ast::Nodes::IcBaseTypeVariant>
   end
 
   rule base_type_func

data/lib/ic_agent/ast/nodes/named_nodes.rb

@@ -19,6 +19,10 @@ module IcAgent
         def elements_to_s
           elements.map(&:to_s).join("\n")
         end
+
+        def source_content
+          self.text_value.strip
+        end
       end
 
       class Instruction < NamedNode
@@ -57,11 +61,11 @@ module IcAgent
         end
 
         def type_param_name
-          elements[0].text_value
+          elements[0].source_content
         end
 
         def type_param_content
-          elements[1].text_value.gsub("\n", '').gsub(';}', '}')
+          elements[1].source_content.gsub("\n", '').gsub(';}', '}')
         end
 
         def type_root_opt_code

data/lib/ic_agent/ast/record_parser.treetop

@@ -0,0 +1,22 @@
+grammar RecordParser
+  # record { key1: text; key2: 42; value1; value2; }
+  rule record
+    'record' space '{' space? (pair / value)* space? '}' <IcAgent::Ast::Nodes::IcBaseTypeRecord>
+  end
+
+  rule pair
+    space? identifier space? ':' space? identifier ';' <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule value
+    space? identifier ';' <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule identifier
+    [a-zA-Z0-9_]*
+  end
+
+  rule space
+    [\s]+
+  end
+end

data/lib/ic_agent/ast/statement_parser.rb

@@ -29,9 +29,9 @@ module IcAgent
         tree = @parser.parse(data)
         raise Exception, "Parse error at offset: #{@parser.index} #{@parser.failure_reason}" if tree.nil?
 
-
         # this edits the tree in place
         clean_tree(tree)
+
         # generate soure tree
         gen_source_tree(tree)
         @tree = tree
@@ -64,8 +64,16 @@ module IcAgent
 
             # set refer_type
             unless Regexp.union(REFER_TYPE_KEYS) === root_node.source_content
-              param_arr = root_node.source_content.strip.split(' ').collect { |v| v.strip.gsub(';', '') }
-              param_arr = param_arr - IcAgent::Candid::ALL_TYPES
+              # func type content
+              if root_node.source_content.index('->')
+                param_arr = []
+                temp_param_arr = root_node.source_content.strip.split(' ').collect { |v| v.strip.gsub(';', '') }
+                temp_param_arr.delete_if {|v| !v.index('(') && !v.index(')') }
+                temp_param_arr.each {|v| param_arr = param_arr + v.sub('(', '').sub(')', '').split(',')}
+              else
+                param_arr = root_node.source_content.strip.split(' ').collect { |v| v.strip.gsub(';', '') }
+                param_arr = param_arr - IcAgent::Candid::ALL_TYPES
+              end
               tree_root_node.content[:refer_type] = (tree_root_node.content[:refer_type] + param_arr).uniq
             end
 

data/lib/ic_agent/ast/variant_parser.treetop

@@ -0,0 +1,21 @@
+grammar VariantParser
+  rule variant
+    'variant' space? '{' space? (pair / key)* space? '}' <IcAgent::Ast::Nodes::IcBaseTypeVariant>
+  end
+
+  rule pair
+    space? identifier space? ':' space? identifier ';' <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule key
+    space? identifier ';' <IcAgent::Ast::Nodes::IcBaseTypeChild>
+  end
+
+  rule identifier
+    [a-zA-Z0-9_]*
+  end
+
+  rule space
+    [\s]+
+  end
+end

data/lib/ic_agent/canister.rb

@@ -33,9 +33,14 @@ module IcAgent
         args_arr.each do |arg|
           args_type_arrs << get_param_to_ic_type(parser, arg)
         end
-        ret_type = get_param_to_ic_type(parser, rets)
 
-        add_caniter_method(method_name, args, args_type_arrs, ret_type, anno)
+        rets_arr = rets.nil? ? [] : rets.split(',').map(&:strip)
+        rets_type_arr = []
+        rets_arr.each do |ret|
+          rets_type_arr << get_param_to_ic_type(parser, ret)
+        end
+
+        add_caniter_method(method_name, args, args_type_arrs, rets_type_arr, anno)
       end
     end
 
@@ -183,14 +188,11 @@ module IcAgent
       refer_type.empty? ? nil : refer_type[0]
     end
 
-    def only_refer_type?(param)
-      refer_types = IcAgent::Ast::Assembler.get_params_refer_values(param)
-      param.index(' ').nil? && refer_types.size == 1
-    end
-
     def get_param_to_ic_type(parser, param)
       ic_refer_types = {}
       refer_types = IcAgent::Ast::Assembler.get_params_refer_values(param)
+      # param self is refer_values
+      refer_types << param unless param.index(' ') || IcAgent::Candid::ALL_TYPES.any?(param)
       refer_types.each do |refer_code|
         ic_refer_types[refer_code] = build_param_tree(parser, refer_code, nil, nil).content[:ic_type]
       end
@@ -235,14 +237,14 @@ module IcAgent
       new_root_text
     end
 
-    def add_caniter_method(method_name, type_args, args_types, rets_type, anno = nil)
+    def add_caniter_method(method_name, type_args, args_types, rets_types, anno = nil)
       self.class.class_eval do
         define_method(method_name) do |*args|
           init_method_name = method_name
           init_method_args = type_args.nil? ? [] : type_args.split(',').map(&:strip)
           init_method_anno = anno
           init_method_types = args_types
-          init_method_ret_type = rets_type
+          init_method_ret_type = rets_types
 
           if init_method_args.length != args.length
             raise ArgumentError, 'Arguments length not match'

data/lib/ic_agent/common/cycles_wallet.rb

@@ -228,7 +228,7 @@ module IcAgent
           wallet_balance128: () -> (record { amount: nat }) query;
           wallet_send: (record { canister: principal; amount: nat64 }) -> (WalletResult);
           wallet_send128: (record { canister: principal; amount: nat }) -> (WalletResult);
-          wallet_receive: (opt ReceiveOptions) -> ();  // Endpoint for receiving cycles.
+          wallet_receive: (opt ReceiveOptions) -> ();
           wallet_create_canister: (CreateCanisterArgs) -> (WalletResultCreate);
           wallet_create_canister128: (CreateCanisterArgs128) -> (WalletResultCreate);
           wallet_create_wallet: (CreateCanisterArgs) -> (WalletResultCreate);
@@ -248,9 +248,7 @@ module IcAgent
             args: blob;
             cycles: nat;
           }) -> (WalletResultCall);
-          add_address: (address: AddressEntry) -> ();
           list_addresses: () -> (vec AddressEntry) query;
-          remove_address: (address: principal) -> (WalletResult);
           get_events: (opt record { from: opt nat32; to: opt nat32; }) -> (vec Event) query;
           get_events128: (opt record { from: opt nat32; to: opt nat32; }) -> (vec Event128) query;
           get_chart: (opt record { count: opt nat32; precision: opt nat64; } ) -> (vec record { nat64; nat64; }) query;
@@ -258,7 +256,6 @@ module IcAgent
           get_managed_canister_events: (record { canister: principal; from: opt nat32; to: opt nat32; }) -> (opt vec ManagedCanisterEvent) query;
           get_managed_canister_events128: (record { canister: principal; from: opt nat32; to: opt nat32; }) -> (opt vec ManagedCanisterEvent128) query;
           set_short_name: (principal, opt text) -> (opt ManagedCanisterInfo);
-          http_request: (request: HttpRequest) -> (HttpResponse) query;
         }
       DIDL_DOC
 

data/lib/ic_agent/principal.rb

@@ -72,7 +72,7 @@ module IcAgent
     end
 
     def to_account_id(sub_account = 0)
-      AccountIdentifier.new(self, sub_account)
+      AccountIdentifier.generate(self, sub_account)
     end
 
     def to_s
@@ -97,11 +97,12 @@ module IcAgent
       to_str
     end
 
-    def self.new(principal, sub_account = 0)
-      sha224 = Digest::SHA224.new
+    def self.generate(principal, sub_account = 0)
+      sha224 = OpenSSL::Digest::SHA224.new
       sha224 << "\naccount-id"
       sha224 << principal.bytes
-      sub_account = [sub_account].pack('N')
+      format_sub_account = "%08d" % sub_account
+      sub_account = format_sub_account.chars.map {|c| c.to_i}.pack('N*')
       sha224 << sub_account
       hash = sha224.digest
       checksum = Zlib.crc32(hash) & 0xFFFFFFFF

data/lib/ic_agent/utils.rb

@@ -66,6 +66,10 @@ module IcAgent
       s = vec.sort.join
       Digest::SHA256.digest(s)
     end
+
+    def self.decode_blob(blob_bytes)
+      blob_bytes.pack('C*')
+    end
   end
 end
 

data/lib/ic_agent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IcAgent
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ic_agent
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Terry.Tu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -247,7 +247,9 @@ files:
 - lib/ic_agent/ast/nodes/statement_nodes.rb
 - lib/ic_agent/ast/nodes/string_literal.rb
 - lib/ic_agent/ast/parser.rb
+- lib/ic_agent/ast/record_parser.treetop
 - lib/ic_agent/ast/statement_parser.rb
+- lib/ic_agent/ast/variant_parser.treetop
 - lib/ic_agent/ast/writer.rb
 - lib/ic_agent/candid.rb
 - lib/ic_agent/canister.rb