@cubist-labs/cubesigner-sdk 0.4.254 → 0.4.259
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/src/audit_log.d.ts +5 -5
- package/dist/src/client/api_client.d.ts +18 -3
- package/dist/src/client/api_client.d.ts.map +1 -1
- package/dist/src/client/api_client.js +27 -4
- package/dist/src/key.d.ts +5 -8
- package/dist/src/key.d.ts.map +1 -1
- package/dist/src/key.js +6 -2
- package/dist/src/org.d.ts +463 -25
- package/dist/src/org.d.ts.map +1 -1
- package/dist/src/org.js +66 -26
- package/dist/src/schema.d.ts +531 -13
- package/dist/src/schema.d.ts.map +1 -1
- package/dist/src/schema.js +1 -1
- package/dist/src/schema_types.d.ts +7 -0
- package/dist/src/schema_types.d.ts.map +1 -1
- package/dist/src/schema_types.js +23 -3
- package/dist/src/scopes.d.ts.map +1 -1
- package/dist/src/scopes.js +10 -1
- package/package.json +1 -1
- package/src/client/api_client.ts +36 -4
- package/src/key.ts +8 -8
- package/src/org.ts +82 -28
- package/src/schema.ts +581 -9
- package/src/schema_types.ts +30 -2
- package/src/scopes.ts +9 -0
package/src/schema.ts
CHANGED
|
@@ -1760,6 +1760,9 @@ export interface components {
|
|
|
1760
1760
|
{
|
|
1761
1761
|
BinanceDryRun: components["schemas"]["BinanceDryRunArgs"];
|
|
1762
1762
|
},
|
|
1763
|
+
{
|
|
1764
|
+
BybitDryRun: components["schemas"]["BybitDryRunArgs"];
|
|
1765
|
+
},
|
|
1763
1766
|
{
|
|
1764
1767
|
CoinbaseDryRun: components["schemas"]["CoinbaseDryRunArgs"];
|
|
1765
1768
|
},
|
|
@@ -1769,7 +1772,12 @@ export interface components {
|
|
|
1769
1772
|
]
|
|
1770
1773
|
>;
|
|
1771
1774
|
/** @enum {string} */
|
|
1772
|
-
AcceptedValueCode:
|
|
1775
|
+
AcceptedValueCode:
|
|
1776
|
+
| "SignDryRun"
|
|
1777
|
+
| "BinanceDryRun"
|
|
1778
|
+
| "BybitDryRun"
|
|
1779
|
+
| "CoinbaseDryRun"
|
|
1780
|
+
| "MfaRequired";
|
|
1773
1781
|
/**
|
|
1774
1782
|
* @description Determines who controls the keys within an org
|
|
1775
1783
|
* @enum {string}
|
|
@@ -2876,8 +2884,10 @@ export interface components {
|
|
|
2876
2884
|
| "InvalidPropertiesForKeyType"
|
|
2877
2885
|
| "MismatchedKeyPropertiesPatch"
|
|
2878
2886
|
| "MissingBinanceApiKey"
|
|
2887
|
+
| "MissingBybitApiKey"
|
|
2879
2888
|
| "MissingCoinbaseApiKey"
|
|
2880
2889
|
| "BinanceKeyMasterMismatch"
|
|
2890
|
+
| "BybitAccountMismatch"
|
|
2881
2891
|
| "InvalidKeyMaterial"
|
|
2882
2892
|
| "InvalidHexValue"
|
|
2883
2893
|
| "InvalidBase32Value"
|
|
@@ -3154,6 +3164,7 @@ export interface components {
|
|
|
3154
3164
|
| "BabylonStaking"
|
|
3155
3165
|
| "BabylonCovSign"
|
|
3156
3166
|
| "BinanceSign"
|
|
3167
|
+
| "BybitSign"
|
|
3157
3168
|
| "CoinbaseSign"
|
|
3158
3169
|
| "BlobSign"
|
|
3159
3170
|
| "BtcMessageSign"
|
|
@@ -3202,6 +3213,7 @@ export interface components {
|
|
|
3202
3213
|
| "RpcListTransactions"
|
|
3203
3214
|
| "RpcRetryTransaction"
|
|
3204
3215
|
| "RpcBinance"
|
|
3216
|
+
| "RpcBybit"
|
|
3205
3217
|
| "RpcCoinbase"
|
|
3206
3218
|
| "CustomChainRpcCall"
|
|
3207
3219
|
| "EsploraApiCall"
|
|
@@ -3754,6 +3766,487 @@ export interface components {
|
|
|
3754
3766
|
metadata?: unknown;
|
|
3755
3767
|
owner: components["schemas"]["Id"];
|
|
3756
3768
|
};
|
|
3769
|
+
/**
|
|
3770
|
+
* @description Wire-format patch payload for [`KeyProperties::BybitApi`].
|
|
3771
|
+
*
|
|
3772
|
+
* Every field follows the same per-field PATCH semantics: a missing field
|
|
3773
|
+
* leaves the existing value alone, a JSON `null` clears it, and a value sets it.
|
|
3774
|
+
*/
|
|
3775
|
+
BybitApiPropertiesPatch: {
|
|
3776
|
+
/** @description The Bybit-issued API key string. Encrypted server-side before storage. */
|
|
3777
|
+
api_key?: string | null;
|
|
3778
|
+
/** @description Arbitrary label. Useful for storing the corresponding API key label on the Bybit side. */
|
|
3779
|
+
label?: string | null;
|
|
3780
|
+
};
|
|
3781
|
+
/** @description One entry in [`BybitQueryCoinsBalanceResponse::balance`]. */
|
|
3782
|
+
BybitCoinBalance: {
|
|
3783
|
+
/** @description Bonus / promotional balance, as a decimal string. */
|
|
3784
|
+
bonus?: string | null;
|
|
3785
|
+
/** @description Coin symbol, uppercase (e.g. `USDT`, `BTC`). */
|
|
3786
|
+
coin: string;
|
|
3787
|
+
/** @description Portion of `wallet_balance` that can be transferred out. */
|
|
3788
|
+
transferBalance: string;
|
|
3789
|
+
/** @description Total wallet balance for `coin`, as a decimal string. */
|
|
3790
|
+
walletBalance: string;
|
|
3791
|
+
};
|
|
3792
|
+
/** @description One entry in [`BybitQueryDepositAddressResponse::chains`]. */
|
|
3793
|
+
BybitDepositChain: {
|
|
3794
|
+
/** @description Deposit address on this chain. */
|
|
3795
|
+
addressDeposit: string;
|
|
3796
|
+
/** @description Single-deposit cap for this coin on this chain; `"-1"` means no limit. */
|
|
3797
|
+
batchReleaseLimit?: string | null;
|
|
3798
|
+
/** @description Short chain code (e.g. `ETH`, `TRX`). */
|
|
3799
|
+
chain: string;
|
|
3800
|
+
/** @description Human-readable chain name (e.g. `Ethereum (ERC20)`). */
|
|
3801
|
+
chainType?: string | null;
|
|
3802
|
+
/**
|
|
3803
|
+
* @description Token contract address on this chain. Bybit only returns the last 6
|
|
3804
|
+
* characters; empty for native coins.
|
|
3805
|
+
*/
|
|
3806
|
+
contractAddress?: string | null;
|
|
3807
|
+
/**
|
|
3808
|
+
* @description Memo / tag required for chains that use one (e.g. XRP, EOS). Empty for
|
|
3809
|
+
* chains that don't.
|
|
3810
|
+
*/
|
|
3811
|
+
tagDeposit?: string | null;
|
|
3812
|
+
};
|
|
3813
|
+
BybitDryRunArgs: {
|
|
3814
|
+
/** @description The Bybit API method that would have been used */
|
|
3815
|
+
method: string;
|
|
3816
|
+
/** @description The request body (for POST endpoints) or query string (for GET endpoints). */
|
|
3817
|
+
payload: string;
|
|
3818
|
+
/** @description The Bybit API url that would have been called */
|
|
3819
|
+
url: string;
|
|
3820
|
+
};
|
|
3821
|
+
/**
|
|
3822
|
+
* @description "Dry run" modes for Bybit requests.
|
|
3823
|
+
* @enum {string}
|
|
3824
|
+
*/
|
|
3825
|
+
BybitDryRunMode: "NO_SIGN" | "NO_SUBMIT";
|
|
3826
|
+
/**
|
|
3827
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3828
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3829
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3830
|
+
* directly below.)
|
|
3831
|
+
*/
|
|
3832
|
+
BybitQueryCoinsBalanceParams: components["schemas"]["BybitQueryCoinsBalanceRequest"] & {
|
|
3833
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3834
|
+
keyId: components["schemas"]["Id"];
|
|
3835
|
+
/**
|
|
3836
|
+
* Format: int32
|
|
3837
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3838
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3839
|
+
*/
|
|
3840
|
+
recvWindow?: number | null;
|
|
3841
|
+
};
|
|
3842
|
+
/** @description Parameters for `GET /v5/asset/transfer/query-account-coins-balance`. */
|
|
3843
|
+
BybitQueryCoinsBalanceRequest: {
|
|
3844
|
+
/**
|
|
3845
|
+
* @description Wallet type. Common values: `"FUND"`, `"UNIFIED"`, `"CONTRACT"`. Bybit
|
|
3846
|
+
* expects this verbatim; we don't constrain it on our side.
|
|
3847
|
+
*/
|
|
3848
|
+
accountType: string;
|
|
3849
|
+
/**
|
|
3850
|
+
* @description Optional list of coin symbols, comma-separated (e.g. `"BTC,USDT"`).
|
|
3851
|
+
* Bybit returns balances for all coins when omitted.
|
|
3852
|
+
*/
|
|
3853
|
+
coin?: string | null;
|
|
3854
|
+
/**
|
|
3855
|
+
* @description Optional sub-account UID. When supplied, the master key queries the
|
|
3856
|
+
* named sub-account's balance.
|
|
3857
|
+
*/
|
|
3858
|
+
memberId?: string | null;
|
|
3859
|
+
/**
|
|
3860
|
+
* @description Optional flag: `"0"` query without conversion to USD (default),
|
|
3861
|
+
* `"1"` include USD valuation. Bybit accepts this as a string.
|
|
3862
|
+
*/
|
|
3863
|
+
withBonus?: string | null;
|
|
3864
|
+
};
|
|
3865
|
+
/** @description Response of `GET /v5/asset/transfer/query-account-coins-balance`. */
|
|
3866
|
+
BybitQueryCoinsBalanceResponse: {
|
|
3867
|
+
/** @description Account type the balances belong to (e.g. `UNIFIED`, `FUND`, `CONTRACT`). */
|
|
3868
|
+
accountType: string;
|
|
3869
|
+
/** @description Per-coin balances. */
|
|
3870
|
+
balance: components["schemas"]["BybitCoinBalance"][];
|
|
3871
|
+
/** @description UID of the (sub-)account whose balance is being reported. */
|
|
3872
|
+
memberId?: string | null;
|
|
3873
|
+
};
|
|
3874
|
+
/**
|
|
3875
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3876
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3877
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3878
|
+
* directly below.)
|
|
3879
|
+
*/
|
|
3880
|
+
BybitQueryDepositAddressParams: components["schemas"]["BybitQueryDepositAddressRequest"] & {
|
|
3881
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3882
|
+
keyId: components["schemas"]["Id"];
|
|
3883
|
+
/**
|
|
3884
|
+
* Format: int32
|
|
3885
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3886
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3887
|
+
*/
|
|
3888
|
+
recvWindow?: number | null;
|
|
3889
|
+
};
|
|
3890
|
+
/** @description Parameters for `GET /v5/asset/deposit/query-address`. */
|
|
3891
|
+
BybitQueryDepositAddressRequest: {
|
|
3892
|
+
/**
|
|
3893
|
+
* @description Optional network identifier (e.g. `"ETH"`, `"TRX"`). When omitted,
|
|
3894
|
+
* Bybit returns the deposit address on every supported chain.
|
|
3895
|
+
*/
|
|
3896
|
+
chainType?: string | null;
|
|
3897
|
+
/** @description Coin symbol (e.g. `"BTC"`, `"USDT"`). */
|
|
3898
|
+
coin: string;
|
|
3899
|
+
};
|
|
3900
|
+
/** @description Response of `GET /v5/asset/deposit/query-address`. */
|
|
3901
|
+
BybitQueryDepositAddressResponse: {
|
|
3902
|
+
/** @description One deposit address per supported chain. */
|
|
3903
|
+
chains: components["schemas"]["BybitDepositChain"][];
|
|
3904
|
+
/** @description Coin symbol the deposit addresses are for (e.g. `USDT`). */
|
|
3905
|
+
coin: string;
|
|
3906
|
+
};
|
|
3907
|
+
/**
|
|
3908
|
+
* @description Parameters for [`BybitRpc::QuerySubMembers`].
|
|
3909
|
+
*
|
|
3910
|
+
* Bybit endpoint: `GET /v5/user/query-sub-members`. Takes no inputs beyond
|
|
3911
|
+
* the common envelope.
|
|
3912
|
+
*/
|
|
3913
|
+
BybitQuerySubMembersParams: {
|
|
3914
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3915
|
+
keyId: components["schemas"]["Id"];
|
|
3916
|
+
/**
|
|
3917
|
+
* Format: int32
|
|
3918
|
+
* @description Optional receive window in milliseconds. Defaults to 10000.
|
|
3919
|
+
*/
|
|
3920
|
+
recvWindow?: number | null;
|
|
3921
|
+
};
|
|
3922
|
+
/** @description Response of `GET /v5/user/query-sub-members`. */
|
|
3923
|
+
BybitQuerySubMembersResponse: {
|
|
3924
|
+
/** @description The sub-accounts under the calling master account. */
|
|
3925
|
+
subMembers: components["schemas"]["BybitSubMember"][];
|
|
3926
|
+
};
|
|
3927
|
+
/**
|
|
3928
|
+
* @description Parameters for [`BybitRpc::QueryUser`].
|
|
3929
|
+
*
|
|
3930
|
+
* Bybit endpoint: `GET /v5/user/query-api`. Takes no inputs beyond the common
|
|
3931
|
+
* `recvWindow` / `timestamp` envelope; defined directly (instead of through
|
|
3932
|
+
* the [`BybitParams`] generic alias) so utoipa emits a non-empty schema.
|
|
3933
|
+
*/
|
|
3934
|
+
BybitQueryUserParams: {
|
|
3935
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3936
|
+
keyId: components["schemas"]["Id"];
|
|
3937
|
+
/**
|
|
3938
|
+
* Format: int32
|
|
3939
|
+
* @description Optional receive window in milliseconds. Defaults to 10000.
|
|
3940
|
+
*/
|
|
3941
|
+
recvWindow?: number | null;
|
|
3942
|
+
};
|
|
3943
|
+
/** @description Response of `GET /v5/user/query-api`. */
|
|
3944
|
+
BybitQueryUserResponse: {
|
|
3945
|
+
/** @description Bybit account KYC level (`"0"` = none). */
|
|
3946
|
+
kycLevel?: string | null;
|
|
3947
|
+
/** @description Optional free-text label set on the API key. */
|
|
3948
|
+
note?: string | null;
|
|
3949
|
+
/**
|
|
3950
|
+
* @description Master account UID for sub-accounts, `"0"` if the calling key is a
|
|
3951
|
+
* master account.
|
|
3952
|
+
*/
|
|
3953
|
+
parentUid: string;
|
|
3954
|
+
/** @description API permissions assigned to the key. */
|
|
3955
|
+
permissions?: unknown;
|
|
3956
|
+
/**
|
|
3957
|
+
* Format: int64
|
|
3958
|
+
* @description Bybit-assigned account UID of the API key.
|
|
3959
|
+
*/
|
|
3960
|
+
userID: number;
|
|
3961
|
+
/** @description VIP level. */
|
|
3962
|
+
vipLevel?: string | null;
|
|
3963
|
+
[key: string]: unknown;
|
|
3964
|
+
};
|
|
3965
|
+
/**
|
|
3966
|
+
* @description Bybit-family RPC methods. Each variant authenticates as the
|
|
3967
|
+
* [`KeyType::HmacSha256`] key in its `params.key_id` (which must carry
|
|
3968
|
+
* [`KeyProperties::BybitApi`]).
|
|
3969
|
+
*/
|
|
3970
|
+
BybitRpc:
|
|
3971
|
+
| {
|
|
3972
|
+
/** @enum {string} */
|
|
3973
|
+
method: "cs_bybitQueryUser";
|
|
3974
|
+
params: components["schemas"]["BybitQueryUserParams"];
|
|
3975
|
+
}
|
|
3976
|
+
| {
|
|
3977
|
+
/** @enum {string} */
|
|
3978
|
+
method: "cs_bybitQuerySubMembers";
|
|
3979
|
+
params: components["schemas"]["BybitQuerySubMembersParams"];
|
|
3980
|
+
}
|
|
3981
|
+
| {
|
|
3982
|
+
/** @enum {string} */
|
|
3983
|
+
method: "cs_bybitQueryCoinsBalance";
|
|
3984
|
+
params: components["schemas"]["BybitQueryCoinsBalanceParams"];
|
|
3985
|
+
}
|
|
3986
|
+
| {
|
|
3987
|
+
/** @enum {string} */
|
|
3988
|
+
method: "cs_bybitQueryDepositAddress";
|
|
3989
|
+
params: components["schemas"]["BybitQueryDepositAddressParams"];
|
|
3990
|
+
}
|
|
3991
|
+
| {
|
|
3992
|
+
/** @enum {string} */
|
|
3993
|
+
method: "cs_bybitUniversalTransfer";
|
|
3994
|
+
params: components["schemas"]["BybitUniversalTransferParams"];
|
|
3995
|
+
}
|
|
3996
|
+
| {
|
|
3997
|
+
/** @enum {string} */
|
|
3998
|
+
method: "cs_bybitWithdraw";
|
|
3999
|
+
params: components["schemas"]["BybitWithdrawParams"];
|
|
4000
|
+
}
|
|
4001
|
+
| {
|
|
4002
|
+
/** @enum {string} */
|
|
4003
|
+
method: "cs_bybitWithdrawals";
|
|
4004
|
+
params: components["schemas"]["BybitWithdrawalsParams"];
|
|
4005
|
+
};
|
|
4006
|
+
/** @description Response returned by the typed `bybit_sign` endpoint. */
|
|
4007
|
+
BybitSignResponse: {
|
|
4008
|
+
/** @description Optional policy evaluation tree. */
|
|
4009
|
+
policy_eval_tree?: unknown;
|
|
4010
|
+
} & {
|
|
4011
|
+
/**
|
|
4012
|
+
* @description The Bybit-bound payload (URL-encoded query for GET, JSON body for
|
|
4013
|
+
* POST). Submitted verbatim by the rpc-api lambda; the payload bytes are
|
|
4014
|
+
* also part of the signing input.
|
|
4015
|
+
*/
|
|
4016
|
+
payload: string;
|
|
4017
|
+
/**
|
|
4018
|
+
* Format: int32
|
|
4019
|
+
* @description Effective receive window in milliseconds.
|
|
4020
|
+
*/
|
|
4021
|
+
recv_window: number;
|
|
4022
|
+
/**
|
|
4023
|
+
* @description Hex-encoded HMAC-SHA256 signature of
|
|
4024
|
+
* `timestamp || apiKey || recvWindow || payload`. Goes into the
|
|
4025
|
+
* `X-BAPI-SIGN` header.
|
|
4026
|
+
*/
|
|
4027
|
+
signature_hex: string;
|
|
4028
|
+
/**
|
|
4029
|
+
* Format: int64
|
|
4030
|
+
* @description Signing timestamp (ms since epoch). Picked by the signer.
|
|
4031
|
+
*/
|
|
4032
|
+
timestamp_ms: number;
|
|
4033
|
+
};
|
|
4034
|
+
/** @description One entry in [`BybitQuerySubMembersResponse::sub_members`]. */
|
|
4035
|
+
BybitSubMember: {
|
|
4036
|
+
/**
|
|
4037
|
+
* Format: int32
|
|
4038
|
+
* @description Trading account configuration: `1` Classic, `3` UTA1.0, `4` UTA1.0 Pro,
|
|
4039
|
+
* `5` UTA2.0, `6` UTA2.0 Pro.
|
|
4040
|
+
*/
|
|
4041
|
+
accountMode?: number | null;
|
|
4042
|
+
/**
|
|
4043
|
+
* Format: int32
|
|
4044
|
+
* @description Sub-account category: `1` standard, `6` custodial.
|
|
4045
|
+
*/
|
|
4046
|
+
memberType?: number | null;
|
|
4047
|
+
/** @description Free-text remark associated with the sub-account. */
|
|
4048
|
+
remark?: string | null;
|
|
4049
|
+
/**
|
|
4050
|
+
* Format: int32
|
|
4051
|
+
* @description Account state: `1` active, `2` login-restricted, `4` frozen.
|
|
4052
|
+
*/
|
|
4053
|
+
status?: number | null;
|
|
4054
|
+
/** @description Sub-account UID. */
|
|
4055
|
+
uid: string;
|
|
4056
|
+
/** @description Display name of the sub-account. */
|
|
4057
|
+
username?: string | null;
|
|
4058
|
+
[key: string]: unknown;
|
|
4059
|
+
};
|
|
4060
|
+
/**
|
|
4061
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
4062
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
4063
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
4064
|
+
* directly below.)
|
|
4065
|
+
*/
|
|
4066
|
+
BybitUniversalTransferParams: components["schemas"]["BybitUniversalTransferRequest"] & {
|
|
4067
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
4068
|
+
keyId: components["schemas"]["Id"];
|
|
4069
|
+
/**
|
|
4070
|
+
* Format: int32
|
|
4071
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
4072
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
4073
|
+
*/
|
|
4074
|
+
recvWindow?: number | null;
|
|
4075
|
+
};
|
|
4076
|
+
/** @description Parameters for `POST /v5/asset/transfer/universal-transfer`. */
|
|
4077
|
+
BybitUniversalTransferRequest: {
|
|
4078
|
+
/** @description Amount as a decimal string (e.g. `"1.5"`). Sent verbatim. */
|
|
4079
|
+
amount: string;
|
|
4080
|
+
/** @description Coin symbol (e.g. `"USDT"`). */
|
|
4081
|
+
coin: string;
|
|
4082
|
+
/**
|
|
4083
|
+
* @description Source wallet type. Defaults to `"FUND"` if omitted; the signer
|
|
4084
|
+
* substitutes the default before signing so the signed and submitted
|
|
4085
|
+
* payloads match.
|
|
4086
|
+
*/
|
|
4087
|
+
fromAccountType?: string | null;
|
|
4088
|
+
/**
|
|
4089
|
+
* Format: int64
|
|
4090
|
+
* @description Source account UID. For "self", the manager substitutes the caller's
|
|
4091
|
+
* own UID before this struct reaches the signer.
|
|
4092
|
+
*/
|
|
4093
|
+
fromMemberId: number;
|
|
4094
|
+
/** @description Destination wallet type. Defaults to `"FUND"` if omitted. */
|
|
4095
|
+
toAccountType?: string | null;
|
|
4096
|
+
/**
|
|
4097
|
+
* Format: int64
|
|
4098
|
+
* @description Destination account UID.
|
|
4099
|
+
*/
|
|
4100
|
+
toMemberId: number;
|
|
4101
|
+
/**
|
|
4102
|
+
* @description Client-supplied transfer id (UUID). Bybit echoes it back as the
|
|
4103
|
+
* canonical reference for this transfer.
|
|
4104
|
+
*/
|
|
4105
|
+
transferId: string;
|
|
4106
|
+
};
|
|
4107
|
+
/** @description Response of `POST /v5/asset/transfer/universal-transfer`. */
|
|
4108
|
+
BybitUniversalTransferResponse: {
|
|
4109
|
+
/**
|
|
4110
|
+
* @description Transfer state: one of `SUCCESS`, `PENDING`, `FAILED`, or
|
|
4111
|
+
* `STATUS_UNKNOWN`.
|
|
4112
|
+
*/
|
|
4113
|
+
status?: string | null;
|
|
4114
|
+
/**
|
|
4115
|
+
* @description UUID Bybit assigned to the transfer; the caller-supplied `transferId`
|
|
4116
|
+
* echoed back.
|
|
4117
|
+
*/
|
|
4118
|
+
transferId: string;
|
|
4119
|
+
};
|
|
4120
|
+
/** @description One entry in [`BybitWithdrawalsResponse::rows`]. */
|
|
4121
|
+
BybitWithdrawEntry: {
|
|
4122
|
+
/** @description Withdrawal amount as a decimal string. */
|
|
4123
|
+
amount: string;
|
|
4124
|
+
/** @description Short chain code (e.g. `ETH`, `TRX`). */
|
|
4125
|
+
chain: string;
|
|
4126
|
+
/** @description Coin symbol, uppercase (e.g. `USDT`). */
|
|
4127
|
+
coin: string;
|
|
4128
|
+
/** @description Creation timestamp, in milliseconds since epoch (as a string). */
|
|
4129
|
+
createTime: string;
|
|
4130
|
+
/**
|
|
4131
|
+
* @description Withdrawal state, e.g. `success`, `pending`, `failed`, `cancelled`. See
|
|
4132
|
+
* the Bybit docs for the full set, which depends on `withdraw_type`.
|
|
4133
|
+
*/
|
|
4134
|
+
status: string;
|
|
4135
|
+
/** @description Memo / tag for chains that use one (e.g. XRP, EOS). */
|
|
4136
|
+
tag?: string | null;
|
|
4137
|
+
/** @description Destination: an on-chain address, or a Bybit UID for internal transfers. */
|
|
4138
|
+
toAddress: string;
|
|
4139
|
+
/**
|
|
4140
|
+
* @description On-chain transaction hash; empty for failed/cancelled withdrawals and
|
|
4141
|
+
* for in-flight on-chain withdrawals before broadcast.
|
|
4142
|
+
*/
|
|
4143
|
+
txId?: string | null;
|
|
4144
|
+
/** @description Timestamp of the most recent status change, in milliseconds since epoch. */
|
|
4145
|
+
updateTime: string;
|
|
4146
|
+
/** @description Network / processing fee charged for the withdrawal, as a decimal string. */
|
|
4147
|
+
withdrawFee: string;
|
|
4148
|
+
/** @description Bybit-assigned withdrawal id. */
|
|
4149
|
+
withdrawId: string;
|
|
4150
|
+
/**
|
|
4151
|
+
* Format: int32
|
|
4152
|
+
* @description Withdrawal classification: `0` on-chain, `1` off-chain (internal).
|
|
4153
|
+
*/
|
|
4154
|
+
withdrawType?: number | null;
|
|
4155
|
+
[key: string]: unknown;
|
|
4156
|
+
};
|
|
4157
|
+
/**
|
|
4158
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
4159
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
4160
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
4161
|
+
* directly below.)
|
|
4162
|
+
*/
|
|
4163
|
+
BybitWithdrawParams: components["schemas"]["BybitWithdrawRequest"] & {
|
|
4164
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
4165
|
+
keyId: components["schemas"]["Id"];
|
|
4166
|
+
/**
|
|
4167
|
+
* Format: int32
|
|
4168
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
4169
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
4170
|
+
*/
|
|
4171
|
+
recvWindow?: number | null;
|
|
4172
|
+
};
|
|
4173
|
+
/** @description Parameters for `POST /v5/asset/withdraw/create`. Master-only. */
|
|
4174
|
+
BybitWithdrawRequest: {
|
|
4175
|
+
/**
|
|
4176
|
+
* @description Source wallet (`"FUND"` or `"SPOT"`). Defaults to Bybit's account-level
|
|
4177
|
+
* default when omitted.
|
|
4178
|
+
*/
|
|
4179
|
+
accountType?: string | null;
|
|
4180
|
+
/** @description Destination address. Must already be in Bybit's address book. */
|
|
4181
|
+
address: string;
|
|
4182
|
+
/** @description Amount as a decimal string. Sent verbatim. */
|
|
4183
|
+
amount: string;
|
|
4184
|
+
/** @description Network identifier (e.g. `"ETH"`, `"TRX"`). Required by Bybit. */
|
|
4185
|
+
chain: string;
|
|
4186
|
+
/** @description Coin symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
4187
|
+
coin: string;
|
|
4188
|
+
/**
|
|
4189
|
+
* Format: int32
|
|
4190
|
+
* @description Force-chain flag: `0` (default), `1`, or `2`. See Bybit docs.
|
|
4191
|
+
*/
|
|
4192
|
+
forceChain?: number | null;
|
|
4193
|
+
/** @description Client-supplied request id (UUID). Used by Bybit for idempotency. */
|
|
4194
|
+
requestId: string;
|
|
4195
|
+
/** @description Optional memo / tag (e.g. for XRP, XLM). */
|
|
4196
|
+
tag?: string | null;
|
|
4197
|
+
/**
|
|
4198
|
+
* Format: int64
|
|
4199
|
+
* @description Server-supplied timestamp (ms since epoch). Set by the signer just before
|
|
4200
|
+
* signing; clients leave this `None` (because the server will ignore it anyway).
|
|
4201
|
+
*/
|
|
4202
|
+
timestamp?: number | null;
|
|
4203
|
+
};
|
|
4204
|
+
/** @description Response of `POST /v5/asset/withdraw/create`. */
|
|
4205
|
+
BybitWithdrawResponse: {
|
|
4206
|
+
/** @description Bybit-assigned withdrawal id. */
|
|
4207
|
+
id: string;
|
|
4208
|
+
};
|
|
4209
|
+
/**
|
|
4210
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
4211
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
4212
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
4213
|
+
* directly below.)
|
|
4214
|
+
*/
|
|
4215
|
+
BybitWithdrawalsParams: components["schemas"]["BybitWithdrawalsRequest"] & {
|
|
4216
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
4217
|
+
keyId: components["schemas"]["Id"];
|
|
4218
|
+
/**
|
|
4219
|
+
* Format: int32
|
|
4220
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
4221
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
4222
|
+
*/
|
|
4223
|
+
recvWindow?: number | null;
|
|
4224
|
+
};
|
|
4225
|
+
/** @description Parameters for `GET /v5/asset/withdraw/query-record`. */
|
|
4226
|
+
BybitWithdrawalsRequest: {
|
|
4227
|
+
/** @description Filter by coin symbol. */
|
|
4228
|
+
coin?: string | null;
|
|
4229
|
+
/**
|
|
4230
|
+
* Format: int32
|
|
4231
|
+
* @description Page size.
|
|
4232
|
+
*/
|
|
4233
|
+
limit?: number | null;
|
|
4234
|
+
/**
|
|
4235
|
+
* @description Filter by Bybit-assigned withdrawal id (the `id` returned by
|
|
4236
|
+
* [`BybitRpc::Withdraw`]).
|
|
4237
|
+
*/
|
|
4238
|
+
withdrawID?: string | null;
|
|
4239
|
+
};
|
|
4240
|
+
/** @description Response of `GET /v5/asset/withdraw/query-record`. */
|
|
4241
|
+
BybitWithdrawalsResponse: {
|
|
4242
|
+
/**
|
|
4243
|
+
* @description Opaque cursor to pass back as `cursor` on the next request to fetch
|
|
4244
|
+
* the next page; absent on the last page.
|
|
4245
|
+
*/
|
|
4246
|
+
nextPageCursor?: string | null;
|
|
4247
|
+
/** @description Withdrawal records matching the query. */
|
|
4248
|
+
rows: components["schemas"]["BybitWithdrawEntry"][];
|
|
4249
|
+
};
|
|
3757
4250
|
CancelInvitationRequest: {
|
|
3758
4251
|
email: components["schemas"]["Email"];
|
|
3759
4252
|
};
|
|
@@ -4565,7 +5058,7 @@ export interface components {
|
|
|
4565
5058
|
DepositResponse: {
|
|
4566
5059
|
/** @description Deposit address. */
|
|
4567
5060
|
address: string;
|
|
4568
|
-
/** @description Asset symbol (echoes
|
|
5061
|
+
/** @description Asset symbol (echoes the request's `coin` field). */
|
|
4569
5062
|
coin: string;
|
|
4570
5063
|
/**
|
|
4571
5064
|
* @description Secondary address identifier required by some assets (e.g. memo for
|
|
@@ -5426,6 +5919,14 @@ export interface components {
|
|
|
5426
5919
|
| "sign:binance:deposit"
|
|
5427
5920
|
| "sign:binance:listSubAccounts"
|
|
5428
5921
|
| "sign:binance:coinInfo"
|
|
5922
|
+
| "sign:bybit:*"
|
|
5923
|
+
| "sign:bybit:queryUser"
|
|
5924
|
+
| "sign:bybit:querySubMembers"
|
|
5925
|
+
| "sign:bybit:queryCoinsBalance"
|
|
5926
|
+
| "sign:bybit:queryDepositAddress"
|
|
5927
|
+
| "sign:bybit:universalTransfer"
|
|
5928
|
+
| "sign:bybit:withdraw"
|
|
5929
|
+
| "sign:bybit:withdrawals"
|
|
5429
5930
|
| "sign:coinbase:*"
|
|
5430
5931
|
| "sign:coinbase:accounts:list"
|
|
5431
5932
|
| "sign:coinbase:portfolios:list"
|
|
@@ -5663,6 +6164,7 @@ export interface components {
|
|
|
5663
6164
|
| "rpc:getTransaction"
|
|
5664
6165
|
| "rpc:listTransactions"
|
|
5665
6166
|
| "rpc:binance"
|
|
6167
|
+
| "rpc:bybit"
|
|
5666
6168
|
| "rpc:coinbase";
|
|
5667
6169
|
/**
|
|
5668
6170
|
* @description This type specifies the interpretation of the `fee` field in Babylon
|
|
@@ -6361,6 +6863,13 @@ export interface components {
|
|
|
6361
6863
|
| components["schemas"]["DepositResponse"]
|
|
6362
6864
|
| components["schemas"]["ListSubAccountsResponse"]
|
|
6363
6865
|
| components["schemas"]["CoinInfoResponse"]
|
|
6866
|
+
| components["schemas"]["BybitQueryUserResponse"]
|
|
6867
|
+
| components["schemas"]["BybitQuerySubMembersResponse"]
|
|
6868
|
+
| components["schemas"]["BybitQueryCoinsBalanceResponse"]
|
|
6869
|
+
| components["schemas"]["BybitQueryDepositAddressResponse"]
|
|
6870
|
+
| components["schemas"]["BybitUniversalTransferResponse"]
|
|
6871
|
+
| components["schemas"]["BybitWithdrawResponse"]
|
|
6872
|
+
| components["schemas"]["BybitWithdrawalsResponse"]
|
|
6364
6873
|
| components["schemas"]["CoinbaseListAccountsResponse"]
|
|
6365
6874
|
| components["schemas"]["CoinbaseListPortfoliosResponse"]
|
|
6366
6875
|
| components["schemas"]["CoinbaseMoveFundsResponse"];
|
|
@@ -6512,6 +7021,10 @@ export interface components {
|
|
|
6512
7021
|
/** @enum {string} */
|
|
6513
7022
|
kind: "CoinbaseApi";
|
|
6514
7023
|
},
|
|
7024
|
+
components["schemas"]["BybitApiPropertiesPatch"] & {
|
|
7025
|
+
/** @enum {string} */
|
|
7026
|
+
kind: "BybitApi";
|
|
7027
|
+
},
|
|
6515
7028
|
]
|
|
6516
7029
|
>;
|
|
6517
7030
|
/** @enum {string} */
|
|
@@ -6558,7 +7071,8 @@ export interface components {
|
|
|
6558
7071
|
| "SecpLtcTest"
|
|
6559
7072
|
| "SecpXrpAddr"
|
|
6560
7073
|
| "Ed25519XrpAddr"
|
|
6561
|
-
| "BabyJubjub"
|
|
7074
|
+
| "BabyJubjub"
|
|
7075
|
+
| "HmacSha256";
|
|
6562
7076
|
KeyTypeAndDerivationPath: {
|
|
6563
7077
|
/**
|
|
6564
7078
|
* @description List of derivation paths for which to derive.
|
|
@@ -7066,11 +7580,31 @@ export interface components {
|
|
|
7066
7580
|
| "BabylonCovSign"
|
|
7067
7581
|
| "BabylonRegistration"
|
|
7068
7582
|
| "BabylonStaking"
|
|
7069
|
-
| "
|
|
7583
|
+
| "BinanceSubToMaster"
|
|
7584
|
+
| "BinanceSubToSub"
|
|
7585
|
+
| "BinanceUniversalTransfer"
|
|
7586
|
+
| "BinanceSubAccountAssets"
|
|
7587
|
+
| "BinanceAccountInfo"
|
|
7588
|
+
| "BinanceSubAccountTransferHistory"
|
|
7589
|
+
| "BinanceUniversalTransferHistory"
|
|
7590
|
+
| "BinanceWithdraw"
|
|
7591
|
+
| "BinanceWithdrawHistory"
|
|
7592
|
+
| "BinanceDeposit"
|
|
7593
|
+
| "BinanceListSubAccounts"
|
|
7594
|
+
| "BinanceCoinInfo"
|
|
7070
7595
|
| "BlobSign"
|
|
7071
7596
|
| "BtcMessageSign"
|
|
7072
7597
|
| "BtcSign"
|
|
7073
|
-
| "
|
|
7598
|
+
| "BybitQueryUser"
|
|
7599
|
+
| "BybitQuerySubMembers"
|
|
7600
|
+
| "BybitQueryCoinsBalance"
|
|
7601
|
+
| "BybitQueryDepositAddress"
|
|
7602
|
+
| "BybitUniversalTransfer"
|
|
7603
|
+
| "BybitWithdraw"
|
|
7604
|
+
| "BybitWithdrawals"
|
|
7605
|
+
| "CoinbaseListAccounts"
|
|
7606
|
+
| "CoinbaseListPortfolios"
|
|
7607
|
+
| "CoinbaseMoveFunds"
|
|
7074
7608
|
| "DiffieHellman"
|
|
7075
7609
|
| "PsbtSign"
|
|
7076
7610
|
| "TaprootSign"
|
|
@@ -8880,11 +9414,12 @@ export interface components {
|
|
|
8880
9414
|
* Top-level dispatch. Wire format is preserved by `#[serde(untagged)]`: each
|
|
8881
9415
|
* inbound request is matched against one of the internally-tagged inner enums
|
|
8882
9416
|
* ([`CsRpc`] for the core methods, [`BinanceRpc`] for the Binance family,
|
|
8883
|
-
* [`CoinbaseRpc`] for the Coinbase family).
|
|
9417
|
+
* [`BybitRpc`] for the Bybit family, [`CoinbaseRpc`] for the Coinbase family).
|
|
8884
9418
|
*/
|
|
8885
9419
|
RpcMethod:
|
|
8886
9420
|
| components["schemas"]["CsRpc"]
|
|
8887
9421
|
| components["schemas"]["BinanceRpc"]
|
|
9422
|
+
| components["schemas"]["BybitRpc"]
|
|
8888
9423
|
| components["schemas"]["CoinbaseRpc"];
|
|
8889
9424
|
/** @description All scopes for accessing CubeSigner APIs */
|
|
8890
9425
|
Scope: components["schemas"]["ExplicitScope"] | string;
|
|
@@ -9957,8 +10492,8 @@ export interface components {
|
|
|
9957
10492
|
asset: string;
|
|
9958
10493
|
/**
|
|
9959
10494
|
* @description Optional client-supplied transfer id. If set, Binance echoes it back
|
|
9960
|
-
* on
|
|
9961
|
-
* as a filter on
|
|
10495
|
+
* as `client_tran_id` on the `UniversalTransferResponse` and lets it be
|
|
10496
|
+
* used as a filter on
|
|
9962
10497
|
* [`UniversalTransferHistoryRequest::client_tran_id`].
|
|
9963
10498
|
*/
|
|
9964
10499
|
clientTranId?: string | null;
|
|
@@ -10833,7 +11368,7 @@ export interface components {
|
|
|
10833
11368
|
endTime?: number | null;
|
|
10834
11369
|
/**
|
|
10835
11370
|
* @description Comma-separated list of Binance-assigned withdrawal ids (the `id`
|
|
10836
|
-
* field of
|
|
11371
|
+
* field of `WithdrawResponse`). Up to 45 ids per query, per Binance.
|
|
10837
11372
|
*/
|
|
10838
11373
|
idList?: string | null;
|
|
10839
11374
|
/**
|
|
@@ -11100,6 +11635,38 @@ export interface components {
|
|
|
11100
11635
|
};
|
|
11101
11636
|
};
|
|
11102
11637
|
};
|
|
11638
|
+
/** @description Response returned by the typed `bybit_sign` endpoint. */
|
|
11639
|
+
BybitSignResponse: {
|
|
11640
|
+
content: {
|
|
11641
|
+
"application/json": {
|
|
11642
|
+
/** @description Optional policy evaluation tree. */
|
|
11643
|
+
policy_eval_tree?: unknown;
|
|
11644
|
+
} & {
|
|
11645
|
+
/**
|
|
11646
|
+
* @description The Bybit-bound payload (URL-encoded query for GET, JSON body for
|
|
11647
|
+
* POST). Submitted verbatim by the rpc-api lambda; the payload bytes are
|
|
11648
|
+
* also part of the signing input.
|
|
11649
|
+
*/
|
|
11650
|
+
payload: string;
|
|
11651
|
+
/**
|
|
11652
|
+
* Format: int32
|
|
11653
|
+
* @description Effective receive window in milliseconds.
|
|
11654
|
+
*/
|
|
11655
|
+
recv_window: number;
|
|
11656
|
+
/**
|
|
11657
|
+
* @description Hex-encoded HMAC-SHA256 signature of
|
|
11658
|
+
* `timestamp || apiKey || recvWindow || payload`. Goes into the
|
|
11659
|
+
* `X-BAPI-SIGN` header.
|
|
11660
|
+
*/
|
|
11661
|
+
signature_hex: string;
|
|
11662
|
+
/**
|
|
11663
|
+
* Format: int64
|
|
11664
|
+
* @description Signing timestamp (ms since epoch). Picked by the signer.
|
|
11665
|
+
*/
|
|
11666
|
+
timestamp_ms: number;
|
|
11667
|
+
};
|
|
11668
|
+
};
|
|
11669
|
+
};
|
|
11103
11670
|
/** @description Response returned by the typed `coinbase_sign` endpoint. */
|
|
11104
11671
|
CoinbaseSignResponse: {
|
|
11105
11672
|
content: {
|
|
@@ -12928,6 +13495,11 @@ export interface operations {
|
|
|
12928
13495
|
};
|
|
12929
13496
|
responses: {
|
|
12930
13497
|
200: components["responses"]["UpdateOrgResponse"];
|
|
13498
|
+
202: {
|
|
13499
|
+
content: {
|
|
13500
|
+
"application/json": components["schemas"]["AcceptedResponse"];
|
|
13501
|
+
};
|
|
13502
|
+
};
|
|
12931
13503
|
default: {
|
|
12932
13504
|
content: {
|
|
12933
13505
|
"application/json": components["schemas"]["ErrorResponse"];
|