diff --git a/docs/pages/node-client/public/get_market_mapper_revenue_share_details.mdx b/docs/pages/node-client/public/get_market_mapper_revenue_share_details.mdx new file mode 100644 index 000000000..9e55a5a9a --- /dev/null +++ b/docs/pages/node-client/public/get_market_mapper_revenue_share_details.mdx @@ -0,0 +1,44 @@ +### Get Market Mapper Revenue Share Details + +Retrieves market mapper revenue share details + +#### Method Declaration + +:::code-group + +```python [Python] +async def get_market_mapper_revenue_share_details(self, market_id: int) -> QueryMarketMapperRevShareDetailsResponse +``` + +```typescript [TypeScript] +``` + +```rust [Rust] +``` + +```url [API] + +``` + +::: + +#### Parameters + +| Parameter | Location | Type | Required | Description | +| ----------- | -------- | --------- | -------- | ------------------------------------------------------ | +| `market_id` | query | int | true | Market id | + + +#### Response + +| Status | Meaning | Schema | Description | +| ------ | ------------- | --------------------------------------------- | ------------------------------------- | +| `200` | [OK] | [QueryMarketMapperRevShareDetailsResponse] | Market mapper revenue share details | +| `400` | [Bad Request] | | The request was malformed or invalid. | + +Examples: [Python] + +[Python]: https://github.com/dydxprotocol/v4-clients/blob/95f2ad4b7d87e2c8f819138fcbe903826af47230/v4-client-py-v2/examples/revenue_share_example.py +[OK]: /types/ok +[QueryMarketMapperRevShareDetailsResponse]: /types/query_market_mapper_revenue_share_details_response +[Bad Request]: /types/bad-request diff --git a/docs/pages/node-client/public/get_market_mapper_revenue_share_param.mdx b/docs/pages/node-client/public/get_market_mapper_revenue_share_param.mdx new file mode 100644 index 000000000..89874da37 --- /dev/null +++ b/docs/pages/node-client/public/get_market_mapper_revenue_share_param.mdx @@ -0,0 +1,39 @@ +### Get Market Mapper Revenue Share Parmas + +Retrieves market mapper revenue share params + +#### Method Declaration + +:::code-group + +```python [Python] +async def get_market_mapper_revenue_share_param(self) -> QueryMarketMapperRevenueShareParamsResponse +``` + +```typescript [TypeScript] +``` + +```rust [Rust] +``` + +```url [API] + +``` + +::: + +#### Parameters + +#### Response + +| Status | Meaning | Schema | Description | +| ------ | ------------- | --------------------------------------------- | ------------------------------------- | +| `200` | [OK] | [QueryMarketMapperRevenueShareParamsResponse] | Market mapper revenue share params | +| `400` | [Bad Request] | | The request was malformed or invalid. | + +Examples: [Python] + +[Python]: https://github.com/dydxprotocol/v4-clients/blob/95f2ad4b7d87e2c8f819138fcbe903826af47230/v4-client-py-v2/examples/revenue_share_example.py +[OK]: /types/ok +[QueryMarketMapperRevenueShareParamsResponse]: /types/query_market_mapper_revenue_share_params_response +[Bad Request]: /types/bad-request diff --git a/docs/pages/node-client/public/get_order_router_revenue_share.mdx b/docs/pages/node-client/public/get_order_router_revenue_share.mdx new file mode 100644 index 000000000..425007417 --- /dev/null +++ b/docs/pages/node-client/public/get_order_router_revenue_share.mdx @@ -0,0 +1,44 @@ +### Get Order Router Revenue share + +Retrieves order router revenue share + +#### Method Declaration + +:::code-group + +```python [Python] +async def get_order_router_revenue_share(self, address: str) -> QueryOrderRouterRevShareResponse +``` + +```typescript [TypeScript] +``` + +```rust [Rust] +``` + +```url [API] + +``` + +::: + +#### Parameters + +| Parameter | Location | Type | Mandatory | Description | +| --------- | -------- | ------ | --------- | -------------------------------------- | +| address | Query | string | true | Address of the revenue share recipient | + + +#### Response + +| Status | Meaning | Schema | Description | +| ------ | ------------- | --------------------------------------------- | ------------------------------------- | +| `200` | [OK] | [QueryOrderRouterRevShareResponse] | Order router revenue share | +| `400` | [Bad Request] | | The request was malformed or invalid. | + +Examples: [Python] + +[Python]: https://github.com/dydxprotocol/v4-clients/blob/95f2ad4b7d87e2c8f819138fcbe903826af47230/v4-client-py-v2/examples/revenue_share_example.py +[OK]: /types/ok +[QueryOrderRouterRevShareResponse]: /types/query_order_router_revenue_share_response +[Bad Request]: /types/bad-request diff --git a/docs/pages/node-client/public/get_unconditional_revenue_sharing_config.mdx b/docs/pages/node-client/public/get_unconditional_revenue_sharing_config.mdx new file mode 100644 index 000000000..5672e1aaf --- /dev/null +++ b/docs/pages/node-client/public/get_unconditional_revenue_sharing_config.mdx @@ -0,0 +1,40 @@ +### Get Unconditional Revenue Sharing Config + +Retrieves unconditional revenue share config + + +#### Method Declaration + +:::code-group + +```python [Python] +async def get_unconditional_revenue_sharing_config(self) -> QueryUnconditionalRevShareConfigResponse +``` + +```typescript [TypeScript] +``` + +```rust [Rust] +``` + +```url [API] + +``` + +::: + +#### Parameters + +#### Response + +| Status | Meaning | Schema | Description | +| ------ | ------------- | --------------------------------------------- | ------------------------------------- | +| `200` | [OK] | [QueryUnconditionalRevShareConfigResponse] | Unconditional revenue share config | +| `400` | [Bad Request] | | The request was malformed or invalid. | + +Examples: [Python] + +[Python]: https://github.com/dydxprotocol/v4-clients/blob/95f2ad4b7d87e2c8f819138fcbe903826af47230/v4-client-py-v2/examples/revenue_share_example.py +[OK]: /types/ok +[QueryUnconditionalRevShareConfigResponse]: /types/query_unconditional_revenue_share_config_response +[Bad Request]: /types/bad-request diff --git a/docs/pages/node-client/public/index.mdx b/docs/pages/node-client/public/index.mdx index eb3bed19c..d10ca8818 100644 --- a/docs/pages/node-client/public/index.mdx +++ b/docs/pages/node-client/public/index.mdx @@ -32,6 +32,10 @@ import GetReferredBy from './get_referred_by.mdx' import GetWithdrawalAndTransferGatingStatus from './get_withdrawal_and_transfer_gating_status.mdx' import GetWithdrawalCapacityByDenom from './get_withdrawal_capacity_by_denom.mdx' import QueryAddress from './query_address.mdx' +import GetMarketMapperRevenueShareDetails from './get_market_mapper_revenue_share_details.mdx' +import GetMarketMapperRevenueShareParam from './get_market_mapper_revenue_share_param.mdx' +import GetOrderRouterRevenueShare from './get_order_router_revenue_share.mdx' +import GetUnconditionalRevenueShareConfig from './get_unconditional_revenue_sharing_config.mdx' @@ -66,3 +70,7 @@ import QueryAddress from './query_address.mdx' + + + + diff --git a/docs/pages/types/market_mapper_rev_share_details.mdx b/docs/pages/types/market_mapper_rev_share_details.mdx new file mode 100644 index 000000000..5b7b4e4d1 --- /dev/null +++ b/docs/pages/types/market_mapper_rev_share_details.mdx @@ -0,0 +1,4 @@ +# MarketMapperRevShareDetails + +`expiration_ts`: int + diff --git a/docs/pages/types/market_mapper_revenue_share_params.txt b/docs/pages/types/market_mapper_revenue_share_params.txt new file mode 100644 index 000000000..80460c607 --- /dev/null +++ b/docs/pages/types/market_mapper_revenue_share_params.txt @@ -0,0 +1,7 @@ +# MarketMapperRevenueShareParams + +`address`: string + +`revenue_share_ppm`: int + +`valid_days`: int diff --git a/docs/pages/types/order.mdx b/docs/pages/types/order.mdx index 8e8fd1473..3a7f23a5d 100644 --- a/docs/pages/types/order.mdx +++ b/docs/pages/types/order.mdx @@ -41,7 +41,6 @@ Order represents a single order belonging to a `Subaccount` for a particular `Cl - Must be a multiple of ClobPair.SubticksPerTick (where `ClobPair.Id = orderId.ClobPairId`) `twap_parameters`: [TwapParameters] -> **Note:** This field will be introduced in a future version of the API (v9.0). - Configuration for a TWAP order - Must be set for TWAP orders - Ignored for all other order types @@ -53,6 +52,9 @@ Order represents a single order belonging to a `Subaccount` for a particular `Cl `good_til_oneof`: [GoodTilOneof] - Information about when the order expires +`order_router_address`: string +- Router address to share the revenue + [OrderId]: /types/order_id [OrderSide]: /types/order_side [i32]: /types/i32 diff --git a/docs/pages/types/order_router_rev_share.mdx b/docs/pages/types/order_router_rev_share.mdx new file mode 100644 index 000000000..b898b6062 --- /dev/null +++ b/docs/pages/types/order_router_rev_share.mdx @@ -0,0 +1,5 @@ +# OrderRouterRevShare + +`address`: string + +`share_ppm`: int diff --git a/docs/pages/types/query_market_mapper_revenue_share_details_response.mdx b/docs/pages/types/query_market_mapper_revenue_share_details_response.mdx new file mode 100644 index 000000000..21e2f3618 --- /dev/null +++ b/docs/pages/types/query_market_mapper_revenue_share_details_response.mdx @@ -0,0 +1,5 @@ +# QueryMarketMapperRevShareDetailsResponse + +`details`: [MarketMapperRevShareDetails] + +[MarketMapperRevShareDetails]: /types/market_mapper_rev_share_details \ No newline at end of file diff --git a/docs/pages/types/query_market_mapper_revenue_share_params_response.mdx b/docs/pages/types/query_market_mapper_revenue_share_params_response.mdx new file mode 100644 index 000000000..2f1fa3167 --- /dev/null +++ b/docs/pages/types/query_market_mapper_revenue_share_params_response.mdx @@ -0,0 +1,5 @@ +# QueryMarketMapperRevenueShareParamsResponse + +`params`: [MarketMapperRevenueShareParams] + +[MarketMapperRevenueShareParams]: /types/market_mapper_revenue_share_params \ No newline at end of file diff --git a/docs/pages/types/query_order_router_revenue_share_response.mdx b/docs/pages/types/query_order_router_revenue_share_response.mdx new file mode 100644 index 000000000..0d2bc4162 --- /dev/null +++ b/docs/pages/types/query_order_router_revenue_share_response.mdx @@ -0,0 +1,5 @@ +# QueryOrderRouterRevShareResponse + +`order_router_rev_share`: [OrderRouterRevShare] + +[OrderRouterRevShare]: /types/order_router_rev_share \ No newline at end of file diff --git a/docs/pages/types/query_unconditional_revenue_share_config_response.mdx b/docs/pages/types/query_unconditional_revenue_share_config_response.mdx new file mode 100644 index 000000000..068fd80a0 --- /dev/null +++ b/docs/pages/types/query_unconditional_revenue_share_config_response.mdx @@ -0,0 +1,5 @@ +# QueryUnconditionalRevShareConfigResponse + +`config`: [UnconditionalRevShareConfig] ⛁ + +[UnconditionalRevShareConfig]: /types/unconditional_rev_share_config diff --git a/docs/pages/types/recipient_config.mdx b/docs/pages/types/recipient_config.mdx new file mode 100644 index 000000000..91813eef4 --- /dev/null +++ b/docs/pages/types/recipient_config.mdx @@ -0,0 +1,5 @@ +# RecipientConfig + +`address`: string + +`share_ppm`: int \ No newline at end of file diff --git a/docs/pages/types/unconditional_rev_share_config.mdx b/docs/pages/types/unconditional_rev_share_config.mdx new file mode 100644 index 000000000..deb4122e2 --- /dev/null +++ b/docs/pages/types/unconditional_rev_share_config.mdx @@ -0,0 +1,5 @@ +# UnconditionalRevShareConfig + +`configs`: [RecipientConfig] + +[RecipientConfig]: /types/recipient_config