@secondlayer/stacks 0.0.1

package/dist/src/stackingdao/index.d.cts

@@ -0,0 +1,179 @@
+/** Full chain descriptor used by clients and transports for network-aware operations. */
+type StacksChain = {
+	/** Chain ID (e.g. 0x00000001 for mainnet) */
+	id: number
+	/** Human-readable name */
+	name: string
+	/** Network type */
+	network: "mainnet" | "testnet"
+	/** Transaction version byte for serialization */
+	transactionVersion: number
+	/** Peer network ID for P2P broadcasting */
+	peerNetworkId: number
+	/** Address version bytes */
+	addressVersion: {
+		singleSig: number
+		multiSig: number
+	}
+	/** Magic bytes for network identification */
+	magicBytes: string
+	/** Boot address (system contracts deployer) */
+	bootAddress: string
+	/** Native currency info */
+	nativeCurrency: {
+		name: string
+		symbol: string
+		decimals: number
+	}
+	/** Default RPC URLs */
+	rpcUrls: {
+		default: {
+			http: string[]
+			ws?: string[]
+		}
+	}
+	/** Block explorer URLs */
+	blockExplorers?: {
+		default: {
+			name: string
+			url: string
+		}
+	}
+};
+/** Function that sends an HTTP request to a Stacks node API path. */
+type RequestFn = (path: string, options?: RequestOptions) => Promise<any>;
+/** Options for a transport-level HTTP request. */
+type RequestOptions = {
+	method?: "GET" | "POST" | "PUT" | "DELETE"
+	body?: unknown
+	headers?: Record<string, string>
+};
+/** Shared configuration for all transport types. */
+type TransportConfig = {
+	url?: string
+	timeout?: number
+	retryCount?: number
+	retryDelay?: number
+	fetchOptions?: RequestInit
+	apiKey?: string
+};
+/** A resolved transport instance with a bound request function. */
+type Transport = {
+	type: string
+	request: RequestFn
+	config: TransportConfig
+	destroy?: () => void
+};
+/** Account derived from a local private key (mnemonic or raw key). */
+type LocalAccount = {
+	type: "local"
+	address: string
+	/** Compressed public key (hex) */
+	publicKey: string
+	/** Raw ECDSA sign over a hash */
+	sign(hash: Uint8Array): Uint8Array
+	/** Sign a structured message (SIP-018) */
+	signMessage(message: string | Uint8Array): string
+};
+/** Account with a user-provided signing function (sync or async). */
+type CustomAccount = {
+	type: "custom"
+	address: string
+	publicKey: string
+	sign(hash: Uint8Array): Promise<Uint8Array> | Uint8Array
+};
+/** Browser wallet provider interface (e.g. Leather, Xverse). */
+type StacksProvider = {
+	request(method: string, params?: any): Promise<any>
+};
+/** Account backed by a browser wallet {@link StacksProvider}. */
+type ProviderAccount = {
+	type: "provider"
+	address: string
+	publicKey: string
+	provider: StacksProvider
+};
+/** Union of all supported account types (local key, custom signer, or browser provider). */
+type Account = LocalAccount | CustomAccount | ProviderAccount;
+/**
+* Core client instance that holds chain context, transport, and extensible actions.
+* Created via {@link createClient}, {@link createPublicClient}, or {@link createWalletClient}.
+*/
+type Client<TExtended extends Record<string, unknown> = Record<string, unknown>> = {
+	chain?: StacksChain
+	account?: Account
+	transport: Transport
+	request: RequestFn
+	extend: <const TNew extends Record<string, unknown>>(fn: (client: Client<TExtended>) => TNew) => Client<TExtended & TNew> & TNew
+} & TExtended;
+interface DepositParams {
+	amount: bigint;
+	referrer?: string;
+	pool?: string;
+}
+interface InitWithdrawParams {
+	ststxAmount: bigint;
+}
+interface WithdrawParams {
+	nftId: bigint;
+}
+interface WithdrawIdleParams {
+	ststxAmount: bigint;
+}
+interface ExchangeRateInfo {
+	stxPerStstx: bigint;
+	ststxSupply: bigint;
+	totalStx: bigint;
+}
+interface WithdrawalInfo {
+	ststxAmount: bigint;
+	stxAmount: bigint;
+	unlockBurnHeight: bigint;
+}
+interface FeeInfo {
+	stackFee: bigint;
+	unstackFee: bigint;
+	withdrawIdleFee: bigint;
+}
+declare const STACKINGDAO_CONTRACTS: {
+	readonly core: {
+		readonly name: "stacking-dao-core-v6"
+	}
+	readonly ststxToken: {
+		readonly name: "ststx-token"
+	}
+	readonly withdrawNft: {
+		readonly name: "ststx-withdraw-nft-v2"
+	}
+	readonly reserve: {
+		readonly name: "reserve-v1"
+	}
+	readonly dataCore: {
+		readonly name: "data-core-v3"
+	}
+	readonly dataCoreV1: {
+		readonly name: "data-core-v1"
+	}
+};
+/** Trait contracts auto-passed to core functions — users never need these. */
+declare const TRAIT_CONTRACTS: {};
+/**
+* StackingDAO liquid staking extension.
+* Deposit STX → receive stSTX. Auto-compounding stacking rewards.
+*
+* @example
+* import { createWalletClient, http, mainnet } from "stacks";
+* import { stackingDao } from "stacks/stackingdao";
+*
+* const client = createWalletClient({ ... }).extend(stackingDao());
+*
+* // Deposit STX for stSTX
+* await client.stackingDao.deposit({ amount: 100_000_000_000n });
+*
+* // Check exchange rate
+* const rate = await client.stackingDao.getExchangeRate();
+*/
+declare function stackingDao(): (client: Client) => {
+	stackingDao: {}
+};
+export { stackingDao, WithdrawalInfo, WithdrawParams, WithdrawIdleParams, TRAIT_CONTRACTS, STACKINGDAO_CONTRACTS, InitWithdrawParams, FeeInfo, ExchangeRateInfo, DepositParams };

