Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions docs/pages/node-client/public/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'

<PublicApi />
<GetAccountBalances />
Expand Down Expand Up @@ -66,3 +70,7 @@ import QueryAddress from './query_address.mdx'
<GetWithdrawalAndTransferGatingStatus />
<GetWithdrawalCapacityByDenom />
<QueryAddress />
<GetOrderRouterRevenueShare />
<GetMarketMapperRevenueShareDetails />
<GetMarketMapperRevenueShareParam />
<GetUnconditionalRevenueShareConfig />
4 changes: 4 additions & 0 deletions docs/pages/types/market_mapper_rev_share_details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# MarketMapperRevShareDetails

`expiration_ts`: int

7 changes: 7 additions & 0 deletions docs/pages/types/market_mapper_revenue_share_params.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# MarketMapperRevenueShareParams

`address`: string

`revenue_share_ppm`: int

`valid_days`: int
4 changes: 3 additions & 1 deletion docs/pages/types/order.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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] <Opt/>
> **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
Expand All @@ -53,6 +52,9 @@ Order represents a single order belonging to a `Subaccount` for a particular `Cl
`good_til_oneof`: [GoodTilOneof] <Opt/>
- Information about when the order expires

`order_router_address`: string <Opt/>
- Router address to share the revenue

[OrderId]: /types/order_id
[OrderSide]: /types/order_side
[i32]: /types/i32
Expand Down
5 changes: 5 additions & 0 deletions docs/pages/types/order_router_rev_share.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# OrderRouterRevShare

`address`: string

`share_ppm`: int
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# QueryMarketMapperRevShareDetailsResponse

`details`: [MarketMapperRevShareDetails]

[MarketMapperRevShareDetails]: /types/market_mapper_rev_share_details
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# QueryMarketMapperRevenueShareParamsResponse

`params`: [MarketMapperRevenueShareParams]

[MarketMapperRevenueShareParams]: /types/market_mapper_revenue_share_params
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# QueryOrderRouterRevShareResponse

`order_router_rev_share`: [OrderRouterRevShare]

[OrderRouterRevShare]: /types/order_router_rev_share
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# QueryUnconditionalRevShareConfigResponse

`config`: [UnconditionalRevShareConfig] ⛁

[UnconditionalRevShareConfig]: /types/unconditional_rev_share_config
5 changes: 5 additions & 0 deletions docs/pages/types/recipient_config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# RecipientConfig

`address`: string

`share_ppm`: int
5 changes: 5 additions & 0 deletions docs/pages/types/unconditional_rev_share_config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# UnconditionalRevShareConfig

`configs`: [RecipientConfig]

[RecipientConfig]: /types/recipient_config
Loading