Steem Ruby Tutorial Wiki
Brought to you by:
krischik
Menu
▾
▴
Query specific rows from a Steem Engine Table
Repositories
SteemRubyTutorial
All examples from this tutorial can be found as fully functional scripts on GitHub:
- SteemRubyTutorial
- radiator sample code: Steem-Print-SSC-Table-All.rb.
radiator
- Project Name: Radiator
- Repository: https://github.com/inertia186/radiator
- Official Documentation: https://www.rubydoc.info/gems/radiator
- Official Tutorial: https://developers.steem.io/tutorials-ruby/getting_started
Steem Engine
- Project Name: Steem Engine
- Home Page: https://steem-engine.com
- Repository: https://github.com/harpagon210/steem-engine
- Official Documentation: https://github.com/harpagon210/sscjs (JavaScript only)
- Official Tutorial: N/A
What Will I Learn?
This tutorial shows how to interact with the Steem blockchain, Steem database and Steem Engine using Ruby. When accessing Steem Engine using Ruby their only one APIs available to chose: radiator.
In this particular chapter you learn how to read a create a query and return all row from the Steem Engine database tables which matches this query.
Requirements
Basic knowledge of Ruby programming is needed. It is necessary to install at least Ruby 2.5 as well as the following ruby gems:
gem install bundler
gem install colorize
gem install contracts
gem install radiator
Difficulty
For reader with programming experience this tutorial is basic level.
Tutorial Contents
Steem Engine allows users to add tokens and contacts to the steem block chain. Currently three predefined contracts are know: "tokens", "market", and "steempegged". Each contract has one or more database table to store their data. Currently 10 tables are known:
| Unique name | Contact | Table |
|---|---|---|
| market_buyBook | market | buyBook |
| market_metrics | market | metrics |
| market_sellBook | market | sellBook |
| market_tradesHistory | market | tradesHistory |
| steempegged_withdrawals | steempegged | withdrawals |
| tokens_balances | tokens | balances |
| tokens_contractsBalances | tokens | contractsBalances |
| tokens_params | tokens | params |
| tokens_pendingUnstakes | tokens | pendingUnstakes |
| tokens_tokens | tokens | tokens |
Implementation using radiator
As mentioned only radiator offers an API to access Steem Engine. For this radiator offerers a name space called Radiator::SSC. To access the database tables there are two methods: Contracts.find_one and Contracts.find. The former was described in the previous part of the tutorial.
Im this part of the tutorial Contracts.find is used to access a selection of rows of any table. The method has three mandatory parameters: contract, table and query and three optional parameter limit, offset and descending:
| parameter | description |
|---|---|
| contract | The name of the contract. |
| table | The name of the tables to query. |
| query | A list of column names and values. |
| limit | maximum amount of rows to be returned. |
| offset | offset of the first row to be returned. |
| descending | set order to ascending or descending. |
The amount of rows read from database in a single query. If the overall results exceeds this limit then additional queries are made to get the full result set. One thousand seem to be the standard for Steem queries.
Query_Limit = 1000
Read arguments from command line. There are two options:
- When two parameter are given then print all rows from a database table.
-
When more then two parameter are given then print the rows from database which match the criteria given.
:::ruby
_contract = ARGV.shift
_table = ARGV.shift
_query = {}while ARGV.length >= 2 do
# the query parameter is a hash table with column
# names as key and column values as value.
#
_query[ARGV.shift] = ARGV.shift
end
Steem Engine uses a simpler but more error prone numeric index to load the rows in batches. It's easier as only a numeric index is used to keep track of the start row. But it will lead to duplicate and missing rows when rows are added or deleted while iterating over the result set.
_current = 0
loop do
_rows = Contracts.find(
contract: _contract,
table: _table,
query: _query,
limit: Query_Limit,
offset: _current,
descending: false
)
# exit loop when no result set is returned
#
break if (not _rows) || (_rows.length == 0)
pp _rows
# Move current by the actual amount of rows returned
#
_current = _current + _rows.length
end
# at the end of the loop _current holds the total amount
# of rows returned. If nothing was found _current is 0.
#
if _current == 0 then
puts "No data found, possible reasons:".red + "
⑴ The contract doesn't exist
⑵ The table doesn't exist
⑶ The query doesn't match any rows
⑷ The table is empty"
else
puts "Found %1$d rows".green % _current
end
end
Hint: Follow this link to Github for the complete script with comments and syntax highlighting : Steem-Print-SSC-Table-All.rb.
A closer look at the results
The Steem-Print-SSC-Table-All.rb script is a quite powerfull script which allows for a large variety of queries.
The »params« table
The »params« table only contains a single row with the current price in STEEM for creating a new token which is currently 100 STEEM.
The »tokens« table
The »tokens« table contains the parameters of Steem Engine Token like the token distributed and maximum amount of token which can be distributed.
I have chosen the BEER token from @beerlover as it's the only token I hold.
The »balances« table
The »balances« table holds the current token in the users wallets. The balances can be queried by account and by token.
query balances by account name
To get all balances of an account you you query by column name account.
query balances by token
To get all balances of an account you query by column name symbol. For the sample query is further restricted by current balance of 10 token.
The »metrics« table
The »metrics« table holds the current value in STEEM of the token on the Steem Engine Market.
A future tutorial will show how to combine all these information to further improve Steem-Print-Balances.rb so that Steem Engine token held are be printed as well.
