cardano_wallet 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e3c345e2c100428cf2bdd638ee903c9df401760a78e75bc531f48d8d2832e3
-  data.tar.gz: d11fd3e81378d4ff2d4687d16ebe3cdcfa78cf33d342d2d907ac8b8ab374c70b
+  metadata.gz: df0d8f6569ab3be773efe025fa14ec11e90fdfc9a51a08817182ec99de86eaec
+  data.tar.gz: 4ce00832c57f2afea0c2019d7772f8037b5fb4523e1f8f3be5aa3dfb4040a6d6
 SHA512:
-  metadata.gz: a2a32cd78ee9ec09f814b1bb9eca9786327b2da53e82da90067aaa9cca6c7a9d146b9d120115173e0e17e4f154c6d3cdf3c6ba7cbe228ce07f53dc7b435a5d88
-  data.tar.gz: 5b2f5263447204632e7d80d8a9e15186a19fa7d33e40ee1a74651c0982aa799157a3b42455ea75aff25cd38db2ba8fea1609506f1ac2689dee3bc31911b950eb
+  metadata.gz: 97f5be475f2b18c6344e619fb33866a41d0449baf6801820aacc3123a0390195d4ed29a3d253b9b4e9004c6cd96246100a4b9df4a7ec54cb7e4ace3e37beeac8
+  data.tar.gz: e38d3564c8d28a01cc585ffbf3bf38d061f498301f26c1464aa9703bc927f18230af5bd3dbd27600a2b27b91a6dadc4059b6c91875a2dd2394951ded48af8cc2

data/.github/workflows/nightly.yml

@@ -0,0 +1,34 @@
+name: Nightly
+
+on:
+  schedule:
+  - cron:  "0 23 * * *"
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    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
+    - 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
+      with:
+        ruby-version: 2.6
+    - 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
+    env:
+      CI: true
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      NETWORK: testnet
+      WALLET: dev-master-shelley
+      NODE: 1.14.2

data/.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up cardano-wallet
-      run: docker-compose up --detach
+      run: NODE_CONFIG_PATH=`pwd`/spec/shelley-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):
@@ -31,11 +31,11 @@ jobs:
         ruby-version: 2.6
     - name: Install dependencies
       run: bundle install
-    - name: Run tests
-      run: bundle exec rake
+    - name: Run all tests except nighlty
+      run: bundle exec rspec . -t ~nightly
     env:
       CI: true
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       NETWORK: testnet
-      WALLET: dev-master-byron
-      NODE: latest
+      WALLET: dev-master-shelley
+      NODE: 1.14.2

data/README.md

@@ -1,3 +1,7 @@
+
+<a href="https://badge.fury.io/rb/cardano_wallet">
+  <img src="https://badge.fury.io/rb/cardano_wallet.svg" alt="Gem Version">
+</a>
 <a href="https://github.com/piotr-iohk/cardano-wallet-rb/releases">
   <img src="https://img.shields.io/github/release/piotr-iohk/cardano-wallet-rb.svg" />
 </a>
@@ -7,6 +11,9 @@
 <a href="https://github.com/piotr-iohk/cardano-wallet-rb/actions?query=workflow%3ATests">
   <img src="https://github.com/piotr-iohk/cardano-wallet-rb/workflows/Tests/badge.svg" />
 </a>
+<a href="https://github.com/piotr-iohk/cardano-wallet-rb/actions?query=workflow%3ANightly">
+  <img src="https://github.com/piotr-iohk/cardano-wallet-rb/workflows/Nightly/badge.svg" />
+</a>
 
 # cardano-wallet-rb
 
@@ -28,6 +35,12 @@ Or install it yourself as:
 
     $ gem install cardano_wallet
 
+## Documentation
+
+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
 
 ### Initialize
@@ -42,8 +55,10 @@ CW2 = CardanoWallet.new({port: 443,
                         protocol: "https",
                         cacert: "/root/ca.cert",
                         pem: "/root/client.pem"})
+CW3 = CardanoWallet.new({url: "http://localhost:8090/v2"})
 ```
-### Excercise the API
+
+### Exercise
 ```ruby
 CW = CardanoWallet.new
 
@@ -59,8 +74,8 @@ 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"}
+                       mnemonic_sentence: %w[vintage poem topic machine hazard cement dune glimpse fix brief account badge mass silly business],
+                       passphrase: "Secure Passphrase"}
 
 SHELLEY.wallets.get(w['id'])
 
