@compass-labs/api-sdk 2.2.67-rc.0 → 2.2.68-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/codeSamples_typescript.yaml +8 -2
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +26 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +136 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -0
- package/dist/commonjs/models/components/index.d.ts +3 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +3 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetschargefeerequest.d.ts +42 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeerequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeerequest.js +57 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeerequest.js.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeeresponse.d.ts +35 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeeresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeeresponse.js +62 -0
- package/dist/commonjs/models/components/tokenizedassetschargefeeresponse.js.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetsfee.d.ts +57 -0
- package/dist/commonjs/models/components/tokenizedassetsfee.d.ts.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetsfee.js +66 -0
- package/dist/commonjs/models/components/tokenizedassetsfee.js.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetstraderequest.d.ts +6 -0
- package/dist/commonjs/models/components/tokenizedassetstraderequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetstraderequest.js +2 -0
- package/dist/commonjs/models/components/tokenizedassetstraderequest.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts +4 -0
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.js +2 -0
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsorderorderhashchargefee.d.ts +15 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsorderorderhashchargefee.d.ts.map +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsorderorderhashchargefee.js +57 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsorderorderhashchargefee.js.map +1 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts +14 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/commonjs/sdk/tokenizedassets.js +17 -0
- package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +26 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +100 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -0
- package/dist/esm/models/components/index.d.ts +3 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +3 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetschargefeerequest.d.ts +42 -0
- package/dist/esm/models/components/tokenizedassetschargefeerequest.d.ts.map +1 -0
- package/dist/esm/models/components/tokenizedassetschargefeerequest.js +20 -0
- package/dist/esm/models/components/tokenizedassetschargefeerequest.js.map +1 -0
- package/dist/esm/models/components/tokenizedassetschargefeeresponse.d.ts +35 -0
- package/dist/esm/models/components/tokenizedassetschargefeeresponse.d.ts.map +1 -0
- package/dist/esm/models/components/tokenizedassetschargefeeresponse.js +25 -0
- package/dist/esm/models/components/tokenizedassetschargefeeresponse.js.map +1 -0
- package/dist/esm/models/components/tokenizedassetsfee.d.ts +57 -0
- package/dist/esm/models/components/tokenizedassetsfee.d.ts.map +1 -0
- package/dist/esm/models/components/tokenizedassetsfee.js +28 -0
- package/dist/esm/models/components/tokenizedassetsfee.js.map +1 -0
- package/dist/esm/models/components/tokenizedassetstraderequest.d.ts +6 -0
- package/dist/esm/models/components/tokenizedassetstraderequest.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetstraderequest.js +2 -0
- package/dist/esm/models/components/tokenizedassetstraderequest.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts +4 -0
- package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetstraderesponse.js +2 -0
- package/dist/esm/models/components/tokenizedassetstraderesponse.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsorderorderhashchargefee.d.ts +15 -0
- package/dist/esm/models/operations/v2tokenizedassetsorderorderhashchargefee.d.ts.map +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsorderorderhashchargefee.js +20 -0
- package/dist/esm/models/operations/v2tokenizedassetsorderorderhashchargefee.js.map +1 -0
- package/dist/esm/sdk/tokenizedassets.d.ts +14 -0
- package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/esm/sdk/tokenizedassets.js +17 -0
- package/dist/esm/sdk/tokenizedassets.js.map +1 -1
- package/docs/models/components/tokenizedassetschargefeerequest.md +32 -0
- package/docs/models/components/tokenizedassetschargefeeresponse.md +26 -0
- package/docs/models/components/tokenizedassetsfee.md +27 -0
- package/docs/models/components/tokenizedassetsfeeamount.md +19 -0
- package/docs/models/components/tokenizedassetsfeedenomination.md +17 -0
- package/docs/models/components/tokenizedassetstraderequest.md +7 -1
- package/docs/models/components/tokenizedassetstraderesponse.md +2 -1
- package/docs/models/operations/v2tokenizedassetsorderorderhashchargefeerequest.md +27 -0
- package/docs/sdks/tokenizedassets/README.md +120 -0
- package/openapi_prepped_for_speakeasy.json +190 -0
- package/package.json +1 -1
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.ts +191 -0
- package/src/models/components/index.ts +3 -0
- package/src/models/components/tokenizedassetschargefeerequest.ts +74 -0
- package/src/models/components/tokenizedassetschargefeeresponse.ts +72 -0
- package/src/models/components/tokenizedassetsfee.ts +98 -0
- package/src/models/components/tokenizedassetstraderequest.ts +11 -0
- package/src/models/components/tokenizedassetstraderesponse.ts +6 -0
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/v2tokenizedassetsorderorderhashchargefee.ts +47 -0
- package/src/sdk/tokenizedassets.ts +25 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TokenizedAssetsChargeFeeResponse
|
|
2
|
+
|
|
3
|
+
Unsigned USDC fee transfer for the owner to sign.
|
|
4
|
+
|
|
5
|
+
Exactly one of `transaction` (gas_sponsorship=false) or `eip_712`
|
|
6
|
+
(gas_sponsorship=true) is set.
|
|
7
|
+
|
|
8
|
+
## Example Usage
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
import { TokenizedAssetsChargeFeeResponse } from "@compass-labs/api-sdk/models/components";
|
|
12
|
+
|
|
13
|
+
let value: TokenizedAssetsChargeFeeResponse = {
|
|
14
|
+
feeAmount: "<value>",
|
|
15
|
+
proceeds: "<value>",
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Fields
|
|
20
|
+
|
|
21
|
+
| Field | Type | Required | Description |
|
|
22
|
+
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
23
|
+
| `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign: | Unsigned transaction transferring the fee from the product account. |
|
|
24
|
+
| `eip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 payload for gas-sponsored execution. |
|
|
25
|
+
| `feeAmount` | *string* | :heavy_check_mark: | Fee charged, in USDC. |
|
|
26
|
+
| `proceeds` | *string* | :heavy_check_mark: | Filled USDC proceeds the fee was computed on. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TokenizedAssetsFee
|
|
2
|
+
|
|
3
|
+
Fee configuration for tokenized-asset trades.
|
|
4
|
+
|
|
5
|
+
Same shape as `Fee`, but narrows `denomination` to the values supported by
|
|
6
|
+
tokenized-asset trades. PERFORMANCE is not supported because realized-profit
|
|
7
|
+
fees are not computed for spot buy/sell trades.
|
|
8
|
+
|
|
9
|
+
## Example Usage
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { TokenizedAssetsFee } from "@compass-labs/api-sdk/models/components";
|
|
13
|
+
|
|
14
|
+
let value: TokenizedAssetsFee = {
|
|
15
|
+
recipient: "<value>",
|
|
16
|
+
amount: "128.57",
|
|
17
|
+
denomination: "PERCENTAGE",
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Fields
|
|
22
|
+
|
|
23
|
+
| Field | Type | Required | Description | Example |
|
|
24
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
25
|
+
| `recipient` | *string* | :heavy_check_mark: | The wallet address that will receive the fee. | |
|
|
26
|
+
| `amount` | *components.TokenizedAssetsFeeAmount* | :heavy_check_mark: | The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit). | |
|
|
27
|
+
| `denomination` | [components.TokenizedAssetsFeeDenomination](../../models/components/tokenizedassetsfeedenomination.md) | :heavy_minus_sign: | The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the trade proceeds), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens). | PERCENTAGE |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TokenizedAssetsFeeAmount
|
|
2
|
+
|
|
3
|
+
The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit).
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Supported Types
|
|
7
|
+
|
|
8
|
+
### `number`
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
const value: number = 1284.03;
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### `string`
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
const value: string = "<value>";
|
|
18
|
+
```
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TokenizedAssetsFeeDenomination
|
|
2
|
+
|
|
3
|
+
The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the trade proceeds), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { TokenizedAssetsFeeDenomination } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: TokenizedAssetsFeeDenomination = "PERCENTAGE";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"PERCENTAGE" | "FIXED"
|
|
17
|
+
```
|
|
@@ -18,6 +18,11 @@ let value: TokenizedAssetsTradeRequest = {
|
|
|
18
18
|
owner: "<value>",
|
|
19
19
|
chain: "ethereum",
|
|
20
20
|
gasSponsorship: false,
|
|
21
|
+
fee: {
|
|
22
|
+
recipient: "<value>",
|
|
23
|
+
amount: "420.91",
|
|
24
|
+
denomination: "PERCENTAGE",
|
|
25
|
+
},
|
|
21
26
|
};
|
|
22
27
|
```
|
|
23
28
|
|
|
@@ -31,4 +36,5 @@ let value: TokenizedAssetsTradeRequest = {
|
|
|
31
36
|
| `slippage` | *components.TokenizedAssetsTradeRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). | 0.5 |
|
|
32
37
|
| `owner` | *string* | :heavy_check_mark: | The owner's wallet address. | |
|
|
33
38
|
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
|
|
34
|
-
| `gasSponsorship` | *boolean* | :heavy_minus_sign: | When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction. | false |
|
|
39
|
+
| `gasSponsorship` | *boolean* | :heavy_minus_sign: | When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction. | false |
|
|
40
|
+
| `fee` | [components.TokenizedAssetsFee](../../models/components/tokenizedassetsfee.md) | :heavy_minus_sign: | Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution. | |
|
|
@@ -21,4 +21,5 @@ let value: TokenizedAssetsTradeResponse = {
|
|
|
21
21
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
22
22
|
| `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign: | Unsigned transaction executing the trade in the product account. |
|
|
23
23
|
| `eip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 payload for gas-sponsored execution. |
|
|
24
|
-
| `estimatedAmountOut` | *string* | :heavy_check_mark: | Estimated amount of `token_out` received (human-readable units). |
|
|
24
|
+
| `estimatedAmountOut` | *string* | :heavy_check_mark: | Estimated amount of `token_out` received (human-readable units). |
|
|
25
|
+
| `feeAmount` | *string* | :heavy_minus_sign: | Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# V2TokenizedAssetsOrderOrderHashChargeFeeRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { V2TokenizedAssetsOrderOrderHashChargeFeeRequest } from "@compass-labs/api-sdk/models/operations";
|
|
7
|
+
|
|
8
|
+
let value: V2TokenizedAssetsOrderOrderHashChargeFeeRequest = {
|
|
9
|
+
orderHash: "<value>",
|
|
10
|
+
tokenizedAssetsChargeFeeRequest: {
|
|
11
|
+
owner: "<value>",
|
|
12
|
+
fee: {
|
|
13
|
+
recipient: "<value>",
|
|
14
|
+
amount: "420.91",
|
|
15
|
+
denomination: "PERCENTAGE",
|
|
16
|
+
},
|
|
17
|
+
gasSponsorship: false,
|
|
18
|
+
},
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Fields
|
|
23
|
+
|
|
24
|
+
| Field | Type | Required | Description |
|
|
25
|
+
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `orderHash` | *string* | :heavy_check_mark: | N/A |
|
|
27
|
+
| `tokenizedAssetsChargeFeeRequest` | [components.TokenizedAssetsChargeFeeRequest](../../models/components/tokenizedassetschargefeerequest.md) | :heavy_check_mark: | N/A |
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
* [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a tokenized-equity buy/sell order (Ondo)
|
|
16
16
|
* [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed tokenized-equity order (Ondo)
|
|
17
17
|
* [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled tokenized-equity order (Ondo)
|
|
18
|
+
* [tokenizedAssetsOrderOrderHashChargeFee](#tokenizedassetsorderorderhashchargefee) - Charge a partner fee on a filled sell order's USDC proceeds
|
|
18
19
|
* [tokenizedAssetsTransactBuy](#tokenizedassetstransactbuy) - Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
|
|
19
20
|
* [tokenizedAssetsTransactSell](#tokenizedassetstransactsell) - Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
|
|
20
21
|
|
|
@@ -1042,6 +1043,105 @@ run();
|
|
|
1042
1043
|
| errors.TokenizedAssetsErrorResponse | 502 | application/json |
|
|
1043
1044
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1044
1045
|
|
|
1046
|
+
## tokenizedAssetsOrderOrderHashChargeFee
|
|
1047
|
+
|
|
1048
|
+
Build a USDC fee transfer on a filled equity sell order's proceeds.
|
|
1049
|
+
|
|
1050
|
+
Equity orders fill off-chain via a third-party resolver, so the fee can't be
|
|
1051
|
+
bundled into the trade. Once the sell order has filled, call this with the
|
|
1052
|
+
order hash and your `fee` (recipient + percentage/fixed); it reads the actual
|
|
1053
|
+
filled USDC proceeds and returns a `transfer(recipient, fee)` executed by the
|
|
1054
|
+
product account — an unsigned transaction the owner signs, or an EIP-712
|
|
1055
|
+
payload when `gas_sponsorship` is true.
|
|
1056
|
+
|
|
1057
|
+
### Example Usage
|
|
1058
|
+
|
|
1059
|
+
<!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_order_{order_hash}_charge_fee" method="post" path="/v2/tokenized_assets/order/{order_hash}/charge_fee" -->
|
|
1060
|
+
```typescript
|
|
1061
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
1062
|
+
|
|
1063
|
+
const compassApiSDK = new CompassApiSDK({
|
|
1064
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1065
|
+
});
|
|
1066
|
+
|
|
1067
|
+
async function run() {
|
|
1068
|
+
const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsOrderOrderHashChargeFee({
|
|
1069
|
+
orderHash: "<value>",
|
|
1070
|
+
tokenizedAssetsChargeFeeRequest: {
|
|
1071
|
+
owner: "<value>",
|
|
1072
|
+
fee: {
|
|
1073
|
+
recipient: "<value>",
|
|
1074
|
+
amount: 8619.46,
|
|
1075
|
+
denomination: "PERCENTAGE",
|
|
1076
|
+
},
|
|
1077
|
+
gasSponsorship: false,
|
|
1078
|
+
},
|
|
1079
|
+
});
|
|
1080
|
+
|
|
1081
|
+
console.log(result);
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
run();
|
|
1085
|
+
```
|
|
1086
|
+
|
|
1087
|
+
### Standalone function
|
|
1088
|
+
|
|
1089
|
+
The standalone function version of this method:
|
|
1090
|
+
|
|
1091
|
+
```typescript
|
|
1092
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
1093
|
+
import { tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js";
|
|
1094
|
+
|
|
1095
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
1096
|
+
// You can create one instance of it to use across an application.
|
|
1097
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
1098
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1099
|
+
});
|
|
1100
|
+
|
|
1101
|
+
async function run() {
|
|
1102
|
+
const res = await tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee(compassApiSDK, {
|
|
1103
|
+
orderHash: "<value>",
|
|
1104
|
+
tokenizedAssetsChargeFeeRequest: {
|
|
1105
|
+
owner: "<value>",
|
|
1106
|
+
fee: {
|
|
1107
|
+
recipient: "<value>",
|
|
1108
|
+
amount: 8619.46,
|
|
1109
|
+
denomination: "PERCENTAGE",
|
|
1110
|
+
},
|
|
1111
|
+
gasSponsorship: false,
|
|
1112
|
+
},
|
|
1113
|
+
});
|
|
1114
|
+
if (res.ok) {
|
|
1115
|
+
const { value: result } = res;
|
|
1116
|
+
console.log(result);
|
|
1117
|
+
} else {
|
|
1118
|
+
console.log("tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee failed:", res.error);
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
|
|
1122
|
+
run();
|
|
1123
|
+
```
|
|
1124
|
+
|
|
1125
|
+
### Parameters
|
|
1126
|
+
|
|
1127
|
+
| Parameter | Type | Required | Description |
|
|
1128
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1129
|
+
| `request` | [operations.V2TokenizedAssetsOrderOrderHashChargeFeeRequest](../../models/operations/v2tokenizedassetsorderorderhashchargefeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1130
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1131
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1132
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1133
|
+
|
|
1134
|
+
### Response
|
|
1135
|
+
|
|
1136
|
+
**Promise\<[components.TokenizedAssetsChargeFeeResponse](../../models/components/tokenizedassetschargefeeresponse.md)\>**
|
|
1137
|
+
|
|
1138
|
+
### Errors
|
|
1139
|
+
|
|
1140
|
+
| Error Type | Status Code | Content Type |
|
|
1141
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
1142
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
1143
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1144
|
+
|
|
1045
1145
|
## tokenizedAssetsTransactBuy
|
|
1046
1146
|
|
|
1047
1147
|
Buy (mint) an RWA yield asset (e.g. `mTBILL`) inside the product account.
|
|
@@ -1075,6 +1175,11 @@ async function run() {
|
|
|
1075
1175
|
owner: "<value>",
|
|
1076
1176
|
chain: "ethereum",
|
|
1077
1177
|
gasSponsorship: false,
|
|
1178
|
+
fee: {
|
|
1179
|
+
recipient: "<value>",
|
|
1180
|
+
amount: "841.37",
|
|
1181
|
+
denomination: "PERCENTAGE",
|
|
1182
|
+
},
|
|
1078
1183
|
});
|
|
1079
1184
|
|
|
1080
1185
|
console.log(result);
|
|
@@ -1106,6 +1211,11 @@ async function run() {
|
|
|
1106
1211
|
owner: "<value>",
|
|
1107
1212
|
chain: "ethereum",
|
|
1108
1213
|
gasSponsorship: false,
|
|
1214
|
+
fee: {
|
|
1215
|
+
recipient: "<value>",
|
|
1216
|
+
amount: "841.37",
|
|
1217
|
+
denomination: "PERCENTAGE",
|
|
1218
|
+
},
|
|
1109
1219
|
});
|
|
1110
1220
|
if (res.ok) {
|
|
1111
1221
|
const { value: result } = res;
|
|
@@ -1168,6 +1278,11 @@ async function run() {
|
|
|
1168
1278
|
owner: "<value>",
|
|
1169
1279
|
chain: "ethereum",
|
|
1170
1280
|
gasSponsorship: false,
|
|
1281
|
+
fee: {
|
|
1282
|
+
recipient: "<value>",
|
|
1283
|
+
amount: 3839.45,
|
|
1284
|
+
denomination: "PERCENTAGE",
|
|
1285
|
+
},
|
|
1171
1286
|
});
|
|
1172
1287
|
|
|
1173
1288
|
console.log(result);
|
|
@@ -1199,6 +1314,11 @@ async function run() {
|
|
|
1199
1314
|
owner: "<value>",
|
|
1200
1315
|
chain: "ethereum",
|
|
1201
1316
|
gasSponsorship: false,
|
|
1317
|
+
fee: {
|
|
1318
|
+
recipient: "<value>",
|
|
1319
|
+
amount: 3839.45,
|
|
1320
|
+
denomination: "PERCENTAGE",
|
|
1321
|
+
},
|
|
1202
1322
|
});
|
|
1203
1323
|
if (res.ok) {
|
|
1204
1324
|
const { value: result } = res;
|
|
@@ -7991,6 +7991,60 @@
|
|
|
7991
7991
|
"x-speakeasy-name-override": "tokenized_assets_order_{order_hash}_cancel"
|
|
7992
7992
|
}
|
|
7993
7993
|
},
|
|
7994
|
+
"/v2/tokenized_assets/order/{order_hash}/charge_fee": {
|
|
7995
|
+
"post": {
|
|
7996
|
+
"tags": [
|
|
7997
|
+
"Tokenized Assets"
|
|
7998
|
+
],
|
|
7999
|
+
"summary": "Charge a partner fee on a filled sell order's USDC proceeds",
|
|
8000
|
+
"description": "Build a USDC fee transfer on a filled equity sell order's proceeds.\n\nEquity orders fill off-chain via a third-party resolver, so the fee can't be\nbundled into the trade. Once the sell order has filled, call this with the\norder hash and your `fee` (recipient + percentage/fixed); it reads the actual\nfilled USDC proceeds and returns a `transfer(recipient, fee)` executed by the\nproduct account \u2014 an unsigned transaction the owner signs, or an EIP-712\npayload when `gas_sponsorship` is true.",
|
|
8001
|
+
"operationId": "v2_tokenized_assets_order_{order_hash}_charge_fee",
|
|
8002
|
+
"parameters": [
|
|
8003
|
+
{
|
|
8004
|
+
"name": "order_hash",
|
|
8005
|
+
"in": "path",
|
|
8006
|
+
"required": true,
|
|
8007
|
+
"schema": {
|
|
8008
|
+
"type": "string",
|
|
8009
|
+
"title": "Order Hash"
|
|
8010
|
+
}
|
|
8011
|
+
}
|
|
8012
|
+
],
|
|
8013
|
+
"requestBody": {
|
|
8014
|
+
"required": true,
|
|
8015
|
+
"content": {
|
|
8016
|
+
"application/json": {
|
|
8017
|
+
"schema": {
|
|
8018
|
+
"$ref": "#/components/schemas/TokenizedAssetsChargeFeeRequest"
|
|
8019
|
+
}
|
|
8020
|
+
}
|
|
8021
|
+
}
|
|
8022
|
+
},
|
|
8023
|
+
"responses": {
|
|
8024
|
+
"200": {
|
|
8025
|
+
"description": "Successful Response",
|
|
8026
|
+
"content": {
|
|
8027
|
+
"application/json": {
|
|
8028
|
+
"schema": {
|
|
8029
|
+
"$ref": "#/components/schemas/TokenizedAssetsChargeFeeResponse"
|
|
8030
|
+
}
|
|
8031
|
+
}
|
|
8032
|
+
}
|
|
8033
|
+
},
|
|
8034
|
+
"422": {
|
|
8035
|
+
"description": "Validation Error",
|
|
8036
|
+
"content": {
|
|
8037
|
+
"application/json": {
|
|
8038
|
+
"schema": {
|
|
8039
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
8040
|
+
}
|
|
8041
|
+
}
|
|
8042
|
+
}
|
|
8043
|
+
}
|
|
8044
|
+
},
|
|
8045
|
+
"x-speakeasy-name-override": "tokenized_assets_order_{order_hash}_charge_fee"
|
|
8046
|
+
}
|
|
8047
|
+
},
|
|
7994
8048
|
"/v2/tokenized_assets/transact/buy": {
|
|
7995
8049
|
"post": {
|
|
7996
8050
|
"tags": [
|
|
@@ -22025,6 +22079,77 @@
|
|
|
22025
22079
|
],
|
|
22026
22080
|
"title": "TokenizedAssetsCancelOrderResponse"
|
|
22027
22081
|
},
|
|
22082
|
+
"TokenizedAssetsChargeFeeRequest": {
|
|
22083
|
+
"properties": {
|
|
22084
|
+
"owner": {
|
|
22085
|
+
"type": "string",
|
|
22086
|
+
"title": "Owner",
|
|
22087
|
+
"description": "The owner's wallet address; the product account is derived from it."
|
|
22088
|
+
},
|
|
22089
|
+
"fee": {
|
|
22090
|
+
"$ref": "#/components/schemas/TokenizedAssetsFee",
|
|
22091
|
+
"description": "The partner fee to charge on the sell proceeds, taken in USDC and sent to your fee recipient."
|
|
22092
|
+
},
|
|
22093
|
+
"gas_sponsorship": {
|
|
22094
|
+
"type": "boolean",
|
|
22095
|
+
"title": "Gas Sponsorship",
|
|
22096
|
+
"description": "When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction.",
|
|
22097
|
+
"example": false
|
|
22098
|
+
}
|
|
22099
|
+
},
|
|
22100
|
+
"type": "object",
|
|
22101
|
+
"required": [
|
|
22102
|
+
"owner",
|
|
22103
|
+
"fee"
|
|
22104
|
+
],
|
|
22105
|
+
"title": "TokenizedAssetsChargeFeeRequest",
|
|
22106
|
+
"description": "Charge a partner fee on the USDC proceeds of a filled sell order.\n\nEquity orders fill off-chain via a third-party resolver, so the fee can't\nride inside the trade (unlike Midas/earn/credit). After the sell order\nfills, call this with the order hash to build a USDC `transfer(recipient,\nfee)` executed by the product account."
|
|
22107
|
+
},
|
|
22108
|
+
"TokenizedAssetsChargeFeeResponse": {
|
|
22109
|
+
"properties": {
|
|
22110
|
+
"transaction": {
|
|
22111
|
+
"anyOf": [
|
|
22112
|
+
{
|
|
22113
|
+
"$ref": "#/components/schemas/UnsignedTransaction"
|
|
22114
|
+
},
|
|
22115
|
+
{
|
|
22116
|
+
"type": "null"
|
|
22117
|
+
}
|
|
22118
|
+
],
|
|
22119
|
+
"description": "Unsigned transaction transferring the fee from the product account."
|
|
22120
|
+
},
|
|
22121
|
+
"eip_712": {
|
|
22122
|
+
"anyOf": [
|
|
22123
|
+
{
|
|
22124
|
+
"$ref": "#/components/schemas/BatchedSafeOperationsResponse-Output"
|
|
22125
|
+
},
|
|
22126
|
+
{
|
|
22127
|
+
"type": "null"
|
|
22128
|
+
}
|
|
22129
|
+
],
|
|
22130
|
+
"description": "EIP-712 payload for gas-sponsored execution."
|
|
22131
|
+
},
|
|
22132
|
+
"fee_amount": {
|
|
22133
|
+
"type": "string",
|
|
22134
|
+
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
|
|
22135
|
+
"title": "Fee Amount",
|
|
22136
|
+
"description": "Fee charged, in USDC."
|
|
22137
|
+
},
|
|
22138
|
+
"proceeds": {
|
|
22139
|
+
"type": "string",
|
|
22140
|
+
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
|
|
22141
|
+
"title": "Proceeds",
|
|
22142
|
+
"description": "Filled USDC proceeds the fee was computed on."
|
|
22143
|
+
}
|
|
22144
|
+
},
|
|
22145
|
+
"type": "object",
|
|
22146
|
+
"required": [
|
|
22147
|
+
"fee_amount",
|
|
22148
|
+
"proceeds"
|
|
22149
|
+
],
|
|
22150
|
+
"title": "TokenizedAssetsChargeFeeResponse",
|
|
22151
|
+
"description": "Unsigned USDC fee transfer for the owner to sign.\n\nExactly one of `transaction` (gas_sponsorship=false) or `eip_712`\n(gas_sponsorship=true) is set."
|
|
22152
|
+
},
|
|
22028
22153
|
"TokenizedAssetsErrorResponse": {
|
|
22029
22154
|
"properties": {
|
|
22030
22155
|
"error": {
|
|
@@ -22046,6 +22171,47 @@
|
|
|
22046
22171
|
"title": "TokenizedAssetsErrorResponse",
|
|
22047
22172
|
"description": "Standard error envelope returned by every non-2xx response.\n\nSurfaced in OpenAPI ``responses`` declarations so SDK consumers can decode\nfailures uniformly without inspecting per-status-code shapes."
|
|
22048
22173
|
},
|
|
22174
|
+
"TokenizedAssetsFee": {
|
|
22175
|
+
"properties": {
|
|
22176
|
+
"recipient": {
|
|
22177
|
+
"type": "string",
|
|
22178
|
+
"title": "Recipient",
|
|
22179
|
+
"description": "The wallet address that will receive the fee."
|
|
22180
|
+
},
|
|
22181
|
+
"amount": {
|
|
22182
|
+
"anyOf": [
|
|
22183
|
+
{
|
|
22184
|
+
"type": "number",
|
|
22185
|
+
"exclusiveMinimum": 0.0
|
|
22186
|
+
},
|
|
22187
|
+
{
|
|
22188
|
+
"type": "string",
|
|
22189
|
+
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
|
|
22190
|
+
}
|
|
22191
|
+
],
|
|
22192
|
+
"title": "Amount",
|
|
22193
|
+
"description": "The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."
|
|
22194
|
+
},
|
|
22195
|
+
"denomination": {
|
|
22196
|
+
"type": "string",
|
|
22197
|
+
"enum": [
|
|
22198
|
+
"PERCENTAGE",
|
|
22199
|
+
"FIXED"
|
|
22200
|
+
],
|
|
22201
|
+
"title": "Denomination",
|
|
22202
|
+
"description": "The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the trade proceeds), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).",
|
|
22203
|
+
"example": "PERCENTAGE"
|
|
22204
|
+
}
|
|
22205
|
+
},
|
|
22206
|
+
"additionalProperties": false,
|
|
22207
|
+
"type": "object",
|
|
22208
|
+
"required": [
|
|
22209
|
+
"recipient",
|
|
22210
|
+
"amount"
|
|
22211
|
+
],
|
|
22212
|
+
"title": "TokenizedAssetsFee",
|
|
22213
|
+
"description": "Fee configuration for tokenized-asset trades.\n\nSame shape as `Fee`, but narrows `denomination` to the values supported by\ntokenized-asset trades. PERFORMANCE is not supported because realized-profit\nfees are not computed for spot buy/sell trades."
|
|
22214
|
+
},
|
|
22049
22215
|
"TokenizedAssetsMarketsListResponse": {
|
|
22050
22216
|
"properties": {
|
|
22051
22217
|
"markets": {
|
|
@@ -22355,6 +22521,17 @@
|
|
|
22355
22521
|
"title": "Gas Sponsorship",
|
|
22356
22522
|
"description": "When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction.",
|
|
22357
22523
|
"example": false
|
|
22524
|
+
},
|
|
22525
|
+
"fee": {
|
|
22526
|
+
"anyOf": [
|
|
22527
|
+
{
|
|
22528
|
+
"$ref": "#/components/schemas/TokenizedAssetsFee"
|
|
22529
|
+
},
|
|
22530
|
+
{
|
|
22531
|
+
"type": "null"
|
|
22532
|
+
}
|
|
22533
|
+
],
|
|
22534
|
+
"description": "Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution."
|
|
22358
22535
|
}
|
|
22359
22536
|
},
|
|
22360
22537
|
"type": "object",
|
|
@@ -22397,6 +22574,19 @@
|
|
|
22397
22574
|
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
|
|
22398
22575
|
"title": "Estimated Amount Out",
|
|
22399
22576
|
"description": "Estimated amount of `token_out` received (human-readable units)."
|
|
22577
|
+
},
|
|
22578
|
+
"fee_amount": {
|
|
22579
|
+
"anyOf": [
|
|
22580
|
+
{
|
|
22581
|
+
"type": "string",
|
|
22582
|
+
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
|
|
22583
|
+
},
|
|
22584
|
+
{
|
|
22585
|
+
"type": "null"
|
|
22586
|
+
}
|
|
22587
|
+
],
|
|
22588
|
+
"title": "Fee Amount",
|
|
22589
|
+
"description": "Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied."
|
|
22400
22590
|
}
|
|
22401
22591
|
},
|
|
22402
22592
|
"type": "object",
|