@secretkeylabs/stacks-tools 0.6.0-d6a9ecd → 0.6.0

package/dist/index.cjs

@@ -1108,8 +1108,46 @@ async function readOnly(args) {
   return success(data);
 }
 
+// src/stacks-rpc-api/smart-contracts/interface.ts
+async function contractInterface(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
+    };
+  }
+  const endpoint = `${args.baseUrl}/v2/contracts/interface/${args.contractAddress}/${args.contractName}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetcContractInterfaceError",
+      message: "Failed to fetch contract interface.",
+      data: {
+        init,
+        status: res.status,
+        statusText: res.statusText,
+        endpoint,
+        bodyText: await safePromise(res.text())
+      }
+    });
+  }
+  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-rpc-api/smart-contracts/index.ts
 var smartContracts = {
+  contractInterface,
   mapEntry,
   readOnly
 };

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { MempoolTransaction, OperationResponse } from '@stacks/blockchain-api-client';
 import * as v from 'valibot';
-import { OptionalCV, TupleCV, BufferCV, UIntCV, PrincipalCV, ListCV } from '@stacks/transactions';
+import { ClarityAbi, OptionalCV, TupleCV, BufferCV, UIntCV, PrincipalCV, ListCV } from '@stacks/transactions';
 
 type SafeError<TName extends string = string, TData = unknown> = {
     readonly name: TName;
@@ -49,7 +49,7 @@ type ListResponse<T = unknown> = {
     results: T[];
 };
 
-type Args$j = {
+type Args$k = {
     /**
      * Filter to only return transactions with this sender address.
      */
@@ -74,7 +74,7 @@ type Args$j = {
     order?: "asc" | "desc";
 } & ApiRequestOptions & ApiPaginationOptions;
 type MempoolTransactionsResponse = ListResponse<MempoolTransaction>;
-declare function mempoolTransactions(args: Args$j): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function mempoolTransactions(args: Args$k): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type mempoolTransactions$1_MempoolTransactionsResponse = MempoolTransactionsResponse;
 declare const mempoolTransactions$1_mempoolTransactions: typeof mempoolTransactions;
@@ -421,17 +421,17 @@ declare namespace schemas {
   export { type schemas_ContractCallTransaction as ContractCallTransaction, type schemas_SmartContractTransaction as SmartContractTransaction, type schemas_Transaction as Transaction, schemas_baseTransactionSchema as baseTransactionSchema, schemas_contractCallTransactionSchema as contractCallTransactionSchema, schemas_smartContractTransactionSchema as smartContractTransactionSchema, schemas_tokenTransferSchema as tokenTransferSchema, schemas_transactionSchema as transactionSchema };
 }
 
-type Args$i = {
+type Args$j = {
     transactionId: string;
 } & ApiRequestOptions;
-declare function getTransaction(args: Args$i): Promise<Result$1<Transaction>>;
+declare function getTransaction(args: Args$j): Promise<Result$1<Transaction>>;
 
 declare const getTransaction$1_getTransaction: typeof getTransaction;
 declare namespace getTransaction$1 {
   export { getTransaction$1_getTransaction as getTransaction };
 }
 
-type Args$h = {
+type Args$i = {
     address: string;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const resultSchema: v.ObjectSchema<{
@@ -913,7 +913,7 @@ declare const addressTransactionsResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type AddressTransactionsResponse = v.InferOutput<typeof addressTransactionsResponseSchema>;
-declare function addressTransactions(args: Args$h): Promise<Result$1<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function addressTransactions(args: Args$i): Promise<Result$1<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type addressTransactions$1_AddressTransactionsResponse = AddressTransactionsResponse;
 type addressTransactions$1_Result = Result;
@@ -922,7 +922,7 @@ declare namespace addressTransactions$1 {
   export { type addressTransactions$1_AddressTransactionsResponse as AddressTransactionsResponse, type addressTransactions$1_Result as Result, type Results$3 as Results, addressTransactions$1_addressTransactions as addressTransactions };
 }
 
-type Args$g = {
+type Args$h = {
     poolPrincipal: string;
     afterBlock?: number;
     unanchored?: boolean;
@@ -952,7 +952,7 @@ declare const membersResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type MembersResponse = v.InferOutput<typeof membersResponseSchema>;
-declare function members(args: Args$g): Promise<Result$1<MembersResponse>>;
+declare function members(args: Args$h): Promise<Result$1<MembersResponse>>;
 
 type members$1_Member = Member;
 type members$1_MembersResponse = MembersResponse;
@@ -960,10 +960,10 @@ declare const members$1_memberSchema: typeof memberSchema;
 declare const members$1_members: typeof members;
 declare const members$1_membersResponseSchema: typeof membersResponseSchema;
 declare namespace members$1 {
-  export { type Args$g as Args, type members$1_Member as Member, type members$1_MembersResponse as MembersResponse, members$1_memberSchema as memberSchema, members$1_members as members, members$1_membersResponseSchema as membersResponseSchema };
+  export { type Args$h as Args, type members$1_Member as Member, type members$1_MembersResponse as MembersResponse, members$1_memberSchema as memberSchema, members$1_members as members, members$1_membersResponseSchema as membersResponseSchema };
 }
 
-type Args$f = {
+type Args$g = {
     cycleNumber: number;
     signerPublicKey: string;
 } & ApiRequestOptions & ApiPaginationOptions;
@@ -993,7 +993,7 @@ declare const stackersForSignerInCycleResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type StackersForSignerInCycleResponse = v.InferOutput<typeof stackersForSignerInCycleResponseSchema>;
-declare function stackersForSignerInCycle(opts: Args$f): Promise<Result$1<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function stackersForSignerInCycle(opts: Args$g): Promise<Result$1<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type stackersForSignerInCycle$1_StackerInfo = StackerInfo;
 type stackersForSignerInCycle$1_StackersForSignerInCycleResponse = StackersForSignerInCycleResponse;
@@ -1001,10 +1001,10 @@ declare const stackersForSignerInCycle$1_stackerInfoSchema: typeof stackerInfoSc
 declare const stackersForSignerInCycle$1_stackersForSignerInCycle: typeof stackersForSignerInCycle;
 declare const stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema: typeof stackersForSignerInCycleResponseSchema;
 declare namespace stackersForSignerInCycle$1 {
-  export { type Args$f as Args, type Results$2 as Results, type stackersForSignerInCycle$1_StackerInfo as StackerInfo, type stackersForSignerInCycle$1_StackersForSignerInCycleResponse as StackersForSignerInCycleResponse, resultsSchema$2 as resultsSchema, stackersForSignerInCycle$1_stackerInfoSchema as stackerInfoSchema, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle, stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema as stackersForSignerInCycleResponseSchema };
+  export { type Args$g as Args, type Results$2 as Results, type stackersForSignerInCycle$1_StackerInfo as StackerInfo, type stackersForSignerInCycle$1_StackersForSignerInCycleResponse as StackersForSignerInCycleResponse, resultsSchema$2 as resultsSchema, stackersForSignerInCycle$1_stackerInfoSchema as stackerInfoSchema, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle, stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema as stackersForSignerInCycleResponseSchema };
 }
 
-type Args$e = {
+type Args$f = {
     cycleNumber: number;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const signerSchema: v.ObjectSchema<{
@@ -1045,7 +1045,7 @@ declare const signersResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type SignersResponse = v.InferOutput<typeof signersResponseSchema>;
-declare function signersInCycle(args: Args$e): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function signersInCycle(args: Args$f): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type signersInCycle$1_Signer = Signer;
 type signersInCycle$1_SignersResponse = SignersResponse;
@@ -1053,10 +1053,10 @@ 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$e 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 };
+  export { type Args$f 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$d = {
+type Args$e = {
     /**
      * The signers public key as a hex string, with or without a '0x' prefix.
      */
@@ -1074,16 +1074,16 @@ declare const signerInCycleResponseSchema: v.ObjectSchema<{
     readonly pooled_stacker_count: v.NumberSchema<undefined>;
 }, undefined>;
 type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
-declare function signerInCycle(args: Args$d): Promise<Result$1<SignerInCycleResponse>>;
+declare function signerInCycle(args: Args$e): Promise<Result$1<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$d as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
+  export { type Args$e as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
 }
 
-type Args$c = ApiRequestOptions & ApiPaginationOptions;
+type Args$d = ApiRequestOptions & ApiPaginationOptions;
 declare const cycleInfoSchema: v.ObjectSchema<{
     readonly block_height: v.NumberSchema<undefined>;
     readonly index_block_hash: v.StringSchema<undefined>;
@@ -1116,7 +1116,7 @@ declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
-declare function cycles(args: Args$c): Promise<Result$1<CyclesResponse>>;
+declare function cycles(args: Args$d): Promise<Result$1<CyclesResponse>>;
 
 type cycles$1_CycleInfo = CycleInfo;
 type cycles$1_CyclesResponse = CyclesResponse;
@@ -1126,10 +1126,10 @@ declare const cycles$1_cycles: typeof cycles;
 declare const cycles$1_cyclesResponseSchema: typeof cyclesResponseSchema;
 declare const cycles$1_resultsSchema: typeof resultsSchema;
 declare namespace cycles$1 {
-  export { type Args$c as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
+  export { type Args$d as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
 }
 
-type Args$b = {
+type Args$c = {
     cycleNumber: number;
 } & ApiRequestOptions;
 declare const responseSchema$2: v.ObjectSchema<{
@@ -1141,11 +1141,11 @@ 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$b): Promise<Result$1<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function cycle(opts: Args$c): Promise<Result$1<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const cycle$1_cycle: typeof cycle;
 declare namespace cycle$1 {
-  export { type Args$b as Args, type Response$2 as Response, cycle$1_cycle as cycle, responseSchema$2 as responseSchema };
+  export { type Args$c as Args, type Response$2 as Response, cycle$1_cycle as cycle, responseSchema$2 as responseSchema };
 }
 
 type FeePrioritiesResponse = {
@@ -1207,18 +1207,18 @@ declare namespace coreApi$1 {
   export { type coreApi$1_CoreApiResponse as CoreApiResponse, coreApi$1_coreApi as coreApi };
 }
 
-type Args$a = {
+type Args$b = {
     address: string;
     stacking?: boolean;
 } & ApiRequestOptions;
-declare function stx(opts: Args$a): Promise<Result$1<any>>;
+declare function stx(opts: Args$b): Promise<Result$1<any>>;
 
 declare const stx$1_stx: typeof stx;
 declare namespace stx$1 {
-  export { type Args$a as Args, stx$1_stx as stx };
+  export { type Args$b as Args, stx$1_stx as stx };
 }
 
-type Args$9 = {
+type Args$a = {
     heightOrHash: string | number;
 } & ApiRequestOptions;
 declare const responseSchema$1: v.ObjectSchema<{
@@ -1243,14 +1243,14 @@ 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$9): Promise<Result$1<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function getBlock(opts: Args$a): Promise<Result$1<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const getBlock$1_getBlock: typeof getBlock;
 declare namespace getBlock$1 {
-  export { type Args$9 as Args, type Response$1 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
+  export { type Args$a as Args, type Response$1 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
 }
 
-type Args$8 = {
+type Args$9 = {
     principal: string;
 } & ApiRequestOptions;
 declare const responseSchema: v.ObjectSchema<{
@@ -1261,25 +1261,25 @@ declare const responseSchema: v.ObjectSchema<{
     readonly detected_mempool_nonces: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
 }, undefined>;
 type Response = v.InferOutput<typeof responseSchema>;
-declare function latestNonce(opts: Args$8): Promise<Result$1<Response, SafeError<"FetchLatestNonceError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function latestNonce(opts: Args$9): Promise<Result$1<Response, SafeError<"FetchLatestNonceError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type latestNonce$1_Response = Response;
 declare const latestNonce$1_latestNonce: typeof latestNonce;
 declare const latestNonce$1_responseSchema: typeof responseSchema;
 declare namespace latestNonce$1 {
-  export { type Args$8 as Args, type latestNonce$1_Response as Response, latestNonce$1_latestNonce as latestNonce, latestNonce$1_responseSchema as responseSchema };
+  export { type Args$9 as Args, type latestNonce$1_Response as Response, latestNonce$1_latestNonce as latestNonce, latestNonce$1_responseSchema as responseSchema };
 }
 
-type Args$7 = {
+type Args$8 = {
     principal: string;
     unanchored?: boolean;
     untilBlock?: number;
 } & ApiRequestOptions;
-declare function balances(opts: Args$7): Promise<Result$1<OperationResponse["get_account_balance"], SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function balances(opts: Args$8): Promise<Result$1<OperationResponse["get_account_balance"], SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const balances$1_balances: typeof balances;
 declare namespace balances$1 {
-  export { type Args$7 as Args, balances$1_balances as balances };
+  export { type Args$8 as Args, balances$1_balances as balances };
 }
 
 declare const accounts: {
@@ -1400,7 +1400,7 @@ declare namespace index$6 {
   export { index$e as Accounts, index$d as Blocks, index$c as Faucets, index$b as Info, index$7 as Mempool, index$a as ProofOfTransfer, index$9 as StackingPool, index$8 as Transactions, index$6_stacksApi as stacksApi };
 }
 
-type Args$6 = {
+type Args$7 = {
     sender: string;
     arguments: string[];
     contractAddress: string;
@@ -1417,15 +1417,15 @@ interface ReadOnlyContractCallFailResponse {
 }
 type ReadOnlyContractCallResponse = ReadOnlyContractCallSuccessResponse | ReadOnlyContractCallFailResponse;
 type ReadOnlyResponse = ReadOnlyContractCallResponse;
-declare function readOnly$1(args: Args$6): Promise<Result$1<ReadOnlyResponse>>;
+declare function readOnly$1(args: Args$7): Promise<Result$1<ReadOnlyResponse>>;
 
 type readOnly$2_ReadOnlyContractCallResponse = ReadOnlyContractCallResponse;
 type readOnly$2_ReadOnlyResponse = ReadOnlyResponse;
 declare namespace readOnly$2 {
-  export { type Args$6 as Args, type readOnly$2_ReadOnlyContractCallResponse as ReadOnlyContractCallResponse, type readOnly$2_ReadOnlyResponse as ReadOnlyResponse, readOnly$1 as readOnly };
+  export { type Args$7 as Args, type readOnly$2_ReadOnlyContractCallResponse as ReadOnlyContractCallResponse, type readOnly$2_ReadOnlyResponse as ReadOnlyResponse, readOnly$1 as readOnly };
 }
 
-type Args$5 = {
+type Args$6 = {
     contractAddress: string;
     contractName: string;
     mapName: string;
@@ -1445,12 +1445,25 @@ declare const mapEntryResponseSchema: v.ObjectSchema<{
     readonly proof: v.OptionalSchema<v.StringSchema<undefined>, never>;
 }, undefined>;
 type MapEntryResponse = v.InferOutput<typeof mapEntryResponseSchema>;
-declare function mapEntry(args: Args$5): Promise<Result$1<MapEntryResponse>>;
+declare function mapEntry(args: Args$6): Promise<Result$1<MapEntryResponse>>;
 
 type mapEntry$1_MapEntryResponse = MapEntryResponse;
 declare const mapEntry$1_mapEntry: typeof mapEntry;
 declare namespace mapEntry$1 {
-  export { type Args$5 as Args, type mapEntry$1_MapEntryResponse as MapEntryResponse, mapEntry$1_mapEntry as mapEntry };
+  export { type Args$6 as Args, type mapEntry$1_MapEntryResponse as MapEntryResponse, mapEntry$1_mapEntry as mapEntry };
+}
+
+type Args$5 = {
+    contractAddress: string;
+    contractName: string;
+} & ApiRequestOptions & ProofAndTip;
+type InterfaceResponse = ClarityAbi;
+declare function contractInterface(args: Args$5): Promise<Result$1<InterfaceResponse>>;
+
+type _interface_InterfaceResponse = InterfaceResponse;
+declare const _interface_contractInterface: typeof contractInterface;
+declare namespace _interface {
+  export { type Args$5 as Args, type _interface_InterfaceResponse as InterfaceResponse, _interface_contractInterface as contractInterface };
 }
 
 type Args$4 = ApiRequestOptions;
@@ -1608,13 +1621,14 @@ declare namespace poxDetails$1 {
 }
 
 declare const smartContracts: {
+    contractInterface: typeof contractInterface;
     mapEntry: typeof mapEntry;
     readOnly: typeof readOnly$1;
 };
 
 declare const index$5_smartContracts: typeof smartContracts;
 declare namespace index$5 {
-  export { mapEntry$1 as MapEntry, readOnly$2 as ReadOnly, index$5_smartContracts as smartContracts };
+  export { _interface as ContractInterface, mapEntry$1 as MapEntry, readOnly$2 as ReadOnly, index$5_smartContracts as smartContracts };
 }
 
 declare const pox: {
@@ -1631,6 +1645,7 @@ declare const stacksRpcApi: {
         poxDetails: typeof poxDetails;
     };
     smartContracts: {
+        contractInterface: typeof contractInterface;
         mapEntry: typeof mapEntry;
         readOnly: typeof readOnly$1;
     };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { MempoolTransaction, OperationResponse } from '@stacks/blockchain-api-client';
 import * as v from 'valibot';
-import { OptionalCV, TupleCV, BufferCV, UIntCV, PrincipalCV, ListCV } from '@stacks/transactions';
+import { ClarityAbi, OptionalCV, TupleCV, BufferCV, UIntCV, PrincipalCV, ListCV } from '@stacks/transactions';
 
 type SafeError<TName extends string = string, TData = unknown> = {
     readonly name: TName;
@@ -49,7 +49,7 @@ type ListResponse<T = unknown> = {
     results: T[];
 };
 
-type Args$j = {
+type Args$k = {
     /**
      * Filter to only return transactions with this sender address.
      */
@@ -74,7 +74,7 @@ type Args$j = {
     order?: "asc" | "desc";
 } & ApiRequestOptions & ApiPaginationOptions;
 type MempoolTransactionsResponse = ListResponse<MempoolTransaction>;
-declare function mempoolTransactions(args: Args$j): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function mempoolTransactions(args: Args$k): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type mempoolTransactions$1_MempoolTransactionsResponse = MempoolTransactionsResponse;
 declare const mempoolTransactions$1_mempoolTransactions: typeof mempoolTransactions;
@@ -421,17 +421,17 @@ declare namespace schemas {
   export { type schemas_ContractCallTransaction as ContractCallTransaction, type schemas_SmartContractTransaction as SmartContractTransaction, type schemas_Transaction as Transaction, schemas_baseTransactionSchema as baseTransactionSchema, schemas_contractCallTransactionSchema as contractCallTransactionSchema, schemas_smartContractTransactionSchema as smartContractTransactionSchema, schemas_tokenTransferSchema as tokenTransferSchema, schemas_transactionSchema as transactionSchema };
 }
 
-type Args$i = {
+type Args$j = {
     transactionId: string;
 } & ApiRequestOptions;
-declare function getTransaction(args: Args$i): Promise<Result$1<Transaction>>;
+declare function getTransaction(args: Args$j): Promise<Result$1<Transaction>>;
 
 declare const getTransaction$1_getTransaction: typeof getTransaction;
 declare namespace getTransaction$1 {
   export { getTransaction$1_getTransaction as getTransaction };
 }
 
-type Args$h = {
+type Args$i = {
     address: string;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const resultSchema: v.ObjectSchema<{
@@ -913,7 +913,7 @@ declare const addressTransactionsResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type AddressTransactionsResponse = v.InferOutput<typeof addressTransactionsResponseSchema>;
-declare function addressTransactions(args: Args$h): Promise<Result$1<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function addressTransactions(args: Args$i): Promise<Result$1<AddressTransactionsResponse, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type addressTransactions$1_AddressTransactionsResponse = AddressTransactionsResponse;
 type addressTransactions$1_Result = Result;
@@ -922,7 +922,7 @@ declare namespace addressTransactions$1 {
   export { type addressTransactions$1_AddressTransactionsResponse as AddressTransactionsResponse, type addressTransactions$1_Result as Result, type Results$3 as Results, addressTransactions$1_addressTransactions as addressTransactions };
 }
 
-type Args$g = {
+type Args$h = {
     poolPrincipal: string;
     afterBlock?: number;
     unanchored?: boolean;
@@ -952,7 +952,7 @@ declare const membersResponseSchema: v.ObjectSchema<{
     }, undefined>, undefined>;
 }, undefined>;
 type MembersResponse = v.InferOutput<typeof membersResponseSchema>;
-declare function members(args: Args$g): Promise<Result$1<MembersResponse>>;
+declare function members(args: Args$h): Promise<Result$1<MembersResponse>>;
 
 type members$1_Member = Member;
 type members$1_MembersResponse = MembersResponse;
@@ -960,10 +960,10 @@ declare const members$1_memberSchema: typeof memberSchema;
 declare const members$1_members: typeof members;
 declare const members$1_membersResponseSchema: typeof membersResponseSchema;
 declare namespace members$1 {
-  export { type Args$g as Args, type members$1_Member as Member, type members$1_MembersResponse as MembersResponse, members$1_memberSchema as memberSchema, members$1_members as members, members$1_membersResponseSchema as membersResponseSchema };
+  export { type Args$h as Args, type members$1_Member as Member, type members$1_MembersResponse as MembersResponse, members$1_memberSchema as memberSchema, members$1_members as members, members$1_membersResponseSchema as membersResponseSchema };
 }
 
-type Args$f = {
+type Args$g = {
     cycleNumber: number;
     signerPublicKey: string;
 } & ApiRequestOptions & ApiPaginationOptions;
@@ -993,7 +993,7 @@ declare const stackersForSignerInCycleResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type StackersForSignerInCycleResponse = v.InferOutput<typeof stackersForSignerInCycleResponseSchema>;
-declare function stackersForSignerInCycle(opts: Args$f): Promise<Result$1<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function stackersForSignerInCycle(opts: Args$g): Promise<Result$1<StackersForSignerInCycleResponse, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type stackersForSignerInCycle$1_StackerInfo = StackerInfo;
 type stackersForSignerInCycle$1_StackersForSignerInCycleResponse = StackersForSignerInCycleResponse;
@@ -1001,10 +1001,10 @@ declare const stackersForSignerInCycle$1_stackerInfoSchema: typeof stackerInfoSc
 declare const stackersForSignerInCycle$1_stackersForSignerInCycle: typeof stackersForSignerInCycle;
 declare const stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema: typeof stackersForSignerInCycleResponseSchema;
 declare namespace stackersForSignerInCycle$1 {
-  export { type Args$f as Args, type Results$2 as Results, type stackersForSignerInCycle$1_StackerInfo as StackerInfo, type stackersForSignerInCycle$1_StackersForSignerInCycleResponse as StackersForSignerInCycleResponse, resultsSchema$2 as resultsSchema, stackersForSignerInCycle$1_stackerInfoSchema as stackerInfoSchema, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle, stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema as stackersForSignerInCycleResponseSchema };
+  export { type Args$g as Args, type Results$2 as Results, type stackersForSignerInCycle$1_StackerInfo as StackerInfo, type stackersForSignerInCycle$1_StackersForSignerInCycleResponse as StackersForSignerInCycleResponse, resultsSchema$2 as resultsSchema, stackersForSignerInCycle$1_stackerInfoSchema as stackerInfoSchema, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle, stackersForSignerInCycle$1_stackersForSignerInCycleResponseSchema as stackersForSignerInCycleResponseSchema };
 }
 
-type Args$e = {
+type Args$f = {
     cycleNumber: number;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const signerSchema: v.ObjectSchema<{
@@ -1045,7 +1045,7 @@ declare const signersResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type SignersResponse = v.InferOutput<typeof signersResponseSchema>;
-declare function signersInCycle(args: Args$e): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function signersInCycle(args: Args$f): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type signersInCycle$1_Signer = Signer;
 type signersInCycle$1_SignersResponse = SignersResponse;
@@ -1053,10 +1053,10 @@ 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$e 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 };
+  export { type Args$f 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$d = {
+type Args$e = {
     /**
      * The signers public key as a hex string, with or without a '0x' prefix.
      */
@@ -1074,16 +1074,16 @@ declare const signerInCycleResponseSchema: v.ObjectSchema<{
     readonly pooled_stacker_count: v.NumberSchema<undefined>;
 }, undefined>;
 type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
-declare function signerInCycle(args: Args$d): Promise<Result$1<SignerInCycleResponse>>;
+declare function signerInCycle(args: Args$e): Promise<Result$1<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$d as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
+  export { type Args$e as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
 }
 
-type Args$c = ApiRequestOptions & ApiPaginationOptions;
+type Args$d = ApiRequestOptions & ApiPaginationOptions;
 declare const cycleInfoSchema: v.ObjectSchema<{
     readonly block_height: v.NumberSchema<undefined>;
     readonly index_block_hash: v.StringSchema<undefined>;
@@ -1116,7 +1116,7 @@ declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
-declare function cycles(args: Args$c): Promise<Result$1<CyclesResponse>>;
+declare function cycles(args: Args$d): Promise<Result$1<CyclesResponse>>;
 
 type cycles$1_CycleInfo = CycleInfo;
 type cycles$1_CyclesResponse = CyclesResponse;
@@ -1126,10 +1126,10 @@ declare const cycles$1_cycles: typeof cycles;
 declare const cycles$1_cyclesResponseSchema: typeof cyclesResponseSchema;
 declare const cycles$1_resultsSchema: typeof resultsSchema;
 declare namespace cycles$1 {
-  export { type Args$c as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
+  export { type Args$d as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
 }
 
-type Args$b = {
+type Args$c = {
     cycleNumber: number;
 } & ApiRequestOptions;
 declare const responseSchema$2: v.ObjectSchema<{
@@ -1141,11 +1141,11 @@ 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$b): Promise<Result$1<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function cycle(opts: Args$c): Promise<Result$1<Response$2, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const cycle$1_cycle: typeof cycle;
 declare namespace cycle$1 {
-  export { type Args$b as Args, type Response$2 as Response, cycle$1_cycle as cycle, responseSchema$2 as responseSchema };
+  export { type Args$c as Args, type Response$2 as Response, cycle$1_cycle as cycle, responseSchema$2 as responseSchema };
 }
 
 type FeePrioritiesResponse = {
@@ -1207,18 +1207,18 @@ declare namespace coreApi$1 {
   export { type coreApi$1_CoreApiResponse as CoreApiResponse, coreApi$1_coreApi as coreApi };
 }
 
-type Args$a = {
+type Args$b = {
     address: string;
     stacking?: boolean;
 } & ApiRequestOptions;
-declare function stx(opts: Args$a): Promise<Result$1<any>>;
+declare function stx(opts: Args$b): Promise<Result$1<any>>;
 
 declare const stx$1_stx: typeof stx;
 declare namespace stx$1 {
-  export { type Args$a as Args, stx$1_stx as stx };
+  export { type Args$b as Args, stx$1_stx as stx };
 }
 
-type Args$9 = {
+type Args$a = {
     heightOrHash: string | number;
 } & ApiRequestOptions;
 declare const responseSchema$1: v.ObjectSchema<{
@@ -1243,14 +1243,14 @@ 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$9): Promise<Result$1<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function getBlock(opts: Args$a): Promise<Result$1<Response$1, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const getBlock$1_getBlock: typeof getBlock;
 declare namespace getBlock$1 {
-  export { type Args$9 as Args, type Response$1 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
+  export { type Args$a as Args, type Response$1 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
 }
 
-type Args$8 = {
+type Args$9 = {
     principal: string;
 } & ApiRequestOptions;
 declare const responseSchema: v.ObjectSchema<{
@@ -1261,25 +1261,25 @@ declare const responseSchema: v.ObjectSchema<{
     readonly detected_mempool_nonces: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
 }, undefined>;
 type Response = v.InferOutput<typeof responseSchema>;
-declare function latestNonce(opts: Args$8): Promise<Result$1<Response, SafeError<"FetchLatestNonceError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function latestNonce(opts: Args$9): Promise<Result$1<Response, SafeError<"FetchLatestNonceError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type latestNonce$1_Response = Response;
 declare const latestNonce$1_latestNonce: typeof latestNonce;
 declare const latestNonce$1_responseSchema: typeof responseSchema;
 declare namespace latestNonce$1 {
-  export { type Args$8 as Args, type latestNonce$1_Response as Response, latestNonce$1_latestNonce as latestNonce, latestNonce$1_responseSchema as responseSchema };
+  export { type Args$9 as Args, type latestNonce$1_Response as Response, latestNonce$1_latestNonce as latestNonce, latestNonce$1_responseSchema as responseSchema };
 }
 
-type Args$7 = {
+type Args$8 = {
     principal: string;
     unanchored?: boolean;
     untilBlock?: number;
 } & ApiRequestOptions;
-declare function balances(opts: Args$7): Promise<Result$1<OperationResponse["get_account_balance"], SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function balances(opts: Args$8): Promise<Result$1<OperationResponse["get_account_balance"], SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const balances$1_balances: typeof balances;
 declare namespace balances$1 {
-  export { type Args$7 as Args, balances$1_balances as balances };
+  export { type Args$8 as Args, balances$1_balances as balances };
 }
 
 declare const accounts: {
@@ -1400,7 +1400,7 @@ declare namespace index$6 {
   export { index$e as Accounts, index$d as Blocks, index$c as Faucets, index$b as Info, index$7 as Mempool, index$a as ProofOfTransfer, index$9 as StackingPool, index$8 as Transactions, index$6_stacksApi as stacksApi };
 }
 
-type Args$6 = {
+type Args$7 = {
     sender: string;
     arguments: string[];
     contractAddress: string;
@@ -1417,15 +1417,15 @@ interface ReadOnlyContractCallFailResponse {
 }
 type ReadOnlyContractCallResponse = ReadOnlyContractCallSuccessResponse | ReadOnlyContractCallFailResponse;
 type ReadOnlyResponse = ReadOnlyContractCallResponse;
-declare function readOnly$1(args: Args$6): Promise<Result$1<ReadOnlyResponse>>;
+declare function readOnly$1(args: Args$7): Promise<Result$1<ReadOnlyResponse>>;
 
 type readOnly$2_ReadOnlyContractCallResponse = ReadOnlyContractCallResponse;
 type readOnly$2_ReadOnlyResponse = ReadOnlyResponse;
 declare namespace readOnly$2 {
-  export { type Args$6 as Args, type readOnly$2_ReadOnlyContractCallResponse as ReadOnlyContractCallResponse, type readOnly$2_ReadOnlyResponse as ReadOnlyResponse, readOnly$1 as readOnly };
+  export { type Args$7 as Args, type readOnly$2_ReadOnlyContractCallResponse as ReadOnlyContractCallResponse, type readOnly$2_ReadOnlyResponse as ReadOnlyResponse, readOnly$1 as readOnly };
 }
 
-type Args$5 = {
+type Args$6 = {
     contractAddress: string;
     contractName: string;
     mapName: string;
@@ -1445,12 +1445,25 @@ declare const mapEntryResponseSchema: v.ObjectSchema<{
     readonly proof: v.OptionalSchema<v.StringSchema<undefined>, never>;
 }, undefined>;
 type MapEntryResponse = v.InferOutput<typeof mapEntryResponseSchema>;
-declare function mapEntry(args: Args$5): Promise<Result$1<MapEntryResponse>>;
+declare function mapEntry(args: Args$6): Promise<Result$1<MapEntryResponse>>;
 
 type mapEntry$1_MapEntryResponse = MapEntryResponse;
 declare const mapEntry$1_mapEntry: typeof mapEntry;
 declare namespace mapEntry$1 {
-  export { type Args$5 as Args, type mapEntry$1_MapEntryResponse as MapEntryResponse, mapEntry$1_mapEntry as mapEntry };
+  export { type Args$6 as Args, type mapEntry$1_MapEntryResponse as MapEntryResponse, mapEntry$1_mapEntry as mapEntry };
+}
+
+type Args$5 = {
+    contractAddress: string;
+    contractName: string;
+} & ApiRequestOptions & ProofAndTip;
+type InterfaceResponse = ClarityAbi;
+declare function contractInterface(args: Args$5): Promise<Result$1<InterfaceResponse>>;
+
+type _interface_InterfaceResponse = InterfaceResponse;
+declare const _interface_contractInterface: typeof contractInterface;
+declare namespace _interface {
+  export { type Args$5 as Args, type _interface_InterfaceResponse as InterfaceResponse, _interface_contractInterface as contractInterface };
 }
 
 type Args$4 = ApiRequestOptions;
@@ -1608,13 +1621,14 @@ declare namespace poxDetails$1 {
 }
 
 declare const smartContracts: {
+    contractInterface: typeof contractInterface;
     mapEntry: typeof mapEntry;
     readOnly: typeof readOnly$1;
 };
 
 declare const index$5_smartContracts: typeof smartContracts;
 declare namespace index$5 {
-  export { mapEntry$1 as MapEntry, readOnly$2 as ReadOnly, index$5_smartContracts as smartContracts };
+  export { _interface as ContractInterface, mapEntry$1 as MapEntry, readOnly$2 as ReadOnly, index$5_smartContracts as smartContracts };
 }
 
 declare const pox: {
@@ -1631,6 +1645,7 @@ declare const stacksRpcApi: {
         poxDetails: typeof poxDetails;
     };
     smartContracts: {
+        contractInterface: typeof contractInterface;
         mapEntry: typeof mapEntry;
         readOnly: typeof readOnly$1;
     };

package/dist/index.js

@@ -1063,8 +1063,46 @@ async function readOnly(args) {
   return success(data);
 }
 
+// src/stacks-rpc-api/smart-contracts/interface.ts
+async function contractInterface(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
+    };
+  }
+  const endpoint = `${args.baseUrl}/v2/contracts/interface/${args.contractAddress}/${args.contractName}`;
+  const res = await fetch(endpoint, init);
+  if (!res.ok) {
+    return error({
+      name: "FetcContractInterfaceError",
+      message: "Failed to fetch contract interface.",
+      data: {
+        init,
+        status: res.status,
+        statusText: res.statusText,
+        endpoint,
+        bodyText: await safePromise(res.text())
+      }
+    });
+  }
+  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-rpc-api/smart-contracts/index.ts
 var smartContracts = {
+  contractInterface,
   mapEntry,
   readOnly
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secretkeylabs/stacks-tools",
-  "version": "0.6.0-d6a9ecd",
+  "version": "0.6.0",
   "type": "module",
   "files": [
     "dist"