Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: fix generated read hooks select type #1892

Merged
merged 5 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tasty-dolphins-flash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@wagmi/cli': patch
---

Fixed generated read hooks `select` type.
88 changes: 57 additions & 31 deletions packages/cli/src/plugins/__snapshots__/react.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ exports[`react > run > with TypeScript 1`] = `
useContractEvent,
UseContractEventConfig,
} from 'wagmi'
import { WriteContractMode, PrepareWriteContractResult } from 'wagmi/actions'
import {
ReadContractResult,
WriteContractMode,
PrepareWriteContractResult,
} from 'wagmi/actions'

/**
* Wraps __{@link useContract}__ with \`abi\` set to __{@link wagmiAbi}__.
Expand All @@ -25,160 +29,182 @@ export function useWagmi(config: Omit<UseContractConfig, 'abi'> = {} as any) {
/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__.
*/
export function useWagmiRead<TFunctionName extends string>(
export function useWagmiRead<
TFunctionName extends string,
TSelectData = ReadContractResult<typeof wagmiAbi, TFunctionName>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, TFunctionName>,
UseContractReadConfig<typeof wagmiAbi, TFunctionName, TSelectData>,
'abi'
> = {} as any,
) {
return useContractRead({ abi: wagmiAbi, ...config } as UseContractReadConfig<
typeof wagmiAbi,
TFunctionName
TFunctionName,
TSelectData
>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"balanceOf\\"\`.
*/
export function useWagmiBalanceOf(
export function useWagmiBalanceOf<
TSelectData = ReadContractResult<typeof wagmiAbi, 'balanceOf'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'balanceOf'>,
UseContractReadConfig<typeof wagmiAbi, 'balanceOf', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'balanceOf',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'balanceOf'>)
} as UseContractReadConfig<typeof wagmiAbi, 'balanceOf', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"getApproved\\"\`.
*/
export function useWagmiGetApproved(
export function useWagmiGetApproved<
TSelectData = ReadContractResult<typeof wagmiAbi, 'getApproved'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'getApproved'>,
UseContractReadConfig<typeof wagmiAbi, 'getApproved', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'getApproved',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'getApproved'>)
} as UseContractReadConfig<typeof wagmiAbi, 'getApproved', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"isApprovedForAll\\"\`.
*/
export function useWagmiIsApprovedForAll(
export function useWagmiIsApprovedForAll<
TSelectData = ReadContractResult<typeof wagmiAbi, 'isApprovedForAll'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'isApprovedForAll'>,
UseContractReadConfig<typeof wagmiAbi, 'isApprovedForAll', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'isApprovedForAll',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'isApprovedForAll'>)
} as UseContractReadConfig<typeof wagmiAbi, 'isApprovedForAll', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"name\\"\`.
*/
export function useWagmiName(
export function useWagmiName<
TSelectData = ReadContractResult<typeof wagmiAbi, 'name'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'name'>,
UseContractReadConfig<typeof wagmiAbi, 'name', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'name',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'name'>)
} as UseContractReadConfig<typeof wagmiAbi, 'name', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"ownerOf\\"\`.
*/
export function useWagmiOwnerOf(
export function useWagmiOwnerOf<
TSelectData = ReadContractResult<typeof wagmiAbi, 'ownerOf'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'ownerOf'>,
UseContractReadConfig<typeof wagmiAbi, 'ownerOf', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'ownerOf',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'ownerOf'>)
} as UseContractReadConfig<typeof wagmiAbi, 'ownerOf', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"supportsInterface\\"\`.
*/
export function useWagmiSupportsInterface(
export function useWagmiSupportsInterface<
TSelectData = ReadContractResult<typeof wagmiAbi, 'supportsInterface'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'supportsInterface'>,
UseContractReadConfig<typeof wagmiAbi, 'supportsInterface', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'supportsInterface',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'supportsInterface'>)
} as UseContractReadConfig<typeof wagmiAbi, 'supportsInterface', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"symbol\\"\`.
*/
export function useWagmiSymbol(
export function useWagmiSymbol<
TSelectData = ReadContractResult<typeof wagmiAbi, 'symbol'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'symbol'>,
UseContractReadConfig<typeof wagmiAbi, 'symbol', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'symbol',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'symbol'>)
} as UseContractReadConfig<typeof wagmiAbi, 'symbol', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"tokenURI\\"\`.
*/
export function useWagmiTokenUri(
export function useWagmiTokenUri<
TSelectData = ReadContractResult<typeof wagmiAbi, 'tokenURI'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'tokenURI'>,
UseContractReadConfig<typeof wagmiAbi, 'tokenURI', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'tokenURI',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'tokenURI'>)
} as UseContractReadConfig<typeof wagmiAbi, 'tokenURI', TSelectData>)
}

/**
* Wraps __{@link useContractRead}__ with \`abi\` set to __{@link wagmiAbi}__ and \`functionName\` set to \`\\"totalSupply\\"\`.
*/
export function useWagmiTotalSupply(
export function useWagmiTotalSupply<
TSelectData = ReadContractResult<typeof wagmiAbi, 'totalSupply'>,
>(
config: Omit<
UseContractReadConfig<typeof wagmiAbi, 'totalSupply'>,
UseContractReadConfig<typeof wagmiAbi, 'totalSupply', TSelectData>,
'abi' | 'functionName'
> = {} as any,
) {
return useContractRead({
abi: wagmiAbi,
functionName: 'totalSupply',
...config,
} as UseContractReadConfig<typeof wagmiAbi, 'totalSupply'>)
} as UseContractReadConfig<typeof wagmiAbi, 'totalSupply', TSelectData>)
}

/**
Expand Down
13 changes: 8 additions & 5 deletions packages/cli/src/plugins/react.ts
Original file line number Diff line number Diff line change
Expand Up @@ -198,15 +198,17 @@ export function react(config: ReactConfig = {}): ReactResult {
let code
if (isTypeScript) {
imports.add('UseContractReadConfig')
actionsImports.add('ReadContractResult')
code = dedent`
${docString}
export function use${baseHookName}Read<
TFunctionName extends string,
TSelectData = ReadContractResult<typeof ${contract.meta.abiName}, TFunctionName>
>(
config: Omit<UseContractReadConfig<typeof ${contract.meta.abiName}, TFunctionName>, 'abi'${omitted}>${typeParams} = {} as any,
config: Omit<UseContractReadConfig<typeof ${contract.meta.abiName}, TFunctionName, TSelectData>, 'abi'${omitted}>${typeParams} = {} as any,
) {
${innerContent}
return useContractRead(${innerHookConfig} as UseContractReadConfig<typeof ${contract.meta.abiName}, TFunctionName>)
return useContractRead(${innerHookConfig} as UseContractReadConfig<typeof ${contract.meta.abiName}, TFunctionName, TSelectData>)
}
`
} else
Expand Down Expand Up @@ -247,14 +249,15 @@ export function react(config: ReactConfig = {}): ReactResult {
let code
if (isTypeScript) {
imports.add('UseContractReadConfig')
actionsImports.add('ReadContractResult')
// prettier-ignore
code = dedent`
${docString}
export function use${baseHookName}${pascalCase(item.name)}(
config: Omit<UseContractReadConfig<typeof ${contract.meta.abiName}, '${item.name}'>, 'abi'${omitted} | 'functionName'>${typeParams} = {} as any,
export function use${baseHookName}${pascalCase(item.name)}<TSelectData = ReadContractResult<typeof ${contract.meta.abiName}, '${item.name}'>>(
config: Omit<UseContractReadConfig<typeof ${contract.meta.abiName}, '${item.name}', TSelectData>, 'abi'${omitted} | 'functionName'>${typeParams} = {} as any,
) {
${innerContent}
return useContractRead(${config} as UseContractReadConfig<typeof ${contract.meta.abiName}, '${item.name}'>)
return useContractRead(${config} as UseContractReadConfig<typeof ${contract.meta.abiName}, '${item.name}', TSelectData>)
}
`
} else {
Expand Down