@@ -72,22 +87,27 @@ MISC.network.clock
 PROXY.submit_external_transaction(File.new("/tmp/blob.bin").read)
 ```
 
-Refer to documentation.
+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.
+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
 
-This starts:
-  - `cardano-node` latest [release](https://github.com/input-output-hk/cardano-node/releases)
-  - `cardano-wallet-byron` [master](https://github.com/input-output-hk/cardano-wallet)
+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/Rakefile

@@ -4,3 +4,13 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+require_relative "lib/cardano_wallet"
+task :wait_until_node_synced do
+  desc "Wait for node to be synced"
+  network = CardanoWallet.new.misc.network
+  while network.information["sync_progress"]["status"] == "syncing" do
+    puts "Syncing... #{network.information["sync_progress"]["progress"]["quantity"]}%"
+    sleep 15
+  end
+end

data/cardano_wallet.gemspec

@@ -31,6 +31,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 'simplecov'
 

data/dev

@@ -0,0 +1 @@
+NETWORK=testnet WALLET=dev-master-byron NODE=master docker-compose $1

data/docker-compose-shelley.yml

@@ -0,0 +1,27 @@
+version: "3.5"
+
+services:
+  cardano-node:
+    image: inputoutput/cardano-node:${NODE}
+    volumes:
+      - 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
+    restart: on-failure
+
+  cardano-wallet:
+    image: inputoutput/cardano-wallet:${WALLET}
+    volumes:
+      - wallet-shelley-db:/wallet-db
+      - node-ipc:/ipc
+      - ${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
+    restart: on-failure
+
+volumes:
+  node-db:
+  wallet-shelley-db:
+  node-ipc:

data/lib/cardano_wallet/base.rb

@@ -2,7 +2,7 @@ module CardanoWallet
   class Base
     include HTTParty
 
-    attr_reader :opt
+    attr_accessor :opt
 
     def initialize(opt = {})
       raise ArgumentError, "argument should be Hash" unless opt.is_a?(Hash)

data/lib/cardano_wallet/byron.rb

@@ -161,6 +161,12 @@ module CardanoWallet
         super
       end
 
+      # Get tx by id
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getByronTransaction
+      def get(wid, tx_id)
+        self.class.get("/byron-wallets/#{wid}/transactions/#{tx_id}")
+      end
+
       # List all Byron wallet's transactions.
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listByronTransactions
       #

data/lib/cardano_wallet/misc.rb

@@ -38,8 +38,8 @@ module CardanoWallet
 
       # Check network parameters
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getNetworkParameters
-      def parameters(epoch_id)
-        self.class.get("/network/parameters/#{epoch_id}")
+      def parameters
+        self.class.get("/network/parameters")
       end
 
     end

data/lib/cardano_wallet/shelley.rb

@@ -42,6 +42,12 @@ module CardanoWallet
         StakePools.new @opt
       end
 
+      # API for Migrations
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#tag/Migrations
+      def migrations
+        Migrations.new @opt
+      end
+
     end
 
     # API for Wallets
@@ -168,6 +174,12 @@ module CardanoWallet
         super
       end
 
+      # Get tx by id
+      # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getTransaction
+      def get(wid, tx_id)
+        self.class.get("/wallets/#{wid}/transactions/#{tx_id}")
+      end
+
       # List all wallet's transactions
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listTransactions
       #
@@ -183,17 +195,18 @@ module CardanoWallet
       # @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)
       #
       # @example
-      #   create(wid, passphrase, {addr1: 1000000})
-      def create(wid, passphrase, payments)
+      #   create(wid, passphrase, {addr1: 1000000}, q)
+      def create(wid, passphrase, payments, q = {})
         payments_formatted = Utils.format_payments(payments)
-        self.class.post("/wallets/#{wid}/transactions",
+        q.empty? ? query = '' : query = Utils.to_query(q)
+        self.class.post("/wallets/#{wid}/transactions#{query}",
         :body => { :payments => payments_formatted,
                    :passphrase => passphrase
                  }.to_json,
         :headers => { 'Content-Type' => 'application/json' } )
-
       end
 
       # Estimate fees for transaction
@@ -224,8 +237,9 @@ module CardanoWallet
 
       # List all stake pools
       # @see https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listStakePools
-      def list
-        self.class.get("/stake-pools")
+      def list(stake = {})
+        stake.empty? ? query = '' : query = Utils.to_query(stake)
+        self.class.get("/stake-pools#{query}")
       end
 
       # Join stake pool
@@ -250,5 +264,33 @@ module CardanoWallet
         self.class.get("/wallets/#{wid}/delegation-fees")
       end
     end
+
+    # Shelley migrations
+    # @see https://input-output-hk.github.io/cardano-wallet/api/#tag/Migrations
+    class Migrations < Base
+      def initialize opt
+        super
+      end
+
+      # Calculate migration cost
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/getShelleyWalletMigrationInfo
+      def cost(wid)
+        self.class.get("/wallets/#{wid}/migrations")
+      end
+
+      # Migrate all funds from Shelley wallet.
+      # @see https://input-output-hk.github.io/cardano-wallet/api/#operation/migrateShelleyWallet
+      # @param wid [String] wallet id
+      # @param passphrase [String] wallet's passphrase
+      # @param [Array] array of addresses
+      def migrate(wid, passphrase, addresses)
+        self.class.post("/wallets/#{wid}/migrations",
+        :body => { :addresses => addresses,
+                   :passphrase => passphrase
+                 }.to_json,
+        :headers => { 'Content-Type' => 'application/json' } )
+      end
+
+    end
   end
 end

data/lib/cardano_wallet/version.rb

@@ -1,3 +1,3 @@
 module CardanoWallet
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano_wallet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-23 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bip_mnemonic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
+- ".github/workflows/nightly.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rakeTasks"
@@ -100,6 +115,8 @@ files:
 - bin/console
 - bin/setup
 - cardano_wallet.gemspec
+- dev
+- docker-compose-shelley.yml
 - docker-compose.yml
 - lib/cardano_wallet.rb
 - lib/cardano_wallet/base.rb