package/dist/src/stackingdao/index.d.ts

@@ -0,0 +1,179 @@
+/** Full chain descriptor used by clients and transports for network-aware operations. */
+type StacksChain = {
+	/** Chain ID (e.g. 0x00000001 for mainnet) */
+	id: number
+	/** Human-readable name */
+	name: string
+	/** Network type */
+	network: "mainnet" | "testnet"
+	/** Transaction version byte for serialization */
+	transactionVersion: number
+	/** Peer network ID for P2P broadcasting */
+	peerNetworkId: number
+	/** Address version bytes */
+	addressVersion: {
+		singleSig: number
+		multiSig: number
+	}
+	/** Magic bytes for network identification */
+	magicBytes: string
+	/** Boot address (system contracts deployer) */
+	bootAddress: string
+	/** Native currency info */
+	nativeCurrency: {
+		name: string
+		symbol: string
+		decimals: number
+	}
+	/** Default RPC URLs */
+	rpcUrls: {
+		default: {
+			http: string[]
+			ws?: string[]
+		}
+	}
+	/** Block explorer URLs */
+	blockExplorers?: {
+		default: {
+			name: string
+			url: string
+		}
+	}
+};
+/** Function that sends an HTTP request to a Stacks node API path. */
+type RequestFn = (path: string, options?: RequestOptions) => Promise<any>;
+/** Options for a transport-level HTTP request. */
+type RequestOptions = {
+	method?: "GET" | "POST" | "PUT" | "DELETE"
+	body?: unknown
+	headers?: Record<string, string>
+};
+/** Shared configuration for all transport types. */
+type TransportConfig = {
+	url?: string
+	timeout?: number
+	retryCount?: number
+	retryDelay?: number
+	fetchOptions?: RequestInit
+	apiKey?: string
+};
+/** A resolved transport instance with a bound request function. */
+type Transport = {
+	type: string
+	request: RequestFn
+	config: TransportConfig
+	destroy?: () => void
+};
+/** Account derived from a local private key (mnemonic or raw key). */
+type LocalAccount = {
+	type: "local"
+	address: string
+	/** Compressed public key (hex) */
+	publicKey: string
+	/** Raw ECDSA sign over a hash */
+	sign(hash: Uint8Array): Uint8Array
+	/** Sign a structured message (SIP-018) */
+	signMessage(message: string | Uint8Array): string
+};
+/** Account with a user-provided signing function (sync or async). */
+type CustomAccount = {
+	type: "custom"
+	address: string
+	publicKey: string
+	sign(hash: Uint8Array): Promise<Uint8Array> | Uint8Array
+};
+/** Browser wallet provider interface (e.g. Leather, Xverse). */
+type StacksProvider = {
+	request(method: string, params?: any): Promise<any>
+};
+/** Account backed by a browser wallet {@link StacksProvider}. */
+type ProviderAccount = {
+	type: "provider"
+	address: string
+	publicKey: string
+	provider: StacksProvider
+};
+/** Union of all supported account types (local key, custom signer, or browser provider). */
+type Account = LocalAccount | CustomAccount | ProviderAccount;
+/**
+* Core client instance that holds chain context, transport, and extensible actions.
+* Created via {@link createClient}, {@link createPublicClient}, or {@link createWalletClient}.
+*/
+type Client<TExtended extends Record<string, unknown> = Record<string, unknown>> = {
+	chain?: StacksChain
+	account?: Account
+	transport: Transport
+	request: RequestFn
+	extend: <const TNew extends Record<string, unknown>>(fn: (client: Client<TExtended>) => TNew) => Client<TExtended & TNew> & TNew
+} & TExtended;
+interface DepositParams {
+	amount: bigint;
+	referrer?: string;
+	pool?: string;
+}
+interface InitWithdrawParams {
+	ststxAmount: bigint;
+}
+interface WithdrawParams {
+	nftId: bigint;
+}
+interface WithdrawIdleParams {
+	ststxAmount: bigint;
+}
+interface ExchangeRateInfo {
+	stxPerStstx: bigint;
+	ststxSupply: bigint;
+	totalStx: bigint;
+}
+interface WithdrawalInfo {
+	ststxAmount: bigint;
+	stxAmount: bigint;
+	unlockBurnHeight: bigint;
+}
+interface FeeInfo {
+	stackFee: bigint;
+	unstackFee: bigint;
+	withdrawIdleFee: bigint;
+}
+declare const STACKINGDAO_CONTRACTS: {
+	readonly core: {
+		readonly name: "stacking-dao-core-v6"
+	}
+	readonly ststxToken: {
+		readonly name: "ststx-token"
+	}
+	readonly withdrawNft: {
+		readonly name: "ststx-withdraw-nft-v2"
+	}
+	readonly reserve: {
+		readonly name: "reserve-v1"
+	}
+	readonly dataCore: {
+		readonly name: "data-core-v3"
+	}
+	readonly dataCoreV1: {
+		readonly name: "data-core-v1"
+	}
+};
+/** Trait contracts auto-passed to core functions — users never need these. */
+declare const TRAIT_CONTRACTS: {};
+/**
+* StackingDAO liquid staking extension.
+* Deposit STX → receive stSTX. Auto-compounding stacking rewards.
+*
+* @example
+* import { createWalletClient, http, mainnet } from "stacks";
+* import { stackingDao } from "stacks/stackingdao";
+*
+* const client = createWalletClient({ ... }).extend(stackingDao());
+*
+* // Deposit STX for stSTX
+* await client.stackingDao.deposit({ amount: 100_000_000_000n });
+*
+* // Check exchange rate
+* const rate = await client.stackingDao.getExchangeRate();
+*/
+declare function stackingDao(): (client: Client) => {
+	stackingDao: {}
+};
+export { stackingDao, WithdrawalInfo, WithdrawParams, WithdrawIdleParams, TRAIT_CONTRACTS, STACKINGDAO_CONTRACTS, InitWithdrawParams, FeeInfo, ExchangeRateInfo, DepositParams };

