// 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

React

React Native

Flutter

API Reference

Live Support

Start Free

Explore Dynamic

Find an environment by ID

Location in the browser where Dynamic will attempt to store the JWT token.

Chain specific configuration for dynamic embedded wallets

Optional validation rules for the custom field

The text that will be displayed for the checkbox field

The regex pattern that the text field must match

If this field must be unique for every user in the environment

The dropdown options for the select field

Secret key used to validate captcha response. This will never be surfaced in a GET response.

Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.

A light client, compared to a full node, tracks only pieces of certain information on a blockchain. Light clients do not track the entire state of a blockchain and also do not contain every transaction/block of a chain.

External integrations like e-mail, social credentials, mpc providers, etc.

If set to false, will create smart wallets for new users only.

If set to false, will create smart wallets for embedded wallets only.

Embedded wallet authenticator security methods required upon creation of the embedded wallet at onboarding

When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.

When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.

When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.

When true users will be able to start recovery for their accounts.

When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction

When true, the user will be prompted to export their private key after creating a wallet.

When true users will see embedded wallets action confirmation views.

passkeyEmbeddedWalletEnabled is deprecated as of v0.19. Please enable embedded wallets using the provider API.

Configs used to create the views in the sdk.

Key ID required for Apple Oauth2 applications. This is the identifier for a private key.

Team ID required for Apple Oauth2 applications. This is associated with the Apple developer membership account.

If the provider supports Oauth 2, this field will contain the URL of the login and authorization where a user can authorize the applciation to gain access to their provider account

Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

Standard OAuth client secret key. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

DEPRECATED: Use defaultChain. The default chain id the SDK should use

The url of the site to go to export wallets private keys

Some providers require additional information, typically called a project ID or site ID

If the provider supports Oauth 2, this field will contain the URL of redirect or callback URL which will need to be provided to the Oauth provider to properly configure your App tp talk with Dynamic

Required to initialize Twilio provider. Phone number used to send SMS messages.

Reference to the user that accepted the terms and conditions, if one is necessary for this provider.

The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.

Configs used to create the view in the sdk.

The sections which will be used create the view in the sdk. The sections will be displayed in the order that they appear in the array.

A section used create the view in the sdk.

The option to be displayed as the main one. The default item will be displayed in a more prominent way than the rest of the items in the section. For Wallet section, represents the wallet item to be displayed by default. For Social section, represents the social provider to be displayed by default.

The label for the section. This will be displayed above the section or as part of the separator component if it is a Separator section.

The deafult number of items to display in the section. For Wallet section, represents the number of wallet items to be displayed by default. User has to click a button to view more options if there are any. For Social section, represents the number of social providers to be displayed by default. User has to click a button to view more options if there are any.

CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)

bearerAuth

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

Go Live Checklist

Developer Best Practices

Adding the SDK

DynamicContextProvider props

Wagmi & Dynamic

Using Ethers instead of Viem

Enabling Chains

Embedded Wallet Chains

Account Abstraction Chains

Using RPC Providers

Custom EVM networks (EvmNetwork)

Switching Networks

Sign Up with Email/Social/SMS

Sign Up with Branded Wallets

JWTs/Authentication Tokens

Cookie Based Authentication

Adding Captcha Protection

Server-side verification

Third-party Authentication

Multi Asset UI

Accessing Users

Verified Credentials

Email and Phone Verification

Social Linking

UI Customization Overview

Customizing Signup/Login UI

Adapt Copy With Translations

Adapt UI With Views

Customizing Transaction UI

Headless Overview

Headless Email Signup

Headless SMS signup

Headless Social Login

Headless Embedded Wallets With OTP

Headless embedded wallets using Passkeys

Headless Embedded Wallet Export

Headless Wallet Management

Headless User Profile

Banxa

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

Dynamic Bridge Widget

bridgeChains

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

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

Privacy Settings

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

Invite Members

Projects vs Organizations

General

Webhook Event types

Social Providers Overview

Farcaster Overview

Sign in with Farcaster

Enable Write Access to Farcaster

Generate an multi-chain embedded wallet from a Farcaster frame

Phantom Redirect

Multi-Factor Authentcation (MFA)

NextAuth & Dynamic

Create-web3-dapp & Dynamic

Dynamic in PWA

Deploy a Safe account with Dynamic

Telegram Mini App

Co:Create & Dynamic Integration

Shield3 & Dynamic Integration

XMTP & Dynamic Integration

Verifying webhook message signatures

Add new users to your CRM

Webhooks using a serverless function

Post in a slack channel when you have a new signup

Slack notifications of new signups

Send new users an XMTP message

Migrating to Dynamic

Migrating Users via CSV

Migration from RainbowKit

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

Introduction to the SDK

SDK/User Loading States

Providers and Connectors Introduction

DynamicContextProvider

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

Rest API

Find an environment by ID

Authorizations

Path Parameters

Response