@secretkeylabs/stacks-tools 0.2.0 → 0.3.0-6a691d3

package/dist/index.d.cts

@@ -0,0 +1,400 @@
+import * as v from 'valibot';
+
+type SafeError<TName extends string = string, TData = unknown> = {
+    readonly name: TName;
+    readonly message: string;
+    readonly data?: TData;
+};
+type Result<TData = unknown, E extends SafeError = SafeError> = [E, null] | [null, TData];
+
+type ApiKeyConfig = {
+    key: string;
+    header: string;
+};
+type ApiRequestOptions = {
+    baseUrl: string;
+    apiKeyConfig?: ApiKeyConfig;
+};
+type ApiPaginationOptions = {
+    /**
+     * The number of items to return. Each endpoint has its own maximum allowed
+     * limit, although many support at least 50 items. The [Hiro
+     * docs](https://docs.hiro.so/stacks/api) include the allowed maximum for each
+     * endpoint.
+     */
+    limit?: number;
+    offset?: number;
+};
+
+type Args$7 = {
+    principal: string;
+    unanchored?: boolean;
+    untilBlock?: number;
+} & ApiRequestOptions;
+declare const responseSchema$2: v.ObjectSchema<{
+    readonly stx: v.ObjectSchema<{
+        readonly balance: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+        readonly total_fees_sent: v.StringSchema<undefined>;
+        readonly total_miner_rewards_received: v.StringSchema<undefined>;
+        readonly lock_tx_id: v.StringSchema<undefined>;
+        readonly locked: v.StringSchema<undefined>;
+        readonly lock_height: v.NumberSchema<undefined>;
+        readonly burnchain_lock_height: v.NumberSchema<undefined>;
+        readonly burnchain_unlock_height: v.NumberSchema<undefined>;
+    }, undefined>;
+    readonly fungible_tokens: v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+        readonly balance: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly non_fungible_tokens: v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+        readonly count: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type Response$2 = v.InferOutput<typeof responseSchema$2>;
+declare function balances(opts: Args$7): Promise<Result<Response$2, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+
+declare const balances$1_balances: typeof balances;
+declare namespace balances$1 {
+  export { type Args$7 as Args, type Response$2 as Response, balances$1_balances as balances, responseSchema$2 as responseSchema };
+}
+
+declare const index$4_balances: typeof balances;
+declare namespace index$4 {
+  export { balances$1 as Balances, index$4_balances as balances };
+}
+
+type Args$6 = {
+    heightOrHash: string | number;
+} & ApiRequestOptions;
+declare const responseSchema$1: v.ObjectSchema<{
+    readonly canonical: v.BooleanSchema<undefined>;
+    readonly height: v.NumberSchema<undefined>;
+    readonly hash: v.StringSchema<undefined>;
+    readonly block_time: v.NumberSchema<undefined>;
+    readonly block_time_iso: v.StringSchema<undefined>;
+    readonly index_block_hash: v.StringSchema<undefined>;
+    readonly parent_block_hash: v.StringSchema<undefined>;
+    readonly parent_index_block_hash: v.StringSchema<undefined>;
+    readonly burn_block_time: v.NumberSchema<undefined>;
+    readonly burn_block_time_iso: v.StringSchema<undefined>;
+    readonly burn_block_hash: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly miner_txid: v.StringSchema<undefined>;
+    readonly tx_count: v.NumberSchema<undefined>;
+    readonly execution_cost_read_count: v.NumberSchema<undefined>;
+    readonly execution_cost_read_length: v.NumberSchema<undefined>;
+    readonly execution_cost_runtime: v.NumberSchema<undefined>;
+    readonly execution_cost_write_count: v.NumberSchema<undefined>;
+    readonly execution_cost_write_length: v.NumberSchema<undefined>;
+}, undefined>;
+type Response$1 = v.InferOutput<typeof responseSchema$1>;
+declare function getBlock(opts: Args$6): Promise<Result<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
+
+declare const getBlock$1_getBlock: typeof getBlock;
+declare namespace getBlock$1 {
+  export { type Args$6 as Args, type Response$1 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
+}
+
+declare const index$3_getBlock: typeof getBlock;
+declare namespace index$3 {
+  export { getBlock$1 as GetBlock, index$3_getBlock as getBlock };
+}
+
+declare const CoreApiResponseSchema: v.ObjectSchema<{
+    readonly peer_version: v.NumberSchema<undefined>;
+    readonly pox_consensus: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly stable_pox_consensus: v.StringSchema<undefined>;
+    readonly stable_burn_block_height: v.NumberSchema<undefined>;
+    readonly server_version: v.StringSchema<undefined>;
+    readonly network_id: v.NumberSchema<undefined>;
+    readonly parent_network_id: v.NumberSchema<undefined>;
+    readonly stacks_tip_height: v.NumberSchema<undefined>;
+    readonly stacks_tip: v.StringSchema<undefined>;
+    readonly stacks_tip_consensus_hash: v.StringSchema<undefined>;
+    readonly unanchored_tip: v.StringSchema<undefined>;
+    readonly exit_at_block_height: v.NumberSchema<undefined>;
+}, undefined>;
+type CoreApiResponse = v.InferOutput<typeof CoreApiResponseSchema>;
+declare function coreApi(apiOpts: ApiRequestOptions): Promise<Result<CoreApiResponse>>;
+
+type coreApi$1_CoreApiResponse = CoreApiResponse;
+declare const coreApi$1_coreApi: typeof coreApi;
+declare namespace coreApi$1 {
+  export { type coreApi$1_CoreApiResponse as CoreApiResponse, coreApi$1_coreApi as coreApi };
+}
+
+type Args$5 = ApiRequestOptions;
+declare const poxDetailsResponseSchema: v.ObjectSchema<{
+    readonly contract_id: v.StringSchema<undefined>;
+    readonly pox_activation_threshold_ustx: v.NumberSchema<undefined>;
+    readonly first_burnchain_block_height: v.NumberSchema<undefined>;
+    readonly current_burnchain_block_height: v.NumberSchema<undefined>;
+    readonly prepare_phase_block_length: v.NumberSchema<undefined>;
+    readonly reward_phase_block_length: v.NumberSchema<undefined>;
+    readonly reward_slots: v.NumberSchema<undefined>;
+    readonly rejection_fraction: v.NullSchema<undefined>;
+    readonly total_liquid_supply_ustx: v.NumberSchema<undefined>;
+    readonly current_cycle: v.ObjectSchema<{
+        readonly id: v.NumberSchema<undefined>;
+        readonly min_threshold_ustx: v.NumberSchema<undefined>;
+        readonly stacked_ustx: v.NumberSchema<undefined>;
+        readonly is_pox_active: v.BooleanSchema<undefined>;
+    }, undefined>;
+    readonly next_cycle: v.ObjectSchema<{
+        readonly id: v.NumberSchema<undefined>;
+        readonly min_threshold_ustx: v.NumberSchema<undefined>;
+        readonly min_increment_ustx: v.NumberSchema<undefined>;
+        readonly stacked_ustx: v.NumberSchema<undefined>;
+        readonly prepare_phase_start_block_height: v.NumberSchema<undefined>;
+        readonly blocks_until_prepare_phase: v.NumberSchema<undefined>;
+        readonly reward_phase_start_block_height: v.NumberSchema<undefined>;
+        readonly blocks_until_reward_phase: v.NumberSchema<undefined>;
+        readonly ustx_until_pox_rejection: v.NullSchema<undefined>;
+    }, undefined>;
+    readonly epochs: v.ArraySchema<v.ObjectSchema<{
+        readonly epoch_id: v.StringSchema<undefined>;
+        readonly start_height: v.NumberSchema<undefined>;
+        readonly end_height: v.NumberSchema<undefined>;
+        readonly block_limit: v.ObjectSchema<{
+            readonly write_length: v.NumberSchema<undefined>;
+            readonly write_count: v.NumberSchema<undefined>;
+            readonly read_length: v.NumberSchema<undefined>;
+            readonly read_count: v.NumberSchema<undefined>;
+            readonly runtime: v.NumberSchema<undefined>;
+        }, undefined>;
+        readonly network_epoch: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly min_amount_ustx: v.NumberSchema<undefined>;
+    readonly prepare_cycle_length: v.NumberSchema<undefined>;
+    readonly reward_cycle_id: v.NumberSchema<undefined>;
+    readonly reward_cycle_length: v.NumberSchema<undefined>;
+    readonly rejection_votes_left_required: v.NullSchema<undefined>;
+    readonly next_reward_cycle_in: v.NumberSchema<undefined>;
+    readonly contract_versions: v.ArraySchema<v.ObjectSchema<{
+        readonly contract_id: v.StringSchema<undefined>;
+        readonly activation_burnchain_block_height: v.NumberSchema<undefined>;
+        readonly first_reward_cycle_id: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type PoxDetailsResponse = v.InferOutput<typeof poxDetailsResponseSchema>;
+declare function poxDetails(args: Args$5): Promise<Result<PoxDetailsResponse>>;
+
+declare const poxDetails$1_poxDetails: typeof poxDetails;
+declare namespace poxDetails$1 {
+  export { poxDetails$1_poxDetails as poxDetails };
+}
+
+declare const index$2_coreApi: typeof coreApi;
+declare const index$2_poxDetails: typeof poxDetails;
+declare namespace index$2 {
+  export { coreApi$1 as CoreApi, poxDetails$1 as PoxDetails, index$2_coreApi as coreApi, index$2_poxDetails as poxDetails };
+}
+
+type Args$4 = {
+    cycleNumber: number;
+} & ApiRequestOptions;
+declare const responseSchema: v.ObjectSchema<{
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly index_block_hash: v.StringSchema<undefined>;
+    readonly cycle_number: v.NumberSchema<undefined>;
+    readonly total_weight: v.NumberSchema<undefined>;
+    readonly total_stacked_amount: v.StringSchema<undefined>;
+    readonly total_signers: v.NumberSchema<undefined>;
+}, undefined>;
+type Response = v.InferOutput<typeof responseSchema>;
+declare function cycle(opts: Args$4): Promise<Result<Response, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type cycle$1_Response = Response;
+declare const cycle$1_cycle: typeof cycle;
+declare const cycle$1_responseSchema: typeof responseSchema;
+declare namespace cycle$1 {
+  export { type Args$4 as Args, type cycle$1_Response as Response, cycle$1_cycle as cycle, cycle$1_responseSchema as responseSchema };
+}
+
+type Args$3 = ApiRequestOptions & ApiPaginationOptions;
+declare const cycleInfoSchema: v.ObjectSchema<{
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly index_block_hash: v.StringSchema<undefined>;
+    readonly cycle_number: v.NumberSchema<undefined>;
+    readonly total_weight: v.NumberSchema<undefined>;
+    readonly total_stacked_amount: v.StringSchema<undefined>;
+    readonly total_signers: v.NumberSchema<undefined>;
+}, undefined>;
+type CycleInfo = v.InferOutput<typeof cycleInfoSchema>;
+declare const resultsSchema$2: v.ArraySchema<v.ObjectSchema<{
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly index_block_hash: v.StringSchema<undefined>;
+    readonly cycle_number: v.NumberSchema<undefined>;
+    readonly total_weight: v.NumberSchema<undefined>;
+    readonly total_stacked_amount: v.StringSchema<undefined>;
+    readonly total_signers: v.NumberSchema<undefined>;
+}, undefined>, undefined>;
+type Results$2 = v.InferOutput<typeof resultsSchema$2>;
+declare const cyclesResponseSchema: v.ObjectSchema<{
+    readonly results: v.ArraySchema<v.ObjectSchema<{
+        readonly block_height: v.NumberSchema<undefined>;
+        readonly index_block_hash: v.StringSchema<undefined>;
+        readonly cycle_number: v.NumberSchema<undefined>;
+        readonly total_weight: v.NumberSchema<undefined>;
+        readonly total_stacked_amount: v.StringSchema<undefined>;
+        readonly total_signers: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly limit: v.NumberSchema<undefined>;
+    readonly offset: v.NumberSchema<undefined>;
+    readonly total: v.NumberSchema<undefined>;
+}, undefined>;
+type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
+declare function cycles(args: Args$3): Promise<Result<CyclesResponse>>;
+
+type cycles$1_CycleInfo = CycleInfo;
+type cycles$1_CyclesResponse = CyclesResponse;
+declare const cycles$1_cycleInfoSchema: typeof cycleInfoSchema;
+declare const cycles$1_cycles: typeof cycles;
+declare const cycles$1_cyclesResponseSchema: typeof cyclesResponseSchema;
+declare namespace cycles$1 {
+  export { type Args$3 as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type Results$2 as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, resultsSchema$2 as resultsSchema };
+}
+
+type Args$2 = {
+    /**
+     * The signers public key as a hex string, with or without a '0x' prefix.
+     */
+    signerPublicKey: string;
+    cycleId: number;
+} & ApiRequestOptions;
+declare const signerInCycleResponseSchema: v.ObjectSchema<{
+    readonly signing_key: v.StringSchema<undefined>;
+    readonly signer_address: v.StringSchema<undefined>;
+    readonly weight: v.NumberSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly weight_percent: v.NumberSchema<undefined>;
+    readonly stacked_amount_percent: v.NumberSchema<undefined>;
+    readonly solo_stacker_count: v.NumberSchema<undefined>;
+    readonly pooled_stacker_count: v.NumberSchema<undefined>;
+}, undefined>;
+type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
+declare function signerInCycle(args: Args$2): Promise<Result<SignerInCycleResponse>>;
+
+type signerInCycle$1_SignerInCycleResponse = SignerInCycleResponse;
+declare const signerInCycle$1_signerInCycle: typeof signerInCycle;
+declare const signerInCycle$1_signerInCycleResponseSchema: typeof signerInCycleResponseSchema;
+declare namespace signerInCycle$1 {
+  export { type Args$2 as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
+}
+
+type Args$1 = {
+    cycleNumber: number;
+} & ApiRequestOptions & ApiPaginationOptions;
+declare const signerSchema: v.ObjectSchema<{
+    readonly signing_key: v.StringSchema<undefined>;
+    readonly signer_address: v.StringSchema<undefined>;
+    readonly weight: v.NumberSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly weight_percent: v.NumberSchema<undefined>;
+    readonly stacked_amount_percent: v.NumberSchema<undefined>;
+    readonly pooled_stacker_count: v.NumberSchema<undefined>;
+    readonly solo_stacker_count: v.NumberSchema<undefined>;
+}, undefined>;
+type Signer = v.InferOutput<typeof signerSchema>;
+declare const resultsSchema$1: v.ArraySchema<v.ObjectSchema<{
+    readonly signing_key: v.StringSchema<undefined>;
+    readonly signer_address: v.StringSchema<undefined>;
+    readonly weight: v.NumberSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly weight_percent: v.NumberSchema<undefined>;
+    readonly stacked_amount_percent: v.NumberSchema<undefined>;
+    readonly pooled_stacker_count: v.NumberSchema<undefined>;
+    readonly solo_stacker_count: v.NumberSchema<undefined>;
+}, undefined>, undefined>;
+type Results$1 = v.InferOutput<typeof resultsSchema$1>;
+declare const signersResponseSchema: v.ObjectSchema<{
+    readonly results: v.ArraySchema<v.ObjectSchema<{
+        readonly signing_key: v.StringSchema<undefined>;
+        readonly signer_address: v.StringSchema<undefined>;
+        readonly weight: v.NumberSchema<undefined>;
+        readonly stacked_amount: v.StringSchema<undefined>;
+        readonly weight_percent: v.NumberSchema<undefined>;
+        readonly stacked_amount_percent: v.NumberSchema<undefined>;
+        readonly pooled_stacker_count: v.NumberSchema<undefined>;
+        readonly solo_stacker_count: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly limit: v.NumberSchema<undefined>;
+    readonly offset: v.NumberSchema<undefined>;
+    readonly total: v.NumberSchema<undefined>;
+}, undefined>;
+type SignersResponse = v.InferOutput<typeof signersResponseSchema>;
+declare function signersInCycle(args: Args$1): Promise<Result<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type signersInCycle$1_Signer = Signer;
+type signersInCycle$1_SignersResponse = SignersResponse;
+declare const signersInCycle$1_signerSchema: typeof signerSchema;
+declare const signersInCycle$1_signersInCycle: typeof signersInCycle;
+declare const signersInCycle$1_signersResponseSchema: typeof signersResponseSchema;
+declare namespace signersInCycle$1 {
+  export { type Args$1 as Args, type Results$1 as Results, type signersInCycle$1_Signer as Signer, type signersInCycle$1_SignersResponse as SignersResponse, resultsSchema$1 as resultsSchema, signersInCycle$1_signerSchema as signerSchema, signersInCycle$1_signersInCycle as signersInCycle, signersInCycle$1_signersResponseSchema as signersResponseSchema };
+}
+
+type Args = {
+    cycleNumber: number;
+    signerPublicKey: string;
+} & ApiRequestOptions & ApiPaginationOptions;
+declare const stackerInfoSchema: v.ObjectSchema<{
+    readonly stacker_address: v.StringSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly pox_address: v.StringSchema<undefined>;
+    readonly stacker_type: v.UnionSchema<[v.LiteralSchema<"pooled", undefined>, v.LiteralSchema<"solo", undefined>], undefined>;
+}, undefined>;
+type StackerInfo = v.InferOutput<typeof stackerInfoSchema>;
+declare const resultsSchema: v.ArraySchema<v.ObjectSchema<{
+    readonly stacker_address: v.StringSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly pox_address: v.StringSchema<undefined>;
+    readonly stacker_type: v.UnionSchema<[v.LiteralSchema<"pooled", undefined>, v.LiteralSchema<"solo", undefined>], undefined>;
+}, undefined>, undefined>;
+type Results = v.InferOutput<typeof resultsSchema>;
+declare const stackersForSignerInCycleResponseSchema: v.ObjectSchema<{
+    readonly results: v.ArraySchema<v.ObjectSchema<{
+        readonly stacker_address: v.StringSchema<undefined>;
+        readonly stacked_amount: v.StringSchema<undefined>;
+        readonly pox_address: v.StringSchema<undefined>;
+        readonly stacker_type: v.UnionSchema<[v.LiteralSchema<"pooled", undefined>, v.LiteralSchema<"solo", undefined>], undefined>;
+    }, undefined>, undefined>;
+    readonly limit: v.NumberSchema<undefined>;
+    readonly offset: v.NumberSchema<undefined>;
+    readonly total: v.NumberSchema<undefined>;
+}, undefined>;
+type StackersForSignerInCycleResponse = v.InferOutput<typeof stackersForSignerInCycleResponseSchema>;
+declare function stackersForSignerInCycle(opts: Args): Promise<Result<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type stackersForSignerInCycle$1_Args = Args;
+type stackersForSignerInCycle$1_Results = Results;
+type stackersForSignerInCycle$1_StackerInfo = StackerInfo;
+type stackersForSignerInCycle$1_StackersForSignerInCycleResponse = StackersForSignerInCycleResponse;
+declare const stackersForSignerInCycle$1_resultsSchema: typeof resultsSchema;
+declare const stackersForSignerInCycle$1_stackerInfoSchema: typeof stackerInfoSchema;
+declare const stackersForSignerInCycle$1_stackersForSignerInCycle: typeof stackersForSignerInCycle;
+declare const stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema: typeof stackersForSignerInCycleResponseSchema;
+declare namespace stackersForSignerInCycle$1 {
+  export { type stackersForSignerInCycle$1_Args as Args, type stackersForSignerInCycle$1_Results as Results, type stackersForSignerInCycle$1_StackerInfo as StackerInfo, type stackersForSignerInCycle$1_StackersForSignerInCycleResponse as StackersForSignerInCycleResponse, stackersForSignerInCycle$1_resultsSchema as resultsSchema, stackersForSignerInCycle$1_stackerInfoSchema as stackerInfoSchema, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle, stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema as stackersForSignerInCycleResponseSchema };
+}
+
+declare const index$1_cycle: typeof cycle;
+declare const index$1_cycles: typeof cycles;
+declare const index$1_signerInCycle: typeof signerInCycle;
+declare const index$1_signersInCycle: typeof signersInCycle;
+declare const index$1_stackersForSignerInCycle: typeof stackersForSignerInCycle;
+declare namespace index$1 {
+  export { cycle$1 as Cycle, cycles$1 as Cycles, signerInCycle$1 as SignerInCycle, signersInCycle$1 as SignersInCycle, stackersForSignerInCycle$1 as StackersForSignerInCycle, index$1_cycle as cycle, index$1_cycles as cycles, index$1_signerInCycle as signerInCycle, index$1_signersInCycle as signersInCycle, index$1_stackersForSignerInCycle as stackersForSignerInCycle };
+}
+
+declare namespace index {
+  export { index$4 as Accounts, index$3 as Blocks, index$2 as Info, index$1 as ProofOfTransfer, index$4 as accounts, index$3 as blocks, index$2 as info, index$1 as proofOfTransfer };
+}
+
+export { index as StacksApi, index as stacksApi };