cardano_wallet 0.3.26 → 0.3.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b939ecfaab3cb3b39b87072b84ada64881ca169a40a21537e046a407c7c940b7
-  data.tar.gz: 8e208b0afe7adcf2d853955da46a0acb786aae86ce20a5e0eeb31bb8a5d552f7
+  metadata.gz: '083f459db029fab491c2d7fddad1f0a6bfff596e08344af6e31ea75dfb9e2a21'
+  data.tar.gz: eb50ebc2b10e841c941fc36250bc0d035d52b785fc2920961b9c563b0410c9ae
 SHA512:
-  metadata.gz: 8420ef9068779be1a4b7ea1c23c8f8ad6995781a5b31508830150cea83bb44370d35be2a03f5045a60d7f3dee6e035669ffaeea8b5007f8663f3acf7c520f020
-  data.tar.gz: cd653f1463d490e7590dcf99ecd2b19902bee68c02019116363db659238d51c1bfac2ce280a63c29dbcdef6ac0bc2f85595611aa9512f9149907bf18195ac049
+  metadata.gz: 14ca8505a76dc7d21474b92a7e444d76b4b436e8f33ec7553b3a0a49eb1bb83e415eedc0ade4d6fb50353981eb20f56c129f786576ad1c0ed5c1ac216eeb6205
+  data.tar.gz: 94ae2907f02096c838b97c9097ee71668ddbbdb293ec2b1786d3ecd505ecfc2c6344c45d9f82016846d5031f22bac7b55ef137621d0bd994290ee03c28558c16

data/README.md

@@ -13,11 +13,9 @@
 
 # cardano-wallet-rb
 
