Updating README

0xsequence · Oct 1, 2024 · 3613bac · 3613bac
1 parent ace5afd
commit 3613bac
Show file tree

Hide file tree

Showing 7 changed files with 121 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -33,18 +33,57 @@ yarn add @0xsequence/kit wagmi ethers@6.13.0 viem 0xsequence @tanstack/react-que
 
 #### The 'easy' way
 
+- `createConfig(walletType, options)` method is used to create your initial config and prepare sensible defaults that can be overridden
+
+`walletType` is either 'waas' or 'universal'
+
+```ts
+interface CreateConfigOptions {
+  appName: string
+  projectAccessKey: string
+  chainIds?: number[]
+  defaultChainId?: number
+  disableAnalytics?: boolean
+  defaultTheme?: Theme
+  position?: ModalPosition
+  signIn?: {
+    logoUrl?: string
+    projectName?: string
+    useMock?: boolean
+  }
+  displayedAssets?: Array<{
+    contractAddress: string
+    chainId: number
+  }>
+  ethAuth?: EthAuthSettings
+  isDev?: boolean
+
+  // optional wagmiConfig overrides
+  wagmiConfig?: WagmiConfig
+
+  walletConnectProjectId: string
+
+  // embedded wallet (waas) specific connector options
+  waasConfigKey: string
+  googleClientId?: string
+  appleClientId?: string
+  appleRedirectURI?: string
+  enableConfirmationModal?: boolean
+  legacyEmailAuth?: boolean
+}
+```
+
 ```js
 import { SequenceKit, createConfig } from '@0xsequence/kit'
 
 import Content from './components/Content'
 
-const projectAccessKey = '<your-project-access-key>'
-
 const config = createConfig('waas', {
-  projectAccessKey,
+  projectAccessKey: '<your-project-access-key>',
   chainIds: [1, 137]
   defaultChainId: 1
-  appName: 'Demo Dapp'
+  appName: 'Demo Dapp',
+  waasConfigKey: '<your-waas-config-key>'
 })
 
 function App() {

diff --git a/packages/checkout/README.md b/packages/checkout/README.md
@@ -25,15 +25,11 @@ import { KitCheckoutProvider } from '@0xsequence/kit-checkout'
 
 const App = () => {
   return (
-    <WagmiProvider config={config}>
-      <QueryClientProvider client={queryClient}>
-        <KitProvider>
-          <KitCheckoutProvider>
-            <Page />
-          </KitCheckoutProvider>
-        </KitProvider>
-      </QueryClientProvider>
-    </WagmiProvider>
+    <SequenceKit config={config}>
+      <KitCheckoutProvider>
+        <Page />
+      </KitCheckoutProvider>
+    </SequenceKit>
   )
 }
 ```

diff --git a/packages/kit/README.md b/packages/kit/README.md
@@ -32,18 +32,57 @@ yarn add @0xsequence/kit wagmi ethers@6.13.0 viem 0xsequence @tanstack/react-que
 
 #### The 'easy' way
 
