@xyo-network/react-wallet 2.71.0 → 2.71.2

package/src/components/WalletAccountSelect/WalletAccountSelectBar.stories.tsx

@@ -1,14 +1,16 @@
 import { Meta, StoryFn } from '@storybook/react'
-import { DefaultSeedPhrase } from '@xyo-network/react-storybook'
 import { WalletInstance } from '@xyo-network/wallet-model'
 
-import { WalletProvider } from '../../contexts'
-import { useWallet, useWallets } from '../../hooks'
+import { useWallets } from '../../hooks'
 import { WalletAccountSelectBar } from './SelectBar'
+import { WalletProviderDecorator } from './stories'
+
+const PATHS = { paths: ['0', '3', '5']}
 
 const StorybookEntry = {
   argTypes: {},
   component: WalletAccountSelectBar,
+  decorators: [WalletProviderDecorator],
   parameters: {
     docs: {
       page: null,
@@ -21,21 +23,10 @@ const Template: StoryFn<typeof WalletAccountSelectBar> = (args) => {
   return <WalletAccountSelectBar {...args}></WalletAccountSelectBar>
 }
 
-const WithWalletTemplate: StoryFn<typeof WalletAccountSelectBar> = (args) => {
-  const [rootWallet] = useWallet({ mnemonic: DefaultSeedPhrase })
-  return (
-    <WalletProvider rootWallet={rootWallet}>
-      <WalletAccountSelectBar {...args} />
-    </WalletProvider>
-  )
-}
-
 const WithFavoritesTemplate: StoryFn<typeof WalletAccountSelectBar> = (args) => {
-  const [rootWallet] = useWallet({ mnemonic: DefaultSeedPhrase })
-  const [wallets] = useWallets({ paths: ['0', '3', '5'], wallet: rootWallet })
+  const [wallets] = useWallets(PATHS)
   const castWallets = wallets as WalletInstance[] | undefined
   return (
-    <WalletProvider rootWallet={rootWallet}>
       <WalletAccountSelectBar
         addressNames={
           castWallets
@@ -51,20 +42,19 @@ const WithFavoritesTemplate: StoryFn<typeof WalletAccountSelectBar> = (args) =>
         showFavorite
         {...args}
       />
-    </WalletProvider>
   )
 }
 
 const Default = Template.bind({})
 Default.args = {}
 
-const WithWallet = WithWalletTemplate.bind({})
+const WithWallet = Template.bind({})
 WithWallet.args = {}
 
-const WithWalletIcon = WithWalletTemplate.bind({})
+const WithWalletIcon = Template.bind({})
 WithWalletIcon.args = { icons: true }
 
-const WithAdditionalAccounts = WithWalletTemplate.bind({})
+const WithAdditionalAccounts = Template.bind({})
 WithAdditionalAccounts.args = { icons: true, maxAccounts: 10 }
 
 const WithAccountFavorites = WithFavoritesTemplate.bind({})

package/src/components/WalletAccountSelect/WalletAccountSelectWithProvider.stories.tsx

@@ -1,13 +1,12 @@
 import { Meta, StoryFn } from '@storybook/react'
-import { DefaultSeedPhrase } from '@xyo-network/react-storybook'
 
-import { WalletProvider } from '../../contexts'
-import { useWallet } from '../../hooks'
 import { WalletAccountSelect } from './Select'
+import { WalletProviderDecorator } from './stories'
 
 const StorybookEntry = {
   argTypes: {},
   component: WalletAccountSelect,
+  decorators: [WalletProviderDecorator],
   parameters: {
     docs: {
       page: null,
@@ -17,12 +16,7 @@ const StorybookEntry = {
 } as Meta<typeof WalletAccountSelect>
 
 const Template: StoryFn<typeof WalletAccountSelect> = (args) => {
-  const [rootWallet] = useWallet({ mnemonic: DefaultSeedPhrase })
-  return (
-    <WalletProvider rootWallet={rootWallet}>
-      <WalletAccountSelect {...args}></WalletAccountSelect>
-    </WalletProvider>
-  )
+  return <WalletAccountSelect {...args}></WalletAccountSelect>
 }
 
 const Default = Template.bind({})

package/src/components/WalletAccountSelect/WalletInfo.tsx

@@ -46,6 +46,7 @@ export const WalletIdenticon: React.FC<WalletIdenticonProps> = ({ account, name
   )
 }
 
+/** @deprecated - use rootWallet instead */
 export const CoinTypeWalletInfo: React.FC<FlexBoxProps> = (props) => {
   const [wallet, error] = useCoinTypeWallet()
   return (

package/src/components/WalletAccountSelect/stories/WalletProviderDecorator.tsx

@@ -0,0 +1,15 @@
+import { Decorator } from '@storybook/react'
+import { DefaultSeedPhrase } from '@xyo-network/react-storybook'
+
+import { WalletProvider } from '../../../contexts'
+import { useWallet } from '../../../hooks'
+
+export const WalletProviderDecorator: Decorator = (Story, context) => {
+  const [rootWallet] = useWallet({ mnemonic: DefaultSeedPhrase })
+
+  return (
+    <WalletProvider rootWallet={rootWallet}>
+      <Story {...context} />
+    </WalletProvider>
+  )
+}

package/src/components/WalletAccountSelect/stories/index.ts

@@ -0,0 +1 @@
+export * from './WalletProviderDecorator'

package/src/contexts/Wallet/Provider.tsx

@@ -4,16 +4,16 @@ import { WalletInstance } from '@xyo-network/wallet-model'
 import { useEffect, useState } from 'react'
 
 import { WalletContext } from './Context'
-import { WalletRootPath } from './lib'
 
 export interface WalletProviderProps {
+  /** @deprecated - BasePath is no longer supported. Set base path outside of WalletProvider */
   basePath?: string
   defaultActiveAccountIndex?: number
   rootWallet?: WalletInstance | null
 }
 
 export const WalletProvider: React.FC<WithChildren<WalletProviderProps>> = ({
-  basePath = WalletRootPath,
+  basePath,
   children,
   defaultActiveAccountIndex = 0,
   rootWallet = null,
@@ -27,28 +27,7 @@ export const WalletProvider: React.FC<WithChildren<WalletProviderProps>> = ({
     }
   }, [defaultActiveAccountIndex])
 
-  const [coinTypeWallet = null] = usePromise(async () => {
-    // ensure the wallet has the proper base
-    if (rootWallet) {
-      if (rootWallet?.path !== basePath) {
-        try {
-          const result = await rootWallet?.derivePath(basePath)
-          return result
-        } catch (e) {
-          console.error('Error setting proper wallet base path', e)
-        }
-      }
-    } else {
-      return rootWallet
-    }
-  }, [basePath, rootWallet])
-
-  //console.log(`coinTypeWallet: ${coinTypeWallet}`)
-
-  const [activeAccount = null] = usePromise(
-    async () => await coinTypeWallet?.derivePath(activeAccountIndex.toString()),
-    [coinTypeWallet, activeAccountIndex],
-  )
+  const [activeAccount = null] = usePromise(async () => await rootWallet?.derivePath(activeAccountIndex.toString()), [activeAccountIndex, rootWallet])
 
   return (
     <WalletContext.Provider
@@ -56,7 +35,9 @@ export const WalletProvider: React.FC<WithChildren<WalletProviderProps>> = ({
         activeAccount,
         activeAccountIndex,
         basePath,
-        coinTypeWallet,
+        /* eslint-disable deprecation/deprecation */
+        /** @deprecated - Set path for coinTypeWallet outside of provider and pass as rootWallet */
+        coinTypeWallet: null,
         provided: true,
         rootWallet,
         setActiveAccountIndex,

package/src/contexts/Wallet/State.ts

@@ -7,8 +7,10 @@ export interface WalletContextState extends ContextExState {
   activeAccount?: WalletInstance | null
   /** Currently selected index */
   activeAccountIndex?: number
+  /** @deprecated - BasePath is no longer supported. Set base path outside of WalletProvider */
   /** Base path from which the wallet was derived */
   basePath?: string
+  /** @deprecated - Set path for coinTypeWallet outside of provider and pass as rootWallet */
   /** The coin_type derived wallet being used */
   coinTypeWallet?: WalletInstance | null
   /** The root wallet being used */

package/src/contexts/Wallet/index.ts

@@ -1,5 +1,4 @@
 export * from './Context'
-export * from './lib'
 export * from './Provider'
 export * from './State'
 export * from './use'

package/src/contexts/Wallet/use.ts

@@ -12,6 +12,7 @@ export const useWalletProvided = () => {
   return useProvided(WalletContext)
 }
 
+/** @deprecated - useWalletContext instead */
 export const useCoinTypeWallet = (required = true): [WalletInstance | null | undefined, Error | undefined] => {
   const { coinTypeWallet } = useWalletContext(required)
   return [coinTypeWallet, undefined]
@@ -23,8 +24,8 @@ export const useRootWallet = (required = true): [WalletInstance | null | undefin
 }
 
 export const useIndexedWalletFromContext = (index: number, required = true): [WalletInstance | null | undefined, Error | undefined] => {
-  const [coinTypeWallet] = useCoinTypeWallet(required)
-  const [wallet] = usePromise(async () => (await coinTypeWallet?.derivePath(index.toString())) ?? coinTypeWallet, [coinTypeWallet, index])
+  const { rootWallet } = useWalletContext(required)
+  const [wallet] = usePromise(async () => (await rootWallet?.derivePath(index.toString())) ?? rootWallet, [rootWallet, index])
   return [wallet, undefined]
 }
 

package/src/hooks/useAccount.ts

@@ -3,7 +3,7 @@ import { AccountInstance } from '@xyo-network/account-model'
 import { WalletInstance } from '@xyo-network/wallet-model'
 import { useState } from 'react'
 
-import { useCoinTypeWallet, useWalletContext, useWalletProvided } from '../contexts'
+import { useRootWallet, useWalletContext, useWalletProvided } from '../contexts'
 
 export interface AccountHookParams {
   account?: AccountInstance
@@ -27,15 +27,15 @@ export const useAccount = ({ wallet, account, index, required = false }: Account
   }
 
   const [error, setError] = useState<Error>()
-  const [coinTypeWallet] = useCoinTypeWallet(!wallet && required)
+  const [rootWallet] = useRootWallet(!wallet && required)
   const { activeAccountIndex } = useWalletContext(false)
   const [activeAccount] = usePromise(async () => {
     try {
       if (!validationError) {
         if (wallet) {
           return await wallet?.derivePath?.(`${index ?? 0}'\0`)
-        } else if (coinTypeWallet) {
-          return await coinTypeWallet?.derivePath?.(`${index ?? activeAccountIndex ?? 0}'\0`)
+        } else if (rootWallet) {
+          return await rootWallet?.derivePath?.(`${index ?? activeAccountIndex ?? 0}'\0`)
         }
       }
     } catch (ex) {
@@ -43,7 +43,7 @@ export const useAccount = ({ wallet, account, index, required = false }: Account
       console.error(error.message)
       setError(error)
     }
-  }, [index, wallet, coinTypeWallet, activeAccountIndex, validationError])
+  }, [index, wallet, rootWallet, activeAccountIndex, validationError])
   if (validationError && !error) {
     console.error(validationError.message)
     setError(validationError)

package/src/hooks/useWallet.ts

@@ -3,7 +3,7 @@ import { HDWallet } from '@xyo-network/account'
 import { WalletInstance } from '@xyo-network/wallet-model'
 import { useState } from 'react'
 
-import { useSelectedWalletAccount, useWalletProvided } from '../contexts'
+import { useSelectedWalletAccount, useWalletContext } from '../contexts'
 
 export interface WalletHookParams {
   mnemonic?: string
@@ -17,7 +17,7 @@ export const useWallet = ({ mnemonic, wallet, path, required = false, seed }: Wa
   WalletInstance | null | undefined,
   Error | undefined,
 ] => {
-  const walletContextProvided = useWalletProvided()
+  const walletContextProvided = useWalletContext(false)
   const [error, setError] = useState<Error>()
   const [contextAccount] = useSelectedWalletAccount(!wallet && required)
   const [activeAccount] = usePromise(async () => {

package/src/hooks/useWallets.ts

@@ -1,7 +1,7 @@
 import { usePromise } from '@xylabs/react-promise'
 import { WalletInstance } from '@xyo-network/wallet-model'
 
-import { useWalletProvided } from '../contexts'
+import { useWalletContext } from '../contexts'
 import { useWallet } from './useWallet'
 
 export interface WalletsHookParams {
@@ -10,7 +10,7 @@ export interface WalletsHookParams {
 }
 
 export const useWallets = ({ wallet, paths }: WalletsHookParams): [WalletInstance[] | null | undefined, Error | undefined] => {
-  const walletContextProvided = useWalletProvided()
+  const walletContextProvided = useWalletContext(false)
   const [foundWallet] = useWallet({ wallet })
   const [wallets, error] = usePromise(
     async () => (foundWallet ? await Promise.all(paths.map((path) => foundWallet.derivePath(path))) : undefined),

package/dist/browser/contexts/Wallet/lib/WalletPath.d.cts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/browser/contexts/Wallet/lib/WalletPath.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/browser/contexts/Wallet/lib/WalletPath.d.mts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/browser/contexts/Wallet/lib/WalletPath.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/browser/contexts/Wallet/lib/WalletPath.d.ts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/browser/contexts/Wallet/lib/WalletPath.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/browser/contexts/Wallet/lib/index.d.cts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/browser/contexts/Wallet/lib/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/browser/contexts/Wallet/lib/index.d.mts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/browser/contexts/Wallet/lib/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/browser/contexts/Wallet/lib/index.d.ts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/browser/contexts/Wallet/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/node/contexts/Wallet/lib/WalletPath.d.cts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/node/contexts/Wallet/lib/WalletPath.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/node/contexts/Wallet/lib/WalletPath.d.mts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/node/contexts/Wallet/lib/WalletPath.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/node/contexts/Wallet/lib/WalletPath.d.ts

@@ -1,13 +0,0 @@
-export declare const Bip44: {
-    base: string;
-    coin_type: {
-        bitcoin: string;
-        bitcoinTestnet: string;
-        ether: string;
-        etherClassic: string;
-    };
-    purpose: string;
-};
-export declare const WalletRootPath: string;
-export declare const ethereumAccountPath: (index: number, hardened?: boolean) => string;
-//# sourceMappingURL=WalletPath.d.ts.map

package/dist/node/contexts/Wallet/lib/WalletPath.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WalletPath.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/WalletPath.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;;;;;;;;CAUjB,CAAA;AAED,eAAO,MAAM,cAAc,QAA4D,CAAA;AAEvF,eAAO,MAAM,mBAAmB,UAAW,MAAM,+BAEhD,CAAA"}

package/dist/node/contexts/Wallet/lib/index.d.cts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/contexts/Wallet/lib/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/node/contexts/Wallet/lib/index.d.mts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/contexts/Wallet/lib/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/node/contexts/Wallet/lib/index.d.ts

@@ -1,2 +0,0 @@
-export * from './WalletPath';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/contexts/Wallet/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/contexts/Wallet/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/src/contexts/Wallet/lib/WalletPath.ts

@@ -1,17 +0,0 @@
-export const Bip44 = {
-  base: 'm',
-  coin_type: {
-    /* https://github.com/satoshilabs/slips/blob/master/slip-0044.md */
-    bitcoin: "0'",
-    bitcoinTestnet: "1'",
-    ether: "60'",
-    etherClassic: "61'",
-  },
-  purpose: "44'",
-}
-
-export const WalletRootPath = `${Bip44.base}/${Bip44.purpose}/${Bip44.coin_type.ether}`
-
-export const ethereumAccountPath = (index: number, hardened = true) => {
-  return `${WalletRootPath}/${index}${hardened ? "'" : ''}/0`
-}

package/src/contexts/Wallet/lib/index.ts

@@ -1 +0,0 @@
-export * from './WalletPath'