// Importing required modules
const yaml = require("js-yaml");
const fs = require("fs");
const path = require("path");
const axios = require("axios");

// Function to create all OpenAPI files
const createAllOpenApiFiles = async () => {
  console.log("Creating new openapi files...");
  const folderName = "api-reference";

  // Function to read OpenAPI documentation from URL
  const readDoc = async () => {
    try {
      const response = await axios.get(
        "https://app.dynamic.xyz/api-docs/api.yaml"
      );

      fs.writeFileSync(
        path.join(__dirname, "../../openapi.yaml"),
        response.data
      );

      const doc = yaml.load(fs.readFileSync("openapi.yaml", "utf8"));
      return doc;
    } catch (e) {
      console.log(e);
      return null;
    }
  };

  // Function to delete output folder
  const deleteOutputFolder = () => {
    if (fs.existsSync(path.join(__dirname, `/${folderName}`))) {
      fs.rmSync(path.join(__dirname, `/${folderName}`), { recursive: true });
    }
  };

  // Read OpenAPI documentation
  const doc = await readDoc();

  // Delete output folder
  deleteOutputFolder();

  // // Loop through each path in the OpenAPI documentation
  for (const [key, value] of Object.entries(doc.paths)) {
    const url = key;
    const availableMethods = value;
    const innerFolderName = url.split("/")[1].toLowerCase();

    // Create output folder if it doesn't exist
    if (!fs.existsSync(path.join(__dirname, `/${folderName}`))) {
      fs.mkdirSync(path.join(__dirname, `/${folderName}`));
    }

    // Loop through each available method for the path
    for (const [key, value] of Object.entries(availableMethods)) {
      const method = key.toUpperCase();

      // Don't create file for OPTIONS method calls
      if (method !== "OPTIONS") {
        const description = value.summary;
        const id = value.operationId;
        const tags = value.tags;
        const tag = tags[0].toLowerCase();

        // Create inner folder for tag if it doesn't exist
        if (!fs.existsSync(path.join(__dirname, `/${folderName}/${tag}`))) {
          fs.mkdirSync(path.join(__dirname, `/${folderName}/${tag}`));
        }

        // Format string for output file
        const formattedString =
          "---\ntitle: " +
          description +
          "\nopenapi: " +
          method +
          " " +
          url +
          "\n---";

        // Write output file
        fs.writeFileSync(
          path.join(__dirname, `/${folderName}/${tag}/${id}.mdx`),
          formattedString,
          { flag: "wx" }
        );
      }
    }
  }
};

// Function to move overview file into OpenAPI folder
const moveOverviewIntoOpenApiFolder = () => {
  console.log("copying overview file into OpenAPI folder...");
  const folderName = "api-reference";
  const overviewFileName = "overview.mdx";

  // Copy overview file into OpenAPI folder
  if (fs.existsSync(path.join(__dirname, `./${folderName}`))) {
    fs.copyFileSync(
      path.join(__dirname, `../${overviewFileName}`),
      path.join(__dirname, `./${folderName}/${overviewFileName}`)
    );
  }

  return;
};

const createNewOpenApiFiles = async () => {
  // Call functions to create all OpenAPI files and move overview file into OpenAPI folder
  await createAllOpenApiFiles();
  await moveOverviewIntoOpenApiFolder();

  console.log("New openapi files created!");
  return;
};

module.exports = createNewOpenApiFiles;


Announcements

System Status

Changelog

Dynamic

SDK Reference

API Reference

Live Support

Start Free

Explore Dynamic

WalletConnect V2: Fixes & V1 Bridge

Welcome to Dynamic! We're so excited that you're here!

Welcome

Let's get you up and running with a React based signup/login UI! Just [sign up](https://app.dynamic.xyz) and follow the guide below!

Quickstart

Example apps

Chains & Networks

Go Live Checklist

Overview

Sign Up with Email/Social

Sign up with Branded Wallets

Server-side verification

Adding Captcha Protection

Dynamic Embedded Wallets

Pre-generated Wallets

Passkeys

One-time codes

Account Abstraction

ZeroDev Smart Accounts

Alchemy Smart Accounts

Pimlico Smart Accounts

Biconomy Smart Accounts

Account Recovery

Wallet Export

HD Wallets

Magic

Crossmint

Blocto

Connected vs Authenticated

Connect

Authenticate

Recommend Wallets

Chainalysis

Sort and Filter Wallets

Multi-Wallet

Bridge Widget

Advanced Wallet Options

Design Tutorial

Custom Widget Content

Themes & Settings

CSS Variables

Custom CSS

Programmable Views

One of the first things you'll want to do as you create a new project is update some of the basic metadata associated with the SDK such as your app name, logo url, and support url.