+- `createConfig(walletType, options)` method is used to create your initial config and prepare sensible defaults that can be overridden
+
+`walletType` is either 'waas' or 'universal'
+
+```ts
+interface CreateConfigOptions {
+  appName: string
+  projectAccessKey: string
+  chainIds?: number[]
+  defaultChainId?: number
+  disableAnalytics?: boolean
+  defaultTheme?: Theme
+  position?: ModalPosition
+  signIn?: {
+    logoUrl?: string
+    projectName?: string
+    useMock?: boolean
+  }
+  displayedAssets?: Array<{
+    contractAddress: string
+    chainId: number
+  }>
+  ethAuth?: EthAuthSettings
+  isDev?: boolean
+
+  // optional wagmiConfig overrides
+  wagmiConfig?: WagmiConfig
+
+  walletConnectProjectId: string
+
+  // embedded wallet (waas) specific connector options
+  waasConfigKey: string
+  googleClientId?: string
+  appleClientId?: string
+  appleRedirectURI?: string
+  enableConfirmationModal?: boolean
+  legacyEmailAuth?: boolean
+}
+```
+
 ```js
 import { SequenceKit, createConfig } from '@0xsequence/kit'
 
 import Content from './components/Content'
 
-const projectAccessKey = '<your-project-access-key>'
-
 const config = createConfig('waas', {
-  projectAccessKey,
+  projectAccessKey: '<your-project-access-key>',
   chainIds: [1, 137]
   defaultChainId: 1
-  appName: 'Demo Dapp'
+  appName: 'Demo Dapp',
+  waasConfigKey: '<your-waas-config-key>'
 })
 
 function App() {

diff --git a/packages/kit/src/config/createConfig.ts b/packages/kit/src/config/createConfig.ts
@@ -3,11 +3,11 @@ import { createConfig as createWagmiConfig, type CreateConfigParameters, type Co
 import { KitConfig, WalletType } from '../types'
 
 import { getDefaultChains } from './defaultChains'
-import { DefaultConnectorsProps, getDefaultConnectors } from './defaultConnectors'
+import { DefaultConnectorOptions, getDefaultConnectors } from './defaultConnectors'
 import { getDefaultTransports } from './defaultTransports'
 
-type DefaultConfigProps<T extends WalletType> = KitConfig &
-  DefaultConnectorsProps<T> & {
+export type CreateConfigOptions<T extends WalletType> = KitConfig &
+  DefaultConnectorOptions<T> & {
     chainIds?: number[]
     wagmiConfig?: Partial<Omit<CreateConfigParameters, 'client'>>
   }
@@ -17,12 +17,12 @@ export interface SequenceKitConfig {
   kitConfig: KitConfig
 }
 
-export const createConfig = <T extends WalletType>(walletType: T, props: DefaultConfigProps<T>): SequenceKitConfig => {
-  const { projectAccessKey, chainIds, wagmiConfig, ...rest } = props
+export const createConfig = <T extends WalletType>(walletType: T, options: CreateConfigOptions<T>): SequenceKitConfig => {
+  const { projectAccessKey, chainIds, wagmiConfig, ...rest } = options
 
   const chains = wagmiConfig?.chains || getDefaultChains(chainIds)
   const transports = wagmiConfig?.transports || getDefaultTransports(chains)
-  const connectors = wagmiConfig?.connectors || getDefaultConnectors(walletType, props)
+  const connectors = wagmiConfig?.connectors || getDefaultConnectors(walletType, options)
 
   return {
     kitConfig: {

diff --git a/packages/kit/src/config/defaultConnectors.ts b/packages/kit/src/config/defaultConnectors.ts
@@ -14,14 +14,14 @@ import { walletConnect } from '../connectors/walletConnect'
 import { WalletType } from '../types'
 import { getKitConnectWallets } from '../utils/getKitConnectWallets'
 
-export interface CommonConnectorsProps {
+export interface CommonConnectorOptions {
   appName: string
   projectAccessKey: string
   walletConnectProjectId: string
   defaultChainId?: number
 }
 
-export interface DefaultWaasConnectorsProps extends CommonConnectorsProps {
+export interface DefaultWaasConnectorOptions extends CommonConnectorOptions {
   waasConfigKey: string
   googleClientId?: string
   appleClientId?: string
@@ -31,17 +31,17 @@ export interface DefaultWaasConnectorsProps extends CommonConnectorsProps {
   isDev?: boolean
 }
 
-export interface DefaultUniversalConnectorsProps extends CommonConnectorsProps {}
+export interface DefaultUniversalConnectorOptions extends CommonConnectorOptions {}
 
-export type DefaultConnectorsProps<T extends WalletType> = T extends 'waas'
-  ? DefaultWaasConnectorsProps
-  : DefaultUniversalConnectorsProps
+export type DefaultConnectorOptions<T extends WalletType> = T extends 'waas'
+  ? DefaultWaasConnectorOptions
+  : DefaultUniversalConnectorOptions
 
-export const getDefaultConnectors = <T extends WalletType>(walletType: T, props: DefaultConnectorsProps<T>) => {
+export const getDefaultConnectors = <T extends WalletType>(walletType: T, options: DefaultConnectorOptions<T>) => {
   if (walletType === 'waas') {
-    return getDefaultWaasConnectors(props as DefaultWaasConnectorsProps)
+    return getDefaultWaasConnectors(options as DefaultWaasConnectorOptions)
   } else if (walletType === 'universal') {
-    return getDefaultUniversalConnectors(props as DefaultUniversalConnectorsProps)
+    return getDefaultUniversalConnectors(options as DefaultUniversalConnectorOptions)
   }
 }
 
@@ -58,7 +58,7 @@ export const getDefaultWaasConnectors = ({
   enableConfirmationModal,
   legacyEmailAuth = false,
   isDev = false
-}: DefaultWaasConnectorsProps): CreateConnectorFn[] => {
+}: DefaultWaasConnectorOptions): CreateConnectorFn[] => {
   const wallets: any[] = [
     emailWaas({
       projectAccessKey,
@@ -111,7 +111,7 @@ export const getDefaultUniversalConnectors = ({
   projectAccessKey,
   walletConnectProjectId,
   defaultChainId
-}: DefaultUniversalConnectorsProps): CreateConnectorFn[] => {
+}: DefaultUniversalConnectorOptions): CreateConnectorFn[] => {
   const connectors = getKitConnectWallets(projectAccessKey, [
     email({
       defaultNetwork: defaultChainId,

diff --git a/packages/kit/src/index.ts b/packages/kit/src/index.ts
@@ -21,8 +21,15 @@ export type {
 export type { SwapQuotesWithCurrencyInfo } from './hooks/data'
 
 // Config
-export { createConfig } from './config/createConfig'
-export { getDefaultConnectors, getDefaultWaasConnectors } from './config/defaultConnectors'
+export { createConfig, type CreateConfigOptions } from './config/createConfig'
+export {
+  getDefaultConnectors,
+  getDefaultWaasConnectors,
+  getDefaultUniversalConnectors,
+  type DefaultConnectorOptions,
+  type DefaultWaasConnectorOptions,
+  type DefaultUniversalConnectorOptions
+} from './config/defaultConnectors'
 export { getDefaultChains } from './config/defaultChains'
 export { getDefaultTransports } from './config/defaultTransports'
 

diff --git a/packages/wallet/README.md b/packages/wallet/README.md
@@ -25,14 +25,10 @@ import { KitWalletProvider } from '@0xsequence/kit-wallet'
 
 const App = () => {
   return (
-    <WagmiProvider config={config}>
-      <QueryClientProvider client={queryClient}>
-        <KitProvider>
-          <KitWalletProvider>
-            <Page />
-          </KitWalletProvider>
-        </KitProvider>
-      </QueryClientProvider>
+    <SequenceKit config={config}>
+      <KitWalletProvider>
+        <Page />
+      </KitWalletProvider>
     </WagmiProvider>
   )
 }