diff --git a/cspell.json b/cspell.json index 861eabe..3cf1a67 100644 --- a/cspell.json +++ b/cspell.json @@ -14,8 +14,8 @@ "words": [ "agentbook", "agentic", - "anymatch", "agentkit", + "anymatch", "AQAB", "blockchain", "Blockscout", @@ -118,8 +118,8 @@ "quicknode", "quotidiennes", "Rabby", - "Recompensas", "readdirp", + "Recompensas", "Récompenses", "reenroll", "Roboto", @@ -141,6 +141,7 @@ "Solana", "sont", "spammy", + "stablecoins", "Sunsetting", "Superbridge", "superchain", @@ -155,8 +156,8 @@ "tute", "uniffi", "unpackedProof", - "userop", "urlencode", + "userop", "UUPS", "uvwx", "verifyProof", diff --git a/docs.json b/docs.json index e2e4e4f..72b69ff 100644 --- a/docs.json +++ b/docs.json @@ -68,6 +68,7 @@ { "group": "Commands", "pages": [ + "mini-apps/commands/verify", "mini-apps/commands/pay", "mini-apps/commands/wallet-auth", "mini-apps/commands/send-transaction", @@ -111,6 +112,11 @@ { "group": "Further Reading", "pages": [ + "mini-apps/more/minikit-v2", + "mini-apps/more/webview-spec", + "mini-apps/ecosystem/ecosystem", + "mini-apps/more/community-tools-perks", + "mini-apps/more/faq", { "group": "Growth Playbook", "pages": [ @@ -120,13 +126,7 @@ "mini-apps/growth/notifications", "mini-apps/growth/analytics" ] - }, - "mini-apps/more/releases", - "mini-apps/more/webview-spec", - "mini-apps/ecosystem/ecosystem", - "mini-apps/more/community-tools-perks", - "mini-apps/more/minikit-v2", - "mini-apps/more/faq" + } ] } ] diff --git a/images/docs/mini-apps/commands/pay-command.mp4 b/images/docs/mini-apps/commands/pay-command.mp4 deleted file mode 100644 index 9ebfb8d..0000000 Binary files a/images/docs/mini-apps/commands/pay-command.mp4 and /dev/null differ diff --git a/images/docs/mini-apps/commands/pay-updated.gif b/images/docs/mini-apps/commands/pay-updated.gif new file mode 100644 index 0000000..97002ea Binary files /dev/null and b/images/docs/mini-apps/commands/pay-updated.gif differ diff --git a/mini-apps/commands/attestation.mdx b/mini-apps/commands/attestation.mdx index de547bd..090b028 100644 --- a/mini-apps/commands/attestation.mdx +++ b/mini-apps/commands/attestation.mdx @@ -7,14 +7,10 @@ description: "Request an attestation token using the unified MiniKit API." Use `MiniKit.attestation()` to request an app attestation token for a request hash. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -37,6 +33,14 @@ export async function requestAttestation() { } ``` +```ts title="Type" +type MiniKitAttestationOptions = { + requestHash: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -70,7 +74,7 @@ type AttestationResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/chat.mdx b/mini-apps/commands/chat.mdx index 239ec8a..754de44 100644 --- a/mini-apps/commands/chat.mdx +++ b/mini-apps/commands/chat.mdx @@ -7,14 +7,10 @@ description: "Share a message through World Chat using the unified MiniKit API." Use `MiniKit.chat()` to open World Chat with a prefilled message. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -38,6 +34,15 @@ export async function shareToChat() { } ``` +```ts title="Type" +type MiniKitChatOptions = { + message: string; + to?: string[]; + fallback?: () => unknown; +}; +``` + + ## Result @@ -73,7 +78,7 @@ type ChatResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent sharing behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/close-miniapp.mdx b/mini-apps/commands/close-miniapp.mdx index a70a74c..da6c4fd 100644 --- a/mini-apps/commands/close-miniapp.mdx +++ b/mini-apps/commands/close-miniapp.mdx @@ -7,14 +7,10 @@ description: "Programmatically close the mini app using the unified MiniKit API. Use `MiniKit.closeMiniApp()` to programmatically close the mini app. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -35,6 +31,13 @@ export async function closeMiniApp() { } ``` +```ts title="Type" +type MiniKitCloseMiniAppOptions = { + fallback?: () => unknown; +}; +``` + + ## Result @@ -66,4 +69,4 @@ type CloseMiniAppResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. diff --git a/mini-apps/commands/get-permissions.mdx b/mini-apps/commands/get-permissions.mdx index 97563ca..2fdd422 100644 --- a/mini-apps/commands/get-permissions.mdx +++ b/mini-apps/commands/get-permissions.mdx @@ -7,14 +7,10 @@ description: "Read current mini app permission settings using the unified MiniKi Use `MiniKit.getPermissions()` to read the current permission state for the mini app. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -35,6 +31,13 @@ export async function getPermissions() { } ``` +```ts title="Type" +type MiniKitGetPermissionsOptions = { + fallback?: () => unknown; +}; +``` + + ## Result @@ -78,7 +81,7 @@ type GetPermissionsResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent permission behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/how-to-send-notifications.mdx b/mini-apps/commands/how-to-send-notifications.mdx index 98fc076..187b3b7 100644 --- a/mini-apps/commands/how-to-send-notifications.mdx +++ b/mini-apps/commands/how-to-send-notifications.mdx @@ -13,28 +13,6 @@ To send notifications to users you need to: - Request permission to send notifications from the user, via MiniKit (see [Request Permission](/mini-apps/commands/request-permission)), - Actually send the notification using our API or the Developer Portal. -Notifications are queued on our servers, users may not receive them immediately. - -## Manually sending notifications from Developer Portal - - - This form doesn't support localized notifications yet. To take advantage of - localizations, use the API. - - -You can send notifications to multiple wallet addresses (up to 1000) directly from the Developer Portal. - -
- Notification Interface in the Developer Portal -
- -Use the form to input addresses, and content details. Once you click the `Send` button and get a success response, your notifications will be queued for delivery. - ## Calling the send-notification endpoint The API endpoint provides capabilities for sending notifications programmatically. These notifications can be localized, @@ -83,6 +61,26 @@ If their language isn't included in your localizations, you'll receive a specifi For complete API documentation including all supported languages and response formats, see the [API Reference](/api-reference/developer-portal/send-notification). +## Manually sending notifications from Developer Portal + + + This form doesn't support localized notifications yet. To take advantage of + localizations, use the API. + + +You can send notifications to multiple wallet addresses (up to 1000) directly from the Developer Portal. + +
+ Notification Interface in the Developer Portal +
+ +Use the form to input addresses, and content details. Once you click the `Send` button and get a success response, your notifications will be queued for delivery. + ## Testing We currently have a limit of 40 notifications per 4 hours for unverified apps. This is to help you test your notification implementations. diff --git a/mini-apps/commands/pay.mdx b/mini-apps/commands/pay.mdx index bf83bfc..4815917 100644 --- a/mini-apps/commands/pay.mdx +++ b/mini-apps/commands/pay.mdx @@ -1,25 +1,16 @@ --- title: "Pay" -description: "Request a payment using the unified MiniKit API." +description: "Request a payment from the user" "og:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" "twitter:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" --- -Use `MiniKit.pay()` to request a payment inside World App. - - - These examples assume MiniKit has already been initialized through - `MiniKitProvider` or `MiniKit.install()`. - - -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App +This command is an abstraction for a simple transfer. This shouldn't be used outside of World App. Pay supports WLD and all local stablecoins. ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import { Tokens, @@ -30,7 +21,8 @@ import { } from "@worldcoin/minikit-js/commands"; export async function sendPayment() { - const response = await fetch("/api/initiate-payment", { method: "POST" }); + // Create a nonce in the backend to use as a reference for this payment. + const response = await fetch("/api/generate-nonce", { method: "POST" }); const { id } = await response.json(); const input = { @@ -43,7 +35,10 @@ export async function sendPayment() { }, ], description: "Example payment", - } satisfies MiniKitPayOptions; + fallback: () => { + alert("Please complete the payment in World App to proceed."); + }, + }; const result: CommandResultByVia = await MiniKit.pay(input); @@ -58,6 +53,20 @@ export async function sendPayment() { } ``` +```ts title="Type" +type MiniKitPayOptions = { + reference: string; + to: string; + tokens: { + symbol: Tokens; + token_amount: string; + }[]; + description: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -93,10 +102,6 @@ type PayResponse = ``` -## Fallback Behavior - -Use a custom `fallback` if you want equivalent payment behavior outside World App. - ## Backend Verification Always verify the payment on your backend before treating it as final. @@ -140,14 +145,12 @@ export async function POST(req: NextRequest) { | `generic_error` | Unexpected failure | | `user_blocked` | Payments are not available in the user's region | +## Fallback Behavior + +Define a custom fallback in the command payload for support outside mini apps. + ## Preview
- + Pay command demo
diff --git a/mini-apps/commands/request-permission.mdx b/mini-apps/commands/request-permission.mdx index d00bb3c..5ec66c4 100644 --- a/mini-apps/commands/request-permission.mdx +++ b/mini-apps/commands/request-permission.mdx @@ -7,14 +7,10 @@ description: "Request a mini app permission using the unified MiniKit API." Use `MiniKit.requestPermission()` to ask the user for a permission such as notifications or microphone access. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import { Permission, @@ -38,6 +34,14 @@ export async function requestNotifications() { } ``` +```ts title="Type" +type MiniKitRequestPermissionOptions = { + permission: Permission; + fallback?: () => unknown; +}; +``` + + ## Result @@ -73,7 +77,7 @@ type RequestPermissionResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent permission behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/send-haptic-feedback.mdx b/mini-apps/commands/send-haptic-feedback.mdx index 6282ebd..babffc3 100644 --- a/mini-apps/commands/send-haptic-feedback.mdx +++ b/mini-apps/commands/send-haptic-feedback.mdx @@ -7,11 +7,6 @@ description: "Trigger haptic feedback using the unified MiniKit API." Use `MiniKit.sendHapticFeedback()` to trigger native haptic feedback. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Haptic Types - **`"notification"`** — style: `"success"`, `"warning"`, or `"error"` @@ -21,30 +16,6 @@ Use `MiniKit.sendHapticFeedback()` to trigger native haptic feedback. ## Basic Usage -```tsx title="Notification" -import { MiniKit } from "@worldcoin/minikit-js"; -import type { - CommandResultByVia, - MiniAppSendHapticFeedbackSuccessPayload, - MiniKitSendHapticFeedbackOptions, -} from "@worldcoin/minikit-js/commands"; - -export async function sendSuccessHaptic() { - const input = { - hapticsType: "notification", - style: "success", - } satisfies MiniKitSendHapticFeedbackOptions; - - const result: CommandResultByVia< - MiniAppSendHapticFeedbackSuccessPayload, - MiniAppSendHapticFeedbackSuccessPayload, - "minikit" - > = await MiniKit.sendHapticFeedback(input); - - console.log(result.data.timestamp); -} -``` - ```tsx title="Impact" import { MiniKit } from "@worldcoin/minikit-js"; import type { MiniKitSendHapticFeedbackOptions } from "@worldcoin/minikit-js/commands"; @@ -67,6 +38,24 @@ export async function sendSelectionHaptic() { } satisfies MiniKitSendHapticFeedbackOptions); } ``` + +```ts title="Type" +type MiniKitSendHapticFeedbackOptions = + | { + hapticsType: "notification"; + style: "error" | "success" | "warning"; + fallback?: () => unknown; + } + | { + hapticsType: "impact"; + style: "light" | "medium" | "heavy"; + fallback?: () => unknown; + } + | { + hapticsType: "selection-changed"; + fallback?: () => unknown; + }; +``` ## Result @@ -102,7 +91,7 @@ type SendHapticFeedbackResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent haptic behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/send-transaction.mdx b/mini-apps/commands/send-transaction.mdx index aa27d40..cf67717 100644 --- a/mini-apps/commands/send-transaction.mdx +++ b/mini-apps/commands/send-transaction.mdx @@ -7,22 +7,11 @@ description: "Send one or more World Chain transactions using the unified MiniKi Use `MiniKit.sendTransaction()` to submit one or more World Chain transactions. - - These examples assume MiniKit has already been initialized through - `MiniKitProvider` or `MiniKit.install()`. - - -## Availability - -- Works natively in World App -- Supports Wagmi execution outside World App -- Batch transactions are only available in World App - ## Basic Usage -If you used permit2 in MiniKit v1, MiniKit v2 removes that top-level field; Permit2 approvals now need to be sent as explicit transactions - -```tsx +MiniKit uses Permit2 under the hood. + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -49,6 +38,19 @@ export async function sendTransaction() { } ``` +```ts title="Type" +type MiniKitSendTransactionOptions = { + chainId: number; + transactions: { + to: string; + data?: string; + value?: string; + }[]; + fallback?: () => unknown; +}; +``` + + ## Result @@ -147,15 +149,6 @@ if (status.status === "success") { See [GET /api/v2/minikit/userop/{user_op_hash}](/api-reference/developer-portal/get-user-operation) for the full endpoint response shape. -## Fallback Behavior - -If `result.executedWith === "wagmi"`, MiniKit used the standard web signer path -outside World App. This path supports only a single transaction, so batched -`transactions` arrays remain World App-only. - -If you need a different non-World-App flow, provide a custom `fallback` and -handle submission yourself. - ## Error Codes | Code | Meaning | @@ -174,6 +167,10 @@ handle submission yourself. | `permitted_amount_exceeds_slippage` | Permit2 amount exceeds allowed slippage | | `permitted_amount_not_found` | Permit2 amount could not be resolved | +## Fallback Behavior + +By default we intend for mini apps to be useable outside of World App. Fallbacks generally will not be needed and you should instead follow the [migration path outlined](/mini-apps/more/minikit-v2). + ## Preview
diff --git a/mini-apps/commands/share-contacts.mdx b/mini-apps/commands/share-contacts.mdx index fb35b1a..db24bba 100644 --- a/mini-apps/commands/share-contacts.mdx +++ b/mini-apps/commands/share-contacts.mdx @@ -7,14 +7,10 @@ description: "Open the native contact picker using the unified MiniKit API." Use `MiniKit.shareContacts()` to open the World App contact picker. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -38,6 +34,15 @@ export async function pickContacts() { } ``` +```ts title="Type" +type MiniKitShareContactsOptions = { + isMultiSelectEnabled?: boolean; + inviteMessage?: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -77,10 +82,6 @@ type ShareContactsResponse = ``` -## Fallback Behavior - -Use a custom `fallback` if you want equivalent behavior outside World App. - ## Error Codes | Code | Meaning | @@ -88,6 +89,10 @@ Use a custom `fallback` if you want equivalent behavior outside World App. | `user_rejected` | The user rejected the request | | `generic_error` | Unexpected failure | +## Fallback Behavior + +Define a custom fallback in the command payload for support outside mini apps. + ## Preview
diff --git a/mini-apps/commands/share.mdx b/mini-apps/commands/share.mdx index 7f3af1b..659546f 100644 --- a/mini-apps/commands/share.mdx +++ b/mini-apps/commands/share.mdx @@ -7,14 +7,10 @@ description: "Open the native share sheet using the unified MiniKit API." Use `MiniKit.share()` to open the native share sheet with text, links, or files. -## Availability - -- Works natively in World App -- Supports a custom fallback outside World App - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -39,6 +35,17 @@ export async function shareLink() { } ``` +```ts title="Type" +type MiniKitShareOptions = { + files?: File[]; + title?: string; + text?: string; + url?: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -74,7 +81,7 @@ type ShareResponse = ## Fallback Behavior -Use a custom `fallback` if you want equivalent share behavior outside World App. +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/sign-message.mdx b/mini-apps/commands/sign-message.mdx index 15ebc3d..5f318b6 100644 --- a/mini-apps/commands/sign-message.mdx +++ b/mini-apps/commands/sign-message.mdx @@ -7,14 +7,10 @@ description: "Sign an EIP-191 message using the unified MiniKit API." Use `MiniKit.signMessage()` to request a personal signature from the user's wallet. -## Availability - -- Works natively in World App -- Can execute outside World App through Wagmi or a custom fallback when configured - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -34,6 +30,14 @@ export async function signMessage() { } ``` +```ts title="Type" +type MiniKitSignMessageOptions = { + message: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -69,8 +73,7 @@ type SignMessageResponse = ## Fallback Behavior -- `executedWith: "wagmi"` means the web signer handled the request -- `executedWith: "fallback"` means your custom fallback handled the request +Define a custom fallback in the command payload for support outside mini apps. ## Notes diff --git a/mini-apps/commands/sign-typed-data.mdx b/mini-apps/commands/sign-typed-data.mdx index 75ba74c..599c1ea 100644 --- a/mini-apps/commands/sign-typed-data.mdx +++ b/mini-apps/commands/sign-typed-data.mdx @@ -7,14 +7,10 @@ description: "Sign EIP-712 typed data using the unified MiniKit API." Use `MiniKit.signTypedData()` to request an EIP-712 signature from the user's wallet. -## Availability - -- Works natively in World App -- Can execute outside World App through Wagmi or a custom fallback when configured - ## Basic Usage -```tsx + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -52,6 +48,18 @@ export async function signTypedData() { } ``` +```ts title="Type" +type MiniKitSignTypedDataOptions = { + types: TypedData; + primaryType: string; + message: Record; + domain?: TypedDataDomain; + chainId?: number; + fallback?: () => unknown; +}; +``` + + ## Result @@ -87,8 +95,7 @@ type SignTypedDataResponse = ## Fallback Behavior -- `executedWith: "wagmi"` means the web signer handled the request -- `executedWith: "fallback"` means your custom fallback handled the request +Define a custom fallback in the command payload for support outside mini apps. ## Error Codes diff --git a/mini-apps/commands/verify.mdx b/mini-apps/commands/verify.mdx index cb59a24..38e42f8 100644 --- a/mini-apps/commands/verify.mdx +++ b/mini-apps/commands/verify.mdx @@ -1,22 +1,10 @@ --- -title: "Verify (Legacy)" -description: "Legacy note for the removed MiniKit Verify command." +title: "World ID" +description: "World ID verification has moved to IDKit." "og:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" "twitter:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" --- - - Verify is not part of current MiniKit command docs. For new verification - flows, use [`@worldcoin/idkit`](/world-id/idkit/integrate). - +World ID has been unified into [IDKit](/world-id/idkit/integrate), so the same integration works in both mini apps and desktop. -MiniKit 1.x included a `verify` command. In current versions of MiniKit: - -- World ID verification lives in IDKit -- MiniKit focuses on mini app commands such as `walletAuth`, `pay`, and `sendTransaction` - -If you are migrating from MiniKit 1.x: - -1. replace `MiniKit.verify(...)` or `MiniKit.commandsAsync.verify(...)` with an IDKit request flow -2. verify the proof on your backend -3. keep this page only as historical context while migrating older implementations +If you are migrating from MiniKit 1.x, replace `MiniKit.verify(...)` or `MiniKit.commandsAsync.verify(...)` with IDKit. See the [IDKit integration guide](/world-id/idkit/integrate) for setup instructions. diff --git a/mini-apps/commands/wallet-auth.mdx b/mini-apps/commands/wallet-auth.mdx index 8e08b1b..f35bb74 100644 --- a/mini-apps/commands/wallet-auth.mdx +++ b/mini-apps/commands/wallet-auth.mdx @@ -9,23 +9,12 @@ Use `MiniKit.walletAuth()` to authenticate a user with Sign-In with Ethereum ins This is the recommended authentication flow for mini apps. - - These examples assume MiniKit has already been initialized through - `MiniKitProvider` or `MiniKit.install()`. - - -## Availability - -- Works natively in World App -- Can execute outside World App through Wagmi or a custom fallback when configured - ## Basic Usage Generate the nonce on your backend. The nonce must be alphanumeric and at least 8 characters. -```tsx -"use client"; - + +```tsx title="Example" import { MiniKit } from "@worldcoin/minikit-js"; import type { CommandResultByVia, @@ -65,6 +54,18 @@ export async function signInWithWallet() { } ``` +```ts title="Type" +type MiniKitWalletAuthOptions = { + nonce: string; + statement?: string; + expirationTime?: Date; + notBefore?: Date; + requestId?: string; + fallback?: () => unknown; +}; +``` + + ## Result @@ -96,13 +97,6 @@ type WalletAuthResponse = ``` -## Fallback Behavior - -- `executedWith: "wagmi"` means the Wagmi integration handled the request -- `executedWith: "fallback"` means your custom `fallback` function handled the request - -Use `executedWith` to branch on the runtime path when needed. - ## Backend Verification Always verify the returned SIWE payload on your backend. @@ -179,6 +173,10 @@ export async function POST(req: NextRequest) { | `user_rejected` | The user rejected the signature request | | `generic_error` | Unexpected failure | +## Fallback Behavior + +Define a custom fallback in the command payload for support outside mini apps. + ## Preview
diff --git a/mini-apps/more/releases.mdx b/mini-apps/more/releases.mdx deleted file mode 100644 index 701b6ca..0000000 --- a/mini-apps/more/releases.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Changelog" -description: "Weekly updates for Mini Apps, MiniKit, Dev Portal, and Docs." -mode: "center" -rss: true -"og:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" -"twitter:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" ---- - - - -### Mobile - -- [Android] Multi-file selection added -- [iOS] Improved microphone permissions -- [Both] Notification badges for the home screen -- [Both] Refactored Mini App impressions work -- [Both] Transaction failure messages improved - -### Dev Portal - -- Notification opt-in rate added to the dashboard -- Updated draft Mini App logic and notifications -- Sharing and deferred linking - -### MiniKit 1.9.5 - -- Added transaction parallelism -- Updated signed typed data -- Fixed versioning issues blocking wallet-auth - -### Docs - -- Updated Send Transaction implementation guide -- Updated Sign Typed Data implementation guide -- New integrations for Worldchain -- Added Oracles to Worldchain -- Sharing and deferred linking implementation guidelines - - - - - -### Mobile - -- [iOS] Enhanced keyboard interaction within the App Store search -- [iOS] Fixes for UI issues, including layering and scrolling behavior -- [Both] World App 4.0 update: comprehensive updates for Mini Apps -- [Both] Updated App Store -- [Both] Fixes on deeplinking both internal and from external apps -- [Both] Wallet Auth v2 improvements -- [Both] The Contacts tab has been moved into Mini App for streamlined navigation -- [Both] Updated settings menu and UI/UX enhancements -- [Both] Mini App state management enhancements -- [Both] New haptic feedback command implemented for Mini Apps -- [Both] Spotlight Search now supported for Mini Apps -- [Both] Widgets are now customizable with reordering support -- [Both] Add the category ranking of the app to the app store detail page -- [Both] Get Started page for new users - -### MiniKit - -- New Web3 template -- New template `npx @worldcoin/create-mini-app my-first-mini-app` -- Prod QA Mini App for testing commands - -### Dev Portal - -- Improved reporting link structure for easier tracking -- Added metatag images for sharing Mini Apps - -### Docs - -- Virality section -- Authentication section -- New templates (community and official) on docs -- Developer rewards pilot -- `llms-full.txt` added on getting started -- Get transaction debug URL - - - - - -### Mobile - -- [Both] Search has gotten much faster in the Mini Apps -- [Both] Mini Apps deeplinking fixes -- [Both] World Mini Apps widget -- [Android] Added `safeTxHash` and `userOpHash` in response from Send Transaction -- [Android] Added contacts to Get Permissions command -- [Android] Show settings in the pop-up menu on long press - -### MiniKit - -- Added NFC ID support to MiniKit. You can now receive a more detailed `verification_level` response - -### Dev Portal - -- Notification sending from developer portal -- Import wallets as CSV - -### Docs - -- New Quick Actions: PUF, World Companies Finder, One Pay, Orbital X -- Added Send Transaction and Wallet Auth GIFs -- NSFW prohibition - - - - - -### Mobile - -- [iOS] Notification paths bugs: Fixed -- [iOS] Contacts modal bugs: Fixed -- [iOS] Added safeTxHash and userOpHash in response from send transaction -- [iOS + Android] Include Mini App ID in Transaction Response Payload -- [iOS + Android] Added Haptic Feedback -- [Android] World Chat Bugs Fixed -- [iOS + Android] Mini App rearrange -- [iOS + Android] Spotlight Search Fixed -- [iOS + Android] Mini App Widget - -### MiniKit - -- Transaction improvements - - Support for booleans in Send Transaction - - Auto-formatting of content (no need to stringify manually) -- Haptics support -- Get Permissions: command to get notification permission status without requesting first - -### Docs - -- World Chat Quick Actions Added - - Pay - - Request Payment - - Draft Message -- Google & Apple Pay Implementation guides -- Haptic Feedback implementation guide - - diff --git a/mini-apps/quick-start/responses.mdx b/mini-apps/quick-start/responses.mdx index 4180e0b..d314aab 100644 --- a/mini-apps/quick-start/responses.mdx +++ b/mini-apps/quick-start/responses.mdx @@ -48,9 +48,5 @@ async function signInWithWallet() { ## Event Subscriptions -`MiniKit.subscribe()` and `MiniKit.unsubscribe()` still exist for lower-level integrations and legacy v1 flows. For new 2.x command integrations, prefer `await MiniKit.()`. +For new 2.x command integrations, prefer `await MiniKit.()`. - - If you are migrating from MiniKit 1.x, do not use `finalPayload`, - `commandPayload`, `MiniKit.commands`, or `MiniKit.commandsAsync` in new code. -