@secretkeylabs/stacks-tools 0.3.0-6dd40b1 → 0.3.0-9a0fdf3

package/dist/index.cjs

@@ -31,7 +31,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   queries: () => queries,
-  stacksApi: () => stacksApi
+  stacksApi: () => stacksApi,
+  stacksRpcApi: () => stacksRpcApi
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -503,6 +504,8 @@ async function signerInCycle(args) {
       name: "FetchSignerInCycleError",
       message: "Failed to fetch signer in cycle.",
       data: {
+        ...args,
+        endpoint,
         status: res.status,
         statusText: res.statusText
       }
@@ -617,7 +620,8 @@ async function stackersForSignerInCycle(opts) {
       [opts.apiKeyConfig.header]: opts.apiKeyConfig.key
     };
   }
-  const endpoint = `${opts.baseUrl}/extended/v2/pox/cycles/${opts.cycleNumber}/signers/${opts.signerPublicKey}/stackers?${search}`;
+  const signerPublicKey = opts.signerPublicKey.startsWith("0x") ? opts.signerPublicKey : `0x${opts.signerPublicKey}`;
+  const endpoint = `${opts.baseUrl}/extended/v2/pox/cycles/${opts.cycleNumber}/signers/${signerPublicKey}/stackers?${search}`;
   const res = await fetch(endpoint, init);
   if (!res.ok) {
     return error({
@@ -674,15 +678,15 @@ var readOnlyResponseSchema = v11.variant("okay", [
     cause: v11.unknown()
   })
 ]);
-async function readOnly(opts, apiOpts) {
+async function readOnly(args) {
   const init = {};
-  if (apiOpts.apiKeyConfig) {
+  if (args.apiKeyConfig) {
     init.headers = {
-      [apiOpts.apiKeyConfig.header]: apiOpts.apiKeyConfig.key
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
     };
   }
   const res = await fetch(
-    `${apiOpts.baseUrl}/v2/contracts/call-read/${opts.contractAddress}/${opts.contractName}/${opts.functionName}`,
+    `${args.baseUrl}/v2/contracts/call-read/${args.contractAddress}/${args.contractName}/${args.functionName}`,
     init
   );
   if (!res.ok) {
@@ -736,22 +740,20 @@ var membersResponseSchema = v12.object({
   total: v12.number(),
   results: v12.array(memberSchema)
 });
-async function members(opts, apiOpts) {
+async function members(args) {
   const search = new URLSearchParams();
-  if (opts.afterBlock) search.append("after_block", opts.afterBlock.toString());
-  if (opts.unanchored) search.append("unanchored", "true");
-  if (opts.limit) search.append("limit", opts.limit.toString());
-  if (opts.offset) search.append("offset", opts.offset.toString());
+  if (args.afterBlock) search.append("after_block", args.afterBlock.toString());
+  if (args.unanchored) search.append("unanchored", "true");
+  if (args.limit) search.append("limit", args.limit.toString());
+  if (args.offset) search.append("offset", args.offset.toString());
   const init = {};
-  if (apiOpts.apiKeyConfig) {
+  if (args.apiKeyConfig) {
     init.headers = {
-      [apiOpts.apiKeyConfig.header]: apiOpts.apiKeyConfig.key
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
     };
   }
-  const res = await fetch(
-    `${apiOpts.baseUrl}/extended/beta/stacking/${opts.poolPrincipal}/delegations?${search}`,
-    init
-  );
+  const endpoint = `${args.baseUrl}/extended/v1/pox4/${args.poolPrincipal}/delegations?${search}`;
+  const res = await fetch(endpoint, init);
   if (!res.ok) {
     return error({
       name: "FetchMembersError",
@@ -992,10 +994,52 @@ var transactions = {
   getTransaction
 };
 
+// src/stacks-api/faucets/stx.ts
+async function stx(opts) {
+  const search = new URLSearchParams();
+  search.append("address", opts.address);
+  if (opts.stacking) search.append("stacking", "true");
+  const init = {};
+  if (opts.apiKeyConfig) {
+    init.headers = {
+      [opts.apiKeyConfig.header]: opts.apiKeyConfig.key
+    };
+  }
+  init.method = "POST";
+  const endpoint = `${opts.baseUrl}/extended/v1/faucets/stx?${search}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetchStxError",
+      message: "Failed to fetch STX.",
+      data: {
+        status: res.status,
+        statusText: res.statusText,
+        bodyParseResult: await safePromise(res.json())
+      }
+    });
+  }
+  const [jsonError, data] = await safePromise(res.json());
+  if (jsonError) {
+    return error({
+      name: "ParseBodyError",
+      message: "Failed to parse response body as JSON.",
+      data: jsonError
+    });
+  }
+  return success(data);
+}
+
+// src/stacks-api/faucets/index.ts
+var faucets = {
+  stx
+};
+
 // src/stacks-api/index.ts
 var stacksApi = {
   accounts,
   blocks,
+  faucets,
   info,
   proofOfTransfer,
   smartContracts,
@@ -1003,6 +1047,72 @@ var stacksApi = {
   transactions
 };
 
+// src/stacks-rpc-api/smart-contracts/map-entry.ts
+var v16 = __toESM(require("valibot"), 1);
+var mapEntryResponseSchema = v16.object({
+  /**
+   * Hex-encoded string of clarity value. It is always an optional tuple.
+   */
+  data: v16.string(),
+  /**
+   * Hex-encoded string of the MARF proof for the data
+   */
+  proof: v16.optional(v16.string())
+});
+async function mapEntry(args) {
+  const search = new URLSearchParams();
+  if (args.proof === 0) search.append("proof", "0");
+  if (args.tip) search.append("tip", args.tip);
+  const init = {};
+  if (args.apiKeyConfig) {
+    init.headers = {
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
+    };
+  }
+  init.method = "POST";
+  init.body = args.mapKey;
+  const endpoint = `${args.baseUrl}/v2/map_entry/${args.contractAddress}/${args.contractName}/${args.mapName}?${search}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetchMapEntryError",
+      message: "Failed to fetch map entry.",
+      data: {
+        status: res.status,
+        statusText: res.statusText,
+        bodyParseResult: await safePromise(res.json())
+      }
+    });
+  }
+  const [jsonError, data] = await safePromise(res.json());
+  if (jsonError) {
+    return error({
+      name: "ParseBodyError",
+      message: "Failed to parse response body as JSON.",
+      data: jsonError
+    });
+  }
+  const validationResult = v16.safeParse(mapEntryResponseSchema, data);
+  if (!validationResult.success) {
+    return error({
+      name: "ValidateDataError",
+      message: "Failed to validate response data.",
+      data: validationResult
+    });
+  }
+  return success(validationResult.output);
+}
+
+// src/stacks-rpc-api/smart-contracts/index.ts
+var smartContracts2 = {
+  mapEntry
+};
+
+// src/stacks-rpc-api/index.ts
+var stacksRpcApi = {
+  smartContracts: smartContracts2
+};
+
 // src/utils/call-rate-limited-api.ts
 var import_exponential_backoff = require("exponential-backoff");
 async function safeCallRateLimitedApi(fn, options) {
@@ -1084,5 +1194,6 @@ var queries = {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   queries,
-  stacksApi
+  stacksApi,
+  stacksRpcApi
 });

package/dist/index.d.cts

@@ -15,6 +15,13 @@ type ApiRequestOptions = {
     baseUrl: string;
     apiKeyConfig?: ApiKeyConfig;
 };
+type ProofAndTip = {
+    /**
+     * Returns object without the proof field when set to 0.
+     */
+    proof?: number;
+    tip?: "latest" | string;
+};
 type ApiPaginationOptions = {
     /**
      * The number of items to return. Each endpoint has its own maximum allowed
@@ -171,12 +178,12 @@ declare const transactionSchema: v.VariantSchema<"tx_type", [v.ObjectSchema<{
 }, undefined>], undefined>;
 type Transaction = v.InferOutput<typeof transactionSchema>;
 
-type Args$a = {
+type Args$e = {
     transactionId: string;
 } & ApiRequestOptions;
-declare function getTransaction(args: Args$a): Promise<Result<Transaction>>;
+declare function getTransaction(args: Args$e): Promise<Result<Transaction>>;
 
-type Args$9 = {
+type Args$d = {
     address: string;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const addressTransactionsResponseSchema: v.ObjectSchema<{
@@ -342,15 +349,15 @@ declare const addressTransactionsResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function addressTransactions(args: Args$d): Promise<Result<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Options$1 = {
+type Args$c = {
     poolPrincipal: string;
     afterBlock?: number;
     unanchored?: boolean;
     limit?: number;
     offset?: number;
-};
+} & ApiRequestOptions & ApiPaginationOptions;
 declare const membersResponseSchema: v.ObjectSchema<{
     readonly limit: v.NumberSchema<undefined>;
     readonly offset: v.NumberSchema<undefined>;
@@ -365,15 +372,15 @@ declare const membersResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type MembersResponse = v.InferOutput<typeof membersResponseSchema>;
-declare function members(opts: Options$1, apiOpts: ApiRequestOptions): Promise<Result<MembersResponse>>;
+declare function members(args: Args$c): Promise<Result<MembersResponse>>;
 
-type Options = {
+type Args$b = {
     sender: string;
     arguments: string[];
     contractAddress: string;
     contractName: string;
     functionName: string;
-};
+} & ApiRequestOptions;
 declare const readOnlyResponseSchema: v.VariantSchema<"okay", [v.ObjectSchema<{
     readonly okay: v.LiteralSchema<true, undefined>;
     readonly result: v.StringSchema<undefined>;
@@ -382,9 +389,9 @@ declare const readOnlyResponseSchema: v.VariantSchema<"okay", [v.ObjectSchema<{
     readonly cause: v.UnknownSchema;
 }, undefined>], undefined>;
 type ReadOnlyResponse = v.InferOutput<typeof readOnlyResponseSchema>;
-declare function readOnly(opts: Options, apiOpts: ApiRequestOptions): Promise<Result<ReadOnlyResponse>>;
+declare function readOnly(args: Args$b): Promise<Result<ReadOnlyResponse>>;
 
-type Args$8 = {
+type Args$a = {
     cycleNumber: number;
     signerPublicKey: string;
 } & ApiRequestOptions & ApiPaginationOptions;
@@ -400,9 +407,9 @@ declare const stackersForSignerInCycleResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function stackersForSignerInCycle(opts: Args$a): Promise<Result<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$7 = {
+type Args$9 = {
     cycleNumber: number;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const signersResponseSchema: v.ObjectSchema<{
@@ -421,9 +428,9 @@ declare const signersResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function signersInCycle(args: Args$9): Promise<Result<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$6 = {
+type Args$8 = {
     /**
      * The signers public key as a hex string, with or without a '0x' prefix.
      */
@@ -441,9 +448,9 @@ declare const signerInCycleResponseSchema: v.ObjectSchema<{
     readonly pooled_stacker_count: v.NumberSchema<undefined>;
 }, undefined>;
 type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
-declare function signerInCycle(args: Args$6): Promise<Result<SignerInCycleResponse>>;
+declare function signerInCycle(args: Args$8): Promise<Result<SignerInCycleResponse>>;
 
-type Args$5 = ApiRequestOptions & ApiPaginationOptions;
+type Args$7 = ApiRequestOptions & ApiPaginationOptions;
 declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly results: v.ArraySchema<v.ObjectSchema<{
         readonly block_height: v.NumberSchema<undefined>;
@@ -458,9 +465,9 @@ declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
-declare function cycles(args: Args$5): Promise<Result<CyclesResponse>>;
+declare function cycles(args: Args$7): Promise<Result<CyclesResponse>>;
 
-type Args$4 = {
+type Args$6 = {
     cycleNumber: number;
 } & ApiRequestOptions;
 declare const responseSchema$2: v.ObjectSchema<{
@@ -472,9 +479,9 @@ declare const responseSchema$2: v.ObjectSchema<{
     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">>>;
+declare function cycle(opts: Args$6): Promise<Result<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$3 = ApiRequestOptions;
+type Args$5 = ApiRequestOptions;
 declare const poxDetailsResponseSchema: v.ObjectSchema<{
     readonly contract_id: v.StringSchema<undefined>;
     readonly pox_activation_threshold_ustx: v.NumberSchema<undefined>;
@@ -528,7 +535,7 @@ declare const poxDetailsResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type PoxDetailsResponse = v.InferOutput<typeof poxDetailsResponseSchema>;
-declare function poxDetails(args: Args$3): Promise<Result<PoxDetailsResponse>>;
+declare function poxDetails(args: Args$5): Promise<Result<PoxDetailsResponse>>;
 
 declare const CoreApiResponseSchema: v.ObjectSchema<{
     readonly peer_version: v.NumberSchema<undefined>;
@@ -548,7 +555,18 @@ declare const CoreApiResponseSchema: v.ObjectSchema<{
 type CoreApiResponse = v.InferOutput<typeof CoreApiResponseSchema>;
 declare function coreApi(apiOpts: ApiRequestOptions): Promise<Result<CoreApiResponse>>;
 
-type Args$2 = {
+type Args$4 = {
+    address: string;
+    stacking?: boolean;
+} & ApiRequestOptions;
+declare function stx(opts: Args$4): Promise<Result<any>>;
+
+declare const stx$1_stx: typeof stx;
+declare namespace stx$1 {
+  export { type Args$4 as Args, stx$1_stx as stx };
+}
+
+type Args$3 = {
     heightOrHash: string | number;
 } & ApiRequestOptions;
 declare const responseSchema$1: v.ObjectSchema<{
@@ -573,9 +591,9 @@ declare const responseSchema$1: v.ObjectSchema<{
     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">>>;
+declare function getBlock(opts: Args$3): Promise<Result<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$1 = {
+type Args$2 = {
     principal: string;
     unanchored?: boolean;
     untilBlock?: number;
@@ -605,7 +623,16 @@ declare const responseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type Response = v.InferOutput<typeof responseSchema>;
-declare function balances(opts: Args$1): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function balances(opts: Args$2): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+
+declare const faucets: {
+    stx: typeof stx;
+};
+
+declare const index$1_faucets: typeof faucets;
+declare namespace index$1 {
+  export { stx$1 as Stx, index$1_faucets as faucets };
+}
 
 declare const stacksApi: {
     accounts: {
@@ -614,6 +641,9 @@ declare const stacksApi: {
     blocks: {
         getBlock: typeof getBlock;
     };
+    faucets: {
+        stx: typeof stx;
+    };
     info: {
         coreApi: typeof coreApi;
         poxDetails: typeof poxDetails;
@@ -637,6 +667,36 @@ declare const stacksApi: {
     };
 };
 
+declare const index_stacksApi: typeof stacksApi;
+declare namespace index {
+  export { index$1 as Faucets, index_stacksApi as stacksApi };
+}
+
+type Args$1 = {
+    contractAddress: string;
+    contractName: string;
+    mapName: string;
+    mapKey: string;
+} & ApiRequestOptions & ProofAndTip;
+declare const mapEntryResponseSchema: v.ObjectSchema<{
+    /**
+     * Hex-encoded string of clarity value. It is always an optional tuple.
+     */
+    readonly data: v.StringSchema<undefined>;
+    /**
+     * Hex-encoded string of the MARF proof for the data
+     */
+    readonly proof: v.OptionalSchema<v.StringSchema<undefined>, never>;
+}, undefined>;
+type MapEntryResponse = v.InferOutput<typeof mapEntryResponseSchema>;
+declare function mapEntry(args: Args$1): Promise<Result<MapEntryResponse>>;
+
+declare const stacksRpcApi: {
+    smartContracts: {
+        mapEntry: typeof mapEntry;
+    };
+};
+
 type Identifier = {
     type: "address";
     signerAddress: string;
@@ -658,4 +718,4 @@ declare const queries: {
     getSignerStackedAmount: typeof getSignerStackedAmount;
 };
 
-export { queries, stacksApi };
+export { index as StacksApi, queries, stacksApi, stacksRpcApi };

package/dist/index.d.ts

@@ -15,6 +15,13 @@ type ApiRequestOptions = {
     baseUrl: string;
     apiKeyConfig?: ApiKeyConfig;
 };
+type ProofAndTip = {
+    /**
+     * Returns object without the proof field when set to 0.
+     */
+    proof?: number;
+    tip?: "latest" | string;
+};
 type ApiPaginationOptions = {
     /**
      * The number of items to return. Each endpoint has its own maximum allowed
@@ -171,12 +178,12 @@ declare const transactionSchema: v.VariantSchema<"tx_type", [v.ObjectSchema<{
 }, undefined>], undefined>;
 type Transaction = v.InferOutput<typeof transactionSchema>;
 
-type Args$a = {
+type Args$e = {
     transactionId: string;
 } & ApiRequestOptions;
-declare function getTransaction(args: Args$a): Promise<Result<Transaction>>;
+declare function getTransaction(args: Args$e): Promise<Result<Transaction>>;
 
-type Args$9 = {
+type Args$d = {
     address: string;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const addressTransactionsResponseSchema: v.ObjectSchema<{
@@ -342,15 +349,15 @@ declare const addressTransactionsResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function addressTransactions(args: Args$d): Promise<Result<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Options$1 = {
+type Args$c = {
     poolPrincipal: string;
     afterBlock?: number;
     unanchored?: boolean;
     limit?: number;
     offset?: number;
-};
+} & ApiRequestOptions & ApiPaginationOptions;
 declare const membersResponseSchema: v.ObjectSchema<{
     readonly limit: v.NumberSchema<undefined>;
     readonly offset: v.NumberSchema<undefined>;
@@ -365,15 +372,15 @@ declare const membersResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type MembersResponse = v.InferOutput<typeof membersResponseSchema>;
-declare function members(opts: Options$1, apiOpts: ApiRequestOptions): Promise<Result<MembersResponse>>;
+declare function members(args: Args$c): Promise<Result<MembersResponse>>;
 
-type Options = {
+type Args$b = {
     sender: string;
     arguments: string[];
     contractAddress: string;
     contractName: string;
     functionName: string;
-};
+} & ApiRequestOptions;
 declare const readOnlyResponseSchema: v.VariantSchema<"okay", [v.ObjectSchema<{
     readonly okay: v.LiteralSchema<true, undefined>;
     readonly result: v.StringSchema<undefined>;
@@ -382,9 +389,9 @@ declare const readOnlyResponseSchema: v.VariantSchema<"okay", [v.ObjectSchema<{
     readonly cause: v.UnknownSchema;
 }, undefined>], undefined>;
 type ReadOnlyResponse = v.InferOutput<typeof readOnlyResponseSchema>;
-declare function readOnly(opts: Options, apiOpts: ApiRequestOptions): Promise<Result<ReadOnlyResponse>>;
+declare function readOnly(args: Args$b): Promise<Result<ReadOnlyResponse>>;
 
-type Args$8 = {
+type Args$a = {
     cycleNumber: number;
     signerPublicKey: string;
 } & ApiRequestOptions & ApiPaginationOptions;
@@ -400,9 +407,9 @@ declare const stackersForSignerInCycleResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function stackersForSignerInCycle(opts: Args$a): Promise<Result<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$7 = {
+type Args$9 = {
     cycleNumber: number;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const signersResponseSchema: v.ObjectSchema<{
@@ -421,9 +428,9 @@ declare const signersResponseSchema: v.ObjectSchema<{
     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">>>;
+declare function signersInCycle(args: Args$9): Promise<Result<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$6 = {
+type Args$8 = {
     /**
      * The signers public key as a hex string, with or without a '0x' prefix.
      */
@@ -441,9 +448,9 @@ declare const signerInCycleResponseSchema: v.ObjectSchema<{
     readonly pooled_stacker_count: v.NumberSchema<undefined>;
 }, undefined>;
 type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
-declare function signerInCycle(args: Args$6): Promise<Result<SignerInCycleResponse>>;
+declare function signerInCycle(args: Args$8): Promise<Result<SignerInCycleResponse>>;
 
-type Args$5 = ApiRequestOptions & ApiPaginationOptions;
+type Args$7 = ApiRequestOptions & ApiPaginationOptions;
 declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly results: v.ArraySchema<v.ObjectSchema<{
         readonly block_height: v.NumberSchema<undefined>;
@@ -458,9 +465,9 @@ declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
-declare function cycles(args: Args$5): Promise<Result<CyclesResponse>>;
+declare function cycles(args: Args$7): Promise<Result<CyclesResponse>>;
 
-type Args$4 = {
+type Args$6 = {
     cycleNumber: number;
 } & ApiRequestOptions;
 declare const responseSchema$2: v.ObjectSchema<{
@@ -472,9 +479,9 @@ declare const responseSchema$2: v.ObjectSchema<{
     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">>>;
+declare function cycle(opts: Args$6): Promise<Result<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$3 = ApiRequestOptions;
+type Args$5 = ApiRequestOptions;
 declare const poxDetailsResponseSchema: v.ObjectSchema<{
     readonly contract_id: v.StringSchema<undefined>;
     readonly pox_activation_threshold_ustx: v.NumberSchema<undefined>;
@@ -528,7 +535,7 @@ declare const poxDetailsResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type PoxDetailsResponse = v.InferOutput<typeof poxDetailsResponseSchema>;
-declare function poxDetails(args: Args$3): Promise<Result<PoxDetailsResponse>>;
+declare function poxDetails(args: Args$5): Promise<Result<PoxDetailsResponse>>;
 
 declare const CoreApiResponseSchema: v.ObjectSchema<{
     readonly peer_version: v.NumberSchema<undefined>;
@@ -548,7 +555,18 @@ declare const CoreApiResponseSchema: v.ObjectSchema<{
 type CoreApiResponse = v.InferOutput<typeof CoreApiResponseSchema>;
 declare function coreApi(apiOpts: ApiRequestOptions): Promise<Result<CoreApiResponse>>;
 
-type Args$2 = {
+type Args$4 = {
+    address: string;
+    stacking?: boolean;
+} & ApiRequestOptions;
+declare function stx(opts: Args$4): Promise<Result<any>>;
+
+declare const stx$1_stx: typeof stx;
+declare namespace stx$1 {
+  export { type Args$4 as Args, stx$1_stx as stx };
+}
+
+type Args$3 = {
     heightOrHash: string | number;
 } & ApiRequestOptions;
 declare const responseSchema$1: v.ObjectSchema<{
@@ -573,9 +591,9 @@ declare const responseSchema$1: v.ObjectSchema<{
     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">>>;
+declare function getBlock(opts: Args$3): Promise<Result<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
 
-type Args$1 = {
+type Args$2 = {
     principal: string;
     unanchored?: boolean;
     untilBlock?: number;
@@ -605,7 +623,16 @@ declare const responseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type Response = v.InferOutput<typeof responseSchema>;
-declare function balances(opts: Args$1): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function balances(opts: Args$2): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+
+declare const faucets: {
+    stx: typeof stx;
+};
+
+declare const index$1_faucets: typeof faucets;
+declare namespace index$1 {
+  export { stx$1 as Stx, index$1_faucets as faucets };
+}
 
 declare const stacksApi: {
     accounts: {
@@ -614,6 +641,9 @@ declare const stacksApi: {
     blocks: {
         getBlock: typeof getBlock;
     };
+    faucets: {
+        stx: typeof stx;
+    };
     info: {
         coreApi: typeof coreApi;
         poxDetails: typeof poxDetails;
@@ -637,6 +667,36 @@ declare const stacksApi: {
     };
 };
 
+declare const index_stacksApi: typeof stacksApi;
+declare namespace index {
+  export { index$1 as Faucets, index_stacksApi as stacksApi };
+}
+
+type Args$1 = {
+    contractAddress: string;
+    contractName: string;
+    mapName: string;
+    mapKey: string;
+} & ApiRequestOptions & ProofAndTip;
+declare const mapEntryResponseSchema: v.ObjectSchema<{
+    /**
+     * Hex-encoded string of clarity value. It is always an optional tuple.
+     */
+    readonly data: v.StringSchema<undefined>;
+    /**
+     * Hex-encoded string of the MARF proof for the data
+     */
+    readonly proof: v.OptionalSchema<v.StringSchema<undefined>, never>;
+}, undefined>;
+type MapEntryResponse = v.InferOutput<typeof mapEntryResponseSchema>;
+declare function mapEntry(args: Args$1): Promise<Result<MapEntryResponse>>;
+
+declare const stacksRpcApi: {
+    smartContracts: {
+        mapEntry: typeof mapEntry;
+    };
+};
+
 type Identifier = {
     type: "address";
     signerAddress: string;
@@ -658,4 +718,4 @@ declare const queries: {
     getSignerStackedAmount: typeof getSignerStackedAmount;
 };
 
-export { queries, stacksApi };
+export { index as StacksApi, queries, stacksApi, stacksRpcApi };

package/dist/index.js

@@ -466,6 +466,8 @@ async function signerInCycle(args) {
       name: "FetchSignerInCycleError",
       message: "Failed to fetch signer in cycle.",
       data: {
+        ...args,
+        endpoint,
         status: res.status,
         statusText: res.statusText
       }
@@ -580,7 +582,8 @@ async function stackersForSignerInCycle(opts) {
       [opts.apiKeyConfig.header]: opts.apiKeyConfig.key
     };
   }
-  const endpoint = `${opts.baseUrl}/extended/v2/pox/cycles/${opts.cycleNumber}/signers/${opts.signerPublicKey}/stackers?${search}`;
+  const signerPublicKey = opts.signerPublicKey.startsWith("0x") ? opts.signerPublicKey : `0x${opts.signerPublicKey}`;
+  const endpoint = `${opts.baseUrl}/extended/v2/pox/cycles/${opts.cycleNumber}/signers/${signerPublicKey}/stackers?${search}`;
   const res = await fetch(endpoint, init);
   if (!res.ok) {
     return error({
@@ -637,15 +640,15 @@ var readOnlyResponseSchema = v11.variant("okay", [
     cause: v11.unknown()
   })
 ]);
-async function readOnly(opts, apiOpts) {
+async function readOnly(args) {
   const init = {};
-  if (apiOpts.apiKeyConfig) {
+  if (args.apiKeyConfig) {
     init.headers = {
-      [apiOpts.apiKeyConfig.header]: apiOpts.apiKeyConfig.key
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
     };
   }
   const res = await fetch(
-    `${apiOpts.baseUrl}/v2/contracts/call-read/${opts.contractAddress}/${opts.contractName}/${opts.functionName}`,
+    `${args.baseUrl}/v2/contracts/call-read/${args.contractAddress}/${args.contractName}/${args.functionName}`,
     init
   );
   if (!res.ok) {
@@ -699,22 +702,20 @@ var membersResponseSchema = v12.object({
   total: v12.number(),
   results: v12.array(memberSchema)
 });
-async function members(opts, apiOpts) {
+async function members(args) {
   const search = new URLSearchParams();
-  if (opts.afterBlock) search.append("after_block", opts.afterBlock.toString());
-  if (opts.unanchored) search.append("unanchored", "true");
-  if (opts.limit) search.append("limit", opts.limit.toString());
-  if (opts.offset) search.append("offset", opts.offset.toString());
+  if (args.afterBlock) search.append("after_block", args.afterBlock.toString());
+  if (args.unanchored) search.append("unanchored", "true");
+  if (args.limit) search.append("limit", args.limit.toString());
+  if (args.offset) search.append("offset", args.offset.toString());
   const init = {};
-  if (apiOpts.apiKeyConfig) {
+  if (args.apiKeyConfig) {
     init.headers = {
-      [apiOpts.apiKeyConfig.header]: apiOpts.apiKeyConfig.key
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
     };
   }
-  const res = await fetch(
-    `${apiOpts.baseUrl}/extended/beta/stacking/${opts.poolPrincipal}/delegations?${search}`,
-    init
-  );
+  const endpoint = `${args.baseUrl}/extended/v1/pox4/${args.poolPrincipal}/delegations?${search}`;
+  const res = await fetch(endpoint, init);
   if (!res.ok) {
     return error({
       name: "FetchMembersError",
@@ -955,10 +956,52 @@ var transactions = {
   getTransaction
 };
 
+// src/stacks-api/faucets/stx.ts
+async function stx(opts) {
+  const search = new URLSearchParams();
+  search.append("address", opts.address);
+  if (opts.stacking) search.append("stacking", "true");
+  const init = {};
+  if (opts.apiKeyConfig) {
+    init.headers = {
+      [opts.apiKeyConfig.header]: opts.apiKeyConfig.key
+    };
+  }
+  init.method = "POST";
+  const endpoint = `${opts.baseUrl}/extended/v1/faucets/stx?${search}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetchStxError",
+      message: "Failed to fetch STX.",
+      data: {
+        status: res.status,
+        statusText: res.statusText,
+        bodyParseResult: await safePromise(res.json())
+      }
+    });
+  }
+  const [jsonError, data] = await safePromise(res.json());
+  if (jsonError) {
+    return error({
+      name: "ParseBodyError",
+      message: "Failed to parse response body as JSON.",
+      data: jsonError
+    });
+  }
+  return success(data);
+}
+
+// src/stacks-api/faucets/index.ts
+var faucets = {
+  stx
+};
+
 // src/stacks-api/index.ts
 var stacksApi = {
   accounts,
   blocks,
+  faucets,
   info,
   proofOfTransfer,
   smartContracts,
@@ -966,6 +1009,72 @@ var stacksApi = {
   transactions
 };
 
+// src/stacks-rpc-api/smart-contracts/map-entry.ts
+import * as v16 from "valibot";
+var mapEntryResponseSchema = v16.object({
+  /**
+   * Hex-encoded string of clarity value. It is always an optional tuple.
+   */
+  data: v16.string(),
+  /**
+   * Hex-encoded string of the MARF proof for the data
+   */
+  proof: v16.optional(v16.string())
+});
+async function mapEntry(args) {
+  const search = new URLSearchParams();
+  if (args.proof === 0) search.append("proof", "0");
+  if (args.tip) search.append("tip", args.tip);
+  const init = {};
+  if (args.apiKeyConfig) {
+    init.headers = {
+      [args.apiKeyConfig.header]: args.apiKeyConfig.key
+    };
+  }
+  init.method = "POST";
+  init.body = args.mapKey;
+  const endpoint = `${args.baseUrl}/v2/map_entry/${args.contractAddress}/${args.contractName}/${args.mapName}?${search}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetchMapEntryError",
+      message: "Failed to fetch map entry.",
+      data: {
+        status: res.status,
+        statusText: res.statusText,
+        bodyParseResult: await safePromise(res.json())
+      }
+    });
+  }
+  const [jsonError, data] = await safePromise(res.json());
+  if (jsonError) {
+    return error({
+      name: "ParseBodyError",
+      message: "Failed to parse response body as JSON.",
+      data: jsonError
+    });
+  }
+  const validationResult = v16.safeParse(mapEntryResponseSchema, data);
+  if (!validationResult.success) {
+    return error({
+      name: "ValidateDataError",
+      message: "Failed to validate response data.",
+      data: validationResult
+    });
+  }
+  return success(validationResult.output);
+}
+
+// src/stacks-rpc-api/smart-contracts/index.ts
+var smartContracts2 = {
+  mapEntry
+};
+
+// src/stacks-rpc-api/index.ts
+var stacksRpcApi = {
+  smartContracts: smartContracts2
+};
+
 // src/utils/call-rate-limited-api.ts
 import { backOff } from "exponential-backoff";
 async function safeCallRateLimitedApi(fn, options) {
@@ -1046,5 +1155,6 @@ var queries = {
 };
 export {
   queries,
-  stacksApi
+  stacksApi,
+  stacksRpcApi
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secretkeylabs/stacks-tools",
-  "version": "0.3.0-6dd40b1",
+  "version": "0.3.0-9a0fdf3",
   "type": "module",
   "files": [
     "dist"