Class: TapyrusApiClient::TimestampApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tapyrus-api-client/api/timestamp_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TimestampApi

Returns a new instance of TimestampApi.



19
20
21
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_timestamp(opts = {}) ⇒ AddTimestampResponse

Timestampを記録 ブロックチェーンにハッシュ値をタイムスタンプとして記録します。 現在、記録方法として2種類の`type`（`simple`（デフォルト）、`trackable`）をサポートしています。 `simple`を指定した場合は、ハッシュ値がトランザクション内のOP_RETURNアウトプットに直接埋め込まれます。 単純に値をブロックチェーンに記録する場合は`simple`の利用を推奨します。 `trackable`を指定した場合は、ハッシュ値を組み合わせたPay to Contractアドレスが生成され、ハッシュ値は間接的に記録されます。 アドレスは、Timestampの戻り値の１つである`payment_base`と指定されたコンテンツハッシュを使って次のように計算されます。 “` アドレスの公開鍵 = payment_base + SHA256(payment_base || コンテンツハッシュ)G “` ※Gは楕円曲線の生成元。公開鍵からアドレス（P2PKH）を導出すると、戻り値の１つである`p2c_address`と合致します。 `trackable`を使用するとハッシュ値は間接的に記録されますが、ブロックチェーン上で使用可能なアセットとして管理できます。 そのため、ある記録を持つデータを更新する場合に、このアセットを使用して新しい`trackable`アセットを作成することで、 記録の更新、最新性を表現することが可能になります。未使用な記録のみ`latest`がtrueになります。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_timestamp_request (AddTimestampRequest) —

    `content_hash`, `prefix`, `type` を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。

Returns:



27
28
29
30
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 27

def add_timestamp(opts = {})
  data, _status_code, _headers = add_timestamp_with_http_info(opts)
  data
end

#add_timestamp_with_http_info(opts = {}) ⇒ Array<(AddTimestampResponse, Integer, Hash)>

Timestampを記録 ブロックチェーンにハッシュ値をタイムスタンプとして記録します。 現在、記録方法として2種類の&#x60;type&#x60;（&#x60;simple&#x60;（デフォルト）、&#x60;trackable&#x60;）をサポートしています。 &#x60;simple&#x60;を指定した場合は、ハッシュ値がトランザクション内のOP_RETURNアウトプットに直接埋め込まれます。 単純に値をブロックチェーンに記録する場合は&#x60;simple&#x60;の利用を推奨します。 &#x60;trackable&#x60;を指定した場合は、ハッシュ値を組み合わせたPay to Contractアドレスが生成され、ハッシュ値は間接的に記録されます。 アドレスは、Timestampの戻り値の１つである&#x60;payment_base&#x60;と指定されたコンテンツハッシュを使って次のように計算されます。 &#x60;&#x60;&#x60; アドレスの公開鍵 &#x3D; payment_base + SHA256(payment_base || コンテンツハッシュ)G &#x60;&#x60;&#x60; ※Gは楕円曲線の生成元。公開鍵からアドレス（P2PKH）を導出すると、戻り値の１つである&#x60;p2c_address&#x60;と合致します。 &#x60;trackable&#x60;を使用するとハッシュ値は間接的に記録されますが、ブロックチェーン上で使用可能なアセットとして管理できます。 そのため、ある記録を持つデータを更新する場合に、このアセットを使用して新しい&#x60;trackable&#x60;アセットを作成することで、 記録の更新、最新性を表現することが可能になります。未使用な記録のみ&#x60;latest&#x60;がtrueになります。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_timestamp_request (AddTimestampRequest) —

    &#x60;content_hash&#x60;, &#x60;prefix&#x60;, &#x60;type&#x60; を受け取り、ブロックチェーンにハッシュ値をタイムスタンプとして記録します。

Returns:

  • (Array<(AddTimestampResponse, Integer, Hash)>) —

    AddTimestampResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 37

def add_timestamp_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimestampApi.add_timestamp ...'
  end
  # resource path
  local_var_path = '/timestamps'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'add_timestamp_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'AddTimestampResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TimestampApi.add_timestamp",
    :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: TimestampApi#add_timestamp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_timestamp(id, opts = {}) ⇒ GetTimestampResponse

Timestamp表示 タイムスタンプ ID に対応する Timestamp を表示します。

Parameters:

  • id (Integer) —

    Timestamp id。&#x60;Timestamp を記録 API(POST /timestamps)&#x60; の返り値の JSON の &#x60;id&#x60; 要素の値です。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 91

def get_timestamp(id, opts = {})
  data, _status_code, _headers = get_timestamp_with_http_info(id, opts)
  data
end

#get_timestamp_with_http_info(id, opts = {}) ⇒ Array<(GetTimestampResponse, Integer, Hash)>

Timestamp表示 タイムスタンプ ID に対応する Timestamp を表示します。

Parameters:

  • id (Integer) —

    Timestamp id。&#x60;Timestamp を記録 API(POST /timestamps)&#x60; の返り値の JSON の &#x60;id&#x60; 要素の値です。

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetTimestampResponse, Integer, Hash)>) —

    GetTimestampResponse data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 101

def get_timestamp_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimestampApi.get_timestamp ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TimestampApi.get_timestamp"
  end
  # resource path
  local_var_path = '/timestamps/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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] || 'GetTimestampResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TimestampApi.get_timestamp",
    :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: TimestampApi#get_timestamp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_timestamps(opts = {}) ⇒ Array<GetTimestampResponse>

Timestamp一覧表示 ブロックチェーンに記録したタイムスタンプを取得し、`content_hash`,`prefix`,`txid`を一覧で表示します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 153

def get_timestamps(opts = {})
  data, _status_code, _headers = get_timestamps_with_http_info(opts)
  data
end

#get_timestamps_with_http_info(opts = {}) ⇒ Array<(Array<GetTimestampResponse>, Integer, Hash)>

Timestamp一覧表示 ブロックチェーンに記録したタイムスタンプを取得し、&#x60;content_hash&#x60;,&#x60;prefix&#x60;,&#x60;txid&#x60;を一覧で表示します。

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<GetTimestampResponse>, Integer, Hash)>) —

    Array<GetTimestampResponse> data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/tapyrus-api-client/api/timestamp_api.rb', line 162

def get_timestamps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimestampApi.get_timestamps ...'
  end
  # resource path
  local_var_path = '/timestamps'

  # 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] || 'Array<GetTimestampResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TimestampApi.get_timestamps",
    :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: TimestampApi#get_timestamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end