@continuumdao/ctm-mpc-defi 0.1.3 → 0.2.0

package/dist/protocols/evm/sky/index.d.ts

@@ -0,0 +1,218 @@
+import { d as ProtocolModule } from '../../../types-Ce2qNHai.js';
+import { Address, createPublicClient } from 'viem';
+import { K as KeyGenSubsetForPermit } from '../../../keygen-DsINazx8.js';
+
+/**
+ * Sky LockStake on Ethereum mainnet.
+ * @see https://developers.skyeco.com/protocol/rewards/staking-engine/
+ * @see https://developers.skyeco.com/guides/sky/token-governance-upgrade/key-info/ (contract list)
+ */
+/** Sky (SKY token) on Ethereum mainnet. */
+declare const SKY_ETHEREUM_MAINNET = "0x56072C95FAA701256059aa122697B133aDEd9279";
+declare const SKY_ETHEREUM_MAINNET_CHAIN_ID = 1;
+declare const USDS_ETHEREUM_MAINNET = "0xdC035D45d973E3EC169d2276DDab16f1e407384F";
+/** sUSDS ERC-4626 vault (share token); deposit USDS → mint shares, redeem shares → USDS. @see https://developers.skyeco.com/protocol/tokens/susds/ */
+declare const SUSDS_VAULT_ERC4626_MAINNET = "0xa3931d71877C0E7a3148CB7Eb4463524FEc27fbD";
+/**
+ * Staking Engine (LockStake) — **Chief V3 / SKY** (active; `LSEV2-SKY-A` ilk). This is the contract users should call.
+ * Do not use Seal Engine V1 (`0x2b16C07D…`, MKR / Chief V2 legacy); it has little traffic and is not the current SKY engine.
+ * Dual entrypoints: legacy `lock`/`free` (MKR path) vs **`lockSky`/`freeSky`** for SKY collateral via `mkrSky`.
+ */
+declare const SKY_LOCKSTAKE_ENGINE_MAINNET = "0xCe01C90dE7FD1bcFa39e237FE6D8D9F569e8A6a3";
+/**
+ * Wrapped SKY used inside the urn after `lockSky`; StakingRewards farms must list this ERC-20 as `stakingToken()`.
+ * @see Symbol `lsSKY`.
+ */
+declare const SKY_LS_SKY_ERC20_MAINNET = "0xf9A9cfD3229E985B91F99Bc866d42938044FFa1C";
+/**
+ * Default staking rewards farm on {@link SKY_LOCKSTAKE_ENGINE_MAINNET} — must be ACTIVE and `stakingToken() === lsSKY`.
+ * (Older Seal-engine farm addresses are not whitelisted on the current engine.)
+ */
+declare const SKY_LOCKSTAKE_DEFAULT_FARM_MAINNET = "0xB44C2Fb4181D7Cb06bdFf34A46FdFe4a259B40Fc";
+declare const SKY_LOCKSTAKE_DEFAULT_FARM_REF = 1;
+/**
+ * Rough UI collateral factor for “remaining borrow (USD)” estimate in the LockStake dialog only.
+ * Not protocol liquidation collateralization; see `SkyLockstakeDialog` disclosures.
+ */
+declare const SKY_LOCKSTAKE_UI_COLLATERAL_FACTOR = 0.65;
+declare const SKY_TOKEN_DECIMALS = 18;
+declare const USDS_DECIMALS = 18;
+
+/**
+ * Sky LockStake Engine (Ethereum): multisign batches for stake/open position, borrow, repay, close.
+ * Pattern mirrors `ethenaStakeMultisign.ts` (sequential txs, `proposalTxParams`, `batchMeta`).
+ */
+
+declare const SKY_LOCKSTAKE_MULTICALL_FALLBACK_GAS = 5000000n;
+type SkyMultisignBatchStep = {
+    to: Address;
+    data: `0x${string}`;
+    value: bigint;
+    meta: Record<string, unknown>;
+};
+type SkyMultisignChainDetailRow = {
+    legacy?: boolean;
+    gasLimit?: number;
+    gasMultiplier?: number;
+    gasPrice?: number;
+    baseFee?: number;
+    priorityFee?: number;
+    baseFeeMultiplier?: number;
+};
+type ChainRow = SkyMultisignChainDetailRow;
+declare function appendSerializedSkyBatch(args: {
+    steps: SkyMultisignBatchStep[];
+    publicClient: ReturnType<typeof createPublicClient>;
+    executor: Address;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    purposePrefix: string;
+    keyGen: KeyGenSubsetForPermit;
+    destinationChainID: string;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+declare function buildSkyLockstakeStakePositionBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    /** Human SKY amount */
+    amountHuman: string;
+    farm?: Address;
+    farmRef?: number;
+    /**
+     * Add SKY to this urn (multicall omits `open`). Must be `< ownerUrnsCount`.
+     * If omitted and `ownerUrnsCount > 0`, defaults to urn `0` (single-position UX). If omitted and count is 0, opens urn `0`.
+     */
+    existingUrnIndex?: bigint;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+declare function buildSkyLockstakeDrawBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    urnIndex: bigint;
+    /** Human USDS */
+    amountHuman: string;
+    to?: Address;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+declare function buildSkyLockstakeGetRewardBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    urnIndex: bigint;
+    /** Urn’s selected staking rewards farm (must be non-zero). */
+    farmAddress: Address;
+    /** Recipient of claimed ERC-20 rewards; defaults to executor. */
+    rewardRecipient?: Address;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+    rewardToken: Address;
+}>;
+declare function buildSkyLockstakeWipeBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    urnIndex: bigint;
+    wipeAll: boolean;
+    amountHuman?: string;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+declare function buildSkyLockstakeCloseBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: ChainRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    urnIndex: bigint;
+    inkWei: bigint;
+    skyRecipient?: Address;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+/**
+ * True when `extraJSON.batchMeta[i].evm.type` pulls ERC-20 inside the same batched approve flow,
+ * so `eth_estimateGas` on this step alone skips prior approvals (similar to Ethena sUSDe deposit).
+ */
+declare function isSkyLockstakeIsolationEstimateGasFragileBatchStep(detail: Record<string, unknown> | null | undefined, batchIndex: number): boolean;
+/** Prefer `proposalTxParams[i].gasLimit` from proposal time — isolated RPC estimate often reverts. */
+declare function resolveSkyLockstakeBatchStepGasFromSignRequest(detail: Record<string, unknown> | null | undefined, batchIndex: number): bigint | null;
+
+/**
+ * Sky sUSDS — ERC-4626 deposit (USDS → mint shares) and redeem (burn shares → USDS).
+ * Serialization matches {@link appendSerializedSkyBatch} from `skyLockstakeMultisign.ts`.
+ */
+
+declare function buildSkySusdsRedeemToUsdsBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: SkyMultisignChainDetailRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    /** Human sUSDS (vault share) amount to redeem */
+    sharesHuman: string;
+    /** Address receiving USDS from redeem (defaults to executor). */
+    receiver?: Address;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+declare function buildSkySusdsDepositFromUsdsBatch(args: {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: SkyMultisignChainDetailRow;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+    /** Human USDS amount to deposit into the vault. */
+    assetsHuman: string;
+}): Promise<{
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+}>;
+
+declare const SKY_PROTOCOL_ID = "sky";
+declare const skyProtocolModule: ProtocolModule;
+
+export { SKY_ETHEREUM_MAINNET, SKY_ETHEREUM_MAINNET_CHAIN_ID, SKY_LOCKSTAKE_DEFAULT_FARM_MAINNET, SKY_LOCKSTAKE_DEFAULT_FARM_REF, SKY_LOCKSTAKE_ENGINE_MAINNET, SKY_LOCKSTAKE_MULTICALL_FALLBACK_GAS, SKY_LOCKSTAKE_UI_COLLATERAL_FACTOR, SKY_LS_SKY_ERC20_MAINNET, SKY_PROTOCOL_ID, SKY_TOKEN_DECIMALS, SUSDS_VAULT_ERC4626_MAINNET, type SkyMultisignBatchStep, type SkyMultisignChainDetailRow, USDS_DECIMALS, USDS_ETHEREUM_MAINNET, appendSerializedSkyBatch, buildSkyLockstakeCloseBatch, buildSkyLockstakeDrawBatch, buildSkyLockstakeGetRewardBatch, buildSkyLockstakeStakePositionBatch, buildSkyLockstakeWipeBatch, buildSkySusdsDepositFromUsdsBatch, buildSkySusdsRedeemToUsdsBatch, isSkyLockstakeIsolationEstimateGasFragileBatchStep, resolveSkyLockstakeBatchStepGasFromSignRequest, skyProtocolModule };