mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
61 lines
1.8 KiB
Python
61 lines
1.8 KiB
Python
"""This module provides the blueprint for the statuses API endpoints.
|
|
|
|
For more information please refer to the documentation: http://bigchaindb.com/http-api
|
|
"""
|
|
from flask import current_app
|
|
from flask_restful import Resource, reqparse
|
|
|
|
from bigchaindb.web.views.base import make_error
|
|
|
|
|
|
class StatusApi(Resource):
|
|
def get(self):
|
|
"""API endpoint to get details about the status of a transaction or a block.
|
|
|
|
Return:
|
|
A ``dict`` in the format ``{'status': <status>}``, where
|
|
``<status>`` is one of "valid", "invalid", "undecided", "backlog".
|
|
"""
|
|
parser = reqparse.RequestParser()
|
|
parser.add_argument('tx_id', type=str)
|
|
parser.add_argument('block_id', type=str)
|
|
|
|
args = parser.parse_args(strict=True)
|
|
tx_id = args['tx_id']
|
|
block_id = args['block_id']
|
|
|
|
# logical xor - exactly one query argument required
|
|
if bool(tx_id) == bool(block_id):
|
|
return make_error(400, 'Provide exactly one query parameter. Choices are: block_id, tx_id')
|
|
|
|
pool = current_app.config['bigchain_pool']
|
|
status, links = None, None
|
|
|
|
with pool() as bigchain:
|
|
if tx_id:
|
|
status = bigchain.get_status(tx_id)
|
|
links = {
|
|
'tx': '/transactions/{}'.format(tx_id)
|
|
}
|
|
|
|
elif block_id:
|
|
_, status = bigchain.get_block(block_id=block_id, include_status=True)
|
|
# TODO: enable once blocks endpoint is available
|
|
# links = {
|
|
# "block": "/blocks/{}".format(args['block_id'])
|
|
# }
|
|
|
|
if not status:
|
|
return make_error(404)
|
|
|
|
response = {
|
|
'status': status
|
|
}
|
|
|
|
if links:
|
|
response.update({
|
|
'_links': links
|
|
})
|
|
|
|
return response
|