@p2pdotme/sdk 1.1.8 → 1.1.9

package/dist/react.d.cts

@@ -112,6 +112,132 @@ interface PublicClientLike {
     }): Promise<readonly unknown[]>;
 }
 
+type StakeErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "TX_SUBMISSION_FAILED" | "RECEIPT_TIMEOUT" | "TX_REVERTED";
+declare class StakeError extends SdkError<StakeErrorCode> {
+    constructor(message: string, options: {
+        code: StakeErrorCode;
+        cause?: unknown;
+        context?: Record<string, unknown>;
+    });
+}
+
+declare const ZodGetUserStakeParamsSchema: z.ZodObject<{
+    user: z.ZodString & z.ZodType<`0x${string}`, string, z.core.$ZodTypeInternals<`0x${string}`, string>>;
+}, z.core.$strip>;
+type GetUserStakeParams = z.infer<typeof ZodGetUserStakeParamsSchema>;
+declare const ZodGetStakeBoostConfigParamsSchema: z.ZodObject<{
+    currency: z.ZodEnum<{
+        IDR: "IDR";
+        INR: "INR";
+        BRL: "BRL";
+        ARS: "ARS";
+        MEX: "MEX";
+        VEN: "VEN";
+        EUR: "EUR";
+        NGN: "NGN";
+        USD: "USD";
+        COP: "COP";
+    }>;
+}, z.core.$strip>;
+type GetStakeBoostConfigParams = z.infer<typeof ZodGetStakeBoostConfigParamsSchema>;
+declare const ZodGetP2pTokenBalanceParamsSchema: z.ZodObject<{
+    address: z.ZodString & z.ZodType<`0x${string}`, string, z.core.$ZodTypeInternals<`0x${string}`, string>>;
+}, z.core.$strip>;
+type GetP2pTokenBalanceParams = z.infer<typeof ZodGetP2pTokenBalanceParamsSchema>;
+declare const ZodStakeParamsSchema: z.ZodObject<{
+    tokens: z.ZodBigInt;
+}, z.core.$strip>;
+type StakeParams = z.infer<typeof ZodStakeParamsSchema>;
+declare const ZodTopUpParamsSchema: z.ZodObject<{
+    tokens: z.ZodBigInt;
+}, z.core.$strip>;
+type TopUpParams = z.infer<typeof ZodTopUpParamsSchema>;
+
+/**
+ * Stake lifecycle state for a user.
+ *   0 — None: no active stake.
+ *   1 — Active: stake is live.
+ *   2 — CooldownRequested: unstake requested; awaiting cooldown end.
+ *   3 — Seized: stake was forcefully seized.
+ */
+type StakeStatus = "none" | "active" | "cooldown" | "seized";
+/** Normalized on-chain stake record for a user. */
+interface UserStake {
+    /** Currently staked token amount (raw bigint, token decimals). */
+    readonly stakedAmount: bigint;
+    /** Unix seconds when cooldown ends (0 if not in cooldown). */
+    readonly cooldownEnd: bigint;
+    /** Lifecycle status decoded from the on-chain enum. */
+    readonly status: StakeStatus;
+}
+/**
+ * Per-currency boost config — how many tokens map to 1 USD of boost, and the
+ * cap on USD-denominated boost a stake can unlock.
+ */
+interface StakeBoostConfig {
+    readonly tokensPerUsdNumerator: bigint;
+    readonly tokensPerUsdDenominator: bigint;
+    readonly maxBoostUsd: bigint;
+}
+/** Global stake boost configuration shared across all users. */
+interface StakeBoostGlobals {
+    readonly p2pToken: Address;
+    readonly fraudReserve: Address;
+    readonly maxStakeTokens: bigint;
+    readonly normalCooldown: bigint;
+    readonly blacklistCooldown: bigint;
+    readonly tokenDecimals: number;
+    readonly totalStaked: bigint;
+}
+interface PreparedTx$1 {
+    readonly to: `0x${string}`;
+    readonly data: `0x${string}`;
+    readonly value: bigint;
+}
+interface TxResult$1 {
+    readonly hash: `0x${string}`;
+    readonly receipt?: TransactionReceipt;
+}
+interface ExecuteBase$1 {
+    readonly walletClient: WalletClient;
+    readonly waitForReceipt?: boolean;
+}
+
+interface ClaimUnstakeAction {
+    prepare(): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface RequestUnstakeAction {
+    prepare(): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface StakeAction {
+    prepare(params: StakeParams): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: StakeParams & ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface TopUpAction {
+    prepare(params: TopUpParams): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: TopUpParams & ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface StakeClient {
+    /** Reads the on-chain stake record for a user (stakedAmount, cooldownEnd, status). */
+    getUserStake(params: GetUserStakeParams): ResultAsync<UserStake, StakeError>;
+    /** Reads the per-currency stake boost config (tokens-per-USD, max boost). */
+    getStakeBoostConfig(params: GetStakeBoostConfigParams): ResultAsync<StakeBoostConfig, StakeError>;
+    /** Reads global stake boost configuration (token addr, cooldowns, totals). */
+    getStakeBoostGlobals(): ResultAsync<StakeBoostGlobals, StakeError>;
+    /** Reads the P2P token (ERC20) balance for a given address (raw bigint). */
+    getP2pTokenBalance(params: GetP2pTokenBalanceParams): ResultAsync<bigint, StakeError>;
+    readonly stake: StakeAction;
+    readonly topUp: TopUpAction;
+    readonly requestUnstake: RequestUnstakeAction;
+    readonly claimUnstake: ClaimUnstakeAction;
+}
+
 type OrdersErrorCode = "VALIDATION_ERROR" | "INVALID_ORDER_ID" | "INVALID_GET_ORDERS_PARAMS" | "INVALID_FEE_CONFIG_PARAMS" | "ORDER_NOT_FOUND" | "CONTRACT_READ_FAILED" | "SUBGRAPH_REQUEST_FAILED" | "SUBGRAPH_VALIDATION_FAILED" | "MALFORMED_ORDER" | "CIRCLE_SELECTION_FAILED" | "ENCRYPTION_FAILED" | "RELAY_IDENTITY_CORRUPT" | "RELAY_IDENTITY_STORE_FAILED" | "TX_SUBMISSION_FAILED" | "RECEIPT_TIMEOUT" | "TX_REVERTED" | "EVENT_WATCH_FAILED";
 declare class OrdersError extends SdkError<OrdersErrorCode> {
     constructor(message: string, options: {
@@ -686,6 +812,7 @@ interface SdkConfig {
     readonly subgraphUrl: string;
     readonly diamondAddress: Address;
     readonly usdcAddress: Address;
+    readonly p2pTokenAddress: Address;
     readonly reputationManagerAddress?: Address;
     readonly fraudEngine?: FraudEngineSdkConfig;
     readonly orders?: OrdersSdkConfig;
@@ -695,6 +822,7 @@ interface Sdk {
     readonly profile: Profile;
     readonly prices: Prices;
     readonly orders: OrdersClient;
+    readonly stake: StakeClient;
     readonly zkkyc?: Zkkyc;
     readonly fraudEngine?: FraudEngine;
 }
@@ -724,6 +852,8 @@ declare function useProfile(): Profile;
 declare function usePrices(): Prices;
 /** Returns the Orders instance from the nearest SdkProvider. */
 declare function useOrders(): OrdersClient;
+/** Returns the Stake instance from the nearest SdkProvider. */
+declare function useStake(): StakeClient;
 /** Returns the Zkkyc instance from the nearest SdkProvider. */
 declare function useZkkyc(): Zkkyc;
 /** Returns the FraudEngine instance from the nearest SdkProvider. */
@@ -749,4 +879,4 @@ interface UseFingerprintResult {
 }
 declare function useFingerprint(enabled: boolean): UseFingerprintResult;
 
-export { type FraudEngineSdkConfig, type OrdersSdkConfig, type SdkConfig, SdkProvider, useFingerprint, useFraudEngine, useOrders, usePrices, useProfile, useSdk, useWatchOrders, useZkkyc };
+export { type FraudEngineSdkConfig, type OrdersSdkConfig, type SdkConfig, SdkProvider, useFingerprint, useFraudEngine, useOrders, usePrices, useProfile, useSdk, useStake, useWatchOrders, useZkkyc };

package/dist/react.d.ts

@@ -112,6 +112,132 @@ interface PublicClientLike {
     }): Promise<readonly unknown[]>;
 }
 
+type StakeErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "TX_SUBMISSION_FAILED" | "RECEIPT_TIMEOUT" | "TX_REVERTED";
+declare class StakeError extends SdkError<StakeErrorCode> {
+    constructor(message: string, options: {
+        code: StakeErrorCode;
+        cause?: unknown;
+        context?: Record<string, unknown>;
+    });
+}
+
+declare const ZodGetUserStakeParamsSchema: z.ZodObject<{
+    user: z.ZodString & z.ZodType<`0x${string}`, string, z.core.$ZodTypeInternals<`0x${string}`, string>>;
+}, z.core.$strip>;
+type GetUserStakeParams = z.infer<typeof ZodGetUserStakeParamsSchema>;
+declare const ZodGetStakeBoostConfigParamsSchema: z.ZodObject<{
+    currency: z.ZodEnum<{
+        IDR: "IDR";
+        INR: "INR";
+        BRL: "BRL";
+        ARS: "ARS";
+        MEX: "MEX";
+        VEN: "VEN";
+        EUR: "EUR";
+        NGN: "NGN";
+        USD: "USD";
+        COP: "COP";
+    }>;
+}, z.core.$strip>;
+type GetStakeBoostConfigParams = z.infer<typeof ZodGetStakeBoostConfigParamsSchema>;
+declare const ZodGetP2pTokenBalanceParamsSchema: z.ZodObject<{
+    address: z.ZodString & z.ZodType<`0x${string}`, string, z.core.$ZodTypeInternals<`0x${string}`, string>>;
+}, z.core.$strip>;
+type GetP2pTokenBalanceParams = z.infer<typeof ZodGetP2pTokenBalanceParamsSchema>;
+declare const ZodStakeParamsSchema: z.ZodObject<{
+    tokens: z.ZodBigInt;
+}, z.core.$strip>;
+type StakeParams = z.infer<typeof ZodStakeParamsSchema>;
+declare const ZodTopUpParamsSchema: z.ZodObject<{
+    tokens: z.ZodBigInt;
+}, z.core.$strip>;
+type TopUpParams = z.infer<typeof ZodTopUpParamsSchema>;
+
+/**
+ * Stake lifecycle state for a user.
+ *   0 — None: no active stake.
+ *   1 — Active: stake is live.
+ *   2 — CooldownRequested: unstake requested; awaiting cooldown end.
+ *   3 — Seized: stake was forcefully seized.
+ */
+type StakeStatus = "none" | "active" | "cooldown" | "seized";
+/** Normalized on-chain stake record for a user. */
+interface UserStake {
+    /** Currently staked token amount (raw bigint, token decimals). */
+    readonly stakedAmount: bigint;
+    /** Unix seconds when cooldown ends (0 if not in cooldown). */
+    readonly cooldownEnd: bigint;
+    /** Lifecycle status decoded from the on-chain enum. */
+    readonly status: StakeStatus;
+}
+/**
+ * Per-currency boost config — how many tokens map to 1 USD of boost, and the
+ * cap on USD-denominated boost a stake can unlock.
+ */
+interface StakeBoostConfig {
+    readonly tokensPerUsdNumerator: bigint;
+    readonly tokensPerUsdDenominator: bigint;
+    readonly maxBoostUsd: bigint;
+}
+/** Global stake boost configuration shared across all users. */
+interface StakeBoostGlobals {
+    readonly p2pToken: Address;
+    readonly fraudReserve: Address;
+    readonly maxStakeTokens: bigint;
+    readonly normalCooldown: bigint;
+    readonly blacklistCooldown: bigint;
+    readonly tokenDecimals: number;
+    readonly totalStaked: bigint;
+}
+interface PreparedTx$1 {
+    readonly to: `0x${string}`;
+    readonly data: `0x${string}`;
+    readonly value: bigint;
+}
+interface TxResult$1 {
+    readonly hash: `0x${string}`;
+    readonly receipt?: TransactionReceipt;
+}
+interface ExecuteBase$1 {
+    readonly walletClient: WalletClient;
+    readonly waitForReceipt?: boolean;
+}
+
+interface ClaimUnstakeAction {
+    prepare(): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface RequestUnstakeAction {
+    prepare(): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface StakeAction {
+    prepare(params: StakeParams): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: StakeParams & ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface TopUpAction {
+    prepare(params: TopUpParams): ResultAsync<PreparedTx$1, StakeError>;
+    execute(params: TopUpParams & ExecuteBase$1): ResultAsync<TxResult$1, StakeError>;
+}
+
+interface StakeClient {
+    /** Reads the on-chain stake record for a user (stakedAmount, cooldownEnd, status). */
+    getUserStake(params: GetUserStakeParams): ResultAsync<UserStake, StakeError>;
+    /** Reads the per-currency stake boost config (tokens-per-USD, max boost). */
+    getStakeBoostConfig(params: GetStakeBoostConfigParams): ResultAsync<StakeBoostConfig, StakeError>;
+    /** Reads global stake boost configuration (token addr, cooldowns, totals). */
+    getStakeBoostGlobals(): ResultAsync<StakeBoostGlobals, StakeError>;
+    /** Reads the P2P token (ERC20) balance for a given address (raw bigint). */
+    getP2pTokenBalance(params: GetP2pTokenBalanceParams): ResultAsync<bigint, StakeError>;
+    readonly stake: StakeAction;
+    readonly topUp: TopUpAction;
+    readonly requestUnstake: RequestUnstakeAction;
+    readonly claimUnstake: ClaimUnstakeAction;
+}
+
 type OrdersErrorCode = "VALIDATION_ERROR" | "INVALID_ORDER_ID" | "INVALID_GET_ORDERS_PARAMS" | "INVALID_FEE_CONFIG_PARAMS" | "ORDER_NOT_FOUND" | "CONTRACT_READ_FAILED" | "SUBGRAPH_REQUEST_FAILED" | "SUBGRAPH_VALIDATION_FAILED" | "MALFORMED_ORDER" | "CIRCLE_SELECTION_FAILED" | "ENCRYPTION_FAILED" | "RELAY_IDENTITY_CORRUPT" | "RELAY_IDENTITY_STORE_FAILED" | "TX_SUBMISSION_FAILED" | "RECEIPT_TIMEOUT" | "TX_REVERTED" | "EVENT_WATCH_FAILED";
 declare class OrdersError extends SdkError<OrdersErrorCode> {
     constructor(message: string, options: {
@@ -686,6 +812,7 @@ interface SdkConfig {
     readonly subgraphUrl: string;
     readonly diamondAddress: Address;
     readonly usdcAddress: Address;
+    readonly p2pTokenAddress: Address;
     readonly reputationManagerAddress?: Address;
     readonly fraudEngine?: FraudEngineSdkConfig;
     readonly orders?: OrdersSdkConfig;
@@ -695,6 +822,7 @@ interface Sdk {
     readonly profile: Profile;
     readonly prices: Prices;
     readonly orders: OrdersClient;
+    readonly stake: StakeClient;
     readonly zkkyc?: Zkkyc;
     readonly fraudEngine?: FraudEngine;
 }
@@ -724,6 +852,8 @@ declare function useProfile(): Profile;
 declare function usePrices(): Prices;
 /** Returns the Orders instance from the nearest SdkProvider. */
 declare function useOrders(): OrdersClient;
+/** Returns the Stake instance from the nearest SdkProvider. */
+declare function useStake(): StakeClient;
 /** Returns the Zkkyc instance from the nearest SdkProvider. */
 declare function useZkkyc(): Zkkyc;
 /** Returns the FraudEngine instance from the nearest SdkProvider. */
@@ -749,4 +879,4 @@ interface UseFingerprintResult {
 }
 declare function useFingerprint(enabled: boolean): UseFingerprintResult;
 
-export { type FraudEngineSdkConfig, type OrdersSdkConfig, type SdkConfig, SdkProvider, useFingerprint, useFraudEngine, useOrders, usePrices, useProfile, useSdk, useWatchOrders, useZkkyc };
+export { type FraudEngineSdkConfig, type OrdersSdkConfig, type SdkConfig, SdkProvider, useFingerprint, useFraudEngine, useOrders, usePrices, useProfile, useSdk, useStake, useWatchOrders, useZkkyc };