arweave 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d04de6a25b28b4b42809d2d14fbcd7e71befe7b49ed3977a81ef7eba5d3ac35
+  data.tar.gz: 74e087df6a11aa74699391335df2c8c01ec6bfe640a874320ce6e2dca300426e
+SHA512:
+  metadata.gz: 79526f3f277e5425d6c52b0dbfcd63e1852d8a6923195d38e28378dacf753992817ddbea79fcba7d1558260cc4985d2120decaa4af10b9d53bfacfc13acee831
+  data.tar.gz: 52b5b82f06a20d5cee8f4c0e13621d27a50f5eb6068d7d1790c1d870c3420671ceadaab2ead190de3ea805529b92221ce1bf0ab66659f2d7b521d411af1a52ae

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+.byebug_history
+
+# rspec failure tracking
+.rspec_status

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.5.3
+before_install: gem install bundler -v 2.1.4

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 arefaslani@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,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arweave.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    arweave (0.1.0)
+      httparty (~> 0.18.1)
+      json-jwt (~> 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    aes_key_wrap (1.0.1)
+    bindata (2.4.7)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    json-jwt (1.13.0)
+      activesupport (>= 4.2)
+      aes_key_wrap
+      bindata
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arweave!
+  byebug (~> 11.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aref Aslani
+
+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,33 @@
+# Arweave Ruby SDK
+Ruby flavoured Arweave
+
+## installation
+Simply run
+
+`gem install arweave`
+
+or put the gem into your gemfile:
+```ruby
+gem 'arweave'
+```
+## Usage
+
+### Configuration
+The default node that this package uses is `https://arweave.net`. But you can simply configure it:
+
+```ruby
+Arweave::Client.configure do |config|
+  config.host = 'xxx.xxx.xxx.xxx' # a valid node IP
+  config.port = '1984'
+  config.scheme = 'https'
+end
+```
+
+### Creating transactions
+For a complete list of argument you can pass to the `create_transaction` method, checkout the [documentation](https://docs.arweave.org/developers/server/http-api#submit-a-transaction).
+
+```ruby
+client = Arweave::Client.new
+jwk = JSON.parse(File.read(File.expand_path(File.join('path-to-keyfile'))))
+client.create_transaction(wallet: wallet, data: '<b>test</b>').commit
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/arweave.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/arweave/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arweave'
+  spec.version       = Arweave::VERSION
+  spec.authors       = ['Aref Aslani']
+  spec.email         = ['arefaslani@gmail.com']
+
+  spec.summary       = %q{Arweave SDK}
+  spec.description   = %q{Ruby SDK for Arweave decentralized services}
+  spec.homepage      = 'https://github.com/arefaslani/arweave'
+  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
+
+  # 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 'json-jwt', '~> 1.13'
+  spec.add_dependency 'httparty', '~> 0.18.1'
+  spec.add_development_dependency 'byebug', '~> 11.1'
+end

data/bin/console

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

@@ -0,0 +1,5 @@
+require 'arweave/version'
+require 'arweave/client'
+require 'arweave/api'
+require 'arweave/transaction'
+require 'arweave/wallet'

data/lib/arweave/api.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+
+module Arweave
+  class Api
+    include HTTParty
+
+    class << self
+      def instance
+        @instance ||=
+          new(
+            scheme: Client.configuration&.scheme || 'https',
+            host: Client.configuration&.host || 'arweave.net',
+            port: Client.configuration&.port || '443'
+          )
+      end
+    end
+
+    def get_transaction_anchor
+      self.class.get('/tx_anchor')
+    end
+
+    def reward(byte_size, address = '')
+      self.class.get("/price/#{byte_size}/#{address}")
+    end
+
+    def commit(transaction)
+      self.class.post(
+        '/tx',
+        body: transaction.attributes.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    private
+
+    def initialize(scheme:, host:, port:)
+      self.class.base_uri URI::Generic.build(
+                            scheme: scheme, host: host, port: port
+                          ).to_s
+    end
+  end
+end

data/lib/arweave/client.rb

@@ -0,0 +1,62 @@
+require 'base64'
+
+module Arweave
+  class Client
+    def initialize
+      @api = Api.instance
+    end
+
+    def create_transaction(wallet:, **attributes)
+      attributes.transform_keys!(&:to_sym)
+
+      transaction =
+        Transaction.new(
+          last_tx: api.get_transaction_anchor,
+          owner: wallet.owner,
+          tags: [],
+          target: attributes.fetch(:target, ''),
+          quantity: attributes.fetch(:quantity, '0'),
+          data:
+            Base64.urlsafe_encode64(
+              attributes.fetch(:data, ''),
+              padding: false
+            ),
+          reward:
+            api.reward(
+              attributes.fetch(:data, '').length,
+              attributes.fetch(:target, nil)
+            )
+        )
+
+      transaction.sign(wallet)
+      transaction
+    end
+
+    def commit(transaction)
+      api.commit(transaction)
+    end
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield @configuration
+    end
+
+    private
+
+    class Configuration
+      attr_accessor :scheme, :host, :port
+
+      def initialize
+        @scheme = 'https'
+        @port = '443'
+        @host = 'arweave.net'
+      end
+    end
+
+    attr_reader :api
+  end
+end

data/lib/arweave/transaction.rb

@@ -0,0 +1,63 @@
+require 'base64'
+
+module Arweave
+  class Transaction
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes =
+        {
+          id: '',
+          last_tx: '',
+          owner: '',
+          tags: [],
+          target: '',
+          quantity: '0',
+          data: '',
+          reward: '0',
+          signature: ''
+        }.merge(attributes).yield_self do |hash|
+          hash.each do |key, value|
+            value.respond_to?(:map) ? hash[key] = value : hash[key] = value.to_s
+          end
+
+          hash
+        end.transform_keys!(&:to_sym)
+    end
+
+    def sign(wallet)
+      signature = wallet.sign(get_signature_data)
+
+      @attributes[:signature] =
+        Base64.urlsafe_encode64 signature, padding: false
+      @attributes[:id] =
+        Base64.urlsafe_encode64 Digest::SHA256.digest(signature), padding: false
+
+      # TODO: verify signature
+      signature
+    end
+
+    def commit
+      Api.instance.commit(self)
+    end
+
+    private
+
+    def get_signature_data
+      Base64.urlsafe_decode64(attributes.fetch(:owner)) +
+        Base64.urlsafe_decode64(attributes.fetch(:target)) +
+        Base64.urlsafe_decode64(attributes.fetch(:data)) +
+        attributes.fetch(:quantity) + attributes.fetch(:reward) +
+        Base64.urlsafe_decode64(attributes.fetch(:last_tx)) + tags_string
+    end
+
+    def verify
+      true
+    end
+
+    def tags_string
+      # TODO: Create tags string
+      ''
+    end
+  end
+end

data/lib/arweave/version.rb

@@ -0,0 +1,3 @@
+module Arweave
+  VERSION = '0.9.0'
+end

data/lib/arweave/wallet.rb

@@ -0,0 +1,40 @@
+require 'json/jwt'
+require 'base64'
+require 'digest'
+
+module Arweave
+  class Wallet
+    attr_reader :address, :owner
+
+    def initialize(jwk)
+      @jwk = jwk.transform_keys!(&:to_sym)
+    end
+
+    def owner
+      jwk.dig(:n)
+    end
+
+    def address
+      Base64.urlsafe_encode64(
+        Digest::SHA256.digest(Base64.urlsafe_decode64(owner)),
+        padding: false
+      )
+    end
+
+    def sign(message)
+      private_key.sign_pss(
+        'SHA256',
+        message,
+        salt_length: 0, mgf1_hash: 'SHA256'
+      )
+    end
+
+    private
+
+    attr_reader :jwk
+
+    def private_key
+      JSON::JWK.new(jwk).to_key
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: arweave
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Aref Aslani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+description: Ruby SDK for Arweave decentralized services
+email:
+- arefaslani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- arweave.gemspec
+- bin/console
+- bin/setup
+- lib/arweave.rb
+- lib/arweave/api.rb
+- lib/arweave/client.rb
+- lib/arweave/transaction.rb
+- lib/arweave/version.rb
+- lib/arweave/wallet.rb
+homepage: https://github.com/arefaslani/arweave
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arefaslani/arweave
+  source_code_uri: https://github.com/arefaslani/arweave
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Arweave SDK
+test_files: []