casper_network 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1844fc3cd9eedecd9935d31d099666dae34d6e863e797dca8bc40b18c9d8f37
-  data.tar.gz: 52ae933784296f3a4a488bb8068200b4018ecf3530cc69eaa7b3046b26987129
+  metadata.gz: f511c7cefe099bfc5f6a67280f7826c179e9127f4dd8facf554351cdc132ab19
+  data.tar.gz: '08057f40c2f037da844a3a4f816ca538eb7985e71a41ae0d02303fc65f9527f1'
 SHA512:
-  metadata.gz: 6b93a15e23d06b420edba0ee9dddcc18945d48ddde62ef1415358f4a593bbf90e94107a68ece219523ea84460c50e57f30c0ebf4caa1230670000455af6cb6d5
-  data.tar.gz: 45c008a7a384a30808c8cd5d01dbc73fdcd917c04d4d2c9e746c664bf58eb356f0e4a0b0997ca4a728b2b5470583b1b59d4913181e19fedfe716dd03ae1911f0
+  metadata.gz: 61ca00e871d1fba6c79bf31b60dec38c5285d95675c457823843c7cb99956baadd96bf15c1953d0adbdf01caa5b31179a46ad528e9f3c48c5a203dc194194977
+  data.tar.gz: e9eb9a792d46f97a9316914c7d0cb885a48568b2f162feb97225cb64ff2a428d47b5a8b448c9aa941fc19275ad4da6dc8751694c6a95df97fd904948079d03a7

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing to Casper Ruby SDK

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,154 @@
+# Casper Ruby SDK
+The Ruby SDK enables developers to interact with the Casper Network.
+
+## Requirements
+Click [rbenv](https://github.com/rbenv/rbenv) or [here (Steps: 1, 2, 3)](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04) to install dependencies.
+```bash
+ruby -v
+# ruby 3.0.2
+```
+```bash
+# Install bundler
+gem install bundler
+```
+## How to install
+
+```bash
+# There are two options to install casper_network
+
+# Option 1:
+# Install casper_network that is available in the https://guides.rubygems.org/
+gem install casper_network
+
+# Option 2:
+git clone git@github.com:saitgulmez/casper-ruby-sdk.git
+cd casper-ruby-sdk
+# It automatically installs all the required gems located in the Gemfile
+bundle install
+# Install casper_network gem from repository
+# casper_network-X.Y.Z.gem will be generated after running below command
+gem build casper_network.gemspec
+# (X, Y, Z depends on s.version described in the casper_network.gemspec)
+gem install casper_network-X.Y.Z.gem
+```
+
+## How to build
+```bash
+gem build casper_network.gemspec
+```
+
+## How to run tests
+```bash
+# Install RSpec
+gem install rspec
+# Run the test
+rspec spec/testnet_spec.rb
+rspec spec/mainnet_spec.rb
+```
+
+## Testnet Tests
+```bash
+git checkout main
+# Run the test
+rspec spec/testnet_spec.rb
+# To see the test results in detail
+rspec -fd spec/testnet_spec.rb
+```
+
+## Mainnet Tests
+```bash
+# Run the test
+rspec spec/mainnet_spec.rb
+# To see the test results in detail
+rspec -fd spec/mainnet_spec.rb
+```
+
+## How to generate docs
+```bash
+gem install yard
+# Generate documentation from source code
+yardoc lib/**/*.rb lib/*.rb - README.md LICENSE CONTRIBUTING.md SECURITY.md
+# To see the options
+yardoc --help 
+```
+
+## Usage examples
+### Get 5 peer IP addresses randomly
+```ruby
+require 'casper_network'
+
+# In order to interact with casper network we should give a valid ip address to the constructor
+
+# if it does not work, please choose another node ip address from the link1
+# IP is taken from "Testnet"
+node_ip_address = "85.114.132.129" 
+# block_Hash taken from Testnet
+block_hash = "71e19e2e9629c716dc9578066cfeceace559d32fe51b08245ddd4d218f8c18da"
+# deploy_Hash taken from Testnet
+deploy_hash = "d3e0a1bd85ee74916e096cf4b18df391ada414d0915aeb865eff0ba75f04c3d8"
+state_root_hash = "2a62440a1e1e57bff71344aac8a7de169f6dd08d29cffe83b2fb5d6648971855"
+item_key = "f870e3cadfde21d7d7686fdf3d1a8413838274d363ca7b27ae71fc9125eb6743"
+uref = "uref-9199d08ff4ca4d52cd7a05ba0d2694204b7ebff963fec1c216f81bf654e0e59f-007"
+switch_block_hash = "9e30104581a492f5c6faad4cdfb098311e3bf0e93897ebbfb47c3df62f5e6375"
+
+
+# Uncomment following lines to test on Mainnet 
+# if it does not work, please choose another node ip address from the link2
+# IP is taken from "Mainnet"
+# node_ip_address = "65.108.78.12" 
+# block_Hash taken from MainNet
+# block_hash = "5fdbdf3fa70d37821aa2d1752743e9653befc15e65e40c2655e1ce93a807260f"
+# # deploy_Hash taken from MainNet
+# deploy_hash = "52a40996a88523c475c12e5370ff90b0ae4ec051cfaa57cd048c136b1a83319d"
+# state_root_hash = "7b605ad991c949832fd966495afc3f97a2b8122a1a6afc2610b545a8c07e3456"
+# item_key = "f870e3cadfde21d7d7686fdf3d1a8413838274d363ca7b27ae71fc9125eb6743"
+# uref = "uref-0d689e987db7ee5be246282c3a7badf0411e34baeeab8e9d73c1223ae4ad02e5-007"
+# switch_block_hash = "4696285db1ca6572f425cada612257f85a58a6a4034c09846afe360ba40e5df0"
+
+if (IPAddress.valid? node_ip_address)
+  client = Casper::CasperClient.new(node_ip_address)
+  peers = client.info_get_peers.sample(5)
+  puts "node_id and address of five randomly selected 5 peers:"
+  puts peers
+
+  # Store ip addresses of these peers into an array
+  ips = []
+  peers.select do |item|
+    ip = item["address"]
+    ips << ip[0, ip.index(':')]
+  end
+
+  clients = []
+  puts "Randomly selected 5 peers ip addresses:"
+  ips.each do |ip_address|
+    # Create a client object for each iteration
+    puts ip_address
+    client = CasperClient.new(ip_address)
+    clients.push(client)
+  end
+
+
+  clients.each do |client|
+    puts client.info_get_peers
+    puts client.chain_get_StateRootHash(block_hash)
+    puts client.chain_get_StateRootHash
+    puts client.info_get_deploy(deploy_hash)
+    puts client.info_get_status
+    puts client.chain_get_block_transfers(block_hash)
+    puts client.chain_get_block_transfers
+    puts client.chain_get_block(block_hash)
+    puts client.chain_get_eraInfo_by_SwitchBlock(switch_block_hash)
+    puts client.state_get_item("647C28545316E913969B032Cf506d5D242e0F857061E70Fb3DF55980611ace86", "bid-24b6D5Aabb8F0AC17D272763A405E9CECa9166B75B745Cf200695E172857c2dD", [])
+    puts client.state_get_dictionary_item(state_root_hash, item_key, uref)
+    state_root_hash = "610e932aef10d3e1fa04940c79a4a2789ee79c17046f1a9b45a2919f3600f3d5"
+    uref = "uref-7de5e973b7d70bc2b328814411f2009aafd8dba901cfc2c588ba65088dcd22bb-007"
+    puts client.state_get_balance(state_root_hash, uref)
+    puts client.state_get_AuctionInfo
+
+  end
+else
+  puts "Invalid IP address"
+end
+```
+- [link1](https://testnet.cspr.live/tools/peers),  [link2](https://cspr.live/tools/peers)
+- [doc](https://htmlpreview.github.io/?https://raw.githubusercontent.com/saitgulmez/casper-ruby-sdk/main/doc/index.html)

data/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.2.0   | :white_check_mark: |
+
+
+## Reporting a Vulnerability
+
+If you find a security vulnerability in Casper Ruby SDK, please send an email to cenggulmez.65@gmail.com.