class Nem::Endpoint::Account

Public Instance Methods

find(address) click to toggle source

@param [String] address @return [Nem::Model::Account] @see nemproject.github.io/#requesting-the-account-data

# File lib/nem/endpoint/account.rb, line 15
def find(address)
  request!(:get, '/account/get',
    address: address
  ) do |res|
    Nem::Model::Account.new_from_account_meta_data_pair(res)
  end
end
Also aliased as: get
find_by_public_key(public_key) click to toggle source

@param [String] public_key @return [Nem::Model::Account] @see nemproject.github.io/#requesting-the-account-data

# File lib/nem/endpoint/account.rb, line 28
def find_by_public_key(public_key)
  request!(:get, '/account/get/from-public-key',
    publicKey: public_key
  ) do |res|
    Nem::Model::Account.new_from_account_meta_data_pair(res)
  end
end
find_forwarded(address) click to toggle source

@param [String] address @return [Nem::Model::Account] @see nemproject.github.io/#requesting-the-original-account-data-for-a-delegate-account

# File lib/nem/endpoint/account.rb, line 39
def find_forwarded(address)
  request!(:get, '/account/get/forwarded',
    address: address
  ) do |res|
    Nem::Model::Account.new_from_account_meta_data_pair(res)
  end
end
find_forwarded_by_public_key(public_key) click to toggle source

@param [String] public_key @return [Nem::Model::Account] @see nemproject.github.io/#requesting-the-original-account-data-for-a-delegate-account

# File lib/nem/endpoint/account.rb, line 50
def find_forwarded_by_public_key(public_key)
  request!(:get, '/account/get/forwarded/from-public-key',
    publicKey: public_key
  ) do |res|
    Nem::Model::Account.new_from_account_meta_data_pair(res)
  end
end
generate() click to toggle source

@return [Nem::Model::Keypair] @see nemproject.github.io/#generating-new-account-data

# File lib/nem/endpoint/account.rb, line 6
def generate
  request!(:get, '/account/generate') do |res|
    Nem::Model::Keypair.new_from_key_pair_view_model(res)
  end
end
get(address)
Alias for: find
harvests(address, hash: nil) click to toggle source

@param [String] address @param [String] hash @return [Array <Nem::Model::Harvest>] @see nemproject.github.io/#requesting-harvest-info-data-for-an-account

# File lib/nem/endpoint/account.rb, line 62
def harvests(address, hash: nil)
  request!(:get, '/account/harvests',
    address: address,
    hash: hash
  ) do |res|
    res[:data].map do |harvest|
      Nem::Model::Harvest.new_from_harvest(harvest)
    end
  end
end
historical(address, start_height: nil, end_height: nil, increment: nil) click to toggle source

@param [String] address @param [Integer] start_height @param [Integer] end_height @param [Integer] increment @return [Array <Nem::Model::AccountHistorical>] @see nemproject.github.io/#retrieving-historical-account-data

# File lib/nem/endpoint/account.rb, line 89
def historical(address, start_height: nil, end_height: nil, increment: nil)
  request!(:get, '/account/historical/get',
    address: address,
    startHeight: start_height,
    endHeight: end_height,
    increment: increment
  ) do |res|
    res[:data].map do |ah|
      Nem::Model::AccountHistorical.new_from_account_historical(ah)
    end
  end
end
importances() click to toggle source

@return [Array <Nem::Model::Importance>] @see nemproject.github.io/#retrieving-account-importances-for-accounts

# File lib/nem/endpoint/account.rb, line 75
def importances
  request!(:get, '/account/importances') do |res|
    res[:data].map do |aivm|
      Nem::Model::Importance.new_from_account_importance_view_model(aivm)
    end
  end
end
lock(private_key) click to toggle source

@param private_key [String] @return [nil] @see nemproject.github.io/#locking-and-unlocking-accounts

# File lib/nem/endpoint/account.rb, line 156
def lock(private_key)
  request!(:post, '/account/lock', value: private_key)
end
mosaic_definition(address, parent: nil, id: nil) click to toggle source

@param [String] address @param [String] parent @param [String] id @return [Array <Nem::Model::MosaicDefinition>] @see nemproject.github.io/##retrieving-mosaic-definitions-that-an-account-has-created

# File lib/nem/endpoint/account.rb, line 107
def mosaic_definition(address, parent: nil, id: nil)
  request!(:get, '/account/mosaic/definition/page',
    address: address,
    parent: parent,
    id: id,
  ) do |res|
    res[:data].map do |modef|
      Nem::Model::MosaicDefinition.new_from_mosaic_definition(modef)
    end
  end
end
mosaic_owned(address) click to toggle source

@param [String] address @return [Array <Nem::Model::AccountMetaDataPair>] @see nemproject.github.io/#retrieving-mosaics-that-an-account-owns

# File lib/nem/endpoint/account.rb, line 122
def mosaic_owned(address)
  request!(:get, '/account/mosaic/owned', address: address) do |res|
    Nem::Model::MosaicCollection.new(
      res[:data].map { |moa| Nem::Model::Mosaic.new_from_mosaic(moa) }
    )
  end
