cardano_wallet 0.1.9 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac2a09241bb9761fcd14be27d36baf749e7bce4211f0b153e01f086412fc7c7
-  data.tar.gz: 3a4accd8dc3e07e157cea62b640f934c703ccbf566a83ba3cd8012d017ed048a
+  metadata.gz: 138963a69580ac035ec96fe4d0aa0b312ad9896c202e84079a2bb017fba537d2
+  data.tar.gz: 3e5131b4d9fac94536f4002827d233d0054d2e648bb1e8846e3ed751a0432e3a
 SHA512:
-  metadata.gz: d60a9175cac06389aa7ba70531a2b96be7611beff90eb28fc9a36f44e91e748ee6beee8d50ee9b9efc43340b101ee459752ef0e89c41d387558e3133810bb496
-  data.tar.gz: ce86f1f1c8cd233785cf12be8c90924ba2af63c6579590deed845e53fd5cd0dc97dc66b043c62392b962f2f136de6a324a6a83bb9866af835c3963f6d65df454
+  metadata.gz: 8ab66b2b2d66b6c80d2c0972ca2c3605c7d0bbafb3bff4af9fce72dba96adebc471d01410a7fad3900999d5cb6138c3e2d1078527e0d3fc73d9cabb370739489
+  data.tar.gz: 12d5479650d0e9b5af8c766709ae6ff9e3ade893d58dbfe5e211286d3346ec4f7ec156322b5d513fce84b93c826893f905bfc45f915786ff78b51960bedece64

data/.github/workflows/nightly.yml

@@ -25,10 +25,10 @@ jobs:
     - name: Wait until node is synced
       run: bundle exec rake wait_until_node_synced
     - name: Run all tests
-      run: bundle exec rspec . 
+      run: bundle exec rspec .
     env:
       CI: true
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: 1.19.0
+      NODE: 1.21.1

data/.github/workflows/tests.yml

@@ -38,4 +38,4 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: 1.19.0
+      NODE: 1.21.1

data/README.md

@@ -65,7 +65,6 @@ CW = CardanoWallet.new
 BYRON = CW.byron
 SHELLEY = CW.shelley
 MISC = CW.misc
-PROXY = CW.proxy
 
 #Byron
 BYRON.wallets.list.each_with_index do |wal, i|
@@ -82,9 +81,8 @@ SHELLEY.wallets.get(w['id'])
 #Misc
 MISC.network.information
 MISC.network.clock
