@iota/create-dapp 0.0.0-dev-20251015065834

package/src/index.ts

@@ -0,0 +1,131 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable no-restricted-globals */
+
+import { existsSync, statSync } from 'fs';
+import { mkdir, readdir, readFile, writeFile } from 'fs/promises';
+import { relative, resolve } from 'path';
+import { parseArgs } from 'util';
+import { prompt } from 'enquirer';
+
+const { values: args } = parseArgs({
+    options: {
+        template: {
+            type: 'string',
+            default: '',
+            short: 't',
+        },
+    },
+});
+
+async function main() {
+    const results = await prompt<{
+        template: string;
+        dAppName: string;
+    }>(
+        [
+            {
+                type: 'select',
+                name: 'template',
+                message: 'Which starter template would you like to use?',
+                choices: [
+                    {
+                        name: 'react-client-dapp',
+                        hint: 'React Client dApp that reads data from wallet and the blockchain',
+                    },
+                    {
+                        name: 'react-e2e-counter',
+                        hint: 'React dApp with a move smart contract that implements a distributed counter',
+                    },
+                ],
+            },
+            {
+                type: 'input',
+
+                name: 'dAppName',
+                message: 'What is the name of your dApp? (this will be used as the directory name)',
+                initial: 'my-first-iota-dapp',
+            },
+        ].filter((question) => !args[question.name as 'template']),
+    );
+
+    const outDir = resolve(process.cwd(), results.dAppName);
+
+    if (existsSync(outDir)) {
+        throw new Error(`Directory ${outDir} already exists`);
+    }
+
+    const files = await collectFiles(results.template ?? args.template, results.dAppName);
+    await writeFiles(files, outDir);
+}
+
+main();
+
+async function collectFiles(template: string, dAppName: string) {
+    const dependencies = await getDependencyVersions();
+    const templateDir = resolve(__dirname, '../templates', template);
+    const files = new Array<{
+        path: string;
+        content: Buffer;
+    }>();
+
+    if (!statSync(templateDir).isDirectory()) {
+        throw new Error(`Template ${templateDir} could not be found`);
+    }
+
+    await addDir(templateDir);
+
+    return files;
+
+    async function addDir(dir: string) {
+        const entries = await readdir(dir);
+
+        for (const entry of entries) {
+            if (entry === 'node_modules') {
+                continue;
+            }
+            const entryPath = resolve(dir, entry);
+            const stat = statSync(entryPath);
+
+            if (stat.isDirectory()) {
+                await addDir(entryPath);
+            } else {
+                let content = await readFile(entryPath);
+
+                if (entry === 'package.json') {
+                    const json = JSON.parse(content.toString());
+                    json.name = dAppName;
+                    json.dependencies['@iota/iota-sdk'] = dependencies['@iota/iota-sdk'];
+                    json.dependencies['@iota/dapp-kit'] = dependencies['@iota/dapp-kit'];
+
+                    content = Buffer.from(JSON.stringify(json, null, 2));
+                }
+
+                files.push({ path: relative(templateDir, entryPath), content });
+            }
+        }
+    }
+}
+
+async function writeFiles(files: Array<{ path: string; content: Buffer }>, outDir: string) {
+    for (const file of files) {
+        const filePath = resolve(outDir, file.path);
+        const dirPath = resolve(filePath, '..');
+        if (!existsSync(dirPath)) {
+            await mkdir(dirPath, { recursive: true });
+        }
+
+        await writeFile(filePath, file.content);
+    }
+}
+
+async function getDependencyVersions() {
+    const packagePath = resolve(__dirname, '../package.json');
+    const content = JSON.parse(await readFile(packagePath, 'utf-8')) as {
+        dependencies: Record<string, string>;
+    };
+
+    return content.dependencies;
+}

package/templates/react-client-dapp/README.md

@@ -0,0 +1,35 @@
+# IOTA dApp Starter Template
+
+This dApp was created using `@iota/create-dapp` that sets up a basic React
+Client dApp using the following tools:
+
+- [React](https://react.dev/) as the UI framework
+- [TypeScript](https://www.typescriptlang.org/) for type checking
+- [Vite](https://vitejs.dev/) for build tooling
+- [Radix UI](https://www.radix-ui.com/) for pre-built UI components
+- [ESLint](https://eslint.org/)
+- [`@iota/dapp-kit`](https://docs.iota.org/developer/ts-sdk/dapp-kit) for
+  connecting to wallets and loading data
+- [pnpm](https://pnpm.io/) for package management
+
+## Starting your dApp
+
+To install dependencies you can run
+
+```bash
+pnpm install
+```
+
+To start your dApp in development mode run
+
+```bash
+pnpm dev
+```
+
+## Building
+
+To build your app for deployment you can run
+
+```bash
+pnpm build
+```

package/templates/react-client-dapp/eslint.config.js

@@ -0,0 +1,28 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+
+export default tseslint.config(
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    plugins: {
+      react,
+      reactHooks,
+      reactRefresh,
+    },
+    settings: {
+      version: "18",
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+);

package/templates/react-client-dapp/index.html

@@ -0,0 +1,59 @@
+<!doctype html>
+<html lang="en" class="dark-theme" style="color-scheme: dark">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>IOTA dApp Starter</title>
+
+    <style>
+      /*
+  Josh's Custom CSS Reset
+  https://www.joshwcomeau.com/css/custom-css-reset/
+*/
+      *,
+      *::before,
+      *::after {
+        box-sizing: border-box;
+      }
+      * {
+        margin: 0;
+      }
+      body {
+        line-height: 1.5;
+        -webkit-font-smoothing: antialiased;
+      }
+      img,
+      picture,
+      video,
+      canvas,
+      svg {
+        display: block;
+        max-width: 100%;
+      }
+      input,
+      button,
+      textarea,
+      select {
+        font: inherit;
+      }
+      p,
+      h1,
+      h2,
+      h3,
+      h4,
+      h5,
+      h6 {
+        overflow-wrap: break-word;
+      }
+      #root,
+      #__next {
+        isolation: isolate;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/templates/react-client-dapp/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@iota/template-react-client-app",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview",
+    "format": "prettier -w ."
+  },
+  "dependencies": {
+    "@iota/dapp-kit": "workspace:*",
+    "@iota/iota-sdk": "workspace:*",
+    "@radix-ui/themes": "^3.1.1",
+    "@tanstack/react-query": "^5.50.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "@vitejs/plugin-react-swc": "^3.7.0",
+    "eslint": "^9.17.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.7",
+    "eslint-plugin-react": "^7.37.2",
+    "typescript-eslint": "^8.18.0",
+    "prettier": "^3.3.2",
+    "typescript": "^5.5.3",
+    "vite": "^5.4.12"
+  }
+}

package/templates/react-client-dapp/prettier.config.cjs

@@ -0,0 +1,4 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+  proseWrap: "always",
+};

package/templates/react-client-dapp/src/App.tsx

@@ -0,0 +1,39 @@
+import { ConnectButton } from "@iota/dapp-kit";
+import { Box, Container, Flex, Heading } from "@radix-ui/themes";
+import { WalletStatus } from "./WalletStatus";
+
+function App() {
+  return (
+    <>
+      <Flex
+        position="sticky"
+        px="4"
+        py="2"
+        justify="between"
+        style={{
+          borderBottom: "1px solid var(--gray-a2)",
+        }}
+      >
+        <Box>
+          <Heading>dApp Starter Template</Heading>
+        </Box>
+
+        <Box>
+          <ConnectButton />
+        </Box>
+      </Flex>
+      <Container>
+        <Container
+          mt="5"
+          pt="2"
+          px="4"
+          style={{ background: "var(--gray-a2)", minHeight: 500 }}
+        >
+          <WalletStatus />
+        </Container>
+      </Container>
+    </>
+  );
+}
+
+export default App;

package/templates/react-client-dapp/src/OwnedObjects.tsx

@@ -0,0 +1,42 @@
+import { useCurrentAccount, useIotaClientQuery } from "@iota/dapp-kit";
+import { Flex, Heading, Text } from "@radix-ui/themes";
+
+export function OwnedObjects() {
+  const account = useCurrentAccount();
+  const { data, isPending, error } = useIotaClientQuery(
+    "getOwnedObjects",
+    {
+      owner: account?.address as string,
+    },
+    {
+      enabled: !!account,
+    },
+  );
+
+  if (!account) {
+    return;
+  }
+
+  if (error) {
+    return <Flex>Error: {error.message}</Flex>;
+  }
+
+  if (isPending || !data) {
+    return <Flex>Loading...</Flex>;
+  }
+
+  return (
+    <Flex direction="column" my="2">
+      {data.data.length === 0 ? (
+        <Text>No objects owned by the connected wallet</Text>
+      ) : (
+        <Heading size="4">Objects owned by the connected wallet</Heading>
+      )}
+      {data.data.map((object) => (
+        <Flex key={object.data?.objectId}>
+          <Text>Object ID: {object.data?.objectId}</Text>
+        </Flex>
+      ))}
+    </Flex>
+  );
+}

package/templates/react-client-dapp/src/WalletStatus.tsx

@@ -0,0 +1,23 @@
+import { useCurrentAccount } from "@iota/dapp-kit";
+import { Container, Flex, Heading, Text } from "@radix-ui/themes";
+import { OwnedObjects } from "./OwnedObjects";
+
+export function WalletStatus() {
+  const account = useCurrentAccount();
+
+  return (
+    <Container my="2">
+      <Heading mb="2">Wallet Status</Heading>
+
+      {account ? (
+        <Flex direction="column">
+          <Text>Wallet connected</Text>
+          <Text>Address: {account.address}</Text>
+        </Flex>
+      ) : (
+        <Text>Wallet not connected</Text>
+      )}
+      <OwnedObjects />
+    </Container>
+  );
+}

package/templates/react-client-dapp/src/main.tsx

@@ -0,0 +1,26 @@
+import React from "react";
+import ReactDOM from "react-dom/client";
+import "@iota/dapp-kit/dist/index.css";
+import "@radix-ui/themes/styles.css";
+
+import { IotaClientProvider, WalletProvider } from "@iota/dapp-kit";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { Theme } from "@radix-ui/themes";
+import App from "./App.tsx";
+import { networkConfig } from "./networkConfig.ts";
+
+const queryClient = new QueryClient();
+
+ReactDOM.createRoot(document.getElementById("root")!).render(
+  <React.StrictMode>
+    <Theme appearance="dark">
+      <QueryClientProvider client={queryClient}>
+        <IotaClientProvider networks={networkConfig} defaultNetwork="testnet">
+          <WalletProvider autoConnect>
+            <App />
+          </WalletProvider>
+        </IotaClientProvider>
+      </QueryClientProvider>
+    </Theme>
+  </React.StrictMode>,
+);

package/templates/react-client-dapp/src/networkConfig.ts

@@ -0,0 +1,17 @@
+import { getFullnodeUrl } from "@iota/iota-sdk/client";
+import { createNetworkConfig } from "@iota/dapp-kit";
+
+const { networkConfig, useNetworkVariable, useNetworkVariables } =
+  createNetworkConfig({
+    devnet: {
+      url: getFullnodeUrl("devnet"),
+    },
+    testnet: {
+      url: getFullnodeUrl("testnet"),
+    },
+    mainnet: {
+      url: getFullnodeUrl("mainnet"),
+    },
+  });
+
+export { useNetworkVariable, useNetworkVariables, networkConfig };

package/templates/react-client-dapp/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/templates/react-client-dapp/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

package/templates/react-client-dapp/tsconfig.node.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}

package/templates/react-client-dapp/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react-swc";
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});

package/templates/react-e2e-counter/README.md

@@ -0,0 +1,100 @@
+# IOTA dApp Starter Template
+
+This dApp was created using `@iota/create-dapp` that sets up a basic React
+Client dApp using the following tools:
+
+- [React](https://react.dev/) as the UI framework
+- [TypeScript](https://www.typescriptlang.org/) for type checking
+- [Vite](https://vitejs.dev/) for build tooling
+- [Radix UI](https://www.radix-ui.com/) for pre-built UI components
+- [ESLint](https://eslint.org/) for linting
+- [`@iota/dapp-kit`](https://docs.iota.org/developer/ts-sdk/dapp-kit) for
+  connecting to wallets and loading data
+- [pnpm](https://pnpm.io/) for package management
+
+## Deploying your Move code
+
+### Install IOTA cli
+
+Before deploying your move code, ensure that you have installed the IOTA CLI.
+You can follow the
+[IOTA installation instruction](https://docs.iota.org/developer/getting-started/install-iota) to get
+everything set up.
+
+This template uses `testnet` by default, so we'll need to set up a testnet
+environment in the CLI:
+
+```bash
+iota client new-env --alias testnet --rpc https://fullnode.testnet.iota.org:443
+iota client switch --env testnet
+```
+
+If you haven't set up an address in the iota client yet, you can use the
+following command to get a new address:
+
+```bash
+iota client new-address --key-scheme secp256k1
+```
+
+This well generate a new address and recover phrase for you. You can mark a
+newly created address as you active address by running the following command
+with your new address:
+
+```bash
+iota client switch --address 0xYOUR_ADDRESS...
+```
+
+We can ensure we have some IOTA in our new wallet by requesting IOTA from the
+faucet (make sure to replace the address with your address):
+
+```bash
+curl --location --request POST 'https://faucet.testnet.iota.org/gas' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "FixedAmountRequest": {
+        "recipient": "<YOUR_ADDRESS>"
+    }
+}'
+```
+
+### Publishing the move package
+
+The move code for this template is located in the `move` directory. To publish
+it, you can enter the `move` directory, and publish it with the IOTA CLI:
+
+```bash
+cd move
+iota client publish --gas-budget 100000000 counter
+```
+
+In the output there will be an object with a `"packageId"` property. You'll want
+to save that package ID to the `src/constants.ts` file as `PACKAGE_ID`:
+
+```ts
+export const TESTNET_COUNTER_PACKAGE_ID = "<YOUR_PACKAGE_ID>";
+```
+
+Now that we have published the move code, and update the package ID, we can
+start the app.
+
+## Starting your dApp
+
+To install dependencies you can run
+
+```bash
+pnpm install
+```
+
+To start your dApp in development mode run
+
+```bash
+pnpm dev
+```
+
+## Building
+
+To build your app for deployment you can run
+
+```bash
+pnpm build
+```

package/templates/react-e2e-counter/eslint.config.js

@@ -0,0 +1,28 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+
+export default tseslint.config(
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    plugins: {
+      react,
+      reactHooks,
+      reactRefresh,
+    },
+    settings: {
+      version: "18",
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+);

package/templates/react-e2e-counter/index.html

@@ -0,0 +1,59 @@
+<!doctype html>
+<html lang="en" class="dark-theme" style="color-scheme: dark">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>IOTA dApp Starter</title>
+
+    <style>
+      /*
+  Josh's Custom CSS Reset
+  https://www.joshwcomeau.com/css/custom-css-reset/
+*/
+      *,
+      *::before,
+      *::after {
+        box-sizing: border-box;
+      }
+      * {
+        margin: 0;
+      }
+      body {
+        line-height: 1.5;
+        -webkit-font-smoothing: antialiased;
+      }
+      img,
+      picture,
+      video,
+      canvas,
+      svg {
+        display: block;
+        max-width: 100%;
+      }
+      input,
+      button,
+      textarea,
+      select {
+        font: inherit;
+      }
+      p,
+      h1,
+      h2,
+      h3,
+      h4,
+      h5,
+      h6 {
+        overflow-wrap: break-word;
+      }
+      #root,
+      #__next {
+        isolation: isolate;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>