General Settings

TOS & Privacy Policy

Custom Sign Message

Customizing copy in the SDK

Access Lists

NFT/Token Gating

Information Capture

Email Verification

Social Account Linking

Custom Networks

RPC Urls

Banxa

This page hosts the keys that you'll need to setup the SDK, validate the JWT, and generate tokens for API usage.

SDK and API Keys

Every project you create in Dynamic comes with a Sandbox and a Live environment. Both these environments behave similarly but we've customized the Sandbox environment to make it ideal for testing and exploring features.

Sandbox vs Live

Analytics

Users

Visitors

We take security seriously at Dynamic and most of the work we do is behind the scenes so you don't have to worry about it. We will surface some security features that can be configured. 

Security Settings

Privacy Settings

You can invite members of your company to your Dynamic organization by Navigating to the Admin screen and clicking on the Members tab. 

Invite Members

Projects

If you would like to create a new organization, you can do so.

Organizations

General

Webhook Event types

Social Providers Overview

Apple

Discord

Facebook

Farcaster

Github

Google

Twitch

Twitter/X

Headless Email Signup

Generate an multi-chain embedded wallet from a Farcaster frame

Create-web3-dapp & Dynamic

Wagmi & Dynamic

Wagmi v2 & Dynamic

NextAuth & Dynamic

XMTP & Dynamic Integration

Co:Create & Dynamic Integration

Shield3 & Dynamic Integration

Webhooks using a serverless function

Post in a slack channel when you have a new signup

Slack notifications of new signups

Add new users to your CRM

Send new users an XMTP message

Migrating to Dynamic

Migration from RainbowKit

Migrating Users

The SDK allows you to build authentication and authorization into your application in a few lines of code.

Introduction to the SDK

React Native

Upgrade guides

Viem Or Ethers

Tutorial

Wallet Connectors

Components Introduction

The `DynamicBridgeWidget` component allows you to handle multi chain bridging

DynamicBridgeWidget

DynamicConnectButton

DynamicContextProvider

DynamicEmbeddedWidget

DynamicMultiWalletPromptsWidget

The `DynamicWagmiConnector` component integrates your Dynamic project settings with Wagmi

DynamicWagmiConnector

DynamicWidget

DynamicUserProfile

DynamicNav

Hooks Introduction

useAuthenticateConnectedUser

Allow for headless email OTP authentication

useConnectWithEmailOtp

Dynamic's React Context which is set via DynamicContextProvider

useDynamicContext

useDynamicModals

useDynamicScopes

useEmailVerificationRequest

useEmbeddedReveal

useEmbeddedWallet

useFunding

useIsLoggedIn

usePasskeyRecovery

useSendBalance

useSocialAccounts

useUserUpdateRequest

Get access to the current user/session wallets

useUserWallets

useWalletConnectorEvent

useWalletItemActions

Utilities Introduction

This utility can be used to get a JWT token generated by Dynamic which is stored inside of localStorage.

getAuthToken

getNetwork

isZeroDevConnector

Callbacks Introduction

onAuthFlowCancel

onAuthFlowClose

onAuthFlowOpen

onAuthSuccess

onBeforeConnectSuccessConfirmation

onConnect

onEmailVerificationFailure

onEmailVerificationSuccess

onEmbeddedWalletCreated

onLinkSuccess

onLogout

onSignedMessage

onUnlinkSuccess

onUserProfileUpdate

Object References Introduction

AccessDeniedCustomButton

This is Dynamic's Bitcoin connector over the basic wallet interface. This can be used to interact with the users Bitcoin wallets.

BitcoinWalletConnector

EvmNetwork

JWT Payload

An object containing attributes about the user such as the wallet address, email, first name, etc.

UserProfile

JwtVerifiedCredential

SdkViews

An object containing the attributes about the connected wallet. This object would be available immediately after a wallet has been connected.

Wallet

WalletOption

This is Dynamic's WalletConnect connector over the basic wallet interface. This can be used to interact with the users WalletConnect wallets. It has all methods available in the [WalletConnector](https://docs.dynamic.xyz/react-sdk/references/walletconnector) and some additional method specific to WalletConnect wallets.

WalletConnectConnector

This is Dynamic's abstraction over the wallet interface. This can be used to interact with the users wallet.

WalletConnector

WalletsByChain

Get balance

In this example, we will get the balance for each connect wallet.

Get balance for all wallets

In this example, we are creating a button to sign a message and log the signature to the console.

Sign a message

Send a transaction

Programmatically switch network

Here is an example where you can use the user profile to display in a HTML table.

Get the user's profile

Here are some examples on how to use the Solana typed signer

Typed Solana signer

Developer Changelog