bytom 1.0.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 xiudongy@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,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bytom.gemspec
+gemspec
+gem "http"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    bytom (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http (4.0.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    minitest (5.8.3)
+    public_suffix (3.0.3)
+    rake (10.4.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  bytom!
+  http
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,145 @@
+# Bytom SDK for Ruby
+
+This page will document the API classes and ways to properly use the API. Subsequent new releases also maintain backward compatibility with this class approach. For more information, please see Bytom API reference documentation at [Bytom wiki](https://github.com/Bytom/bytom/wiki/API-Reference)
+
+## System Requirements
+
+The SDK supports Ruby versions 2.3.0 or later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bytom', '>= 1.0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bytom
+
+## Example Usage
+
+### Initialize the client
+
+```ruby
+require "bytom"
+
+# for local node
+bytom_client = Bytom::Client.new(base_url: 'http://127.0.0.1:9888') 
+# for remoate node
+bytom_client = Bytom::Client.new(base_url: 'xxx', token: 'xxx')  
+```
+
+### Create a key
+
+```ruby
+key_data = bytom_client.keys.create_key(
+    alias_name: 'bitdayone001',
+    password: '123456',
+    language: 'en'
+)
+```
+
+### Create an account
+
+```ruby
+account_data = bytom_client.accounts.create_account(
+    root_xpubs: [key_data['data']['xpub']], 
+    alias_name: 'bitdayone001_account_01',
+    quorum: 1
+)
+```
+
+### Create an account receiver
+
+```ruby
+account_receiver_data = bytom_client.accounts.create_account_receiver(
+    account_id: account_data['data']['id'],
+    account_alias: account_data['data']['alias']
+)
+```
+
+### Create an asset
+
+```ruby
+asset_data = bytom_client.asset.create_asset(
+    alias_name: 'PropertyAsset',
+    root_xpubs: [key_data['data']['xpub']],
+    quorum: 1
+)
+```
+
+### Issue asset
+
+#### Firstly build the transaction
+
+```ruby
+actions = [
+    {
+        account_id: account_data['data']['id'],
+        amount: 20000000, # fee, unit: neu. 1 BTM = 1000 mBTM = 100000000 neu
+        asset_id: "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
+        type: "spend_account"
+    },
+    {
+        amount: 100000,
+        asset_id: asset_data['data']['id'],
+        type: "issue"
+    },  # input action
+    {
+        amount: 100000,
+        asset_id: asset_data['data']['id'],
+        address: account_receiver_data['data']['address'],
+        type: "control_address"
+    } # output action
+]
+build_transaction_data = bytom_client.transactions.build_transaction(
+    base_transaction: nil,
+    ttl: 0,
+    time_range: 129829,
+    actions: actions
+)
+```
+
+#### Secondly sign the transaction
+
+```ruby
+transaction = {
+    allow_additional_actions: false,
+    local: true,
+    raw_transaction: build_transaction_data['data']['raw_transaction'],
+    signing_instructions: build_transaction_data['data']['signing_instructions']
+}
+sign_transaction_data = bytom_client.transactions.sign_transaction(
+    password: '123456',
+    transaction: transaction
+)
+```
+
+#### Finally submit the transaction
+
+```ruby
+bytom_client.transactions.submit_transaction(
+    raw_transaction: sign_transaction_data['data']['transaction']['raw_transaction']
+)
+
+# reponse data if success
+{"status"=>"success", "data"=>{"tx_id"=>"77045241ea94ceee617f12b698a4bdef84cd6e16a58f3191b08fe092f247834d"}}
+```
+
+## All API usage examples
+
+All api usage examples you can see [doc](https://github.com/bitdayone/bytom-ruby-sdk/blob/master/API-Reference.md). 
+
+## Support and Feedback
+
+If you find a bug, please submit the issue in Github directly by using [Issues](https://github.com/bitdayone/bytom-ruby-sdk/issues)
+
+## License
+
+Bytom Ruby SDK is based on the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt) protocol.

data/Rakefile

@@ -0,0 +1,10 @@
+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"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bytom/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bytom"
+  spec.version       = Bytom::VERSION
+  spec.authors       = ["BitDayOne"]
+  spec.email         = ["bitdayone@gmail.com"]
+
+  spec.summary       = "Bytom SDK for ruby" 
+  spec.description   = "Bytom SDK for ruby" 
+  spec.homepage      = "https://bytom.io/"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/bitdayone/bytom-ruby-sdk"
+    spec.metadata["changelog_uri"] = "https://github.com/bitdayone/bytom-ruby-sdk/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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 'http'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/bytom.rb

@@ -0,0 +1,2 @@
+require "bytom/version"
+require 'bytom/client'

data/lib/bytom/api/access_token.rb

@@ -0,0 +1,55 @@
+module Bytom
+  class AccessToken
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+    
+    ##
+    # Create access token, it provides basic access authentication for HTTP protocol, returns token contain username and password, they are separated by a colon.
+    # 
+    # 
+    # @param [String] id token ID.
+    # @param [String] type optional type of token.
+    #
+    def create_access_token(id:, type: nil)
+      params = {
+          id: id,
+          type: type
+      }
+      client.make_request('/create-access-token', 'post', params: params)
+    end
+
+    ##
+    # Returns the list of all available access tokens.
+    #
+    def list_access_tokens
+      client.make_request('/list-access-tokens', 'post', params: {})
+    end
+
+    ##
+    # Delete existed access token.
+    #
+    # @param [String] id
+    #
+    def delete_access_token(id:)
+      client.make_request('/delete-access-token', 'post', params: {id: id})
+    end
+
+    ##
+    # Check access token is valid.
+    #
+    # @param [String] id
+    # @param [String] secret
+    #
+    def check_access_token(id: , secret:)
+      params = {
+          id: id,
+          secret: secret
+      }
+      client.make_request('/check-access-token', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/accounts.rb

@@ -0,0 +1,111 @@
+module Bytom
+  class Accounts
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Create account to manage addresses. single sign account contain only one root_xpubs and quorum; however multi sign account contain many number of root_xpubs and quorum, quorum is the number of verify signature, the range is [1, len(root_xpubs)].
+    # 
+    # @param [Array] root_xpubs
+    # @param [Object] alias_name
+    # @param [Object] quorum
+    # @param [Object] access_token optional
+    # 
+    # @return [Hash]
+    #
+    def create_account(root_xpubs:[], alias_name:, quorum: 1, access_token: nil)
+      params = {
+          root_xpubs: root_xpubs,
+          alias: alias_name,
+          quorum: quorum,
+          access_token: access_token
+      }
+      client.make_request('/create-account', 'post', params: params)
+    end
+
+    ##
+    # Returns the list of all available accounts.
+    #
+    # @return [Hash]
+    #
+    def list_accounts(id: nil, alias_name:nil)
+      params = {}
+      params = {id: id} if id
+      params = {alias: alias_name} if alias_name
+      client.make_request('/list-accounts', 'post', params: params)
+    end
+
+    ##
+    # By account id to update alias for the existed account.
+    #
+    # @param [String] account_id
+    # @param [String] new_alias
+    # 
+    # @return [nil] nil if the account alias is updated successfully.
+    #
+    def update_account_alias_by_id(account_id:, new_alias:)
+      params = {
+          account_id: account_id,
+          new_alias: new_alias
+      }
+      client.make_request('/update-account-alias', 'post', params: params)
+    end
+
+    ##
+    # By account alias to update alias for the existed account.
+    #
+    # @param [String] account_alias
+    # @param [String] new_alias
+    #
+    # @return [Nil] nil if the account alias is updated successfully.
+    #
+    def update_account_alias_by_alias(account_alias:, new_alias:)
+      params = {
+          account_alias: account_alias,
+          new_alias: new_alias
+      }
+      client.make_request('/update-account-alias', 'post', params: params)
+    end
+
+    ##
+    # Delete existed account by account id, please make sure that there is no balance in the related addresses.
+    #
+    # @param [String] account_id
+    #
+    # @return [Nil] nil if the account alias is updated successfully.
+    #
+    def delete_account_by_id(account_id:)
+      client.make_request('/delete-account', 'post', params: {account_id: account_id})
+    end
+
+    ##
+    # Delete existed account by account alias, please make sure that there is no balance in the related addresses.
+    # @param [String] account_alias
+    #
+    # @return [Nil] nil if the account alias is updated successfully.
+    #
+    def delete_account_by_alias(account_alias:)
+      client.make_request('/delete-account', 'post', params: {account_alias: account_alias})
+    end
+
+    ##
+    # create address and control program, the address and control program is are one to one relationship. in build-transaction API, receiver is address when action type is control_address, and receiver is control program when action type is control_program, they are the same result.
+    #
+    # @param [String] account_id
+    # @param [String] account_alias
+    #
+    # @return [Hash]
+    #
+    def create_account_receiver(account_id: nil, account_alias: nil )
+      params = {}
+      params = { account_id: account_id } if account_id
+      params = { account_alias: account_alias } if account_alias
+      return {status: 'failed'} if not params
+      client.make_request('/create-account-receiver', 'post', params: params)
+    end
+  end
+end