-
-#Proxy
-PROXY.submit_external_transaction(File.new("/tmp/blob.bin").read)
+MISC.proxy.submit_external_transaction(File.new("/tmp/blob.bin").read)
+MISC.utils.addresses("addr_test1vqrlltfahghjxl5sy5h5mvfrrlt6me5fqphhwjqvj5jd88cccqcek")
 ```
 
 Refer to [documentation](https://rubydoc.info/gems/cardano_wallet) for more details.

data/dev

@@ -1 +1,8 @@
-NETWORK=testnet WALLET=dev-master-shelley NODE=1.19.0 NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml $1
+#!/bin/sh
+
+NETWORK=testnet \
+WALLET=dev-master-shelley \
+NODE=1.20.0 \
+NODE_CONFIG_PATH=`pwd`/spec/testnet \
+docker-compose -f docker-compose-shelley.yml \
+$1 $2 $3 $4

data/lib/cardano_wallet.rb

@@ -6,7 +6,6 @@ require_relative "cardano_wallet/utils"
 require_relative "cardano_wallet/shelley"
 require_relative "cardano_wallet/byron"
 require_relative "cardano_wallet/misc"
-require_relative "cardano_wallet/proxy"
 
 module CardanoWallet
   def self.new(options = {})

data/lib/cardano_wallet/base.rb

@@ -13,7 +13,11 @@ module CardanoWallet
       opt[:url] ||= "#{opt[:protocol]}://#{opt[:host]}:#{opt[:port]}/v2"
       opt[:cacert] ||= ''
       opt[:pem] ||= ''
+      opt[:timeout] ||= -1
       self.class.base_uri opt[:url]
+      unless(opt[:timeout] == -1)
+        self.class.default_timeout(opt[:timeout].to_i)
+      end
 
       unless opt[:cacert].empty?
         ENV['SSL_CERT_FILE'] = opt[:cacert]

data/lib/cardano_wallet/byron.rb

@@ -181,7 +181,7 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/byronSelectCoins
       #
       # @example
-      #   random(wid, {address1: 123, address2: 456})
+      #   random(wid, [{addr1: 1000000}, {addr2: 1000000}])
       def random(wid, payments)
         payments_formatted = Utils.format_payments(payments)
         self.class.post("/byron-wallets/#{wid}/coin-selections/random",
@@ -217,10 +217,10 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postByronTransaction
       # @param wid [String] source wallet id
       # @param passphrase [String] source wallet's passphrase
-      # @param payments [Hash] addres, amount pair
+      # @param payments [Array of Hashes] addres, amount pair
       #
       # @example
-      #   create(wid, passphrase, {addr1: 1000000})
+      #   create(wid, passphrase, [{addr1: 1000000}, {addr2: 1000000}])
       def create(wid, passphrase, payments)
         payments_formatted = Utils.format_payments(payments)
         self.class.post("/byron-wallets/#{wid}/transactions",
@@ -234,7 +234,7 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransactionFee
       #
       # @example
-      #   payment_fees(wid, {addr1: 1000000})
+      #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}])
       def payment_fees(wid, payments)
         payments_formatted = Utils.format_payments(payments)
         self.class.post("/byron-wallets/#{wid}/payment-fees",

data/lib/cardano_wallet/misc.rb

@@ -15,6 +15,44 @@ module CardanoWallet
       def network
         Network.new @opt
       end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Utils
+      def utils
+        Utils.new @opt
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Proxy
+      def proxy
+        Proxy.new @opt
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Settings
+      def settings
+        Settings.new @opt
+      end
+
+    end
+
+    # API for Network
+    # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Settings
+    class Settings < Base
+      def initialize opt
+        super
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getSettings
+      def get
+        self.class.get("/settings")
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/putSettings
+      def update(params)
+        CardanoWallet::Utils.verify_param_is_hash!(params)
+        self.class.put("/settings",
+                       :body => {"settings" => params}.to_json,
+                       :headers => { 'Content-Type' => 'application/json' }
+                      )
+      end
     end
 
     # API for Network
@@ -43,5 +81,50 @@ module CardanoWallet
       end
 
     end
+
+    # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Utils
+    class Utils < Base
+      def initialize opt
+        super
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/signMetadata
+      def sign_metadata(wid, role, index, pass, metadata)
+        payload = { passphrase: pass }
+        payload[:metadata] = metadata if metadata
+
+        self.class.post("/wallets/#{wid}/signatures/#{role}/#{index}",
+                        :body => payload.to_json,
+                        :headers => { 'Content-Type' => 'application/json',
+                                      'Accept' => 'application/octet-stream'} )
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/getWalletKey
+      def get_public_key(wid, role, index)
+        self.class.get("/wallets/#{wid}/keys/#{role}/#{index}")
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/inspectAddress
+      def addresses(address_id)
+        self.class.get("/addresses/#{address_id}")
+      end
+
+    end
+
+    # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Proxy
+    class Proxy < Base
+      def initialize opt
+        super
+      end
+
+      # Submit a transaction that was created and signed outside of cardano-wallet.
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postExternalTransaction
+      # @param binary_blob [String] Signed transaction message binary blob.
+      def submit_external_transaction(binary_blob)
+        self.class.post("/proxy/transactions",
+                        :body => binary_blob,
+                        :headers => { 'Content-Type' => 'application/octet-stream' })
+      end
+    end
   end
 end

data/lib/cardano_wallet/shelley.rb

@@ -48,6 +48,35 @@ module CardanoWallet
         Migrations.new @opt
       end
 
+      # API for Keys
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#tag/Keys
+      def keys
+        Keys.new @opt
+      end
+
+    end
+
+    class Keys < Base
+      def initialize opt
+        super
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/signMetadata
+      def sign_metadata(wid, role, index, pass, metadata)
+        payload = { passphrase: pass }
+        payload[:metadata] = metadata if metadata
+
+        self.class.post("/wallets/#{wid}/signatures/#{role}/#{index}",
+                        :body => payload.to_json,
+                        :headers => { 'Content-Type' => 'application/json',
+                                      'Accept' => 'application/octet-stream'} )
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/getWalletKey
+      def get_public_key(wid, role, index)
+        self.class.get("/wallets/#{wid}/keys/#{role}/#{index}")
+      end
+
     end
 
     # API for Wallets
@@ -158,13 +187,26 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/selectCoins
       #
       # @example
-      #   random(wid, {address1: 123, address2: 456})
+      #   random(wid, [{addr1: 1000000}, {addr2: 1000000}])
       def random(wid, payments)
         payments_formatted = Utils.format_payments(payments)
         self.class.post("/wallets/#{wid}/coin-selections/random",
                         :body => {:payments => payments_formatted}.to_json,
                         :headers => { 'Content-Type' => 'application/json' })
       end
+
+      # Coin selection -> Delegation action
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/selectCoins
+      #
+      # @example
+      #   random(wid, {action: "join", pool: "poolid"})
+      #   random(wid, {action: "quit"})
+      def random_deleg(wid, deleg_action)
+        payments_formatted = Utils.verify_param_is_hash!(deleg_action)
+        self.class.post("/wallets/#{wid}/coin-selections/random",
+                        :body => {:delegation_action => deleg_action}.to_json,
+                        :headers => { 'Content-Type' => 'application/json' })
+      end
     end
 
     # API for Transactions
@@ -194,12 +236,12 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransaction
       # @param wid [String] source wallet id
       # @param passphrase [String] source wallet's passphrase
-      # @param payments [Hash] addres, amount pair
+      # @param payments [Array of Hashes] addres, amount pair
       # @param withdrawal [String or Array] 'self' or mnemonic sentence
       # @param metadata [Hash] special metadata JSON subset format (cf: https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransaction)
       #
       # @example
-      #   create(wid, passphrase, {addr1: 1000000}, 'self', {"1": "abc"})
+      #   create(wid, passphrase, [{addr1: 1000000}, {addr2: 1000000}], 'self', {"1": "abc"})
       def create(wid, passphrase, payments, withdrawal = nil, metadata = nil)
         payments_formatted = Utils.format_payments(payments)
         payload = { :payments => payments_formatted,
@@ -217,7 +259,7 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransactionFee
       #
       # @example
-      #   payment_fees(wid, {addr1: 1000000}, {"1": "abc"})
+      #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}], {"1": "abc"})
       def payment_fees(wid, payments, withdrawal = nil, metadata = nil)
         payments_formatted = Utils.format_payments(payments)
         payload = { :payments => payments_formatted }

data/lib/cardano_wallet/utils.rb

@@ -5,13 +5,24 @@ module CardanoWallet
       raise ArgumentError, "argument should be Hash" unless param.is_a?(Hash)
     end
 
+    def self.verify_param_is_array!(param)
+      raise ArgumentError, "argument should be Array" unless param.is_a?(Array)
+    end
+
+    ##
+    # @param payments [Array of Hashes] - [{addr1: 1}, {addr2: 2}]
+    # @return [Array of Hashes] - [{:address=>"addr1", :amount=>{:quantity=>1, :unit=>"lovelace"}}, {:address=>"addr2", :amount=>{:quantity=>2, :unit=>"lovelace"}}]
     def self.format_payments(payments)
-      verify_param_is_hash!(payments)
-      payments.collect do |addr, amt|
-        {:address => addr.to_s,
-         :amount => {:quantity => amt.to_i,
-                     :unit => "lovelace"}
-        }
+      verify_param_is_array!(payments)
+      raise ArgumentError, "argument should be Array of single Hashes" unless payments.all?{|p| p.size == 1 && p.is_a?(Hash)}
+      payments.map do |p|
+        a = p.collect do |addr, amt|
+          {:address => addr.to_s,
+           :amount => {:quantity => amt.to_i,
+                       :unit => "lovelace"}
+          }
+        end.flatten
+        Hash[*a]
       end
     end
 

data/lib/cardano_wallet/version.rb

@@ -1,3 +1,3 @@
 module CardanoWallet
-  VERSION = "0.1.9"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.4
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -117,12 +117,10 @@ files:
 - cardano_wallet.gemspec
 - dev
 - docker-compose-shelley.yml
-- docker-compose.yml
 - lib/cardano_wallet.rb
 - lib/cardano_wallet/base.rb
 - lib/cardano_wallet/byron.rb
 - lib/cardano_wallet/misc.rb
-- lib/cardano_wallet/proxy.rb
 - lib/cardano_wallet/shelley.rb
 - lib/cardano_wallet/utils.rb
 - lib/cardano_wallet/version.rb
@@ -149,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper over cardano-wallet.

data/docker-compose.yml

@@ -1,38 +0,0 @@
-version: "3.5"
-
-services:
-  cardano-node:
-    image: inputoutput/cardano-node:${NODE}
-    environment:
-      NETWORK:
-    volumes:
-      - node-${NETWORK}-db:/data
-      - node-ipc:/ipc
-      - node-config:/nix/store
-    restart: on-failure
-
-  cardano-wallet:
-    image: inputoutput/cardano-wallet:${WALLET}
-    volumes:
-      - wallet-${NETWORK}-db:/wallet-db
-      - node-ipc:/ipc
-      - node-config:/config
-    ports:
-      - 8090:8090
-    entrypoint: []
-    command: bash -c "
-        ([[ $$NETWORK == \"mainnet\" ]] && $$CMD --mainnet) ||
-        ([[ $$NETWORK == \"testnet\" ]] && $$CMD --testnet /config/*testnet-genesis.json)
-      "
-    environment:
-      CMD: "cardano-wallet-byron serve --node-socket /ipc/node.socket --database /wallet-db --listen-address 0.0.0.0"
-      NETWORK:
-    restart: on-failure
-
-volumes:
-  node-mainnet-db:
-  node-testnet-db:
-  wallet-mainnet-db:
-  wallet-testnet-db:
-  node-ipc:
-  node-config:

data/lib/cardano_wallet/proxy.rb

@@ -1,26 +0,0 @@
-module CardanoWallet
-  module Proxy
-
-    # Call API for Proxy
-    # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Proxy
-    def self.new(opt)
-      Init.new opt
-    end
-
-    class Init < Base
-      def initialize opt
-        super
-      end
-
-      # Submit a transaction that was created and signed outside of cardano-wallet.
-      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postExternalTransaction
-      # @param binary_blob [String] Signed transaction message binary blob.
-      def submit_external_transaction(binary_blob)
-        self.class.post("/proxy/transactions",
-                        :body => binary_blob,
-                        :headers => { 'Content-Type' => 'application/octet-stream' })
-      end
-    end
-
-  end
-end