ic_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f7c8e2c2b92f692a20ba38898f78dd76a854367369a905e8553c162c3a0238c
+  data.tar.gz: 51885b2b8966bae6a23b4dc5e775c7fd3ee864b4452cafa2213e54aa1fdddeae
+SHA512:
+  metadata.gz: 3369b673094b4b7416f1a5125f440d5b5ad4fd9b8878d58564165b50bbd33b503e0653220fb92ac617fdc25890cb20efe2429c3f7f64340f8305134162f58a95
+  data.tar.gz: 0e8e47383437dfd4a1de1d05ac8975faed0fb1cff4e56ea9c2006450fd7036dbff578cb4bbbbea2f635e4a41dbf05e0f25ce178a8978e5f6bdd2e79a7d644d22

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tuminfei1981@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:2.7.8-alpine3.16
+
+ENV BUILD_PACKAGES curl-dev build-base automake autoconf libtool libffi-dev python3-dev
+
+RUN apk update && \
+    apk upgrade && \
+    apk add git curl $BUILD_PACKAGES
+
+WORKDIR /usr/src/app
+
+COPY . .
+
+RUN gem install bundler:2.2.13 && \
+    bundle install && \
+    rake install:local
+
+CMD ["sh"]

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ic_agent.gemspec
+gemspec
+
+gem 'base32', '~> 0.3.4'
+gem 'bitcoin-ruby', '~> 0.0.20'
+gem 'byebug', '~> 11.1', '>= 11.1.3'
+gem 'cbor', '~> 0.5.9.6'
+gem 'ctf-party', '~> 2.3'
+gem 'ecdsa', '~> 1.2'
+gem 'ed25519', '~> 1.3'
+gem 'faraday', '~> 2.7', '>= 2.7.4'
+gem 'leb128', '~> 1.0'
+gem 'pry'
+gem 'rake', '~> 13.0'
+gem 'rbsecp256k1', '~> 6.0'
+gem 'ruby-enum', '~> 0.9.0'
+gem 'rubytree', '~> 2.0'
+gem 'treetop', '~> 1.6', '>= 1.6.12'
+

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    ic_agent (0.1.1)
+      base32 (~> 0.3.4)
+      bitcoin-ruby (~> 0.0.20)
+      cbor (~> 0.5.9.6)
+      ctf-party (~> 2.3)
+      ecdsa (~> 1.2)
+      ed25519 (~> 1.3)
+      faraday (~> 2.7)
+      leb128 (~> 1.0)
+      rbsecp256k1 (~> 6.0)
+      ruby-enum (~> 0.9.0)
+      rubytree (~> 2.0)
+      treetop (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base32 (0.3.4)
+    bitcoin-ruby (0.0.20)
+      eventmachine
+      ffi
+      scrypt
+    byebug (11.1.3)
+    cbor (0.5.9.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    ctf-party (2.3.0)
+      docopt (~> 0.6)
+    diff-lcs (1.5.0)
+    docopt (0.6.1)
+    ecdsa (1.2.0)
+    ed25519 (1.3.0)
+    eventmachine (1.2.7)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    leb128 (1.0.0)
+    method_source (1.0.0)
+    mini_portile2 (2.8.2)
+    pkg-config (1.5.1)
+    polyglot (0.3.5)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rbsecp256k1 (6.0.0)
+      mini_portile2 (~> 2.8)
+      pkg-config (~> 1.5)
+      rubyzip (~> 2.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby-enum (0.9.0)
+      i18n
+    ruby2_keywords (0.0.5)
+    rubytree (2.0.0)
+      json (~> 2.0, > 2.3.1)
+    rubyzip (2.3.2)
+    scrypt (3.0.7)
+      ffi-compiler (>= 1.0, < 2.0)
+    treetop (1.6.12)
+      polyglot (~> 0.3)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  base32 (~> 0.3.4)
+  bitcoin-ruby (~> 0.0.20)
+  byebug (~> 11.1, >= 11.1.3)
+  cbor (~> 0.5.9.6)
+  ctf-party (~> 2.3)
+  ecdsa (~> 1.2)
+  ed25519 (~> 1.3)
+  faraday (~> 2.7, >= 2.7.4)
+  ic_agent!
+  leb128 (~> 1.0)
+  pry
+  rake (~> 13.0)
+  rbsecp256k1 (~> 6.0)
+  rspec (~> 3.2)
+  ruby-enum (~> 0.9.0)
+  rubytree (~> 2.0)
+  treetop (~> 1.6, >= 1.6.12)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Terry.Tu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,217 @@
+# IcAgent
+
+## Ruby Agent Library for the Internet Computer
+
+`ic_agent` provides basic modules to interact with canisters on the DFINITY Internet Computer.
+
+
+## Installation
+
+```
+gem install ic_agent
+```
+
+### Features
+
+1. candid types encode & decode
+2. support secp256k1 & ed25519 identity
+3. canister DID file parsing
+4. canister class, initialized with canister id and DID file
+5. common canister interfaces: ledger, management, nns, cycles wallet
+6. BLS Verify
+
+### Modules & Usage
+
+#### 1. Principal
+
+Create an instance:
+
+```ruby
+require "lib/ic_agent/principal"
+p = IcAgent::Principal.new # default is management canister id `aaaaa-aa`
+p1 = IcAgent::Principal.new(bytes: '') # create an instance from bytes
+p2 = IcAgent::Principal.anonymous() # create anonymous principal
+p3 = IcAgent::Principal.self_authenticating(pubkey) # create a principal from public key
+p4 = IcAgent::Principal.from_str('aaaaa-aa') # create an instance from string
+p5 = IcAgent::Principal.from_hex('xxx') # create an instance from hex
+```
+
+Class methods:
+
+```ruby
+p.bytes # principal bytes
+p.len # byte array length
+p.to_str() # convert to string
+```
+
+#### 2. Identity
+
+Create an instance:
+
+```ruby
+require "lib/ic_agent/identity"
+i = IcAgent::Identity.new # create an identity instance, key is randomly generated
+i1 = IcAgent::Identity.new(privkey = '833fe62409237b9d62ec77587520911e9a759cec1d19755b7da901b96dca3d42') # create an instance from private key
+i2 = IcAgent::Identity.new(privkey = '833fe62409237b9d62ec77587520911e9a759cec1d19755b7da901b96dca3d42', type = 'secp256k1')
+```
+
+Sign a message and Verify:
+
+```ruby
+msg = "ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f"
+sig = i.sign(msg) # sig = (der_encoded_pubkey, signature)
+ver = i.verify(msg, sig[1])
+```
+
+#### 3. Client
+
+Create an instance:
+
+```ruby
+client = IcAgent::Client.new(url = "https://ic0.app")
+client.status
+```
+
+#### 4. Candid
+
+Encode parameters:
+
+```ruby
+# params is an array, return value is encoded bytes
+params = [{'type': IcAgent::Candid::BaseTypes.nat, 'value': 10}]
+data = IcAgent::Candid.encode(params)
+
+params = [{'type': IcAgent::Candid::BaseTypes.null, 'value': nil}]
+data = IcAgent::Candid.encode(params)
+```
+
+Decode parameters:
+
+```ruby
+# data is bytes, return value is an parameter array
+params =  IcAgent::Candid.decode(data)
+```
+
+#### 5. Agent
+
+Create an instance:
+
+```ruby
+# Identity and Client are dependencies of Agent
+iden = IcAgent::Identity.new
+client = IcAgent::Client.new
+agent = IcAgent::Agent.new(iden, client)
+```
+
+Query call:
+
+```ruby
+# query the name of token canister `gvbup-jyaaa-aaaah-qcdwa-cai`
+name = agent.query_raw("gvbup-jyaaa-aaaah-qcdwa-cai", "name", IcAgent::Candid.encode([]))
+```
+
+Update call:
+
+```ruby
+# transfer 100 token to blackhole address `aaaaa-aa`
+params = [
+  { 'type': IcAgent::Candid::BaseTypes.principal, 'value': 'aaaaa-aa' },
+  { 'type': IcAgent::Candid::BaseTypes.nat, 'value': 10000000000 }
+]
+result = agent.update_raw("gvbup-jyaaa-aaaah-qcdwa-cai", "transfer", IcAgent::Candid.encode(params))
+```
+
+#### 6. Read System State
+
+Create an instance:
+
+```ruby
+# Identity and Client are dependencies of Agent
+iden = IcAgent::Identity.new
+client = IcAgent::Client.new
+agent = IcAgent::Agent.new(iden, client)
+
+time = IcAgent::SyetemState.time(agent, "gvbup-jyaaa-aaaah-qcdwa-cai")
+
+subnet_public_key = IcAgent::SyetemState.subnet_public_key(agent, "gvbup-jyaaa-aaaah-qcdwa-cai", "pjljw-kztyl-46ud4-ofrj6-nzkhm-3n4nt-wi3jt-ypmav-ijqkt-gjf66-uae")
+```
+
+#### 7. Canister
+
+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)
+res = gov_canister.get_neuron_ids()
+```
+
+#### 8. canister: ledger, management, cycles wallet ..
+
+canister common tools:
+
+```ruby
+ledger = IcAgent::Common::Ledger.new
+ledger.canister.name()
+```
+
+## UNIT TEST
+
+```
+bundle exec rspec  
+```
+
+## Docker
+
+1. update to latest image
+
+`docker pull tuminfei1981/ruby_ic_agent:latest`
+
+2. Run image:
+
+`docker run -it tuminfei1981/ruby_ic_agent:latest`
+
+This  will enter the container with a linux shell opened.
+
+```shell
+/usr/src/app # 
+```
+
+3. Type `rspec` to run all tests
+
+```shell
+/usr/src/app # bundle exec rspec
+.............................
+
+Finished in 5.56 seconds (files took 0.12067 seconds to load)
+29 examples, 0 failures
+
+```
+
+4. Or, type `./bin/console` to enter the ruby interactive environment and run any ic_agent code
+
+```shell
+/usr/src/app # ./bin/console
+[1] pry(main)> p = IcAgent::Principal.new
+=> #<IcAgent::Principal:0x000000013a54a548 @bytes="", @hex="", @is_principal=true, @len=0>
+[2] pry(main)> p.to_s
+=> "aaaaa-aa"
+[3] pry(main)>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tuminfei/ic_agent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tuminfei/ic_agent/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IcAgent project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tuminfei/ic_agent/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/ic_agent.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ic_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ic_agent'
+  spec.version = IcAgent::VERSION
+  spec.authors = ['Terry.Tu']
+  spec.email = ['tuminfei1981@gmail.com']
+
+  spec.summary = 'ICP Agent'
+  spec.description = 'ICP Agent.'
+  spec.homepage = 'https://github.com/tuminfei/ic_agent'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'base32', '~> 0.3.4'
+  spec.add_dependency 'bitcoin-ruby', '~> 0.0.20'
+  spec.add_dependency 'cbor', '~> 0.5.9.6'
+  spec.add_dependency 'ctf-party', '~> 2.3'
+  spec.add_dependency 'ecdsa', '~> 1.2'
+  spec.add_dependency 'ed25519', '~> 1.3'
+  spec.add_dependency 'faraday', '~> 2.7'
+  spec.add_dependency 'leb128', '~> 1.0'
+  spec.add_dependency 'rbsecp256k1', '~> 6.0'
+  spec.add_dependency 'ruby-enum', '~> 0.9.0'
+  spec.add_dependency 'rubytree', '~> 2.0'
+  spec.add_dependency 'treetop', '~> 1.6'
+
+  spec.add_development_dependency 'byebug', '~> 11.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end