@binance/mining 1.0.0 → 1.0.1

package/README.md

@@ -139,21 +139,6 @@ The REST API provides detailed error types to help you handle issues effectively
 
 See the [Error Handling example](./docs/rest-api/error-handling.md) for detailed usage.
 
-#### Testnet
-
-For testing purposes, `/sapi/v1/mining/*` endpoints can be used in the [Testnet](https://testnet.binance.vision/). Update the `basePath` in your configuration:
-
-```typescript
-import { Mining, MiningRestAPI, MINING_REST_API_TESTNET_URL } from '@binance/mining';
-
-const configurationRestAPI = {
-    apiKey: 'your-api-key',
-    apiSecret: 'your-api-secret',
-    basePath: MINING_REST_API_TESTNET_URL,
-};
-const client = new Mining({ configurationRestAPI });
-```
-
 If `basePath` is not provided, it defaults to `https://api.binance.com`.
 
 ## Testing

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
-export { BadRequestError, ConnectorClientError, ForbiddenError, MINING_REST_API_PROD_URL, MINING_REST_API_TESTNET_URL, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
+export { BadRequestError, ConnectorClientError, ForbiddenError, MINING_REST_API_PROD_URL, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -40,9 +40,9 @@ interface AccountListResponseDataInnerListInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -79,9 +79,9 @@ interface AccountListResponseDataInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -118,9 +118,9 @@ interface AccountListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -162,9 +162,9 @@ interface AcquiringAlgorithmResponseDataInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -201,9 +201,9 @@ interface AcquiringAlgorithmResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -251,9 +251,9 @@ interface AcquiringCoinnameResponseDataInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -290,9 +290,9 @@ interface AcquiringCoinnameResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -322,9 +322,9 @@ interface BadRequest {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -360,9 +360,9 @@ interface CancelHashrateResaleConfigurationResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -428,9 +428,9 @@ interface EarningsListResponseDataAccountProfitsInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -467,9 +467,9 @@ interface EarningsListResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -506,9 +506,9 @@ interface EarningsListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -556,9 +556,9 @@ interface ExtraBonusListResponseDataOtherProfitsInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -595,9 +595,9 @@ interface ExtraBonusListResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -634,9 +634,9 @@ interface ExtraBonusListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -696,9 +696,9 @@ interface HashrateResaleDetailResponseDataProfitTransferDetailsInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -735,9 +735,9 @@ interface HashrateResaleDetailResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -774,9 +774,9 @@ interface HashrateResaleDetailResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -842,9 +842,9 @@ interface HashrateResaleListResponseDataConfigDetailsInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -881,9 +881,9 @@ interface HashrateResaleListResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -920,9 +920,9 @@ interface HashrateResaleListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -958,9 +958,9 @@ interface HashrateResaleRequestResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1014,9 +1014,9 @@ interface MiningAccountEarningResponseDataAccountProfitsInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1053,9 +1053,9 @@ interface MiningAccountEarningResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1092,9 +1092,9 @@ interface MiningAccountEarningResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1130,9 +1130,9 @@ interface RequestForDetailMinerListResponseDataInnerHashrateDatasInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1169,9 +1169,9 @@ interface RequestForDetailMinerListResponseDataInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1208,9 +1208,9 @@ interface RequestForDetailMinerListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1270,9 +1270,9 @@ interface RequestForMinerListResponseDataWorkerDatasInner {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1309,9 +1309,9 @@ interface RequestForMinerListResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1348,9 +1348,9 @@ interface RequestForMinerListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1386,9 +1386,9 @@ interface StatisticListResponseDataProfitToday {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1461,9 +1461,9 @@ interface StatisticListResponseData {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -1500,9 +1500,9 @@ interface StatisticListResponse {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -2256,9 +2256,9 @@ declare class MiningApi implements MiningApiInterface {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -2446,9 +2446,9 @@ declare class RestAPI {
 }
 
 /**
- * Binance Public Mining REST API
+ * Binance Mining REST API
  *
- * OpenAPI Specification for the Binance Public Mining REST API
+ * OpenAPI Specification for the Binance Mining REST API
  *
  * The version of the OpenAPI document: 1.0.0
  *
@@ -2509,56 +2509,7 @@ type index_StatisticListResponse = StatisticListResponse;
 type index_StatisticListResponseData = StatisticListResponseData;
 type index_StatisticListResponseDataProfitToday = StatisticListResponseDataProfitToday;
 declare namespace index {
-  export {
-    index_AccountListRequest as AccountListRequest,
-    index_AccountListResponse as AccountListResponse,
-    index_AccountListResponseDataInner as AccountListResponseDataInner,
-    index_AccountListResponseDataInnerListInner as AccountListResponseDataInnerListInner,
-    index_AcquiringAlgorithmResponse as AcquiringAlgorithmResponse,
-    index_AcquiringAlgorithmResponseDataInner as AcquiringAlgorithmResponseDataInner,
-    index_AcquiringCoinnameResponse as AcquiringCoinnameResponse,
-    index_AcquiringCoinnameResponseDataInner as AcquiringCoinnameResponseDataInner,
-    index_BadRequest as BadRequest,
-    index_CancelHashrateResaleConfigurationRequest as CancelHashrateResaleConfigurationRequest,
-    index_CancelHashrateResaleConfigurationResponse as CancelHashrateResaleConfigurationResponse,
-    index_EarningsListRequest as EarningsListRequest,
-    index_EarningsListResponse as EarningsListResponse,
-    index_EarningsListResponseData as EarningsListResponseData,
-    index_EarningsListResponseDataAccountProfitsInner as EarningsListResponseDataAccountProfitsInner,
-    index_ExtraBonusListRequest as ExtraBonusListRequest,
-    index_ExtraBonusListResponse as ExtraBonusListResponse,
-    index_ExtraBonusListResponseData as ExtraBonusListResponseData,
-    index_ExtraBonusListResponseDataOtherProfitsInner as ExtraBonusListResponseDataOtherProfitsInner,
-    index_HashrateResaleDetailRequest as HashrateResaleDetailRequest,
-    index_HashrateResaleDetailResponse as HashrateResaleDetailResponse,
-    index_HashrateResaleDetailResponseData as HashrateResaleDetailResponseData,
-    index_HashrateResaleDetailResponseDataProfitTransferDetailsInner as HashrateResaleDetailResponseDataProfitTransferDetailsInner,
-    index_HashrateResaleListRequest as HashrateResaleListRequest,
-    index_HashrateResaleListResponse as HashrateResaleListResponse,
-    index_HashrateResaleListResponseData as HashrateResaleListResponseData,
-    index_HashrateResaleListResponseDataConfigDetailsInner as HashrateResaleListResponseDataConfigDetailsInner,
-    index_HashrateResaleRequestRequest as HashrateResaleRequestRequest,
-    index_HashrateResaleRequestResponse as HashrateResaleRequestResponse,
-    index_MiningAccountEarningRequest as MiningAccountEarningRequest,
-    index_MiningAccountEarningResponse as MiningAccountEarningResponse,
-    index_MiningAccountEarningResponseData as MiningAccountEarningResponseData,
-    index_MiningAccountEarningResponseDataAccountProfitsInner as MiningAccountEarningResponseDataAccountProfitsInner,
-    index_MiningApi as MiningApi,
-    index_MiningApiInterface as MiningApiInterface,
-    index_RequestForDetailMinerListRequest as RequestForDetailMinerListRequest,
-    index_RequestForDetailMinerListResponse as RequestForDetailMinerListResponse,
-    index_RequestForDetailMinerListResponseDataInner as RequestForDetailMinerListResponseDataInner,
-    index_RequestForDetailMinerListResponseDataInnerHashrateDatasInner as RequestForDetailMinerListResponseDataInnerHashrateDatasInner,
-    index_RequestForMinerListRequest as RequestForMinerListRequest,
-    index_RequestForMinerListResponse as RequestForMinerListResponse,
-    index_RequestForMinerListResponseData as RequestForMinerListResponseData,
-    index_RequestForMinerListResponseDataWorkerDatasInner as RequestForMinerListResponseDataWorkerDatasInner,
-    index_RestAPI as RestAPI,
-    index_StatisticListRequest as StatisticListRequest,
-    index_StatisticListResponse as StatisticListResponse,
-    index_StatisticListResponseData as StatisticListResponseData,
-    index_StatisticListResponseDataProfitToday as StatisticListResponseDataProfitToday,
-  };
+  export { type index_AccountListRequest as AccountListRequest, type index_AccountListResponse as AccountListResponse, type index_AccountListResponseDataInner as AccountListResponseDataInner, type index_AccountListResponseDataInnerListInner as AccountListResponseDataInnerListInner, type index_AcquiringAlgorithmResponse as AcquiringAlgorithmResponse, type index_AcquiringAlgorithmResponseDataInner as AcquiringAlgorithmResponseDataInner, type index_AcquiringCoinnameResponse as AcquiringCoinnameResponse, type index_AcquiringCoinnameResponseDataInner as AcquiringCoinnameResponseDataInner, type index_BadRequest as BadRequest, type index_CancelHashrateResaleConfigurationRequest as CancelHashrateResaleConfigurationRequest, type index_CancelHashrateResaleConfigurationResponse as CancelHashrateResaleConfigurationResponse, type index_EarningsListRequest as EarningsListRequest, type index_EarningsListResponse as EarningsListResponse, type index_EarningsListResponseData as EarningsListResponseData, type index_EarningsListResponseDataAccountProfitsInner as EarningsListResponseDataAccountProfitsInner, type index_ExtraBonusListRequest as ExtraBonusListRequest, type index_ExtraBonusListResponse as ExtraBonusListResponse, type index_ExtraBonusListResponseData as ExtraBonusListResponseData, type index_ExtraBonusListResponseDataOtherProfitsInner as ExtraBonusListResponseDataOtherProfitsInner, type index_HashrateResaleDetailRequest as HashrateResaleDetailRequest, type index_HashrateResaleDetailResponse as HashrateResaleDetailResponse, type index_HashrateResaleDetailResponseData as HashrateResaleDetailResponseData, type index_HashrateResaleDetailResponseDataProfitTransferDetailsInner as HashrateResaleDetailResponseDataProfitTransferDetailsInner, type index_HashrateResaleListRequest as HashrateResaleListRequest, type index_HashrateResaleListResponse as HashrateResaleListResponse, type index_HashrateResaleListResponseData as HashrateResaleListResponseData, type index_HashrateResaleListResponseDataConfigDetailsInner as HashrateResaleListResponseDataConfigDetailsInner, type index_HashrateResaleRequestRequest as HashrateResaleRequestRequest, type index_HashrateResaleRequestResponse as HashrateResaleRequestResponse, type index_MiningAccountEarningRequest as MiningAccountEarningRequest, type index_MiningAccountEarningResponse as MiningAccountEarningResponse, type index_MiningAccountEarningResponseData as MiningAccountEarningResponseData, type index_MiningAccountEarningResponseDataAccountProfitsInner as MiningAccountEarningResponseDataAccountProfitsInner, index_MiningApi as MiningApi, type index_MiningApiInterface as MiningApiInterface, type index_RequestForDetailMinerListRequest as RequestForDetailMinerListRequest, type index_RequestForDetailMinerListResponse as RequestForDetailMinerListResponse, type index_RequestForDetailMinerListResponseDataInner as RequestForDetailMinerListResponseDataInner, type index_RequestForDetailMinerListResponseDataInnerHashrateDatasInner as RequestForDetailMinerListResponseDataInnerHashrateDatasInner, type index_RequestForMinerListRequest as RequestForMinerListRequest, type index_RequestForMinerListResponse as RequestForMinerListResponse, type index_RequestForMinerListResponseData as RequestForMinerListResponseData, type index_RequestForMinerListResponseDataWorkerDatasInner as RequestForMinerListResponseDataWorkerDatasInner, index_RestAPI as RestAPI, type index_StatisticListRequest as StatisticListRequest, type index_StatisticListResponse as StatisticListResponse, type index_StatisticListResponseData as StatisticListResponseData, type index_StatisticListResponseDataProfitToday as StatisticListResponseDataProfitToday };
 }
 
 interface ConfigurationMining {
@@ -2569,4 +2520,4 @@ declare class Mining {
     constructor(config: ConfigurationMining);
 }
 
-export { ConfigurationMining, Mining, index as MiningRestAPI };
+export { type ConfigurationMining, Mining, index as MiningRestAPI };