Module: Ordinals

Defined in:
lib/ordinals.rb,
lib/ordinals/api.rb,
lib/ordinals/cache.rb,
lib/ordinals/sandbox.rb,
lib/ordinals/version.rb

Defined Under Namespace

Classes: Api, Cache, Configuration, Sandbox

Constant Summary collapse

API =

add convenience alias

Api
MAJOR =

sync version w/ sport.db n friends - why? why not?

1
MINOR =

todo: namespace inside version or something - why? why not??

3
PATCH =
0
VERSION =
[MAJOR,MINOR,PATCH].join('.')

Class Method Summary collapse

Class Method Details



13
14
15
# File 'lib/ordinals/version.rb', line 13

def self.banner
  "ordinals/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in >#{root}<"
end

.btc?Boolean Also known as: bitcoin?, bitcon?

Returns:

  • (Boolean)


114
# File 'lib/ordinals.rb', line 114

def self.btc?()     config.chain == 'btc'; end

.chainObject



110
# File 'lib/ordinals.rb', line 110

def self.chain()       config.chain; end

.chain=(value) ⇒ Object



111
# File 'lib/ordinals.rb', line 111

def self.chain=(value) config.chain = value; end

.clientObject

add some convenience shortcut helpers (no config. required) - why? why not?



109
# File 'lib/ordinals.rb', line 109

def self.client()      config.client; end

.configObject



106
# File 'lib/ordinals.rb', line 106

def self.config()    @config ||= Configuration.new;  end

.configure {|config| ... } ⇒ Object

lets you use

Ordinals.configure do |config|
   config.chain = :btc
end

Yields:



105
# File 'lib/ordinals.rb', line 105

def self.configure() yield( config ); end

.content(num_or_id) ⇒ Object



132
# File 'lib/ordinals.rb', line 132

def self.content( num_or_id )                 client.content( num_or_id );     end

.doge?Boolean Also known as: dogecoin?, dogecon?

Returns:

  • (Boolean)


116
# File 'lib/ordinals.rb', line 116

def self.doge?()    config.chain == 'doge'; end

.inscription(num_or_id) ⇒ Object

more convenience shortcuts



131
# File 'lib/ordinals.rb', line 131

def self.inscription( num_or_id )             client.inscription( num_or_id ); end

.inscription_ids(offset:) ⇒ Object



134
# File 'lib/ordinals.rb', line 134

def self.inscription_ids( offset: )    client.inscription_ids( offset: offset ); end

.ltc?Boolean Also known as: litecoin?, litecon?

Returns:

  • (Boolean)


115
# File 'lib/ordinals.rb', line 115

def self.ltc?()     config.chain == 'ltc'; end

.rootObject



17
18
19
# File 'lib/ordinals/version.rb', line 17

def self.root
  File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
end

.sub10k_idsObject



135
# File 'lib/ordinals.rb', line 135

def self.sub10k_ids()                  client.sub10k_ids; end

.versionObject



9
10
11
# File 'lib/ordinals/version.rb', line 9

def self.version
  VERSION
end