Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,36 @@
"libsodium",
"Salsa",
"Poly",
"Bedrock"
"Bedrock",
"Completionist",
"diarias",
"Disponibles",
"están",
"idkit",
"IERC",
"inlines",
"Lazo",
"listas",
"localised",
"Mateo",
"mistico",
"Optimising",
"prêtes",
"quotidiennes",
"Recompensas",
"Récompenses",
"Salut",
"Sauton",
"siwe",
"sont",
"spammy",
"tute",
"userop",
"viem",
"virality",
"wagmi",
"XVCJ",
"zrok"
],
"ignorePaths": [
"node_modules",
Expand All @@ -38,7 +67,11 @@
"build",
".vscode"
],
"ignoreRegExpList": ["/\\b[A-Z]{2,}\\b/g", "/\\b[a-f0-9]{6,}\\b/gi"],
"ignoreRegExpList": [
"/%2F\\w+/gi",
"/\\b[A-Z]{2,}\\b/g",
"/\\b[a-f0-9]{6,}\\b/gi"
],
"allowCompoundWords": true,
"dictionaries": [
"en_US",
Expand Down
99 changes: 98 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"anchors": [
{
"anchor": "Mini Apps",
"href": "https://docs.world.org/mini-apps",
"href": "/mini-apps",
"icon": "/images/mini-apps-card.svg",
"color": {
"light": "#fff",
Expand Down Expand Up @@ -63,6 +63,103 @@
}
]
},
{
"tab": "Mini Apps",
"groups": [
{
"group": "Introduction",
"pages": ["mini-apps/index"]
},
{
"group": "Integrate",
"pages": [
"mini-apps/quick-start/installing",
"mini-apps/quick-start/init",
"mini-apps/quick-start/commands",
"mini-apps/quick-start/responses",
"mini-apps/quick-start/testing",
"mini-apps/quick-start/app-store",
{
"group": "Guidelines",
"pages": [
"mini-apps/guidelines/app-guidelines",
"mini-apps/guidelines/design-guidelines",
"mini-apps/guidelines/policy",
"mini-apps/guidelines/features-and-guidelines"
]
}
]
},
{
"group": "Commands",
"pages": [
"mini-apps/commands/verify",
"mini-apps/commands/pay",
"mini-apps/commands/wallet-auth",
"mini-apps/commands/send-transaction",
"mini-apps/commands/chat",
"mini-apps/commands/sign-message",
"mini-apps/commands/sign-typed-data",
"mini-apps/commands/share-contacts",
"mini-apps/commands/request-permission",
"mini-apps/commands/get-permissions",
"mini-apps/commands/how-to-send-notifications",
"mini-apps/commands/send-haptic-feedback",
"mini-apps/commands/share",
"mini-apps/commands/attestation",
"mini-apps/commands/close-miniapp"
]
},
{
"group": "Technical Reference",
"pages": [
"mini-apps/reference/address-book",
"mini-apps/reference/usernames",
"mini-apps/reference/status-page",
"mini-apps/reference/payment-methods",
"mini-apps/reference/microphone",
{
"group": "Quick Actions",
"pages": [
"mini-apps/sharing/quick-actions",
"mini-apps/sharing/add-money-qa",
"mini-apps/sharing/swap-qa",
"mini-apps/sharing/earn-wld-qa",
"mini-apps/sharing/dna-qa",
"mini-apps/sharing/sage-qa"
]
}
]
},
{
"group": "Migration",
"pages": [
"mini-apps/migration/web-to-miniapp",
"mini-apps/migration/standalone-dapp",
"mini-apps/migration/minikit-v2"
]
},
{
"group": "Further Reading",
"pages": [
"mini-apps/more/webview-spec",
"mini-apps/ecosystem/ecosystem",
"mini-apps/more/community-tools-perks",
"mini-apps/more/faq",
{
"group": "Growth Playbook",
"pages": [
"mini-apps/growth/index",
"mini-apps/growth/invites-viral",
"mini-apps/growth/gamification",
"mini-apps/growth/notifications",
"mini-apps/growth/analytics"
]
}
]
}
]
},
{
"tab": "Orb",
"pages": ["orb/index"]
Expand Down
Binary file added images/docs/docs-meta.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps-meta.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/commands/apple-pay.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/chat.mp4
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/commands/pay-updated.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/commands/profilecard.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/share.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/transaction.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/verify.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/walletauth.mp4
Binary file not shown.
Binary file added images/docs/mini-apps/commands/whitelist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added images/docs/mini-apps/guidelines/base-unit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/guidelines/drawers-ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/guidelines/keyboard-ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/guidelines/paddings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/guidelines/states.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/docs/mini-apps/guidelines/toast-ios.png
Binary file added images/docs/mini-apps/mini-apps.png
Binary file added images/docs/mini-apps/more/Thirdweb-Logo.png
Binary file added images/docs/mini-apps/more/alchemy.png
Binary file added images/docs/mini-apps/more/cloudflare.png
Binary file added images/docs/mini-apps/more/featured.jpg
Binary file added images/docs/mini-apps/more/lazo.png
Binary file added images/docs/mini-apps/quick-actions/onepay-qa.png
Binary file added images/docs/mini-apps/quick-actions/puf-qa.png
Binary file added images/docs/mini-apps/quick-actions/sage1-qa.png
Binary file added images/docs/mini-apps/quick-actions/sage2-qa.png
Binary file added images/docs/mini-apps/quick-actions/swap-qa.png
Binary file added images/docs/mini-apps/quick-actions/uno-qa.png
Binary file added images/docs/mini-apps/quick-actions/vuni-qa.png
Binary file added images/docs/mini-apps/quick-actions/wcf-qa.png
Binary file added images/docs/mini-apps/quick-start/submit-app.png
Binary file added images/docs/mini-apps/quick-start/template.png
Binary file added images/docs/mini-apps/quick-start/test-mode.jpg
Binary file added images/docs/mini-apps/virality/widget.jpg
2 changes: 1 addition & 1 deletion index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Tools for Humanity is a technology company building for humans in the age of AI.
<div className="text-md text-gray-500">World App provides simple access to the World Network. World Wallet, World Chat, World ID.</div>
</div>
</Card>
<Card href="https://docs.world.org/mini-apps">
<Card href="/mini-apps">
<div className="-mt-8">
<img src="/images/mini-apps-card.svg" width="48" className="mb-4" />
<div className="text-xl font-semibold mb-2">Mini Apps</div>
Expand Down
87 changes: 87 additions & 0 deletions mini-apps/commands/attestation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: "Attestation"
description: "Request an attestation token using the unified MiniKit API."
"og:image": "https://raw.githubusercontent.com/toolsforhumanity/docs/main/images/docs/docs-meta.png"
"twitter:image": "https://raw.githubusercontent.com/toolsforhumanity/docs/main/images/docs/docs-meta.png"
---

Use `MiniKit.attestation()` to request an app attestation token for a request hash.

## Basic Usage

<CodeGroup>
```tsx title="Example"
import { MiniKit } from "@worldcoin/minikit-js";
import type {
CommandResultByVia,
MiniAppAttestationSuccessPayload,
MiniKitAttestationOptions,
} from "@worldcoin/minikit-js/commands";

export async function requestAttestation() {
const input = {
requestHash: "0x1234",
} satisfies MiniKitAttestationOptions;

const result: CommandResultByVia<
MiniAppAttestationSuccessPayload,
MiniAppAttestationSuccessPayload,
"minikit"
> = await MiniKit.attestation(input);

console.log(result.data.token);
}
```

```ts title="Type"
type MiniKitAttestationOptions = {
requestHash: string;
fallback?: () => unknown;
};
```
</CodeGroup>

## Result

<CodeGroup>
```ts title="Type"
type AttestationResponse =
| {
executedWith: "minikit";
data: {
status: "success";
version: number;
token: string;
};
}
| {
executedWith: "fallback";
data: unknown;
};
```

```json title="Example"
{
"executedWith": "minikit",
"data": {
"status": "success",
"version": 1,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.mock.payload"
}
}
```
</CodeGroup>

## Fallback Behavior

Define a custom fallback in the command payload for support outside mini apps.

## Error Codes

| Code | Meaning |
| --- | --- |
| `unauthorized` | The request is not authorized |
| `attestation_failed` | Attestation generation failed |
| `integrity_failed` | Integrity checks failed |
| `invalid_input` | The request hash is invalid |
| `unsupported_version` | The command version is not supported |
101 changes: 101 additions & 0 deletions mini-apps/commands/chat.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "World Chat"
description: "Share a message through World Chat using the unified MiniKit API."
"og:image": "https://raw.githubusercontent.com/toolsforhumanity/docs/main/images/docs/docs-meta.png"
"twitter:image": "https://raw.githubusercontent.com/toolsforhumanity/docs/main/images/docs/docs-meta.png"
---

Use `MiniKit.chat()` to open World Chat with a prefilled message.

## Basic Usage

<CodeGroup>
```tsx title="Example"
import { MiniKit } from "@worldcoin/minikit-js";
import type {
CommandResultByVia,
MiniAppChatSuccessPayload,
MiniKitChatOptions,
} from "@worldcoin/minikit-js/commands";

export async function shareToChat() {
const input = {
message: "Check out this mini app",
to: ["andy"],
} satisfies MiniKitChatOptions;

const result: CommandResultByVia<
MiniAppChatSuccessPayload,
MiniAppChatSuccessPayload,
"minikit"
> = await MiniKit.chat(input);

console.log(result.data.count);
}
```

```ts title="Type"
type MiniKitChatOptions = {
message: string;
to?: string[];
fallback?: () => unknown;
};
```
</CodeGroup>

## Result

<CodeGroup>
```ts title="Type"
type ChatResponse =
| {
executedWith: "minikit";
data: {
status: "success";
version: number;
count: number;
timestamp: string;
};
}
| {
executedWith: "fallback";
data: unknown;
};
```

```json title="Example"
{
"executedWith": "minikit",
"data": {
"status": "success",
"version": 1,
"count": 2,
"timestamp": "2026-03-28T18:24:00.000Z"
}
}
```
</CodeGroup>

## Fallback Behavior

Define a custom fallback in the command payload for support outside mini apps.

## Error Codes

| Code | Meaning |
| --- | --- |
| `user_rejected` | The user rejected the request |
| `send_failed` | Sending the message failed |
| `generic_error` | Unexpected failure |

## Preview

<div className="grid justify-items-center text-center">
<video className="m-auto" width="300" autoPlay muted loop playsInline>
<source
src="/images/docs/mini-apps/commands/chat.mp4"
type="video/mp4"
/>
Your browser does not support the video tag.
</video>
</div>
Loading
Loading