-Ruby wrapper over [cardano-wallet's](https://github.com/input-output-hk/cardano-wallet) REST [API](https://input-output-hk.github.io/cardano-wallet/api/edge/).
+Ruby wrapper over [cardano-wallet's](https://github.com/input-output-hk/cardano-wallet) REST [API](https://input-output-hk.github.io/cardano-wallet/api/edge/). Requires running `cardano-wallet`.
 
-## E2E tests
-
-Cardano-wallet-rb is used for e2e testing of [cardano-wallet](https://github.com/input-output-hk/cardano-wallet/test/e2e) against public testnet.
+Cardano-wallet-rb is used for e2e testing of [cardano-wallet](https://github.com/input-output-hk/cardano-wallet/test/e2e) and also as a backend of [Ikar](https://github.com/piotr-iohk/ikar).
 
 
 ## Installation
@@ -38,7 +36,7 @@ For ruby doc see: https://rubydoc.info/gems/cardano_wallet.
 
 For `cardano-wallet` REST Api see: https://input-output-hk.github.io/cardano-wallet/api/edge/.
 
-## Usage
+## Examples
 
 ```ruby
 CW = CardanoWallet.new
@@ -48,16 +46,48 @@ SHELLEY = CW.shelley
 MISC = CW.misc
 
 #Byron
+BYRON.wallets.create({name: "Byron",
+                       style: "random",
+                       mnemonic_sentence: CW.utils.mnemonic_sentence,
+                       passphrase: "Secure Passphrase"})
+
 BYRON.wallets.list.each_with_index do |wal, i|
   BYRON.wallets.update_metadata(wal['id'], {name: "Wallet number #{i}"})
 end
 
+BYRON.wallets.list.each do |wal|
+  puts wal['name']
+end
+
 #Shelley
-w = SHELLEY.wallets.create{name: "Wallet1",
-                       mnemonic_sentence: %w[vintage poem topic machine hazard cement dune glimpse fix brief account badge mass silly business],
-                       passphrase: "Secure Passphrase"}
+w = SHELLEY.wallets.create({name: "Shelley",
+                       mnemonic_sentence: CW.utils.mnemonic_sentence,
+                       passphrase: "Secure Passphrase"})
 
 SHELLEY.wallets.get(w['id'])
+SHELLEY.wallets.delete(w['id'])
+
+# Transaction
+wid = '1f82e...ccd95'
+metadata = { "1" => "test"}
+tx_c = SHELLEY.transactions.construct(wid, payments = nil, withdrawal = nil, metadata)
+tx_s = SHELLEY.transactions.sign(wid, 'Secure Passphrase', tx_c['transaction'])
+tx_sub = SHELLEY.transactions.submit(wid, tx_s['transaction'])
+puts SHELLEY.transactions.get(wid, tx_sub['id'])
+
+# Delegation
+wid = '1f82e...ccd95'
+random_stake_pool_id = SHELLEY.stake_pools.list({stake: 10000}).sample['id']
+delegation = [{
+                "join" => {
+                            "pool" => random_stake_pool_id,
+                            "stake_key_index" => "0H"
+                          }
+              }]
+tx_c = SHELLEY.transactions.construct(wid, payments = nil, withdrawal = nil, metadata = nil, delegation)
+tx_s = SHELLEY.transactions.sign(wid, 'Secure Passphrase', tx_c['transaction'])
+tx_sub = SHELLEY.transactions.submit(wid, tx_s['transaction'])
+puts SHELLEY.transactions.get(wid, tx_sub['id'])
 
 #Misc
 MISC.network.information
@@ -68,25 +98,6 @@ MISC.utils.addresses("addr_test1vqrlltfahghjxl5sy5h5mvfrrlt6me5fqphhwjqvj5jd88cc
 
 Refer to [documentation](https://rubydoc.info/gems/cardano_wallet) for more details.
 
-## Development
-
-In order to spin up environment for development and testing `docker-compose` can be used. For instance:
-
-    # Byron testnet
-    $ NETWORK=testnet WALLET=dev-master-byron NODE=latest docker-compose up --detach
-
-or
-
-    # Shelley testnet
-    $ NODE=1.13.0 WALLET=dev-master-shelley NODE_CONFIG_PATH=`pwd`/spec/shelley-testnet/ docker-compose -f docker-compose-shelley.yml up
-
-Run tests on top of that:
-
-    $ rake
-
-Clean up docker stuff after, e.g.:
-
-    $ NETWORK=... docker-compose down --rmi all --remove-orphans
 
 ## Contributing
 

data/cardano_wallet.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'bip_mnemonic', '~> 0.0.4'
   spec.add_runtime_dependency 'httparty', '~> 0.18.0'
 
-  spec.add_development_dependency 'bip_mnemonic', '~> 0.0.4'
   spec.add_development_dependency 'codecov', '0.2.8'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'

data/lib/cardano_wallet/base.rb

@@ -50,9 +50,9 @@ module CardanoWallet
       Misc.new @opt
     end
 
-    # Init API for Proxy
-    def proxy
-      Proxy.new @opt
+    # Init API for Utils
+    def utils
+      Utils.new @opt
     end
   end
 end

data/lib/cardano_wallet/utils.rb

@@ -4,6 +4,51 @@ module CardanoWallet
   ##
   # General Utils not connected to API
   module Utils
+    def self.new(opt)
+      Init.new opt
+    end
+
+    # Init
+    class Init < Base
+      # Generate mnemonic sentence
+      #
+      # @example Default 24-word English mnemonic sentence
+      # CardanoWallet.new.utils.mnemonic_sentence
+      # ["kiwi", "rent", "denial",...]
+      #
+      # @example 15-word French mnemonic sentence
+      # CardanoWallet.new.utils.mnemonic_sentence(15, 'french')
+      # ["ruser", "malaxer", "forgeron",...]
+      def mnemonic_sentence(word_count = 24, language = 'english')
+        languages = %w[english french spanish korean japanese
+                       italian chinese_traditional chinese_simplified]
+        unless languages.include?(language)
+          raise ArgumentError,
+                %(Not supported language: '#{language}'. Supported languages are: #{languages}.)
+        end
+
+        words = [9, 12, 15, 18, 21, 24]
+        case word_count
+        when 9
+          bits = 96
+        when 12
+          bits = 128
+        when 15
+          bits = 164
+        when 18
+          bits = 196
+        when 21
+          bits = 224
+        when 24
+          bits = 256
+        else
+          raise ArgumentError,
+                %(Not supported count of words #{word_count}. Supported counts are: #{words}.)
+        end
+        BipMnemonic.to_mnemonic(bits: bits, language: language).split
+      end
+    end
+
     def self.verify_param_is_hash!(param)
       raise ArgumentError, 'argument should be Hash' unless param.is_a?(Hash)
     end

data/lib/cardano_wallet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CardanoWallet
-  VERSION = '0.3.26'
+  VERSION = '0.3.27'
 end

data/lib/cardano_wallet.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'httparty'
+require 'bip_mnemonic'
 
 require_relative 'cardano_wallet/version'
 require_relative 'cardano_wallet/base'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.3.26
+  version: 0.3.27
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: bip_mnemonic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: bip_mnemonic
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
-  type: :development
+        version: 0.18.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/run_all_tests
 - bin/setup
 - cardano_wallet.gemspec
 - dev

data/bin/run_all_tests

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-NODE_DB=./node_db \
-WALLET_DB=./wallet_db \
-TOKEN_METADATA=http://metadata-server-mock.herokuapp.com/ \
-bundle exec rake run_on["testnet"]