@worldcoin/minikit-js 1.9.11 → 2.0.0-dev.0

package/README.md

@@ -10,6 +10,110 @@ or use the CDN:
 
 For comprehensive setup instructions and usage examples, visit our [developer documentation](https://docs.world.org/mini-apps).
 
+## Scope
+
+`@worldcoin/minikit-js` is the mini-app command SDK:
+
+- `MiniKit.walletAuth()`
+- `MiniKit.sendTransaction()`
+- `MiniKit.pay()`
+- `MiniKit.shareContacts()`
+- `MiniKit.signMessage()`
+- `MiniKit.signTypedData()`
+- and related mini-app commands
+
+World ID verification belongs to IDKit:
+
+- Use `@worldcoin/idkit` for verification requests and widget UI
+- Use `@worldcoin/idkit-core` for backend signing helpers such as `signRequest`
+
+## v2 -> v3 Migration Highlights
+
+- `MiniKit.commands.*` / `MiniKit.commandsAsync.*` are removed. Use `await MiniKit.<command>(...)`.
+- Command responses now use `{ executedWith, data }`.
+- Verify flows moved to IDKit (`@worldcoin/idkit`), not MiniKit.
+- `walletAuth` nonce validation is stricter (alphanumeric SIWE nonce).
+- Tree-shakeable subpath exports are available for commands and helpers.
+
+### `sendTransaction` uses one flexible transaction type
+
+When `transaction[i].data` is provided, MiniKit prioritizes raw calldata over
+`abi` / `functionName` / `args`.
+
+Example:
+
+```ts
+await MiniKit.sendTransaction({
+  transaction: [
+    {
+      address: tokenAddress,
+      data: '0xa9059cbb...', // takes priority when present
+      abi: erc20Abi,
+      functionName: 'transfer',
+      args: [to, amount],
+    },
+  ],
+});
+```
+
+Type shape:
+
+```ts
+type Transaction = {
+  address: string;
+  value?: string;
+  data?: string;
+  abi?: Abi | readonly unknown[];
+  functionName?: ContractFunctionName<...>;
+  args?: ContractFunctionArgs<...>;
+};
+
+interface MiniKitSendTransactionOptions<TCustomFallback = SendTransactionResult> {
+  transaction: Transaction[];
+  chainId?: number; // defaults to 480 on World App
+  permit2?: Permit2[];
+  formatPayload?: boolean;
+}
+```
+
+### Tree-shakeable subpath exports
+
+Use subpaths to import only what you need:
+
+```ts
+import {
+  MiniKitSendTransactionOptions,
+  SendTransactionErrorCodes,
+} from '@worldcoin/minikit-js/commands';
+import { getIsUserVerified } from '@worldcoin/minikit-js/address-book';
+import { parseSiweMessage, verifySiweMessage } from '@worldcoin/minikit-js/siwe';
+```
+
+You can still import `MiniKit` itself from the package root:
+
+```ts
+import { MiniKit } from '@worldcoin/minikit-js';
+```
+
+### Commands now support custom fallbacks
+
+Use `fallback` to run equivalent logic outside World App:
+
+```ts
+const result = await MiniKit.sendHapticFeedback({
+  hapticsType: 'impact',
+  style: 'light',
+  fallback: () => {
+    navigator.vibrate?.(20);
+    return {
+      status: 'success',
+      version: 1,
+      timestamp: new Date().toISOString(),
+    };
+  },
+});
+```
+
 ## 🛠 ️Developing Locally
 
 To run the example mini app locally:

package/build/address-book.cjs

@@ -0,0 +1,81 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/address-book.ts
+var address_book_exports = {};
+__export(address_book_exports, {
+  getIsUserVerified: () => getIsUserVerified
+});
+module.exports = __toCommonJS(address_book_exports);
+
+// src/helpers/address-book.ts
+var import_viem = require("viem");
+var import_chains = require("viem/chains");
+var worldIdAddressBookContractAddress = "0x57b930D551e677CC36e2fA036Ae2fe8FdaE0330D";
+var addressVerifiedUntilAbi = [
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "",
+        type: "address"
+      }
+    ],
+    name: "addressVerifiedUntil",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view",
+    type: "function"
+  }
+];
+var getIsUserVerified = async (walletAddress, rpcUrl) => {
+  const publicClient = (0, import_viem.createPublicClient)({
+    chain: import_chains.worldchain,
+    transport: (0, import_viem.http)(
+      rpcUrl || "https://worldchain-mainnet.g.alchemy.com/public"
+    )
+  });
+  try {
+    const verifiedUntilResponse = await publicClient.readContract({
+      address: worldIdAddressBookContractAddress,
+      abi: addressVerifiedUntilAbi,
+      functionName: "addressVerifiedUntil",
+      args: [walletAddress]
+    });
+    const verifiedUntil = Number(verifiedUntilResponse.toString());
+    if (!Number.isFinite(verifiedUntil)) {
+      console.warn("Invalid verifiedUntil value:", verifiedUntil);
+      return false;
+    }
+    const currentTime = Math.floor(Date.now() / 1e3);
+    return verifiedUntil > currentTime;
+  } catch (error) {
+    console.error("Error verifying user:", error);
+    return false;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getIsUserVerified
+});

package/build/address-book.d.cts

@@ -0,0 +1,3 @@
+declare const getIsUserVerified: (walletAddress: string, rpcUrl?: string) => Promise<boolean>;
+
+export { getIsUserVerified };

package/build/address-book.d.ts

@@ -0,0 +1,3 @@
+declare const getIsUserVerified: (walletAddress: string, rpcUrl?: string) => Promise<boolean>;
+
+export { getIsUserVerified };

package/build/address-book.js

@@ -0,0 +1,54 @@
+// src/helpers/address-book.ts
+import { createPublicClient, http } from "viem";
+import { worldchain } from "viem/chains";
+var worldIdAddressBookContractAddress = "0x57b930D551e677CC36e2fA036Ae2fe8FdaE0330D";
+var addressVerifiedUntilAbi = [
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "",
+        type: "address"
+      }
+    ],
+    name: "addressVerifiedUntil",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view",
+    type: "function"
+  }
+];
+var getIsUserVerified = async (walletAddress, rpcUrl) => {
+  const publicClient = createPublicClient({
+    chain: worldchain,
+    transport: http(
+      rpcUrl || "https://worldchain-mainnet.g.alchemy.com/public"
+    )
+  });
+  try {
+    const verifiedUntilResponse = await publicClient.readContract({
+      address: worldIdAddressBookContractAddress,
+      abi: addressVerifiedUntilAbi,
+      functionName: "addressVerifiedUntil",
+      args: [walletAddress]
+    });
+    const verifiedUntil = Number(verifiedUntilResponse.toString());
+    if (!Number.isFinite(verifiedUntil)) {
+      console.warn("Invalid verifiedUntil value:", verifiedUntil);
+      return false;
+    }
+    const currentTime = Math.floor(Date.now() / 1e3);
+    return verifiedUntil > currentTime;
+  } catch (error) {
+    console.error("Error verifying user:", error);
+    return false;
+  }
+};
+export {
+  getIsUserVerified
+};