package/dist/src/stackingdao/index.js

@@ -0,0 +1,318 @@
+import {
+  SIP010_ABI
+} from "../../shared/stacks-k58k970n.js";
+import {
+  getContract
+} from "../../shared/stacks-vdfs3e5v.js";
+import"../../shared/stacks-zm0b3tgy.js";
+import"../../shared/stacks-709tra19.js";
+import"../../shared/stacks-d1fmkv3p.js";
+import {
+  Pc
+} from "../../shared/stacks-yfveb68e.js";
+import"../../shared/stacks-f7wdrzs3.js";
+import"../../shared/stacks-yfgsm6ap.js";
+import"../../shared/stacks-j2cy7qtt.js";
+import"../../shared/stacks-8yykgdww.js";
+import"../../shared/stacks-v9jqcpd4.js";
+import"../../shared/stacks-bycy6t9k.js";
+import"../../shared/stacks-gjvbq6w7.js";
+import"../../shared/stacks-nqytwfcc.js";
+import"../../shared/stacks-8m9byk2j.js";
+
+// src/stackingdao/abi.ts
+var withdrawTuple = {
+  tuple: [
+    { name: "stx-fee-amount", type: "uint128" },
+    { name: "stx-user-amount", type: "uint128" }
+  ]
+};
+var STACKING_DAO_CORE_ABI = {
+  functions: [
+    {
+      name: "deposit",
+      access: "public",
+      args: [
+        { name: "reserve", type: "trait_reference" },
+        { name: "commission-contract", type: "trait_reference" },
+        { name: "staking-contract", type: "trait_reference" },
+        { name: "direct-helpers", type: "trait_reference" },
+        { name: "stx-amount", type: "uint128" },
+        { name: "referrer", type: { optional: "principal" } },
+        { name: "pool", type: { optional: "principal" } }
+      ],
+      outputs: { response: { ok: "uint128", error: "uint128" } }
+    },
+    {
+      name: "init-withdraw",
+      access: "public",
+      args: [
+        { name: "reserve", type: "trait_reference" },
+        { name: "direct-helpers", type: "trait_reference" },
+        { name: "ststx-amount", type: "uint128" }
+      ],
+      outputs: { response: { ok: "uint128", error: "uint128" } }
+    },
+    {
+      name: "withdraw",
+      access: "public",
+      args: [
+        { name: "reserve", type: "trait_reference" },
+        { name: "commission-contract", type: "trait_reference" },
+        { name: "staking-contract", type: "trait_reference" },
+        { name: "nft-id", type: "uint128" }
+      ],
+      outputs: { response: { ok: withdrawTuple, error: "uint128" } }
+    },
+    {
+      name: "withdraw-idle",
+      access: "public",
+      args: [
+        { name: "reserve", type: "trait_reference" },
+        { name: "direct-helpers", type: "trait_reference" },
+        { name: "commission-contract", type: "trait_reference" },
+        { name: "staking-contract", type: "trait_reference" },
+        { name: "ststx-amount", type: "uint128" }
+      ],
+      outputs: { response: { ok: withdrawTuple, error: "uint128" } }
+    },
+    {
+      name: "get-stack-fee",
+      access: "read-only",
+      args: [],
+      outputs: "uint128"
+    },
+    {
+      name: "get-unstack-fee",
+      access: "read-only",
+      args: [],
+      outputs: "uint128"
+    },
+    {
+      name: "get-withdraw-idle-fee",
+      access: "read-only",
+      args: [],
+      outputs: "uint128"
+    },
+    {
+      name: "get-shutdown-deposits",
+      access: "read-only",
+      args: [],
+      outputs: "bool"
+    }
+  ]
+};
+var DATA_CORE_V1_ABI = {
+  functions: [
+    {
+      name: "get-withdrawals-by-nft",
+      access: "read-only",
+      args: [{ name: "nft-id", type: "uint128" }],
+      outputs: {
+        tuple: [
+          { name: "ststx-amount", type: "uint128" },
+          { name: "stx-amount", type: "uint128" },
+          { name: "unlock-burn-height", type: "uint128" }
+        ]
+      }
+    }
+  ]
+};
+var DATA_CORE_V3_ABI = {
+  functions: [
+    {
+      name: "get-stx-per-ststx-helper",
+      access: "read-only",
+      args: [{ name: "stx-amount", type: "uint128" }],
+      outputs: "uint128"
+    }
+  ]
+};
+var RESERVE_V1_ABI = {
+  functions: [
+    {
+      name: "get-total-stx",
+      access: "read-only",
+      args: [],
+      outputs: { response: { ok: "uint128", error: "none" } }
+    }
+  ]
+};
+
+// src/stackingdao/constants.ts
+var DEPLOYER = "SP4SZE494VC2YC5JYG7AYFQ44F5Q4PYV7DVMDPBG";
+var STACKINGDAO_CONTRACTS = {
+  core: { address: DEPLOYER, name: "stacking-dao-core-v6" },
+  ststxToken: { address: DEPLOYER, name: "ststx-token" },
+  withdrawNft: { address: DEPLOYER, name: "ststx-withdraw-nft-v2" },
+  reserve: { address: DEPLOYER, name: "reserve-v1" },
+  dataCore: { address: DEPLOYER, name: "data-core-v3" },
+  dataCoreV1: { address: DEPLOYER, name: "data-core-v1" }
+};
+var TRAIT_CONTRACTS = {
+  reserve: `${DEPLOYER}.reserve-v1`,
+  commission: `${DEPLOYER}.commission-v2`,
+  directHelpers: `${DEPLOYER}.direct-helpers-v4`,
+  staking: `${DEPLOYER}.staking-v0`
+};
+
+// src/stackingdao/actions.ts
+function assertMainnet(client) {
+  if (!client.chain) {
+    throw new Error("Client must have a chain configured");
+  }
+  if (client.chain.network !== "mainnet") {
+    throw new Error("StackingDAO is only available on mainnet");
+  }
+}
+function getCoreContract(client) {
+  assertMainnet(client);
+  const c = STACKINGDAO_CONTRACTS.core;
+  return getContract({ client, address: c.address, name: c.name, abi: STACKING_DAO_CORE_ABI });
+}
+function getStstxToken(client) {
+  assertMainnet(client);
+  const c = STACKINGDAO_CONTRACTS.ststxToken;
+  return getContract({ client, address: c.address, name: c.name, abi: SIP010_ABI });
+}
+function getDataCoreV1(client) {
+  assertMainnet(client);
+  const c = STACKINGDAO_CONTRACTS.dataCoreV1;
+  return getContract({ client, address: c.address, name: c.name, abi: DATA_CORE_V1_ABI });
+}
+function getDataCoreV3(client) {
+  assertMainnet(client);
+  const c = STACKINGDAO_CONTRACTS.dataCore;
+  return getContract({ client, address: c.address, name: c.name, abi: DATA_CORE_V3_ABI });
+}
+function getReserveContract(client) {
+  assertMainnet(client);
+  const c = STACKINGDAO_CONTRACTS.reserve;
+  return getContract({ client, address: c.address, name: c.name, abi: RESERVE_V1_ABI });
+}
+var traits = {
+  reserve: TRAIT_CONTRACTS.reserve,
+  commissionContract: TRAIT_CONTRACTS.commission,
+  stakingContract: TRAIT_CONTRACTS.staking,
+  directHelpers: TRAIT_CONTRACTS.directHelpers
+};
+async function deposit(client, params) {
+  const core = getCoreContract(client);
+  return core.call.deposit({
+    ...traits,
+    stxAmount: params.amount,
+    referrer: params.referrer ?? null,
+    pool: params.pool ?? null
+  }, {
+    postConditions: [
+      Pc.principal(client.account.address).willSendEq(params.amount).ustx()
+    ]
+  });
+}
+async function initWithdraw(client, params) {
+  const core = getCoreContract(client);
+  const ststx = STACKINGDAO_CONTRACTS.ststxToken;
+  return core.call["init-withdraw"]({
+    reserve: traits.reserve,
+    directHelpers: traits.directHelpers,
+    ststxAmount: params.ststxAmount
+  }, {
+    postConditions: [
+      Pc.principal(client.account.address).willSendEq(params.ststxAmount).ft(`${ststx.address}.${ststx.name}`, "ststx")
+    ]
+  });
+}
+async function withdraw(client, params) {
+  const core = getCoreContract(client);
+  return core.call.withdraw({
+    reserve: traits.reserve,
+    commissionContract: traits.commissionContract,
+    stakingContract: traits.stakingContract,
+    nftId: params.nftId
+  });
+}
+async function withdrawIdle(client, params) {
+  const core = getCoreContract(client);
+  const ststx = STACKINGDAO_CONTRACTS.ststxToken;
+  return core.call["withdraw-idle"]({
+    reserve: traits.reserve,
+    directHelpers: traits.directHelpers,
+    commissionContract: traits.commissionContract,
+    stakingContract: traits.stakingContract,
+    ststxAmount: params.ststxAmount
+  }, {
+    postConditions: [
+      Pc.principal(client.account.address).willSendEq(params.ststxAmount).ft(`${ststx.address}.${ststx.name}`, "ststx")
+    ]
+  });
+}
+async function getStSTXBalance(client, address) {
+  const token = getStstxToken(client);
+  return await token.read["get-balance"]({ account: address });
+}
+async function getExchangeRate(client) {
+  const reserve = getReserveContract(client);
+  const dataV3 = getDataCoreV3(client);
+  const [totalStx, ststxSupply] = await Promise.all([
+    reserve.read["get-total-stx"]({}),
+    getTotalSupply(client)
+  ]);
+  const stxPerStstx = await dataV3.read["get-stx-per-ststx-helper"]({
+    stxAmount: totalStx
+  });
+  return { stxPerStstx, ststxSupply, totalStx };
+}
+async function getTotalSupply(client) {
+  const token = getStstxToken(client);
+  return await token.read["get-total-supply"]({});
+}
+async function getWithdrawalInfo(client, nftId) {
+  const dataV1 = getDataCoreV1(client);
+  return await dataV1.read["get-withdrawals-by-nft"]({
+    nftId
+  });
+}
+async function getFees(client) {
+  const core = getCoreContract(client);
+  const [stackFee, unstackFee, withdrawIdleFee] = await Promise.all([
+    core.read["get-stack-fee"]({}),
+    core.read["get-unstack-fee"]({}),
+    core.read["get-withdraw-idle-fee"]({})
+  ]);
+  return { stackFee, unstackFee, withdrawIdleFee };
+}
+async function getReserveBalance(client) {
+  const reserve = getReserveContract(client);
+  return await reserve.read["get-total-stx"]({});
+}
+async function getShutdownDeposits(client) {
+  const core = getCoreContract(client);
+  return await core.read["get-shutdown-deposits"]({});
+}
+
+// src/stackingdao/index.ts
+function stackingDao() {
+  return (client) => ({
+    stackingDao: {
+      deposit: (params) => deposit(client, params),
+      initWithdraw: (params) => initWithdraw(client, params),
+      withdraw: (params) => withdraw(client, params),
+      withdrawIdle: (params) => withdrawIdle(client, params),
+      getStSTXBalance: (address) => getStSTXBalance(client, address),
+      getExchangeRate: () => getExchangeRate(client),
+      getTotalSupply: () => getTotalSupply(client),
+      getWithdrawalInfo: (nftId) => getWithdrawalInfo(client, nftId),
+      getFees: () => getFees(client),
+      getReserveBalance: () => getReserveBalance(client),
+      getShutdownDeposits: () => getShutdownDeposits(client)
+    }
+  });
+}
+export {
+  stackingDao,
+  TRAIT_CONTRACTS,
+  STACKINGDAO_CONTRACTS
+};
+
+//# debugId=2E26299092479C8C64756E2164756E21
+//# sourceMappingURL=index.js.map