Class: Privy::Resources::Wallets::Balance

Inherits:

Object

• Object
• Privy::Resources::Wallets::Balance

Defined in:

lib/privy/resources/wallets/balance.rb

Overview

Operations related to wallets

Instance Method Summary

• #get(wallet_id, token: nil, asset: nil, chain: nil, include_currency: nil, request_options: {}) ⇒ Privy::Models::Wallets::BalanceGetResponse

  Some parameter documentations has been truncated, see Models::Wallets::BalanceGetParams for more details.

• #initialize(client:) ⇒ Balance constructor private

  A new instance of Balance.

Constructor Details

#initialize(client:) ⇒ Balance

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Balance.

Parameters:

• client (Privy::Client)

# File 'lib/privy/resources/wallets/balance.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

#get(wallet_id, token: nil, asset: nil, chain: nil, include_currency: nil, request_options: {}) ⇒ Privy::Models::Wallets::BalanceGetResponse

Some parameter documentations has been truncated, see Models::Wallets::BalanceGetParams for more details.

Get the balance of a wallet by wallet ID.

Parameters:

• wallet_id (String) —

  ID of the wallet.

• token (String, Array<String>) —

  The token contract address(es) to query in format “chain:address” (e.g., “base:0

• asset (Symbol, Array<Symbol, Privy::Models::WalletAsset>, Privy::Models::Wallets::BalanceGetParams::Asset) —

  Named asset(s) to query (e.g. ‘eth`, `usdc`). Use together with `chain` to scope

• chain (Symbol, Array<Symbol, Privy::Models::Wallets::BalanceGetParams::Chain::UnionMember1>, Privy::Models::Wallets::BalanceGetParams::Chain) —

  Chain(s) to query named assets on (e.g. ‘base`, `ethereum`). Use together with `

• include_currency (Symbol, Privy::Models::Wallets::BalanceGetParams::IncludeCurrency) —

  If set, balances are converted to the specified fiat currency. Not supported whe

• request_options (Privy::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Privy::Models::Wallets::BalanceGetResponse)

See Also:

• Models::Wallets::BalanceGetParams

# File 'lib/privy/resources/wallets/balance.rb', line 30

def get(wallet_id, params = {})
  parsed, options = Privy::Wallets::BalanceGetParams.dump_request(params)
  query = Privy::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/wallets/%1$s/balance", wallet_id],
    query: query,
    model: Privy::Models::Wallets::BalanceGetResponse,
    options: options
  )
end