@worldcoin/minikit-js 1.3.0 → 1.5.0

package/build/index.d.ts

@@ -4,36 +4,6 @@ import { Abi, AbiStateMutability, ExtractAbiFunctionNames, AbiParametersToPrimit
 export { IVerifyResponse, verifyCloudProof } from '@worldcoin/idkit-core/backend';
 import { Client } from 'viem';
 
-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 const VerificationErrorMessage: Record<AppErrorCodes, string>;
 declare enum PaymentErrorCodes {
     InputError = "input_error",
@@ -136,6 +106,52 @@ declare const ShareContactsErrorMessage: {
     user_rejected: string;
     generic_error: string;
 };
+declare enum RequestPermissionErrorCodes {
+    UserRejected = "user_rejected",
+    GenericError = "generic_error",
+    AlreadyRequested = "already_requested",
+    PermissionDisabled = "permission_disabled",
+    AlreadyGranted = "already_granted",
+    UnsupportedPermission = "unsupported_permission"
+}
+declare const RequestPermissionErrorMessage: {
+    user_rejected: string;
+    generic_error: string;
+    already_requested: string;
+    permission_disabled: string;
+    already_granted: string;
+    unsupported_permission: 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",
@@ -144,7 +160,8 @@ declare enum Command {
     SendTransaction = "send-transaction",
     SignMessage = "sign-message",
     SignTypedData = "sign-typed-data",
-    ShareContacts = "share-contacts"
+    ShareContacts = "share-contacts",
+    RequestPermission = "request-permission"
 }
 type WebViewBasePayload = {
     command: Command;
@@ -156,8 +173,8 @@ type AsyncHandlerReturn<CommandPayload, FinalPayload> = Promise<{
     finalPayload: FinalPayload;
 }>;
 type VerifyCommandInput = {
-    action: IDKitConfig["action"];
-    signal?: IDKitConfig["signal"];
+    action: IDKitConfig['action'];
+    signal?: IDKitConfig['signal'];
     verification_level?: VerificationLevel;
 };
 type VerifyCommandPayload = VerifyCommandInput & {
@@ -210,8 +227,16 @@ type SignTypedDataInput = {
 type SignTypedDataPayload = SignTypedDataInput;
 type ShareContactsInput = {
     isMultiSelectEnabled: boolean;
+    inviteMessage?: string;
 };
 type ShareContactsPayload = ShareContactsInput;
+declare enum Permission {
+    Notifications = "notifications"
+}
+type RequestPermissionInput = {
+    permission: Permission;
+};
+type RequestPermissionPayload = RequestPermissionInput;
 type CommandReturnPayloadMap = {
     [Command.Verify]: VerifyCommandPayload;
     [Command.Pay]: PayCommandPayload;
@@ -220,6 +245,7 @@ type CommandReturnPayloadMap = {
     [Command.SignMessage]: SignMessagePayload;
     [Command.SignTypedData]: SignTypedDataPayload;
     [Command.ShareContacts]: ShareContactsPayload;
+    [Command.RequestPermission]: RequestPermissionPayload;
 };
 type CommandReturnPayload<T extends Command> = T extends keyof CommandReturnPayloadMap ? CommandReturnPayloadMap[T] : never;
 
@@ -230,10 +256,11 @@ declare enum ResponseEvent {
     MiniAppSendTransaction = "miniapp-send-transaction",
     MiniAppSignMessage = "miniapp-sign-message",
     MiniAppSignTypedData = "miniapp-sign-typed-data",
-    MiniAppShareContacts = "miniapp-share-contacts"
+    MiniAppShareContacts = "miniapp-share-contacts",
+    MiniAppRequestPermission = "miniapp-request-permission"
 }
 type MiniAppVerifyActionSuccessPayload = {
-    status: "success";
+    status: 'success';
     proof: string;
     merkle_root: string;
     nullifier_hash: string;
@@ -241,14 +268,14 @@ type MiniAppVerifyActionSuccessPayload = {
     version: number;
 };
 type MiniAppVerifyActionErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: AppErrorCodes;
     version: number;
 };
 type MiniAppVerifyActionPayload = MiniAppVerifyActionSuccessPayload | MiniAppVerifyActionErrorPayload;
 type MiniAppPaymentSuccessPayload = {
-    status: "success";
-    transaction_status: "submitted";
+    status: 'success';
+    transaction_status: 'submitted';
     transaction_id: string;
     reference: string;
     from: string;
@@ -257,28 +284,28 @@ type MiniAppPaymentSuccessPayload = {
     version: number;
 };
 type MiniAppPaymentErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: PaymentErrorCodes;
     version: number;
 };
 type MiniAppPaymentPayload = MiniAppPaymentSuccessPayload | MiniAppPaymentErrorPayload;
 type MiniAppWalletAuthSuccessPayload = {
-    status: "success";
+    status: 'success';
     message: string;
     signature: string;
     address: string;
     version: number;
 };
 type MiniAppWalletAuthErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: WalletAuthErrorCodes;
     details: (typeof WalletAuthErrorMessage)[WalletAuthErrorCodes];
     version: number;
 };
 type MiniAppWalletAuthPayload = MiniAppWalletAuthSuccessPayload | MiniAppWalletAuthErrorPayload;
 type MiniAppSendTransactionSuccessPayload = {
-    status: "success";
-    transaction_status: "submitted";
+    status: 'success';
+    transaction_status: 'submitted';
     transaction_id: string;
     reference: string;
     from: string;
@@ -287,33 +314,33 @@ type MiniAppSendTransactionSuccessPayload = {
     version: number;
 };
 type MiniAppSendTransactionErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: SendTransactionErrorCodes;
     details?: Record<string, any>;
     version: number;
 };
 type MiniAppSendTransactionPayload = MiniAppSendTransactionSuccessPayload | MiniAppSendTransactionErrorPayload;
 type MiniAppSignMessageSuccessPayload = {
-    status: "success";
+    status: 'success';
     signature: string;
     address: string;
     version: number;
 };
 type MiniAppSignMessageErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: SignMessageErrorCodes;
     details?: Record<string, any>;
     version: number;
 };
 type MiniAppSignMessagePayload = MiniAppSignMessageSuccessPayload | MiniAppSignMessageErrorPayload;
 type MiniAppSignTypedDataSuccessPayload = {
-    status: "success";
+    status: 'success';
     signature: string;
     address: string;
     version: number;
 };
 type MiniAppSignTypedDataErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: SignTypedDataErrorCodes;
     details?: Record<string, any>;
     version: number;
@@ -325,17 +352,30 @@ type Contact = {
     profilePictureUrl: string | null;
 };
 type MiniAppShareContactsSuccessPayload = {
-    status: "success";
+    status: 'success';
     contacts: Contact[];
     version: number;
     timestamp: string;
 };
 type MiniAppShareContactsErrorPayload = {
-    status: "error";
+    status: 'error';
     error_code: ShareContactsErrorCodes;
     version: number;
 };
 type MiniAppShareContactsPayload = MiniAppShareContactsSuccessPayload | MiniAppShareContactsErrorPayload;
+type MiniAppRequestPermissionSuccessPayload = {
+    status: 'success';
+    permission: Permission;
+    timestamp: string;
+    version: number;
+};
+type MiniAppRequestPermissionErrorPayload = {
+    status: 'error';
+    error_code: RequestPermissionErrorCodes;
+    description: string;
+    version: number;
+};
+type MiniAppRequestPermissionPayload = MiniAppRequestPermissionSuccessPayload | MiniAppRequestPermissionErrorPayload;
 type EventPayloadMap = {
     [ResponseEvent.MiniAppVerifyAction]: MiniAppVerifyActionPayload;
     [ResponseEvent.MiniAppPayment]: MiniAppPaymentPayload;
@@ -344,23 +384,15 @@ type EventPayloadMap = {
     [ResponseEvent.MiniAppSignMessage]: MiniAppSignMessagePayload;
     [ResponseEvent.MiniAppSignTypedData]: MiniAppSignTypedDataPayload;
     [ResponseEvent.MiniAppShareContacts]: MiniAppShareContactsPayload;
+    [ResponseEvent.MiniAppRequestPermission]: MiniAppRequestPermissionPayload;
 };
 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;
+type User = {
+    walletAddress: string;
+    username: string | null;
+    profilePictureUrl: string | null;
 };
 
 declare class MiniKit {
@@ -369,12 +401,11 @@ declare class MiniKit {
     private static isCommandAvailable;
     private static listeners;
     static appId: string | null;
+    /**
+     * @deprecated you should use MiniKit.user.walletAddress instead
+     */
     static walletAddress: string | null;
-    static user: {
-        walletAddress: string | null;
-        username: string | null;
-        profilePictureUrl: string | null;
-    } | null;
+    static user: User | null;
     private static sendInit;
     static subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
     static unsubscribe(event: ResponseEvent): void;
@@ -383,6 +414,7 @@ declare class MiniKit {
     private static commandsValid;
     static install(appId?: string): MiniKitInstallReturnType;
     static isInstalled(debug?: boolean): boolean;
+    static getUserByAddress: (address: string) => Promise<User>;
     static commands: {
         verify: (payload: VerifyCommandInput) => VerifyCommandPayload | null;
         pay: (payload: PayCommandInput) => PayCommandPayload | null;
@@ -391,6 +423,7 @@ declare class MiniKit {
         signMessage: (payload: SignMessageInput) => SignMessagePayload | null;
         signTypedData: (payload: SignTypedDataInput) => SignTypedDataPayload | null;
         shareContacts: (payload: ShareContactsPayload) => ShareContactsPayload | null;
+        requestPermission: (payload: RequestPermissionInput) => RequestPermissionPayload | null;
     };
     /**
      * This object contains async versions of all the commands.
@@ -410,25 +443,48 @@ declare class MiniKit {
         signMessage: (payload: SignMessageInput) => AsyncHandlerReturn<SignMessagePayload | null, MiniAppSignMessagePayload>;
         signTypedData: (payload: SignTypedDataInput) => AsyncHandlerReturn<SignTypedDataPayload | null, MiniAppSignTypedDataPayload>;
         shareContacts: (payload: ShareContactsPayload) => AsyncHandlerReturn<ShareContactsPayload | null, MiniAppShareContactsPayload>;
+        requestPermission: (payload: RequestPermissionInput) => AsyncHandlerReturn<RequestPermissionPayload | null, MiniAppRequestPermissionPayload>;
     };
 }
 
+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 const tokenToDecimals: (amount: number, token: Tokens) => number;
 
 declare const parseSiweMessage: (inputString: string) => SiweMessage;
 declare const SAFE_CONTRACT_ABI: {
-    name: string;
-    type: string;
-    stateMutability: string;
     inputs: {
+        internalType: string;
         name: string;
         type: string;
     }[];
-    outputs: never[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
 }[];
 declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonce: string, statement?: string, requestId?: string, userProvider?: Client) => Promise<{
     isValid: boolean;
     siweMessageData: SiweMessage;
 }>;
 
-export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type Contact, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, type MiniAppShareContactsErrorPayload, type MiniAppShareContactsPayload, type MiniAppShareContactsSuccessPayload, 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, ShareContactsErrorCodes, ShareContactsErrorMessage, type ShareContactsInput, type ShareContactsPayload, 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 };
+declare const getIsUserVerified: (walletAddress: string, rpcUrl?: string) => Promise<boolean>;
+
+export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type Contact, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppRequestPermissionErrorPayload, type MiniAppRequestPermissionPayload, type MiniAppRequestPermissionSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, type MiniAppShareContactsErrorPayload, type MiniAppShareContactsPayload, type MiniAppShareContactsSuccessPayload, 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, Permission, RequestPermissionErrorCodes, RequestPermissionErrorMessage, type RequestPermissionInput, type RequestPermissionPayload, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, ShareContactsErrorCodes, ShareContactsErrorMessage, type ShareContactsInput, type ShareContactsPayload, 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, getIsUserVerified, parseSiweMessage, tokenToDecimals, verifySiweMessage };