mirror of
https://github.com/Blockstream/satellite-api.git
synced 2025-03-15 12:19:47 +01:00
432334b2eb
Previously, it was possible to filter orders before an ISO date only. With this patch, it is now possible to filter before and after ISO dates, so a window can be defined (with start and end datetimes). Also, it is now possible to specify the start and end times of the filtering window with deltas in seconds relative to the current UTC time. For instance, with before_delta=60 and after_delta=120, the filtered window starts 2 min ago and ends 1 min ago.
108 lines
3.7 KiB
Python
108 lines
3.7 KiB
Python
import json
|
|
|
|
from marshmallow import fields, Schema, validate, ValidationError, \
|
|
validates_schema
|
|
|
|
from regions import all_region_numbers, region_code_to_number_list, \
|
|
region_id_to_number
|
|
import constants
|
|
|
|
|
|
class OrderSchema(Schema):
|
|
uuid = fields.String()
|
|
bid = fields.Integer()
|
|
message_size = fields.Integer()
|
|
bid_per_byte = fields.Float()
|
|
message_digest = fields.String()
|
|
status = fields.Function(
|
|
lambda obj: constants.OrderStatus(obj.status).name)
|
|
created_at = fields.DateTime()
|
|
cancelled_at = fields.DateTime()
|
|
started_transmission_at = fields.DateTime()
|
|
ended_transmission_at = fields.DateTime()
|
|
tx_seq_num = fields.Integer()
|
|
unpaid_bid = fields.Integer()
|
|
regions = fields.Function(
|
|
lambda obj: region_code_to_number_list(obj.region_code))
|
|
|
|
|
|
class AdminOrderSchema(OrderSchema):
|
|
channel = fields.Integer()
|
|
tx_confirmations = fields.Function(
|
|
lambda obj:
|
|
[region_id_to_number(x.region_id) for x in obj.tx_confirmations])
|
|
rx_confirmations = fields.Function(
|
|
lambda obj:
|
|
[region_id_to_number(x.region_id) for x in obj.rx_confirmations])
|
|
|
|
|
|
def must_be_region_number(input):
|
|
if input not in all_region_numbers:
|
|
raise ValidationError(
|
|
"Region number not found. The number should be one of "
|
|
f"{all_region_numbers}.")
|
|
|
|
|
|
def must_be_region_number_list(data):
|
|
try:
|
|
regions_list = json.loads(data)
|
|
if not isinstance(regions_list, list) or len(regions_list) < 1:
|
|
raise ValidationError("Invalid json array.")
|
|
for region_number in regions_list:
|
|
must_be_region_number(region_number)
|
|
except json.JSONDecodeError:
|
|
raise ValidationError("Invalid json array.")
|
|
|
|
|
|
class OrderUploadReqSchema(Schema):
|
|
bid = fields.Int(missing=0, validate=validate.Range(min=0))
|
|
message = fields.Str(validate=validate.Length(
|
|
max=constants.MAX_TEXT_MSG_LEN))
|
|
regions = fields.String(required=False,
|
|
validate=must_be_region_number_list)
|
|
channel = fields.Int(missing=constants.USER_CHANNEL,
|
|
validate=validate.OneOf(constants.CHANNELS))
|
|
|
|
|
|
class OrderBumpSchema(Schema):
|
|
uuid = fields.String()
|
|
bid_increase = fields.Int(required=True, validate=validate.Range(min=0))
|
|
auth_token = fields.Str()
|
|
|
|
|
|
class OrdersSchema(Schema):
|
|
before = fields.DateTime(format='iso')
|
|
before_delta = fields.TimeDelta('seconds')
|
|
after = fields.DateTime(format='iso')
|
|
after_delta = fields.TimeDelta('seconds')
|
|
limit = fields.Int(missing=lambda: constants.PAGE_SIZE,
|
|
validate=validate.Range(min=1,
|
|
max=constants.MAX_PAGE_SIZE))
|
|
channel = fields.Int(missing=constants.USER_CHANNEL,
|
|
validate=validate.OneOf(constants.CHANNELS))
|
|
|
|
@validates_schema
|
|
def validate_numbers(self, data, **kwargs):
|
|
if ('before' in data and 'before_delta' in data):
|
|
raise ValidationError(
|
|
"Only one of before or before_delta is allowed")
|
|
if ('after' in data and 'after_delta' in data):
|
|
raise ValidationError(
|
|
"Only one of after or after_delta is allowed")
|
|
|
|
|
|
class TxConfirmationSchema(Schema):
|
|
regions = fields.String(required=True, validate=must_be_region_number_list)
|
|
|
|
|
|
class RxConfirmationSchema(Schema):
|
|
region = fields.Int(required=True, validate=must_be_region_number)
|
|
|
|
|
|
order_schema = OrderSchema()
|
|
admin_order_schema = AdminOrderSchema()
|
|
order_upload_req_schema = OrderUploadReqSchema()
|
|
order_bump_schema = OrderBumpSchema()
|
|
orders_schema = OrdersSchema()
|
|
tx_confirmation_schema = TxConfirmationSchema()
|
|
rx_confirmation_schema = RxConfirmationSchema()
|