diff --git a/.changeset/beige-fireants-invite.md b/.changeset/beige-fireants-invite.md new file mode 100644 index 00000000000..88ab1b92ec0 --- /dev/null +++ b/.changeset/beige-fireants-invite.md @@ -0,0 +1,5 @@ +--- +"@thirdweb-dev/wallets": patch +--- + +[Docs] Document deployOnSign diff --git a/packages/react/src/evm/hooks/wallets/useSmartWallet.ts b/packages/react/src/evm/hooks/wallets/useSmartWallet.ts index bfb5656a617..41fc2b6ce51 100644 --- a/packages/react/src/evm/hooks/wallets/useSmartWallet.ts +++ b/packages/react/src/evm/hooks/wallets/useSmartWallet.ts @@ -204,6 +204,11 @@ import type { BytesLike } from "ethers"; * The entrypoint contract address. Uses v0.6 by default. * * Must be a `string`. + * + * #### deployOnSign + * Whether to deploy the smart wallet when the user signs a message. Defaults to true. + * + * Must be a `boolean`. * * @walletConnection */ diff --git a/packages/wallets/src/evm/wallets/smart-wallet.ts b/packages/wallets/src/evm/wallets/smart-wallet.ts index 340372f46f0..29aa5608665 100644 --- a/packages/wallets/src/evm/wallets/smart-wallet.ts +++ b/packages/wallets/src/evm/wallets/smart-wallet.ts @@ -246,6 +246,11 @@ export class SmartWallet extends AbstractClientWallet< * The entrypoint contract address. Uses v0.6 by default. * * Must be a `string`. + * + * #### deployOnSign + * Whether to deploy the smart wallet when the user signs a message. Defaults to true. + * + * Must be a `boolean`. * * #### chains * Provide an array of chains you want to support.