@worldcoin/minikit-js 0.0.26-internal-alpha → 0.0.28-internal-alpha

package/build/index.d.cts

@@ -1,34 +1,8 @@
-import { ethers } from 'ethers';
-import { AppErrorCodes, VerificationLevel } from '@worldcoin/idkit-core';
+import { AppErrorCodes, IDKitConfig, VerificationLevel } from '@worldcoin/idkit-core';
 export { ISuccessResult, AppErrorCodes as VerificationErrorCodes, VerificationLevel } from '@worldcoin/idkit-core';
-import { IDKitConfig, VerificationLevel as VerificationLevel$1 } from '@worldcoin/idkit-core/*';
+import { Abi, AbiStateMutability, ExtractAbiFunctionNames, AbiParametersToPrimitiveTypes, ExtractAbiFunction, TypedData, TypedDataDomain } from 'abitype';
 export { IVerifyResponse, verifyCloudProof } from '@worldcoin/idkit-core/backend';
-
-type SiweMessage = {
-    scheme?: string;
-    domain: string;
-    address?: string;
-    statement?: string;
-    uri: string;
-    version: number;
-    chain_id: number;
-    nonce: string;
-    issued_at: string;
-    expiration_time?: string;
-    not_before?: string;
-    request_id?: string;
-};
-
-declare enum Tokens {
-    USDCE = "USDCE",
-    WLD = "WLD"
-}
-declare const TokenDecimals: {
-    [key in Tokens]: number;
-};
-declare enum Network {
-    Optimism = "optimism"
-}
+import { Client } from 'viem';
 
 declare const VerificationErrorMessage: Record<AppErrorCodes, string>;
 declare enum PaymentErrorCodes {
@@ -57,7 +31,60 @@ declare const WalletAuthErrorMessage: {
     user_rejected: string;
     generic_error: string;
 };
-declare enum MiniKitInstallErrorCode {
+declare enum SendTransactionErrorCodes {
+    InvalidOperation = "invalid_operation",
+    UserRejected = "user_rejected",
+    InputError = "input_error",
+    SimulationFailed = "simulation_failed",
+    TransactionFailed = "transaction_failed",
+    GenericError = "generic_error",
+    DisallowedOperation = "disallowed_operation",
+    InvalidContract = "invalid_contract",
+    MaliciousOperation = "malicious_operation"
+}
+declare const SendTransactionErrorMessage: {
+    invalid_operation: string;
+    user_rejected: string;
+    input_error: string;
+    simulation_failed: string;
+    transaction_failed: string;
+    generic_error: string;
+    disallowed_operation: string;
+    invalid_contract: string;
+    malicious_operation: string;
+};
+declare enum SignMessageErrorCodes {
+    InvalidMessage = "invalid_message",
+    UserRejected = "user_rejected",
+    GenericError = "generic_error"
+}
+declare const SignMessageErrorMessage: {
+    invalid_message: string;
+    user_rejected: string;
+    generic_error: string;
+};
+declare enum SignTypedDataErrorCodes {
+    InvalidOperation = "invalid_operation",
+    UserRejected = "user_rejected",
+    InputError = "input_error",
+    SimulationFailed = "simulation_failed",
+    GenericError = "generic_error",
+    DisallowedOperation = "disallowed_operation",
+    InvalidContract = "invalid_contract",
+    MaliciousOperation = "malicious_operation"
+}
+declare const SignTypedDataErrorMessage: {
+    invalid_operation: string;
+    user_rejected: string;
+    input_error: string;
+    simulation_failed: string;
+    transaction_failed: string;
+    generic_error: string;
+    disallowed_operation: string;
+    invalid_contract: string;
+    malicious_operation: string;
+};
+declare enum MiniKitInstallErrorCodes {
     Unknown = "unknown",
     AlreadyInstalled = "already_installed",
     OutsideOfWorldApp = "outside_of_worldapp",
@@ -72,10 +99,110 @@ declare const MiniKitInstallErrorMessage: {
     app_out_of_date: string;
 };
 
+declare enum Tokens {
+    USDCE = "USDCE",
+    WLD = "WLD"
+}
+declare const TokenDecimals: {
+    [key in Tokens]: number;
+};
+declare enum Network {
+    Optimism = "optimism",
+    WorldChain = "worldchain"
+}
+
+type Permit2 = {
+    permitted: {
+        token: string;
+        amount: string | unknown;
+    };
+    spender: string;
+    nonce: string | unknown;
+    deadline: string | unknown;
+};
+type Transaction = {
+    address: string;
+    abi: Abi | readonly unknown[];
+    functionName: ContractFunctionName<Abi | readonly unknown[], "payable" | "nonpayable">;
+    args: ContractFunctionArgs<Abi | readonly unknown[], "payable" | "nonpayable", ContractFunctionName<Abi | readonly unknown[], "payable" | "nonpayable">>;
+};
+type ContractFunctionName<abi extends Abi | readonly unknown[] = Abi, mutability extends AbiStateMutability = AbiStateMutability> = ExtractAbiFunctionNames<abi extends Abi ? abi : Abi, mutability> extends infer functionName extends string ? [functionName] extends [never] ? string : functionName : string;
+type ContractFunctionArgs<abi extends Abi | readonly unknown[] = Abi, mutability extends AbiStateMutability = AbiStateMutability, functionName extends ContractFunctionName<abi, mutability> = ContractFunctionName<abi, mutability>> = AbiParametersToPrimitiveTypes<ExtractAbiFunction<abi extends Abi ? abi : Abi, functionName, mutability>["inputs"], "inputs"> extends infer args ? [args] extends [never] ? readonly unknown[] : args : readonly unknown[];
+
+declare enum Command {
+    Verify = "verify",
+    Pay = "pay",
+    WalletAuth = "wallet-auth",
+    SendTransaction = "send-transaction",
+    SignMessage = "sign-message",
+    SignTypedData = "sign-typed-data"
+}
+type WebViewBasePayload = {
+    command: Command;
+    version: number;
+    payload: Record<string, any>;
+};
+type VerifyCommandInput = {
+    action: IDKitConfig["action"];
+    signal?: IDKitConfig["signal"];
+    verification_level?: VerificationLevel;
+};
+type VerifyCommandPayload = VerifyCommandInput & {
+    timestamp: string;
+};
+type TokensPayload = {
+    symbol: Tokens;
+    token_amount: string;
+};
+type PayCommandInput = {
+    reference: string;
+    to: string;
+    tokens: TokensPayload[];
+    network?: Network;
+    description: string;
+};
+type PayCommandPayload = PayCommandInput;
+type WalletAuthInput = {
+    nonce: string;
+    statement?: string;
+    requestId?: string;
+    expirationTime?: Date;
+    notBefore?: Date;
+};
+type WalletAuthPayload = {
+    siweMessage: string;
+};
+type MiniKitInstallReturnType = {
+    success: true;
+} | {
+    success: false;
+    errorCode: MiniKitInstallErrorCodes;
+    errorMessage: (typeof MiniKitInstallErrorMessage)[MiniKitInstallErrorCodes];
+};
+type SendTransactionInput = {
+    transaction: Transaction[];
+    permit2?: Permit2[];
+};
+type SendTransactionPayload = SendTransactionInput;
+type SignMessageInput = {
+    message: string;
+};
+type SignMessagePayload = SignMessageInput;
+type SignTypedDataInput = {
+    types: TypedData;
+    primaryType: string;
+    message: Record<string, unknown>;
+    domain?: TypedDataDomain;
+};
+type SignTypedDataPayload = SignTypedDataInput;
+
 declare enum ResponseEvent {
     MiniAppVerifyAction = "miniapp-verify-action",
     MiniAppPayment = "miniapp-payment",
-    MiniAppWalletAuth = "miniapp-wallet-auth"
+    MiniAppWalletAuth = "miniapp-wallet-auth",
+    MiniAppSendTransaction = "miniapp-send-transaction",
+    MiniAppSignMessage = "miniapp-sign-message",
+    MiniAppSignTypedData = "miniapp-sign-typed-data"
 }
 type MiniAppVerifyActionSuccessPayload = {
     status: "success";
@@ -91,7 +218,7 @@ type MiniAppVerifyActionErrorPayload = {
     version: number;
 };
 type MiniAppVerifyActionPayload = MiniAppVerifyActionSuccessPayload | MiniAppVerifyActionErrorPayload;
-type MiniAppPaymentSuccessEventPayload = {
+type MiniAppPaymentSuccessPayload = {
     status: "success";
     transaction_status: "submitted";
     transaction_id: string;
@@ -106,7 +233,7 @@ type MiniAppPaymentErrorPayload = {
     error_code: PaymentErrorCodes;
     version: number;
 };
-type MiniAppPaymentPayload = MiniAppPaymentSuccessEventPayload | MiniAppPaymentErrorPayload;
+type MiniAppPaymentPayload = MiniAppPaymentSuccessPayload | MiniAppPaymentErrorPayload;
 type MiniAppWalletAuthSuccessPayload = {
     status: "success";
     message: string;
@@ -120,68 +247,71 @@ type MiniAppWalletAuthErrorPayload = {
     details: (typeof WalletAuthErrorMessage)[WalletAuthErrorCodes];
     version: number;
 };
-type EventPayload<T extends ResponseEvent = ResponseEvent> = T extends ResponseEvent.MiniAppVerifyAction ? MiniAppVerifyActionPayload : MiniAppPaymentPayload;
-type EventHandler<E extends ResponseEvent = ResponseEvent> = <T extends EventPayload<E>>(data: T) => void;
-
-declare const parseSiweMessage: (inputString: string) => SiweMessage;
-declare const SAFE_CONTRACT_ABI: {
-    name: string;
-    type: string;
-    stateMutability: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs: never[];
-}[];
-declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonce: string, statement?: string, requestId?: string, userProvider?: ethers.Provider) => Promise<{
-    isValid: boolean;
-    siweMessageData: SiweMessage;
-}>;
-
-declare enum Command {
-    Verify = "verify",
-    Pay = "pay",
-    WalletAuth = "wallet-auth"
-}
-type VerifyCommandInput = {
-    action: IDKitConfig["action"];
-    signal?: IDKitConfig["signal"];
-    verification_level?: VerificationLevel$1;
+type MiniAppWalletAuthPayload = MiniAppWalletAuthSuccessPayload | MiniAppWalletAuthErrorPayload;
+type MiniAppSendTransactionSuccessPayload = {
+    status: "success";
+    transaction_status: "submitted";
+    transaction_id: string;
+    reference: string;
+    from: string;
+    chain: Network;
+    timestamp: string;
+    version: number;
 };
-type TokensPayload = {
-    symbol: Tokens;
-    token_amount: string;
+type MiniAppSendTransactionErrorPayload = {
+    status: "error";
+    error_code: SendTransactionErrorCodes;
+    version: number;
 };
-type PayCommandInput = {
-    reference: string;
-    to: string;
-    tokens: TokensPayload[];
-    network?: Network;
-    description: string;
+type MiniAppSendTransactionPayload = MiniAppSendTransactionSuccessPayload | MiniAppSendTransactionErrorPayload;
+type MiniAppSignMessageSuccessPayload = {
+    status: "success";
+    signature: string;
+    address: string;
+    version: number;
 };
-type WalletAuthInput = {
-    nonce: string;
-    statement?: string;
-    requestId?: string;
-    expirationTime?: Date;
-    notBefore?: Date;
+type MiniAppSignMessageErrorPayload = {
+    status: "error";
+    error_code: SignMessageErrorCodes;
+    version: number;
 };
-type VerifyCommandPayload = VerifyCommandInput & {
-    timestamp: string;
+type MiniAppSignMessagePayload = MiniAppSignMessageSuccessPayload | MiniAppSignMessageErrorPayload;
+type MiniAppSignTypedDataSuccessPayload = {
+    status: "success";
+    signature: string;
+    address: string;
+    version: number;
 };
-type PayCommandPayload = PayCommandInput & {
-    reference: string;
+type MiniAppSignTypedDataErrorPayload = {
+    status: "error";
+    error_code: SignTypedDataErrorCodes;
+    version: number;
 };
-type WalletAuthPayload = {
-    siweMessage: string;
+type MiniAppSignTypedDataPayload = MiniAppSignTypedDataSuccessPayload | MiniAppSignTypedDataErrorPayload;
+type EventPayloadMap = {
+    [ResponseEvent.MiniAppVerifyAction]: MiniAppVerifyActionPayload;
+    [ResponseEvent.MiniAppPayment]: MiniAppPaymentPayload;
+    [ResponseEvent.MiniAppWalletAuth]: MiniAppWalletAuthPayload;
+    [ResponseEvent.MiniAppSendTransaction]: MiniAppSendTransactionPayload;
+    [ResponseEvent.MiniAppSignMessage]: MiniAppSignMessagePayload;
+    [ResponseEvent.MiniAppSignTypedData]: MiniAppSignTypedDataPayload;
 };
-type MiniKitInstallReturnType = {
-    success: true;
-} | {
-    success: false;
-    errorCode: MiniKitInstallErrorCode;
-    errorMessage: (typeof MiniKitInstallErrorMessage)[MiniKitInstallErrorCode];
+type EventPayload<T extends ResponseEvent = ResponseEvent> = T extends keyof EventPayloadMap ? EventPayloadMap[T] : never;
+type EventHandler<E extends ResponseEvent = ResponseEvent> = <T extends EventPayload<E>>(data: T) => void;
+
+type SiweMessage = {
+    scheme?: string;
+    domain: string;
+    address?: string;
+    statement?: string;
+    uri: string;
+    version: number;
+    chain_id: number;
+    nonce: string;
+    issued_at: string;
+    expiration_time?: string;
+    not_before?: string;
+    request_id?: string;
 };
 
 declare class MiniKit {
@@ -199,10 +329,28 @@ declare class MiniKit {
         verify: (payload: VerifyCommandInput) => VerifyCommandPayload;
         pay: (payload: PayCommandInput) => PayCommandPayload | null;
         walletAuth: (payload: WalletAuthInput) => WalletAuthPayload | null;
-        closeWebview: () => void;
+        sendTransaction: (payload: SendTransactionInput) => SendTransactionPayload;
+        signMessage: (payload: SignMessageInput) => SignMessagePayload;
+        signTypedData: (payload: SignTypedDataInput) => SignTypedDataPayload;
     };
 }
 
 declare const tokenToDecimals: (amount: number, token: Tokens) => number;
 
-export { Command, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessEventPayload, type MiniAppVerifyActionErrorPayload, type MiniAppVerifyActionPayload, type MiniAppVerifyActionSuccessPayload, type MiniAppWalletAuthErrorPayload, type MiniAppWalletAuthSuccessPayload, MiniKit, MiniKitInstallErrorCode, MiniKitInstallErrorMessage, Network, type PayCommandInput, PaymentErrorCodes, PaymentErrorMessage, PaymentValidationErrors, ResponseEvent, SAFE_CONTRACT_ABI, type SiweMessage, TokenDecimals, Tokens, VerificationErrorMessage, type VerifyCommandInput, WalletAuthErrorCodes, WalletAuthErrorMessage, parseSiweMessage, tokenToDecimals, verifySiweMessage };
+declare const parseSiweMessage: (inputString: string) => SiweMessage;
+declare const SAFE_CONTRACT_ABI: {
+    name: string;
+    type: string;
+    stateMutability: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: never[];
+}[];
+declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonce: string, statement?: string, requestId?: string, userProvider?: Client) => Promise<{
+    isValid: boolean;
+    siweMessageData: SiweMessage;
+}>;
+
+export { Command, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, type MiniAppSignMessageErrorPayload, type MiniAppSignMessagePayload, type MiniAppSignMessageSuccessPayload, type MiniAppSignTypedDataErrorPayload, type MiniAppSignTypedDataPayload, type MiniAppSignTypedDataSuccessPayload, type MiniAppVerifyActionErrorPayload, type MiniAppVerifyActionPayload, type MiniAppVerifyActionSuccessPayload, type MiniAppWalletAuthErrorPayload, type MiniAppWalletAuthPayload, type MiniAppWalletAuthSuccessPayload, MiniKit, MiniKitInstallErrorCodes, MiniKitInstallErrorMessage, type MiniKitInstallReturnType, Network, type PayCommandInput, type PayCommandPayload, PaymentErrorCodes, PaymentErrorMessage, PaymentValidationErrors, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, SignMessageErrorCodes, SignMessageErrorMessage, type SignMessageInput, type SignMessagePayload, SignTypedDataErrorCodes, SignTypedDataErrorMessage, type SignTypedDataInput, type SignTypedDataPayload, type SiweMessage, TokenDecimals, Tokens, type TokensPayload, VerificationErrorMessage, type VerifyCommandInput, type VerifyCommandPayload, WalletAuthErrorCodes, WalletAuthErrorMessage, type WalletAuthInput, type WalletAuthPayload, type WebViewBasePayload, parseSiweMessage, tokenToDecimals, verifySiweMessage };