@satrush/api 0.1.15 → 0.1.16

package/dist/index.cjs

@@ -33,6 +33,7 @@ __export(index_exports, {
   ClaimTypeDto: () => ClaimTypeDto,
   EpochStateDto: () => EpochStateDto,
   HashrateActionTypeDto: () => HashrateActionTypeDto,
+  LeaderboardSortDto: () => LeaderboardSortDto,
   NotificationEntity: () => NotificationEntity,
   OneBtcStateDto: () => OneBtcStateDto,
   RoundHistoryStateDto: () => RoundHistoryStateDto,
@@ -86,6 +87,8 @@ __export(index_exports, {
   zGetEpochWinnersResponse: () => zGetEpochWinnersResponse,
   zGetHashrateEarnedLeaderboardData: () => zGetHashrateEarnedLeaderboardData,
   zGetHashrateEarnedLeaderboardResponse: () => zGetHashrateEarnedLeaderboardResponse,
+  zGetLeaderboardData: () => zGetLeaderboardData,
+  zGetLeaderboardResponse: () => zGetLeaderboardResponse,
   zGetOneBtcHistoryData: () => zGetOneBtcHistoryData,
   zGetOneBtcHistoryResponse: () => zGetOneBtcHistoryResponse,
   zGetOneBtcIterationData: () => zGetOneBtcIterationData,
@@ -112,11 +115,17 @@ __export(index_exports, {
   zGetUserOneBtcEntriesResponse: () => zGetUserOneBtcEntriesResponse,
   zGetUserProfileData: () => zGetUserProfileData,
   zGetUserProfileResponse: () => zGetUserProfileResponse,
+  zGetWalletLeaderboardData: () => zGetWalletLeaderboardData,
+  zGetWalletLeaderboardResponse: () => zGetWalletLeaderboardResponse,
   zHashrateActionTypeDto: () => zHashrateActionTypeDto,
   zI128Dto: () => zI128Dto,
   zI64Dto: () => zI64Dto,
   zInternalErrorCodeErrorBody: () => zInternalErrorCodeErrorBody,
   zLeaderboardEntryDto: () => zLeaderboardEntryDto,
+  zLeaderboardPageDto: () => zLeaderboardPageDto,
+  zLeaderboardPageEntryDto: () => zLeaderboardPageEntryDto,
+  zLeaderboardRanksDto: () => zLeaderboardRanksDto,
+  zLeaderboardSortDto: () => zLeaderboardSortDto,
   zMinerClaimDto: () => zMinerClaimDto,
   zMinerDeploymentDto: () => zMinerDeploymentDto,
   zMinerDto: () => zMinerDto,
@@ -195,7 +204,11 @@ __export(index_exports, {
   zUserVaultEntriesApiError400InvalidWinsOnly: () => zUserVaultEntriesApiError400InvalidWinsOnly,
   zUserVaultEntriesApiError500Error: () => zUserVaultEntriesApiError500Error,
   zValidationErrorCodeErrorBody: () => zValidationErrorCodeErrorBody,
-  zValidationErrorCodeValidationDetailsErrorBody: () => zValidationErrorCodeValidationDetailsErrorBody
+  zValidationErrorCodeValidationDetailsErrorBody: () => zValidationErrorCodeValidationDetailsErrorBody,
+  zWalletLeaderboardApiError400Error: () => zWalletLeaderboardApiError400Error,
+  zWalletLeaderboardApiError400InvalidAddress: () => zWalletLeaderboardApiError400InvalidAddress,
+  zWalletLeaderboardApiError404Error: () => zWalletLeaderboardApiError404Error,
+  zWalletLeaderboardDto: () => zWalletLeaderboardDto
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1353,6 +1366,21 @@ var getEpochWinnersResponseTransformer = async (data) => {
   data.data = data.data.map((item) => epochWinnerHistoryDtoSchemaResponseTransformer(item));
   return data;
 };
+var leaderboardPageEntryDtoSchemaResponseTransformer = (data) => {
+  data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
+  data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
+  data.totalUsdDeployed = u64DtoSchemaResponseTransformer(data.totalUsdDeployed);
+  return data;
+};
+var leaderboardPageDtoSchemaResponseTransformer = (data) => {
+  data.entries = data.entries.map((item) => leaderboardPageEntryDtoSchemaResponseTransformer(item));
+  data.updatedAt = new Date(data.updatedAt);
+  return data;
+};
+var getLeaderboardResponseTransformer = async (data) => {
+  data.data = leaderboardPageDtoSchemaResponseTransformer(data.data);
+  return data;
+};
 var leaderboardEntryDtoSchemaResponseTransformer = (data) => {
   data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
   data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
@@ -1371,6 +1399,17 @@ var getSatsEarnedLeaderboardResponseTransformer = async (data) => {
   data.data = data.data.map((item) => leaderboardEntryDtoSchemaResponseTransformer(item));
   return data;
 };
+var walletLeaderboardDtoSchemaResponseTransformer = (data) => {
+  data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
+  data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
+  data.totalUsdDeployed = u64DtoSchemaResponseTransformer(data.totalUsdDeployed);
+  data.updatedAt = new Date(data.updatedAt);
+  return data;
+};
+var getWalletLeaderboardResponseTransformer = async (data) => {
+  data.data = walletLeaderboardDtoSchemaResponseTransformer(data.data);
+  return data;
+};
 var oneBtcIterationHistoryDtoSchemaResponseTransformer = (data) => {
   if (data.endedAt) {
     data.endedAt = new Date(data.endedAt);
@@ -1811,6 +1850,22 @@ var zI64Dto = z.coerce.bigint().min(BigInt("-9223372036854775808"), { error: "In
 var zInternalErrorCodeErrorBody = z.object({
   code: z.enum(["internal_error"])
 });
+var zLeaderboardRanksDto = z.object({
+  deployed: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  hashrate: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  rounds: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  satsEarned: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  score: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  streak: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })
+});
+var zLeaderboardSortDto = z.enum([
+  "score",
+  "deployed",
+  "rounds",
+  "sats_earned",
+  "hashrate",
+  "streak"
+]);
 var zNotificationEntity = z.enum(["state_snapshot"]);
 var zOneBtcHistoryApiError400InvalidRange = z.object({
   code: z.enum(["invalid_range"])
@@ -2108,6 +2163,22 @@ var zLeaderboardEntryDto = z.object({
   totalSatsEarned: zU64Dto,
   totalUsdDeployed: zU64Dto
 });
+var zLeaderboardPageEntryDto = z.object({
+  authority: zPubkeyDto,
+  daysActive: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  maxStreak: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  rank: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  score: z.number(),
+  totalHashrateEarned: zU64Dto,
+  totalRoundsPlayed: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  totalSatsEarned: zU64Dto,
+  totalUsdDeployed: zU64Dto
+});
+var zLeaderboardPageDto = z.object({
+  entries: z.array(zLeaderboardPageEntryDto),
+  total: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  updatedAt: z.preprocess((value) => value instanceof Date ? value.toISOString() : value, z.iso.datetime())
+});
 var zMinerClaimDto = z.object({
   authority: zPubkeyDto,
   btcReceived: z.optional(z.union([
@@ -2863,6 +2934,36 @@ var zValidationErrorCodeValidationDetailsErrorBody = z.object({
     errors: z.array(zFieldError)
   }))
 });
+var zWalletLeaderboardApiError400InvalidAddress = z.object({
+  code: z.enum(["invalid_address"])
+});
+var zWalletLeaderboardApiError400Error = z.union([
+  z.object({
+    code: z.literal("invalid_address")
+  }).and(zWalletLeaderboardApiError400InvalidAddress),
+  z.object({
+    code: z.union([
+      z.literal("invalid_body"),
+      z.literal("invalid_path"),
+      z.literal("invalid_query")
+    ])
+  }).and(zBadRequestErrorCodeErrorBody)
+]);
+var zWalletLeaderboardApiError404Error = z.object({
+  code: z.enum(["not_found"])
+});
+var zWalletLeaderboardDto = z.object({
+  authority: zPubkeyDto,
+  daysActive: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  maxStreak: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  ranks: zLeaderboardRanksDto,
+  score: z.number(),
+  totalHashrateEarned: zU64Dto,
+  totalRoundsPlayed: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  totalSatsEarned: zU64Dto,
+  totalUsdDeployed: zU64Dto,
+  updatedAt: z.preprocess((value) => value instanceof Date ? value.toISOString() : value, z.iso.datetime())
+});
 var zGetBoardData = z.object({
   body: z.optional(z.never()),
   path: z.optional(z.never()),
@@ -2927,6 +3028,18 @@ var zGetEpochWinnersData = z.object({
 var zGetEpochWinnersResponse = z.object({
   data: z.array(zEpochWinnerHistoryDto)
 });
+var zGetLeaderboardData = z.object({
+  body: z.optional(z.never()),
+  path: z.optional(z.never()),
+  query: z.optional(z.object({
+    sort: z.optional(zLeaderboardSortDto),
+    offset: z.optional(z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
+    limit: z.optional(z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }))
+  }))
+});
+var zGetLeaderboardResponse = z.object({
+  data: zLeaderboardPageDto
+});
 var zGetHashrateEarnedLeaderboardData = z.object({
   body: z.optional(z.never()),
   path: z.optional(z.never()),
@@ -2951,6 +3064,16 @@ var zGetSatsEarnedLeaderboardData = z.object({
 var zGetSatsEarnedLeaderboardResponse = z.object({
   data: z.array(zLeaderboardEntryDto)
 });
+var zGetWalletLeaderboardData = z.object({
+  body: z.optional(z.never()),
+  path: z.object({
+    address: z.string()
+  }),
+  query: z.optional(z.never())
+});
+var zGetWalletLeaderboardResponse = z.object({
+  data: zWalletLeaderboardDto
+});
 var zGetOneBtcHistoryData = z.object({
   body: z.optional(z.never()),
   path: z.optional(z.never()),
@@ -3221,6 +3344,24 @@ var SatrushBackendSdk = class _SatrushBackendSdk extends HeyApiClient {
       ...params
     });
   }
+  /**
+   * Request a page of the general leaderboard
+   */
+  getLeaderboard(parameters, options) {
+    const params = buildClientParams([parameters], [{ args: [
+      { in: "query", key: "sort" },
+      { in: "query", key: "offset" },
+      { in: "query", key: "limit" }
+    ] }]);
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetLeaderboardData.parseAsync(data),
+      responseTransformer: getLeaderboardResponseTransformer,
+      responseValidator: async (data) => await zGetLeaderboardResponse.parseAsync(data),
+      url: "/v1/leaderboard",
+      ...options,
+      ...params
+    });
+  }
   /**
    * Request the top miners by lifetime hashrate earned
    */
@@ -3257,6 +3398,20 @@ var SatrushBackendSdk = class _SatrushBackendSdk extends HeyApiClient {
       ...options
     });
   }
+  /**
+   * Request a wallet's general-leaderboard stats and ranks
+   */
+  getWalletLeaderboard(parameters, options) {
+    const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "address" }] }]);
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetWalletLeaderboardData.parseAsync(data),
+      responseTransformer: getWalletLeaderboardResponseTransformer,
+      responseValidator: async (data) => await zGetWalletLeaderboardResponse.parseAsync(data),
+      url: "/v1/leaderboard/{address}",
+      ...options,
+      ...params
+    });
+  }
   /**
    * Request 1 BTC Vault history
    */
@@ -3482,6 +3637,14 @@ var EpochStateDto = {
   COMPLETE: "complete"
 };
 var HashrateActionTypeDto = { BUY_EPOCH_TICKETS: "buy_epoch_tickets", BUY_ONE_BTC_TICKETS: "buy_one_btc_tickets" };
+var LeaderboardSortDto = {
+  SCORE: "score",
+  DEPLOYED: "deployed",
+  ROUNDS: "rounds",
+  SATS_EARNED: "sats_earned",
+  HASHRATE: "hashrate",
+  STREAK: "streak"
+};
 var NotificationEntity = { STATE_SNAPSHOT: "state_snapshot" };
 var OneBtcStateDto = {
   OPEN: "open",
@@ -3552,6 +3715,7 @@ async function unwrap(promise) {
   ClaimTypeDto,
   EpochStateDto,
   HashrateActionTypeDto,
+  LeaderboardSortDto,
   NotificationEntity,
   OneBtcStateDto,
   RoundHistoryStateDto,
@@ -3605,6 +3769,8 @@ async function unwrap(promise) {
   zGetEpochWinnersResponse,
   zGetHashrateEarnedLeaderboardData,
   zGetHashrateEarnedLeaderboardResponse,
+  zGetLeaderboardData,
+  zGetLeaderboardResponse,
   zGetOneBtcHistoryData,
   zGetOneBtcHistoryResponse,
   zGetOneBtcIterationData,
@@ -3631,11 +3797,17 @@ async function unwrap(promise) {
   zGetUserOneBtcEntriesResponse,
   zGetUserProfileData,
   zGetUserProfileResponse,
+  zGetWalletLeaderboardData,
+  zGetWalletLeaderboardResponse,
   zHashrateActionTypeDto,
   zI128Dto,
   zI64Dto,
   zInternalErrorCodeErrorBody,
   zLeaderboardEntryDto,
+  zLeaderboardPageDto,
+  zLeaderboardPageEntryDto,
+  zLeaderboardRanksDto,
+  zLeaderboardSortDto,
   zMinerClaimDto,
   zMinerDeploymentDto,
   zMinerDto,
@@ -3714,5 +3886,9 @@ async function unwrap(promise) {
   zUserVaultEntriesApiError400InvalidWinsOnly,
   zUserVaultEntriesApiError500Error,
   zValidationErrorCodeErrorBody,
-  zValidationErrorCodeValidationDetailsErrorBody
+  zValidationErrorCodeValidationDetailsErrorBody,
+  zWalletLeaderboardApiError400Error,
+  zWalletLeaderboardApiError400InvalidAddress,
+  zWalletLeaderboardApiError404Error,
+  zWalletLeaderboardDto
 });