@satrush/api 0.1.25 → 0.1.27

package/dist/index.cjs

@@ -47,6 +47,8 @@ __export(index_exports, {
   isSatrushSdkError: () => isSatrushSdkError,
   satrushSdkErrorInterceptor: () => satrushSdkErrorInterceptor,
   unwrap: () => unwrap,
+  zAffiliateLeaderboardEntryDto: () => zAffiliateLeaderboardEntryDto,
+  zAffiliateLeaderboardPageDto: () => zAffiliateLeaderboardPageDto,
   zAffiliateStatsDto: () => zAffiliateStatsDto,
   zAutomationStrategyDto: () => zAutomationStrategyDto,
   zBadRequestErrorCodeErrorBody: () => zBadRequestErrorCodeErrorBody,
@@ -76,6 +78,8 @@ __export(index_exports, {
   zEpochWinnersApiError400InvalidRange: () => zEpochWinnersApiError400InvalidRange,
   zEpochWinnersApiError500Error: () => zEpochWinnersApiError500Error,
   zFieldError: () => zFieldError,
+  zGetAffiliateLeaderboardData: () => zGetAffiliateLeaderboardData,
+  zGetAffiliateLeaderboardResponse: () => zGetAffiliateLeaderboardResponse,
   zGetBoardData: () => zGetBoardData,
   zGetBoardResponse: () => zGetBoardResponse,
   zGetConfigData: () => zGetConfigData,
@@ -108,8 +112,14 @@ __export(index_exports, {
   zGetSatsEarnedLeaderboardResponse: () => zGetSatsEarnedLeaderboardResponse,
   zGetStakingTreasuryData: () => zGetStakingTreasuryData,
   zGetStakingTreasuryResponse: () => zGetStakingTreasuryResponse,
+  zGetTokenBurnedSupplyData: () => zGetTokenBurnedSupplyData,
+  zGetTokenBurnedSupplyResponse: () => zGetTokenBurnedSupplyResponse,
+  zGetTokenCirculatingSupplyData: () => zGetTokenCirculatingSupplyData,
+  zGetTokenCirculatingSupplyResponse: () => zGetTokenCirculatingSupplyResponse,
   zGetTokenStatsData: () => zGetTokenStatsData,
   zGetTokenStatsResponse: () => zGetTokenStatsResponse,
+  zGetTokenTotalSupplyData: () => zGetTokenTotalSupplyData,
+  zGetTokenTotalSupplyResponse: () => zGetTokenTotalSupplyResponse,
   zGetUserAffiliateData: () => zGetUserAffiliateData,
   zGetUserAffiliateResponse: () => zGetUserAffiliateResponse,
   zGetUserClaimsData: () => zGetUserClaimsData,
@@ -201,6 +211,7 @@ __export(index_exports, {
   zTileStakeDto: () => zTileStakeDto,
   zTokenApiError500Error: () => zTokenApiError500Error,
   zTokenStatsDto: () => zTokenStatsDto,
+  zTokenSupplyDto: () => zTokenSupplyDto,
   zTokenVaultDto: () => zTokenVaultDto,
   zU128Dto: () => zU128Dto,
   zU64Dto: () => zU64Dto,
@@ -1434,6 +1445,7 @@ var getEpochWinnersResponseTransformer = async (data) => {
 var leaderboardPageEntryDtoSchemaResponseTransformer = (data) => {
   data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
   data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
+  data.totalStaked = u64DtoSchemaResponseTransformer(data.totalStaked);
   data.totalUsdDeployed = u64DtoSchemaResponseTransformer(data.totalUsdDeployed);
   return data;
 };
@@ -1446,6 +1458,18 @@ var getLeaderboardResponseTransformer = async (data) => {
   data.data = leaderboardPageDtoSchemaResponseTransformer(data.data);
   return data;
 };
+var affiliateLeaderboardEntryDtoSchemaResponseTransformer = (data) => {
+  data.referralUsdVolume = u64DtoSchemaResponseTransformer(data.referralUsdVolume);
+  return data;
+};
+var affiliateLeaderboardPageDtoSchemaResponseTransformer = (data) => {
+  data.entries = data.entries.map((item) => affiliateLeaderboardEntryDtoSchemaResponseTransformer(item));
+  return data;
+};
+var getAffiliateLeaderboardResponseTransformer = async (data) => {
+  data.data = affiliateLeaderboardPageDtoSchemaResponseTransformer(data.data);
+  return data;
+};
 var leaderboardEntryDtoSchemaResponseTransformer = (data) => {
   data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
   data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
@@ -1467,6 +1491,7 @@ var getSatsEarnedLeaderboardResponseTransformer = async (data) => {
 var walletLeaderboardDtoSchemaResponseTransformer = (data) => {
   data.totalHashrateEarned = u64DtoSchemaResponseTransformer(data.totalHashrateEarned);
   data.totalSatsEarned = u64DtoSchemaResponseTransformer(data.totalSatsEarned);
+  data.totalStaked = u64DtoSchemaResponseTransformer(data.totalStaked);
   data.totalUsdDeployed = u64DtoSchemaResponseTransformer(data.totalUsdDeployed);
   data.updatedAt = new Date(data.updatedAt);
   return data;
@@ -1722,8 +1747,10 @@ var minerDtoSchemaResponseTransformer = (data) => {
   data.totalUsdClaimed = u64DtoSchemaResponseTransformer(data.totalUsdClaimed);
   data.totalUsdDeployed = u64DtoSchemaResponseTransformer(data.totalUsdDeployed);
   data.totalUsdEarned = u64DtoSchemaResponseTransformer(data.totalUsdEarned);
+  data.unclaimedBtcAmount = u64DtoSchemaResponseTransformer(data.unclaimedBtcAmount);
   data.unclaimedHashrateAmount = u64DtoSchemaResponseTransformer(data.unclaimedHashrateAmount);
   data.unclaimedSatsShares = u64DtoSchemaResponseTransformer(data.unclaimedSatsShares);
+  data.unclaimedTokenAmount = u64DtoSchemaResponseTransformer(data.unclaimedTokenAmount);
   data.unclaimedTokenShares = u64DtoSchemaResponseTransformer(data.unclaimedTokenShares);
   data.unclaimedUsdAmount = u64DtoSchemaResponseTransformer(data.unclaimedUsdAmount);
   data.unrealizedBtcPnl = i64DtoSchemaResponseTransformer(data.unrealizedBtcPnl);
@@ -2034,6 +2061,7 @@ var zLeaderboardRanksDto = z.object({
   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" }),
+  staked: 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([
@@ -2042,7 +2070,8 @@ var zLeaderboardSortDto = z.enum([
   "rounds",
   "sats_earned",
   "hashrate",
-  "streak"
+  "streak",
+  "staked"
 ]);
 var zNotificationEntity = z.enum(["state_snapshot"]);
 var zOneBtcHistoryApiError400InvalidRange = z.object({
@@ -2173,8 +2202,22 @@ var zStakingTreasuryApiError500Error = z.object({
 var zTokenApiError500Error = z.object({
   code: z.enum(["internal"])
 });
+var zTokenSupplyDto = z.object({
+  result: z.string()
+});
 var zU128Dto = z.string();
 var zU64Dto = z.coerce.bigint().min(BigInt("0"), { error: "Invalid value: Expected uint64 to be >= 0" }).max(BigInt("18446744073709551615"), { error: "Invalid value: Expected uint64 to be <= 18446744073709551615" });
+var zAffiliateLeaderboardEntryDto = z.object({
+  authority: zPubkeyDto,
+  rank: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  referralUsdVolume: zU64Dto,
+  referredMiners: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
+  tag: z.string()
+});
+var zAffiliateLeaderboardPageDto = z.object({
+  entries: z.array(zAffiliateLeaderboardEntryDto),
+  total: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })
+});
 var zAffiliateStatsDto = z.object({
   affiliateRateBps: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
   authority: zPubkeyDto,
@@ -2404,9 +2447,14 @@ var zLeaderboardPageEntryDto = z.object({
   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(),
+  tag: z.optional(z.union([
+    z.string(),
+    z.null()
+  ])),
   totalHashrateEarned: zU64Dto,
   totalRoundsPlayed: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
   totalSatsEarned: zU64Dto,
+  totalStaked: zU64Dto,
   totalUsdDeployed: zU64Dto
 });
 var zLeaderboardPageDto = z.object({
@@ -2527,8 +2575,10 @@ var zMinerDto = z.object({
   totalUsdClaimed: zU64Dto,
   totalUsdDeployed: zU64Dto,
   totalUsdEarned: zU64Dto,
+  unclaimedBtcAmount: zU64Dto,
   unclaimedHashrateAmount: zU64Dto,
   unclaimedSatsShares: zU64Dto,
+  unclaimedTokenAmount: zU64Dto,
   unclaimedTokenShares: zU64Dto,
   unclaimedUsdAmount: zU64Dto,
   unrealizedBtcPnl: zI64Dto,
@@ -3405,9 +3455,14 @@ var zWalletLeaderboardDto = z.object({
   maxStreak: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
   ranks: zLeaderboardRanksDto,
   score: z.number(),
+  tag: z.optional(z.union([
+    z.string(),
+    z.null()
+  ])),
   totalHashrateEarned: zU64Dto,
   totalRoundsPlayed: z.int().gte(0).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }),
   totalSatsEarned: zU64Dto,
+  totalStaked: zU64Dto,
   totalUsdDeployed: zU64Dto,
   updatedAt: z.preprocess((value) => value instanceof Date ? value.toISOString() : value, z.iso.datetime())
 });
@@ -3487,6 +3542,17 @@ var zGetLeaderboardData = z.object({
 var zGetLeaderboardResponse = z.object({
   data: zLeaderboardPageDto
 });
+var zGetAffiliateLeaderboardData = z.object({
+  body: z.optional(z.never()),
+  path: z.optional(z.never()),
+  query: z.optional(z.object({
+    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 zGetAffiliateLeaderboardResponse = z.object({
+  data: zAffiliateLeaderboardPageDto
+});
 var zGetHashrateEarnedLeaderboardData = z.object({
   body: z.optional(z.never()),
   path: z.optional(z.never()),
@@ -3604,6 +3670,30 @@ var zGetTokenStatsData = z.object({
 var zGetTokenStatsResponse = z.object({
   data: zTokenStatsDto
 });
+var zGetTokenBurnedSupplyData = z.object({
+  body: z.optional(z.never()),
+  path: z.optional(z.never()),
+  query: z.optional(z.never())
+});
+var zGetTokenBurnedSupplyResponse = z.object({
+  data: zTokenSupplyDto
+});
+var zGetTokenCirculatingSupplyData = z.object({
+  body: z.optional(z.never()),
+  path: z.optional(z.never()),
+  query: z.optional(z.never())
+});
+var zGetTokenCirculatingSupplyResponse = z.object({
+  data: zTokenSupplyDto
+});
+var zGetTokenTotalSupplyData = z.object({
+  body: z.optional(z.never()),
+  path: z.optional(z.never()),
+  query: z.optional(z.never())
+});
+var zGetTokenTotalSupplyResponse = z.object({
+  data: zTokenSupplyDto
+});
 var zGetUserProfileData = z.object({
   body: z.optional(z.never()),
   path: z.object({
@@ -3860,6 +3950,20 @@ var SatrushBackendSdk = class _SatrushBackendSdk extends HeyApiClient {
       ...params
     });
   }
+  /**
+   * Request a page of the affiliate leaderboard, by referral USD volume
+   */
+  getAffiliateLeaderboard(parameters, options) {
+    const params = buildClientParams([parameters], [{ args: [{ in: "query", key: "offset" }, { in: "query", key: "limit" }] }]);
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetAffiliateLeaderboardData.parseAsync(data),
+      responseTransformer: getAffiliateLeaderboardResponseTransformer,
+      responseValidator: async (data) => await zGetAffiliateLeaderboardResponse.parseAsync(data),
+      url: "/v1/leaderboard/affiliates",
+      ...options,
+      ...params
+    });
+  }
   /**
    * Request the top miners by lifetime hashrate earned
    */
@@ -4032,6 +4136,39 @@ var SatrushBackendSdk = class _SatrushBackendSdk extends HeyApiClient {
       ...options
     });
   }
+  /**
+   * Request the protocol tokens burned so far (the protocol's buyback burns plus the LP wallet's burns) in whole tokens, in the shape CoinGecko's supply endpoints use
+   */
+  getTokenBurnedSupply(options) {
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetTokenBurnedSupplyData.parseAsync(data),
+      responseValidator: async (data) => await zGetTokenBurnedSupplyResponse.parseAsync(data),
+      url: "/v1/token/supply/burned",
+      ...options
+    });
+  }
+  /**
+   * Request the protocol token's circulating supply in whole tokens (total supply less the non-circulating wallets' balances), in the shape CoinGecko's supply endpoints use
+   */
+  getTokenCirculatingSupply(options) {
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetTokenCirculatingSupplyData.parseAsync(data),
+      responseValidator: async (data) => await zGetTokenCirculatingSupplyResponse.parseAsync(data),
+      url: "/v1/token/supply/circulating",
+      ...options
+    });
+  }
+  /**
+   * Request the protocol token's total supply in whole tokens, in the shape CoinGecko's supply endpoints use
+   */
+  getTokenTotalSupply(options) {
+    return (options?.client ?? this.client).get({
+      requestValidator: async (data) => await zGetTokenTotalSupplyData.parseAsync(data),
+      responseValidator: async (data) => await zGetTokenTotalSupplyResponse.parseAsync(data),
+      url: "/v1/token/supply/total",
+      ...options
+    });
+  }
   /**
    * Request user profile
    */
@@ -4218,7 +4355,8 @@ var LeaderboardSortDto = {
   ROUNDS: "rounds",
   SATS_EARNED: "sats_earned",
   HASHRATE: "hashrate",
-  STREAK: "streak"
+  STREAK: "streak",
+  STAKED: "staked"
 };
 var NotificationEntity = { STATE_SNAPSHOT: "state_snapshot" };
 var OneBtcStateDto = {
@@ -4307,6 +4445,8 @@ async function unwrap(promise) {
   isSatrushSdkError,
   satrushSdkErrorInterceptor,
   unwrap,
+  zAffiliateLeaderboardEntryDto,
+  zAffiliateLeaderboardPageDto,
   zAffiliateStatsDto,
   zAutomationStrategyDto,
   zBadRequestErrorCodeErrorBody,
@@ -4336,6 +4476,8 @@ async function unwrap(promise) {
   zEpochWinnersApiError400InvalidRange,
   zEpochWinnersApiError500Error,
   zFieldError,
+  zGetAffiliateLeaderboardData,
+  zGetAffiliateLeaderboardResponse,
   zGetBoardData,
   zGetBoardResponse,
   zGetConfigData,
@@ -4368,8 +4510,14 @@ async function unwrap(promise) {
   zGetSatsEarnedLeaderboardResponse,
   zGetStakingTreasuryData,
   zGetStakingTreasuryResponse,
+  zGetTokenBurnedSupplyData,
+  zGetTokenBurnedSupplyResponse,
+  zGetTokenCirculatingSupplyData,
+  zGetTokenCirculatingSupplyResponse,
   zGetTokenStatsData,
   zGetTokenStatsResponse,
+  zGetTokenTotalSupplyData,
+  zGetTokenTotalSupplyResponse,
   zGetUserAffiliateData,
   zGetUserAffiliateResponse,
   zGetUserClaimsData,
@@ -4461,6 +4609,7 @@ async function unwrap(promise) {
   zTileStakeDto,
   zTokenApiError500Error,
   zTokenStatsDto,
+  zTokenSupplyDto,
   zTokenVaultDto,
   zU128Dto,
   zU64Dto,