@secretkeylabs/stacks-tools 0.2.0 → 0.3.0-05c5288

package/dist/index.d.ts

@@ -1,2 +1,661 @@
-export { stacksApi } from "./stacks-api/index.js";
-export { queries } from "./queries/index.js";
+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;
+};
+
+/**
+ * Incomplete schema of some transaction types.
+ */
+declare const transactionSchema: v.VariantSchema<"tx_type", [v.ObjectSchema<{
+    readonly tx_id: v.StringSchema<undefined>;
+    readonly nonce: v.NumberSchema<undefined>;
+    readonly fee_rate: v.StringSchema<undefined>;
+    readonly sender_address: v.StringSchema<undefined>;
+    readonly sponsored: v.BooleanSchema<undefined>;
+    readonly post_condition_mode: v.StringSchema<undefined>;
+    readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+    readonly anchor_mode: v.StringSchema<undefined>;
+    readonly is_unanchored: v.BooleanSchema<undefined>;
+    readonly block_hash: v.StringSchema<undefined>;
+    readonly parent_block_hash: v.StringSchema<undefined>;
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly block_time: v.NumberSchema<undefined>;
+    readonly block_time_iso: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly burn_block_time: v.NumberSchema<undefined>;
+    readonly burn_block_time_iso: v.StringSchema<undefined>;
+    readonly parent_burn_block_time: v.NumberSchema<undefined>;
+    readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+    readonly canonical: v.BooleanSchema<undefined>;
+    readonly tx_index: v.NumberSchema<undefined>;
+    readonly tx_status: v.StringSchema<undefined>;
+    readonly tx_result: v.ObjectSchema<{
+        readonly hex: v.StringSchema<undefined>;
+        readonly repr: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly microblock_hash: v.StringSchema<undefined>;
+    readonly microblock_sequence: v.NumberSchema<undefined>;
+    readonly microblock_canonical: v.BooleanSchema<undefined>;
+    readonly event_count: v.NumberSchema<undefined>;
+    readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+    readonly tx_type: v.LiteralSchema<"contract_call", undefined>;
+    readonly contract_call: v.ObjectSchema<{
+        readonly contract_id: v.StringSchema<undefined>;
+        readonly function_name: v.StringSchema<undefined>;
+        readonly function_signature: v.StringSchema<undefined>;
+        readonly function_args: v.ArraySchema<v.ObjectSchema<{
+            readonly hex: v.StringSchema<undefined>;
+            readonly repr: v.StringSchema<undefined>;
+            readonly name: v.StringSchema<undefined>;
+            readonly type: v.StringSchema<undefined>;
+        }, undefined>, undefined>;
+    }, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly tx_id: v.StringSchema<undefined>;
+    readonly nonce: v.NumberSchema<undefined>;
+    readonly fee_rate: v.StringSchema<undefined>;
+    readonly sender_address: v.StringSchema<undefined>;
+    readonly sponsored: v.BooleanSchema<undefined>;
+    readonly post_condition_mode: v.StringSchema<undefined>;
+    readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+    readonly anchor_mode: v.StringSchema<undefined>;
+    readonly is_unanchored: v.BooleanSchema<undefined>;
+    readonly block_hash: v.StringSchema<undefined>;
+    readonly parent_block_hash: v.StringSchema<undefined>;
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly block_time: v.NumberSchema<undefined>;
+    readonly block_time_iso: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly burn_block_time: v.NumberSchema<undefined>;
+    readonly burn_block_time_iso: v.StringSchema<undefined>;
+    readonly parent_burn_block_time: v.NumberSchema<undefined>;
+    readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+    readonly canonical: v.BooleanSchema<undefined>;
+    readonly tx_index: v.NumberSchema<undefined>;
+    readonly tx_status: v.StringSchema<undefined>;
+    readonly tx_result: v.ObjectSchema<{
+        readonly hex: v.StringSchema<undefined>;
+        readonly repr: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly microblock_hash: v.StringSchema<undefined>;
+    readonly microblock_sequence: v.NumberSchema<undefined>;
+    readonly microblock_canonical: v.BooleanSchema<undefined>;
+    readonly event_count: v.NumberSchema<undefined>;
+    readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+    readonly tx_type: v.LiteralSchema<"smart_contract", undefined>;
+    readonly smart_contract: v.ObjectSchema<{
+        /**
+         * NOTE: The types may be wrong, not sure what type of value is used when
+         * the version is not `null`.
+         */
+        readonly clarity_version: v.UnionSchema<[v.NullSchema<undefined>, v.NumberSchema<undefined>], undefined>;
+        readonly contract_id: v.StringSchema<undefined>;
+        readonly source_code: v.StringSchema<undefined>;
+    }, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly tx_id: v.StringSchema<undefined>;
+    readonly nonce: v.NumberSchema<undefined>;
+    readonly fee_rate: v.StringSchema<undefined>;
+    readonly sender_address: v.StringSchema<undefined>;
+    readonly sponsored: v.BooleanSchema<undefined>;
+    readonly post_condition_mode: v.StringSchema<undefined>;
+    readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+    readonly anchor_mode: v.StringSchema<undefined>;
+    readonly is_unanchored: v.BooleanSchema<undefined>;
+    readonly block_hash: v.StringSchema<undefined>;
+    readonly parent_block_hash: v.StringSchema<undefined>;
+    readonly block_height: v.NumberSchema<undefined>;
+    readonly block_time: v.NumberSchema<undefined>;
+    readonly block_time_iso: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly burn_block_time: v.NumberSchema<undefined>;
+    readonly burn_block_time_iso: v.StringSchema<undefined>;
+    readonly parent_burn_block_time: v.NumberSchema<undefined>;
+    readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+    readonly canonical: v.BooleanSchema<undefined>;
+    readonly tx_index: v.NumberSchema<undefined>;
+    readonly tx_status: v.StringSchema<undefined>;
+    readonly tx_result: v.ObjectSchema<{
+        readonly hex: v.StringSchema<undefined>;
+        readonly repr: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly microblock_hash: v.StringSchema<undefined>;
+    readonly microblock_sequence: v.NumberSchema<undefined>;
+    readonly microblock_canonical: v.BooleanSchema<undefined>;
+    readonly event_count: v.NumberSchema<undefined>;
+    readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+    readonly tx_type: v.LiteralSchema<"token_transfer", undefined>;
+    readonly token_transfer: v.ObjectSchema<{
+        readonly recipient_address: v.StringSchema<undefined>;
+        readonly amount: v.StringSchema<undefined>;
+        readonly memo: v.StringSchema<undefined>;
+    }, undefined>;
+}, undefined>], undefined>;
+type Transaction = v.InferOutput<typeof transactionSchema>;
+
+type Args$a = {
+    transactionId: string;
+} & ApiRequestOptions;
+declare function getTransaction(args: Args$a): Promise<Result<Transaction>>;
+
+type Args$9 = {
+    address: string;
+} & ApiRequestOptions & ApiPaginationOptions;
+declare const addressTransactionsResponseSchema: v.ObjectSchema<{
+    readonly results: v.ArraySchema<v.ObjectSchema<{
+        readonly tx: v.VariantSchema<"tx_type", [v.ObjectSchema<{
+            readonly tx_id: v.StringSchema<undefined>;
+            readonly nonce: v.NumberSchema<undefined>;
+            readonly fee_rate: v.StringSchema<undefined>;
+            readonly sender_address: v.StringSchema<undefined>;
+            readonly sponsored: v.BooleanSchema<undefined>;
+            readonly post_condition_mode: v.StringSchema<undefined>;
+            readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+            readonly anchor_mode: v.StringSchema<undefined>;
+            readonly is_unanchored: v.BooleanSchema<undefined>;
+            readonly block_hash: v.StringSchema<undefined>;
+            readonly parent_block_hash: v.StringSchema<undefined>;
+            readonly block_height: v.NumberSchema<undefined>;
+            readonly block_time: v.NumberSchema<undefined>;
+            readonly block_time_iso: v.StringSchema<undefined>;
+            readonly burn_block_height: v.NumberSchema<undefined>;
+            readonly burn_block_time: v.NumberSchema<undefined>;
+            readonly burn_block_time_iso: v.StringSchema<undefined>;
+            readonly parent_burn_block_time: v.NumberSchema<undefined>;
+            readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+            readonly canonical: v.BooleanSchema<undefined>;
+            readonly tx_index: v.NumberSchema<undefined>;
+            readonly tx_status: v.StringSchema<undefined>;
+            readonly tx_result: v.ObjectSchema<{
+                readonly hex: v.StringSchema<undefined>;
+                readonly repr: v.StringSchema<undefined>;
+            }, undefined>;
+            readonly microblock_hash: v.StringSchema<undefined>;
+            readonly microblock_sequence: v.NumberSchema<undefined>;
+            readonly microblock_canonical: v.BooleanSchema<undefined>;
+            readonly event_count: v.NumberSchema<undefined>;
+            readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+            readonly tx_type: v.LiteralSchema<"contract_call", undefined>;
+            readonly contract_call: v.ObjectSchema<{
+                readonly contract_id: v.StringSchema<undefined>;
+                readonly function_name: v.StringSchema<undefined>;
+                readonly function_signature: v.StringSchema<undefined>;
+                readonly function_args: v.ArraySchema<v.ObjectSchema<{
+                    readonly hex: v.StringSchema<undefined>;
+                    readonly repr: v.StringSchema<undefined>;
+                    readonly name: v.StringSchema<undefined>;
+                    readonly type: v.StringSchema<undefined>;
+                }, undefined>, undefined>;
+            }, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly tx_id: v.StringSchema<undefined>;
+            readonly nonce: v.NumberSchema<undefined>;
+            readonly fee_rate: v.StringSchema<undefined>;
+            readonly sender_address: v.StringSchema<undefined>;
+            readonly sponsored: v.BooleanSchema<undefined>;
+            readonly post_condition_mode: v.StringSchema<undefined>;
+            readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+            readonly anchor_mode: v.StringSchema<undefined>;
+            readonly is_unanchored: v.BooleanSchema<undefined>;
+            readonly block_hash: v.StringSchema<undefined>;
+            readonly parent_block_hash: v.StringSchema<undefined>;
+            readonly block_height: v.NumberSchema<undefined>;
+            readonly block_time: v.NumberSchema<undefined>;
+            readonly block_time_iso: v.StringSchema<undefined>;
+            readonly burn_block_height: v.NumberSchema<undefined>;
+            readonly burn_block_time: v.NumberSchema<undefined>;
+            readonly burn_block_time_iso: v.StringSchema<undefined>;
+            readonly parent_burn_block_time: v.NumberSchema<undefined>;
+            readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+            readonly canonical: v.BooleanSchema<undefined>;
+            readonly tx_index: v.NumberSchema<undefined>;
+            readonly tx_status: v.StringSchema<undefined>;
+            readonly tx_result: v.ObjectSchema<{
+                readonly hex: v.StringSchema<undefined>;
+                readonly repr: v.StringSchema<undefined>;
+            }, undefined>;
+            readonly microblock_hash: v.StringSchema<undefined>;
+            readonly microblock_sequence: v.NumberSchema<undefined>;
+            readonly microblock_canonical: v.BooleanSchema<undefined>;
+            readonly event_count: v.NumberSchema<undefined>;
+            readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+            readonly tx_type: v.LiteralSchema<"smart_contract", undefined>;
+            readonly smart_contract: v.ObjectSchema<{
+                readonly clarity_version: v.UnionSchema<[v.NullSchema<undefined>, v.NumberSchema<undefined>], undefined>;
+                readonly contract_id: v.StringSchema<undefined>;
+                readonly source_code: v.StringSchema<undefined>;
+            }, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly tx_id: v.StringSchema<undefined>;
+            readonly nonce: v.NumberSchema<undefined>;
+            readonly fee_rate: v.StringSchema<undefined>;
+            readonly sender_address: v.StringSchema<undefined>;
+            readonly sponsored: v.BooleanSchema<undefined>;
+            readonly post_condition_mode: v.StringSchema<undefined>;
+            readonly post_conditions: v.ArraySchema<v.UnknownSchema, undefined>;
+            readonly anchor_mode: v.StringSchema<undefined>;
+            readonly is_unanchored: v.BooleanSchema<undefined>;
+            readonly block_hash: v.StringSchema<undefined>;
+            readonly parent_block_hash: v.StringSchema<undefined>;
+            readonly block_height: v.NumberSchema<undefined>;
+            readonly block_time: v.NumberSchema<undefined>;
+            readonly block_time_iso: v.StringSchema<undefined>;
+            readonly burn_block_height: v.NumberSchema<undefined>;
+            readonly burn_block_time: v.NumberSchema<undefined>;
+            readonly burn_block_time_iso: v.StringSchema<undefined>;
+            readonly parent_burn_block_time: v.NumberSchema<undefined>;
+            readonly parent_burn_block_time_iso: v.StringSchema<undefined>;
+            readonly canonical: v.BooleanSchema<undefined>;
+            readonly tx_index: v.NumberSchema<undefined>;
+            readonly tx_status: v.StringSchema<undefined>;
+            readonly tx_result: v.ObjectSchema<{
+                readonly hex: v.StringSchema<undefined>;
+                readonly repr: v.StringSchema<undefined>;
+            }, undefined>;
+            readonly microblock_hash: v.StringSchema<undefined>;
+            readonly microblock_sequence: v.NumberSchema<undefined>;
+            readonly microblock_canonical: v.BooleanSchema<undefined>;
+            readonly event_count: v.NumberSchema<undefined>;
+            readonly events: v.ArraySchema<v.UnknownSchema, 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>;
+            readonly tx_type: v.LiteralSchema<"token_transfer", undefined>;
+            readonly token_transfer: v.ObjectSchema<{
+                readonly recipient_address: v.StringSchema<undefined>;
+                readonly amount: v.StringSchema<undefined>;
+                readonly memo: v.StringSchema<undefined>;
+            }, undefined>;
+        }, undefined>], undefined>;
+        readonly stx_sent: v.StringSchema<undefined>;
+        readonly stx_received: v.StringSchema<undefined>;
+        readonly events: v.ObjectSchema<{
+            readonly stx: v.ObjectSchema<{
+                readonly transfer: v.NumberSchema<undefined>;
+                readonly mint: v.NumberSchema<undefined>;
+                readonly burn: v.NumberSchema<undefined>;
+            }, undefined>;
+            readonly ft: v.ObjectSchema<{
+                readonly transfer: v.NumberSchema<undefined>;
+                readonly mint: v.NumberSchema<undefined>;
+                readonly burn: v.NumberSchema<undefined>;
+            }, undefined>;
+            readonly nft: v.ObjectSchema<{
+                readonly transfer: v.NumberSchema<undefined>;
+                readonly mint: v.NumberSchema<undefined>;
+                readonly burn: v.NumberSchema<undefined>;
+            }, undefined>;
+        }, undefined>;
+    }, undefined>, undefined>;
+    readonly limit: v.NumberSchema<undefined>;
+    readonly offset: v.NumberSchema<undefined>;
+    readonly total: v.NumberSchema<undefined>;
+}, undefined>;
+type AddressTransactionsResponse = v.InferOutput<typeof addressTransactionsResponseSchema>;
+declare function addressTransactions(args: Args$9): Promise<Result<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type Options$1 = {
+    poolPrincipal: string;
+    afterBlock?: number;
+    unanchored?: boolean;
+    limit?: number;
+    offset?: number;
+};
+declare const membersResponseSchema: v.ObjectSchema<{
+    readonly limit: v.NumberSchema<undefined>;
+    readonly offset: v.NumberSchema<undefined>;
+    readonly total: v.NumberSchema<undefined>;
+    readonly results: v.ArraySchema<v.ObjectSchema<{
+        readonly stacker: v.StringSchema<undefined>;
+        readonly pox_addr: v.OptionalSchema<v.StringSchema<undefined>, never>;
+        readonly amount_ustx: v.StringSchema<undefined>;
+        readonly burn_block_unlock_height: v.OptionalSchema<v.NumberSchema<undefined>, never>;
+        readonly block_height: v.NumberSchema<undefined>;
+        readonly tx_id: v.StringSchema<undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type MembersResponse = v.InferOutput<typeof membersResponseSchema>;
+declare function members(opts: Options$1, apiOpts: ApiRequestOptions): Promise<Result<MembersResponse>>;
+
+type Options = {
+    sender: string;
+    arguments: string[];
+    contractAddress: string;
+    contractName: string;
+    functionName: string;
+};
+declare const readOnlyResponseSchema: v.VariantSchema<"okay", [v.ObjectSchema<{
+    readonly okay: v.LiteralSchema<true, undefined>;
+    readonly result: v.StringSchema<undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly okay: v.LiteralSchema<false, undefined>;
+    readonly cause: v.UnknownSchema;
+}, undefined>], undefined>;
+type ReadOnlyResponse = v.InferOutput<typeof readOnlyResponseSchema>;
+declare function readOnly(opts: Options, apiOpts: ApiRequestOptions): Promise<Result<ReadOnlyResponse>>;
+
+type Args$8 = {
+    cycleNumber: number;
+    signerPublicKey: string;
+} & ApiRequestOptions & ApiPaginationOptions;
+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$8): Promise<Result<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type Args$7 = {
+    cycleNumber: number;
+} & ApiRequestOptions & ApiPaginationOptions;
+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$7): Promise<Result<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type Args$6 = {
+    /**
+     * 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$6): Promise<Result<SignerInCycleResponse>>;
+
+type Args$5 = ApiRequestOptions & ApiPaginationOptions;
+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$5): Promise<Result<CyclesResponse>>;
+
+type Args$4 = {
+    cycleNumber: number;
+} & ApiRequestOptions;
+declare const responseSchema$2: 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$2 = v.InferOutput<typeof responseSchema$2>;
+declare function cycle(opts: Args$4): Promise<Result<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type Args$3 = 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$3): Promise<Result<PoxDetailsResponse>>;
+
+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 Args$2 = {
+    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$2): Promise<Result<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
+
+type Args$1 = {
+    principal: string;
+    unanchored?: boolean;
+    untilBlock?: number;
+} & ApiRequestOptions;
+declare const responseSchema: 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 = v.InferOutput<typeof responseSchema>;
+declare function balances(opts: Args$1): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+
+declare const stacksApi: {
+    accounts: {
+        balances: typeof balances;
+    };
+    blocks: {
+        getBlock: typeof getBlock;
+    };
+    info: {
+        coreApi: typeof coreApi;
+        poxDetails: typeof poxDetails;
+    };
+    proofOfTransfer: {
+        cycle: typeof cycle;
+        cycles: typeof cycles;
+        signerInCycle: typeof signerInCycle;
+        signersInCycle: typeof signersInCycle;
+        stackersForSignerInCycle: typeof stackersForSignerInCycle;
+    };
+    smartContracts: {
+        readOnly: typeof readOnly;
+    };
+    stackingPool: {
+        members: typeof members;
+    };
+    transactions: {
+        addressTransactions: typeof addressTransactions;
+        getTransaction: typeof getTransaction;
+    };
+};
+
+type Identifier = {
+    type: "address";
+    signerAddress: string;
+} | {
+    type: "publicKey";
+    signerPublicKey: string;
+};
+type Args = {
+    identifier: Identifier;
+} & {
+    cycleNumber: number;
+} & ApiRequestOptions;
+/**
+ * Return the total locked amount for a signer in a PoX cycle.
+ */
+declare function getSignerStackedAmount(args: Args): Promise<Result<bigint, SafeError<"SignerNotFound" | string>>>;
+
+declare const queries: {
+    getSignerStackedAmount: typeof getSignerStackedAmount;
+};
+
+export { queries, stacksApi };