class Onchain

Handles all transactions via Onchain

Public Instance Methods

generate_address(customer_email) click to toggle source

Generates a temporary address for onchain transaction

  • Required Function Parameters: customer_email

# File lib/bitnob/objects/onchain.rb, line 33
def generate_address(customer_email)
  body = { customerEmail: customer_email }
  payload = body.to_json
  post_request("#{base_url}#{BaseEndpoints::ADDRESS}/generate", payload)
end
list_addresses(page_number=1, limit=10) click to toggle source

Returns a JSON data containing list of addresses

  • Required Function Parameters: page_number limit

    default: <tt>page_number => 1, limit => 10</tt>
# File lib/bitnob/objects/onchain.rb, line 45
def list_addresses(page_number=1, limit=10)
  get_request("#{base_url}#{BaseEndpoints::ADDRESS}order=ASC&page=#{page_number}&take=#{limit}")
end
send_bitcoin(data) click to toggle source

Onchain sending of bitcoin

  • Required Function Parameters:

       data: {
    satoshis: number,
    customerEmail: string,
    address: string,
    priorityLevel: string
     }
  • Priority level is used to detect how long a transaction would take. Its default is regular

# File lib/bitnob/objects/onchain.rb, line 22
def send_bitcoin(data)
  required_parameters = %w[satoshis customerEmail address]

  checked_passed_parameters(required_parameters, data)
  payload = data.to_json
  post_request("#{base_url}#{BaseEndpoints::ONCHAIN}/send_bitcoin", payload)
end