# Vertex Protocol Python SDK
This is the Python SDK for the [Vertex Protocol API](https://vertex-protocol.gitbook.io/docs/developer-resources/api).
See [SDK docs](https://vertex-protocol.github.io/vertex-python-sdk/index.html) to get started.
## Requirements
- Python 3.9 or above
## Installation
You can install the SDK via pip:
```bash
pip install vertex-protocol
```
## Basic usage
### Import the necessary utilities:
```python
from vertex_protocol.client import create_vertex_client, VertexClientMode
from vertex_protocol.contracts.types import DepositCollateralParams
from vertex_protocol.engine_client.types.execute import (
OrderParams,
PlaceOrderParams,
SubaccountParams
)
from vertex_protocol.utils.expiration import OrderType, get_expiration_timestamp
from vertex_protocol.utils.math import to_pow_10, to_x18
from vertex_protocol.utils.nonce import gen_order_nonce
```
### Create the VertexClient providing your private key:
```python
print("setting up vertex client...")
private_key = "xxx"
client = create_vertex_client(VertexClientMode.MAINNET, private_key)
```
### Perform basic operations:
```python
# Depositing collaterals
print("approving allowance...")
approve_allowance_tx_hash = client.spot.approve_allowance(0, to_pow_10(100000, 6))
print("approve allowance tx hash:", approve_allowance_tx_hash)
print("querying my allowance...")
token_allowance = client.spot.get_token_allowance(0, client.context.signer.address)
print("token allowance:", token_allowance)
print("depositing collateral...")
deposit_tx_hash = client.spot.deposit(
DepositCollateralParams(
subaccount_name="default", product_id=0, amount=to_pow_10(100000, 6)
)
)
print("deposit collateral tx hash:", deposit_tx_hash)
# Placing orders
print("placing order...")
owner = client.context.engine_client.signer.address
product_id = 1
order = OrderParams(
sender=SubaccountParams(
subaccount_owner=owner,
subaccount_name="default",
),
priceX18=to_x18(20000),
amount=to_pow_10(1, 17),
expiration=get_expiration_timestamp(OrderType.POST_ONLY, int(time.time()) + 40),
nonce=gen_order_nonce(),
)
res = client.market.place_order({"product_id": product_id, "order": order})
print("order result:", res.json(indent=2))
```
See [Getting Started](https://vertex-protocol.github.io/vertex-python-sdk/getting-started.html) for more.
## Running locally
1. Clone [github repo](https://github.com/vertex-protocol/vertex-python-sdk)
2. Install poetry
```
$ curl -sSL https://install.python-poetry.org | python3 -
```
3. Setup a virtual environment and activate it
```
$ python3 -m venv venv
$ source ./venv/bin/activate
```
4. Install dependencies via `poetry install`
5. Setup an `.env` file and set the following envvars
```shell
CLIENT_MODE='mainnet|sepolia-testnet|devnet'
SIGNER_PRIVATE_KEY="0x..."
LINKED_SIGNER_PRIVATE_KEY="0x..." # not required
```
### Run tests
```
$ poetry run test
```
### Run sanity checks
- `poetry run client-sanity`: runs sanity checks for the top-level client.
- `poetry run engine-sanity`: runs sanity checks for the `engine-client`.
- `poetry run indexer-sanity`: runs sanity checks for the `indexer-client`.
- `poetry run contracts-sanity`: runs sanity checks for the contracts module.
### Build Docs
To build the docs locally run:
```
$ poetry run sphinx-build docs/source docs/build
```
Raw data
{
"_id": null,
"home_page": "https://vertexprotocol.com/",
"name": "vertex-protocol",
"maintainer": "Frank Jia",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "frank@vertexprotocol.com",
"keywords": "vertex protocol, vertex sdk, vertex protocol api",
"author": "Jeury Mejia",
"author_email": "jeury@vertexprotocol.com",
"download_url": "https://files.pythonhosted.org/packages/fb/8e/85244b40cf7311f781ec10d6751293701e1c6a86a9d0294471d97f8808ca/vertex_protocol-2.1.9.tar.gz",
"platform": null,
"description": "# Vertex Protocol Python SDK\n\nThis is the Python SDK for the [Vertex Protocol API](https://vertex-protocol.gitbook.io/docs/developer-resources/api).\n\nSee [SDK docs](https://vertex-protocol.github.io/vertex-python-sdk/index.html) to get started.\n\n## Requirements\n\n- Python 3.9 or above\n\n## Installation\n\nYou can install the SDK via pip:\n\n```bash\npip install vertex-protocol\n```\n\n## Basic usage\n\n### Import the necessary utilities:\n\n```python\nfrom vertex_protocol.client import create_vertex_client, VertexClientMode\nfrom vertex_protocol.contracts.types import DepositCollateralParams\nfrom vertex_protocol.engine_client.types.execute import (\n OrderParams,\n PlaceOrderParams,\n SubaccountParams\n)\nfrom vertex_protocol.utils.expiration import OrderType, get_expiration_timestamp\nfrom vertex_protocol.utils.math import to_pow_10, to_x18\nfrom vertex_protocol.utils.nonce import gen_order_nonce\n```\n\n### Create the VertexClient providing your private key:\n\n```python\nprint(\"setting up vertex client...\")\nprivate_key = \"xxx\"\nclient = create_vertex_client(VertexClientMode.MAINNET, private_key)\n```\n\n### Perform basic operations:\n\n```python\n# Depositing collaterals\nprint(\"approving allowance...\")\napprove_allowance_tx_hash = client.spot.approve_allowance(0, to_pow_10(100000, 6))\nprint(\"approve allowance tx hash:\", approve_allowance_tx_hash)\n\nprint(\"querying my allowance...\")\ntoken_allowance = client.spot.get_token_allowance(0, client.context.signer.address)\nprint(\"token allowance:\", token_allowance)\n\nprint(\"depositing collateral...\")\ndeposit_tx_hash = client.spot.deposit(\n DepositCollateralParams(\n subaccount_name=\"default\", product_id=0, amount=to_pow_10(100000, 6)\n )\n)\nprint(\"deposit collateral tx hash:\", deposit_tx_hash)\n\n# Placing orders\nprint(\"placing order...\")\nowner = client.context.engine_client.signer.address\nproduct_id = 1\norder = OrderParams(\n sender=SubaccountParams(\n subaccount_owner=owner,\n subaccount_name=\"default\",\n ),\n priceX18=to_x18(20000),\n amount=to_pow_10(1, 17),\n expiration=get_expiration_timestamp(OrderType.POST_ONLY, int(time.time()) + 40),\n nonce=gen_order_nonce(),\n)\nres = client.market.place_order({\"product_id\": product_id, \"order\": order})\nprint(\"order result:\", res.json(indent=2))\n```\n\nSee [Getting Started](https://vertex-protocol.github.io/vertex-python-sdk/getting-started.html) for more.\n\n## Running locally\n\n1. Clone [github repo](https://github.com/vertex-protocol/vertex-python-sdk)\n\n2. Install poetry\n\n```\n\n$ curl -sSL https://install.python-poetry.org | python3 -\n\n```\n\n3. Setup a virtual environment and activate it\n\n```\n\n$ python3 -m venv venv\n$ source ./venv/bin/activate\n\n```\n\n4. Install dependencies via `poetry install`\n5. Setup an `.env` file and set the following envvars\n\n```shell\nCLIENT_MODE='mainnet|sepolia-testnet|devnet'\nSIGNER_PRIVATE_KEY=\"0x...\"\nLINKED_SIGNER_PRIVATE_KEY=\"0x...\" # not required\n```\n\n### Run tests\n\n```\n$ poetry run test\n```\n\n### Run sanity checks\n\n- `poetry run client-sanity`: runs sanity checks for the top-level client.\n- `poetry run engine-sanity`: runs sanity checks for the `engine-client`.\n- `poetry run indexer-sanity`: runs sanity checks for the `indexer-client`.\n- `poetry run contracts-sanity`: runs sanity checks for the contracts module.\n\n### Build Docs\n\nTo build the docs locally run:\n\n```\n$ poetry run sphinx-build docs/source docs/build\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Vertex Protocol SDK",
"version": "2.1.9",
"project_urls": {
"Documentation": "https://vertex-protocol.github.io/vertex-python-sdk/",
"Homepage": "https://vertexprotocol.com/"
},
"split_keywords": [
"vertex protocol",
" vertex sdk",
" vertex protocol api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7800e8a4ea45dd09d53a77666f66cd60d865a0f732d9310ec7166ebff8012cc8",
"md5": "cd7aa3bb56ec70334d21224f990b8e7a",
"sha256": "bd9796dfbf5cedba432cb67df43ce6ea4fb74d0b312a73de294ac67323e9e261"
},
"downloads": -1,
"filename": "vertex_protocol-2.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd7aa3bb56ec70334d21224f990b8e7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 91893,
"upload_time": "2024-11-21T20:27:31",
"upload_time_iso_8601": "2024-11-21T20:27:31.306840Z",
"url": "https://files.pythonhosted.org/packages/78/00/e8a4ea45dd09d53a77666f66cd60d865a0f732d9310ec7166ebff8012cc8/vertex_protocol-2.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb8e85244b40cf7311f781ec10d6751293701e1c6a86a9d0294471d97f8808ca",
"md5": "3741f1906bfb481c82435a1e1c995ee0",
"sha256": "9f6b94f98125c9c904d6b0d7520fd3513d4a6df383c6652d7da15346fe7d19cb"
},
"downloads": -1,
"filename": "vertex_protocol-2.1.9.tar.gz",
"has_sig": false,
"md5_digest": "3741f1906bfb481c82435a1e1c995ee0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 62317,
"upload_time": "2024-11-21T20:27:32",
"upload_time_iso_8601": "2024-11-21T20:27:32.988240Z",
"url": "https://files.pythonhosted.org/packages/fb/8e/85244b40cf7311f781ec10d6751293701e1c6a86a9d0294471d97f8808ca/vertex_protocol-2.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 20:27:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vertex-protocol"
}
JSON