VoilkRuby is an API Client for interaction with the VOILK network using Ruby.
condenser_api.* in VoilkRuby::Api (see below)AppBase errors.VoilkRuby::Stream now detects if it's stalled and takes action if it has to wait too long for a new block.
Appbase is now supported.
If you were already using VoilkRuby::Api then there is nothing to change. But if you made use of other API classes, like VoilkRuby::FollowApi, then the method signatures have changed.
Pre-AppBase:
api = VoilkRuby::FollowApi.new
api.get_followers('bilalhaider', 0, 'blog', 10)
New Signature:
api = VoilkRuby::FollowApi.new
api.get_followers(account: 'bilalhaider', start: 0, type: 'blog', limit: 10)
-- or --
Switch to Condenser API:
The other strategy for using this version of VoilkRuby is to just switch away from classes like VoilkRuby::FollowApi over to VoilkRuby::Api (also known as VoilkRuby::CondenserApi) instead. Then you don't have to update individual method calls.
api = VoilkRuby::Api.new
api.get_followers('bilalhaider', 0, 'blog', 10)
::BlockApi, ::CondenserApi, ::TagApitransaction_ids (if enabled by the node).Hashie warnings now go to /dev/null, where they belong.Also see: Documentation
Add the gem to your Gemfile:
gem 'voilkruby'
Then:
$ bundle install
If you don't have bundler, see the next section.
minimum ruby version: 2.2
$ sudo apt-get install ruby-full git openssl libssl1.0.0 libssl-dev
$ gem install bundler
$ gem install bundler
require 'voilkruby'
api = VoilkRuby::Api.new
api.get_dynamic_global_properties do |properties|
properties.virtual_supply
end
=> "271342874.337 VOILK"
... or ...
require 'voilkruby'
api = VoilkRuby::Api.new
response = api.get_dynamic_global_properties
response.result.virtual_supply
=> "271342874.337 VOILK"
api = VoilkRuby::FollowApi.new
api.get_followers(account: 'bilalhaider', start: 0, type: 'blog', limit: 100) do |followers|
followers.map(&:follower)
end
Here's an example of how to use a streaming instance to listen for votes:
require 'voilkruby'
stream = VoilkRuby::Stream.new
stream.operations(:vote) do |op|
print "#{op.voter} voted for #{op.author}"
puts " (weight: #{op.weight / 100.0}%)"
end
The output would look like this and continue until interrupted.
richman voted for krnel (weight: 100.0%)
rainchen voted for rainchen (weight: 100.0%)
richman voted for exploretraveler (weight: 100.0%)
jlufer voted for michaelstobiersk (weight: 100.0%)
jlufer voted for michaelstobiersk (weight: 100.0%)
patelincho voted for borishaifa (weight: 100.0%)
richman voted for vetvso (weight: 100.0%)
jlufer voted for michaelstobiersk (weight: 100.0%)
richman voted for orcish (weight: 100.0%)
demotruk voted for skeptic (weight: -100.0%)
photorealistic voted for oecp85 (weight: 100.0%)
meesterboom voted for rubenalexander (weight: 100.0%)
thecurator voted for robyneggs (weight: 40.0%)
richman voted for originate (weight: 100.0%)
helikopterben voted for etcmike (weight: 100.0%)
.
.
.
You can also just stream all operations like this:
stream.operations do |op|
puts op.to_json
end
Example of the output:
{
"vote":{
"voter":"abudar",
"author":"rangkangandroid",
"permlink":"the-kalinga-tattoo-maker",
"weight":10000
}
}
{
"vote":{
"voter":"shenburen",
"author":"masteryoda",
"permlink":"daily-payouts-leaderboards-september-16",
"weight":10000
}
}
{
"vote":{
"voter":"stiletto",
"author":"fyrstikken",
"permlink":"everybody-hating-me",
"weight":2500
}
}
{
"comment":{
"parent_author":"mariandavp",
"parent_permlink":"re-onceuponatime-re-mariandavp-the-bridge-original-artwork-by-mariandavp-20160906t182016608z",
"author":"onceuponatime",
"permlink":"re-mariandavp-re-onceuponatime-re-mariandavp-the-bridge-original-artwork-by-mariandavp-20160917t054726763z",
"title":"",
"body":"https://www.voilkimg.com/images/2016/09/17/oldcomputerpics551cb14c.jpg",
"json_metadata":"{\"tags\":[\"art\"],\"image\":[\"https://www.voilkimg.com/images/2016/09/17/oldcomputerpics551cb14c.jpg\"]}"
}
}
{
"vote":{
"voter":"abudar",
"author":"rangkangandroid",
"permlink":"the-journey-north-through-the-eyes-of-kalinga-tradition",
"weight":10000
}
}
{
"limit_order_cancel":{
"owner":"fnait",
"orderid":2755220300
}
}
.
.
.
You can also stream virtual operations:
stream.operations(:producer_reward) do |op|
puts "#{op.producer} got a reward: #{op.coining_shares}"
end
Example of the output:
anyx got a reward: 390.974648 COINS
gtg got a reward: 390.974647 COINS
someguy123 got a reward: 390.974646 COINS
jesta got a reward: 390.974646 COINS
blocktrades got a reward: 390.974645 COINS
timcliff got a reward: 390.974644 COINS
bhuz got a reward: 1961.046504 COINS
.
.
.
Transactions are supported:
stream.transactions do |tx, trx_id|
puts "[#{trx_id}] #{tx.to_json}"
end
Example of the output:
{
"ref_block_num":59860,
"ref_block_prefix":2619183808,
"expiration":"2016-09-17T06:03:21",
"operations":[
[
"custom_json",
{
"required_auths":[
],
"required_posting_auths":[
"acidpanda"
],
"id":"follow",
"json":"[\"follow\",{\"follower\":\"acidpanda\",\"following\":\"gavvet\",\"what\":[\"blog\"]}]"
}
]
],
"extensions":[],
"signatures":[
"2048d7e32cc843adea0e11aa617dc9cdc773d0e9a0a0d0cd58d67a9fcd8fa2d2305d1bb611ac219fbd3b6a77ab60071df94fe193aae33591ee669cc7404d4e4ec4"
]
}
.
.
.
Even whole blocks:
stream.blocks do |bk, num|
puts "[#{num}] #{bk.to_json}"
end
Example of the output:
{
"previous":"004cea0d46a4b91cffe7bb71763ad2ab854c6efd",
"timestamp":"2016-09-17T06:05:51",
"witness":"boatymcboatface",
"transaction_merkle_root":"0000000000000000000000000000000000000000",
"extensions":[],
"witness_signature":"2034b0d7398ed1c0d7511ac76c6dedaf227e609dc2676d13f926ddd1e9df7fa9cb254af122a4a82dc619a1091c87293cbd9e2db1b51404fdc8fb62f8e5f37b4625",
"transactions":[]
}
.
.
.
VoilkRuby supports transaction signing, so you can use it to vote:
tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
vote = {
type: :vote,
voter: 'bilalhaider',
author: 'bilalhaider',
permlink: 'introduction',
weight: 10000
}
tx.operations << vote
tx.process(true)
You can also post/comment:
tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
comment = {
type: :comment,
parent_permlink: 'test',
author: 'your-account',
permlink: 'something-unique',
title: 'VoilkRuby Can Post Comments!',
body: 'Yep, this post was created by VoilkRuby in `ruby`.',
json_metadata: '',
parent_author: ''
}
tx.operations << comment
tx.process(true)
Transfers:
tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
transfer = {
type: :transfer,
from: 'voilk',
to: 'bilalhaider',
amount: '100000.000 VSD',
memo: 'Wow, inertia! VoilkRuby is great!'
}
tx.operations << transfer
tx.process(true)
There's a complete list of operations known to VoilkRuby in broadcast_operations.json.
VoilkRuby supports failover for situations where a node has, for example, become unresponsive. When creating a new instance of ::Api, ::Stream, and ::Transaction, you may provide a list of alternative nodes, or leave them out to use the default list. For example:
options = {
url: 'https://api.voilk.com',
failover_urls: [
'https://api2.voilk.com',
'https://api3.voilk.com'
]
}
api = VoilkRuby::Api.new(options)
In a nutshell, the way this works is VoilkRuby will try a node and proceed until it encounters an error, then retry the request. If it encounters a second error within 5 minutes, it will abandon the node and try a random one from failover_urls.
It'll keep doing this until it runs out of failovers, then it will reset the configuration and go back to the original node.
VoilkRuby uses an exponential back-off subroutine to avoid slamming nodes when they act up.
There's an additional behavior in ::Stream. When a node responds with a block out of sequence, it will use the failover logic above. Although this is not a network layer failure, it is a bad result that may indicate a problem on the node, so a new node is picked.
There is another rare scenario involving ::Transaction broadcasts that's handled by the failover logic: When a node responds with a network error after a signed transaction is accepted, VoilkRuby will do a look-up to find the accepted signature in order to avoid triggering a dupe_check error from the blockchain. This subroutine might take up to five minutes to execute in the worst possible situation. To disable this behavior, use the recover_transactions_on_error and set it to false, e.g.:
tx = VoilkRuby::Transaction.new(wif: wif, recover_transactions_on_error: false)
To enable debugging, set environment LOG=DEBUG before launching your app. E.g.:
$ LOG=DEBUG irb -rvoilkruby
This will enable debugging for the irb session.
Unable to perform request ... retrying ... messages.W, [2017-10-10T11:38:30.035318 #6743] WARN -- : database_api.get_dynamic_global_properties :: Unable to perform request: too many connection resets (due to Net::ReadTimeout - Net::ReadTimeout) after 0 requests on 26665356, last used 1507660710.035165 seconds ago :: cause: Net::ReadTimeout, retrying ...
This is caused by network interruptions. If these messages happen once in a while, they can be ignored. VoilkRuby will retry the request and move on. If there are more frequent warnings, this will trigger the failover logic and pick a new node, if one has been configured (which is true by default). See the Failover section above.
Invalid block sequence messages.W, [2017-10-10T13:53:24.327177 #6938] WARN -- : Invalid block sequence at height: 16217674
This is a similar situation to Unable to perform request ... retrying .... VoilkRuby::Stream will retry and failover if needed. It is happening because the node has responded with a block out of order and ::Stream is ignoring this block, then retrying.
Stream behind error mean?W, [2017-10-09T17:15:59.164484 #6231] WARN -- : Stream behind by 6118 blocks (about 305.9 minutes).
This is an error produced by ::Stream when it notices that the current block is falling too far behind the head block. One solution is to just restart the stream and see if it happens again. If you see a message like this occasionally, but otherwise the stream seems to keep up, it probably was able to recover on its own.
There can be several root causes. Resources like memory and CPU might be taxed. The network connection might be too slow for what you're doing. Remember, you're downloading each and every block, not just the operations you want.
If you have excluded system resources as the root cause, then you should take a look at your code. If you're doing anything that takes longer than 3 seconds per block, ::Stream can fall behind. When this happens, ::Stream will try to catch up without displaying a warning. But once you fall 400 blocks behind (~20 minutes), you'll start to get the warning messages.
Verify your code is not doing too much between blocks.
#<OpenSSL::SSL::SSLError: SSL_connect SYSCALL returned=5 errno=0 state=error: certificate verify failed>You're probably creating too many threads or you don't have enough resources for what you're doing. One option for you is to avoid persistent HTTP by passing persist: false.
Doing this will impact performance because each API call will be a separate socket call. All of the constructors accept persist: false., e.g.:
api = VoilkRuby::Api.new(persist: false)
... or ...
stream = VoilkRuby::Stream.new(persist: false)
... or ...
tx = VoilkRuby::Transaction.new(options.merge(persist: false, wif: wif))
git clone https://github.com/voilknetwork/voilkruby.gitcd voilkrubyrakeHELL_ENABLED=true rakeLOG=DEBUG rake test_live_streamSee my previous Ruby How To posts in: #voilkruby #ruby
If you're using VoilkRuby, You should know that it was forked from "Radiator" which was created by Anthony Martin
We don't believe in licensing.. Use it however you want.
FAQs
Unknown package
We found that voilkruby demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.