tapyrus-api-client 0

data/docs/TokenResponse.md

@@ -0,0 +1,20 @@
+# TapyrusApiClient::TokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tokens_id** | **String** |  | [optional] |
+| **txid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TokenResponse.new(
+  tokens_id: c3ec2fd806701a3f55808cbec3922c38dafaa3070c48c803e9043ee3642c660b46,
+  txid: 76077052e323a8445c398b690ed8b4b49c9b6e4d1e8e19ea0e7de7cead6f5fc8
+)
+```
+

data/docs/TransferTokenRequest.md

@@ -0,0 +1,20 @@
+# TapyrusApiClient::TransferTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** |  |  |
+| **amount** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::TransferTokenRequest.new(
+  address: 1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a,
+  amount: 100
+)
+```
+

data/docs/UserApi.md

@@ -0,0 +1,140 @@
+# TapyrusApiClient::UserApi
+
+All URIs are relative to *https://ap-01.tapyrus.chaintope.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_user**](UserApi.md#create_user) | **POST** /users | ユーザを作成します。 |
+| [**get_user_info**](UserApi.md#get_user_info) | **GET** /userinfo | ユーザの情報を返します。 |
+
+
+## create_user
+
+> create_user(create_user_request)
+
+ユーザを作成します。
+
+OpenID Connect を使った認証で得た id_token と access_token を Tapyrus API へ登録しユーザを作成します。すでにユーザが存在する場合は認証情報を更新します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+
+api_instance = TapyrusApiClient::UserApi.new
+create_user_request = TapyrusApiClient::CreateUserRequest.new({id_token: 'eyJhbGciOiJSUzI1NiIsImtpZCI6IjFlOWdkazcifQ.ewogImlzcyI6ICJodHRwOi8vc2VydmVyLmV4YW1wbGUuY29tIiwKICJzdWIiOiAiMjQ4Mjg5NzYxMDAxIiwKICJhdWQiOiAiczZCaGRSa3F0MyIsCiAibm9uY2UiOiAibi0wUzZfV3pBMk1qIiwKICJleHAiOiAxMzExMjgxOTcwLAogImlhdCI6IDEzMTEyODA5NzAKfQ.ggW8hZ1EuVLuxNuuIJKX_V8a_OMXzR0EHR9R6jgdqrOOF4daGU96Sr_P6qJp6IcmD3HP99Obi1PRs-cwh3LO-p146waJ8IhehcwL7F09JdijmBqkvPeB2T9CJNqeGpe-gccMg4vfKjkM8FcGvnzZUN4_KSP0aAp1tOJ1zZwgjxqGByKHiOtX7TpdQyHE5lcMiKPXfEIQILVq0pc_E2DzL7emopWoaoZTF_m0_N0YzFC6g6EJbOEoRoSK5hoDalrcvRYLSrQAZZKflyuVCyixEoV9GfNQC3_osjzw2PAithfubEEBLuVVk4XUVrWOLrLl0nx7RkKU8NXNHq-rvKMzqg', issuer: 'https://server.example.com', client_id: 's6BhdRkqt3', access_token: 'SlAV32hkKG'}) # CreateUserRequest | 
+
+begin
+  # ユーザを作成します。
+  api_instance.create_user(create_user_request)
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling UserApi->create_user: #{e}"
+end
+```
+
+#### Using the create_user_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> create_user_with_http_info(create_user_request)
+
+```ruby
+begin
+  # ユーザを作成します。
+  data, status_code, headers = api_instance.create_user_with_http_info(create_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling UserApi->create_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## get_user_info
+
+> <UserinfoResponse> get_user_info(opts)
+
+ユーザの情報を返します。
+
+ユーザの`id`,`balance`, `address`の情報を返します。
+
+### Examples
+
+```ruby
+require 'time'
+require 'tapyrus-api-client'
+# setup authorization
+TapyrusApiClient.configure do |config|end
+
+api_instance = TapyrusApiClient::UserApi.new
+opts = {
+  confirmation_only: true # Boolean | オプションで`confirmation_only`を設定でき、`true`の場合ブロックチェーン上で承認済みのtpc・トークンのみを取得し、`false`の場合未承認のtpc・トークンも含めて取得します。デフォルトは`true`です。
+}
+
+begin
+  # ユーザの情報を返します。
+  result = api_instance.get_user_info(opts)
+  p result
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling UserApi->get_user_info: #{e}"
+end
+```
+
+#### Using the get_user_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserinfoResponse>, Integer, Hash)> get_user_info_with_http_info(opts)
+
+```ruby
+begin
+  # ユーザの情報を返します。
+  data, status_code, headers = api_instance.get_user_info_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserinfoResponse>
+rescue TapyrusApiClient::ApiError => e
+  puts "Error when calling UserApi->get_user_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **confirmation_only** | **Boolean** | オプションで&#x60;confirmation_only&#x60;を設定でき、&#x60;true&#x60;の場合ブロックチェーン上で承認済みのtpc・トークンのみを取得し、&#x60;false&#x60;の場合未承認のtpc・トークンも含めて取得します。デフォルトは&#x60;true&#x60;です。 | [optional] |
+
+### Return type
+
+[**UserinfoResponse**](UserinfoResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UserinfoResponse.md

@@ -0,0 +1,22 @@
+# TapyrusApiClient::UserinfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub** | **Integer** |  | [optional] |
+| **balances** | [**UserinfoResponseBalances**](UserinfoResponseBalances.md) |  | [optional] |
+| **addresses** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::UserinfoResponse.new(
+  sub: 1,
+  balances: null,
+  addresses: null
+)
+```
+

data/docs/UserinfoResponseBalances.md

@@ -0,0 +1,18 @@
+# TapyrusApiClient::UserinfoResponseBalances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tpc** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tapyrus-api-client'
+
+instance = TapyrusApiClient::UserinfoResponseBalances.new(
+  tpc: 50000000000
+)
+```
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/tapyrus-api-client.rb

@@ -0,0 +1,56 @@
+=begin
+#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) 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1-SNAPSHOT
+
+=end
+
+# Common files
+require 'tapyrus-api-client/api_client'
+require 'tapyrus-api-client/api_error'
+require 'tapyrus-api-client/version'
+require 'tapyrus-api-client/configuration'
+
+# Models
+require 'tapyrus-api-client/models/add_timestamp_request'
+require 'tapyrus-api-client/models/create_user_request'
+require 'tapyrus-api-client/models/get_addresses_response'
+require 'tapyrus-api-client/models/get_tokens_response'
+require 'tapyrus-api-client/models/issue_token_request'
+require 'tapyrus-api-client/models/payment_request'
+require 'tapyrus-api-client/models/payment_response'
+require 'tapyrus-api-client/models/reissue_token_request'
+require 'tapyrus-api-client/models/token_response'
+require 'tapyrus-api-client/models/transfer_token_request'
+require 'tapyrus-api-client/models/userinfo_response'
+require 'tapyrus-api-client/models/userinfo_response_balances'
+
+# APIs
+require 'tapyrus-api-client/api/address_api'
+require 'tapyrus-api-client/api/payment_api'
+require 'tapyrus-api-client/api/timestamp_api'
+require 'tapyrus-api-client/api/token_api'
+require 'tapyrus-api-client/api/user_api'
+
+module TapyrusApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   TapyrusApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/tapyrus-api-client/api/address_api.rb

@@ -0,0 +1,142 @@
+=begin
+#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) 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module TapyrusApiClient
+  class AddressApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # アドレスを生成して返します。
+    # 受金用のアドレス生成して返します。
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def create_address(opts = {})
+      data, _status_code, _headers = create_address_with_http_info(opts)
+      data
+    end
+
+    # アドレスを生成して返します。
+    # 受金用のアドレス生成して返します。
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def create_address_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.create_address ...'
+      end
+      # resource path
+      local_var_path = '/addresses'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressApi.create_address",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#create_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # これまで生成したアドレスを一覧にして返します。
+    # これまで生成したアドレスを一覧にして返します。
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per 1ページあたりの件数
+    # @option opts [Integer] :page ページ番号
+    # @return [GetAddressesResponse]
+    def get_addresses(opts = {})
+      data, _status_code, _headers = get_addresses_with_http_info(opts)
+      data
+    end
+
+    # これまで生成したアドレスを一覧にして返します。
+    # これまで生成したアドレスを一覧にして返します。
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per 1ページあたりの件数
+    # @option opts [Integer] :page ページ番号
+    # @return [Array<(GetAddressesResponse, Integer, Hash)>] GetAddressesResponse data, response status code and response headers
+    def get_addresses_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.get_addresses ...'
+      end
+      # resource path
+      local_var_path = '/addresses'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAddressesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressApi.get_addresses",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#get_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end