123 lines
3.9 KiB
Python
123 lines
3.9 KiB
Python
"""This module provides the blueprint for some basic API endpoints.
|
|
|
|
For more information please refer to the documentation on ReadTheDocs:
|
|
- https://bigchaindb.readthedocs.io/en/latest/drivers-clients/http-client-server-api.html
|
|
"""
|
|
from flask import current_app, request, Blueprint
|
|
from flask_restful import Resource, Api
|
|
|
|
from bigchaindb_common.exceptions import InvalidHash, InvalidSignature
|
|
|
|
import bigchaindb
|
|
from bigchaindb.models import Transaction
|
|
from bigchaindb.web.views.base import make_error
|
|
|
|
|
|
transaction_views = Blueprint('transaction_views', __name__)
|
|
transaction_api = Api(transaction_views)
|
|
|
|
|
|
# Unfortunately I cannot find a reference to this decorator.
|
|
# This answer on SO is quite useful tho:
|
|
# - http://stackoverflow.com/a/13432373/597097
|
|
@transaction_views.record
|
|
def record(state):
|
|
"""This function checks if the blueprint can be initialized
|
|
with the provided state."""
|
|
|
|
bigchain_pool = state.app.config.get('bigchain_pool')
|
|
monitor = state.app.config.get('monitor')
|
|
|
|
if bigchain_pool is None:
|
|
raise Exception('This blueprint expects you to provide '
|
|
'a pool of Bigchain instances called `bigchain_pool`')
|
|
|
|
if monitor is None:
|
|
raise ValueError('This blueprint expects you to provide '
|
|
'a monitor instance to record system '
|
|
'performance.')
|
|
|
|
|
|
class TransactionApi(Resource):
|
|
def get(self, tx_id):
|
|
"""API endpoint to get details about a transaction.
|
|
|
|
Args:
|
|
tx_id (str): the id of the transaction.
|
|
|
|
Return:
|
|
A JSON string containing the data about the transaction.
|
|
"""
|
|
pool = current_app.config['bigchain_pool']
|
|
|
|
with pool() as bigchain:
|
|
tx = bigchain.get_transaction(tx_id)
|
|
|
|
if not tx:
|
|
return make_error(404)
|
|
|
|
return tx.to_dict()
|
|
|
|
|
|
class TransactionStatusApi(Resource):
|
|
def get(self, tx_id):
|
|
"""API endpoint to get details about the status of a transaction.
|
|
|
|
Args:
|
|
tx_id (str): the id of the transaction.
|
|
|
|
Return:
|
|
A ``dict`` in the format ``{'status': <status>}``, where ``<status>``
|
|
is one of "valid", "invalid", "undecided", "backlog".
|
|
"""
|
|
|
|
pool = current_app.config['bigchain_pool']
|
|
|
|
with pool() as bigchain:
|
|
status = bigchain.get_status(tx_id)
|
|
|
|
if not status:
|
|
return make_error(404)
|
|
|
|
return {'status': status}
|
|
|
|
|
|
class TransactionListApi(Resource):
|
|
def post(self):
|
|
"""API endpoint to push transactions to the Federation.
|
|
|
|
Return:
|
|
A ``dict`` containing the data about the transaction.
|
|
"""
|
|
pool = current_app.config['bigchain_pool']
|
|
monitor = current_app.config['monitor']
|
|
|
|
# `force` will try to format the body of the POST request even if the `content-type` header is not
|
|
# set to `application/json`
|
|
tx = request.get_json(force=True)
|
|
|
|
try:
|
|
tx_obj = Transaction.from_dict(tx)
|
|
except (InvalidHash, InvalidSignature):
|
|
return make_error(400, 'Invalid transaction')
|
|
|
|
with pool() as bigchain:
|
|
if bigchain.is_valid_transaction(tx_obj):
|
|
rate = bigchaindb.config['statsd']['rate']
|
|
with monitor.timer('write_transaction', rate=rate):
|
|
bigchain.write_transaction(tx_obj)
|
|
else:
|
|
return make_error(400, 'Invalid transaction')
|
|
|
|
return tx
|
|
|
|
transaction_api.add_resource(TransactionApi,
|
|
'/transactions/<string:tx_id>',
|
|
strict_slashes=False)
|
|
transaction_api.add_resource(TransactionStatusApi,
|
|
'/transactions/<string:tx_id>/status',
|
|
strict_slashes=False)
|
|
transaction_api.add_resource(TransactionListApi,
|
|
'/transactions',
|
|
strict_slashes=False)
|