bitcoin_unit_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 898fa8312f0e20d0e86d2f3676d390344ba8688c6b4070f9c9b298844ca5fbdc
+  data.tar.gz: b3a14f2307241d9084c3f84ee13af5b2683f4250d62349ca42072aaa9f80a964
+SHA512:
+  metadata.gz: d7bf6ae8a0b71be3f0a2ae79f0518aa4bcecec6ba477f30efc378c181b136c8ff14f8c4a9c1ac6630bf5c04c63c7c05ab776414548ea1272a536643f20abd87f
+  data.tar.gz: 5bcd019b00412484ad5e1b556d47d7d62a6658fd514e5f5706c24f4c92ed0d559d7bfe71a3a91eed7480897bc813a53f428f5c656ea5a58958194e698fa838f1

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bitcoin_unit_converter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    bitcoin_unit_converter (0.1.0)
+      bigdecimal (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    bigdecimal (3.1.2)
+    builder (3.2.4)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.6)
+    ruby-progressbar (1.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitcoin_unit_converter!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.5)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# BitcoinUnitConverter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bitcoin_unit_converter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitcoin_unit_converter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bitcoin_unit_converter
+
+## Usage
+### Convert from unit to unit
+```ruby
+# BitcoinUnitConverter.convert(amount, unit = 'sat', to_unit = 'btc')
+BitcoinUnitConverter.convert(100_000_000, 'sat', 'btc') # '1'
+BitcoinUnitConverter.convert(1, 'sat', 'btc') # '0.00000001'
+BitcoinUnitConverter.convert(1, 'btc', 'uBTC') # '1000000'
+```
+### Supported Units
+```ruby
+  UNITS = {
+    'sat': 1,
+    'Satoshi': 1,
+    'uBTC': 100, # MicroBit
+    'ubtc': 100, # MicroBit
+    'mBTC': 100_000, # Milibit
+    'mbtc': 100_000, # Milibit
+    'cBTC': 1_000_000, # Bitcent
+    'cbtc': 1_000_000, # Bitcent
+    'dBTC': 10_000_000, # deciBitcoin
+    'dbtc': 10_000_000, # deciBitcoin
+    'BTC': 100_000_000,
+    'btc': 100_000_000,
+    'daBTC': 10_000_000, # decaBitcoin
+    'dabtc': 1_000_000_000 # decaBitcoin
+  }
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bitcoin_unit_converter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bitcoin_unit_converter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitcoin_unit_converter.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/bitcoin_unit_converter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = 'bitcoin_unit_converter'
+  spec.version = BitcoinUnitConverter::VERSION
+  spec.authors = ['Serigne Mouhamadou Bassirou Diaby']
+  spec.email = ['bayevels@gmail.com']
+
+  spec.summary = 'Bitcoin unit converter in Ruby'
+  spec.homepage = 'https://github.com/bayevels/bitcoin_unit_converter'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
+  spec.metadata = {
+    'documentation_uri' => spec.homepage.to_s,
+    'homepage_uri' => spec.homepage.to_s,
+    'source_code_uri' => spec.homepage.to_s
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bigdecimal', '~> 3.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/lib/bitcoin_unit_converter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BitcoinUnitConverter
+  VERSION = "0.1.0"
+end

data/lib/bitcoin_unit_converter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'bitcoin_unit_converter/version'
+require 'bigdecimal'
+
+module BitcoinUnitConverter
+  # Later add more units https://www.cryps.info/en/BTC_to_Satoshi/1/
+  UNITS = {
+    'sat': 1,
+    'Satoshi': 1,
+    'uBTC': 100, # MicroBit
+    'ubtc': 100, # MicroBit
+    'mBTC': 100_000, # Milibit
+    'mbtc': 100_000, # Milibit
+    'cBTC': 1_000_000, # Bitcent
+    'cbtc': 1_000_000, # Bitcent
+    'dBTC': 10_000_000, # deciBitcoin
+    'dbtc': 10_000_000, # deciBitcoin
+    'BTC': 100_000_000,
+    'btc': 100_000_000,
+    'daBTC': 10_000_000, # decaBitcoin
+    'dabtc': 1_000_000_000 # decaBitcoin
+  }.freeze
+
+  class << self
+    def convert(amount, unit = 'sat', to_unit = 'btc')
+      return nil if amount.nil?
+
+      return from_sat(amount, to_unit).to_s('F').delete_suffix('.0') if unit == 'sat'
+
+      from_sat(to_sat(amount, unit), to_unit).to_s('F').delete_suffix('.0')
+    end
+
+    def to_sat(amount, unit = 'btc')
+      return nil if amount.nil?
+
+      begin
+        BigDecimal(UNITS[unit.to_sym] * amount, 16)
+      rescue StandardError => e
+        raise e.class
+      end
+    end
+
+    def from_sat(amount, unit = 'btc')
+      return nil if amount.nil?
+
+      begin
+        (BigDecimal(amount, 16) / BigDecimal(UNITS[unit.to_sym], 16))
+      rescue StandardError => e
+        raise e.class
+      end
+    end
+  end
+end

data/sig/bitcoin_unit_converter.rbs

@@ -0,0 +1,4 @@
+module BitcoinUnitConverter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bitcoin_unit_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serigne Mouhamadou Bassirou Diaby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email:
+- bayevels@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitcoin_unit_converter.gemspec
+- lib/bitcoin_unit_converter.rb
+- lib/bitcoin_unit_converter/version.rb
+- sig/bitcoin_unit_converter.rbs
+homepage: https://github.com/bayevels/bitcoin_unit_converter
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://github.com/bayevels/bitcoin_unit_converter
+  homepage_uri: https://github.com/bayevels/bitcoin_unit_converter
+  source_code_uri: https://github.com/bayevels/bitcoin_unit_converter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Bitcoin unit converter in Ruby
+test_files: []