-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
139 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
import { useMutation } from "@tanstack/react-query"; | ||
import { useCallback } from "react"; | ||
import type { Chain, Client, Transport } from "viem"; | ||
import type { SupportedAccounts } from "../../config"; | ||
import type { UseSmartAccountClientResult } from "./useSmartAccountClient"; | ||
|
||
export type UseClientActionsProps< | ||
TTransport extends Transport = Transport, | ||
TChain extends Chain | undefined = Chain | undefined, | ||
TActions extends { [x: string]: (...args: any[]) => unknown } = { | ||
[x: string]: (...args: any[]) => unknown; | ||
} | ||
> = { | ||
client?: UseSmartAccountClientResult< | ||
TTransport, | ||
TChain, | ||
SupportedAccounts | ||
>["client"]; | ||
actions: (client: Client<TTransport, TChain, SupportedAccounts>) => TActions; | ||
}; | ||
|
||
export type UseClientActionsResult< | ||
TActions extends { [x: string]: (...args: any[]) => unknown } = { | ||
[x: string]: (...args: any[]) => unknown; | ||
} | ||
> = { | ||
executeAction: <TFunctionName extends ExecutableFunctionName<TActions>>( | ||
params: ClientActionParameters<TActions, TFunctionName> | ||
) => void; | ||
isExecutingAction: boolean; | ||
}; | ||
|
||
export type ExecutableFunctionName< | ||
TActions extends { [x: string]: (...args: any[]) => unknown } = { | ||
[x: string]: (...args: any[]) => unknown; | ||
} | ||
> = keyof TActions extends infer functionName extends string | ||
? [functionName] extends [never] | ||
? string | ||
: functionName | ||
: string; | ||
|
||
export type ExecutableFunctionArgs< | ||
TActions extends { [x: string]: (...args: any[]) => unknown } = { | ||
[x: string]: (...args: any[]) => unknown; | ||
}, | ||
TFunctionName extends ExecutableFunctionName<TActions> = ExecutableFunctionName<TActions> | ||
> = Parameters<TActions[TFunctionName]>; | ||
|
||
// All of this is based one how viem's `encodeFunctionData` works | ||
export type ClientActionParameters< | ||
TActions extends { [x: string]: (...args: any[]) => unknown } = { | ||
[x: string]: (...args: any[]) => unknown; | ||
}, | ||
TFunctionName extends ExecutableFunctionName<TActions> = ExecutableFunctionName<TActions>, | ||
allArgs = ExecutableFunctionArgs< | ||
TActions, | ||
TFunctionName extends ExecutableFunctionName<TActions> | ||
? TFunctionName | ||
: ExecutableFunctionName<TActions> | ||
> | ||
> = { | ||
functionName: TFunctionName; | ||
args: allArgs; | ||
}; | ||
|
||
/** | ||
* A hook that allows you to execute plugin actions with a given | ||
* client connected to a Modular Account. | ||
* | ||
* @example | ||
* ```tsx | ||
* const Foo = () => { | ||
* const { executePluginAction } = usePlugin({ | ||
* client: {} as any, | ||
* pluginActions: sessionKeyPluginActions, | ||
* }); | ||
* | ||
* executePluginAction({ | ||
* functionName: "isAccountSessionKey", | ||
* args: [{ key: "0x0" }], | ||
* }); | ||
* }; | ||
* ``` | ||
*/ | ||
export function useClientActions< | ||
TTransport extends Transport = Transport, | ||
TChain extends Chain | undefined = Chain | undefined, | ||
TActions extends { [x: string]: (...args: any[]) => any } = { | ||
[x: string]: (...args: any[]) => any; | ||
} | ||
>({ | ||
client, | ||
actions: pluginActions, | ||
}: UseClientActionsProps< | ||
TTransport, | ||
TChain, | ||
TActions | ||
>): UseClientActionsResult<TActions> { | ||
const { mutate, isPending: isExecutingAction } = useMutation< | ||
ReturnType<TActions[keyof TActions]>, | ||
Error, | ||
ClientActionParameters<TActions, ExecutableFunctionName<TActions>> | ||
>({ | ||
mutationFn: async <TFunctionName extends ExecutableFunctionName<TActions>>({ | ||
functionName, | ||
args, | ||
}: ClientActionParameters<TActions, TFunctionName>) => { | ||
if (!client) { | ||
// TODO: use the strongly typed error here | ||
throw new Error("no client"); | ||
} | ||
|
||
const actions = pluginActions(client); | ||
return actions[functionName](...args); | ||
}, | ||
}); | ||
|
||
const executeAction = useCallback( | ||
<TFunctionName extends ExecutableFunctionName<TActions>>( | ||
params: ClientActionParameters<TActions, TFunctionName> | ||
) => { | ||
const { functionName, args } = params; | ||
return mutate({ functionName, args }); | ||
}, | ||
[mutate] | ||
); | ||
|
||
// TODO: add methods for installPlugin, uninstallPlugin, isPluginInstalled | ||
// NOTE: installPlugin is actually already part of the generated plugin actions usually, so we don't need that here | ||
// for uninstallPluin, we should start autogenerating that code as well | ||
|
||
return { | ||
executeAction, | ||
isExecutingAction, | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters