ic_agent 0.1.1

data/lib/ic_agent/identity.rb

@@ -0,0 +1,125 @@
+require 'digest'
+require 'json'
+require 'ecdsa'
+require 'bitcoin/trezor/mnemonic'
+require 'ed25519'
+require 'rbsecp256k1'
+require 'ctf_party'
+require 'base64'
+
+module IcAgent
+  class Identity
+    attr_reader :privkey, :pubkey, :der_pubkey, :sk, :vk, :key_type
+
+    def initialize(privkey = '', type = 'ed25519', anonymous = false)
+      privkey = [privkey].pack('H*')
+      @anonymous = anonymous
+      if @anonymous
+        return
+      end
+      @key_type = type
+      if type == 'secp256k1'
+        data = privkey.length > 0 ? privkey : Random.new.bytes(32)
+        @sk = Secp256k1::PrivateKey.from_data(data)
+        @privkey = @sk.data.str2hex
+        context = Secp256k1::Context.create
+        @vk = context.key_pair_from_private_key(data)
+        @pubkey = @vk.public_key.uncompressed.str2hex
+        @der_pubkey = "#{IcAgent::IC_PUBKEY_SECP_DER_HERD}#{@pubkey}".hex2str
+      elsif type == 'ed25519'
+        @sk = privkey.length > 0 ? Ed25519::SigningKey.new(privkey) : Ed25519::SigningKey.generate
+        @privkey = @sk.keypair.unpack1('H*')[0..63]
+        @vk = @sk.verify_key
+        @pubkey = @vk.to_bytes.unpack1('H*')
+        @der_pubkey = "#{IcAgent::IC_PUBKEY_ED_DER_HEAD}#{@vk.to_bytes.unpack1('H*')}".hex2str
+      else
+        raise 'unsupported identity type'
+      end
+    end
+
+    def self.from_seed(mnemonic)
+      seed = Bitcoin::Trezor::Mnemonic.to_seed(mnemonic)
+      privkey = seed[0..63]
+      key_type = 'ed25519'
+      Identity.new(privkey = privkey, type = key_type)
+    end
+
+    def sender
+      if @anonymous
+        IcAgent::Principal.anonymous
+      else
+        IcAgent::Principal.self_authenticating(@der_pubkey)
+      end
+    end
+
+    def sign(msg)
+      if @anonymous
+        [nil, nil]
+      elsif @key_type == 'ed25519'
+        sig = @sk.sign(msg)
+        [@der_pubkey, sig]
+      elsif @key_type == 'secp256k1'
+        context = Secp256k1::Context.create
+        sig = context.sign(@sk, Digest::SHA256.digest(msg)).compact
+        [@der_pubkey, sig]
+      end
+    end
+
+    def verify(msg, sig)
+      if @anonymous
+        false
+      else
+        @vk.verify(sig, msg)
+      end
+    end
+
+    def to_pem
+      der = @key_type == 'secp256k1' ? "#{IcAgent::IC_PUBKEY_SECP_DER_HERD}#{@sk.data.unpack1('H*')}".hex2str : "#{IcAgent::IC_PUBKEY_ED_DER_HEAD}#{@sk.to_bytes.unpack1('H*')}".hex2str
+      b64 = Base64.strict_encode64(der)
+      lines = ["-----BEGIN PRIVATE KEY-----\n"]
+      lines.concat(b64.chars.each_slice(64).map(&:join).map { |line| "#{line}\n" })
+      lines << "-----END PRIVATE KEY-----\n"
+      lines.join
+    end
+
+    def to_s
+      "(#{@key_type}, #{@privkey}, #{@pubkey})"
+    end
+
+    alias inspect to_s
+  end
+
+  class DelegateIdentity
+    attr_reader :identity, :delegations, :der_pubkey
+
+    def initialize(identity, delegation)
+      @identity = identity
+      @delegations = delegation['delegations'].map { |d| d }
+      @der_pubkey = [delegation['publicKey']].pack('H*')
+    end
+
+    def sign(msg)
+      @identity.sign(msg)
+    end
+
+    def sender
+      Principal.self_authenticating(@der_pubkey)
+    end
+
+    def self.from_json(ic_identity, ic_delegation)
+      parsed_ic_identity = JSON.parse(ic_identity)
+      parsed_ic_delegation = JSON.parse(ic_delegation)
+
+      DelegateIdentity.new(
+        Identity.new(parsed_ic_identity[1][0...64]),
+        parsed_ic_delegation
+      )
+    end
+
+    def to_s
+      "(#{@identity.to_s},\n#{@delegations.to_s})"
+    end
+
+    alias inspect to_s
+  end
+end

data/lib/ic_agent/principal.rb

@@ -0,0 +1,112 @@
+require 'zlib'
+require 'base32'
+
+module IcAgent
+  CRC_LENGTH_IN_BYTES = 4
+  HASH_LENGTH_IN_BYTES = 28
+  MAX_LENGTH_IN_BYTES = 29
+
+  class PrincipalSort
+    OpaqueId = 1
+    SelfAuthenticating = 2
+    DerivedId = 3
+    Anonymous = 4
+    # Unassigned
+  end
+
+  class Principal
+    attr_reader :len, :bytes, :is_principal, :hex
+
+    def initialize(bytes: ''.b)
+      @len = bytes.length
+      @bytes = bytes
+      @hex = @bytes.unpack1('H*').upcase
+      @is_principal = true
+    end
+
+    def self.management_canister
+      Principal.new
+    end
+
+    def self.self_authenticating(pubkey)
+      # check pubkey.size for is ed25519 or secp256k1
+      pubkey = [pubkey].pack('H*') if pubkey.size != 44 && pubkey.size != 88
+
+      hash_ = OpenSSL::Digest::SHA224.digest(pubkey)
+      hash_ += [PrincipalSort::SelfAuthenticating].pack('C')
+      Principal.new(bytes: hash_)
+    end
+
+    def self.anonymous
+      Principal.new(bytes: "\x04".b)
+    end
+
+    def self.from_str(s)
+      s1 = s.delete('-')
+      pad_len = ((s1.length / 8.0).ceil * 8) - s1.length
+      b = Base32.decode(s1.upcase + ('=' * pad_len))
+      raise 'principal length error' if b.length < CRC_LENGTH_IN_BYTES
+
+      p = Principal.new(bytes: b[CRC_LENGTH_IN_BYTES..-1])
+      raise 'principal format error' unless p.to_str == s
+
+      p
+    end
+
+    def self.from_hex(s)
+      Principal.new(bytes: [s].pack('H*'))
+    end
+
+    def to_str
+      checksum = Zlib.crc32(@bytes) & 0xFFFFFFFF
+      b = ''
+      b += [checksum].pack('N')
+      b += @bytes
+      s = Base32.encode(b).downcase.delete('=')
+      ret = ''
+      while s.length > 5
+        ret += s[0..4] + '-'
+        s = s[5..-1]
+      end
+      ret + s
+    end
+
+    def to_account_id(sub_account = 0)
+      AccountIdentifier.new(self, sub_account)
+    end
+
+    def to_s
+      to_str
+    end
+  end
+
+  class AccountIdentifier
+    attr_reader :bytes
+
+    def initialize(hash)
+      raise 'Invalid hash length' unless hash.length == 32
+
+      @bytes = hash
+    end
+
+    def to_str
+      '0x' + @bytes.unpack1('H*')
+    end
+
+    def to_s
+      to_str
+    end
+
+    def self.new(principal, sub_account = 0)
+      sha224 = Digest::SHA224.new
+      sha224 << "\naccount-id"
+      sha224 << principal.bytes
+      sub_account = [sub_account].pack('N')
+      sha224 << sub_account
+      hash = sha224.digest
+      checksum = Zlib.crc32(hash) & 0xFFFFFFFF
+      account = [checksum].pack('N') + hash
+      AccountIdentifier.new(account)
+    end
+  end
+end

data/lib/ic_agent/system_state.rb

@@ -0,0 +1,43 @@
+require_relative 'principal'
+require_relative 'certificate'
+require 'leb128'
+require 'cbor'
+
+module IcAgent
+  class SyetemState
+    def self.time(agent, canister_id)
+      cert = agent.read_state_raw(canister_id, [['time']])
+      timestamp = Certificate.lookup(['time'], cert)
+      str_io = StringIO.new(timestamp)
+      LEB128.decode_signed(str_io)
+    end
+
+    def self.subnet_public_key(agent, canister_id, subnet_id)
+      path = ['subnet', Principal.from_str(subnet_id).bytes, 'public_key']
+      cert = agent.read_state_raw(canister_id, [path])
+      pubkey = Certificate.lookup(path, cert)
+      pubkey.str2hex
+    end
+
+    def self.subnet_canister_ranges(agent, canister_id, subnet_id)
+      path = ['subnet', Principal.from_str(subnet_id).bytes, 'canister_ranges']
+      cert = agent.read_state_raw(canister_id, [path])
+      ranges = Certificate.lookup(path, cert)
+      CBOR.decode(ranges).value.map { |range| range.map { |item| Principal.new(bytes: item) } }
+    end
+
+    def self.canister_module_hash(agent, canister_id)
+      path = ['canister', Principal.from_str(canister_id).bytes, 'module_hash']
+      cert = agent.read_state_raw(canister_id, [path])
+      module_hash = Certificate.lookup(path, cert)
+      module_hash.str2hex
+    end
+
+    def self.canister_controllers(agent, canister_id)
+      path = ['canister', Principal.from_str(canister_id).bytes, 'controllers']
+      cert = agent.read_state_raw(canister_id, [path])
+      controllers = Certificate.lookup(path, cert)
+      CBOR.decode(controllers).value.map { |item| Principal.new(bytes: item) }
+    end
+  end
+end

data/lib/ic_agent/utils.rb

@@ -0,0 +1,71 @@
+require 'digest/sha2'
+require 'leb128'
+
+module IcAgent
+  module Utils
+    def self.encode_list(l)
+      ret = ''
+      l.each do |item|
+        v = item
+        if item.is_a?(Array)
+          v = encode_list(item)
+        end
+        if item.is_a?(Integer)
+          v = LEB128.encode_signed(v)
+        end
+        if item.is_a?(String)
+          v = item
+        end
+        ret += Digest::SHA256.digest(v)
+      end
+      ret
+    end
+
+    # used for sort record by key
+    def self.label_hash(s)
+      if s =~ /(^_\d+_$)|(^_0x[0-9a-fA-F]+_$)/
+        num = s[1..-2]
+        begin
+          if num.start_with?("0x")
+            num = num.to_i(16)
+          else
+            num = num.to_i
+          end
+        rescue
+          # fallback
+        end
+        if num.is_a?(Integer) && num >= 0 && num < 2**32
+          return num
+        end
+      end
+      idl_hash(s)
+    end
+
+    def self.idl_hash(s)
+      h = 0
+      s.bytes.each do |c|
+        h = (h * 223 + c) % 2**32
+      end
+      h
+    end
+
+    def self.to_request_id(d)
+      return nil unless d.is_a?(Hash)
+
+      vec = []
+
+      d.each do |k, v|
+        v = encode_list(v) if v.is_a?(Array)
+        v = LEB128.encode_signed(v).string if v.is_a?(Integer)
+        k = k.hex unless k.is_a?(String)
+        v = v.str2hex unless v.is_a?(String)
+        h_k = Digest::SHA256.digest(k)
+        h_v = Digest::SHA256.digest(v)
+        vec << h_k + h_v
+      end
+      s = vec.sort.join
+      Digest::SHA256.digest(s)
+    end
+  end
+end
+

data/lib/ic_agent/version.rb

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

data/lib/ic_agent.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'treetop'
+
+require_relative 'ic_agent/version'
+require_relative 'ic_agent/principal'
+require_relative 'ic_agent/identity'
+require_relative 'ic_agent/client'
+require_relative 'ic_agent/utils'
+require_relative 'ic_agent/candid'
+require_relative 'ic_agent/agent'
+require_relative 'ic_agent/certificate'
+require_relative 'ic_agent/system_state'
+require_relative 'ic_agent/canister'
+
+require_relative 'ic_agent/ast/nodes/named_nodes'
+require_relative 'ic_agent/ast/nodes/string_literal'
+require_relative 'ic_agent/ast/parser'
+require_relative 'ic_agent/ast/writer'
+require_relative 'ic_agent/ast/assembler'
+
+require_relative 'ic_agent/common/ledger'
+require_relative 'ic_agent/common/cycles_wallet'
+require_relative 'ic_agent/common/governance'
+require_relative 'ic_agent/common/management'
+
+module IcAgent
+  class Error < StandardError; end
+  class ValueError < StandardError; end
+  class TypeError < StandardError; end
+
+  IC_REQUEST_DOMAIN_SEPARATOR = "\x0Aic-request".freeze
+  IC_ROOT_KEY = "\x4E\x9A\xF9\x9F\x06\x13\x26\x81\xE7\xD2\x55\x2A\x26\x17\x98\x51\xE9\xC3\x79\xB3\xC7\xBE\x88\x27\xB8\x35\x17\xFC\x84\x4E\x4C\x4F".freeze
+  IC_PUBKEY_ED_DER_HEAD = '302a300506032b6570032100'
+  IC_PUBKEY_SECP_DER_HERD = '3056301006072a8648ce3d020106052b8104000a034200'
+  DEFAULT_POLL_TIMEOUT_SECS = 60
+end

data/sig/ic_agent.rbs

@@ -0,0 +1,4 @@
+module IcAgent
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,288 @@
+--- !ruby/object:Gem::Specification
+name: ic_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Terry.Tu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: bitcoin-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.20
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+- !ruby/object:Gem::Dependency
+  name: ctf-party
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: ecdsa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: leb128
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rbsecp256k1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ICP Agent.
+email:
+- tuminfei1981@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ic_agent.gemspec
+- lib/ic_agent.rb
+- lib/ic_agent/agent.rb
+- lib/ic_agent/ast/assembler.rb
+- lib/ic_agent/ast/did_grammar.treetop
+- lib/ic_agent/ast/did_grammar_v1.treetop
+- lib/ic_agent/ast/nodes/named_nodes.rb
+- lib/ic_agent/ast/nodes/string_literal.rb
+- lib/ic_agent/ast/parser.rb
+- lib/ic_agent/ast/writer.rb
+- lib/ic_agent/candid.rb
+- lib/ic_agent/canister.rb
+- lib/ic_agent/certificate.rb
+- lib/ic_agent/client.rb
+- lib/ic_agent/common/cycles_wallet.rb
+- lib/ic_agent/common/governance.rb
+- lib/ic_agent/common/ledger.rb
+- lib/ic_agent/common/management.rb
+- lib/ic_agent/identity.rb
+- lib/ic_agent/principal.rb
+- lib/ic_agent/system_state.rb
+- lib/ic_agent/utils.rb
+- lib/ic_agent/version.rb
+- sig/ic_agent.rbs
+homepage: https://github.com/tuminfei/ic_agent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tuminfei/ic_agent
+  source_code_uri: https://github.com/tuminfei/ic_agent
+  changelog_uri: https://github.com/tuminfei/ic_agent
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: ICP Agent
+test_files: []