b58 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43c014be31ac7d77ecba9426b5037e3d942029dea3c82c5e8f47b6b7bc7fcdd6
+  data.tar.gz: e8a762b838821958110908c7e03254a014cbe4fcee3172a868ad4e671b0d1825
+SHA512:
+  metadata.gz: 9a65ea0ac061923d16c7f7a6e766dcc34bd9d791a3a7eabd9cdeced4cf56528383a11ded5a9454cebafaf067b8fc41822be4d19594bb18f3c9b1ecc8b4d63f64
+  data.tar.gz: 51cd54e9b36c5d030d4943ce2eac39d9ed0be5ad66c8636a474a3b0a856ef165748d34c5dbbde43f830b32553d35d26d4be7341bc5b712f7c68fabf83f52ee58

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ext/libbase58"]
+	path = ext/libbase58
+	url = https://github.com/luke-jr/libbase58

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at i.kerseymer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in b58.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    b58 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  b58!
+  rake (~> 12.0)
+  rake-compiler
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ian Ker-Seymer
+
+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,44 @@
+# Base58
+
+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/b58`. 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 'b58'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install b58
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/ianks/b58. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ianks/b58/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Base58 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ianks/b58/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("b58") do |ext|
+  ext.lib_dir = "lib/b58"
+end
+
+task :default => [:clobber, :compile, :spec]

data/b58.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/b58/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "b58"
+  spec.version       = Base58::VERSION
+  spec.authors       = ["Ian Ker-Seymer"]
+  spec.email         = ["i.kerseymer@gmail.com"]
+
+  spec.summary       = %q{A base58 encoder for Ruby}
+  spec.description   = %q{Uses libbase58 to encode Ruby strings to base58}
+  spec.homepage      = "https://github.com/ianks/b58"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) do
+    `git ls-files --recurse-submodules -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|tests)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/b58/extconf.rb"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "b58"
+
+# 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/ext/b58/b58.c

@@ -0,0 +1,126 @@
+#include "b58.h"
+#include "./../libbase58/base58.c"
+
+#include <openssl/sha.h>
+#include <stdbool.h>
+#include <unistd.h>
+
+VALUE rb_mBase58;
+VALUE rb_mBase58_Error;
+VALUE rb_mBase58_EncodeError;
+VALUE rb_mBase58_DecodeError;
+
+static bool my_sha256(void *md, const void *input, size_t length) {
+  SHA256_CTX context;
+  if (!SHA256_Init(&context))
+    return false;
+
+  if (!SHA256_Update(&context, (unsigned char *)input, length))
+    return false;
+
+  if (!SHA256_Final(md, &context))
+    return false;
+
+  return true;
+}
+
+VALUE rb_mBase58_decode_58(VALUE self, VALUE str) {
+  Check_Type(str, T_STRING);
+
+  size_t input_size;
+  input_size = RSTRING_LEN(str);
+
+  size_t output_size;
+  output_size = input_size * 733 / 1000 + 1;
+
+  char outbuf[output_size];
+  char *plaintxt;
+
+  plaintxt = RSTRING_PTR(str);
+
+  bool rv;
+
+  rv = b58tobin(outbuf, &output_size, plaintxt, input_size);
+
+  if (!rv) {
+    rb_raise(rb_mBase58_EncodeError, "Could not encode string in base58");
+    return Qnil;
+  }
+
+  // Account for null termination
+  VALUE outstring;
+  outstring = rb_str_new(outbuf, output_size);
+  return outstring;
+}
+
+VALUE rb_mBase58_encode_58(VALUE self, VALUE str) {
+  Check_Type(str, T_STRING);
+
+  size_t input_size;
+  input_size = RSTRING_LEN(str);
+
+  size_t output_size;
+  output_size = input_size * 2;
+
+  char outbuf[output_size];
+  char *plaintxt;
+
+  plaintxt = RSTRING_PTR(str);
+
+  bool rv;
+
+  rv = b58enc(outbuf, &output_size, plaintxt, input_size);
+
+  if (!rv) {
+    rb_raise(rb_mBase58_EncodeError, "Could not encode string in base58");
+    return Qnil;
+  }
+
+  // Account for null termination
+  return rb_str_new(outbuf, output_size - 1);
+}
+
+VALUE rb_mBase58_check_58(VALUE self, VALUE str) {
+  Check_Type(str, T_STRING);
+
+  size_t input_size;
+  input_size = RSTRING_LEN(str);
+
+  size_t output_size;
+  output_size = input_size * 2;
+
+  char outbuf[output_size];
+
+  char *plaintxt;
+  plaintxt = RSTRING_PTR(str);
+
+  int version;
+  version = plaintxt[0];
+
+  bool rv;
+
+  rv =
+      b58check_enc(outbuf, &output_size, version, &plaintxt[1], input_size - 1);
+
+  if (rv) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+void Init_b58(void) {
+  b58_sha256_impl = my_sha256;
+
+  rb_mBase58 = rb_define_module("Base58");
+  rb_mBase58_Error =
+      rb_define_class_under(rb_mBase58, "Error", rb_eStandardError);
+  rb_mBase58_EncodeError =
+      rb_define_class_under(rb_mBase58, "EncodeError", rb_mBase58_Error);
+  rb_mBase58_DecodeError =
+      rb_define_class_under(rb_mBase58, "EncodeError", rb_mBase58_Error);
+
+  rb_define_module_function(rb_mBase58, "encode_58", rb_mBase58_encode_58, 1);
+  rb_define_module_function(rb_mBase58, "decode_58", rb_mBase58_decode_58, 1);
+  rb_define_module_function(rb_mBase58, "check_58", rb_mBase58_check_58, 1);
+}

data/ext/b58/b58.h

@@ -0,0 +1,6 @@
+#ifndef BASE_58_H
+#define BASE_58_H 1
+
+#include "ruby.h"
+
+#endif /* BASE_58_H */

data/ext/b58/extconf.rb

@@ -0,0 +1,14 @@
+require "mkmf"
+
+$CFLAGS << " -std=c99 -Wno-declaration-after-statement"
+
+have_library('crypto')
+have_library('base58')
+
+have_header("stdbool.h")
+have_header("unistd.h")
+have_header('openssl/sha.h')
+
+dir_config "b58"
+
+create_makefile("b58/b58")