@satrush/api 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -313,6 +313,9 @@ declare const createClient: (config?: Config) => Client;
 type ClientOptions = {
     baseUrl: `${string}://${string}/api` | (string & {});
 };
+type BadRequestErrorCodeErrorBody = {
+    code: 'invalid_path' | 'invalid_query' | 'invalid_body';
+};
 /**
  * Board state: the active round pointer, its mining window, the strike
  * jackpot, the live blockchain slot and the current round's details.
@@ -340,6 +343,16 @@ type BoardDto = {
     startSlot: U64Dto;
     strike: StrikeJackpotDto;
 };
+type FieldError = {
+    /**
+     * Field name in request.
+     */
+    field: string;
+    /**
+     * Validation error message.
+     */
+    message: string;
+};
 /**
  * Signed 128-bit integer encoded as a decimal string.
  */
@@ -351,6 +364,42 @@ type I64Dto = bigint;
 type InternalErrorCodeErrorBody = {
     code: 'internal_error';
 };
+/**
+ * A miner's accumulated protocol state, keyed by its authority wallet.
+ */
+type MinerDto = {
+    authority: PubkeyDto;
+    /**
+     * Number of consecutive rounds played.
+     */
+    currentStreakCount: number;
+    /**
+     * Accumulated hashrate points.
+     */
+    hashrateAmount: U64Dto;
+    /**
+     * Id of the last round the miner played.
+     */
+    lastMinedRoundId: number;
+    /**
+     * BTC shares in the Sats Vault not yet claimed.
+     */
+    unclaimedBtcShares: U64Dto;
+    /**
+     * USD rewards not yet claimed.
+     */
+    unclaimedUsdAmount: U64Dto;
+};
+/**
+ * A user's profile: their miner account and currently-open deployments.
+ */
+type ProfileDto = {
+    /**
+     * The authority's open public deployments.
+     */
+    deployments: Array<PublicDeploymentDto>;
+    miner: MinerDto;
+};
 /**
  * Pubkey represented as base58 string in JSON and OpenAPI.
  *
@@ -358,6 +407,24 @@ type InternalErrorCodeErrorBody = {
  * - OpenAPI: `type: string`, pattern for base58, optional format
  */
 type PubkeyDto = string;
+/**
+ * A miner's deployment of USD onto a round's tiles.
+ */
+type PublicDeploymentDto = {
+    address: PubkeyDto;
+    /**
+     * USD deployed after protocol fees.
+     */
+    deployedUsdAmount: U64Dto;
+    /**
+     * Round this deployment belongs to.
+     */
+    roundId: number;
+    /**
+     * 21-bit mask of the selected tiles.
+     */
+    selectionMask: number;
+};
 /**
  * Core state of a mining round.
  */
@@ -391,6 +458,44 @@ declare const RoundStateDto: {
  * Lifecycle state of a round.
  */
 type RoundStateDto = typeof RoundStateDto[keyof typeof RoundStateDto];
+/**
+ * Protocol configuration: token mints and fee rates.
+ */
+type SatrushConfigDto = {
+    address: PubkeyDto;
+    /**
+     * BTC mint (initially cbBTC).
+     */
+    btcMint: PubkeyDto;
+    /**
+     * Epoch Vault fee in basis points.
+     */
+    epochFeeBps: number;
+    /**
+     * 1 BTC Vault fee in basis points.
+     */
+    oneBtcFeeBps: number;
+    /**
+     * Protocol fee in basis points.
+     */
+    protocolFeeBps: number;
+    /**
+     * Sats Vault claim fee in basis points.
+     */
+    satsVaultClaimFeeBps: number;
+    /**
+     * Sats Vault round fee in basis points.
+     */
+    satsVaultRoundFeeBps: number;
+    /**
+     * Strike jackpot fee in basis points.
+     */
+    strikeFeeBps: number;
+    /**
+     * USD mint (initially USDC).
+     */
+    usdMint: PubkeyDto;
+};
 /**
  * Strike jackpot balances tracked on the board.
  */
@@ -427,6 +532,26 @@ type U128Dto = bigint;
  * Unsigned 64-bit integer encoded as a decimal string.
  */
 type U64Dto = bigint;
+type UserProfileApiError400Error = ({
+    code: 'invalid_address';
+} & UserProfileApiError400InvalidAddress) | ({
+    code: 'invalid_body' | 'invalid_path' | 'invalid_query';
+} & BadRequestErrorCodeErrorBody);
+type UserProfileApiError400InvalidAddress = {
+    code: 'invalid_address';
+};
+type ValidationErrorCodeErrorBody = {
+    code: 'validation_failed';
+    data?: {
+        errors: Array<FieldError>;
+    };
+};
+type ValidationErrorCodeValidationDetailsErrorBody = {
+    code: 'validation_failed';
+    data?: {
+        errors: Array<FieldError>;
+    };
+};
 type GetBoardData = {
     body?: never;
     path?: never;
@@ -443,6 +568,45 @@ type GetBoardResponses = {
     };
 };
 type GetBoardResponse = GetBoardResponses[keyof GetBoardResponses];
+type GetConfigData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/config';
+};
+type GetConfigErrors = {
+    500: InternalErrorCodeErrorBody;
+};
+type GetConfigError = GetConfigErrors[keyof GetConfigErrors];
+type GetConfigResponses = {
+    200: {
+        data: SatrushConfigDto;
+    };
+};
+type GetConfigResponse = GetConfigResponses[keyof GetConfigResponses];
+type GetUserProfileData = {
+    body?: never;
+    path: {
+        /**
+         * User wallet address (base58)
+         */
+        address: string;
+    };
+    query?: never;
+    url: '/v1/user/{address}/profile';
+};
+type GetUserProfileErrors = {
+    400: UserProfileApiError400Error;
+    422: ValidationErrorCodeErrorBody;
+    500: InternalErrorCodeErrorBody;
+};
+type GetUserProfileError = GetUserProfileErrors[keyof GetUserProfileErrors];
+type GetUserProfileResponses = {
+    200: {
+        data: ProfileDto;
+    };
+};
+type GetUserProfileResponse = GetUserProfileResponses[keyof GetUserProfileResponses];
 
 type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
     /**
@@ -479,8 +643,29 @@ declare class SatrushBackendSdk extends HeyApiClient {
      * Request board
      */
     getBoard<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<GetBoardResponses, GetBoardErrors, ThrowOnError, "fields">;
+    /**
+     * Request config
+     */
+    getConfig<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<GetConfigResponses, GetConfigErrors, ThrowOnError, "fields">;
+    /**
+     * Request user profile
+     */
+    getUserProfile<ThrowOnError extends boolean = false>(parameters: {
+        address: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<GetUserProfileResponses, GetUserProfileErrors, ThrowOnError, "fields">;
 }
 
+declare const zBadRequestErrorCodeErrorBody: z.ZodObject<{
+    code: z.ZodEnum<{
+        invalid_path: "invalid_path";
+        invalid_query: "invalid_query";
+        invalid_body: "invalid_body";
+    }>;
+}, z.core.$strip>;
+declare const zFieldError: z.ZodObject<{
+    field: z.ZodString;
+    message: z.ZodString;
+}, z.core.$strip>;
 /**
  * Signed 128-bit integer encoded as a decimal string.
  */
@@ -510,6 +695,20 @@ declare const zRoundStateDto: z.ZodEnum<{
     settled: "settled";
     finished: "finished";
 }>;
+/**
+ * Protocol configuration: token mints and fee rates.
+ */
+declare const zSatrushConfigDto: z.ZodObject<{
+    address: z.ZodString;
+    btcMint: z.ZodString;
+    epochFeeBps: z.ZodInt;
+    oneBtcFeeBps: z.ZodInt;
+    protocolFeeBps: z.ZodInt;
+    satsVaultClaimFeeBps: z.ZodInt;
+    satsVaultRoundFeeBps: z.ZodInt;
+    strikeFeeBps: z.ZodInt;
+    usdMint: z.ZodString;
+}, z.core.$strip>;
 /**
  * Unsigned 128-bit integer encoded as a decimal string.
  */
@@ -518,6 +717,45 @@ declare const zU128Dto: z.ZodString;
  * Unsigned 64-bit integer encoded as a decimal string.
  */
 declare const zU64Dto: z.ZodCoercedBigInt<unknown>;
+/**
+ * A miner's accumulated protocol state, keyed by its authority wallet.
+ */
+declare const zMinerDto: z.ZodObject<{
+    authority: z.ZodString;
+    currentStreakCount: z.ZodInt;
+    hashrateAmount: z.ZodCoercedBigInt<unknown>;
+    lastMinedRoundId: z.ZodInt;
+    unclaimedBtcShares: z.ZodCoercedBigInt<unknown>;
+    unclaimedUsdAmount: z.ZodCoercedBigInt<unknown>;
+}, z.core.$strip>;
+/**
+ * A miner's deployment of USD onto a round's tiles.
+ */
+declare const zPublicDeploymentDto: z.ZodObject<{
+    address: z.ZodString;
+    deployedUsdAmount: z.ZodCoercedBigInt<unknown>;
+    roundId: z.ZodInt;
+    selectionMask: z.ZodInt;
+}, z.core.$strip>;
+/**
+ * A user's profile: their miner account and currently-open deployments.
+ */
+declare const zProfileDto: z.ZodObject<{
+    deployments: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        deployedUsdAmount: z.ZodCoercedBigInt<unknown>;
+        roundId: z.ZodInt;
+        selectionMask: z.ZodInt;
+    }, z.core.$strip>>;
+    miner: z.ZodObject<{
+        authority: z.ZodString;
+        currentStreakCount: z.ZodInt;
+        hashrateAmount: z.ZodCoercedBigInt<unknown>;
+        lastMinedRoundId: z.ZodInt;
+        unclaimedBtcShares: z.ZodCoercedBigInt<unknown>;
+        unclaimedUsdAmount: z.ZodCoercedBigInt<unknown>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 /**
  * Strike jackpot balances tracked on the board.
  */
@@ -630,6 +868,48 @@ declare const zBoardDto: z.ZodObject<{
         usdAmount: z.ZodCoercedBigInt<unknown>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+declare const zUserProfileApiError400InvalidAddress: z.ZodObject<{
+    code: z.ZodEnum<{
+        invalid_address: "invalid_address";
+    }>;
+}, z.core.$strip>;
+declare const zUserProfileApiError400Error: z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
+    code: z.ZodLiteral<"invalid_address">;
+}, z.core.$strip>, z.ZodObject<{
+    code: z.ZodEnum<{
+        invalid_address: "invalid_address";
+    }>;
+}, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
+    code: z.ZodUnion<readonly [z.ZodLiteral<"invalid_body">, z.ZodLiteral<"invalid_path">, z.ZodLiteral<"invalid_query">]>;
+}, z.core.$strip>, z.ZodObject<{
+    code: z.ZodEnum<{
+        invalid_path: "invalid_path";
+        invalid_query: "invalid_query";
+        invalid_body: "invalid_body";
+    }>;
+}, z.core.$strip>>]>;
+declare const zValidationErrorCodeErrorBody: z.ZodObject<{
+    code: z.ZodEnum<{
+        validation_failed: "validation_failed";
+    }>;
+    data: z.ZodOptional<z.ZodObject<{
+        errors: z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const zValidationErrorCodeValidationDetailsErrorBody: z.ZodObject<{
+    code: z.ZodEnum<{
+        validation_failed: "validation_failed";
+    }>;
+    data: z.ZodOptional<z.ZodObject<{
+        errors: z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 declare const zGetBoardData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodOptional<z.ZodNever>;
@@ -702,11 +982,56 @@ declare const zGetBoardResponse: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 type GetBoardResponseZodType = z.infer<typeof zGetBoardResponse>;
+declare const zGetConfigData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodOptional<z.ZodNever>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+declare const zGetConfigResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        address: z.ZodString;
+        btcMint: z.ZodString;
+        epochFeeBps: z.ZodInt;
+        oneBtcFeeBps: z.ZodInt;
+        protocolFeeBps: z.ZodInt;
+        satsVaultClaimFeeBps: z.ZodInt;
+        satsVaultRoundFeeBps: z.ZodInt;
+        strikeFeeBps: z.ZodInt;
+        usdMint: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type GetConfigResponseZodType = z.infer<typeof zGetConfigResponse>;
+declare const zGetUserProfileData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        address: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+declare const zGetUserProfileResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        deployments: z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            deployedUsdAmount: z.ZodCoercedBigInt<unknown>;
+            roundId: z.ZodInt;
+            selectionMask: z.ZodInt;
+        }, z.core.$strip>>;
+        miner: z.ZodObject<{
+            authority: z.ZodString;
+            currentStreakCount: z.ZodInt;
+            hashrateAmount: z.ZodCoercedBigInt<unknown>;
+            lastMinedRoundId: z.ZodInt;
+            unclaimedBtcShares: z.ZodCoercedBigInt<unknown>;
+            unclaimedUsdAmount: z.ZodCoercedBigInt<unknown>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type GetUserProfileResponseZodType = z.infer<typeof zGetUserProfileResponse>;
 
-type HasOnlyDataKey<T> = T extends object ? (Exclude<keyof T, "data"> extends never ? true : false) : false;
+type HasOnlyDataKey<T> = T extends object ? Exclude<keyof T, 'data'> extends never ? true : false : false;
 type UnwrapData<T> = T extends {
     data: infer U;
-} ? (HasOnlyDataKey<T> extends true ? U : T) : T;
+} ? HasOnlyDataKey<T> extends true ? U : T : T;
 type ExtractData<T> = T extends {
     data: infer D;
     error?: undefined;
@@ -725,4 +1050,4 @@ declare class SatrushBackendSdkError<TCause = unknown> extends Error {
 declare const satrushSdkErrorInterceptor: (error: unknown, response?: Response) => SatrushBackendSdkError<unknown>;
 declare const isSatrushSdkError: <TCause = unknown>(error: unknown) => error is SatrushBackendSdkError<TCause>;
 
-export { type BoardDto, type ClientOptions, type GetBoardData, type GetBoardError, type GetBoardErrors, type GetBoardResponse, type GetBoardResponseZodType, type GetBoardResponses, type I128Dto, type I64Dto, type InternalErrorCodeErrorBody, type Options, type PubkeyDto, type RoundDto, RoundStateDto, SatrushBackendSdk, SatrushBackendSdkError, type ServerSentEventsOptions, type ServerSentEventsResult, type StreamEvent, type StrikeJackpotDto, type TileStakeDto, type U128Dto, type U64Dto, createClient, createSseClient, isSatrushSdkError, satrushSdkErrorInterceptor, unwrap, zBoardDto, zGetBoardData, zGetBoardResponse, zI128Dto, zI64Dto, zInternalErrorCodeErrorBody, zPubkeyDto, zRoundDto, zRoundStateDto, zStrikeJackpotDto, zTileStakeDto, zU128Dto, zU64Dto };
+export { type BadRequestErrorCodeErrorBody, type BoardDto, type ClientOptions, type FieldError, type GetBoardData, type GetBoardError, type GetBoardErrors, type GetBoardResponse, type GetBoardResponseZodType, type GetBoardResponses, type GetConfigData, type GetConfigError, type GetConfigErrors, type GetConfigResponse, type GetConfigResponseZodType, type GetConfigResponses, type GetUserProfileData, type GetUserProfileError, type GetUserProfileErrors, type GetUserProfileResponse, type GetUserProfileResponseZodType, type GetUserProfileResponses, type I128Dto, type I64Dto, type InternalErrorCodeErrorBody, type MinerDto, type Options, type ProfileDto, type PubkeyDto, type PublicDeploymentDto, type RoundDto, RoundStateDto, SatrushBackendSdk, SatrushBackendSdkError, type SatrushConfigDto, type ServerSentEventsOptions, type ServerSentEventsResult, type StreamEvent, type StrikeJackpotDto, type TileStakeDto, type U128Dto, type U64Dto, type UserProfileApiError400Error, type UserProfileApiError400InvalidAddress, type ValidationErrorCodeErrorBody, type ValidationErrorCodeValidationDetailsErrorBody, createClient, createSseClient, isSatrushSdkError, satrushSdkErrorInterceptor, unwrap, zBadRequestErrorCodeErrorBody, zBoardDto, zFieldError, zGetBoardData, zGetBoardResponse, zGetConfigData, zGetConfigResponse, zGetUserProfileData, zGetUserProfileResponse, zI128Dto, zI64Dto, zInternalErrorCodeErrorBody, zMinerDto, zProfileDto, zPubkeyDto, zPublicDeploymentDto, zRoundDto, zRoundStateDto, zSatrushConfigDto, zStrikeJackpotDto, zTileStakeDto, zU128Dto, zU64Dto, zUserProfileApiError400Error, zUserProfileApiError400InvalidAddress, zValidationErrorCodeErrorBody, zValidationErrorCodeValidationDetailsErrorBody };