tapyrus-api-client 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf77f4a63d4967ed8ec527e78c991c74fe092b74a2ee1840e51085ba2b18504b
+  data.tar.gz: 4fcb11e67112de015e8962b3a32afaa805d91819464f826587df47d9421d6ed4
+SHA512:
+  metadata.gz: 556bbd41c3c3cdc76083ac80bd9636fcb21a3e12a9344d3b1b75b8a54f5fde3165aee705bcad163a5d25f44f11e0b5ab00ea55703f49d2e44f05686340acdb03
+  data.tar.gz: 6761f6762c1574941ef24c09d4fb9f6675721b5a0eee9a9ef826d002df8ad638fa62550bcde5f0c01ff6668953e94f673c8d98be54b25c25e84813d06e10a276

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    tapyrus-api-client (0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.3)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    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.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  tapyrus-api-client!
+
+BUNDLED WITH
+   2.2.24

data/README.md

@@ -0,0 +1,183 @@
+# tapyrus-api-client
+
+TapyrusApiClient - the Ruby gem for the Tapyrus API
+
+# イントロダクション
+
+これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。
+現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。
+* Payment: TPC(Tapyrus Coin) の送金
+* Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録
+* Token: 新しいトークンの発行、送金、焼却。NFTも利用可能
+
+Tapyrus ブロックチェーンについては以下の情報を参照してください。
+
+* [Chaintope のブロックチェーンプロトコル](https://www.chaintope.com/chaintope-blockchain-protocol/)
+* [chaintope/tapyrus-core - github](https://github.com/chaintope/tapyrus-core)
+
+## Tapyrus API の利用法
+
+Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みの
+トークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。
+ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。
+
+### Tapyrus API のエンドポイント
+
+エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。
+
+`ap-01.tapyrus.chaintope.com`
+
+例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。
+
+`testnet-api.tapyrus.chaintope.com`
+
+testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。
+利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。
+
+* [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com)
+
+### OpenID Connect を使った認証
+
+Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、
+以下のステップを踏みます。
+
+1. 利用する OpenID Provider(OP) を選択する
+
+  公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API
+  を利用させる場合は後者の自身で OP を構築する方法を選択することになります。
+
+2. OAuth 2.0 Client Credential を入手する
+
+  多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。
+
+3. Access Token と ID Token を入手する
+
+  OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。
+
+4. Tapyrus API ユーザを作成する
+
+  入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。
+
+コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。
+
+## Tapyrus API ユーザとウォレットについて
+
+認証により得たアクセストークンを使い、Tapyrus API ユーザを１つ作成する必要があります。
+Tapyrus API の内部では、このユーザ１つにつき１つのウォレットが作成されます。
+ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。
+そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。
+
+# Getting Started
+
+Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。
+
+  * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build tapyrus-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./tapyrus-api-client-.gem
+```
+
+(for development, run `gem install --dev ./tapyrus-api-client-.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'tapyrus-api-client', '~> '
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'tapyrus-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'tapyrus-api-client'
+
+# Setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::AddressApi.new
+
+begin
+  #アドレスを生成して返します。
+  result = api_instance.create_address
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Exception when calling AddressApi->create_address: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TapyrusApiClient::AddressApi* | [**create_address**](docs/AddressApi.md#create_address) | **POST** /addresses | アドレスを生成して返します。
+*TapyrusApiClient::AddressApi* | [**get_addresses**](docs/AddressApi.md#get_addresses) | **GET** /addresses | これまで生成したアドレスを一覧にして返します。
+*TapyrusApiClient::PaymentApi* | [**transfer**](docs/PaymentApi.md#transfer) | **POST** /payment | 資金の送金
+*TapyrusApiClient::TimestampApi* | [**add_timestamp**](docs/TimestampApi.md#add_timestamp) | **POST** /timestamp | Timestampを記録
+*TapyrusApiClient::TimestampApi* | [**get_timestamps**](docs/TimestampApi.md#get_timestamps) | **GET** /timestamps | Timestamp一覧表示
+*TapyrusApiClient::TokenApi* | [**burn_token**](docs/TokenApi.md#burn_token) | **DELETE** /tokens/{token_id}/burn | トークンの焼却
+*TapyrusApiClient::TokenApi* | [**get_tokens**](docs/TokenApi.md#get_tokens) | **GET** /tokens | トークンの総量取得
+*TapyrusApiClient::TokenApi* | [**issue_token**](docs/TokenApi.md#issue_token) | **POST** /tokens/issue | トークンの新規発行
+*TapyrusApiClient::TokenApi* | [**reissue_token**](docs/TokenApi.md#reissue_token) | **POST** /tokens/{token_id}/reissue | トークンの再発行
+*TapyrusApiClient::TokenApi* | [**transfer_token**](docs/TokenApi.md#transfer_token) | **PUT** /tokens/{token_id}/transfer | トークンの送付
+*TapyrusApiClient::UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /users | ユーザを作成します。
+*TapyrusApiClient::UserApi* | [**get_user_info**](docs/UserApi.md#get_user_info) | **GET** /userinfo | ユーザの情報を返します。
+
+
+## Documentation for Models
+
+ - [TapyrusApiClient::AddTimestampRequest](docs/AddTimestampRequest.md)
+ - [TapyrusApiClient::CreateUserRequest](docs/CreateUserRequest.md)
+ - [TapyrusApiClient::GetAddressesResponse](docs/GetAddressesResponse.md)
+ - [TapyrusApiClient::GetTokensResponse](docs/GetTokensResponse.md)
+ - [TapyrusApiClient::IssueTokenRequest](docs/IssueTokenRequest.md)
+ - [TapyrusApiClient::PaymentRequest](docs/PaymentRequest.md)
+ - [TapyrusApiClient::PaymentResponse](docs/PaymentResponse.md)
+ - [TapyrusApiClient::ReissueTokenRequest](docs/ReissueTokenRequest.md)
+ - [TapyrusApiClient::TokenResponse](docs/TokenResponse.md)
+ - [TapyrusApiClient::TransferTokenRequest](docs/TransferTokenRequest.md)
+ - [TapyrusApiClient::UserinfoResponse](docs/UserinfoResponse.md)
+ - [TapyrusApiClient::UserinfoResponseBalances](docs/UserinfoResponseBalances.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddTimestampRequest.md

@@ -0,0 +1,20 @@
+# TapyrusApiClient::AddTimestampRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_hash** | **String** |  |  |
+| **prefix** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::AddTimestampRequest.new(
+  content_hash: 9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d,
+  prefix: app
+)
+```
+

data/docs/AddressApi.md

@@ -0,0 +1,142 @@
+# TapyrusApiClient::AddressApi
+
+All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_address**](AddressApi.md#create_address) | **POST** /addresses | アドレスを生成して返します。 |
+| [**get_addresses**](AddressApi.md#get_addresses) | **GET** /addresses | これまで生成したアドレスを一覧にして返します。 |
+
+
+## create_address
+
+> String create_address
+
+アドレスを生成して返します。
+
+受金用のアドレス生成して返します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::AddressApi.new
+
+begin
+  # アドレスを生成して返します。
+  result = api_instance.create_address
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling AddressApi->create_address: #{e}"
+end
+```
+
+#### Using the create_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> create_address_with_http_info
+
+```ruby
+begin
+  # アドレスを生成して返します。
+  data, status_code, headers = api_instance.create_address_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling AddressApi->create_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_addresses
+
+> <GetAddressesResponse> get_addresses(opts)
+
+これまで生成したアドレスを一覧にして返します。
+
+これまで生成したアドレスを一覧にして返します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::AddressApi.new
+opts = {
+  per: 56, # Integer | 1ページあたりの件数
+  page: 56 # Integer | ページ番号
+}
+
+begin
+  # これまで生成したアドレスを一覧にして返します。
+  result = api_instance.get_addresses(opts)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling AddressApi->get_addresses: #{e}"
+end
+```
+
+#### Using the get_addresses_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAddressesResponse>, Integer, Hash)> get_addresses_with_http_info(opts)
+
+```ruby
+begin
+  # これまで生成したアドレスを一覧にして返します。
+  data, status_code, headers = api_instance.get_addresses_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAddressesResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling AddressApi->get_addresses_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **per** | **Integer** | 1ページあたりの件数 | [optional] |
+| **page** | **Integer** | ページ番号 | [optional] |
+
+### Return type
+
+[**GetAddressesResponse**](GetAddressesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+