@cubist-labs/cubesigner-sdk 0.4.241 → 0.4.246
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/dist/package.json +1 -1
- package/dist/spec/env/gamma.json +5 -0
- package/dist/src/audit_log.d.ts +5 -5
- package/dist/src/audit_log.js +1 -1
- package/dist/src/client/api_client.d.ts +22 -7
- package/dist/src/client/api_client.d.ts.map +1 -1
- package/dist/src/client/api_client.js +43 -13
- package/dist/src/client/base_client.d.ts +5 -1
- package/dist/src/client/base_client.d.ts.map +1 -1
- package/dist/src/client/base_client.js +16 -10
- package/dist/src/client/session.d.ts +3 -1
- package/dist/src/client/session.d.ts.map +1 -1
- package/dist/src/client/session.js +7 -3
- package/dist/src/client.d.ts +12 -5
- package/dist/src/client.d.ts.map +1 -1
- package/dist/src/client.js +15 -4
- package/dist/src/diffie_hellman.js +2 -2
- package/dist/src/env.d.ts +7 -0
- package/dist/src/env.d.ts.map +1 -1
- package/dist/src/env.js +14 -1
- package/dist/src/fetch.d.ts.map +1 -1
- package/dist/src/fetch.js +2 -3
- package/dist/src/key.d.ts +17 -1
- package/dist/src/key.d.ts.map +1 -1
- package/dist/src/key.js +19 -3
- package/dist/src/policy.d.ts +24 -7
- package/dist/src/policy.d.ts.map +1 -1
- package/dist/src/policy.js +34 -16
- package/dist/src/response.d.ts +29 -5
- package/dist/src/response.d.ts.map +1 -1
- package/dist/src/response.js +62 -24
- package/dist/src/schema.d.ts +975 -84
- package/dist/src/schema.d.ts.map +1 -1
- package/dist/src/schema.js +1 -1
- package/dist/src/schema_types.d.ts +10 -1
- package/dist/src/schema_types.d.ts.map +1 -1
- package/dist/src/schema_types.js +2 -1
- package/dist/src/scopes.d.ts.map +1 -1
- package/dist/src/scopes.js +23 -3
- package/dist/src/user_export.d.ts +1 -1
- package/dist/src/user_export.js +3 -3
- package/dist/src/util.d.ts +7 -0
- package/dist/src/util.d.ts.map +1 -1
- package/dist/src/util.js +30 -7
- package/package.json +1 -1
- package/src/audit_log.ts +3 -5
- package/src/client/api_client.ts +54 -14
- package/src/client/base_client.ts +13 -3
- package/src/client/session.ts +10 -3
- package/src/client.ts +17 -4
- package/src/diffie_hellman.ts +1 -1
- package/src/env.ts +17 -0
- package/src/fetch.ts +1 -2
- package/src/key.ts +26 -2
- package/src/policy.ts +34 -16
- package/src/response.ts +72 -25
- package/src/schema.ts +1034 -92
- package/src/schema_types.ts +12 -1
- package/src/scopes.ts +22 -2
- package/src/user_export.ts +2 -2
- package/src/util.ts +34 -8
package/src/schema.ts
CHANGED
|
@@ -1664,6 +1664,19 @@ export interface paths {
|
|
|
1664
1664
|
*/
|
|
1665
1665
|
get: operations["userOrgs"];
|
|
1666
1666
|
};
|
|
1667
|
+
"/v1/org/{org_id}/binance/sign/{material_id}": {
|
|
1668
|
+
/**
|
|
1669
|
+
* Sign Binance RPC Request
|
|
1670
|
+
* @description Sign Binance RPC Request
|
|
1671
|
+
*
|
|
1672
|
+
* Signs a typed [`BinanceRpc`] request with the [`KeyType::Ed25519BinanceApi`]
|
|
1673
|
+
* key identified by `material_id`. The signer URL-encodes the inner request,
|
|
1674
|
+
* appends Binance's `recvWindow` and `timestamp` parameters, signs the
|
|
1675
|
+
* resulting query, and returns the full query string ready to be submitted
|
|
1676
|
+
* to Binance.
|
|
1677
|
+
*/
|
|
1678
|
+
post: operations["binanceSign"];
|
|
1679
|
+
};
|
|
1667
1680
|
"/v1/org/{org_id}/blob/sign/{key_id}": {
|
|
1668
1681
|
/**
|
|
1669
1682
|
* Sign Raw Blob
|
|
@@ -1751,34 +1764,99 @@ export type webhooks = Record<string, never>;
|
|
|
1751
1764
|
export interface components {
|
|
1752
1765
|
schemas: {
|
|
1753
1766
|
AcceptedResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
|
|
1767
|
+
/** @description Different responses we return for success status codes. */
|
|
1768
|
+
AcceptedValue: OneOf<
|
|
1769
|
+
[
|
|
1770
|
+
{
|
|
1771
|
+
SignDryRun: components["schemas"]["SignDryRunArgs"];
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
BinanceDryRun: components["schemas"]["BinanceDryRunArgs"];
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
MfaRequired: components["schemas"]["MfaRequiredArgs"];
|
|
1778
|
+
},
|
|
1779
|
+
]
|
|
1780
|
+
>;
|
|
1781
|
+
/** @enum {string} */
|
|
1782
|
+
AcceptedValueCode: "SignDryRun" | "BinanceDryRun" | "MfaRequired";
|
|
1754
1783
|
/**
|
|
1755
|
-
* @description
|
|
1784
|
+
* @description Determines who controls the keys within an org
|
|
1785
|
+
* @enum {string}
|
|
1786
|
+
*/
|
|
1787
|
+
AccessModel: "User" | "Org";
|
|
1788
|
+
/**
|
|
1789
|
+
* @description One asset balance entry in [`AccountInfoResponse::balances`]. Distinct from
|
|
1790
|
+
* [`SubAccountAsset`] because the spot-account schema lacks the `freeze` and
|
|
1791
|
+
* `withdrawing` fields.
|
|
1792
|
+
*/
|
|
1793
|
+
AccountBalance: {
|
|
1794
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
1795
|
+
asset: string;
|
|
1796
|
+
/** @description Available balance. */
|
|
1797
|
+
free: string;
|
|
1798
|
+
/** @description Balance locked in open orders. */
|
|
1799
|
+
locked: string;
|
|
1800
|
+
};
|
|
1801
|
+
/**
|
|
1802
|
+
* @description Parameters for `GET /api/v3/account`.
|
|
1756
1803
|
*
|
|
1757
|
-
*
|
|
1758
|
-
*
|
|
1759
|
-
* return `Result<T, SignerError>` where `T` is the type of the
|
|
1760
|
-
* response for the status code "200 Ok".
|
|
1804
|
+
* Returns Spot account info for whichever account the signing key
|
|
1805
|
+
* authenticates as (master or sub).
|
|
1761
1806
|
*/
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1807
|
+
AccountInfoRequest: {
|
|
1808
|
+
/**
|
|
1809
|
+
* @description If `true`, the response omits assets with all-zero balances. Defaults to
|
|
1810
|
+
* `false` (Binance's default).
|
|
1811
|
+
*/
|
|
1812
|
+
omitZeroBalances?: boolean | null;
|
|
1813
|
+
};
|
|
1814
|
+
/** @description Response returned by `cs_binanceAccountInfo`. */
|
|
1815
|
+
AccountInfoResponse: {
|
|
1816
|
+
/** @description Account type, e.g. `"SPOT"`. Left as `String` for forward compatibility. */
|
|
1817
|
+
accountType: string;
|
|
1818
|
+
/** @description One entry per asset. Affected by the `omit_zero_balances` request flag. */
|
|
1819
|
+
balances: components["schemas"]["AccountBalance"][];
|
|
1820
|
+
brokered: boolean;
|
|
1821
|
+
/** Format: int64 */
|
|
1822
|
+
buyerCommission: number;
|
|
1823
|
+
canDeposit: boolean;
|
|
1824
|
+
canTrade: boolean;
|
|
1825
|
+
canWithdraw: boolean;
|
|
1826
|
+
commissionRates: components["schemas"]["CommissionRates"];
|
|
1827
|
+
/**
|
|
1828
|
+
* Format: int64
|
|
1829
|
+
* @description Maker commission, in basis points (e.g. `10` = 0.1%). Superseded by
|
|
1830
|
+
* [`AccountInfoResponse::commission_rates`] for fractional rates.
|
|
1831
|
+
*/
|
|
1832
|
+
makerCommission: number;
|
|
1833
|
+
/** @description Permission flags, e.g. `["SPOT", "MARGIN"]`. */
|
|
1834
|
+
permissions: string[];
|
|
1835
|
+
preventSor: boolean;
|
|
1836
|
+
requireSelfTradePrevention: boolean;
|
|
1837
|
+
/** Format: int64 */
|
|
1838
|
+
sellerCommission: number;
|
|
1839
|
+
/** Format: int64 */
|
|
1840
|
+
takerCommission: number;
|
|
1841
|
+
/**
|
|
1842
|
+
* Format: int64
|
|
1843
|
+
* @description Account user id.
|
|
1844
|
+
*/
|
|
1845
|
+
uid: number;
|
|
1846
|
+
/**
|
|
1847
|
+
* Format: int64
|
|
1848
|
+
* @description Last account update time (ms since epoch).
|
|
1849
|
+
*/
|
|
1850
|
+
updateTime: number;
|
|
1774
1851
|
};
|
|
1775
|
-
/** @enum {string} */
|
|
1776
|
-
AcceptedValueCode: "MfaRequired";
|
|
1777
1852
|
/**
|
|
1778
|
-
* @description
|
|
1853
|
+
* @description Wallet type used as the source or destination of a [`UniversalTransferRequest`].
|
|
1854
|
+
*
|
|
1855
|
+
* Serializes to the SCREAMING_SNAKE_CASE strings Binance expects. The default
|
|
1856
|
+
* is [`AccountType::Spot`].
|
|
1779
1857
|
* @enum {string}
|
|
1780
1858
|
*/
|
|
1781
|
-
|
|
1859
|
+
AccountType: "SPOT" | "USDT_FUTURE" | "COIN_FUTURE" | "MARGIN";
|
|
1782
1860
|
/** @description Request to add OIDC identity to an existing user account */
|
|
1783
1861
|
AddIdentityRequest: {
|
|
1784
1862
|
oidc_token: string;
|
|
@@ -2075,6 +2153,8 @@ export interface components {
|
|
|
2075
2153
|
AuthenticatorTransport: "usb" | "nfc" | "ble" | "internal";
|
|
2076
2154
|
/** @description Request to sign a serialized Avalanche transaction */
|
|
2077
2155
|
AvaSerializedTxSignRequest: {
|
|
2156
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2157
|
+
dry_run?: boolean;
|
|
2078
2158
|
/**
|
|
2079
2159
|
* @description Request additional information to be included in the response, explaining
|
|
2080
2160
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2097,6 +2177,8 @@ export interface components {
|
|
|
2097
2177
|
};
|
|
2098
2178
|
/** @description Request to sign an Avalanche transaction */
|
|
2099
2179
|
AvaSignRequest: {
|
|
2180
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2181
|
+
dry_run?: boolean;
|
|
2100
2182
|
/**
|
|
2101
2183
|
* @description Request additional information to be included in the response, explaining
|
|
2102
2184
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2134,6 +2216,8 @@ export interface components {
|
|
|
2134
2216
|
/** @description Wrapper around a zeroizing 32-byte fixed-size array */
|
|
2135
2217
|
B32: string;
|
|
2136
2218
|
BabylonCovSignRequest: {
|
|
2219
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2220
|
+
dry_run?: boolean;
|
|
2137
2221
|
/**
|
|
2138
2222
|
* @description Request additional information to be included in the response, explaining
|
|
2139
2223
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2327,6 +2411,8 @@ export interface components {
|
|
|
2327
2411
|
*/
|
|
2328
2412
|
value: number;
|
|
2329
2413
|
}) & {
|
|
2414
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2415
|
+
dry_run?: boolean;
|
|
2330
2416
|
/**
|
|
2331
2417
|
* @description Request additional information to be included in the response, explaining
|
|
2332
2418
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2797,10 +2883,15 @@ export interface components {
|
|
|
2797
2883
|
| "InvalidMfaReceiptInvalidOrgId"
|
|
2798
2884
|
| "MfaRequestNotFound"
|
|
2799
2885
|
| "InvalidKeyType"
|
|
2886
|
+
| "InvalidPropertiesForKeyType"
|
|
2887
|
+
| "MismatchedKeyPropertiesPatch"
|
|
2888
|
+
| "MissingBinanceApiKey"
|
|
2889
|
+
| "BinanceKeyMasterMismatch"
|
|
2800
2890
|
| "InvalidKeyMaterial"
|
|
2801
2891
|
| "InvalidHexValue"
|
|
2802
2892
|
| "InvalidBase32Value"
|
|
2803
2893
|
| "InvalidBase58Value"
|
|
2894
|
+
| "InvalidBase64Value"
|
|
2804
2895
|
| "InvalidSs58Value"
|
|
2805
2896
|
| "InvalidForkVersionLength"
|
|
2806
2897
|
| "InvalidEthAddress"
|
|
@@ -3071,6 +3162,7 @@ export interface components {
|
|
|
3071
3162
|
| "BabylonRegistration"
|
|
3072
3163
|
| "BabylonStaking"
|
|
3073
3164
|
| "BabylonCovSign"
|
|
3165
|
+
| "BinanceSign"
|
|
3074
3166
|
| "BlobSign"
|
|
3075
3167
|
| "BtcMessageSign"
|
|
3076
3168
|
| "BtcSign"
|
|
@@ -3116,6 +3208,8 @@ export interface components {
|
|
|
3116
3208
|
| "RpcCreateTransaction"
|
|
3117
3209
|
| "RpcGetTransaction"
|
|
3118
3210
|
| "RpcListTransactions"
|
|
3211
|
+
| "RpcRetryTransaction"
|
|
3212
|
+
| "RpcBinance"
|
|
3119
3213
|
| "CustomChainRpcCall"
|
|
3120
3214
|
| "EsploraApiCall"
|
|
3121
3215
|
| "SentryApiCall"
|
|
@@ -3125,6 +3219,213 @@ export interface components {
|
|
|
3125
3219
|
| "UserOrgs"
|
|
3126
3220
|
| "PublicOrgInfo"
|
|
3127
3221
|
| "EmailMyOrgs";
|
|
3222
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3223
|
+
BinanceAccountInfoParams: components["schemas"]["AccountInfoRequest"] & {
|
|
3224
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3225
|
+
keyId: components["schemas"]["Id"];
|
|
3226
|
+
/**
|
|
3227
|
+
* Format: float
|
|
3228
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3229
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3230
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3231
|
+
*/
|
|
3232
|
+
recvWindow?: number | null;
|
|
3233
|
+
};
|
|
3234
|
+
BinanceApiPropertiesPatch: {
|
|
3235
|
+
/** @description The Binance-issued API key string. Encrypted server-side before storage. */
|
|
3236
|
+
api_key?: string | null;
|
|
3237
|
+
/** @description Email address of the Binance (master or sub) account this key authenticates as. */
|
|
3238
|
+
email?: string | null;
|
|
3239
|
+
/** @description Whether this corresponds to a master (as opposed to a sub) account on Binance. */
|
|
3240
|
+
is_master?: boolean | null;
|
|
3241
|
+
/** @description Arbitrary label. Useful for storing the corresponding API key label on the Binance side. */
|
|
3242
|
+
label?: string | null;
|
|
3243
|
+
};
|
|
3244
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3245
|
+
BinanceDepositParams: components["schemas"]["DepositRequest"] & {
|
|
3246
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3247
|
+
keyId: components["schemas"]["Id"];
|
|
3248
|
+
/**
|
|
3249
|
+
* Format: float
|
|
3250
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3251
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3252
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3253
|
+
*/
|
|
3254
|
+
recvWindow?: number | null;
|
|
3255
|
+
};
|
|
3256
|
+
BinanceDryRunArgs: {
|
|
3257
|
+
/** @description The Binance API method that would have been used */
|
|
3258
|
+
method: string;
|
|
3259
|
+
/** @description The Binance API url method that would have been called */
|
|
3260
|
+
url: string;
|
|
3261
|
+
};
|
|
3262
|
+
/**
|
|
3263
|
+
* @description Different "dry run" modes for executing Binance requests.
|
|
3264
|
+
* @enum {string}
|
|
3265
|
+
*/
|
|
3266
|
+
BinanceDryRunMode: "NO_SIGN" | "NO_SUBMIT";
|
|
3267
|
+
/**
|
|
3268
|
+
* @description Binance-family RPC methods. Each variant authenticates as the
|
|
3269
|
+
* [`KeyType::Ed25519BinanceApi`] key in its `params.key_id`.
|
|
3270
|
+
*/
|
|
3271
|
+
BinanceRpc:
|
|
3272
|
+
| {
|
|
3273
|
+
/** @enum {string} */
|
|
3274
|
+
method: "cs_binanceSubToMaster";
|
|
3275
|
+
params: components["schemas"]["BinanceSubToMasterParams"];
|
|
3276
|
+
}
|
|
3277
|
+
| {
|
|
3278
|
+
/** @enum {string} */
|
|
3279
|
+
method: "cs_binanceSubToSub";
|
|
3280
|
+
params: components["schemas"]["BinanceSubToSubParams"];
|
|
3281
|
+
}
|
|
3282
|
+
| {
|
|
3283
|
+
/** @enum {string} */
|
|
3284
|
+
method: "cs_binanceUniversalTransfer";
|
|
3285
|
+
params: components["schemas"]["BinanceUniversalTransferParams"];
|
|
3286
|
+
}
|
|
3287
|
+
| {
|
|
3288
|
+
/** @enum {string} */
|
|
3289
|
+
method: "cs_binanceSubAccountAssets";
|
|
3290
|
+
params: components["schemas"]["BinanceSubAccountAssetsParams"];
|
|
3291
|
+
}
|
|
3292
|
+
| {
|
|
3293
|
+
/** @enum {string} */
|
|
3294
|
+
method: "cs_binanceAccountInfo";
|
|
3295
|
+
params: components["schemas"]["BinanceAccountInfoParams"];
|
|
3296
|
+
}
|
|
3297
|
+
| {
|
|
3298
|
+
/** @enum {string} */
|
|
3299
|
+
method: "cs_binanceSubAccountTransferHistory";
|
|
3300
|
+
params: components["schemas"]["BinanceSubAccountTransferHistoryParams"];
|
|
3301
|
+
}
|
|
3302
|
+
| {
|
|
3303
|
+
/** @enum {string} */
|
|
3304
|
+
method: "cs_binanceUniversalTransferHistory";
|
|
3305
|
+
params: components["schemas"]["BinanceUniversalTransferHistoryParams"];
|
|
3306
|
+
}
|
|
3307
|
+
| {
|
|
3308
|
+
/** @enum {string} */
|
|
3309
|
+
method: "cs_binanceWithdraw";
|
|
3310
|
+
params: components["schemas"]["BinanceWithdrawParams"];
|
|
3311
|
+
}
|
|
3312
|
+
| {
|
|
3313
|
+
/** @enum {string} */
|
|
3314
|
+
method: "cs_binanceWithdrawHistory";
|
|
3315
|
+
params: components["schemas"]["BinanceWithdrawHistoryParams"];
|
|
3316
|
+
}
|
|
3317
|
+
| {
|
|
3318
|
+
/** @enum {string} */
|
|
3319
|
+
method: "cs_binanceDeposit";
|
|
3320
|
+
params: components["schemas"]["BinanceDepositParams"];
|
|
3321
|
+
};
|
|
3322
|
+
/** @description Response returned by the typed `binance_sign` endpoint. */
|
|
3323
|
+
BinanceSignResponse: {
|
|
3324
|
+
/** @description Optional policy evaluation tree. */
|
|
3325
|
+
policy_eval_tree?: unknown;
|
|
3326
|
+
} & {
|
|
3327
|
+
/**
|
|
3328
|
+
* @description The full signed query string, ready to be submitted to Binance.
|
|
3329
|
+
* Encoded as `<urlencoded params>&recvWindow=<ms>×tamp=<ms>&signature=<urlencoded base64 sig>`.
|
|
3330
|
+
*/
|
|
3331
|
+
signed_query: string;
|
|
3332
|
+
};
|
|
3333
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3334
|
+
BinanceSubAccountAssetsParams: components["schemas"]["SubAccountAssetsRequest"] & {
|
|
3335
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3336
|
+
keyId: components["schemas"]["Id"];
|
|
3337
|
+
/**
|
|
3338
|
+
* Format: float
|
|
3339
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3340
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3341
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3342
|
+
*/
|
|
3343
|
+
recvWindow?: number | null;
|
|
3344
|
+
};
|
|
3345
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3346
|
+
BinanceSubAccountTransferHistoryParams: components["schemas"]["SubAccountTransferHistoryRequest"] & {
|
|
3347
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3348
|
+
keyId: components["schemas"]["Id"];
|
|
3349
|
+
/**
|
|
3350
|
+
* Format: float
|
|
3351
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3352
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3353
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3354
|
+
*/
|
|
3355
|
+
recvWindow?: number | null;
|
|
3356
|
+
};
|
|
3357
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3358
|
+
BinanceSubToMasterParams: components["schemas"]["SubToMasterRequest"] & {
|
|
3359
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3360
|
+
keyId: components["schemas"]["Id"];
|
|
3361
|
+
/**
|
|
3362
|
+
* Format: float
|
|
3363
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3364
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3365
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3366
|
+
*/
|
|
3367
|
+
recvWindow?: number | null;
|
|
3368
|
+
};
|
|
3369
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3370
|
+
BinanceSubToSubParams: components["schemas"]["SubToSubRequest"] & {
|
|
3371
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3372
|
+
keyId: components["schemas"]["Id"];
|
|
3373
|
+
/**
|
|
3374
|
+
* Format: float
|
|
3375
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3376
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3377
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3378
|
+
*/
|
|
3379
|
+
recvWindow?: number | null;
|
|
3380
|
+
};
|
|
3381
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3382
|
+
BinanceUniversalTransferHistoryParams: components["schemas"]["UniversalTransferHistoryRequest"] & {
|
|
3383
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3384
|
+
keyId: components["schemas"]["Id"];
|
|
3385
|
+
/**
|
|
3386
|
+
* Format: float
|
|
3387
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3388
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3389
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3390
|
+
*/
|
|
3391
|
+
recvWindow?: number | null;
|
|
3392
|
+
};
|
|
3393
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3394
|
+
BinanceUniversalTransferParams: components["schemas"]["UniversalTransferRequest"] & {
|
|
3395
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3396
|
+
keyId: components["schemas"]["Id"];
|
|
3397
|
+
/**
|
|
3398
|
+
* Format: float
|
|
3399
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3400
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3401
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3402
|
+
*/
|
|
3403
|
+
recvWindow?: number | null;
|
|
3404
|
+
};
|
|
3405
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3406
|
+
BinanceWithdrawHistoryParams: components["schemas"]["WithdrawHistoryRequest"] & {
|
|
3407
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3408
|
+
keyId: components["schemas"]["Id"];
|
|
3409
|
+
/**
|
|
3410
|
+
* Format: float
|
|
3411
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3412
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3413
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3414
|
+
*/
|
|
3415
|
+
recvWindow?: number | null;
|
|
3416
|
+
};
|
|
3417
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
3418
|
+
BinanceWithdrawParams: components["schemas"]["WithdrawRequest"] & {
|
|
3419
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
3420
|
+
keyId: components["schemas"]["Id"];
|
|
3421
|
+
/**
|
|
3422
|
+
* Format: float
|
|
3423
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3424
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
3425
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
3426
|
+
*/
|
|
3427
|
+
recvWindow?: number | null;
|
|
3428
|
+
};
|
|
3128
3429
|
/** @description A bitcoin address and its network. */
|
|
3129
3430
|
BitcoinAddressInfo: {
|
|
3130
3431
|
/**
|
|
@@ -3140,6 +3441,8 @@ export interface components {
|
|
|
3140
3441
|
* }
|
|
3141
3442
|
*/
|
|
3142
3443
|
BlobSignRequest: {
|
|
3444
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3445
|
+
dry_run?: boolean;
|
|
3143
3446
|
/**
|
|
3144
3447
|
* @description Request additional information to be included in the response, explaining
|
|
3145
3448
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3228,6 +3531,8 @@ export interface components {
|
|
|
3228
3531
|
};
|
|
3229
3532
|
/** @description Data to sign */
|
|
3230
3533
|
BtcMessageSignRequest: {
|
|
3534
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3535
|
+
dry_run?: boolean;
|
|
3231
3536
|
/**
|
|
3232
3537
|
* @description Request additional information to be included in the response, explaining
|
|
3233
3538
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3270,6 +3575,8 @@ export interface components {
|
|
|
3270
3575
|
| "NonePlusAnyoneCanPay"
|
|
3271
3576
|
| "SinglePlusAnyoneCanPay";
|
|
3272
3577
|
BtcSignRequest: {
|
|
3578
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3579
|
+
dry_run?: boolean;
|
|
3273
3580
|
/**
|
|
3274
3581
|
* @description Request additional information to be included in the response, explaining
|
|
3275
3582
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3479,6 +3786,13 @@ export interface components {
|
|
|
3479
3786
|
client?: components["schemas"]["ClientProfile"];
|
|
3480
3787
|
os_info?: components["schemas"]["OsInfo"];
|
|
3481
3788
|
};
|
|
3789
|
+
/** @description Commission rates as decimal strings (e.g. `"0.00100000"`). */
|
|
3790
|
+
CommissionRates: {
|
|
3791
|
+
buyer: string;
|
|
3792
|
+
maker: string;
|
|
3793
|
+
seller: string;
|
|
3794
|
+
taker: string;
|
|
3795
|
+
};
|
|
3482
3796
|
/**
|
|
3483
3797
|
* @description Fields that are common to different types of resources such as keys, roles, etc.
|
|
3484
3798
|
* Includes versioning fields plus metadata, edit policy, etc.
|
|
@@ -3571,7 +3885,10 @@ export interface components {
|
|
|
3571
3885
|
type: "fido";
|
|
3572
3886
|
};
|
|
3573
3887
|
/** @enum {string} */
|
|
3574
|
-
ConflictErrorCode:
|
|
3888
|
+
ConflictErrorCode:
|
|
3889
|
+
| "ConcurrentRequestDisallowed"
|
|
3890
|
+
| "ConcurrentLockCreation"
|
|
3891
|
+
| "ConcurrentTransactionSubmission";
|
|
3575
3892
|
/** @description A contact in the org. */
|
|
3576
3893
|
Contact: components["schemas"]["CommonFields"] & {
|
|
3577
3894
|
/**
|
|
@@ -3876,6 +4193,31 @@ export interface components {
|
|
|
3876
4193
|
CreationOptionsWithHash: components["schemas"]["ChallengePieces"] & {
|
|
3877
4194
|
options: components["schemas"]["PublicKeyCredentialCreationOptions"];
|
|
3878
4195
|
};
|
|
4196
|
+
/** @description Core RPC methods (transaction CRUD). */
|
|
4197
|
+
CsRpc: OneOf<
|
|
4198
|
+
[
|
|
4199
|
+
{
|
|
4200
|
+
/** @enum {string} */
|
|
4201
|
+
method: "cs_createTransaction";
|
|
4202
|
+
params: components["schemas"]["CreateTransactionRequest"];
|
|
4203
|
+
},
|
|
4204
|
+
{
|
|
4205
|
+
/** @enum {string} */
|
|
4206
|
+
method: "cs_retryTransaction";
|
|
4207
|
+
params: components["schemas"]["RetryTransactionRequest"];
|
|
4208
|
+
},
|
|
4209
|
+
{
|
|
4210
|
+
/** @enum {string} */
|
|
4211
|
+
method: "cs_getTransaction";
|
|
4212
|
+
params: components["schemas"]["GetTransactionRequest"];
|
|
4213
|
+
},
|
|
4214
|
+
{
|
|
4215
|
+
/** @enum {string} */
|
|
4216
|
+
method: "cs_listTransactions";
|
|
4217
|
+
params: components["schemas"]["ListTransactionsRequest"];
|
|
4218
|
+
},
|
|
4219
|
+
]
|
|
4220
|
+
>;
|
|
3879
4221
|
CubeSignerUserInfo: {
|
|
3880
4222
|
/** @description All multi-factor authentication methods configured for this user */
|
|
3881
4223
|
configured_mfa: components["schemas"]["ConfiguredMfa"][];
|
|
@@ -3908,6 +4250,40 @@ export interface components {
|
|
|
3908
4250
|
/** @description Custom EVM chains. */
|
|
3909
4251
|
evm: components["schemas"]["EvmCustomChain"][];
|
|
3910
4252
|
};
|
|
4253
|
+
/**
|
|
4254
|
+
* @description Parameters for `GET /sapi/v1/capital/deposit/address`.
|
|
4255
|
+
*
|
|
4256
|
+
* Fetches the deposit address for `coin` on the account that the signing key
|
|
4257
|
+
* authenticates as. Optionally narrows the address to a specific `network`.
|
|
4258
|
+
*/
|
|
4259
|
+
DepositRequest: {
|
|
4260
|
+
/**
|
|
4261
|
+
* @description Required only when `network` is `"LIGHTNING"`: the deposit amount that
|
|
4262
|
+
* the returned invoice should encode, as a decimal string.
|
|
4263
|
+
*/
|
|
4264
|
+
amount?: string | null;
|
|
4265
|
+
/** @description The asset symbol whose deposit address to fetch (e.g. `"USDT"`, `"BTC"`). */
|
|
4266
|
+
coin: string;
|
|
4267
|
+
/**
|
|
4268
|
+
* @description Network identifier (e.g. `"BSC"`, `"ETH"`). If omitted, Binance returns
|
|
4269
|
+
* the address on the asset's default network.
|
|
4270
|
+
*/
|
|
4271
|
+
network?: string | null;
|
|
4272
|
+
};
|
|
4273
|
+
/** @description Response returned by `cs_binanceDeposit`. */
|
|
4274
|
+
DepositResponse: {
|
|
4275
|
+
/** @description Deposit address. */
|
|
4276
|
+
address: string;
|
|
4277
|
+
/** @description Asset symbol (echoes [`DepositRequest::coin`]). */
|
|
4278
|
+
coin: string;
|
|
4279
|
+
/**
|
|
4280
|
+
* @description Secondary address identifier required by some assets (e.g. memo for
|
|
4281
|
+
* XRP, tag for XLM). Empty string when the asset does not use one.
|
|
4282
|
+
*/
|
|
4283
|
+
tag: string;
|
|
4284
|
+
/** @description Blockchain explorer URL for `address`. */
|
|
4285
|
+
url: string;
|
|
4286
|
+
};
|
|
3911
4287
|
/**
|
|
3912
4288
|
* @description Information produced by a successful deposit
|
|
3913
4289
|
* @example {
|
|
@@ -3994,6 +4370,8 @@ export interface components {
|
|
|
3994
4370
|
mnemonic_id?: string | null;
|
|
3995
4371
|
};
|
|
3996
4372
|
DiffieHellmanRequest: {
|
|
4373
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4374
|
+
dry_run?: boolean;
|
|
3997
4375
|
/**
|
|
3998
4376
|
* @description Request additional information to be included in the response, explaining
|
|
3999
4377
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4077,6 +4455,8 @@ export interface components {
|
|
|
4077
4455
|
time_lock_until?: components["schemas"]["EpochDateTime"] | null;
|
|
4078
4456
|
};
|
|
4079
4457
|
Eip191SignRequest: {
|
|
4458
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4459
|
+
dry_run?: boolean;
|
|
4080
4460
|
/**
|
|
4081
4461
|
* @description Request additional information to be included in the response, explaining
|
|
4082
4462
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4199,6 +4579,8 @@ export interface components {
|
|
|
4199
4579
|
* }
|
|
4200
4580
|
*/
|
|
4201
4581
|
Eip712SignRequest: {
|
|
4582
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4583
|
+
dry_run?: boolean;
|
|
4202
4584
|
/**
|
|
4203
4585
|
* @description Request additional information to be included in the response, explaining
|
|
4204
4586
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4294,6 +4676,8 @@ export interface components {
|
|
|
4294
4676
|
* at a specified block height.
|
|
4295
4677
|
*/
|
|
4296
4678
|
EotsCreateNonceRequest: {
|
|
4679
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4680
|
+
dry_run?: boolean;
|
|
4297
4681
|
/**
|
|
4298
4682
|
* @description Request additional information to be included in the response, explaining
|
|
4299
4683
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4344,6 +4728,8 @@ export interface components {
|
|
|
4344
4728
|
};
|
|
4345
4729
|
/** @description Request for an EOTS signature on a specified message, chain-id, block-height triple */
|
|
4346
4730
|
EotsSignRequest: {
|
|
4731
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4732
|
+
dry_run?: boolean;
|
|
4347
4733
|
/**
|
|
4348
4734
|
* @description Request additional information to be included in the response, explaining
|
|
4349
4735
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4440,6 +4826,8 @@ export interface components {
|
|
|
4440
4826
|
* }
|
|
4441
4827
|
*/
|
|
4442
4828
|
Eth1SignRequest: {
|
|
4829
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4830
|
+
dry_run?: boolean;
|
|
4443
4831
|
/**
|
|
4444
4832
|
* @description Request additional information to be included in the response, explaining
|
|
4445
4833
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4502,6 +4890,8 @@ export interface components {
|
|
|
4502
4890
|
* }
|
|
4503
4891
|
*/
|
|
4504
4892
|
Eth2SignRequest: {
|
|
4893
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4894
|
+
dry_run?: boolean;
|
|
4505
4895
|
/**
|
|
4506
4896
|
* @description Request additional information to be included in the response, explaining
|
|
4507
4897
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4628,6 +5018,11 @@ export interface components {
|
|
|
4628
5018
|
};
|
|
4629
5019
|
/** @description EVM-specific transaction details. */
|
|
4630
5020
|
EvmTransactionDetails: {
|
|
5021
|
+
/**
|
|
5022
|
+
* Format: int64
|
|
5023
|
+
* @description The EVM chain id for the chain the transaction is submitted to.
|
|
5024
|
+
*/
|
|
5025
|
+
chain_id: number;
|
|
4631
5026
|
/**
|
|
4632
5027
|
* @description The transaction hash, as submitted to the chain.
|
|
4633
5028
|
*
|
|
@@ -4639,7 +5034,7 @@ export interface components {
|
|
|
4639
5034
|
*
|
|
4640
5035
|
* Can be undefined if the transaction hasn't been signed yet, or failed to be signed.
|
|
4641
5036
|
*/
|
|
4642
|
-
signature?: string;
|
|
5037
|
+
signature?: string | null;
|
|
4643
5038
|
/** @description The transaction itself. */
|
|
4644
5039
|
tx: unknown;
|
|
4645
5040
|
};
|
|
@@ -4691,8 +5086,7 @@ export interface components {
|
|
|
4691
5086
|
/**
|
|
4692
5087
|
* @description Optional nonce.
|
|
4693
5088
|
*
|
|
4694
|
-
* If not specified, the
|
|
4695
|
-
* used.
|
|
5089
|
+
* If not specified, the next available nonce is used.
|
|
4696
5090
|
*/
|
|
4697
5091
|
nonce?: string | null;
|
|
4698
5092
|
};
|
|
@@ -4728,6 +5122,17 @@ export interface components {
|
|
|
4728
5122
|
ExplicitScope:
|
|
4729
5123
|
| "sign:*"
|
|
4730
5124
|
| "sign:ava"
|
|
5125
|
+
| "sign:binance:*"
|
|
5126
|
+
| "sign:binance:subToMaster"
|
|
5127
|
+
| "sign:binance:subToSub"
|
|
5128
|
+
| "sign:binance:universalTransfer"
|
|
5129
|
+
| "sign:binance:subAccountAssets"
|
|
5130
|
+
| "sign:binance:accountInfo"
|
|
5131
|
+
| "sign:binance:subAccountTransferHistory"
|
|
5132
|
+
| "sign:binance:universalTransferHistory"
|
|
5133
|
+
| "sign:binance:withdraw"
|
|
5134
|
+
| "sign:binance:withdrawHistory"
|
|
5135
|
+
| "sign:binance:deposit"
|
|
4731
5136
|
| "sign:blob"
|
|
4732
5137
|
| "sign:diffieHellman"
|
|
4733
5138
|
| "sign:btc:*"
|
|
@@ -4803,6 +5208,7 @@ export interface components {
|
|
|
4803
5208
|
| "manage:key:update:enabled"
|
|
4804
5209
|
| "manage:key:update:region"
|
|
4805
5210
|
| "manage:key:update:metadata"
|
|
5211
|
+
| "manage:key:update:properties"
|
|
4806
5212
|
| "manage:key:update:editPolicy"
|
|
4807
5213
|
| "manage:key:delete"
|
|
4808
5214
|
| "manage:policy:*"
|
|
@@ -4889,10 +5295,16 @@ export interface components {
|
|
|
4889
5295
|
| "manage:org:inviteAlien"
|
|
4890
5296
|
| "manage:org:invitation:list"
|
|
4891
5297
|
| "manage:org:invitation:cancel"
|
|
4892
|
-
| "manage:org:updateMembership"
|
|
5298
|
+
| "manage:org:updateMembership:*"
|
|
5299
|
+
| "manage:org:updateMembership:owner"
|
|
5300
|
+
| "manage:org:updateMembership:member"
|
|
5301
|
+
| "manage:org:updateMembership:alien"
|
|
4893
5302
|
| "manage:org:listUsers"
|
|
4894
5303
|
| "manage:org:user:get"
|
|
4895
|
-
| "manage:org:deleteUser"
|
|
5304
|
+
| "manage:org:deleteUser:*"
|
|
5305
|
+
| "manage:org:deleteUser:owner"
|
|
5306
|
+
| "manage:org:deleteUser:member"
|
|
5307
|
+
| "manage:org:deleteUser:alien"
|
|
4896
5308
|
| "manage:org:get"
|
|
4897
5309
|
| "manage:org:update:*"
|
|
4898
5310
|
| "manage:org:update:enabled"
|
|
@@ -4950,8 +5362,10 @@ export interface components {
|
|
|
4950
5362
|
| "rpc:*"
|
|
4951
5363
|
| "rpc:createTransaction:*"
|
|
4952
5364
|
| "rpc:createTransaction:evm"
|
|
5365
|
+
| "rpc:retryTransaction"
|
|
4953
5366
|
| "rpc:getTransaction"
|
|
4954
|
-
| "rpc:listTransactions"
|
|
5367
|
+
| "rpc:listTransactions"
|
|
5368
|
+
| "rpc:binance";
|
|
4955
5369
|
/**
|
|
4956
5370
|
* @description This type specifies the interpretation of the `fee` field in Babylon
|
|
4957
5371
|
* staking requests. If `sats`, the field is intpreted as a fixed value
|
|
@@ -5618,14 +6032,12 @@ export interface components {
|
|
|
5618
6032
|
key_type: string;
|
|
5619
6033
|
};
|
|
5620
6034
|
/** @description The top-level JSON-RPC request type. */
|
|
5621
|
-
JsonRpcRequest: {
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
jsonrpc: string;
|
|
5628
|
-
};
|
|
6035
|
+
JsonRpcRequest: components["schemas"]["RpcMethod"] & {
|
|
6036
|
+
/** @description Request ID */
|
|
6037
|
+
id?: string;
|
|
6038
|
+
/** @description JSON-RPC version. */
|
|
6039
|
+
jsonrpc: string;
|
|
6040
|
+
};
|
|
5629
6041
|
/** @description The RPC API's response. */
|
|
5630
6042
|
JsonRpcResponse: {
|
|
5631
6043
|
error?: components["schemas"]["ErrorObj"] | null;
|
|
@@ -5639,7 +6051,16 @@ export interface components {
|
|
|
5639
6051
|
/** @description Valid `result` from the JSON-RPC API. */
|
|
5640
6052
|
JsonRpcResult:
|
|
5641
6053
|
| components["schemas"]["TransactionInfo"]
|
|
5642
|
-
| components["schemas"]["ListTransactionsPaginatedResponse"]
|
|
6054
|
+
| components["schemas"]["ListTransactionsPaginatedResponse"]
|
|
6055
|
+
| components["schemas"]["SubAccountTransferResponse"]
|
|
6056
|
+
| components["schemas"]["UniversalTransferResponse"]
|
|
6057
|
+
| components["schemas"]["SubAccountAssetsResponse"]
|
|
6058
|
+
| components["schemas"]["AccountInfoResponse"]
|
|
6059
|
+
| components["schemas"]["SubAccountTransferHistoryResponse"]
|
|
6060
|
+
| components["schemas"]["UniversalTransferHistoryResponse"]
|
|
6061
|
+
| components["schemas"]["WithdrawResponse"]
|
|
6062
|
+
| components["schemas"]["WithdrawHistoryResponse"]
|
|
6063
|
+
| components["schemas"]["DepositResponse"];
|
|
5643
6064
|
JwkSetResponse: {
|
|
5644
6065
|
/** @description The keys included in this set */
|
|
5645
6066
|
keys: Record<string, never>[];
|
|
@@ -5741,6 +6162,7 @@ export interface components {
|
|
|
5741
6162
|
* ]
|
|
5742
6163
|
*/
|
|
5743
6164
|
policy: unknown[];
|
|
6165
|
+
properties?: components["schemas"]["KeyPropertiesPatch"] | null;
|
|
5744
6166
|
/** @description The key provenance. */
|
|
5745
6167
|
provenance?: string | null;
|
|
5746
6168
|
/**
|
|
@@ -5768,6 +6190,19 @@ export interface components {
|
|
|
5768
6190
|
KeyInfos: {
|
|
5769
6191
|
keys: components["schemas"]["KeyInfo"][];
|
|
5770
6192
|
};
|
|
6193
|
+
/**
|
|
6194
|
+
* @description Client-side wire payload for [`KeyProperties`]. Used in both directions:
|
|
6195
|
+
*
|
|
6196
|
+
* - **On write**: a *patch*, i.e., for each field, missing means "leave alone",
|
|
6197
|
+
* `null` means "clear", and a value means "set". Secret fields arrive in the
|
|
6198
|
+
* clear and are encrypted server-side before persisting.
|
|
6199
|
+
* - **On read**: each field is omitted when the stored property is unset; secret
|
|
6200
|
+
* fields are emitted with the redacted marker (e.g. "[REDACTED]").
|
|
6201
|
+
*/
|
|
6202
|
+
KeyPropertiesPatch: components["schemas"]["BinanceApiPropertiesPatch"] & {
|
|
6203
|
+
/** @enum {string} */
|
|
6204
|
+
kind: "BinanceApi";
|
|
6205
|
+
};
|
|
5771
6206
|
/** @enum {string} */
|
|
5772
6207
|
KeyType:
|
|
5773
6208
|
| "SecpEthAddr"
|
|
@@ -5787,6 +6222,7 @@ export interface components {
|
|
|
5787
6222
|
| "Ed25519StellarAddr"
|
|
5788
6223
|
| "Ed25519SubstrateAddr"
|
|
5789
6224
|
| "Ed25519CantonAddr"
|
|
6225
|
+
| "Ed25519BinanceApi"
|
|
5790
6226
|
| "Mnemonic"
|
|
5791
6227
|
| "Stark"
|
|
5792
6228
|
| "BabylonEots"
|
|
@@ -5881,7 +6317,7 @@ export interface components {
|
|
|
5881
6317
|
*/
|
|
5882
6318
|
owner?: string | null;
|
|
5883
6319
|
};
|
|
5884
|
-
/** @description The response to [`cs_listTransactions`](super::request::
|
|
6320
|
+
/** @description The response to [`cs_listTransactions`](super::request::CsRpc::ListTransactions) */
|
|
5885
6321
|
ListTransactionsResponse: {
|
|
5886
6322
|
/** @description A list of transaction infos. */
|
|
5887
6323
|
transactions: components["schemas"]["TransactionInfo"][];
|
|
@@ -5975,6 +6411,17 @@ export interface components {
|
|
|
5975
6411
|
request: components["schemas"]["HttpRequest"];
|
|
5976
6412
|
status: components["schemas"]["Status"];
|
|
5977
6413
|
};
|
|
6414
|
+
MfaRequiredArgs: {
|
|
6415
|
+
/** @description Always set to first MFA id from `Self::ids` */
|
|
6416
|
+
id: string;
|
|
6417
|
+
/** @description Non-empty MFA request IDs */
|
|
6418
|
+
ids: string[];
|
|
6419
|
+
/** @description Organization id */
|
|
6420
|
+
org_id: string;
|
|
6421
|
+
/** @description Optional policy evaluation tree (included in signer responses, when requested) */
|
|
6422
|
+
policy_eval_tree?: unknown;
|
|
6423
|
+
session?: components["schemas"]["NewSessionResponse"] | null;
|
|
6424
|
+
};
|
|
5978
6425
|
/** @description Org-wide MFA requirements. */
|
|
5979
6426
|
MfaRequirements: {
|
|
5980
6427
|
alien_login_requirement?: components["schemas"]["SecondFactorRequirement"];
|
|
@@ -6014,7 +6461,7 @@ export interface components {
|
|
|
6014
6461
|
verified_email?: string | null;
|
|
6015
6462
|
};
|
|
6016
6463
|
MigrateUpdateUsersRequest: components["schemas"]["MigrateUpdateUserItem"][];
|
|
6017
|
-
MmiMetadata:
|
|
6464
|
+
MmiMetadata: {
|
|
6018
6465
|
/** @description Chain ID (not required when signing a personal message (EIP-191)) */
|
|
6019
6466
|
chainId?: string | null;
|
|
6020
6467
|
/** @description If the custodian should publish the transaction */
|
|
@@ -6028,42 +6475,6 @@ export interface components {
|
|
|
6028
6475
|
/** @description The category of transaction, as best can be determined by the wallet */
|
|
6029
6476
|
transactionCategory?: string | null;
|
|
6030
6477
|
};
|
|
6031
|
-
MmiMetadataExt: {
|
|
6032
|
-
/**
|
|
6033
|
-
* @description All accounts the user can access.
|
|
6034
|
-
* Only set when requested explicitly, i.e., via 'customer_listAccountsSigned'.
|
|
6035
|
-
*/
|
|
6036
|
-
accounts?:
|
|
6037
|
-
| {
|
|
6038
|
-
/**
|
|
6039
|
-
* @description An Ethereum address, hex-encoded, with leading '0x'
|
|
6040
|
-
* @example 0x0123456789012345678901234567890123456789
|
|
6041
|
-
*/
|
|
6042
|
-
address: string;
|
|
6043
|
-
/** @description Account metadata */
|
|
6044
|
-
metadata?: unknown;
|
|
6045
|
-
/** @description Account name */
|
|
6046
|
-
name: string;
|
|
6047
|
-
/** @description Ordered list of name-value pairs */
|
|
6048
|
-
tags?: {
|
|
6049
|
-
/** @description Tag name */
|
|
6050
|
-
name: string;
|
|
6051
|
-
/** @description Tag value */
|
|
6052
|
-
value: string;
|
|
6053
|
-
}[];
|
|
6054
|
-
}[]
|
|
6055
|
-
| null;
|
|
6056
|
-
/** @description The customer ID of the user, i.e., the customer's organization ID. */
|
|
6057
|
-
customerId: string | null;
|
|
6058
|
-
/** @description A human readable name of the corresponding organization, if any. */
|
|
6059
|
-
customerName: string | null;
|
|
6060
|
-
} & {
|
|
6061
|
-
/**
|
|
6062
|
-
* @description This must match the `sub` claim of the customer proof of
|
|
6063
|
-
* the user or role session which created the transaction.
|
|
6064
|
-
*/
|
|
6065
|
-
userId: string | null;
|
|
6066
|
-
};
|
|
6067
6478
|
MmiRejectRequest: {
|
|
6068
6479
|
/** @description Optional reason for rejecting. */
|
|
6069
6480
|
reason?: string | null;
|
|
@@ -6263,6 +6674,7 @@ export interface components {
|
|
|
6263
6674
|
| "BabylonCovSign"
|
|
6264
6675
|
| "BabylonRegistration"
|
|
6265
6676
|
| "BabylonStaking"
|
|
6677
|
+
| "BinanceSign"
|
|
6266
6678
|
| "BlobSign"
|
|
6267
6679
|
| "BtcMessageSign"
|
|
6268
6680
|
| "BtcSign"
|
|
@@ -7437,6 +7849,8 @@ export interface components {
|
|
|
7437
7849
|
>;
|
|
7438
7850
|
/** @description A request to sign a PSBT */
|
|
7439
7851
|
PsbtSignRequest: {
|
|
7852
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7853
|
+
dry_run?: boolean;
|
|
7440
7854
|
/**
|
|
7441
7855
|
* @description Request additional information to be included in the response, explaining
|
|
7442
7856
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7978,6 +8392,11 @@ export interface components {
|
|
|
7978
8392
|
RestrictedActionsMap: {
|
|
7979
8393
|
[key: string]: components["schemas"]["MemberRole"][];
|
|
7980
8394
|
};
|
|
8395
|
+
/** @description Parameters for the [`cs_retryTransaction`](RpcMethod::RetryTransaction) method. */
|
|
8396
|
+
RetryTransactionRequest: components["schemas"]["EvmTxCustomization"] & {
|
|
8397
|
+
/** @description The transaction id. */
|
|
8398
|
+
id: string;
|
|
8399
|
+
};
|
|
7981
8400
|
/**
|
|
7982
8401
|
* @description List of role actions that can be restricted to a set of member roles
|
|
7983
8402
|
* @enum {string}
|
|
@@ -8050,23 +8469,14 @@ export interface components {
|
|
|
8050
8469
|
/** @description A JSON Web Token whose claims contain the `RoleInfo` structure. */
|
|
8051
8470
|
jwt: string;
|
|
8052
8471
|
};
|
|
8053
|
-
/**
|
|
8054
|
-
|
|
8055
|
-
|
|
8056
|
-
|
|
8057
|
-
|
|
8058
|
-
|
|
8059
|
-
|
|
8060
|
-
|
|
8061
|
-
/** @enum {string} */
|
|
8062
|
-
method: "cs_getTransaction";
|
|
8063
|
-
params: components["schemas"]["GetTransactionRequest"];
|
|
8064
|
-
}
|
|
8065
|
-
| {
|
|
8066
|
-
/** @enum {string} */
|
|
8067
|
-
method: "cs_listTransactions";
|
|
8068
|
-
params: components["schemas"]["ListTransactionsRequest"];
|
|
8069
|
-
};
|
|
8472
|
+
/**
|
|
8473
|
+
* @description The RPC API method and matching parameters.
|
|
8474
|
+
*
|
|
8475
|
+
* Top-level dispatch. Wire format is preserved by `#[serde(untagged)]`: each
|
|
8476
|
+
* inbound request is matched against one of the internally-tagged inner enums
|
|
8477
|
+
* ([`CsRpc`] for the core methods, [`BinanceRpc`] for the Binance family).
|
|
8478
|
+
*/
|
|
8479
|
+
RpcMethod: components["schemas"]["CsRpc"] | components["schemas"]["BinanceRpc"];
|
|
8070
8480
|
/** @description All scopes for accessing CubeSigner APIs */
|
|
8071
8481
|
Scope: components["schemas"]["ExplicitScope"] | string;
|
|
8072
8482
|
/** @description A set of scopes. */
|
|
@@ -8218,6 +8628,12 @@ export interface components {
|
|
|
8218
8628
|
/** @description All metrics must include 'org_id' as a dimension. */
|
|
8219
8629
|
org_id: string;
|
|
8220
8630
|
};
|
|
8631
|
+
SignDryRunArgs: {
|
|
8632
|
+
/** @description Whether MFA is required */
|
|
8633
|
+
mfa_requests: components["schemas"]["MfaRequestInfo"][];
|
|
8634
|
+
/** @description Optional policy evaluation tree, if requested */
|
|
8635
|
+
policy_eval_tree?: unknown;
|
|
8636
|
+
};
|
|
8221
8637
|
SignResponse: {
|
|
8222
8638
|
/** @description Optional policy evaluation tree. */
|
|
8223
8639
|
policy_eval_tree?: unknown;
|
|
@@ -8330,6 +8746,8 @@ export interface components {
|
|
|
8330
8746
|
* }
|
|
8331
8747
|
*/
|
|
8332
8748
|
SolanaSignRequest: {
|
|
8749
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
8750
|
+
dry_run?: boolean;
|
|
8333
8751
|
/**
|
|
8334
8752
|
* @description Request additional information to be included in the response, explaining
|
|
8335
8753
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8359,6 +8777,8 @@ export interface components {
|
|
|
8359
8777
|
source_ip: string;
|
|
8360
8778
|
};
|
|
8361
8779
|
StakeRequest: {
|
|
8780
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
8781
|
+
dry_run?: boolean;
|
|
8362
8782
|
/**
|
|
8363
8783
|
* @description Request additional information to be included in the response, explaining
|
|
8364
8784
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8438,6 +8858,164 @@ export interface components {
|
|
|
8438
8858
|
num_auth_factors: number;
|
|
8439
8859
|
request_comparer?: components["schemas"]["HttpRequestCmp"];
|
|
8440
8860
|
};
|
|
8861
|
+
/**
|
|
8862
|
+
* @description A single asset balance entry returned by [`SubAccountAssetsResponse`].
|
|
8863
|
+
*
|
|
8864
|
+
* All balance fields are decimal strings (Binance preserves precision by not
|
|
8865
|
+
* converting to floats).
|
|
8866
|
+
*/
|
|
8867
|
+
SubAccountAsset: {
|
|
8868
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
8869
|
+
asset: string;
|
|
8870
|
+
/** @description Available balance. */
|
|
8871
|
+
free: string;
|
|
8872
|
+
/** @description Balance frozen by Binance (e.g. due to compliance holds). */
|
|
8873
|
+
freeze: string;
|
|
8874
|
+
/** @description Balance locked in open orders. */
|
|
8875
|
+
locked: string;
|
|
8876
|
+
/** @description Balance currently being withdrawn. */
|
|
8877
|
+
withdrawing: string;
|
|
8878
|
+
};
|
|
8879
|
+
/**
|
|
8880
|
+
* @description Parameters for `GET /sapi/v4/sub-account/assets`.
|
|
8881
|
+
*
|
|
8882
|
+
* Queries the spot-wallet balances of a single sub-account. Must be called by
|
|
8883
|
+
* a master-account credential.
|
|
8884
|
+
*/
|
|
8885
|
+
SubAccountAssetsRequest: {
|
|
8886
|
+
/** @description Email address of the sub-account whose balances to fetch. */
|
|
8887
|
+
email: string;
|
|
8888
|
+
};
|
|
8889
|
+
/** @description Response returned by `cs_binanceSubAccountAssets`. */
|
|
8890
|
+
SubAccountAssetsResponse: {
|
|
8891
|
+
/**
|
|
8892
|
+
* @description One entry per asset held in the sub-account's spot wallet. Binance
|
|
8893
|
+
* omits assets with all-zero balances.
|
|
8894
|
+
*/
|
|
8895
|
+
balances: components["schemas"]["SubAccountAsset"][];
|
|
8896
|
+
};
|
|
8897
|
+
/** @description One transfer entry in [`SubAccountTransferHistoryResponse`]. */
|
|
8898
|
+
SubAccountTransferHistoryEntry: {
|
|
8899
|
+
/** @description Asset symbol (e.g. `"USDT"`). */
|
|
8900
|
+
asset: string;
|
|
8901
|
+
/** @description Email of the counterparty account on the other side of the transfer. */
|
|
8902
|
+
counterParty: string;
|
|
8903
|
+
/**
|
|
8904
|
+
* @description Email of the account this entry's API key authenticates as. Binance
|
|
8905
|
+
* returns this on each row even though it is the same for the whole page.
|
|
8906
|
+
*/
|
|
8907
|
+
email: string;
|
|
8908
|
+
/**
|
|
8909
|
+
* @description Wallet type debited on the source side (e.g. `"SPOT"`,
|
|
8910
|
+
* `"USDT_FUTURE"`). Left as `String` for forward compatibility.
|
|
8911
|
+
*/
|
|
8912
|
+
fromAccountType: string;
|
|
8913
|
+
/** @description Amount transferred, as a decimal string. */
|
|
8914
|
+
qty: string;
|
|
8915
|
+
/**
|
|
8916
|
+
* @description Transfer status: `"PROCESS"`, `"SUCCESS"`, or `"FAILURE"`. Left as
|
|
8917
|
+
* `String` for forward compatibility.
|
|
8918
|
+
*/
|
|
8919
|
+
status: string;
|
|
8920
|
+
/**
|
|
8921
|
+
* Format: int64
|
|
8922
|
+
* @description Time of the transfer (ms since epoch).
|
|
8923
|
+
*/
|
|
8924
|
+
time: number;
|
|
8925
|
+
/** @description Wallet type credited on the destination side. */
|
|
8926
|
+
toAccountType: string;
|
|
8927
|
+
/**
|
|
8928
|
+
* Format: int64
|
|
8929
|
+
* @description Transfer id. Matches the `txnId` returned by the original
|
|
8930
|
+
* [`SubAccountTransferResponse`].
|
|
8931
|
+
*/
|
|
8932
|
+
tranId: number;
|
|
8933
|
+
/**
|
|
8934
|
+
* Format: int32
|
|
8935
|
+
* @description `1` = transfer in, `2` = transfer out.
|
|
8936
|
+
*/
|
|
8937
|
+
type: number;
|
|
8938
|
+
};
|
|
8939
|
+
/**
|
|
8940
|
+
* @description Parameters for `GET /sapi/v1/sub-account/transfer/subUserHistory`.
|
|
8941
|
+
*
|
|
8942
|
+
* Lists the transfer history of the calling sub-account. Covers both
|
|
8943
|
+
* sub-to-master and sub-to-sub transfers. All filters are optional; if
|
|
8944
|
+
* `start_time`/`end_time` are omitted, Binance returns the most recent 30
|
|
8945
|
+
* days. If `r#type` is omitted, Binance defaults to `TransferOut` (`2`).
|
|
8946
|
+
*/
|
|
8947
|
+
SubAccountTransferHistoryRequest: {
|
|
8948
|
+
/** @description Filter to a specific asset (e.g. `"USDT"`). */
|
|
8949
|
+
asset?: string | null;
|
|
8950
|
+
/**
|
|
8951
|
+
* Format: int64
|
|
8952
|
+
* @description Window end (ms since epoch).
|
|
8953
|
+
*/
|
|
8954
|
+
endTime?: number | null;
|
|
8955
|
+
/**
|
|
8956
|
+
* Format: int32
|
|
8957
|
+
* @description Page size (Binance default: 500).
|
|
8958
|
+
*/
|
|
8959
|
+
limit?: number | null;
|
|
8960
|
+
/**
|
|
8961
|
+
* @description If `true`, include failed transfers in the response. Binance defaults
|
|
8962
|
+
* to `false`.
|
|
8963
|
+
*/
|
|
8964
|
+
returnFailHistory?: boolean | null;
|
|
8965
|
+
/**
|
|
8966
|
+
* Format: int64
|
|
8967
|
+
* @description Window start (ms since epoch).
|
|
8968
|
+
*/
|
|
8969
|
+
startTime?: number | null;
|
|
8970
|
+
/**
|
|
8971
|
+
* Format: int32
|
|
8972
|
+
* @description Direction filter (`1` = transfer in, `2` = transfer out).
|
|
8973
|
+
*/
|
|
8974
|
+
type?: number | null;
|
|
8975
|
+
};
|
|
8976
|
+
/**
|
|
8977
|
+
* @description Response returned by `cs_binanceSubAccountTransferHistory`.
|
|
8978
|
+
*
|
|
8979
|
+
* Binance returns a top-level JSON array; this newtype preserves that wire
|
|
8980
|
+
* format while giving the response a named type in the OpenAPI schema.
|
|
8981
|
+
*/
|
|
8982
|
+
SubAccountTransferHistoryResponse: components["schemas"]["SubAccountTransferHistoryEntry"][];
|
|
8983
|
+
/** @description Response returned by `cs_binanceSubToMaster` and `cs_binanceSubToSub`. */
|
|
8984
|
+
SubAccountTransferResponse: {
|
|
8985
|
+
/** Format: int64 */
|
|
8986
|
+
txnId: number;
|
|
8987
|
+
};
|
|
8988
|
+
/**
|
|
8989
|
+
* @description Parameters for `POST /sapi/v1/sub-account/transfer/subToMaster`.
|
|
8990
|
+
*
|
|
8991
|
+
* Transfers an asset from the caller's sub-account to the master account.
|
|
8992
|
+
*/
|
|
8993
|
+
SubToMasterRequest: {
|
|
8994
|
+
/**
|
|
8995
|
+
* @description The amount being transferred, formatted as a decimal string (e.g. `"0.1"`).
|
|
8996
|
+
* Sent verbatim: Binance is strict about decimal formatting.
|
|
8997
|
+
*/
|
|
8998
|
+
amount: string;
|
|
8999
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`, `"BTC"`). */
|
|
9000
|
+
asset: string;
|
|
9001
|
+
};
|
|
9002
|
+
/**
|
|
9003
|
+
* @description Parameters for `POST /sapi/v1/sub-account/transfer/subToSub`.
|
|
9004
|
+
*
|
|
9005
|
+
* Transfers an asset from the caller's sub-account to another sub-account
|
|
9006
|
+
* under the same master account.
|
|
9007
|
+
*/
|
|
9008
|
+
SubToSubRequest: {
|
|
9009
|
+
/** @description The amount being transferred, as a decimal string (e.g. `"0.1"`). */
|
|
9010
|
+
amount: string;
|
|
9011
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`). */
|
|
9012
|
+
asset: string;
|
|
9013
|
+
/**
|
|
9014
|
+
* @description Email address of the destination sub-account. Must be a sub-account of
|
|
9015
|
+
* the same master.
|
|
9016
|
+
*/
|
|
9017
|
+
toEmail: string;
|
|
9018
|
+
};
|
|
8441
9019
|
/**
|
|
8442
9020
|
* @description The status of a subscription
|
|
8443
9021
|
* @enum {string}
|
|
@@ -8459,6 +9037,8 @@ export interface components {
|
|
|
8459
9037
|
SuiChain: "mainnet" | "devnet" | "testnet";
|
|
8460
9038
|
/** @description Request to sign a serialized SUI transaction */
|
|
8461
9039
|
SuiSignRequest: {
|
|
9040
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
9041
|
+
dry_run?: boolean;
|
|
8462
9042
|
/**
|
|
8463
9043
|
* @description Request additional information to be included in the response, explaining
|
|
8464
9044
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8485,6 +9065,8 @@ export interface components {
|
|
|
8485
9065
|
tx: string;
|
|
8486
9066
|
};
|
|
8487
9067
|
TaprootSignRequest: {
|
|
9068
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
9069
|
+
dry_run?: boolean;
|
|
8488
9070
|
/**
|
|
8489
9071
|
* @description Request additional information to be included in the response, explaining
|
|
8490
9072
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8557,6 +9139,8 @@ export interface components {
|
|
|
8557
9139
|
TelegramEnvironment: "production" | "test";
|
|
8558
9140
|
/** @description The request for using the Tendermint sign endpoint. */
|
|
8559
9141
|
TendermintSignRequest: {
|
|
9142
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
9143
|
+
dry_run?: boolean;
|
|
8560
9144
|
/**
|
|
8561
9145
|
* @description Request additional information to be included in the response, explaining
|
|
8562
9146
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8836,6 +9420,119 @@ export interface components {
|
|
|
8836
9420
|
| "AuthorizationHeaderMissing"
|
|
8837
9421
|
| "EndpointRequiresUserSession"
|
|
8838
9422
|
| "RefreshTokenMissing";
|
|
9423
|
+
/** @description One transfer entry in [`UniversalTransferHistoryResponse`]. */
|
|
9424
|
+
UniversalTransferHistoryEntry: {
|
|
9425
|
+
/** @description Amount transferred, as a decimal string. */
|
|
9426
|
+
amount: string;
|
|
9427
|
+
/** @description Asset symbol. */
|
|
9428
|
+
asset: string;
|
|
9429
|
+
/** @description Client-supplied transfer id, if one was set on the original transfer. */
|
|
9430
|
+
clientTranId?: string | null;
|
|
9431
|
+
/**
|
|
9432
|
+
* Format: int64
|
|
9433
|
+
* @description Time of the transfer (ms since epoch).
|
|
9434
|
+
*/
|
|
9435
|
+
createTimeStamp: number;
|
|
9436
|
+
/**
|
|
9437
|
+
* @description Wallet type debited on the source side. Left as `String` for forward
|
|
9438
|
+
* compatibility.
|
|
9439
|
+
*/
|
|
9440
|
+
fromAccountType: string;
|
|
9441
|
+
/** @description Source sub-account email; absent when the source is the master. */
|
|
9442
|
+
fromEmail?: string | null;
|
|
9443
|
+
/** @description Transfer status (e.g. `"SUCCESS"`). */
|
|
9444
|
+
status: string;
|
|
9445
|
+
/** @description Wallet type credited on the destination side. */
|
|
9446
|
+
toAccountType: string;
|
|
9447
|
+
/** @description Destination sub-account email; absent when the destination is master. */
|
|
9448
|
+
toEmail?: string | null;
|
|
9449
|
+
/**
|
|
9450
|
+
* Format: int64
|
|
9451
|
+
* @description Transfer id. Matches the `tranId` returned by the original
|
|
9452
|
+
* [`UniversalTransferResponse`].
|
|
9453
|
+
*/
|
|
9454
|
+
tranId: number;
|
|
9455
|
+
};
|
|
9456
|
+
/**
|
|
9457
|
+
* @description Parameters for `GET /sapi/v1/sub-account/universalTransfer`.
|
|
9458
|
+
*
|
|
9459
|
+
* Lists universal transfers initiated by the master account. All filters
|
|
9460
|
+
* are optional; if `start_time`/`end_time` are omitted, Binance returns the
|
|
9461
|
+
* most recent 30 days. Binance does not support filtering by `tran_id`
|
|
9462
|
+
* directly — use `client_tran_id` if you set one when initiating the
|
|
9463
|
+
* transfer, or page through the result and match the `tranId` client-side.
|
|
9464
|
+
*/
|
|
9465
|
+
UniversalTransferHistoryRequest: {
|
|
9466
|
+
/** @description Filter by client-supplied transfer id. */
|
|
9467
|
+
clientTranId?: string | null;
|
|
9468
|
+
/**
|
|
9469
|
+
* Format: int64
|
|
9470
|
+
* @description Window end (ms since epoch).
|
|
9471
|
+
*/
|
|
9472
|
+
endTime?: number | null;
|
|
9473
|
+
/** @description Filter to transfers originating from this sub-account email. */
|
|
9474
|
+
fromEmail?: string | null;
|
|
9475
|
+
/**
|
|
9476
|
+
* Format: int32
|
|
9477
|
+
* @description Page size (Binance default: 500, max: 500).
|
|
9478
|
+
*/
|
|
9479
|
+
limit?: number | null;
|
|
9480
|
+
/**
|
|
9481
|
+
* Format: int32
|
|
9482
|
+
* @description 1-based page number (Binance default: 1).
|
|
9483
|
+
*/
|
|
9484
|
+
page?: number | null;
|
|
9485
|
+
/**
|
|
9486
|
+
* Format: int64
|
|
9487
|
+
* @description Window start (ms since epoch).
|
|
9488
|
+
*/
|
|
9489
|
+
startTime?: number | null;
|
|
9490
|
+
/** @description Filter to transfers destined for this sub-account email. */
|
|
9491
|
+
toEmail?: string | null;
|
|
9492
|
+
};
|
|
9493
|
+
/** @description Response returned by `cs_binanceUniversalTransferHistory`. */
|
|
9494
|
+
UniversalTransferHistoryResponse: {
|
|
9495
|
+
/** @description Transfers in the current page. */
|
|
9496
|
+
result: components["schemas"]["UniversalTransferHistoryEntry"][];
|
|
9497
|
+
/**
|
|
9498
|
+
* Format: int64
|
|
9499
|
+
* @description Total number of transfers matching the filters across all pages.
|
|
9500
|
+
*/
|
|
9501
|
+
totalCount: number;
|
|
9502
|
+
};
|
|
9503
|
+
/**
|
|
9504
|
+
* @description Parameters for `POST /sapi/v1/sub-account/universalTransfer`.
|
|
9505
|
+
*
|
|
9506
|
+
* Transfers an asset between any two accounts (master to/from sub, or sub
|
|
9507
|
+
* to/from sub) and between any two wallet types (spot, futures, margin, etc).
|
|
9508
|
+
* The signing credential (the API key + Ed25519 key pair) must belong to the
|
|
9509
|
+
* master account.
|
|
9510
|
+
*/
|
|
9511
|
+
UniversalTransferRequest: {
|
|
9512
|
+
/** @description The amount being transferred, as a decimal string. */
|
|
9513
|
+
amount: string;
|
|
9514
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`). */
|
|
9515
|
+
asset: string;
|
|
9516
|
+
/**
|
|
9517
|
+
* @description Optional client-supplied transfer id. If set, Binance echoes it back
|
|
9518
|
+
* on [`UniversalTransferResponse::client_tran_id`] and lets it be used
|
|
9519
|
+
* as a filter on
|
|
9520
|
+
* [`UniversalTransferHistoryRequest::client_tran_id`].
|
|
9521
|
+
*/
|
|
9522
|
+
clientTranId?: string | null;
|
|
9523
|
+
fromAccountType?: components["schemas"]["AccountType"];
|
|
9524
|
+
/** @description Source sub-account email. If `None`, the source is the master account. */
|
|
9525
|
+
fromEmail?: string | null;
|
|
9526
|
+
toAccountType?: components["schemas"]["AccountType"];
|
|
9527
|
+
/** @description Destination sub-account email. If `None`, the destination is the master account. */
|
|
9528
|
+
toEmail?: string | null;
|
|
9529
|
+
};
|
|
9530
|
+
/** @description Response returned by `cs_binanceUniversalTransfer`. */
|
|
9531
|
+
UniversalTransferResponse: {
|
|
9532
|
+
clientTranId?: string | null;
|
|
9533
|
+
/** Format: int64 */
|
|
9534
|
+
tranId: number;
|
|
9535
|
+
};
|
|
8839
9536
|
/** @description Options that should be set only for local devnet testing. */
|
|
8840
9537
|
UnsafeConf: {
|
|
8841
9538
|
/**
|
|
@@ -8864,6 +9561,8 @@ export interface components {
|
|
|
8864
9561
|
*/
|
|
8865
9562
|
validator_index: string;
|
|
8866
9563
|
} & {
|
|
9564
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
9565
|
+
dry_run?: boolean;
|
|
8867
9566
|
/**
|
|
8868
9567
|
* @description Request additional information to be included in the response, explaining
|
|
8869
9568
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -8938,6 +9637,14 @@ export interface components {
|
|
|
8938
9637
|
* Once disabled, a key cannot be used for signing.
|
|
8939
9638
|
*/
|
|
8940
9639
|
enabled?: boolean | null;
|
|
9640
|
+
/**
|
|
9641
|
+
* @description If set, patch the key's structured [`KeyProperties`]. The patch's variant must
|
|
9642
|
+
* match the key's [`KeyType`] (e.g. `BinanceApi` properties are only allowed on
|
|
9643
|
+
* `Ed25519BinanceApi` keys). Each field in the patch is independent: missing
|
|
9644
|
+
* means leave alone, JSON `null` clears, a value sets. Sending JSON `null` for
|
|
9645
|
+
* the whole field clears all properties on the key.
|
|
9646
|
+
*/
|
|
9647
|
+
properties?: unknown;
|
|
8941
9648
|
/**
|
|
8942
9649
|
* @description If set, change the key's region affinity to this value.
|
|
8943
9650
|
*
|
|
@@ -9603,6 +10310,179 @@ export interface components {
|
|
|
9603
10310
|
WhereAndWhen: components["schemas"]["SourceIp"] & {
|
|
9604
10311
|
time: components["schemas"]["EpochDateTime"];
|
|
9605
10312
|
};
|
|
10313
|
+
/** @description One withdrawal entry in [`WithdrawHistoryResponse`]. */
|
|
10314
|
+
WithdrawHistoryEntry: {
|
|
10315
|
+
/** @description Destination address. */
|
|
10316
|
+
address: string;
|
|
10317
|
+
/** @description Withdrawal amount, as a decimal string. */
|
|
10318
|
+
amount: string;
|
|
10319
|
+
/**
|
|
10320
|
+
* @description Time the withdrawal was requested (Binance returns a UTC string,
|
|
10321
|
+
* e.g. `"2019-09-24 12:43:45"`).
|
|
10322
|
+
*/
|
|
10323
|
+
applyTime: string;
|
|
10324
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
10325
|
+
coin: string;
|
|
10326
|
+
/**
|
|
10327
|
+
* @description Time the withdrawal completed (UTC string), present once
|
|
10328
|
+
* `status == 6`.
|
|
10329
|
+
*/
|
|
10330
|
+
completeTime?: string | null;
|
|
10331
|
+
/**
|
|
10332
|
+
* Format: int32
|
|
10333
|
+
* @description Number of on-chain confirmations.
|
|
10334
|
+
*/
|
|
10335
|
+
confirmNo?: number | null;
|
|
10336
|
+
/**
|
|
10337
|
+
* @description Binance-assigned withdrawal id. Matches the `id` returned by
|
|
10338
|
+
* [`WithdrawResponse`].
|
|
10339
|
+
*/
|
|
10340
|
+
id: string;
|
|
10341
|
+
/** @description Failure reason when the withdrawal was rejected. */
|
|
10342
|
+
info?: string | null;
|
|
10343
|
+
/** @description Blockchain network identifier (e.g. `"BSC"`, `"ETH"`). */
|
|
10344
|
+
network?: string | null;
|
|
10345
|
+
/**
|
|
10346
|
+
* Format: int32
|
|
10347
|
+
* @description Withdrawal status. Binance values: `0` = Email Sent,
|
|
10348
|
+
* `2` = Awaiting Approval, `3` = Rejected, `4` = Processing,
|
|
10349
|
+
* `6` = Completed. Left as `u8` for forward compatibility.
|
|
10350
|
+
*/
|
|
10351
|
+
status: number;
|
|
10352
|
+
/** @description Network fee charged for the withdrawal, as a decimal string. */
|
|
10353
|
+
transactionFee: string;
|
|
10354
|
+
/**
|
|
10355
|
+
* Format: int32
|
|
10356
|
+
* @description `0` = external transfer, `1` = internal (Binance↔Binance) transfer.
|
|
10357
|
+
*/
|
|
10358
|
+
transferType: number;
|
|
10359
|
+
/**
|
|
10360
|
+
* @description On-chain transaction hash, once Binance has broadcast the withdrawal.
|
|
10361
|
+
* May be empty until then.
|
|
10362
|
+
*/
|
|
10363
|
+
txId?: string | null;
|
|
10364
|
+
/**
|
|
10365
|
+
* Format: int32
|
|
10366
|
+
* @description Source wallet: `0` = spot wallet, `1` = funding wallet.
|
|
10367
|
+
*/
|
|
10368
|
+
walletType: number;
|
|
10369
|
+
/**
|
|
10370
|
+
* @description Client-supplied withdrawal id, if one was set on the original
|
|
10371
|
+
* withdrawal call.
|
|
10372
|
+
*/
|
|
10373
|
+
withdrawOrderId?: string | null;
|
|
10374
|
+
};
|
|
10375
|
+
/**
|
|
10376
|
+
* @description Parameters for `GET /sapi/v1/capital/withdraw/history`.
|
|
10377
|
+
*
|
|
10378
|
+
* Returns the master account's withdrawal history. All filters are
|
|
10379
|
+
* optional; if `start_time`/`end_time` are omitted, Binance returns the
|
|
10380
|
+
* most recent 90 days. Use `id_list` to look up specific withdrawals by
|
|
10381
|
+
* the `id` returned from [`BinanceRpc::Withdraw`], or `withdraw_order_id`
|
|
10382
|
+
* to look one up by its client-supplied id.
|
|
10383
|
+
*/
|
|
10384
|
+
WithdrawHistoryRequest: {
|
|
10385
|
+
/** @description Filter to a specific asset (e.g. `"USDT"`). */
|
|
10386
|
+
coin?: string | null;
|
|
10387
|
+
/**
|
|
10388
|
+
* Format: int64
|
|
10389
|
+
* @description Window end (ms since epoch).
|
|
10390
|
+
*/
|
|
10391
|
+
endTime?: number | null;
|
|
10392
|
+
/**
|
|
10393
|
+
* @description Comma-separated list of Binance-assigned withdrawal ids (the `id`
|
|
10394
|
+
* field of [`WithdrawResponse`]). Up to 45 ids per query, per Binance.
|
|
10395
|
+
*/
|
|
10396
|
+
idList?: string | null;
|
|
10397
|
+
/**
|
|
10398
|
+
* Format: int32
|
|
10399
|
+
* @description Page size (Binance default and max: 1000).
|
|
10400
|
+
*/
|
|
10401
|
+
limit?: number | null;
|
|
10402
|
+
/**
|
|
10403
|
+
* Format: int32
|
|
10404
|
+
* @description Pagination offset.
|
|
10405
|
+
*/
|
|
10406
|
+
offset?: number | null;
|
|
10407
|
+
/**
|
|
10408
|
+
* Format: int64
|
|
10409
|
+
* @description Window start (ms since epoch).
|
|
10410
|
+
*/
|
|
10411
|
+
startTime?: number | null;
|
|
10412
|
+
/**
|
|
10413
|
+
* Format: int32
|
|
10414
|
+
* @description Filter by withdrawal status. Binance values:
|
|
10415
|
+
* `0` = Email Sent, `2` = Awaiting Approval, `3` = Rejected,
|
|
10416
|
+
* `4` = Processing, `6` = Completed. Left as `u8` for forward
|
|
10417
|
+
* compatibility.
|
|
10418
|
+
*/
|
|
10419
|
+
status?: number | null;
|
|
10420
|
+
/**
|
|
10421
|
+
* @description Filter by the client-supplied withdrawal id originally passed to
|
|
10422
|
+
* [`WithdrawRequest::withdraw_order_id`].
|
|
10423
|
+
*/
|
|
10424
|
+
withdrawOrderId?: string | null;
|
|
10425
|
+
};
|
|
10426
|
+
/**
|
|
10427
|
+
* @description Response returned by `cs_binanceWithdrawHistory`.
|
|
10428
|
+
*
|
|
10429
|
+
* Binance returns a top-level JSON array; this newtype preserves that wire
|
|
10430
|
+
* format while giving the response a named type in the OpenAPI schema.
|
|
10431
|
+
*/
|
|
10432
|
+
WithdrawHistoryResponse: components["schemas"]["WithdrawHistoryEntry"][];
|
|
10433
|
+
/**
|
|
10434
|
+
* @description Parameters for `POST /sapi/v1/capital/withdraw/apply`.
|
|
10435
|
+
*
|
|
10436
|
+
* Submits a withdrawal of `amount` of `coin` to the given external `address`.
|
|
10437
|
+
* The signing key's account must have withdrawal permissions enabled.
|
|
10438
|
+
*/
|
|
10439
|
+
WithdrawRequest: {
|
|
10440
|
+
/** @description Destination address. */
|
|
10441
|
+
address: string;
|
|
10442
|
+
/**
|
|
10443
|
+
* @description Secondary address identifier required by some assets (e.g. memo for
|
|
10444
|
+
* XRP, tag for XLM).
|
|
10445
|
+
*/
|
|
10446
|
+
addressTag?: string | null;
|
|
10447
|
+
/**
|
|
10448
|
+
* @description The amount being withdrawn, formatted as a decimal string (e.g. `"0.1"`).
|
|
10449
|
+
* Sent verbatim: Binance is strict about decimal formatting.
|
|
10450
|
+
*/
|
|
10451
|
+
amount: string;
|
|
10452
|
+
/** @description The asset symbol being withdrawn (e.g. `"USDT"`, `"BTC"`). */
|
|
10453
|
+
coin: string;
|
|
10454
|
+
/** @description Optional human-readable description for the withdrawal. */
|
|
10455
|
+
name?: string | null;
|
|
10456
|
+
/**
|
|
10457
|
+
* @description Network identifier (e.g. `"BSC"`, `"ETH"`). If omitted, Binance picks
|
|
10458
|
+
* the default network for the asset.
|
|
10459
|
+
*/
|
|
10460
|
+
network?: string | null;
|
|
10461
|
+
/**
|
|
10462
|
+
* @description If `true`, the withdrawal fee is deducted from the destination amount;
|
|
10463
|
+
* if `false` (Binance default), it is deducted from the account balance
|
|
10464
|
+
* in addition to `amount`.
|
|
10465
|
+
*/
|
|
10466
|
+
transactionFeeFlag?: boolean | null;
|
|
10467
|
+
/**
|
|
10468
|
+
* Format: int32
|
|
10469
|
+
* @description Source wallet: `0` = spot wallet (default), `1` = funding wallet.
|
|
10470
|
+
*/
|
|
10471
|
+
walletType?: number | null;
|
|
10472
|
+
/**
|
|
10473
|
+
* @description Client-supplied withdrawal id, returned by Binance as `withdrawOrderId`
|
|
10474
|
+
* in subsequent withdrawal-history queries.
|
|
10475
|
+
*/
|
|
10476
|
+
withdrawOrderId?: string | null;
|
|
10477
|
+
};
|
|
10478
|
+
/** @description Response returned by `cs_binanceWithdraw`. */
|
|
10479
|
+
WithdrawResponse: {
|
|
10480
|
+
/**
|
|
10481
|
+
* @description Binance-assigned withdrawal id. Used to look the request up later via
|
|
10482
|
+
* the withdrawal-history endpoint.
|
|
10483
|
+
*/
|
|
10484
|
+
id: string;
|
|
10485
|
+
};
|
|
9606
10486
|
};
|
|
9607
10487
|
responses: {
|
|
9608
10488
|
AddThirdPartyUserResponse: {
|
|
@@ -9728,6 +10608,21 @@ export interface components {
|
|
|
9728
10608
|
};
|
|
9729
10609
|
};
|
|
9730
10610
|
};
|
|
10611
|
+
/** @description Response returned by the typed `binance_sign` endpoint. */
|
|
10612
|
+
BinanceSignResponse: {
|
|
10613
|
+
content: {
|
|
10614
|
+
"application/json": {
|
|
10615
|
+
/** @description Optional policy evaluation tree. */
|
|
10616
|
+
policy_eval_tree?: unknown;
|
|
10617
|
+
} & {
|
|
10618
|
+
/**
|
|
10619
|
+
* @description The full signed query string, ready to be submitted to Binance.
|
|
10620
|
+
* Encoded as `<urlencoded params>&recvWindow=<ms>×tamp=<ms>&signature=<urlencoded base64 sig>`.
|
|
10621
|
+
*/
|
|
10622
|
+
signed_query: string;
|
|
10623
|
+
};
|
|
10624
|
+
};
|
|
10625
|
+
};
|
|
9731
10626
|
/** @description BTC message signing response */
|
|
9732
10627
|
BtcMessageSignResponse: {
|
|
9733
10628
|
content: {
|
|
@@ -10187,6 +11082,7 @@ export interface components {
|
|
|
10187
11082
|
* ]
|
|
10188
11083
|
*/
|
|
10189
11084
|
policy: unknown[];
|
|
11085
|
+
properties?: components["schemas"]["KeyPropertiesPatch"] | null;
|
|
10190
11086
|
/** @description The key provenance. */
|
|
10191
11087
|
provenance?: string | null;
|
|
10192
11088
|
/**
|
|
@@ -16833,6 +17729,11 @@ export interface operations {
|
|
|
16833
17729
|
user_id: string;
|
|
16834
17730
|
};
|
|
16835
17731
|
};
|
|
17732
|
+
requestBody: {
|
|
17733
|
+
content: {
|
|
17734
|
+
"application/json": components["schemas"]["Empty"];
|
|
17735
|
+
};
|
|
17736
|
+
};
|
|
16836
17737
|
responses: {
|
|
16837
17738
|
200: components["responses"]["EmptyImpl"];
|
|
16838
17739
|
default: {
|
|
@@ -17076,6 +17977,47 @@ export interface operations {
|
|
|
17076
17977
|
};
|
|
17077
17978
|
};
|
|
17078
17979
|
};
|
|
17980
|
+
/**
|
|
17981
|
+
* Sign Binance RPC Request
|
|
17982
|
+
* @description Sign Binance RPC Request
|
|
17983
|
+
*
|
|
17984
|
+
* Signs a typed [`BinanceRpc`] request with the [`KeyType::Ed25519BinanceApi`]
|
|
17985
|
+
* key identified by `material_id`. The signer URL-encodes the inner request,
|
|
17986
|
+
* appends Binance's `recvWindow` and `timestamp` parameters, signs the
|
|
17987
|
+
* resulting query, and returns the full query string ready to be submitted
|
|
17988
|
+
* to Binance.
|
|
17989
|
+
*/
|
|
17990
|
+
binanceSign: {
|
|
17991
|
+
parameters: {
|
|
17992
|
+
path: {
|
|
17993
|
+
/**
|
|
17994
|
+
* @description Name or ID of the desired Org
|
|
17995
|
+
* @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
17996
|
+
*/
|
|
17997
|
+
org_id: string;
|
|
17998
|
+
/** @description Material id of the Ed25519BinanceApi key */
|
|
17999
|
+
material_id: string;
|
|
18000
|
+
};
|
|
18001
|
+
};
|
|
18002
|
+
requestBody: {
|
|
18003
|
+
content: {
|
|
18004
|
+
"application/json": components["schemas"]["BinanceRpc"];
|
|
18005
|
+
};
|
|
18006
|
+
};
|
|
18007
|
+
responses: {
|
|
18008
|
+
200: components["responses"]["BinanceSignResponse"];
|
|
18009
|
+
202: {
|
|
18010
|
+
content: {
|
|
18011
|
+
"application/json": components["schemas"]["AcceptedResponse"];
|
|
18012
|
+
};
|
|
18013
|
+
};
|
|
18014
|
+
default: {
|
|
18015
|
+
content: {
|
|
18016
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
18017
|
+
};
|
|
18018
|
+
};
|
|
18019
|
+
};
|
|
18020
|
+
};
|
|
17079
18021
|
/**
|
|
17080
18022
|
* Sign Raw Blob
|
|
17081
18023
|
* @description Sign Raw Blob
|