@binance/common 2.0.1 → 2.1.1

package/dist/index.mjs

@@ -46,8 +46,8 @@ var RequestSigner = class {
 		}
 		throw new Error("Either 'apiSecret' or 'privateKey' must be provided for signed requests.");
 	}
-	sign(queryParams) {
-		const params = buildQueryString(queryParams);
+	sign(queryParams, bodyParams) {
+		const params = buildQueryString(queryParams) + (bodyParams ? buildQueryString(bodyParams) : "");
 		if (this.apiSecret) return crypto.createHmac("sha256", this.apiSecret).update(params).digest("hex");
 		if (this.keyObject && this.keyType) {
 			const data = Buffer.from(params);
@@ -112,6 +112,42 @@ function randomString() {
 	return crypto.randomBytes(16).toString("hex");
 }
 /**
+* Generates a cryptographically secure random 32-bit unsigned integer.
+*
+* Uses the Web Crypto API to generate a random value between 0 and 4,294,967,295 (2^32 - 1).
+*
+* @returns A random 32-bit unsigned integer.
+*/
+function randomInteger() {
+	const array = new Uint32Array(1);
+	crypto.getRandomValues(array);
+	return array[0];
+}
+/**
+* Normalizes a stream ID to ensure it is valid, generating a random ID if needed.
+*
+* For string inputs:
+* - Returns the input if it's a valid 32-character hexadecimal string (case-insensitive)
+* - Otherwise, generates a new random hexadecimal string using `randomString()`
+*
+* For number inputs:
+* - Returns the input if it's a finite, non-negative integer within the safe integer range
+* - Otherwise, generates a new random integer using `randomInteger()`
+*
+* For null or undefined inputs:
+* - Generates a new random hexadecimal string using `randomString()`
+*
+* @param id - The stream ID to normalize (string, number, null, or undefined).
+* @param streamIdIsStrictlyNumber - Boolean forcing an id to be a number or not.
+* @returns A valid stream ID as either a 32-character hexadecimal string or a safe integer.
+*/
+function normalizeStreamId(id, streamIdIsStrictlyNumber) {
+	const isValidNumber = typeof id === "number" && Number.isFinite(id) && Number.isInteger(id) && id >= 0 && id <= Number.MAX_SAFE_INTEGER;
+	if (streamIdIsStrictlyNumber || typeof id === "number") return isValidNumber ? id : randomInteger();
+	if (typeof id === "string") return id && /^[0-9a-f]{32}$/i.test(id) ? id : randomString();
+	return randomString();
+}
+/**
 * Validates the provided time unit string and returns it if it is either 'MILLISECOND' or 'MICROSECOND'.
 *
 * @param timeUnit - The time unit string to be validated.
@@ -147,13 +183,13 @@ function getTimestamp() {
 * @param queryParams - The query parameters to be signed.
 * @returns A string representing the generated signature.
 */
-const getSignature = function(configuration, queryParams) {
+const getSignature = function(configuration, queryParams, bodyParams) {
 	let signer = signerCache.get(configuration);
 	if (!signer) {
 		signer = new RequestSigner(configuration);
 		signerCache.set(configuration, signer);
 	}
-	return signer.sign(queryParams);
+	return signer.sign(queryParams, bodyParams);
 };
 /**
 * Asserts that a function parameter exists and is not null or undefined.
@@ -397,19 +433,33 @@ const parseRateLimitHeaders = function(headers) {
 * @param options - Additional request options (isSigned).
 * @returns A promise resolving to the response data object.
 */
-const sendRequest = function(configuration, endpoint, method, params = {}, timeUnit, options = {}) {
+const sendRequest = function(configuration, endpoint, method, queryParams = {}, bodyParams = {}, timeUnit, options = {}) {
 	const localVarUrlObj = new URL(endpoint, configuration?.basePath);
 	const localVarRequestOptions = {
 		method,
 		...configuration?.baseOptions
 	};
-	const localVarQueryParameter = { ...normalizeScientificNumbers(params) };
+	const localVarQueryParameter = { ...normalizeScientificNumbers(queryParams) };
+	const localVarBodyParameter = { ...normalizeScientificNumbers(bodyParams) };
 	if (options.isSigned) {
 		localVarQueryParameter["timestamp"] = getTimestamp();
-		const signature = getSignature(configuration, localVarQueryParameter);
+		const signature = getSignature(configuration, localVarQueryParameter, localVarBodyParameter);
 		if (signature) localVarQueryParameter["signature"] = signature;
 	}
 	setSearchParams(localVarUrlObj, localVarQueryParameter);
+	if (Object.keys(localVarBodyParameter).length > 0) {
+		const searchParams = new URLSearchParams();
+		for (const [key, value] of Object.entries(localVarBodyParameter)) {
+			if (value === null || value === void 0) continue;
+			const serializedValue = serializeValue(value);
+			searchParams.append(key, serializedValue);
+		}
+		localVarRequestOptions.data = searchParams.toString();
+		localVarRequestOptions.headers = {
+			...localVarRequestOptions.headers || {},
+			"Content-Type": "application/x-www-form-urlencoded"
+		};
+	}
 	if (timeUnit && localVarRequestOptions.headers) {
 		const _timeUnit = validateTimeUnit(timeUnit);
 		localVarRequestOptions.headers = {
@@ -1404,6 +1454,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 	constructor(configuration, connectionPool = []) {
 		super(configuration, connectionPool);
 		this.streamConnectionMap = /* @__PURE__ */ new Map();
+		this.streamIdIsStrictlyNumber = false;
 		this.streamCallbackMap = /* @__PURE__ */ new Map();
 		this.logger = Logger.getInstance();
 		this.configuration = configuration;
@@ -1463,7 +1514,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 		const payload = {
 			method: "SUBSCRIBE",
 			params: streams,
-			id: id && /^[0-9a-f]{32}$/.test(id) ? id : randomString()
+			id: normalizeStreamId(id, this.streamIdIsStrictlyNumber)
 		};
 		this.logger.debug("SUBSCRIBE", payload);
 		this.send(JSON.stringify(payload), void 0, false, 0, connection);
@@ -1570,7 +1621,7 @@ var WebsocketStreamsBase = class extends WebsocketCommon {
 				const payload = {
 					method: "UNSUBSCRIBE",
 					params: [stream$1],
-					id: id && /^[0-9a-f]{32}$/.test(id) ? id : randomString()
+					id: normalizeStreamId(id, this.streamIdIsStrictlyNumber)
 				};
 				this.logger.debug("UNSUBSCRIBE", payload);
 				this.send(JSON.stringify(payload), void 0, false, 0, connection);
@@ -1621,5 +1672,5 @@ function createStreamHandler(websocketBase, streamOrId, id) {
 }
 
 //#endregion
-export { ALGO_REST_API_PROD_URL, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequiredError, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketCommon, WebsocketEventEmitter, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, parseCustomHeaders, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequiredError, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketCommon, WebsocketEventEmitter, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
 //# sourceMappingURL=index.mjs.map