nano-wallet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3db8f1753de79240814f36972966648273cfc1a02ff8c2752f900ea0146fa100
+  data.tar.gz: d5a408021d294144e89207e595eaa0a18c99c042b8a179b7456e103b119bb086
+SHA512:
+  metadata.gz: 9d18a43d6e746482e36fb68f20daac6ca7c919b0a22aa4d145aa9fb907ed76e87d37dfe5fb23d2bd75cb56f8760dc1de612e4e50b7e1977cb83e091a5b44e4c0
+  data.tar.gz: e41ef71ebd1165c75c35a3ac4793a4eb472f2865c0a3b47b297a5d16de67eb4e4e5ec43798129da3f653d029766deb85049b7d02a26bb4007a138eaf36aa7f83

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+output*
+test.rb
+Gemfile.lock

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 meltingice8917@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nano-wallet.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kitepay
+
+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,94 @@
+# Nano::Wallet
+
+A library for creating and managing a wallet for the Nano cryptocurrency, offline. Lets you securely generate a seed and its corresponding accounts and keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nano-wallet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nano-wallet
+
+## Usage
+
+### Nano::Wallet
+
+Used for managing a collection of accounts that belong to a seed.
+
+```ruby
+# Create a new wallet with a securely generated random seed
+wallet = Nano::Wallet.with_random_seed
+
+seed = "DFE531F385024EF302B8284A0AFC380E948D7DDE3FFFBD9F83F064B4823A8F6F"
+
+# Create a wallet with the given seed
+wallet = Nano::Wallet.new(seed)
+
+# Add an account to the wallet
+wallet.add_account!
+
+# Add multiple accounts to the wallet
+# .add_accounts(count)
+wallet.add_accounts!(10_000)
+
+# Retrieve generated accounts
+wallet.accounts
+
+# Retrieve an account at the given wallet index
+# .account_at_index(index)
+wallet.account_at_index(1974903)
+```
+
+### Nano::Account
+
+Represents an account at the given index for the wallet's seed. Typically accessed through `Nano::Wallet` but can be used on its own as well.
+
+Private and public keys are returned encoded as a binary string, due to how Ruby works. If you wish to convert them to a more human readable hex format, you can use `Nano::Util.bin_to_hex()`.
+
+```ruby
+# .new(seed, [index])
+account = Nano::Account.new(seed, 0)
+
+# Retrieve the account keys
+priv_key = account.private_key
+pub_key = account.public_key
+
+# Human readable format
+Nano::Util.bin_to_hex(priv_key)
+Nano::Util.bin_to_hex(pub_key)
+
+# The encoded address typically used
+# .address([prefix])
+account.address
+
+# You can also set the address prefix
+account.address('nano')
+account.address('ban')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/Kitepay/nano-wallet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Nano::Wallet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Kitepay/nano-wallet/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nano/wallet"
+
+# 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/lib/nano/wallet.rb

@@ -0,0 +1,31 @@
+require_relative "wallet/version"
+require_relative "wallet/account"
+
+module Nano
+  class Wallet
+    def self.with_random_seed
+      self.new(SecureRandom.hex(32))
+    end
+
+    attr_reader :accounts
+
+    def initialize(seed)
+      @seed = seed
+      @accounts = []
+    end
+
+    def account_at_index(index)
+      Nano::Account.new(@seed, index)
+    end
+
+    def add_accounts!(count)
+      count.times { add_account! }
+    end
+
+    def add_account!
+      account = Nano::Account.new(@seed, @accounts.size)
+      @accounts << account
+      account
+    end
+  end
+end

data/lib/nano/wallet/account.rb

@@ -0,0 +1,27 @@
+require "blake2b"
+require "ed25519_blake2b"
+
+require_relative "util"
+
+module Nano
+  class Account
+    def initialize(seed, index = 0)
+      @seed = seed
+      @seed_bin = Util.hex_to_bin(@seed)
+      @index = index
+    end
+
+    def private_key
+      Util.hex_to_bin(Blake2b.hex(@seed_bin + [@index].pack('L>'), Blake2b::Key.none, 32))
+    end
+
+    def public_key
+      Ed25519Blake2b.public_key(private_key)
+    end
+
+    def address(prefix = "xrb")
+      Util.public_key_to_address(prefix, public_key)
+    end
+    alias_method :to_s, :address
+  end
+end

data/lib/nano/wallet/util.rb

@@ -0,0 +1,48 @@
+module Nano
+  module Util
+    ALLOWED_CHARS = '13456789abcdefghijkmnopqrstuwxyz'.freeze
+
+    def self.hex_to_bin(hex)
+      hex.scan(/../).map { |x| x.hex }.pack('C*')
+    end
+
+    def self.bin_to_hex(bin)
+      bin.unpack('H*').first
+    end
+
+    def self.public_key_to_address(prefix, public_key)
+      key_bytes = public_key.unpack('C*')
+      account = self.encode(key_bytes)
+      checksum_bytes = Blake2b.bytes(public_key, Blake2b::Key.none, 5).reverse
+      checksum = self.encode(checksum_bytes)
+
+      "#{prefix}_#{account}#{checksum}"
+    end
+
+    def self.encode(bytes)
+      length = bytes.length
+      leftover = (length * 8) % 5
+      offset = leftover == 0 ? 0 : 5 - leftover
+
+      value = 0
+      output = ""
+      bits = 0
+
+      length.times do |i|
+        value = (value << 8) | bytes[i]
+        bits += 8
+
+        while (bits >= 5)
+          output += ALLOWED_CHARS[(value >> (bits + offset - 5)) & 31]
+          bits -= 5
+        end
+      end
+
+      if bits > 0
+        output += ALLOWED_CHARS[(value << (5 - (bits + offset))) & 31]
+      end
+
+      output
+    end
+  end
+end

data/lib/nano/wallet/version.rb

@@ -0,0 +1,5 @@
+module Nano
+  class Wallet
+    VERSION = "0.1.0"
+  end
+end

data/nano-wallet.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nano/wallet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nano-wallet"
+  spec.version       = Nano::Wallet::VERSION
+  spec.authors       = ["Ryan LeFevre"]
+  spec.email         = ["meltingice8917@gmail.com"]
+
+  spec.summary       = %q{A library for generating account data for the Nano cryptocurrency.}
+  spec.description   = %q{A library for generating account private/public keys and addresses for the Nano cryptocurrency.}
+  spec.homepage      = "https://github.com/kitepay/nano-wallet"
+  spec.license       = "MIT"
+
+  # 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 -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blake2b"
+  spec.add_dependency "ed25519_blake2b"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: nano-wallet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan LeFevre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blake2b
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519_blake2b
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A library for generating account private/public keys and addresses for
+  the Nano cryptocurrency.
+email:
+- meltingice8917@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nano/wallet.rb
+- lib/nano/wallet/account.rb
+- lib/nano/wallet/util.rb
+- lib/nano/wallet/version.rb
+- nano-wallet.gemspec
+homepage: https://github.com/kitepay/nano-wallet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A library for generating account data for the Nano cryptocurrency.
+test_files: []