end
namespace(address, parent: nil) click to toggle source

@param [String] address @param [String] parent @param [String] id @param [Integer] page_size @return [Array <Nem::Model::Namespace>] @see nemproject.github.io/#retrieving-namespaces-that-an-account-owns

# File lib/nem/endpoint/account.rb, line 136
def namespace(address, parent: nil)
  request!(:get, '/account/namespace/page', address: address, parent: parent) do |res|
    res[:data].map do |ns|
      Nem::Model::Namespace.new_from_namespace(ns)
    end
  end
end
status(address) click to toggle source

@param [String] address @return [Nem::Model::Account] @see nemproject.github.io/#requesting-the-account-status

# File lib/nem/endpoint/account.rb, line 147
def status(address)
  request!(:get, '/account/status', address: address) do |res|
    Nem::Model::Account.new_from_account_meta_data(res)
  end
end
transfers(address, hash: nil, id: nil, page_size: nil, dir: :all) click to toggle source

@param [String] address @param [String] hash @param [String] id @param [Symbol] dir direction(:in, :out, :unconfirmed, :all) @param [Integer] page_size @return [Array <Nem::Model::TransactionMetaDataPair>] @see nemproject.github.io/#requesting-transaction-data-for-an-account

# File lib/nem/endpoint/account.rb, line 254
def transfers(address, hash: nil, id: nil, page_size: nil, dir: :all)
  case dir.to_s
  when /\Ain/  then transfers_incoming(address, hash, id, page_size)
  when /\Aout/ then transfers_outgoing(address, hash, id, page_size)
  when /\Aunconfirmed/ then transfers_unconfirmed(address)
  else transfers_all(address, hash, id, page_size)
  end
end
transfers_all(address, hash: nil, id: nil, page_size: nil) click to toggle source

@param [String] address @param [String] hash @param [String] id @param [Integer] page_size @return [Array <Nem::Model::Transaction>] @see nemproject.github.io/#requesting-transaction-data-for-an-account

# File lib/nem/endpoint/account.rb, line 219
def transfers_all(address, hash: nil, id: nil, page_size: nil)
  request!(:get, '/account/transfers/all',
    address: address,
    hash: hash,
    id: id,
    pageSize: page_size
  ) do |res|
    res[:data].map do |tx|
      Nem::Model::Transaction.new_from_account_transaction_meta_data_pair(tx)
    end
  end
end
transfers_incoming(address, hash: nil, id: nil, page_size: nil) click to toggle source

@param [String] address @param [String] hash @param [String] id @param [Integer] page_size @return [Array <Nem::Model::Transaction>] @see nemproject.github.io/#requesting-transaction-data-for-an-account

# File lib/nem/endpoint/account.rb, line 181
def transfers_incoming(address, hash: nil, id: nil, page_size: nil)
  request!(:get, '/account/transfers/incoming',
    address: address,
    hash: hash,
    id: id,
    pageSize: page_size
  ) do |res|
    res[:data].map do |tx|
      Nem::Model::Transaction.new_from_account_transaction_meta_data_pair(tx)
    end
  end
end
transfers_outgoing(address, hash: nil, id: nil, page_size: nil) click to toggle source

@param [String] address @param [String] hash @param [String] id @param [Integer] page_size @return [Array <Nem::Model::Transaction>] @see nemproject.github.io/#requesting-transaction-data-for-an-account

# File lib/nem/endpoint/account.rb, line 200
def transfers_outgoing(address, hash: nil, id: nil, page_size: nil)
  request!(:get, '/account/transfers/outgoing',
    address: address,
    hash: hash,
    id: id,
    pageSize: page_size
  ) do |res|
    res[:data].map do |tx|
      Nem::Model::Transaction.new_from_account_transaction_meta_data_pair(tx)
    end
  end
end
transfers_unconfirmed(address)
unconfirmed_transactions(address) click to toggle source

@param [String] address @return [Array <Nem::Model::Transaction>] @see nemproject.github.io/#requesting-transaction-data-for-an-account

# File lib/nem/endpoint/account.rb, line 235
def unconfirmed_transactions(address)
  request!(:get, '/account/unconfirmedTransactions',
    address: address
  ) do |res|
    res[:data].map do |tx|
      Nem::Model::Transaction.new_from_account_transaction_meta_data_pair(tx)
    end
  end
end
Also aliased as: transfers_unconfirmed
unlock(private_key) click to toggle source

@param [String] private_key @return [nil] @see nemproject.github.io/#locking-and-unlocking-accounts

# File lib/nem/endpoint/account.rb, line 163
def unlock(private_key)
  request!(:post, '/account/unlock', value: private_key)
end
unlocked_info() click to toggle source

@return [Nem::Model::UnlockedInfo] @see nemproject.github.io/#retrieving-the-unlock-info

# File lib/nem/endpoint/account.rb, line 169
def unlocked_info
  request!(:post, '/account/unlocked/info') do |res|
    Nem::Model::UnlockedInfo.new_from_unlocked_info(res)
  end
end