cardano_wallet 0.1.7 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e71c5cdb72ca953d4289d8d343e1e769c0cd0cb24f6bc51c8487fd189c7dff2
-  data.tar.gz: 4c4712df87921f80adf52b49db9cb8752f397b9fef31c3dd10fe895e18caa29b
+  metadata.gz: b3d493df353517eb41d713b9b12973fadd1b56da5f17f8a15763181285d13a82
+  data.tar.gz: 6848865dea8cd920f95d0268065293aba195e67e4cfd1b1324a62e355e119347
 SHA512:
-  metadata.gz: 515592573f6cdff23f85e26b32430f2913192d04d841dd23f1e1b4c2b5a11c698861f6b5c2039052ce0f6327f82c7c523cf907feb67f8a1a5b3195c1fa27b73c
-  data.tar.gz: 3e8f0e8a30a9eda51a229c202d08adf6d91f7a67a58dbb933f1c50df83182e9b4eb448352ff9e4d5790913ecfe297f753831496807636c5ebac75cd8d065dc45
+  metadata.gz: d02a807c61dad05dd08fc300990702a10ed631a25268735189772e4f54dabb411d4ab5d2688e10333b9d88558a881de1eaf1545cd3a9547cc29bf4f36116f909
+  data.tar.gz: 4007b0db748e9f88244257e30a9a939dea56e213eec84fce632b603c1d2dbfb55e73222db8f13bb6ab6855e3aa0e8c5e3c575f6ce89d55d7cb51c063a5dffb45

data/.github/workflows/nightly.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up cardano-wallet
-      run: NODE_CONFIG_PATH=`pwd`/spec/shelley-testnet docker-compose -f docker-compose-shelley.yml up --detach
+      run: NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml up --detach
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
@@ -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: master
+      NODE: 1.21.1

data/.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up cardano-wallet
-      run: NODE_CONFIG_PATH=`pwd`/spec/shelley-testnet docker-compose -f docker-compose-shelley.yml up --detach
+      run: NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml up --detach
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
@@ -38,4 +38,4 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: master
+      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/cardano_wallet.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'bip_mnemonic', '~> 0.0.4'
-  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'codecov', '~> 0.2.8'
   spec.add_development_dependency 'simplecov'
 
 end

data/dev

@@ -1 +1,8 @@
-NETWORK=testnet WALLET=dev-master-byron NODE=master docker-compose $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/docker-compose-shelley.yml

@@ -7,7 +7,7 @@ services:
       - node-db:/data
       - node-ipc:/ipc
       - ${NODE_CONFIG_PATH}:/config
-    command: run --socket-path /ipc/node.socket --config /config/shelley_testnet-config.json --topology /config/shelley_testnet-topology.json --database-path /data
+    command: run --socket-path /ipc/node.socket --config /config/${NETWORK}-config.json --topology /config/${NETWORK}-topology.json --database-path /data
     restart: on-failure
 
   cardano-wallet:
@@ -18,7 +18,7 @@ services:
       - ${NODE_CONFIG_PATH}:/config
     ports:
       - 8090:8090
-    command: serve --testnet /config/shelley_testnet-genesis.json --node-socket /ipc/node.socket --database /wallet-db --listen-address 0.0.0.0
+    command: serve --testnet /config/${NETWORK}-byron-genesis.json --node-socket /ipc/node.socket --database /wallet-db --listen-address 0.0.0.0
     restart: on-failure
 
 volumes:

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,43 @@ 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 +80,34 @@ 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/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

@@ -158,7 +158,7 @@ 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",
@@ -194,18 +194,22 @@ 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 q [Hash] query param (currently only withdrawRewards = true | false)
+      # @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}, q)
-      def create(wid, passphrase, payments, q = {})
+      #   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)
-        q.empty? ? query = '' : query = Utils.to_query(q)
-        self.class.post("/wallets/#{wid}/transactions#{query}",
-        :body => { :payments => payments_formatted,
-                   :passphrase => passphrase
-                 }.to_json,
+        payload = { :payments => payments_formatted,
+                    :passphrase => passphrase
+                  }
+        payload[:withdrawal] = withdrawal if withdrawal
+        payload[:metadata] = metadata if metadata
+
+        self.class.post("/wallets/#{wid}/transactions",
+        :body => payload.to_json,
         :headers => { 'Content-Type' => 'application/json' } )
       end
 
@@ -213,12 +217,16 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransactionFee
       #
       # @example
-      #   payment_fees(wid, {addr1: 1000000})
-      def payment_fees(wid, payments, q = {})
+      #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}], {"1": "abc"})
+      def payment_fees(wid, payments, withdrawal = nil, metadata = nil)
         payments_formatted = Utils.format_payments(payments)
-        q.empty? ? query = '' : query = Utils.to_query(q)
-        self.class.post("/wallets/#{wid}/payment-fees#{query}",
-        :body => { :payments => payments_formatted }.to_json,
+        payload = { :payments => payments_formatted }
+
+        payload[:withdrawal] = withdrawal if withdrawal
+        payload[:metadata] = metadata if metadata
+
+        self.class.post("/wallets/#{wid}/payment-fees",
+        :body => payload.to_json,
         :headers => { 'Content-Type' => 'application/json' } )
       end
 

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.7"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.2
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -70,16 +70,16 @@ dependencies:
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -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