Skip to content

Upgrading @ant-design/web3-common 0.2 to 1

Breaking0.2.0 → 1.23.0Breaking1Security1Platform1New73Changed57Fixed76Other218

Full comparisonBack to @ant-design/web3-common
BreakingUpgrade verdict

1 breaking change and a platform requirement change and a security fix.

In plain terms
  • The Solana provider no longer accepts the chainAssets property.
  • Moves @tanstack/react-query to peerDependencies to fix the react-query context error.
  • Fixes a security issue in the deploy yml.
Must act 3 items need code or config changes

Adds lodash-es ^4.17.22.

Installs 1 package in all (was 0).

What you must change

Breaking1
Simplifies Solana provider properties and removes chainAssets.
chainAssets
1.8.0GitHub ReleaseSummarizedView source
Security1
Fixes a security issue in the deploy yml.
1.22.0GitHub ReleaseSummarizedView source
Platform1
Moves @tanstack/react-query to peerDependencies to fix the react-query context error.
@tanstack/react-query
1.10.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published .d.ts files. Not mixed with prose notes.

  • added: export * from './locale'
  • added: default localeValues
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • added: export { default as defaultLocale } from './default'
  • added: export { default as en_US } from './en_US'
  • added: export { default as zh_CN } from './zh_CN'
  • added: export { default as zh_HK } from './zh_HK'
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • changed: property ConnectorTriggerProps.onConnectClick?: () => void → property ConnectorTriggerProps.onConnectClick?: (wallet?: Wallet) => void
  • changed: property NFTMetadata.edition?: number → property NFTMetadata.edition?: string | number
  • changed: property UniversalWeb3ProviderInterface.connect?: (wallet?: Wallet) => Promise<void> → property UniversalWeb3ProviderInterface.connect?: (wallet?: Wallet, options?: ConnectOptions) => Promise<void | Account>
  • changed: property UniversalWeb3ProviderInterface.getNFTMetadata?: (params: { address: string; tokenId: bigint }) => Promise<NFTMetadata> → property UniversalWeb3ProviderInterface.getNFTMetadata?: (params: { address: string; tokenId?: bigint }) => Promise<NFTMetadata>
  • changed: type Balance = BalanceMetadata & { value?: bigint } → type Balance = BalanceMetadata & { value?: bigint; coverAddress?: boolean }
  • added: const enum ConnectStatus
  • added: enum ChainType
  • added: enum SolanaChainIds
  • added: enum SuiChainIds
  • added: interface ConnectOptions
  • added: interface Locale
  • added: interface RequiredLocale
  • added: interface SignConfig
  • added: interface UniversalEIP6963Config
  • added: member ChainIds.Avalanche = 43114
  • added: member ChainIds.Base = 8453
  • added: member ChainIds.Hardhat = 31337
  • added: member ChainIds.Holesky = 17000
  • added: member ChainIds.Localhost = 1337
  • added: member ChainIds.Scroll = 534352
  • added: member ChainIds.ScrollSepolia = 534351
  • added: member ChainIds.Sepolia = 11155111
  • added: member ChainIds.X1Testnet = 195
  • added: member ChainType.Bitcoin = 'Bitcoin'
  • added: member ChainType.EVM = 'EVM'
  • added: member ChainType.SVM = 'SVM'
  • added: member ChainType.Sui = 'Sui'
  • added: member ConnectStatus.Connected = 'connected'
  • added: member ConnectStatus.Disconnected = 'disconnected'
  • added: member ConnectStatus.Signed = 'signed'
  • added: member SolanaChainIds.Devnet = 3
  • added: member SolanaChainIds.MainnetBeta = 2
  • added: member SolanaChainIds.Testnet = 4
  • added: member SuiChainIds.Devnet = 3
  • added: member SuiChainIds.Localnet = 4
  • added: member SuiChainIds.Mainnet = 1
  • added: member SuiChainIds.Testnet = 2
  • added: property Account.addresses?: [`0x${string}`, ...`0x${string}`[]] | readonly `0x${string}`[]
  • added: property Account.avatar?: string
  • added: property Account.status?: ConnectStatus
  • added: property Chain.type?: ChainType
  • added: property ConnectOptions.connectType?: 'extension' | 'qrCode' | 'openMobile'
  • added: property ConnectorTriggerProps.availableWallets?: Wallet[]
  • added: property Locale.Address?: Partial<RequiredLocale['Address']>
  • added: property Locale.ConnectButton?: Partial<RequiredLocale['ConnectButton']>
  • added: property Locale.ConnectModal?: Partial<RequiredLocale['ConnectModal']>
  • added: property Locale.CryptoInput?: Partial<RequiredLocale['CryptoInput']>
  • added: property Locale.NFTCard?: Partial<RequiredLocale['NFTCard']>
  • added: property Locale.PayPanel?: Partial<RequiredLocale['PayPanel']>
  • added: property Locale.TokenSelect?: Partial<RequiredLocale['TokenSelect']>
  • added: property RequiredLocale.Address: { copyTips: string; copiedTips: string }
  • added: property RequiredLocale.ConnectButton: { connect: string; disconnect: string; copyAddress: string; copied: string; walletAddress: string; moreWallets: string; sign: string }
  • added: property RequiredLocale.ConnectModal: { title: string; guideTitle: string; guideInfos1Title: string; guideInfos1Desc: string; guideInfos2Title: string; guideInfos2Desc: string; guideInfos3Title: string; guideInfos3Desc: string; guideInfosGetWalletBtnText: string; guideInfosMoreLinkText: string; getWalletBtnText: string; getWalletUniversalProtocolBtnText: string; getWalletPanelTitle: string; getWa…
  • added: property RequiredLocale.CryptoInput: { placeholder: string; maxButtonText: string }
  • added: property RequiredLocale.NFTCard: { actionText: string }
  • added: property RequiredLocale.PayPanel: { tips: string }
  • added: property RequiredLocale.TokenSelect: { placeholder: string }
  • added: property SignConfig.signIn: (address: string) => Promise<void>
  • added: property SignConfig.signOut?: () => Promise<void>
  • added: property UniversalEIP6963Config.autoAddInjectedWallets?: boolean
  • added: property UniversalWeb3ProviderInterface.addressPrefix?: string | false
  • added: property UniversalWeb3ProviderInterface.extendsContextFromParent?: boolean
  • added: property UniversalWeb3ProviderInterface.sign?: SignConfig
  • added: property Wallet._isMobileWallet?: boolean
  • added: property Wallet._standardWallet?: any
  • added: property Wallet.customQrCodePanel?: boolean
  • added: property Wallet.hasExtensionInstalled?: () => Promise<boolean>
  • added: type ConnectingStatus = 'signing' | 'connecting'
  • added: type ConnectingStatusConfig = boolean | { status: ConnectingStatus }
  • added: type Token = { name: string; symbol: string; icon: React.ReactNode; decimal: number; availableChains: { chain: Chain; contract?: string }[] }
  • added: const createGetBrowserLink: (url: string) => (address: string, type: string) => string
  • added: export * from './createGetBrowserLink'
  • added: export * from './warning'
  • added: const WarningContext: React.Context<WarningContextProps>
  • added: const devUseWarning: (component: string) => TypeWarning
  • added: default warning
  • added: function noop(): void
  • added: function resetWarned(): void
  • added: interface WarningContextProps
  • added: let warning: Warning
  • added: property WarningContextProps.strict?: boolean
  • added: property ConfigConsumerProps.defaultLocale: RequiredLocale
  • added: property ConfigConsumerProps.locale?: Locale
  • added: property Web3ConfigProviderProps.ignoreConfig?: boolean
  • added: property Web3ConfigProviderProps.locale?: Locale
  • added: export { Web3ConfigProviderProps }
  • added: export * from './locale'
  • added: default localeValues
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • added: export { default as defaultLocale } from './default'
  • added: export { default as en_US } from './en_US'
  • added: export { default as zh_CN } from './zh_CN'
  • added: export { default as zh_HK } from './zh_HK'
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • added: const localeValues: RequiredLocale
  • added: default localeValues
  • changed: property ConnectorTriggerProps.onConnectClick?: () => void → property ConnectorTriggerProps.onConnectClick?: (wallet?: Wallet) => void
  • changed: property NFTMetadata.edition?: number → property NFTMetadata.edition?: string | number
  • changed: property UniversalWeb3ProviderInterface.connect?: (wallet?: Wallet) => Promise<void> → property UniversalWeb3ProviderInterface.connect?: (wallet?: Wallet, options?: ConnectOptions) => Promise<void | Account>
  • changed: property UniversalWeb3ProviderInterface.getNFTMetadata?: (params: { address: string; tokenId: bigint }) => Promise<NFTMetadata> → property UniversalWeb3ProviderInterface.getNFTMetadata?: (params: { address: string; tokenId?: bigint }) => Promise<NFTMetadata>
  • changed: type Balance = BalanceMetadata & { value?: bigint } → type Balance = BalanceMetadata & { value?: bigint; coverAddress?: boolean }
  • added: const enum ConnectStatus
  • added: enum ChainType
  • added: enum SolanaChainIds
  • added: enum SuiChainIds
  • added: interface ConnectOptions
  • added: interface Locale
  • added: interface RequiredLocale
  • added: interface SignConfig
  • added: interface UniversalEIP6963Config
  • added: member ChainIds.Avalanche = 43114
  • added: member ChainIds.Base = 8453
  • added: member ChainIds.Hardhat = 31337
  • added: member ChainIds.Holesky = 17000
  • added: member ChainIds.Localhost = 1337
  • added: member ChainIds.Scroll = 534352
  • added: member ChainIds.ScrollSepolia = 534351
  • added: member ChainIds.Sepolia = 11155111
  • added: member ChainIds.X1Testnet = 195
  • added: member ChainType.Bitcoin = 'Bitcoin'
  • added: member ChainType.EVM = 'EVM'
  • added: member ChainType.SVM = 'SVM'
  • added: member ChainType.Sui = 'Sui'
  • added: member ConnectStatus.Connected = 'connected'
  • added: member ConnectStatus.Disconnected = 'disconnected'
  • added: member ConnectStatus.Signed = 'signed'
  • added: member SolanaChainIds.Devnet = 3
  • added: member SolanaChainIds.MainnetBeta = 2
  • added: member SolanaChainIds.Testnet = 4
  • added: member SuiChainIds.Devnet = 3
  • added: member SuiChainIds.Localnet = 4
  • added: member SuiChainIds.Mainnet = 1
  • added: member SuiChainIds.Testnet = 2
  • added: property Account.addresses?: [`0x${string}`, ...`0x${string}`[]] | readonly `0x${string}`[]
  • added: property Account.avatar?: string
  • added: property Account.status?: ConnectStatus
  • added: property Chain.type?: ChainType
  • added: property ConnectOptions.connectType?: 'extension' | 'qrCode' | 'openMobile'
  • added: property ConnectorTriggerProps.availableWallets?: Wallet[]
  • added: property Locale.Address?: Partial<RequiredLocale['Address']>
  • added: property Locale.ConnectButton?: Partial<RequiredLocale['ConnectButton']>
  • added: property Locale.ConnectModal?: Partial<RequiredLocale['ConnectModal']>
  • added: property Locale.CryptoInput?: Partial<RequiredLocale['CryptoInput']>
  • added: property Locale.NFTCard?: Partial<RequiredLocale['NFTCard']>
  • added: property Locale.PayPanel?: Partial<RequiredLocale['PayPanel']>
  • added: property Locale.TokenSelect?: Partial<RequiredLocale['TokenSelect']>
  • added: property RequiredLocale.Address: { copyTips: string; copiedTips: string }
  • added: property RequiredLocale.ConnectButton: { connect: string; disconnect: string; copyAddress: string; copied: string; walletAddress: string; moreWallets: string; sign: string }
  • added: property RequiredLocale.ConnectModal: { title: string; guideTitle: string; guideInfos1Title: string; guideInfos1Desc: string; guideInfos2Title: string; guideInfos2Desc: string; guideInfos3Title: string; guideInfos3Desc: string; guideInfosGetWalletBtnText: string; guideInfosMoreLinkText: string; getWalletBtnText: string; getWalletUniversalProtocolBtnText: string; getWalletPanelTitle: string; getWa…
  • added: property RequiredLocale.CryptoInput: { placeholder: string; maxButtonText: string }
  • added: property RequiredLocale.NFTCard: { actionText: string }
  • added: property RequiredLocale.PayPanel: { tips: string }
  • added: property RequiredLocale.TokenSelect: { placeholder: string }
  • added: property SignConfig.signIn: (address: string) => Promise<void>
  • added: property SignConfig.signOut?: () => Promise<void>
  • added: property UniversalEIP6963Config.autoAddInjectedWallets?: boolean
  • added: property UniversalWeb3ProviderInterface.addressPrefix?: string | false
  • added: property UniversalWeb3ProviderInterface.extendsContextFromParent?: boolean
  • added: property UniversalWeb3ProviderInterface.sign?: SignConfig
  • added: property Wallet._isMobileWallet?: boolean
  • added: property Wallet._standardWallet?: any
  • added: property Wallet.customQrCodePanel?: boolean
  • added: property Wallet.hasExtensionInstalled?: () => Promise<boolean>
  • added: type ConnectingStatus = 'signing' | 'connecting'
  • added: type ConnectingStatusConfig = boolean | { status: ConnectingStatus }
  • added: type Token = { name: string; symbol: string; icon: React.ReactNode; decimal: number; availableChains: { chain: Chain; contract?: string }[] }
  • added: const createGetBrowserLink: (url: string) => (address: string, type: string) => string
  • added: export * from './createGetBrowserLink'
  • added: export * from './warning'
  • added: const WarningContext: React.Context<WarningContextProps>
  • added: const devUseWarning: (component: string) => TypeWarning
  • added: default warning
  • added: function noop(): void
  • added: function resetWarned(): void
  • added: interface WarningContextProps
  • added: let warning: Warning
  • added: property WarningContextProps.strict?: boolean
  • added: property ConfigConsumerProps.defaultLocale: RequiredLocale
  • added: property ConfigConsumerProps.locale?: Locale
  • added: property Web3ConfigProviderProps.ignoreConfig?: boolean
  • added: property Web3ConfigProviderProps.locale?: Locale
  • added: export { Web3ConfigProviderProps }