Class: CardanoWallet::Shared::Wallets

Inherits:

Base

• Object
• Base
• CardanoWallet::Shared::Wallets

Defined in:

lib/cardano_wallet/shared.rb

Overview

API for Wallets

Examples:

@cw = CardanoWallet.new
@cw.shared.wallets # API for Shared Wallets

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#tag/Shared-Wallets

Instance Attribute Summary

Attributes inherited from Base

#opt

Instance Method Summary

• #create(params) ⇒ Object

  Create a wallet based on the params.

• #delete(wid) ⇒ Object

  Delete wallet.

• #get(wid) ⇒ Object

  Get wallet details.

• #list ⇒ Object

  List all wallets.

• #update_delegation_script(wid, cosigner, acc_pub_key) ⇒ Object

  Update delegation script.

• #update_payment_script(wid, cosigner, acc_pub_key) ⇒ Object

  Update payment script.

Methods inherited from Base

#byron, #initialize, #misc, #shared, #shelley, #utils

Constructor Details

This class inherits a constructor from CardanoWallet::Base

Instance Method Details

#create(params) ⇒ Object

Create a wallet based on the params.

Examples:

Create wallet from mnemonic sentence

create({name: "Wallet from mnemonic_sentence",
        passphrase: "Secure Passphrase",
        mnemonic_sentence: %w[story egg fun ... ],
        account_index: "1852H",
        payment_script_template: {...},
        ...
       })

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/postSharedWallet

# File 'lib/cardano_wallet/shared.rb', line 188

def create(params)
  Utils.verify_param_is_hash!(params)
  self.class.post('/shared-wallets',
                  body: params.to_json,
                  headers: { 'Content-Type' => 'application/json' })
end

#delete(wid) ⇒ Object

Delete wallet

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/deleteSharedWallet

# File 'lib/cardano_wallet/shared.rb', line 197

def delete(wid)
  self.class.delete("/shared-wallets/#{wid}")
end

#get(wid) ⇒ Object

Get wallet details

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/getSharedWallet

# File 'lib/cardano_wallet/shared.rb', line 173

def get(wid)
  self.class.get("/shared-wallets/#{wid}")
end

#list ⇒ Object

List all wallets

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listSharedWallets

# File 'lib/cardano_wallet/shared.rb', line 167

def list
  self.class.get('/shared-wallets')
end

#update_delegation_script(wid, cosigner, acc_pub_key) ⇒ Object

Update delegation script

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/patchSharedWalletInDelegation

# File 'lib/cardano_wallet/shared.rb', line 211

def update_delegation_script(wid, cosigner, acc_pub_key)
  self.class.patch("/shared-wallets/#{wid}/delegation-script-template",
                   body: { cosigner => acc_pub_key }.to_json,
                   headers: { 'Content-Type' => 'application/json' })
end

#update_payment_script(wid, cosigner, acc_pub_key) ⇒ Object

Update payment script

See Also:

• https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/patchSharedWalletInPayment

# File 'lib/cardano_wallet/shared.rb', line 203

def update_payment_script(wid, cosigner, acc_pub_key)
  self.class.patch("/shared-wallets/#{wid}/payment-script-template",
                   body: { cosigner => acc_pub_key }.to_json,
                   headers: { 'Content-Type' => 'application/json' })
end