cardano_wallet 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a386b2276f8b8373cd9a89cebdba30a5f151c2b32cee0ae3d8915a6daee980
-  data.tar.gz: 10094b3fb16e9c9e71e61409a314b06d94dd140c01f79641e8bce9dafa21fccc
+  metadata.gz: 880714f1f46b46a2b97b2ba99700acfc06c576df55fb457a852152832d964c4e
+  data.tar.gz: 35964e6bb0356db5f0ae855efc60694857f4987c537e9b563dda8b3253883b2b
 SHA512:
-  metadata.gz: ff0b9ac1b5071acee4be8ad9830adbe082fb01587e4593fa868ed7dd47552609e04ed3a382a47abedba658340a4cad4e25506ad9f0db73e6b6f7f35fe23621a8
-  data.tar.gz: 19e1aad7916ec508822a48e1ac38996236874236c8d7849754fed3922444bae0396c955d62a4a06a11e4aafefbeb33b494035c5e9026aefa36a5885a7d3495ca
+  metadata.gz: 747a1f8a8c669547c8a076ac8adcbdc463355c094522f2ac50fdae69afba4f22d3aa443fe7d7c1e1b80064699b5fcfcd2b1fa4ad03397ba699f5fba80a645929
+  data.tar.gz: 78ce365d4ae47bc8b406d719a66e387eb9c26256286f8babbd1ac3499820c3d534b5ce491d7ce745d8267aa9df2b33e4f4fa60cbedb9d4b660faa5aa54002b28

data/.github/workflows/nightly.yml

@@ -31,4 +31,4 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: 1.20.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.20.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.1 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/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

@@ -25,6 +25,34 @@ module CardanoWallet
       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
@@ -60,6 +88,22 @@ module CardanoWallet
         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}")

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,19 +236,21 @@ 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)
+      # @param ttl [Int] transaction's time-to-live in seconds
       #
       # @example
-      #   create(wid, passphrase, {addr1: 1000000}, 'self', {"1": "abc"})
-      def create(wid, passphrase, payments, withdrawal = nil, metadata = nil)
+      #   create(wid, passphrase, [{addr1: 1000000}, {addr2: 1000000}], 'self', {"1": "abc"}, ttl = 10)
+      def create(wid, passphrase, payments, withdrawal = nil, metadata = nil, ttl = nil)
         payments_formatted = Utils.format_payments(payments)
         payload = { :payments => payments_formatted,
                     :passphrase => passphrase
                   }
         payload[:withdrawal] = withdrawal if withdrawal
         payload[:metadata] = metadata if metadata
+        payload[:time_to_live] = { quantity: ttl, unit: "second" } if ttl
 
         self.class.post("/wallets/#{wid}/transactions",
         :body => payload.to_json,
@@ -217,13 +261,14 @@ module CardanoWallet
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postTransactionFee
       #
       # @example
-      #   payment_fees(wid, {addr1: 1000000}, {"1": "abc"})
-      def payment_fees(wid, payments, withdrawal = nil, metadata = nil)
+      #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}], {"1": "abc"}, ttl = 10)
+      def payment_fees(wid, payments, withdrawal = nil, metadata = nil, ttl = nil)
         payments_formatted = Utils.format_payments(payments)
         payload = { :payments => payments_formatted }
 
         payload[:withdrawal] = withdrawal if withdrawal
         payload[:metadata] = metadata if metadata
+        payload[:time_to_live] = { quantity: ttl, unit: "second" } if ttl
 
         self.class.post("/wallets/#{wid}/payment-fees",
         :body => payload.to_json,

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -117,7 +117,6 @@ 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
@@ -148,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.4
 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: