cardano_wallet 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e03252209057d5605ab9020ce1ef5ff66f123c6de43039595fbcfeefcc93ceb
-  data.tar.gz: 17be8811e28fa42f2b7dcc3f143d15d1f3b86ff186031c30dccbd71ee6487028
+  metadata.gz: f416f0ff4fd389ce9af664e9c128f0765cda62c346f6b2f3b5237a884e43a253
+  data.tar.gz: 5769fb34859b6c2ddc7376a718ba5c0fc7962810cc1d3fc6012a82219d979302
 SHA512:
-  metadata.gz: 92fb3ce4f8d6083e03dce79d4a617b672d28c5952590b5ac9604ebd01352ed03d59e62aa3a42f6a1674800a10fa3e26355897dabebfde916a90c73a1e7471a94
-  data.tar.gz: db0decbb39674070b8741ade621a3e1dd5d6fe8a8539dc13ceaac303bc7b86fc6304c13709caa9f5bfafaecde3f56468ceadbfe879f77243cc407f92716d3526
+  metadata.gz: 8b3492bd2f7f215a3ef7008ae997189eab233ab821764f93a1bae69f3bf859258c519dd808e433ec2edcc6f9ba183e59dc28e3439d974dc35dec498f106becf7
+  data.tar.gz: 877550274108bc8c06203b9f488493c930d57b45c71ce7601f0116d129826f5638801dc46355b123ec2bf784977129e9a73fdfbc430e1d52f7bd13c28dbe39f8

data/.github/workflows/nightly.yml

@@ -3,6 +3,16 @@ name: Nightly
 on:
   schedule:
   - cron:  "0 23 * * *"
+  workflow_dispatch:
+    inputs:
+      nodeTag:
+        description: 'Node tag (docker)'
+        required: true
+        default: '1.24.2'
+      walletTag:
+        description: 'Wallet tag (docker)'
+        required: true
+        default: 'dev-master-shelley'
 
 jobs:
   test:
@@ -11,24 +21,54 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up cardano-wallet
-      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):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+
+    - name: Cache node db
+      id: cache
+      uses: actions/cache@v2
       with:
-        ruby-version: 2.6
+        path: ~/node-db-nightly-docker
+        key: ${{ runner.os }}-node-db-nightly-docker-tests-${{ hashFiles('**/protocolMagicId') }}
+
+    - name: Set up cardano-wallet and cardano-node MANUAL
+      if: ${{ github.event.inputs.walletTag != '' && github.event.inputs.nodeTag != ''}}
+      env:
+        WALLET: ${{ github.event.inputs.walletTag }}
+        NODE: ${{ github.event.inputs.nodeTag }}
+      run: |
+        echo "Wallet: $WALLET"
+        echo "Node: $NODE"
+        NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml up --detach
+        docker run --rm inputoutput/cardano-wallet:$WALLET version
+        docker run --rm inputoutput/cardano-node:$NODE version
+        ls ~/node-db-nightly-docker
+
+    - name: Set up cardano-wallet and cardano-node NIGHTLY
+      if: ${{ github.event.inputs.walletTag == '' && github.event.inputs.nodeTag == ''}}
+      run: |
+        echo "Wallet: $WALLET"
+        echo "Node: $NODE"
+        NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml up --detach
+        docker run --rm inputoutput/cardano-wallet:$WALLET version
+        docker run --rm inputoutput/cardano-node:$NODE version
+        ls ~/node-db-nightly-docker
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+
     - name: Install dependencies
       run: bundle install
+
     - name: Wait until node is synced
       run: bundle exec rake wait_until_node_synced
+
     - name: Run all tests
       run: bundle exec rspec .
+
+    - name: Stop docker-compose
+      run: NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml down
     env:
       CI: true
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: 1.21.1
+      NODE: 1.25.1

data/.github/workflows/tests.yml

@@ -1,10 +1,3 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: Tests
 
 on:
@@ -12,6 +5,7 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  workflow_dispatch:
 
 jobs:
   test:
@@ -20,22 +14,37 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up cardano-wallet
-      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):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+
+    - name: Cache node db
+      id: cache
+      uses: actions/cache@v2
       with:
-        ruby-version: 2.6
+        path: ~/node-db-nightly-docker
+        key: ${{ runner.os }}-node-db-tests-docker-${{ hashFiles('**/protocolMagicId') }}
+
+    - name: Set up cardano-wallet and cardano-node
+      run: |
+        echo "Wallet: $WALLET"
+        echo "Node: $NODE"
+        NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml up --detach
+        docker run --rm inputoutput/cardano-wallet:$WALLET version
+        docker run --rm inputoutput/cardano-node:$NODE version
+        ls ~/node-db-nightly-docker
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+
     - name: Install dependencies
       run: bundle install
+
     - name: Run all tests except nighlty
-      run: bundle exec rspec . -t ~nightly
+      run: rspec . -t ~nightly
+
+    - name: Stop docker-compose
+      run: NODE_CONFIG_PATH=`pwd`/spec/testnet docker-compose -f docker-compose-shelley.yml down
     env:
       CI: true
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
       WALLET: dev-master-shelley
-      NODE: 1.21.1
+      NODE: 1.25.1

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

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', '~> 0.2.8'
+  spec.add_development_dependency 'codecov', '0.2.8'
   spec.add_development_dependency 'simplecov'
 
 end

data/dev

@@ -2,7 +2,7 @@
 
 NETWORK=testnet \
 WALLET=dev-master-shelley \
-NODE=1.20.0 \
+NODE=1.24.2 \
 NODE_CONFIG_PATH=`pwd`/spec/testnet \
 docker-compose -f docker-compose-shelley.yml \
 $1 $2 $3 $4

data/docker-compose-shelley.yml

@@ -4,7 +4,7 @@ services:
   cardano-node:
     image: inputoutput/cardano-node:${NODE}
     volumes:
-      - node-db:/data
+      - ~/node-db-nightly-docker:/data
       - node-ipc:/ipc
       - ${NODE_CONFIG_PATH}:/config
     command: run --socket-path /ipc/node.socket --config /config/${NETWORK}-config.json --topology /config/${NETWORK}-topology.json --database-path /data
@@ -22,6 +22,5 @@ services:
     restart: on-failure
 
 volumes:
-  node-db:
   wallet-shelley-db:
   node-ipc:

data/lib/cardano_wallet/byron.rb

@@ -39,6 +39,29 @@ module CardanoWallet
       def migrations
         Migrations.new @opt
       end
+
+      # API for Assets
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Byron-Assets
+      def assets
+        Assets.new @opt
+      end
+    end
+
+    class Assets < Base
+      def initialize opt
+        super
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listByronAssets
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getByronAsset
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getByronAssetDefault
+      def get(wid, policy_id = nil, asset_name = nil)
+        ep = "/byron-wallets/#{wid}/assets"
+        ep += "/#{policy_id}" if policy_id
+        ep += "/#{asset_name}" if asset_name
+        self.class.get(ep)
+      end
+
     end
 
     # Byron wallets
@@ -182,8 +205,14 @@ module CardanoWallet
       #
       # @example
       #   random(wid, [{addr1: 1000000}, {addr2: 1000000}])
+      #   random(wid, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ])
       def random(wid, payments)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
         self.class.post("/byron-wallets/#{wid}/coin-selections/random",
                         :body => {:payments => payments_formatted}.to_json,
                         :headers => { 'Content-Type' => 'application/json' })
@@ -221,8 +250,15 @@ module CardanoWallet
       #
       # @example
       #   create(wid, passphrase, [{addr1: 1000000}, {addr2: 1000000}])
+      #   create(wid, passphrase, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ])
+
       def create(wid, passphrase, payments)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
         self.class.post("/byron-wallets/#{wid}/transactions",
         :body => { :payments => payments_formatted,
                    :passphrase => passphrase
@@ -235,8 +271,14 @@ module CardanoWallet
       #
       # @example
       #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}])
+      #   payment_fees(wid, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ])
       def payment_fees(wid, payments)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
         self.class.post("/byron-wallets/#{wid}/payment-fees",
         :body => { :payments => payments_formatted }.to_json,
         :headers => { 'Content-Type' => 'application/json' } )

data/lib/cardano_wallet/misc.rb

@@ -117,6 +117,16 @@ module CardanoWallet
                                       'Accept' => 'application/json'} )
       end
 
+      # Current SMASH health
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getCurrentSmashHealth
+      #
+      # @example
+      #   smash_health({url: "https://smash.cardano-mainnet.iohk.io/"})
+      def smash_health(q = {})
+        q.empty? ? query = '' : query = CardanoWallet::Utils.to_query(q)
+        self.class.get("/smash/health#{query}")
+      end
+
     end
 
     # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Proxy

data/lib/cardano_wallet/shelley.rb

@@ -54,6 +54,29 @@ module CardanoWallet
         Keys.new @opt
       end
 
+      # API for Assets
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Assets
+      def assets
+        Assets.new @opt
+      end
+
+    end
+
+    class Assets < Base
+      def initialize opt
+        super
+      end
+
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listAssets
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getAsset
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getAssetDefault
+      def get(wid, policy_id = nil, asset_name = nil)
+        ep = "/wallets/#{wid}/assets"
+        ep += "/#{policy_id}" if policy_id
+        ep += "/#{asset_name}" if asset_name
+        self.class.get(ep)
+      end
+
     end
 
     class Keys < Base
@@ -77,6 +100,15 @@ module CardanoWallet
         self.class.get("/wallets/#{wid}/keys/#{role}/#{index}")
       end
 
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/postAccountKey
+      def create_acc_public_key(wid, index, pass, extended)
+        payload = { passphrase: pass, extended: extended }
+        self.class.post("/wallets/#{wid}/keys/#{index}",
+                        :body => payload.to_json,
+                        :headers => { 'Content-Type' => 'application/json' }
+                        )
+      end
+
     end
 
     # API for Wallets
@@ -188,8 +220,14 @@ module CardanoWallet
       #
       # @example
       #   random(wid, [{addr1: 1000000}, {addr2: 1000000}])
+      #   random(wid, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ])
       def random(wid, payments)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
         self.class.post("/wallets/#{wid}/coin-selections/random",
                         :body => {:payments => payments_formatted}.to_json,
                         :headers => { 'Content-Type' => 'application/json' })
@@ -202,7 +240,7 @@ module CardanoWallet
       #   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)
+        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' })
@@ -236,15 +274,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 [Array of Hashes] addres, amount pair
+      # @param payments [Array of Hashes] address / amount list or full payments payload with assets
       # @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}, {addr2: 1000000}], 'self', {"1": "abc"}, ttl = 10)
+      #   create(wid, passphrase, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ], 'self', {"1": "abc"}, ttl = 10)
       def create(wid, passphrase, payments, withdrawal = nil, metadata = nil, ttl = nil)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
         payload = { :payments => payments_formatted,
                     :passphrase => passphrase
                   }
@@ -262,8 +306,15 @@ module CardanoWallet
       #
       # @example
       #   payment_fees(wid, [{addr1: 1000000}, {addr2: 1000000}], {"1": "abc"}, ttl = 10)
+      #   payment_fees(wid, [{ "address": "addr1..", "amount": { "quantity": 42000000, "unit": "lovelace" }, "assets": [{"policy_id": "pid", "asset_name": "name", "quantity": 0 } ] } ], {"1": "abc"}, ttl = 10)
       def payment_fees(wid, payments, withdrawal = nil, metadata = nil, ttl = nil)
-        payments_formatted = Utils.format_payments(payments)
+        Utils.verify_param_is_array!(payments)
+        if payments.any?{|p| p.has_key?("address".to_sym) || p.has_key?("address")}
+          payments_formatted = payments
+        else
+          payments_formatted = Utils.format_payments(payments)
+        end
+
         payload = { :payments => payments_formatted }
 
         payload[:withdrawal] = withdrawal if withdrawal
@@ -289,6 +340,24 @@ module CardanoWallet
         super
       end
 
+      # Stake pools maintenance actions
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postMaintenanceAction
+      #
+      # @example
+      #   maintenance_action({ "maintenance_action": "gc_stake_pools" })
+      def trigger_maintenance_actions(action = {})
+        Utils.verify_param_is_hash!(action)
+        self.class.post("/stake-pools/maintenance-actions",
+          :body => action.to_json,
+          :headers => { 'Content-Type' => 'application/json' } )
+      end
+
+      # Metdata GC Status
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getMaintenanceActions
+      def view_maintenance_actions
+        self.class.get("/stake-pools/maintenance-actions")
+      end
+
       # List all stake pools
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listStakePools
       def list(stake = {})

data/lib/cardano_wallet/version.rb

@@ -1,3 +1,3 @@
 module CardanoWallet
-  VERSION = "0.2.6"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -70,14 +70,14 @@ dependencies:
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.2.8
 - !ruby/object:Gem::Dependency
@@ -107,6 +107,7 @@ files:
 - ".gitignore"
 - ".rakeTasks"
 - ".rspec"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper over cardano-wallet.