@cubist-labs/cubesigner-sdk 0.4.241 → 0.4.244
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 +4 -4
- package/dist/src/audit_log.js +1 -1
- package/dist/src/client/api_client.d.ts +9 -1
- package/dist/src/client/api_client.d.ts.map +1 -1
- package/dist/src/client/api_client.js +21 -1
- package/dist/src/client/base_client.js +2 -2
- 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 +17 -1
- package/dist/src/response.d.ts +27 -3
- package/dist/src/response.d.ts.map +1 -1
- package/dist/src/response.js +60 -19
- package/dist/src/schema.d.ts +819 -81
- 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 +1 -1
- package/dist/src/scopes.d.ts.map +1 -1
- package/dist/src/scopes.js +20 -3
- package/package.json +1 -1
- package/src/audit_log.ts +3 -5
- package/src/client/api_client.ts +28 -0
- package/src/client/base_client.ts +1 -1
- package/src/fetch.ts +1 -2
- package/src/key.ts +24 -0
- package/src/response.ts +67 -17
- package/src/schema.ts +879 -90
- package/src/schema_types.ts +11 -1
- package/src/scopes.ts +19 -2
package/dist/src/schema.d.ts
CHANGED
|
@@ -1745,34 +1745,97 @@ export type webhooks = Record<string, never>;
|
|
|
1745
1745
|
export interface components {
|
|
1746
1746
|
schemas: {
|
|
1747
1747
|
AcceptedResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
|
|
1748
|
+
/** @description Different responses we return for success status codes. */
|
|
1749
|
+
AcceptedValue: OneOf<[
|
|
1750
|
+
{
|
|
1751
|
+
SignDryRun: components["schemas"]["SignDryRunArgs"];
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
BinanceDryRun: components["schemas"]["BinanceDryRunArgs"];
|
|
1755
|
+
},
|
|
1756
|
+
{
|
|
1757
|
+
MfaRequired: components["schemas"]["MfaRequiredArgs"];
|
|
1758
|
+
}
|
|
1759
|
+
]>;
|
|
1760
|
+
/** @enum {string} */
|
|
1761
|
+
AcceptedValueCode: "SignDryRun" | "BinanceDryRun" | "MfaRequired";
|
|
1748
1762
|
/**
|
|
1749
|
-
* @description
|
|
1763
|
+
* @description Determines who controls the keys within an org
|
|
1764
|
+
* @enum {string}
|
|
1765
|
+
*/
|
|
1766
|
+
AccessModel: "User" | "Org";
|
|
1767
|
+
/**
|
|
1768
|
+
* @description One asset balance entry in [`AccountInfoResponse::balances`]. Distinct from
|
|
1769
|
+
* [`SubAccountAsset`] because the spot-account schema lacks the `freeze` and
|
|
1770
|
+
* `withdrawing` fields.
|
|
1771
|
+
*/
|
|
1772
|
+
AccountBalance: {
|
|
1773
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
1774
|
+
asset: string;
|
|
1775
|
+
/** @description Available balance. */
|
|
1776
|
+
free: string;
|
|
1777
|
+
/** @description Balance locked in open orders. */
|
|
1778
|
+
locked: string;
|
|
1779
|
+
};
|
|
1780
|
+
/**
|
|
1781
|
+
* @description Parameters for `GET /api/v3/account`.
|
|
1750
1782
|
*
|
|
1751
|
-
*
|
|
1752
|
-
*
|
|
1753
|
-
* return `Result<T, SignerError>` where `T` is the type of the
|
|
1754
|
-
* response for the status code "200 Ok".
|
|
1783
|
+
* Returns Spot account info for whichever account the signing key
|
|
1784
|
+
* authenticates as (master or sub).
|
|
1755
1785
|
*/
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1786
|
+
AccountInfoRequest: {
|
|
1787
|
+
/**
|
|
1788
|
+
* @description If `true`, the response omits assets with all-zero balances. Defaults to
|
|
1789
|
+
* `false` (Binance's default).
|
|
1790
|
+
*/
|
|
1791
|
+
omitZeroBalances?: boolean | null;
|
|
1792
|
+
};
|
|
1793
|
+
/** @description Response for [`BinanceManager::account_info`]. */
|
|
1794
|
+
AccountInfoResponse: {
|
|
1795
|
+
/** @description Account type, e.g. `"SPOT"`. Left as `String` for forward compatibility. */
|
|
1796
|
+
accountType: string;
|
|
1797
|
+
/** @description One entry per asset. Affected by the `omit_zero_balances` request flag. */
|
|
1798
|
+
balances: components["schemas"]["AccountBalance"][];
|
|
1799
|
+
brokered: boolean;
|
|
1800
|
+
/** Format: int64 */
|
|
1801
|
+
buyerCommission: number;
|
|
1802
|
+
canDeposit: boolean;
|
|
1803
|
+
canTrade: boolean;
|
|
1804
|
+
canWithdraw: boolean;
|
|
1805
|
+
commissionRates: components["schemas"]["CommissionRates"];
|
|
1806
|
+
/**
|
|
1807
|
+
* Format: int64
|
|
1808
|
+
* @description Maker commission, in basis points (e.g. `10` = 0.1%). Superseded by
|
|
1809
|
+
* [`AccountInfoResponse::commission_rates`] for fractional rates.
|
|
1810
|
+
*/
|
|
1811
|
+
makerCommission: number;
|
|
1812
|
+
/** @description Permission flags, e.g. `["SPOT", "MARGIN"]`. */
|
|
1813
|
+
permissions: string[];
|
|
1814
|
+
preventSor: boolean;
|
|
1815
|
+
requireSelfTradePrevention: boolean;
|
|
1816
|
+
/** Format: int64 */
|
|
1817
|
+
sellerCommission: number;
|
|
1818
|
+
/** Format: int64 */
|
|
1819
|
+
takerCommission: number;
|
|
1820
|
+
/**
|
|
1821
|
+
* Format: int64
|
|
1822
|
+
* @description Account user id.
|
|
1823
|
+
*/
|
|
1824
|
+
uid: number;
|
|
1825
|
+
/**
|
|
1826
|
+
* Format: int64
|
|
1827
|
+
* @description Last account update time (ms since epoch).
|
|
1828
|
+
*/
|
|
1829
|
+
updateTime: number;
|
|
1768
1830
|
};
|
|
1769
|
-
/** @enum {string} */
|
|
1770
|
-
AcceptedValueCode: "MfaRequired";
|
|
1771
1831
|
/**
|
|
1772
|
-
* @description
|
|
1832
|
+
* @description Wallet type used as the source or destination of a [`UniversalTransferRequest`].
|
|
1833
|
+
*
|
|
1834
|
+
* Serializes to the SCREAMING_SNAKE_CASE strings Binance expects. The default
|
|
1835
|
+
* is [`AccountType::Spot`].
|
|
1773
1836
|
* @enum {string}
|
|
1774
1837
|
*/
|
|
1775
|
-
|
|
1838
|
+
AccountType: "SPOT" | "USDT_FUTURE" | "COIN_FUTURE" | "MARGIN";
|
|
1776
1839
|
/** @description Request to add OIDC identity to an existing user account */
|
|
1777
1840
|
AddIdentityRequest: {
|
|
1778
1841
|
oidc_token: string;
|
|
@@ -2069,6 +2132,8 @@ export interface components {
|
|
|
2069
2132
|
AuthenticatorTransport: "usb" | "nfc" | "ble" | "internal";
|
|
2070
2133
|
/** @description Request to sign a serialized Avalanche transaction */
|
|
2071
2134
|
AvaSerializedTxSignRequest: {
|
|
2135
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2136
|
+
dry_run?: boolean;
|
|
2072
2137
|
/**
|
|
2073
2138
|
* @description Request additional information to be included in the response, explaining
|
|
2074
2139
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2091,6 +2156,8 @@ export interface components {
|
|
|
2091
2156
|
};
|
|
2092
2157
|
/** @description Request to sign an Avalanche transaction */
|
|
2093
2158
|
AvaSignRequest: {
|
|
2159
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2160
|
+
dry_run?: boolean;
|
|
2094
2161
|
/**
|
|
2095
2162
|
* @description Request additional information to be included in the response, explaining
|
|
2096
2163
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2128,6 +2195,8 @@ export interface components {
|
|
|
2128
2195
|
/** @description Wrapper around a zeroizing 32-byte fixed-size array */
|
|
2129
2196
|
B32: string;
|
|
2130
2197
|
BabylonCovSignRequest: {
|
|
2198
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2199
|
+
dry_run?: boolean;
|
|
2131
2200
|
/**
|
|
2132
2201
|
* @description Request additional information to be included in the response, explaining
|
|
2133
2202
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2321,6 +2390,8 @@ export interface components {
|
|
|
2321
2390
|
*/
|
|
2322
2391
|
value: number;
|
|
2323
2392
|
}) & {
|
|
2393
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2394
|
+
dry_run?: boolean;
|
|
2324
2395
|
/**
|
|
2325
2396
|
* @description Request additional information to be included in the response, explaining
|
|
2326
2397
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2700,7 +2771,7 @@ export interface components {
|
|
|
2700
2771
|
/** @enum {string} */
|
|
2701
2772
|
BadGatewayErrorCode: "Generic" | "CustomChainRpcError" | "EsploraApiError" | "SentryApiError" | "CallWebhookError" | "OAuthProviderError" | "OidcDisoveryFailed" | "OidcIssuerJwkEndpointUnavailable" | "SmtpServerUnavailable";
|
|
2702
2773
|
/** @enum {string} */
|
|
2703
|
-
BadRequestErrorCode: "GenericBadRequest" | "DisallowedAllowRuleReference" | "InvalidPaginationToken" | "InvalidEmail" | "InvalidEmailTemplate" | "QueryMetricsError" | "InvalidTelegramData" | "ValidationError" | "WebhookPolicyTimeoutOutOfBounds" | "WebhookPolicyDisallowedUrlScheme" | "WebhookPolicyDisallowedUrlHost" | "WebhookPolicyDisallowedHeaders" | "ReservedName" | "UserEmailNotConfigured" | "EmailPasswordNotFound" | "PasswordAuthNotAllowedByInvitation" | "OneTimeCodeExpired" | "InvalidBody" | "InvalidJwt" | "InvitationNoLongerValid" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyGracePeriodTooLong" | "InvalidBabylonStakingPolicyParams" | "InvalidSuiTxReceiversEmptyAllowlist" | "InvalidBtcTxReceiversEmptyAllowlist" | "InvalidRequireRoleSessionAllowlist" | "InvalidCreateKeyCount" | "InvalidDiffieHellmanCount" | "OrgInviteExistingUser" | "OrgUserAlreadyExists" | "OrgNameTaken" | "KwkNotFoundInRegion" | "OrgIsNotOrgExport" | "RoleNameTaken" | "PolicyNameTaken" | "NameTaken" | "ContactNameInvalid" | "ContactAddressesInvalid" | "ContactLabelInvalid" | "ContactModified" | "PolicyNotFound" | "PolicyVersionNotFound" | "PolicyRuleDisallowedByType" | "PolicyTypeDisallowed" | "PolicyDuplicateError" | "PolicyStillAttached" | "PolicyModified" | "PolicyNotAttached" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidTimeLockAlreadyInThePast" | "InvalidRestrictedScopes" | "InvalidUpdate" | "InvalidMetadataLength" | "InvalidLength" | "InvalidKeyMaterialId" | "KeyNotFound" | "SiweChallengeNotFound" | "SiweInvalidRequest" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "NistP256PublicKeyInvalid" | "UnableToAccessSmtpRelay" | "UserExportInProgress" | "RoleNotFound" | "InvalidRoleNameOrId" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidSs58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidUpdateOrgRequestDisallowedMfaType" | "InvalidUpdateOrgRequestEmptyAllowedMfaTypes" | "EmailOtpDelayTooShortForRegisterMfa" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidDiffieHellmanRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "OnlySpecifyOne" | "NoOidcDataInProof" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "IdpUserAlreadyExists" | "CognitoUserAlreadyOrgMember" | "UserNotFound" | "UserWithEmailNotFound" | "PolicyKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "LimitWindowTooLong" | "Erc20ContractDisallowed" | "EmptyRuleError" | "OptionalListEmpty" | "MultipleExclusiveFieldsProvided" | "DuplicateFieldEntry" | "InvalidRange" | "InvalidOrgPolicyRepeatedRule" | "InvalidSuiTransaction" | "SuiSenderMismatch" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcTaprootHashError" | "BtcSignError" | "TaprootSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "InvalidMemberRoleInRecipientAdd" | "ThirdPartyUserAlreadyExists" | "OidcIdentityAlreadyExists" | "UserAlreadyHasIdentity" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "DeleteUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "InvalidOidcIdentity" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter" | "InvalidTapNodeHash" | "InvalidOneTimeCode" | "MessageNotFound" | "MessageAlreadySigned" | "MessageRejected" | "MessageReplaced" | "InvalidMessageType" | "EmptyAddress" | "InvalidEth2SigningPolicySlotRange" | "InvalidEth2SigningPolicyEpochRange" | "InvalidEth2SigningPolicyTimestampRange" | "InvalidEth2SigningPolicyOverlappingRule" | "RpcUrlMissing" | "MmiChainIdMissing" | "EthersInvalidRpcUrl" | "EthersGetTransactionCountError" | "InvalidPassword" | "BabylonStakingFeePlusDustOverflow" | "BabylonStaking" | "BabylonStakingIncorrectKey" | "BabylonStakingSegwitNonDeposit" | "BabylonStakingRegistrationRequiresTaproot" | "PsbtSigning" | "TooManyResets" | "TooManyRequests" | "TooManyFailedLogins" | "BadBtcMessageSignP2shFlag" | "InvalidTendermintRequest" | "PolicyVersionMaxReached" | "PolicyVersionInvalid" | "PolicySecretLimitReached" | "PolicySecretTooLarge" | "InvalidImportKey" | "AlienOwnerInvalid" | "EmptyUpdateRequest" | "InvalidPolicyReference" | "PolicyEngineDisabled" | "InvalidWasmPolicy" | "InvalidPolicy" | "RedundantDerivationPath" | "ImportKeyMissing" | "InvalidAbiMethods" | "BabylonCovSign" | "InvalidPolicyLogsRequest" | "UserProfileMigrationMultipleEntries" | "UserProfileMigrationTooManyItems" | "InputTooShort" | "InvalidTweakLength" | "InvalidCustomChains" | "InvalidRpcRequest";
|
|
2774
|
+
BadRequestErrorCode: "GenericBadRequest" | "DisallowedAllowRuleReference" | "InvalidPaginationToken" | "InvalidEmail" | "InvalidEmailTemplate" | "QueryMetricsError" | "InvalidTelegramData" | "ValidationError" | "WebhookPolicyTimeoutOutOfBounds" | "WebhookPolicyDisallowedUrlScheme" | "WebhookPolicyDisallowedUrlHost" | "WebhookPolicyDisallowedHeaders" | "ReservedName" | "UserEmailNotConfigured" | "EmailPasswordNotFound" | "PasswordAuthNotAllowedByInvitation" | "OneTimeCodeExpired" | "InvalidBody" | "InvalidJwt" | "InvitationNoLongerValid" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyGracePeriodTooLong" | "InvalidBabylonStakingPolicyParams" | "InvalidSuiTxReceiversEmptyAllowlist" | "InvalidBtcTxReceiversEmptyAllowlist" | "InvalidRequireRoleSessionAllowlist" | "InvalidCreateKeyCount" | "InvalidDiffieHellmanCount" | "OrgInviteExistingUser" | "OrgUserAlreadyExists" | "OrgNameTaken" | "KwkNotFoundInRegion" | "OrgIsNotOrgExport" | "RoleNameTaken" | "PolicyNameTaken" | "NameTaken" | "ContactNameInvalid" | "ContactAddressesInvalid" | "ContactLabelInvalid" | "ContactModified" | "PolicyNotFound" | "PolicyVersionNotFound" | "PolicyRuleDisallowedByType" | "PolicyTypeDisallowed" | "PolicyDuplicateError" | "PolicyStillAttached" | "PolicyModified" | "PolicyNotAttached" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidTimeLockAlreadyInThePast" | "InvalidRestrictedScopes" | "InvalidUpdate" | "InvalidMetadataLength" | "InvalidLength" | "InvalidKeyMaterialId" | "KeyNotFound" | "SiweChallengeNotFound" | "SiweInvalidRequest" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "NistP256PublicKeyInvalid" | "UnableToAccessSmtpRelay" | "UserExportInProgress" | "RoleNotFound" | "InvalidRoleNameOrId" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidPropertiesForKeyType" | "MismatchedKeyPropertiesPatch" | "MissingBinanceApiKey" | "BinanceKeyMasterMismatch" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidBase64Value" | "InvalidSs58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidUpdateOrgRequestDisallowedMfaType" | "InvalidUpdateOrgRequestEmptyAllowedMfaTypes" | "EmailOtpDelayTooShortForRegisterMfa" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidDiffieHellmanRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "OnlySpecifyOne" | "NoOidcDataInProof" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "IdpUserAlreadyExists" | "CognitoUserAlreadyOrgMember" | "UserNotFound" | "UserWithEmailNotFound" | "PolicyKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "LimitWindowTooLong" | "Erc20ContractDisallowed" | "EmptyRuleError" | "OptionalListEmpty" | "MultipleExclusiveFieldsProvided" | "DuplicateFieldEntry" | "InvalidRange" | "InvalidOrgPolicyRepeatedRule" | "InvalidSuiTransaction" | "SuiSenderMismatch" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcTaprootHashError" | "BtcSignError" | "TaprootSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "InvalidMemberRoleInRecipientAdd" | "ThirdPartyUserAlreadyExists" | "OidcIdentityAlreadyExists" | "UserAlreadyHasIdentity" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "DeleteUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "InvalidOidcIdentity" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter" | "InvalidTapNodeHash" | "InvalidOneTimeCode" | "MessageNotFound" | "MessageAlreadySigned" | "MessageRejected" | "MessageReplaced" | "InvalidMessageType" | "EmptyAddress" | "InvalidEth2SigningPolicySlotRange" | "InvalidEth2SigningPolicyEpochRange" | "InvalidEth2SigningPolicyTimestampRange" | "InvalidEth2SigningPolicyOverlappingRule" | "RpcUrlMissing" | "MmiChainIdMissing" | "EthersInvalidRpcUrl" | "EthersGetTransactionCountError" | "InvalidPassword" | "BabylonStakingFeePlusDustOverflow" | "BabylonStaking" | "BabylonStakingIncorrectKey" | "BabylonStakingSegwitNonDeposit" | "BabylonStakingRegistrationRequiresTaproot" | "PsbtSigning" | "TooManyResets" | "TooManyRequests" | "TooManyFailedLogins" | "BadBtcMessageSignP2shFlag" | "InvalidTendermintRequest" | "PolicyVersionMaxReached" | "PolicyVersionInvalid" | "PolicySecretLimitReached" | "PolicySecretTooLarge" | "InvalidImportKey" | "AlienOwnerInvalid" | "EmptyUpdateRequest" | "InvalidPolicyReference" | "PolicyEngineDisabled" | "InvalidWasmPolicy" | "InvalidPolicy" | "RedundantDerivationPath" | "ImportKeyMissing" | "InvalidAbiMethods" | "BabylonCovSign" | "InvalidPolicyLogsRequest" | "UserProfileMigrationMultipleEntries" | "UserProfileMigrationTooManyItems" | "InputTooShort" | "InvalidTweakLength" | "InvalidCustomChains" | "InvalidRpcRequest";
|
|
2704
2775
|
BillingArgs: {
|
|
2705
2776
|
billing_org: components["schemas"]["Id"];
|
|
2706
2777
|
event_type: components["schemas"]["BillingEvent"];
|
|
@@ -2717,7 +2788,168 @@ export interface components {
|
|
|
2717
2788
|
* @description Billing event types.
|
|
2718
2789
|
* @enum {string}
|
|
2719
2790
|
*/
|
|
2720
|
-
BillingEvent: "Mmi" | "MmiMessageGet" | "MmiMessageList" | "MmiMessageSign" | "MmiMessageReject" | "MmiMessageDelete" | "AboutMe" | "UserResetEmailInit" | "UserResetEmailComplete" | "UserDeleteTotp" | "UserResetTotpInit" | "UserResetTotpComplete" | "UserVerifyTotp" | "UserRegisterFidoInit" | "UserRegisterFidoComplete" | "UserDeleteFido" | "CreateProofOidc" | "CreateProofCubeSigner" | "VerifyProof" | "AddOidcIdentity" | "RemoveOidcIdentity" | "ListOidcIdentities" | "GetOrg" | "UpdateOrg" | "GetOrgExport" | "CreateOrg" | "ListKeys" | "AttestKey" | "GetKey" | "GetKeyByMaterialId" | "ListKeyRoles" | "UpdateKey" | "ListHistoricalKeyTx" | "Invite" | "CancelInvitation" | "ListInvitations" | "ListUsers" | "GetUser" | "GetUserByEmail" | "GetUserByOidc" | "UpdateMembership" | "ResetMemberMfa" | "CompleteResetMemberMfa" | "CreateRole" | "AttestRole" | "GetRole" | "ListTokenKeys" | "ListRoles" | "GetRoleKey" | "ListRoleKeys" | "ListRoleUsers" | "UpdateRole" | "DeleteRole" | "ConfigureEmail" | "GetEmailConfig" | "DeleteEmailConfig" | "ListHistoricalRoleTx" | "CreatePolicy" | "GetPolicy" | "ListPolicies" | "DeletePolicy" | "UpdatePolicy" | "InvokePolicy" | "GetPolicyLogs" | "UploadWasmPolicy" | "GetPolicySecrets" | "UpdatePolicySecrets" | "SetPolicySecret" | "DeletePolicySecret" | "CreatePolicyImportKey" | "GetPolicyBucket" | "ListPolicyBuckets" | "UpdatePolicyBucket" | "UserExportDelete" | "UserExportList" | "UserExportInit" | "UserExportComplete" | "AddUserToRole" | "RemoveUserFromRole" | "MfaApproveCs" | "MfaRejectCs" | "MfaGet" | "MfaList" | "AddKeysToRole" | "RemoveKeyFromRole" | "CreateToken" | "CreateSession" | "RevokeSession" | "RevokeCurrentSession" | "RevokeSessions" | "ListSessions" | "GetSession" | "SignerSessionRefresh" | "MfaApproveTotp" | "MfaRejectTotp" | "MfaFidoInit" | "MfaApproveFidoComplete" | "MfaRejectFidoComplete" | "MfaEmailInit" | "MfaEmailComplete" | "Cube3signerHeartbeat" | "CreateContact" | "GetContact" | "ListContacts" | "DeleteContact" | "UpdateContact" | "LookupContactsByAddress" | "QueryMetrics" | "QueryAuditLog" | "Counts" | "CreateKey" | "ImportKey" | "CreateKeyImportKey" | "DeriveKey" | "DeleteKey" | "AvaSign" | "AvaSerializedTxSign" | "BabylonRegistration" | "BabylonStaking" | "BabylonCovSign" | "BlobSign" | "BtcMessageSign" | "BtcSign" | "DiffieHellmanExchange" | "PsbtSign" | "PsbtLegacyInputSign" | "PsbtSegwitInputSign" | "PsbtTaprootInputSign" | "TaprootSign" | "Eip712Sign" | "Eip191Sign" | "Eth1Sign" | "Eth2Sign" | "SolanaSign" | "SuiSign" | "TendermintSign" | "Stake" | "Unstake" | "PasskeyAuthInit" | "PasskeyAuthComplete" | "OidcAuth" | "Oauth2Twitter" | "OAuth2TokenRefresh" | "EmailOtpAuth" | "SiweInit" | "SiweComplete" | "TelegramAuth" | "CreateOidcUser" | "DeleteOidcUser" | "DeleteUser" | "CreateEotsNonces" | "EotsSign" | "AuthMigrationIdentityAdd" | "AuthMigrationIdentityRemove" | "AuthMigrationUserUpdate" | "KeyCreated" | "KeyImported" | "InvitationAccept" | "IdpAuthenticate" | "IdpPasswordResetRequest" | "IdpPasswordResetConfirm" | "RpcApi" | "RpcCreateTransaction" | "RpcGetTransaction" | "RpcListTransactions" | "CustomChainRpcCall" | "EsploraApiCall" | "SentryApiCall" | "SentryApiCallPublic" | "MmiJwkSet" | "AttestationJwkSet" | "UserOrgs" | "PublicOrgInfo" | "EmailMyOrgs";
|
|
2791
|
+
BillingEvent: "Mmi" | "MmiMessageGet" | "MmiMessageList" | "MmiMessageSign" | "MmiMessageReject" | "MmiMessageDelete" | "AboutMe" | "UserResetEmailInit" | "UserResetEmailComplete" | "UserDeleteTotp" | "UserResetTotpInit" | "UserResetTotpComplete" | "UserVerifyTotp" | "UserRegisterFidoInit" | "UserRegisterFidoComplete" | "UserDeleteFido" | "CreateProofOidc" | "CreateProofCubeSigner" | "VerifyProof" | "AddOidcIdentity" | "RemoveOidcIdentity" | "ListOidcIdentities" | "GetOrg" | "UpdateOrg" | "GetOrgExport" | "CreateOrg" | "ListKeys" | "AttestKey" | "GetKey" | "GetKeyByMaterialId" | "ListKeyRoles" | "UpdateKey" | "ListHistoricalKeyTx" | "Invite" | "CancelInvitation" | "ListInvitations" | "ListUsers" | "GetUser" | "GetUserByEmail" | "GetUserByOidc" | "UpdateMembership" | "ResetMemberMfa" | "CompleteResetMemberMfa" | "CreateRole" | "AttestRole" | "GetRole" | "ListTokenKeys" | "ListRoles" | "GetRoleKey" | "ListRoleKeys" | "ListRoleUsers" | "UpdateRole" | "DeleteRole" | "ConfigureEmail" | "GetEmailConfig" | "DeleteEmailConfig" | "ListHistoricalRoleTx" | "CreatePolicy" | "GetPolicy" | "ListPolicies" | "DeletePolicy" | "UpdatePolicy" | "InvokePolicy" | "GetPolicyLogs" | "UploadWasmPolicy" | "GetPolicySecrets" | "UpdatePolicySecrets" | "SetPolicySecret" | "DeletePolicySecret" | "CreatePolicyImportKey" | "GetPolicyBucket" | "ListPolicyBuckets" | "UpdatePolicyBucket" | "UserExportDelete" | "UserExportList" | "UserExportInit" | "UserExportComplete" | "AddUserToRole" | "RemoveUserFromRole" | "MfaApproveCs" | "MfaRejectCs" | "MfaGet" | "MfaList" | "AddKeysToRole" | "RemoveKeyFromRole" | "CreateToken" | "CreateSession" | "RevokeSession" | "RevokeCurrentSession" | "RevokeSessions" | "ListSessions" | "GetSession" | "SignerSessionRefresh" | "MfaApproveTotp" | "MfaRejectTotp" | "MfaFidoInit" | "MfaApproveFidoComplete" | "MfaRejectFidoComplete" | "MfaEmailInit" | "MfaEmailComplete" | "Cube3signerHeartbeat" | "CreateContact" | "GetContact" | "ListContacts" | "DeleteContact" | "UpdateContact" | "LookupContactsByAddress" | "QueryMetrics" | "QueryAuditLog" | "Counts" | "CreateKey" | "ImportKey" | "CreateKeyImportKey" | "DeriveKey" | "DeleteKey" | "AvaSign" | "AvaSerializedTxSign" | "BabylonRegistration" | "BabylonStaking" | "BabylonCovSign" | "BlobSign" | "BtcMessageSign" | "BtcSign" | "DiffieHellmanExchange" | "PsbtSign" | "PsbtLegacyInputSign" | "PsbtSegwitInputSign" | "PsbtTaprootInputSign" | "TaprootSign" | "Eip712Sign" | "Eip191Sign" | "Eth1Sign" | "Eth2Sign" | "SolanaSign" | "SuiSign" | "TendermintSign" | "Stake" | "Unstake" | "PasskeyAuthInit" | "PasskeyAuthComplete" | "OidcAuth" | "Oauth2Twitter" | "OAuth2TokenRefresh" | "EmailOtpAuth" | "SiweInit" | "SiweComplete" | "TelegramAuth" | "CreateOidcUser" | "DeleteOidcUser" | "DeleteUser" | "CreateEotsNonces" | "EotsSign" | "AuthMigrationIdentityAdd" | "AuthMigrationIdentityRemove" | "AuthMigrationUserUpdate" | "KeyCreated" | "KeyImported" | "InvitationAccept" | "IdpAuthenticate" | "IdpPasswordResetRequest" | "IdpPasswordResetConfirm" | "RpcApi" | "RpcCreateTransaction" | "RpcGetTransaction" | "RpcListTransactions" | "RpcBinanceSubToMaster" | "RpcBinanceSubToSub" | "RpcBinanceUniversalTransfer" | "RpcBinanceSubAccountAssets" | "RpcBinanceAccountInfo" | "RpcBinanceSubAccountTransferHistory" | "RpcBinanceUniversalTransferHistory" | "RpcBinanceWithdraw" | "RpcBinanceWithdrawHistory" | "CustomChainRpcCall" | "EsploraApiCall" | "SentryApiCall" | "SentryApiCallPublic" | "MmiJwkSet" | "AttestationJwkSet" | "UserOrgs" | "PublicOrgInfo" | "EmailMyOrgs";
|
|
2792
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2793
|
+
BinanceAccountInfoParams: components["schemas"]["AccountInfoRequest"] & {
|
|
2794
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2795
|
+
keyId: components["schemas"]["Id"];
|
|
2796
|
+
/**
|
|
2797
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2798
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2799
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2800
|
+
*/
|
|
2801
|
+
recvWindow?: string | null;
|
|
2802
|
+
};
|
|
2803
|
+
BinanceApiPropertiesPatch: {
|
|
2804
|
+
/** @description The Binance-issued API key string. Encrypted server-side before storage. */
|
|
2805
|
+
api_key?: string | null;
|
|
2806
|
+
/** @description Email address of the Binance (master or sub) account this key authenticates as. */
|
|
2807
|
+
email?: string | null;
|
|
2808
|
+
/** @description Whether this corresponds to a master (as opposed to a sub) account on Binance. */
|
|
2809
|
+
is_master?: boolean | null;
|
|
2810
|
+
/** @description Arbitrary label. Useful for storing the corresponding API key label on the Binance side. */
|
|
2811
|
+
label?: string | null;
|
|
2812
|
+
};
|
|
2813
|
+
BinanceDryRunArgs: {
|
|
2814
|
+
/** @description The Binance API method that would have been used */
|
|
2815
|
+
method: string;
|
|
2816
|
+
/** @description The Binance API url method that would have been called */
|
|
2817
|
+
url: string;
|
|
2818
|
+
};
|
|
2819
|
+
/**
|
|
2820
|
+
* @description Different "dry run" modes for executing Binance requests
|
|
2821
|
+
* @enum {string}
|
|
2822
|
+
*/
|
|
2823
|
+
BinanceDryRunMode: "NO_SIGN" | "NO_SUBMIT";
|
|
2824
|
+
/**
|
|
2825
|
+
* @description Binance-family RPC methods. Each variant authenticates as the
|
|
2826
|
+
* [`KeyType::Ed25519BinanceApi`] key in its `params.key_id`.
|
|
2827
|
+
*/
|
|
2828
|
+
BinanceRpc: {
|
|
2829
|
+
/** @enum {string} */
|
|
2830
|
+
method: "cs_binanceSubToMaster";
|
|
2831
|
+
params: components["schemas"]["BinanceSubToMasterParams"];
|
|
2832
|
+
} | {
|
|
2833
|
+
/** @enum {string} */
|
|
2834
|
+
method: "cs_binanceSubToSub";
|
|
2835
|
+
params: components["schemas"]["BinanceSubToSubParams"];
|
|
2836
|
+
} | {
|
|
2837
|
+
/** @enum {string} */
|
|
2838
|
+
method: "cs_binanceUniversalTransfer";
|
|
2839
|
+
params: components["schemas"]["BinanceUniversalTransferParams"];
|
|
2840
|
+
} | {
|
|
2841
|
+
/** @enum {string} */
|
|
2842
|
+
method: "cs_binanceSubAccountAssets";
|
|
2843
|
+
params: components["schemas"]["BinanceSubAccountAssetsParams"];
|
|
2844
|
+
} | {
|
|
2845
|
+
/** @enum {string} */
|
|
2846
|
+
method: "cs_binanceAccountInfo";
|
|
2847
|
+
params: components["schemas"]["BinanceAccountInfoParams"];
|
|
2848
|
+
} | {
|
|
2849
|
+
/** @enum {string} */
|
|
2850
|
+
method: "cs_binanceSubAccountTransferHistory";
|
|
2851
|
+
params: components["schemas"]["BinanceSubAccountTransferHistoryParams"];
|
|
2852
|
+
} | {
|
|
2853
|
+
/** @enum {string} */
|
|
2854
|
+
method: "cs_binanceUniversalTransferHistory";
|
|
2855
|
+
params: components["schemas"]["BinanceUniversalTransferHistoryParams"];
|
|
2856
|
+
} | {
|
|
2857
|
+
/** @enum {string} */
|
|
2858
|
+
method: "cs_binanceWithdraw";
|
|
2859
|
+
params: components["schemas"]["BinanceWithdrawParams"];
|
|
2860
|
+
} | {
|
|
2861
|
+
/** @enum {string} */
|
|
2862
|
+
method: "cs_binanceWithdrawHistory";
|
|
2863
|
+
params: components["schemas"]["BinanceWithdrawHistoryParams"];
|
|
2864
|
+
};
|
|
2865
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2866
|
+
BinanceSubAccountAssetsParams: components["schemas"]["SubAccountAssetsRequest"] & {
|
|
2867
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2868
|
+
keyId: components["schemas"]["Id"];
|
|
2869
|
+
/**
|
|
2870
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2871
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2872
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2873
|
+
*/
|
|
2874
|
+
recvWindow?: string | null;
|
|
2875
|
+
};
|
|
2876
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2877
|
+
BinanceSubAccountTransferHistoryParams: components["schemas"]["SubAccountTransferHistoryRequest"] & {
|
|
2878
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2879
|
+
keyId: components["schemas"]["Id"];
|
|
2880
|
+
/**
|
|
2881
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2882
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2883
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2884
|
+
*/
|
|
2885
|
+
recvWindow?: string | null;
|
|
2886
|
+
};
|
|
2887
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2888
|
+
BinanceSubToMasterParams: components["schemas"]["SubToMasterRequest"] & {
|
|
2889
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2890
|
+
keyId: components["schemas"]["Id"];
|
|
2891
|
+
/**
|
|
2892
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2893
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2894
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2895
|
+
*/
|
|
2896
|
+
recvWindow?: string | null;
|
|
2897
|
+
};
|
|
2898
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2899
|
+
BinanceSubToSubParams: components["schemas"]["SubToSubRequest"] & {
|
|
2900
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2901
|
+
keyId: components["schemas"]["Id"];
|
|
2902
|
+
/**
|
|
2903
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2904
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2905
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2906
|
+
*/
|
|
2907
|
+
recvWindow?: string | null;
|
|
2908
|
+
};
|
|
2909
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2910
|
+
BinanceUniversalTransferHistoryParams: components["schemas"]["UniversalTransferHistoryRequest"] & {
|
|
2911
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2912
|
+
keyId: components["schemas"]["Id"];
|
|
2913
|
+
/**
|
|
2914
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2915
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2916
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2917
|
+
*/
|
|
2918
|
+
recvWindow?: string | null;
|
|
2919
|
+
};
|
|
2920
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2921
|
+
BinanceUniversalTransferParams: components["schemas"]["UniversalTransferRequest"] & {
|
|
2922
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2923
|
+
keyId: components["schemas"]["Id"];
|
|
2924
|
+
/**
|
|
2925
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2926
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2927
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2928
|
+
*/
|
|
2929
|
+
recvWindow?: string | null;
|
|
2930
|
+
};
|
|
2931
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2932
|
+
BinanceWithdrawHistoryParams: components["schemas"]["WithdrawHistoryRequest"] & {
|
|
2933
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2934
|
+
keyId: components["schemas"]["Id"];
|
|
2935
|
+
/**
|
|
2936
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2937
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2938
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2939
|
+
*/
|
|
2940
|
+
recvWindow?: string | null;
|
|
2941
|
+
};
|
|
2942
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2943
|
+
BinanceWithdrawParams: components["schemas"]["WithdrawRequest"] & {
|
|
2944
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2945
|
+
keyId: components["schemas"]["Id"];
|
|
2946
|
+
/**
|
|
2947
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2948
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2949
|
+
* If omitted, defaults to "10000". Must not be greater than "60000".
|
|
2950
|
+
*/
|
|
2951
|
+
recvWindow?: string | null;
|
|
2952
|
+
};
|
|
2721
2953
|
/** @description A bitcoin address and its network. */
|
|
2722
2954
|
BitcoinAddressInfo: {
|
|
2723
2955
|
/**
|
|
@@ -2733,6 +2965,8 @@ export interface components {
|
|
|
2733
2965
|
* }
|
|
2734
2966
|
*/
|
|
2735
2967
|
BlobSignRequest: {
|
|
2968
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
2969
|
+
dry_run?: boolean;
|
|
2736
2970
|
/**
|
|
2737
2971
|
* @description Request additional information to be included in the response, explaining
|
|
2738
2972
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2821,6 +3055,8 @@ export interface components {
|
|
|
2821
3055
|
};
|
|
2822
3056
|
/** @description Data to sign */
|
|
2823
3057
|
BtcMessageSignRequest: {
|
|
3058
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3059
|
+
dry_run?: boolean;
|
|
2824
3060
|
/**
|
|
2825
3061
|
* @description Request additional information to be included in the response, explaining
|
|
2826
3062
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -2857,6 +3093,8 @@ export interface components {
|
|
|
2857
3093
|
/** @enum {string} */
|
|
2858
3094
|
BtcSighashType: "All" | "None" | "Single" | "AllPlusAnyoneCanPay" | "NonePlusAnyoneCanPay" | "SinglePlusAnyoneCanPay";
|
|
2859
3095
|
BtcSignRequest: {
|
|
3096
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3097
|
+
dry_run?: boolean;
|
|
2860
3098
|
/**
|
|
2861
3099
|
* @description Request additional information to be included in the response, explaining
|
|
2862
3100
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3058,6 +3296,13 @@ export interface components {
|
|
|
3058
3296
|
client?: components["schemas"]["ClientProfile"];
|
|
3059
3297
|
os_info?: components["schemas"]["OsInfo"];
|
|
3060
3298
|
};
|
|
3299
|
+
/** @description Commission rates as decimal strings (e.g. `"0.00100000"`). */
|
|
3300
|
+
CommissionRates: {
|
|
3301
|
+
buyer: string;
|
|
3302
|
+
maker: string;
|
|
3303
|
+
seller: string;
|
|
3304
|
+
taker: string;
|
|
3305
|
+
};
|
|
3061
3306
|
/**
|
|
3062
3307
|
* @description Fields that are common to different types of resources such as keys, roles, etc.
|
|
3063
3308
|
* Includes versioning fields plus metadata, edit policy, etc.
|
|
@@ -3148,7 +3393,7 @@ export interface components {
|
|
|
3148
3393
|
type: "fido";
|
|
3149
3394
|
};
|
|
3150
3395
|
/** @enum {string} */
|
|
3151
|
-
ConflictErrorCode: "ConcurrentRequestDisallowed" | "ConcurrentLockCreation";
|
|
3396
|
+
ConflictErrorCode: "ConcurrentRequestDisallowed" | "ConcurrentLockCreation" | "ConcurrentTransactionSubmission";
|
|
3152
3397
|
/** @description A contact in the org. */
|
|
3153
3398
|
Contact: components["schemas"]["CommonFields"] & {
|
|
3154
3399
|
/**
|
|
@@ -3445,6 +3690,24 @@ export interface components {
|
|
|
3445
3690
|
CreationOptionsWithHash: components["schemas"]["ChallengePieces"] & {
|
|
3446
3691
|
options: components["schemas"]["PublicKeyCredentialCreationOptions"];
|
|
3447
3692
|
};
|
|
3693
|
+
/** @description Core RPC methods (transaction CRUD). */
|
|
3694
|
+
CsRpc: OneOf<[
|
|
3695
|
+
{
|
|
3696
|
+
/** @enum {string} */
|
|
3697
|
+
method: "cs_createTransaction";
|
|
3698
|
+
params: components["schemas"]["CreateTransactionRequest"];
|
|
3699
|
+
},
|
|
3700
|
+
{
|
|
3701
|
+
/** @enum {string} */
|
|
3702
|
+
method: "cs_getTransaction";
|
|
3703
|
+
params: components["schemas"]["GetTransactionRequest"];
|
|
3704
|
+
},
|
|
3705
|
+
{
|
|
3706
|
+
/** @enum {string} */
|
|
3707
|
+
method: "cs_listTransactions";
|
|
3708
|
+
params: components["schemas"]["ListTransactionsRequest"];
|
|
3709
|
+
}
|
|
3710
|
+
]>;
|
|
3448
3711
|
CubeSignerUserInfo: {
|
|
3449
3712
|
/** @description All multi-factor authentication methods configured for this user */
|
|
3450
3713
|
configured_mfa: components["schemas"]["ConfiguredMfa"][];
|
|
@@ -3563,6 +3826,8 @@ export interface components {
|
|
|
3563
3826
|
mnemonic_id?: string | null;
|
|
3564
3827
|
};
|
|
3565
3828
|
DiffieHellmanRequest: {
|
|
3829
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3830
|
+
dry_run?: boolean;
|
|
3566
3831
|
/**
|
|
3567
3832
|
* @description Request additional information to be included in the response, explaining
|
|
3568
3833
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3643,6 +3908,8 @@ export interface components {
|
|
|
3643
3908
|
time_lock_until?: components["schemas"]["EpochDateTime"] | null;
|
|
3644
3909
|
};
|
|
3645
3910
|
Eip191SignRequest: {
|
|
3911
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
3912
|
+
dry_run?: boolean;
|
|
3646
3913
|
/**
|
|
3647
3914
|
* @description Request additional information to be included in the response, explaining
|
|
3648
3915
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3765,6 +4032,8 @@ export interface components {
|
|
|
3765
4032
|
* }
|
|
3766
4033
|
*/
|
|
3767
4034
|
Eip712SignRequest: {
|
|
4035
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4036
|
+
dry_run?: boolean;
|
|
3768
4037
|
/**
|
|
3769
4038
|
* @description Request additional information to be included in the response, explaining
|
|
3770
4039
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3860,6 +4129,8 @@ export interface components {
|
|
|
3860
4129
|
* at a specified block height.
|
|
3861
4130
|
*/
|
|
3862
4131
|
EotsCreateNonceRequest: {
|
|
4132
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4133
|
+
dry_run?: boolean;
|
|
3863
4134
|
/**
|
|
3864
4135
|
* @description Request additional information to be included in the response, explaining
|
|
3865
4136
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -3910,6 +4181,8 @@ export interface components {
|
|
|
3910
4181
|
};
|
|
3911
4182
|
/** @description Request for an EOTS signature on a specified message, chain-id, block-height triple */
|
|
3912
4183
|
EotsSignRequest: {
|
|
4184
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4185
|
+
dry_run?: boolean;
|
|
3913
4186
|
/**
|
|
3914
4187
|
* @description Request additional information to be included in the response, explaining
|
|
3915
4188
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4006,6 +4279,8 @@ export interface components {
|
|
|
4006
4279
|
* }
|
|
4007
4280
|
*/
|
|
4008
4281
|
Eth1SignRequest: {
|
|
4282
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4283
|
+
dry_run?: boolean;
|
|
4009
4284
|
/**
|
|
4010
4285
|
* @description Request additional information to be included in the response, explaining
|
|
4011
4286
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4068,6 +4343,8 @@ export interface components {
|
|
|
4068
4343
|
* }
|
|
4069
4344
|
*/
|
|
4070
4345
|
Eth2SignRequest: {
|
|
4346
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
4347
|
+
dry_run?: boolean;
|
|
4071
4348
|
/**
|
|
4072
4349
|
* @description Request additional information to be included in the response, explaining
|
|
4073
4350
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -4201,7 +4478,7 @@ export interface components {
|
|
|
4201
4478
|
*
|
|
4202
4479
|
* Can be undefined if the transaction hasn't been signed yet, or failed to be signed.
|
|
4203
4480
|
*/
|
|
4204
|
-
signature?: string;
|
|
4481
|
+
signature?: string | null;
|
|
4205
4482
|
/** @description The transaction itself. */
|
|
4206
4483
|
tx: unknown;
|
|
4207
4484
|
};
|
|
@@ -4270,7 +4547,7 @@ export interface components {
|
|
|
4270
4547
|
* @description Explicitly named scopes for accessing CubeSigner APIs
|
|
4271
4548
|
* @enum {string}
|
|
4272
4549
|
*/
|
|
4273
|
-
ExplicitScope: "sign:*" | "sign:ava" | "sign:blob" | "sign:diffieHellman" | "sign:btc:*" | "sign:btc:segwit" | "sign:btc:taproot" | "sign:btc:psbt:*" | "sign:btc:psbt:doge" | "sign:btc:psbt:legacy" | "sign:btc:psbt:segwit" | "sign:btc:psbt:taproot" | "sign:btc:psbt:ltcSegwit" | "sign:btc:message:*" | "sign:btc:message:segwit" | "sign:btc:message:legacy" | "sign:babylon:*" | "sign:babylon:eots:*" | "sign:babylon:eots:nonces" | "sign:babylon:eots:sign" | "sign:babylon:staking:*" | "sign:babylon:staking:deposit" | "sign:babylon:staking:unbond" | "sign:babylon:staking:withdraw" | "sign:babylon:staking:slash" | "sign:babylon:registration" | "sign:babylon:covenant" | "sign:evm:*" | "sign:evm:tx" | "sign:evm:eip191" | "sign:evm:eip712" | "sign:eth2:*" | "sign:eth2:validate" | "sign:eth2:stake" | "sign:eth2:unstake" | "sign:solana" | "sign:sui" | "sign:tendermint" | "sign:mmi" | "manage:*" | "manage:readonly" | "manage:email:*" | "manage:email:get" | "manage:email:update" | "manage:email:delete" | "manage:mfa:*" | "manage:mfa:readonly" | "manage:mfa:list" | "manage:mfa:vote:*" | "manage:mfa:vote:cs" | "manage:mfa:vote:email" | "manage:mfa:vote:fido" | "manage:mfa:vote:totp" | "manage:mfa:register:*" | "manage:mfa:register:fido" | "manage:mfa:register:totp" | "manage:mfa:register:email" | "manage:mfa:unregister:*" | "manage:mfa:unregister:fido" | "manage:mfa:unregister:totp" | "manage:mfa:verify:*" | "manage:mfa:verify:totp" | "manage:key:*" | "manage:key:readonly" | "manage:key:get" | "manage:key:attest" | "manage:key:listRoles" | "manage:key:list" | "manage:key:history:tx:list" | "manage:key:create" | "manage:key:import" | "manage:key:update:*" | "manage:key:update:owner" | "manage:key:update:policy" | "manage:key:update:enabled" | "manage:key:update:region" | "manage:key:update:metadata" | "manage:key:update:editPolicy" | "manage:key:delete" | "manage:policy:*" | "manage:policy:readonly" | "manage:policy:create" | "manage:policy:get" | "manage:policy:list" | "manage:policy:delete" | "manage:policy:update:*" | "manage:policy:update:owner" | "manage:policy:update:name" | "manage:policy:update:acl" | "manage:policy:update:editPolicy" | "manage:policy:update:metadata" | "manage:policy:update:rule" | "manage:policy:invoke" | "manage:policy:wasm:*" | "manage:policy:wasm:upload" | "manage:policy:secrets:*" | "manage:policy:secrets:get" | "manage:policy:secrets:update:*" | "manage:policy:secrets:update:values" | "manage:policy:secrets:update:acl" | "manage:policy:secrets:update:editPolicy" | "manage:policy:buckets:*" | "manage:policy:buckets:get" | "manage:policy:buckets:list" | "manage:policy:buckets:update:*" | "manage:policy:buckets:update:owner" | "manage:policy:buckets:update:acl" | "manage:policy:buckets:update:metadata" | "manage:contact:*" | "manage:contact:readonly" | "manage:contact:create" | "manage:contact:get" | "manage:contact:list" | "manage:contact:delete" | "manage:contact:update:*" | "manage:contact:update:name" | "manage:contact:update:addresses" | "manage:contact:update:owner" | "manage:contact:update:labels" | "manage:contact:update:metadata" | "manage:contact:update:editPolicy" | "manage:contact:lookup:*" | "manage:contact:lookup:address" | "manage:policy:createImportKey" | "manage:role:*" | "manage:role:readonly" | "manage:role:create" | "manage:role:delete" | "manage:role:get:*" | "manage:role:attest" | "manage:role:get:keys" | "manage:role:get:keys:list" | "manage:role:get:keys:get" | "manage:role:get:users" | "manage:role:list" | "manage:role:update:*" | "manage:role:update:enabled" | "manage:role:update:policy" | "manage:role:update:editPolicy" | "manage:role:update:actions" | "manage:role:update:key:*" | "manage:role:update:key:add" | "manage:role:update:key:remove" | "manage:role:update:user:*" | "manage:role:update:user:add" | "manage:role:update:user:remove" | "manage:role:history:tx:list" | "manage:identity:*" | "manage:identity:readonly" | "manage:identity:verify" | "manage:identity:add" | "manage:identity:remove" | "manage:identity:list" | "manage:org:*" | "manage:org:create" | "manage:org:metrics:query" | "manage:org:audit:query" | "manage:org:readonly" | "manage:org:addUser" | "manage:org:inviteUser" | "manage:org:inviteAlien" | "manage:org:invitation:list" | "manage:org:invitation:cancel" | "manage:org:updateMembership" | "manage:org:listUsers" | "manage:org:user:get" | "manage:org:deleteUser" | "manage:org:get" | "manage:org:update:*" | "manage:org:update:enabled" | "manage:org:update:policy" | "manage:org:update:signPolicy" | "manage:org:update:export" | "manage:org:update:totpFailureLimit" | "manage:org:update:notificationEndpoints" | "manage:org:update:defaultInviteKind" | "manage:org:update:idpConfiguration" | "manage:org:update:passkeyConfiguration" | "manage:org:update:emailPreferences" | "manage:org:update:historicalData" | "manage:org:update:requireScopeCeiling" | "manage:org:update:alienLoginRequirement" | "manage:org:update:memberLoginRequirement" | "manage:org:update:keyExportRequirement" | "manage:org:update:allowedMfaTypes" | "manage:org:update:policyEngineConf" | "manage:org:update:customChains" | "manage:org:update:extProps" | "manage:org:update:editPolicy" | "manage:org:user:resetMfa" | "manage:session:*" | "manage:session:readonly" | "manage:session:get" | "manage:session:list" | "manage:session:create" | "manage:session:extend" | "manage:session:revoke" | "manage:export:*" | "manage:export:readonly" | "manage:export:org:*" | "manage:export:org:get" | "manage:export:user:*" | "manage:export:user:delete" | "manage:export:user:list" | "manage:authMigration:*" | "manage:authMigration:identity:add" | "manage:authMigration:identity:remove" | "manage:authMigration:user:update" | "manage:mmi:*" | "manage:mmi:readonly" | "manage:mmi:get" | "manage:mmi:list" | "manage:mmi:reject" | "manage:mmi:delete" | "export:*" | "export:user:*" | "export:user:init" | "export:user:complete" | "mmi:*" | "orgAccess:*" | "orgAccess:child:*" | "rpc:*" | "rpc:createTransaction:*" | "rpc:createTransaction:evm" | "rpc:getTransaction" | "rpc:listTransactions";
|
|
4550
|
+
ExplicitScope: "sign:*" | "sign:ava" | "sign:blob" | "sign:diffieHellman" | "sign:btc:*" | "sign:btc:segwit" | "sign:btc:taproot" | "sign:btc:psbt:*" | "sign:btc:psbt:doge" | "sign:btc:psbt:legacy" | "sign:btc:psbt:segwit" | "sign:btc:psbt:taproot" | "sign:btc:psbt:ltcSegwit" | "sign:btc:message:*" | "sign:btc:message:segwit" | "sign:btc:message:legacy" | "sign:babylon:*" | "sign:babylon:eots:*" | "sign:babylon:eots:nonces" | "sign:babylon:eots:sign" | "sign:babylon:staking:*" | "sign:babylon:staking:deposit" | "sign:babylon:staking:unbond" | "sign:babylon:staking:withdraw" | "sign:babylon:staking:slash" | "sign:babylon:registration" | "sign:babylon:covenant" | "sign:evm:*" | "sign:evm:tx" | "sign:evm:eip191" | "sign:evm:eip712" | "sign:eth2:*" | "sign:eth2:validate" | "sign:eth2:stake" | "sign:eth2:unstake" | "sign:solana" | "sign:sui" | "sign:tendermint" | "sign:mmi" | "manage:*" | "manage:readonly" | "manage:email:*" | "manage:email:get" | "manage:email:update" | "manage:email:delete" | "manage:mfa:*" | "manage:mfa:readonly" | "manage:mfa:list" | "manage:mfa:vote:*" | "manage:mfa:vote:cs" | "manage:mfa:vote:email" | "manage:mfa:vote:fido" | "manage:mfa:vote:totp" | "manage:mfa:register:*" | "manage:mfa:register:fido" | "manage:mfa:register:totp" | "manage:mfa:register:email" | "manage:mfa:unregister:*" | "manage:mfa:unregister:fido" | "manage:mfa:unregister:totp" | "manage:mfa:verify:*" | "manage:mfa:verify:totp" | "manage:key:*" | "manage:key:readonly" | "manage:key:get" | "manage:key:attest" | "manage:key:listRoles" | "manage:key:list" | "manage:key:history:tx:list" | "manage:key:create" | "manage:key:import" | "manage:key:update:*" | "manage:key:update:owner" | "manage:key:update:policy" | "manage:key:update:enabled" | "manage:key:update:region" | "manage:key:update:metadata" | "manage:key:update:properties" | "manage:key:update:editPolicy" | "manage:key:delete" | "manage:policy:*" | "manage:policy:readonly" | "manage:policy:create" | "manage:policy:get" | "manage:policy:list" | "manage:policy:delete" | "manage:policy:update:*" | "manage:policy:update:owner" | "manage:policy:update:name" | "manage:policy:update:acl" | "manage:policy:update:editPolicy" | "manage:policy:update:metadata" | "manage:policy:update:rule" | "manage:policy:invoke" | "manage:policy:wasm:*" | "manage:policy:wasm:upload" | "manage:policy:secrets:*" | "manage:policy:secrets:get" | "manage:policy:secrets:update:*" | "manage:policy:secrets:update:values" | "manage:policy:secrets:update:acl" | "manage:policy:secrets:update:editPolicy" | "manage:policy:buckets:*" | "manage:policy:buckets:get" | "manage:policy:buckets:list" | "manage:policy:buckets:update:*" | "manage:policy:buckets:update:owner" | "manage:policy:buckets:update:acl" | "manage:policy:buckets:update:metadata" | "manage:contact:*" | "manage:contact:readonly" | "manage:contact:create" | "manage:contact:get" | "manage:contact:list" | "manage:contact:delete" | "manage:contact:update:*" | "manage:contact:update:name" | "manage:contact:update:addresses" | "manage:contact:update:owner" | "manage:contact:update:labels" | "manage:contact:update:metadata" | "manage:contact:update:editPolicy" | "manage:contact:lookup:*" | "manage:contact:lookup:address" | "manage:policy:createImportKey" | "manage:role:*" | "manage:role:readonly" | "manage:role:create" | "manage:role:delete" | "manage:role:get:*" | "manage:role:attest" | "manage:role:get:keys" | "manage:role:get:keys:list" | "manage:role:get:keys:get" | "manage:role:get:users" | "manage:role:list" | "manage:role:update:*" | "manage:role:update:enabled" | "manage:role:update:policy" | "manage:role:update:editPolicy" | "manage:role:update:actions" | "manage:role:update:key:*" | "manage:role:update:key:add" | "manage:role:update:key:remove" | "manage:role:update:user:*" | "manage:role:update:user:add" | "manage:role:update:user:remove" | "manage:role:history:tx:list" | "manage:identity:*" | "manage:identity:readonly" | "manage:identity:verify" | "manage:identity:add" | "manage:identity:remove" | "manage:identity:list" | "manage:org:*" | "manage:org:create" | "manage:org:metrics:query" | "manage:org:audit:query" | "manage:org:readonly" | "manage:org:addUser" | "manage:org:inviteUser" | "manage:org:inviteAlien" | "manage:org:invitation:list" | "manage:org:invitation:cancel" | "manage:org:updateMembership:*" | "manage:org:updateMembership:owner" | "manage:org:updateMembership:member" | "manage:org:updateMembership:alien" | "manage:org:listUsers" | "manage:org:user:get" | "manage:org:deleteUser:*" | "manage:org:deleteUser:owner" | "manage:org:deleteUser:member" | "manage:org:deleteUser:alien" | "manage:org:get" | "manage:org:update:*" | "manage:org:update:enabled" | "manage:org:update:policy" | "manage:org:update:signPolicy" | "manage:org:update:export" | "manage:org:update:totpFailureLimit" | "manage:org:update:notificationEndpoints" | "manage:org:update:defaultInviteKind" | "manage:org:update:idpConfiguration" | "manage:org:update:passkeyConfiguration" | "manage:org:update:emailPreferences" | "manage:org:update:historicalData" | "manage:org:update:requireScopeCeiling" | "manage:org:update:alienLoginRequirement" | "manage:org:update:memberLoginRequirement" | "manage:org:update:keyExportRequirement" | "manage:org:update:allowedMfaTypes" | "manage:org:update:policyEngineConf" | "manage:org:update:customChains" | "manage:org:update:extProps" | "manage:org:update:editPolicy" | "manage:org:user:resetMfa" | "manage:session:*" | "manage:session:readonly" | "manage:session:get" | "manage:session:list" | "manage:session:create" | "manage:session:extend" | "manage:session:revoke" | "manage:export:*" | "manage:export:readonly" | "manage:export:org:*" | "manage:export:org:get" | "manage:export:user:*" | "manage:export:user:delete" | "manage:export:user:list" | "manage:authMigration:*" | "manage:authMigration:identity:add" | "manage:authMigration:identity:remove" | "manage:authMigration:user:update" | "manage:mmi:*" | "manage:mmi:readonly" | "manage:mmi:get" | "manage:mmi:list" | "manage:mmi:reject" | "manage:mmi:delete" | "export:*" | "export:user:*" | "export:user:init" | "export:user:complete" | "mmi:*" | "orgAccess:*" | "orgAccess:child:*" | "rpc:*" | "rpc:createTransaction:*" | "rpc:createTransaction:evm" | "rpc:getTransaction" | "rpc:listTransactions" | "rpc:binance:*" | "rpc:binance:subToMaster" | "rpc:binance:subToSub" | "rpc:binance:universalTransfer" | "rpc:binance:subAccountAssets" | "rpc:binance:accountInfo" | "rpc:binance:subAccountTransferHistory" | "rpc:binance:universalTransferHistory" | "rpc:binance:withdraw" | "rpc:binance:withdrawHistory";
|
|
4274
4551
|
/**
|
|
4275
4552
|
* @description This type specifies the interpretation of the `fee` field in Babylon
|
|
4276
4553
|
* staking requests. If `sats`, the field is intpreted as a fixed value
|
|
@@ -4727,9 +5004,7 @@ export interface components {
|
|
|
4727
5004
|
key_type: string;
|
|
4728
5005
|
};
|
|
4729
5006
|
/** @description The top-level JSON-RPC request type. */
|
|
4730
|
-
JsonRpcRequest: {
|
|
4731
|
-
method: "JsonRpcRequest";
|
|
4732
|
-
} & Omit<components["schemas"]["RpcMethod"], "method"> & {
|
|
5007
|
+
JsonRpcRequest: components["schemas"]["RpcMethod"] & {
|
|
4733
5008
|
/** @description Request ID */
|
|
4734
5009
|
id?: string;
|
|
4735
5010
|
/** @description JSON-RPC version. */
|
|
@@ -4746,7 +5021,7 @@ export interface components {
|
|
|
4746
5021
|
result?: Record<string, unknown> | null;
|
|
4747
5022
|
};
|
|
4748
5023
|
/** @description Valid `result` from the JSON-RPC API. */
|
|
4749
|
-
JsonRpcResult: components["schemas"]["TransactionInfo"] | components["schemas"]["ListTransactionsPaginatedResponse"];
|
|
5024
|
+
JsonRpcResult: components["schemas"]["TransactionInfo"] | components["schemas"]["ListTransactionsPaginatedResponse"] | components["schemas"]["SubAccountTransferResponse"] | components["schemas"]["UniversalTransferResponse"] | components["schemas"]["SubAccountAssetsResponse"] | components["schemas"]["AccountInfoResponse"] | components["schemas"]["SubAccountTransferHistoryResponse"] | components["schemas"]["UniversalTransferHistoryResponse"] | components["schemas"]["WithdrawResponse"] | components["schemas"]["WithdrawHistoryResponse"];
|
|
4750
5025
|
JwkSetResponse: {
|
|
4751
5026
|
/** @description The keys included in this set */
|
|
4752
5027
|
keys: Record<string, never>[];
|
|
@@ -4848,6 +5123,7 @@ export interface components {
|
|
|
4848
5123
|
* ]
|
|
4849
5124
|
*/
|
|
4850
5125
|
policy: unknown[];
|
|
5126
|
+
properties?: components["schemas"]["KeyPropertiesPatch"] | null;
|
|
4851
5127
|
/** @description The key provenance. */
|
|
4852
5128
|
provenance?: string | null;
|
|
4853
5129
|
/**
|
|
@@ -4875,8 +5151,21 @@ export interface components {
|
|
|
4875
5151
|
KeyInfos: {
|
|
4876
5152
|
keys: components["schemas"]["KeyInfo"][];
|
|
4877
5153
|
};
|
|
5154
|
+
/**
|
|
5155
|
+
* @description Client-side wire payload for [`KeyProperties`]. Used in both directions:
|
|
5156
|
+
*
|
|
5157
|
+
* - **On write**: a *patch*, i.e., for each field, missing means "leave alone",
|
|
5158
|
+
* `null` means "clear", and a value means "set". Secret fields arrive in the
|
|
5159
|
+
* clear and are encrypted server-side before persisting.
|
|
5160
|
+
* - **On read**: each field is omitted when the stored property is unset; secret
|
|
5161
|
+
* fields are emitted with the redacted marker (e.g. "[REDACTED]").
|
|
5162
|
+
*/
|
|
5163
|
+
KeyPropertiesPatch: components["schemas"]["BinanceApiPropertiesPatch"] & {
|
|
5164
|
+
/** @enum {string} */
|
|
5165
|
+
kind: "BinanceApi";
|
|
5166
|
+
};
|
|
4878
5167
|
/** @enum {string} */
|
|
4879
|
-
KeyType: "SecpEthAddr" | "SecpBtc" | "SecpBtcTest" | "SecpBtcLegacy" | "SecpBtcLegacyTest" | "SecpAvaAddr" | "SecpAvaTestAddr" | "BlsPub" | "BlsInactive" | "BlsAvaIcm" | "Ed25519SolanaAddr" | "Ed25519SuiAddr" | "Ed25519AptosAddr" | "Ed25519CardanoAddrVk" | "Ed25519StellarAddr" | "Ed25519SubstrateAddr" | "Ed25519CantonAddr" | "Mnemonic" | "Stark" | "BabylonEots" | "BabylonCov" | "TaprootBtc" | "TaprootBtcTest" | "SecpCosmosAddr" | "P256CosmosAddr" | "P256OntologyAddr" | "P256Neo3Addr" | "Ed25519TendermintAddr" | "SecpTronAddr" | "Ed25519TonAddr" | "SecpDogeAddr" | "SecpDogeTestAddr" | "SecpKaspaAddr" | "SecpKaspaTestAddr" | "SchnorrKaspaAddr" | "SchnorrKaspaTestAddr" | "SecpLtc" | "SecpLtcTest" | "SecpXrpAddr" | "Ed25519XrpAddr" | "BabyJubjub";
|
|
5168
|
+
KeyType: "SecpEthAddr" | "SecpBtc" | "SecpBtcTest" | "SecpBtcLegacy" | "SecpBtcLegacyTest" | "SecpAvaAddr" | "SecpAvaTestAddr" | "BlsPub" | "BlsInactive" | "BlsAvaIcm" | "Ed25519SolanaAddr" | "Ed25519SuiAddr" | "Ed25519AptosAddr" | "Ed25519CardanoAddrVk" | "Ed25519StellarAddr" | "Ed25519SubstrateAddr" | "Ed25519CantonAddr" | "Ed25519BinanceApi" | "Mnemonic" | "Stark" | "BabylonEots" | "BabylonCov" | "TaprootBtc" | "TaprootBtcTest" | "SecpCosmosAddr" | "P256CosmosAddr" | "P256OntologyAddr" | "P256Neo3Addr" | "Ed25519TendermintAddr" | "SecpTronAddr" | "Ed25519TonAddr" | "SecpDogeAddr" | "SecpDogeTestAddr" | "SecpKaspaAddr" | "SecpKaspaTestAddr" | "SchnorrKaspaAddr" | "SchnorrKaspaTestAddr" | "SecpLtc" | "SecpLtcTest" | "SecpXrpAddr" | "Ed25519XrpAddr" | "BabyJubjub";
|
|
4880
5169
|
KeyTypeAndDerivationPath: {
|
|
4881
5170
|
/**
|
|
4882
5171
|
* @description List of derivation paths for which to derive.
|
|
@@ -4947,7 +5236,7 @@ export interface components {
|
|
|
4947
5236
|
*/
|
|
4948
5237
|
owner?: string | null;
|
|
4949
5238
|
};
|
|
4950
|
-
/** @description The response to [`cs_listTransactions`](super::request::
|
|
5239
|
+
/** @description The response to [`cs_listTransactions`](super::request::CsRpc::ListTransactions) */
|
|
4951
5240
|
ListTransactionsResponse: {
|
|
4952
5241
|
/** @description A list of transaction infos. */
|
|
4953
5242
|
transactions: components["schemas"]["TransactionInfo"][];
|
|
@@ -5033,6 +5322,17 @@ export interface components {
|
|
|
5033
5322
|
request: components["schemas"]["HttpRequest"];
|
|
5034
5323
|
status: components["schemas"]["Status"];
|
|
5035
5324
|
};
|
|
5325
|
+
MfaRequiredArgs: {
|
|
5326
|
+
/** @description Always set to first MFA id from `Self::ids` */
|
|
5327
|
+
id: string;
|
|
5328
|
+
/** @description Non-empty MFA request IDs */
|
|
5329
|
+
ids: string[];
|
|
5330
|
+
/** @description Organization id */
|
|
5331
|
+
org_id: string;
|
|
5332
|
+
/** @description Optional policy evaluation tree (included in signer responses, when requested) */
|
|
5333
|
+
policy_eval_tree?: unknown;
|
|
5334
|
+
session?: components["schemas"]["NewSessionResponse"] | null;
|
|
5335
|
+
};
|
|
5036
5336
|
/** @description Org-wide MFA requirements. */
|
|
5037
5337
|
MfaRequirements: {
|
|
5038
5338
|
alien_login_requirement?: components["schemas"]["SecondFactorRequirement"];
|
|
@@ -5072,7 +5372,7 @@ export interface components {
|
|
|
5072
5372
|
verified_email?: string | null;
|
|
5073
5373
|
};
|
|
5074
5374
|
MigrateUpdateUsersRequest: components["schemas"]["MigrateUpdateUserItem"][];
|
|
5075
|
-
MmiMetadata:
|
|
5375
|
+
MmiMetadata: {
|
|
5076
5376
|
/** @description Chain ID (not required when signing a personal message (EIP-191)) */
|
|
5077
5377
|
chainId?: string | null;
|
|
5078
5378
|
/** @description If the custodian should publish the transaction */
|
|
@@ -5086,40 +5386,6 @@ export interface components {
|
|
|
5086
5386
|
/** @description The category of transaction, as best can be determined by the wallet */
|
|
5087
5387
|
transactionCategory?: string | null;
|
|
5088
5388
|
};
|
|
5089
|
-
MmiMetadataExt: {
|
|
5090
|
-
/**
|
|
5091
|
-
* @description All accounts the user can access.
|
|
5092
|
-
* Only set when requested explicitly, i.e., via 'customer_listAccountsSigned'.
|
|
5093
|
-
*/
|
|
5094
|
-
accounts?: {
|
|
5095
|
-
/**
|
|
5096
|
-
* @description An Ethereum address, hex-encoded, with leading '0x'
|
|
5097
|
-
* @example 0x0123456789012345678901234567890123456789
|
|
5098
|
-
*/
|
|
5099
|
-
address: string;
|
|
5100
|
-
/** @description Account metadata */
|
|
5101
|
-
metadata?: unknown;
|
|
5102
|
-
/** @description Account name */
|
|
5103
|
-
name: string;
|
|
5104
|
-
/** @description Ordered list of name-value pairs */
|
|
5105
|
-
tags?: {
|
|
5106
|
-
/** @description Tag name */
|
|
5107
|
-
name: string;
|
|
5108
|
-
/** @description Tag value */
|
|
5109
|
-
value: string;
|
|
5110
|
-
}[];
|
|
5111
|
-
}[] | null;
|
|
5112
|
-
/** @description The customer ID of the user, i.e., the customer's organization ID. */
|
|
5113
|
-
customerId: string | null;
|
|
5114
|
-
/** @description A human readable name of the corresponding organization, if any. */
|
|
5115
|
-
customerName: string | null;
|
|
5116
|
-
} & {
|
|
5117
|
-
/**
|
|
5118
|
-
* @description This must match the `sub` claim of the customer proof of
|
|
5119
|
-
* the user or role session which created the transaction.
|
|
5120
|
-
*/
|
|
5121
|
-
userId: string | null;
|
|
5122
|
-
};
|
|
5123
5389
|
MmiRejectRequest: {
|
|
5124
5390
|
/** @description Optional reason for rejecting. */
|
|
5125
5391
|
reason?: string | null;
|
|
@@ -6278,6 +6544,8 @@ export interface components {
|
|
|
6278
6544
|
]>;
|
|
6279
6545
|
/** @description A request to sign a PSBT */
|
|
6280
6546
|
PsbtSignRequest: {
|
|
6547
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
6548
|
+
dry_run?: boolean;
|
|
6281
6549
|
/**
|
|
6282
6550
|
* @description Request additional information to be included in the response, explaining
|
|
6283
6551
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -6881,20 +7149,14 @@ export interface components {
|
|
|
6881
7149
|
/** @description A JSON Web Token whose claims contain the `RoleInfo` structure. */
|
|
6882
7150
|
jwt: string;
|
|
6883
7151
|
};
|
|
6884
|
-
/**
|
|
6885
|
-
|
|
6886
|
-
|
|
6887
|
-
|
|
6888
|
-
|
|
6889
|
-
|
|
6890
|
-
|
|
6891
|
-
|
|
6892
|
-
params: components["schemas"]["GetTransactionRequest"];
|
|
6893
|
-
} | {
|
|
6894
|
-
/** @enum {string} */
|
|
6895
|
-
method: "cs_listTransactions";
|
|
6896
|
-
params: components["schemas"]["ListTransactionsRequest"];
|
|
6897
|
-
};
|
|
7152
|
+
/**
|
|
7153
|
+
* @description The RPC API method and matching parameters.
|
|
7154
|
+
*
|
|
7155
|
+
* Top-level dispatch. Wire format is preserved by `#[serde(untagged)]`: each
|
|
7156
|
+
* inbound request is matched against one of the internally-tagged inner enums
|
|
7157
|
+
* ([`CsRpc`] for the core methods, [`BinanceRpc`] for the Binance family).
|
|
7158
|
+
*/
|
|
7159
|
+
RpcMethod: components["schemas"]["CsRpc"] | components["schemas"]["BinanceRpc"];
|
|
6898
7160
|
/** @description All scopes for accessing CubeSigner APIs */
|
|
6899
7161
|
Scope: components["schemas"]["ExplicitScope"] | string;
|
|
6900
7162
|
/** @description A set of scopes. */
|
|
@@ -7035,6 +7297,12 @@ export interface components {
|
|
|
7035
7297
|
/** @description All metrics must include 'org_id' as a dimension. */
|
|
7036
7298
|
org_id: string;
|
|
7037
7299
|
};
|
|
7300
|
+
SignDryRunArgs: {
|
|
7301
|
+
/** @description Whether MFA is required */
|
|
7302
|
+
mfa_requests: components["schemas"]["MfaRequestInfo"][];
|
|
7303
|
+
/** @description Optional policy evaluation tree, if requested */
|
|
7304
|
+
policy_eval_tree?: unknown;
|
|
7305
|
+
};
|
|
7038
7306
|
SignResponse: {
|
|
7039
7307
|
/** @description Optional policy evaluation tree. */
|
|
7040
7308
|
policy_eval_tree?: unknown;
|
|
@@ -7129,6 +7397,8 @@ export interface components {
|
|
|
7129
7397
|
* }
|
|
7130
7398
|
*/
|
|
7131
7399
|
SolanaSignRequest: {
|
|
7400
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7401
|
+
dry_run?: boolean;
|
|
7132
7402
|
/**
|
|
7133
7403
|
* @description Request additional information to be included in the response, explaining
|
|
7134
7404
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7158,6 +7428,8 @@ export interface components {
|
|
|
7158
7428
|
source_ip: string;
|
|
7159
7429
|
};
|
|
7160
7430
|
StakeRequest: {
|
|
7431
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7432
|
+
dry_run?: boolean;
|
|
7161
7433
|
/**
|
|
7162
7434
|
* @description Request additional information to be included in the response, explaining
|
|
7163
7435
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7237,6 +7509,164 @@ export interface components {
|
|
|
7237
7509
|
num_auth_factors: number;
|
|
7238
7510
|
request_comparer?: components["schemas"]["HttpRequestCmp"];
|
|
7239
7511
|
};
|
|
7512
|
+
/**
|
|
7513
|
+
* @description A single asset balance entry returned by [`SubAccountAssetsResponse`].
|
|
7514
|
+
*
|
|
7515
|
+
* All balance fields are decimal strings (Binance preserves precision by not
|
|
7516
|
+
* converting to floats).
|
|
7517
|
+
*/
|
|
7518
|
+
SubAccountAsset: {
|
|
7519
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
7520
|
+
asset: string;
|
|
7521
|
+
/** @description Available balance. */
|
|
7522
|
+
free: string;
|
|
7523
|
+
/** @description Balance frozen by Binance (e.g. due to compliance holds). */
|
|
7524
|
+
freeze: string;
|
|
7525
|
+
/** @description Balance locked in open orders. */
|
|
7526
|
+
locked: string;
|
|
7527
|
+
/** @description Balance currently being withdrawn. */
|
|
7528
|
+
withdrawing: string;
|
|
7529
|
+
};
|
|
7530
|
+
/**
|
|
7531
|
+
* @description Parameters for `GET /sapi/v4/sub-account/assets`.
|
|
7532
|
+
*
|
|
7533
|
+
* Queries the spot-wallet balances of a single sub-account. Must be called by
|
|
7534
|
+
* a master-account credential.
|
|
7535
|
+
*/
|
|
7536
|
+
SubAccountAssetsRequest: {
|
|
7537
|
+
/** @description Email address of the sub-account whose balances to fetch. */
|
|
7538
|
+
email: string;
|
|
7539
|
+
};
|
|
7540
|
+
/** @description Response for [`BinanceManager::sub_account_assets`]. */
|
|
7541
|
+
SubAccountAssetsResponse: {
|
|
7542
|
+
/**
|
|
7543
|
+
* @description One entry per asset held in the sub-account's spot wallet. Binance
|
|
7544
|
+
* omits assets with all-zero balances.
|
|
7545
|
+
*/
|
|
7546
|
+
balances: components["schemas"]["SubAccountAsset"][];
|
|
7547
|
+
};
|
|
7548
|
+
/** @description One transfer entry in [`SubAccountTransferHistoryResponse`]. */
|
|
7549
|
+
SubAccountTransferHistoryEntry: {
|
|
7550
|
+
/** @description Asset symbol (e.g. `"USDT"`). */
|
|
7551
|
+
asset: string;
|
|
7552
|
+
/** @description Email of the counterparty account on the other side of the transfer. */
|
|
7553
|
+
counterParty: string;
|
|
7554
|
+
/**
|
|
7555
|
+
* @description Email of the account this entry's API key authenticates as. Binance
|
|
7556
|
+
* returns this on each row even though it is the same for the whole page.
|
|
7557
|
+
*/
|
|
7558
|
+
email: string;
|
|
7559
|
+
/**
|
|
7560
|
+
* @description Wallet type debited on the source side (e.g. `"SPOT"`,
|
|
7561
|
+
* `"USDT_FUTURE"`). Left as `String` for forward compatibility.
|
|
7562
|
+
*/
|
|
7563
|
+
fromAccountType: string;
|
|
7564
|
+
/** @description Amount transferred, as a decimal string. */
|
|
7565
|
+
qty: string;
|
|
7566
|
+
/**
|
|
7567
|
+
* @description Transfer status: `"PROCESS"`, `"SUCCESS"`, or `"FAILURE"`. Left as
|
|
7568
|
+
* `String` for forward compatibility.
|
|
7569
|
+
*/
|
|
7570
|
+
status: string;
|
|
7571
|
+
/**
|
|
7572
|
+
* Format: int64
|
|
7573
|
+
* @description Time of the transfer (ms since epoch).
|
|
7574
|
+
*/
|
|
7575
|
+
time: number;
|
|
7576
|
+
/** @description Wallet type credited on the destination side. */
|
|
7577
|
+
toAccountType: string;
|
|
7578
|
+
/**
|
|
7579
|
+
* Format: int64
|
|
7580
|
+
* @description Transfer id. Matches the `txnId` returned by the original
|
|
7581
|
+
* [`SubAccountTransferResponse`].
|
|
7582
|
+
*/
|
|
7583
|
+
tranId: number;
|
|
7584
|
+
/**
|
|
7585
|
+
* Format: int32
|
|
7586
|
+
* @description `1` = transfer in, `2` = transfer out.
|
|
7587
|
+
*/
|
|
7588
|
+
type: number;
|
|
7589
|
+
};
|
|
7590
|
+
/**
|
|
7591
|
+
* @description Parameters for `GET /sapi/v1/sub-account/transfer/subUserHistory`.
|
|
7592
|
+
*
|
|
7593
|
+
* Lists the transfer history of the calling sub-account. Covers both
|
|
7594
|
+
* sub-to-master and sub-to-sub transfers. All filters are optional; if
|
|
7595
|
+
* `start_time`/`end_time` are omitted, Binance returns the most recent 30
|
|
7596
|
+
* days. If `r#type` is omitted, Binance defaults to `TransferOut` (`2`).
|
|
7597
|
+
*/
|
|
7598
|
+
SubAccountTransferHistoryRequest: {
|
|
7599
|
+
/** @description Filter to a specific asset (e.g. `"USDT"`). */
|
|
7600
|
+
asset?: string | null;
|
|
7601
|
+
/**
|
|
7602
|
+
* Format: int64
|
|
7603
|
+
* @description Window end (ms since epoch).
|
|
7604
|
+
*/
|
|
7605
|
+
endTime?: number | null;
|
|
7606
|
+
/**
|
|
7607
|
+
* Format: int32
|
|
7608
|
+
* @description Page size (Binance default: 500).
|
|
7609
|
+
*/
|
|
7610
|
+
limit?: number | null;
|
|
7611
|
+
/**
|
|
7612
|
+
* @description If `true`, include failed transfers in the response. Binance defaults
|
|
7613
|
+
* to `false`.
|
|
7614
|
+
*/
|
|
7615
|
+
returnFailHistory?: boolean | null;
|
|
7616
|
+
/**
|
|
7617
|
+
* Format: int64
|
|
7618
|
+
* @description Window start (ms since epoch).
|
|
7619
|
+
*/
|
|
7620
|
+
startTime?: number | null;
|
|
7621
|
+
/**
|
|
7622
|
+
* Format: int32
|
|
7623
|
+
* @description Direction filter (`1` = transfer in, `2` = transfer out).
|
|
7624
|
+
*/
|
|
7625
|
+
type?: number | null;
|
|
7626
|
+
};
|
|
7627
|
+
/**
|
|
7628
|
+
* @description Response for [`BinanceManager::sub_account_transfer_history`].
|
|
7629
|
+
*
|
|
7630
|
+
* Binance returns a top-level JSON array; this newtype preserves that wire
|
|
7631
|
+
* format while giving the response a named type in the OpenAPI schema.
|
|
7632
|
+
*/
|
|
7633
|
+
SubAccountTransferHistoryResponse: components["schemas"]["SubAccountTransferHistoryEntry"][];
|
|
7634
|
+
/** @description Response for [`BinanceManager::sub_to_master`] and [`BinanceManager::sub_to_sub`]. */
|
|
7635
|
+
SubAccountTransferResponse: {
|
|
7636
|
+
/** Format: int64 */
|
|
7637
|
+
txnId: number;
|
|
7638
|
+
};
|
|
7639
|
+
/**
|
|
7640
|
+
* @description Parameters for `POST /sapi/v1/sub-account/transfer/subToMaster`.
|
|
7641
|
+
*
|
|
7642
|
+
* Transfers an asset from the caller's sub-account to the master account.
|
|
7643
|
+
*/
|
|
7644
|
+
SubToMasterRequest: {
|
|
7645
|
+
/**
|
|
7646
|
+
* @description The amount being transferred, formatted as a decimal string (e.g. `"0.1"`).
|
|
7647
|
+
* Sent verbatim: Binance is strict about decimal formatting.
|
|
7648
|
+
*/
|
|
7649
|
+
amount: string;
|
|
7650
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`, `"BTC"`). */
|
|
7651
|
+
asset: string;
|
|
7652
|
+
};
|
|
7653
|
+
/**
|
|
7654
|
+
* @description Parameters for `POST /sapi/v1/sub-account/transfer/subToSub`.
|
|
7655
|
+
*
|
|
7656
|
+
* Transfers an asset from the caller's sub-account to another sub-account
|
|
7657
|
+
* under the same master account.
|
|
7658
|
+
*/
|
|
7659
|
+
SubToSubRequest: {
|
|
7660
|
+
/** @description The amount being transferred, as a decimal string (e.g. `"0.1"`). */
|
|
7661
|
+
amount: string;
|
|
7662
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`). */
|
|
7663
|
+
asset: string;
|
|
7664
|
+
/**
|
|
7665
|
+
* @description Email address of the destination sub-account. Must be a sub-account of
|
|
7666
|
+
* the same master.
|
|
7667
|
+
*/
|
|
7668
|
+
toEmail: string;
|
|
7669
|
+
};
|
|
7240
7670
|
/**
|
|
7241
7671
|
* @description The status of a subscription
|
|
7242
7672
|
* @enum {string}
|
|
@@ -7258,6 +7688,8 @@ export interface components {
|
|
|
7258
7688
|
SuiChain: "mainnet" | "devnet" | "testnet";
|
|
7259
7689
|
/** @description Request to sign a serialized SUI transaction */
|
|
7260
7690
|
SuiSignRequest: {
|
|
7691
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7692
|
+
dry_run?: boolean;
|
|
7261
7693
|
/**
|
|
7262
7694
|
* @description Request additional information to be included in the response, explaining
|
|
7263
7695
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7284,6 +7716,8 @@ export interface components {
|
|
|
7284
7716
|
tx: string;
|
|
7285
7717
|
};
|
|
7286
7718
|
TaprootSignRequest: {
|
|
7719
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7720
|
+
dry_run?: boolean;
|
|
7287
7721
|
/**
|
|
7288
7722
|
* @description Request additional information to be included in the response, explaining
|
|
7289
7723
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7356,6 +7790,8 @@ export interface components {
|
|
|
7356
7790
|
TelegramEnvironment: "production" | "test";
|
|
7357
7791
|
/** @description The request for using the Tendermint sign endpoint. */
|
|
7358
7792
|
TendermintSignRequest: {
|
|
7793
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
7794
|
+
dry_run?: boolean;
|
|
7359
7795
|
/**
|
|
7360
7796
|
* @description Request additional information to be included in the response, explaining
|
|
7361
7797
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7617,6 +8053,119 @@ export interface components {
|
|
|
7617
8053
|
]>;
|
|
7618
8054
|
/** @enum {string} */
|
|
7619
8055
|
UnauthorizedErrorCode: "AuthorizationHeaderMissing" | "EndpointRequiresUserSession" | "RefreshTokenMissing";
|
|
8056
|
+
/** @description One transfer entry in [`UniversalTransferHistoryResponse`]. */
|
|
8057
|
+
UniversalTransferHistoryEntry: {
|
|
8058
|
+
/** @description Amount transferred, as a decimal string. */
|
|
8059
|
+
amount: string;
|
|
8060
|
+
/** @description Asset symbol. */
|
|
8061
|
+
asset: string;
|
|
8062
|
+
/** @description Client-supplied transfer id, if one was set on the original transfer. */
|
|
8063
|
+
clientTranId?: string | null;
|
|
8064
|
+
/**
|
|
8065
|
+
* Format: int64
|
|
8066
|
+
* @description Time of the transfer (ms since epoch).
|
|
8067
|
+
*/
|
|
8068
|
+
createTimeStamp: number;
|
|
8069
|
+
/**
|
|
8070
|
+
* @description Wallet type debited on the source side. Left as `String` for forward
|
|
8071
|
+
* compatibility.
|
|
8072
|
+
*/
|
|
8073
|
+
fromAccountType: string;
|
|
8074
|
+
/** @description Source sub-account email; absent when the source is the master. */
|
|
8075
|
+
fromEmail?: string | null;
|
|
8076
|
+
/** @description Transfer status (e.g. `"SUCCESS"`). */
|
|
8077
|
+
status: string;
|
|
8078
|
+
/** @description Wallet type credited on the destination side. */
|
|
8079
|
+
toAccountType: string;
|
|
8080
|
+
/** @description Destination sub-account email; absent when the destination is master. */
|
|
8081
|
+
toEmail?: string | null;
|
|
8082
|
+
/**
|
|
8083
|
+
* Format: int64
|
|
8084
|
+
* @description Transfer id. Matches the `tranId` returned by the original
|
|
8085
|
+
* [`UniversalTransferResponse`].
|
|
8086
|
+
*/
|
|
8087
|
+
tranId: number;
|
|
8088
|
+
};
|
|
8089
|
+
/**
|
|
8090
|
+
* @description Parameters for `GET /sapi/v1/sub-account/universalTransfer`.
|
|
8091
|
+
*
|
|
8092
|
+
* Lists universal transfers initiated by the master account. All filters
|
|
8093
|
+
* are optional; if `start_time`/`end_time` are omitted, Binance returns the
|
|
8094
|
+
* most recent 30 days. Binance does not support filtering by `tran_id`
|
|
8095
|
+
* directly — use `client_tran_id` if you set one when initiating the
|
|
8096
|
+
* transfer, or page through the result and match the `tranId` client-side.
|
|
8097
|
+
*/
|
|
8098
|
+
UniversalTransferHistoryRequest: {
|
|
8099
|
+
/** @description Filter by client-supplied transfer id. */
|
|
8100
|
+
clientTranId?: string | null;
|
|
8101
|
+
/**
|
|
8102
|
+
* Format: int64
|
|
8103
|
+
* @description Window end (ms since epoch).
|
|
8104
|
+
*/
|
|
8105
|
+
endTime?: number | null;
|
|
8106
|
+
/** @description Filter to transfers originating from this sub-account email. */
|
|
8107
|
+
fromEmail?: string | null;
|
|
8108
|
+
/**
|
|
8109
|
+
* Format: int32
|
|
8110
|
+
* @description Page size (Binance default: 500, max: 500).
|
|
8111
|
+
*/
|
|
8112
|
+
limit?: number | null;
|
|
8113
|
+
/**
|
|
8114
|
+
* Format: int32
|
|
8115
|
+
* @description 1-based page number (Binance default: 1).
|
|
8116
|
+
*/
|
|
8117
|
+
page?: number | null;
|
|
8118
|
+
/**
|
|
8119
|
+
* Format: int64
|
|
8120
|
+
* @description Window start (ms since epoch).
|
|
8121
|
+
*/
|
|
8122
|
+
startTime?: number | null;
|
|
8123
|
+
/** @description Filter to transfers destined for this sub-account email. */
|
|
8124
|
+
toEmail?: string | null;
|
|
8125
|
+
};
|
|
8126
|
+
/** @description Response for [`BinanceManager::universal_transfer_history`]. */
|
|
8127
|
+
UniversalTransferHistoryResponse: {
|
|
8128
|
+
/** @description Transfers in the current page. */
|
|
8129
|
+
result: components["schemas"]["UniversalTransferHistoryEntry"][];
|
|
8130
|
+
/**
|
|
8131
|
+
* Format: int64
|
|
8132
|
+
* @description Total number of transfers matching the filters across all pages.
|
|
8133
|
+
*/
|
|
8134
|
+
totalCount: number;
|
|
8135
|
+
};
|
|
8136
|
+
/**
|
|
8137
|
+
* @description Parameters for `POST /sapi/v1/sub-account/universalTransfer`.
|
|
8138
|
+
*
|
|
8139
|
+
* Transfers an asset between any two accounts (master to/from sub, or sub
|
|
8140
|
+
* to/from sub) and between any two wallet types (spot, futures, margin, etc).
|
|
8141
|
+
* The signing credential (the API key + Ed25519 key pair) must belong to the
|
|
8142
|
+
* master account.
|
|
8143
|
+
*/
|
|
8144
|
+
UniversalTransferRequest: {
|
|
8145
|
+
/** @description The amount being transferred, as a decimal string. */
|
|
8146
|
+
amount: string;
|
|
8147
|
+
/** @description The asset symbol being transferred (e.g. `"USDT"`). */
|
|
8148
|
+
asset: string;
|
|
8149
|
+
/**
|
|
8150
|
+
* @description Optional client-supplied transfer id. If set, Binance echoes it back
|
|
8151
|
+
* on [`UniversalTransferResponse::client_tran_id`] and lets it be used
|
|
8152
|
+
* as a filter on
|
|
8153
|
+
* [`UniversalTransferHistoryRequest::client_tran_id`].
|
|
8154
|
+
*/
|
|
8155
|
+
clientTranId?: string | null;
|
|
8156
|
+
fromAccountType?: components["schemas"]["AccountType"];
|
|
8157
|
+
/** @description Source sub-account email. If `None`, the source is the master account. */
|
|
8158
|
+
fromEmail?: string | null;
|
|
8159
|
+
toAccountType?: components["schemas"]["AccountType"];
|
|
8160
|
+
/** @description Destination sub-account email. If `None`, the destination is the master account. */
|
|
8161
|
+
toEmail?: string | null;
|
|
8162
|
+
};
|
|
8163
|
+
/** @description Response for [`BinanceManager::universal_transfer`]. */
|
|
8164
|
+
UniversalTransferResponse: {
|
|
8165
|
+
clientTranId?: string | null;
|
|
8166
|
+
/** Format: int64 */
|
|
8167
|
+
tranId: number;
|
|
8168
|
+
};
|
|
7620
8169
|
/** @description Options that should be set only for local devnet testing. */
|
|
7621
8170
|
UnsafeConf: {
|
|
7622
8171
|
/**
|
|
@@ -7645,6 +8194,8 @@ export interface components {
|
|
|
7645
8194
|
*/
|
|
7646
8195
|
validator_index: string;
|
|
7647
8196
|
} & {
|
|
8197
|
+
/** @description Do not produce a valid signature, just evaluate attached policies. */
|
|
8198
|
+
dry_run?: boolean;
|
|
7648
8199
|
/**
|
|
7649
8200
|
* @description Request additional information to be included in the response, explaining
|
|
7650
8201
|
* the outcome (i.e., permitted vs. denied vs. MFA required) of the sign request.
|
|
@@ -7719,6 +8270,14 @@ export interface components {
|
|
|
7719
8270
|
* Once disabled, a key cannot be used for signing.
|
|
7720
8271
|
*/
|
|
7721
8272
|
enabled?: boolean | null;
|
|
8273
|
+
/**
|
|
8274
|
+
* @description If set, patch the key's structured [`KeyProperties`]. The patch's variant must
|
|
8275
|
+
* match the key's [`KeyType`] (e.g. `BinanceApi` properties are only allowed on
|
|
8276
|
+
* `Ed25519BinanceApi` keys). Each field in the patch is independent: missing
|
|
8277
|
+
* means leave alone, JSON `null` clears, a value sets. Sending JSON `null` for
|
|
8278
|
+
* the whole field clears all properties on the key.
|
|
8279
|
+
*/
|
|
8280
|
+
properties?: unknown;
|
|
7722
8281
|
/**
|
|
7723
8282
|
* @description If set, change the key's region affinity to this value.
|
|
7724
8283
|
*
|
|
@@ -8377,6 +8936,179 @@ export interface components {
|
|
|
8377
8936
|
WhereAndWhen: components["schemas"]["SourceIp"] & {
|
|
8378
8937
|
time: components["schemas"]["EpochDateTime"];
|
|
8379
8938
|
};
|
|
8939
|
+
/** @description One withdrawal entry in [`WithdrawHistoryResponse`]. */
|
|
8940
|
+
WithdrawHistoryEntry: {
|
|
8941
|
+
/** @description Destination address. */
|
|
8942
|
+
address: string;
|
|
8943
|
+
/** @description Withdrawal amount, as a decimal string. */
|
|
8944
|
+
amount: string;
|
|
8945
|
+
/**
|
|
8946
|
+
* @description Time the withdrawal was requested (Binance returns a UTC string,
|
|
8947
|
+
* e.g. `"2019-09-24 12:43:45"`).
|
|
8948
|
+
*/
|
|
8949
|
+
applyTime: string;
|
|
8950
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
8951
|
+
coin: string;
|
|
8952
|
+
/**
|
|
8953
|
+
* @description Time the withdrawal completed (UTC string), present once
|
|
8954
|
+
* `status == 6`.
|
|
8955
|
+
*/
|
|
8956
|
+
completeTime?: string | null;
|
|
8957
|
+
/**
|
|
8958
|
+
* Format: int32
|
|
8959
|
+
* @description Number of on-chain confirmations.
|
|
8960
|
+
*/
|
|
8961
|
+
confirmNo?: number | null;
|
|
8962
|
+
/**
|
|
8963
|
+
* @description Binance-assigned withdrawal id. Matches the `id` returned by
|
|
8964
|
+
* [`WithdrawResponse`].
|
|
8965
|
+
*/
|
|
8966
|
+
id: string;
|
|
8967
|
+
/** @description Failure reason when the withdrawal was rejected. */
|
|
8968
|
+
info?: string | null;
|
|
8969
|
+
/** @description Blockchain network identifier (e.g. `"BSC"`, `"ETH"`). */
|
|
8970
|
+
network?: string | null;
|
|
8971
|
+
/**
|
|
8972
|
+
* Format: int32
|
|
8973
|
+
* @description Withdrawal status. Binance values: `0` = Email Sent,
|
|
8974
|
+
* `2` = Awaiting Approval, `3` = Rejected, `4` = Processing,
|
|
8975
|
+
* `6` = Completed. Left as `u8` for forward compatibility.
|
|
8976
|
+
*/
|
|
8977
|
+
status: number;
|
|
8978
|
+
/** @description Network fee charged for the withdrawal, as a decimal string. */
|
|
8979
|
+
transactionFee: string;
|
|
8980
|
+
/**
|
|
8981
|
+
* Format: int32
|
|
8982
|
+
* @description `0` = external transfer, `1` = internal (Binance↔Binance) transfer.
|
|
8983
|
+
*/
|
|
8984
|
+
transferType: number;
|
|
8985
|
+
/**
|
|
8986
|
+
* @description On-chain transaction hash, once Binance has broadcast the withdrawal.
|
|
8987
|
+
* May be empty until then.
|
|
8988
|
+
*/
|
|
8989
|
+
txId?: string | null;
|
|
8990
|
+
/**
|
|
8991
|
+
* Format: int32
|
|
8992
|
+
* @description Source wallet: `0` = spot wallet, `1` = funding wallet.
|
|
8993
|
+
*/
|
|
8994
|
+
walletType: number;
|
|
8995
|
+
/**
|
|
8996
|
+
* @description Client-supplied withdrawal id, if one was set on the original
|
|
8997
|
+
* withdrawal call.
|
|
8998
|
+
*/
|
|
8999
|
+
withdrawOrderId?: string | null;
|
|
9000
|
+
};
|
|
9001
|
+
/**
|
|
9002
|
+
* @description Parameters for `GET /sapi/v1/capital/withdraw/history`.
|
|
9003
|
+
*
|
|
9004
|
+
* Returns the master account's withdrawal history. All filters are
|
|
9005
|
+
* optional; if `start_time`/`end_time` are omitted, Binance returns the
|
|
9006
|
+
* most recent 90 days. Use `id_list` to look up specific withdrawals by
|
|
9007
|
+
* the `id` returned from [`BinanceRpc::Withdraw`], or `withdraw_order_id`
|
|
9008
|
+
* to look one up by its client-supplied id.
|
|
9009
|
+
*/
|
|
9010
|
+
WithdrawHistoryRequest: {
|
|
9011
|
+
/** @description Filter to a specific asset (e.g. `"USDT"`). */
|
|
9012
|
+
coin?: string | null;
|
|
9013
|
+
/**
|
|
9014
|
+
* Format: int64
|
|
9015
|
+
* @description Window end (ms since epoch).
|
|
9016
|
+
*/
|
|
9017
|
+
endTime?: number | null;
|
|
9018
|
+
/**
|
|
9019
|
+
* @description Comma-separated list of Binance-assigned withdrawal ids (the `id`
|
|
9020
|
+
* field of [`WithdrawResponse`]). Up to 45 ids per query, per Binance.
|
|
9021
|
+
*/
|
|
9022
|
+
idList?: string | null;
|
|
9023
|
+
/**
|
|
9024
|
+
* Format: int32
|
|
9025
|
+
* @description Page size (Binance default and max: 1000).
|
|
9026
|
+
*/
|
|
9027
|
+
limit?: number | null;
|
|
9028
|
+
/**
|
|
9029
|
+
* Format: int32
|
|
9030
|
+
* @description Pagination offset.
|
|
9031
|
+
*/
|
|
9032
|
+
offset?: number | null;
|
|
9033
|
+
/**
|
|
9034
|
+
* Format: int64
|
|
9035
|
+
* @description Window start (ms since epoch).
|
|
9036
|
+
*/
|
|
9037
|
+
startTime?: number | null;
|
|
9038
|
+
/**
|
|
9039
|
+
* Format: int32
|
|
9040
|
+
* @description Filter by withdrawal status. Binance values:
|
|
9041
|
+
* `0` = Email Sent, `2` = Awaiting Approval, `3` = Rejected,
|
|
9042
|
+
* `4` = Processing, `6` = Completed. Left as `u8` for forward
|
|
9043
|
+
* compatibility.
|
|
9044
|
+
*/
|
|
9045
|
+
status?: number | null;
|
|
9046
|
+
/**
|
|
9047
|
+
* @description Filter by the client-supplied withdrawal id originally passed to
|
|
9048
|
+
* [`WithdrawRequest::withdraw_order_id`].
|
|
9049
|
+
*/
|
|
9050
|
+
withdrawOrderId?: string | null;
|
|
9051
|
+
};
|
|
9052
|
+
/**
|
|
9053
|
+
* @description Response for [`BinanceManager::withdraw_history`].
|
|
9054
|
+
*
|
|
9055
|
+
* Binance returns a top-level JSON array; this newtype preserves that wire
|
|
9056
|
+
* format while giving the response a named type in the OpenAPI schema.
|
|
9057
|
+
*/
|
|
9058
|
+
WithdrawHistoryResponse: components["schemas"]["WithdrawHistoryEntry"][];
|
|
9059
|
+
/**
|
|
9060
|
+
* @description Parameters for `POST /sapi/v1/capital/withdraw/apply`.
|
|
9061
|
+
*
|
|
9062
|
+
* Submits a withdrawal of `amount` of `coin` to the given external `address`.
|
|
9063
|
+
* The signing key's account must have withdrawal permissions enabled.
|
|
9064
|
+
*/
|
|
9065
|
+
WithdrawRequest: {
|
|
9066
|
+
/** @description Destination address. */
|
|
9067
|
+
address: string;
|
|
9068
|
+
/**
|
|
9069
|
+
* @description Secondary address identifier required by some assets (e.g. memo for
|
|
9070
|
+
* XRP, tag for XLM).
|
|
9071
|
+
*/
|
|
9072
|
+
addressTag?: string | null;
|
|
9073
|
+
/**
|
|
9074
|
+
* @description The amount being withdrawn, formatted as a decimal string (e.g. `"0.1"`).
|
|
9075
|
+
* Sent verbatim: Binance is strict about decimal formatting.
|
|
9076
|
+
*/
|
|
9077
|
+
amount: string;
|
|
9078
|
+
/** @description The asset symbol being withdrawn (e.g. `"USDT"`, `"BTC"`). */
|
|
9079
|
+
coin: string;
|
|
9080
|
+
/** @description Optional human-readable description for the withdrawal. */
|
|
9081
|
+
name?: string | null;
|
|
9082
|
+
/**
|
|
9083
|
+
* @description Network identifier (e.g. `"BSC"`, `"ETH"`). If omitted, Binance picks
|
|
9084
|
+
* the default network for the asset.
|
|
9085
|
+
*/
|
|
9086
|
+
network?: string | null;
|
|
9087
|
+
/**
|
|
9088
|
+
* @description If `true`, the withdrawal fee is deducted from the destination amount;
|
|
9089
|
+
* if `false` (Binance default), it is deducted from the account balance
|
|
9090
|
+
* in addition to `amount`.
|
|
9091
|
+
*/
|
|
9092
|
+
transactionFeeFlag?: boolean | null;
|
|
9093
|
+
/**
|
|
9094
|
+
* Format: int32
|
|
9095
|
+
* @description Source wallet: `0` = spot wallet (default), `1` = funding wallet.
|
|
9096
|
+
*/
|
|
9097
|
+
walletType?: number | null;
|
|
9098
|
+
/**
|
|
9099
|
+
* @description Client-supplied withdrawal id, returned by Binance as `withdrawOrderId`
|
|
9100
|
+
* in subsequent withdrawal-history queries.
|
|
9101
|
+
*/
|
|
9102
|
+
withdrawOrderId?: string | null;
|
|
9103
|
+
};
|
|
9104
|
+
/** @description Response for [`BinanceManager::withdraw`]. */
|
|
9105
|
+
WithdrawResponse: {
|
|
9106
|
+
/**
|
|
9107
|
+
* @description Binance-assigned withdrawal id. Used to look the request up later via
|
|
9108
|
+
* the withdrawal-history endpoint.
|
|
9109
|
+
*/
|
|
9110
|
+
id: string;
|
|
9111
|
+
};
|
|
8380
9112
|
};
|
|
8381
9113
|
responses: {
|
|
8382
9114
|
AddThirdPartyUserResponse: {
|
|
@@ -8958,6 +9690,7 @@ export interface components {
|
|
|
8958
9690
|
* ]
|
|
8959
9691
|
*/
|
|
8960
9692
|
policy: unknown[];
|
|
9693
|
+
properties?: components["schemas"]["KeyPropertiesPatch"] | null;
|
|
8961
9694
|
/** @description The key provenance. */
|
|
8962
9695
|
provenance?: string | null;
|
|
8963
9696
|
/**
|
|
@@ -15567,6 +16300,11 @@ export interface operations {
|
|
|
15567
16300
|
user_id: string;
|
|
15568
16301
|
};
|
|
15569
16302
|
};
|
|
16303
|
+
requestBody: {
|
|
16304
|
+
content: {
|
|
16305
|
+
"application/json": components["schemas"]["Empty"];
|
|
16306
|
+
};
|
|
16307
|
+
};
|
|
15570
16308
|
responses: {
|
|
15571
16309
|
200: components["responses"]["EmptyImpl"];
|
|
15572
16310
|
default: {
|