crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add example usage to sra_client README

Browse Source
This commit is contained in:
F. Eugene Aumson 2018-12-14 16:08:57 -08:00
parent 210840444d
commit 57ac2f28a4
No known key found for this signature in database
GPG Key ID: 23E6737B1374A24A
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
python-packages/sra_client/README.md
View File

@ -6,6 +6,35 @@ A Python client for interacting with servers conforming to [the Standard Relayer
The [JSON schemas](http://json-schema.org/) for the API payloads and responses can be found in [@0xproject/json-schemas](https://github.com/0xProject/0x.js/tree/development/packages/json-schemas). Examples of each payload and response can be found in the 0x.js library's [test suite](https://github.com/0xProject/0x.js/blob/development/packages/json-schemas/test/schema_test.ts#L1). The [JSON schemas](http://json-schema.org/) for the API payloads and responses can be found in [@0xproject/json-schemas](https://github.com/0xProject/0x.js/tree/development/packages/json-schemas). Examples of each payload and response can be found in the 0x.js library's [test suite](https://github.com/0xProject/0x.js/blob/development/packages/json-schemas/test/schema_test.ts#L1).
```bash
pip install 0x-json-schemas
```
You can easily validate your API's payloads and responses using the [0x-json-schemas](https://github.com/0xProject/0x.js/tree/development/python-packages/json_schemas) package:
```python
from zero_ex.json_schemas import assert_valid
from zero_ex.order_utils import Order
order: Order = {
'makerAddress': "0x0000000000000000000000000000000000000000",
'takerAddress': "0x0000000000000000000000000000000000000000",
'feeRecipientAddress': "0x0000000000000000000000000000000000000000",
'senderAddress': "0x0000000000000000000000000000000000000000",
'makerAssetAmount': "1000000000000000000",
'takerAssetAmount': "1000000000000000000",
'makerFee': "0",
'takerFee': "0",
'expirationTimeSeconds': "12345",
'salt': "12345",
'makerAssetData': "0x0000000000000000000000000000000000000000",
'takerAssetData': "0x0000000000000000000000000000000000000000",
'exchangeAddress': "0x0000000000000000000000000000000000000000",
}
assert_valid(order, "/orderSchema")
```
# Pagination # Pagination
Requests that return potentially large collections should respond to the **?page** and **?perPage** parameters. For example: Requests that return potentially large collections should respond to the **?page** and **?perPage** parameters. For example: