Class SmartWalletPlugin

Smart Wallet Plugin for Shogun Core Provides integration with Smart Wallet contracts for account abstraction

Hierarchy (View Summary)

BasePlugin
- SmartWalletPlugin

Implements

SmartWalletPluginInterface

Constructors

constructor

new SmartWalletPlugin(config?: SmartWalletConfig): SmartWalletPlugin
Parameters
- config: SmartWalletConfig = {}
Returns SmartWalletPlugin
Overrides BasePlugin.constructor

Properties

`Optional`_category

_category?: PluginCategory

Categoria del plugin

`Private`config

config: SmartWalletConfig

`Protected`core

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

description

description: string = "Smart Wallet integration for Shogun Core with multi-sig and social recovery"

Descrizione opzionale del plugin

`Private`factoryContract

factoryContract: null | Contract = null

name

name: string = "smartwallet"

Nome univoco del plugin - deve essere implementato dalle sottoclassi

`Private`signer

signer: null | Signer = null

version

version: string = "1.0.0"

Versione del plugin - deve essere implementata dalle sottoclassi

Methods

addGuardian

addGuardian(walletAddress: string, guardian: string): Promise<ExecutionResult>
Parameters
- walletAddress: string
- guardian: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.addGuardian

addSigner

addSigner(walletAddress: string, signer: string): Promise<ExecutionResult>
Parameters
- walletAddress: string
- signer: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.addSigner

approveProposal

approveProposal(
walletAddress: string,
proposalId: number,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- proposalId: number
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.approveProposal

approveRecovery

approveRecovery(walletAddress: string): Promise<ExecutionResult>
Parameters
- walletAddress: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.approveRecovery

`Private`assertFactory

assertFactory(): Contract
Ensure factory is initialized

Returns Contract

`Protected`assertInitialized

assertInitialized(): ShogunCore
Verifica che il plugin sia stato inizializzato prima di usare il core

Returns ShogunCore
L'istanza di ShogunCore non null

Throws
Error se il plugin non è stato inizializzato

Inherited from BasePlugin.assertInitialized

`Private`assertSigner

assertSigner(): Signer
Ensure signer is available

Returns Signer

connectWallet

connectWallet(): Promise<void>
Connect to MetaMask or other injected provider

Returns Promise<void>
Implementation of SmartWalletPluginInterface.connectWallet

createWallet

createWallet(
    owner: string,
    requiredSignatures?: number,
    requiredGuardians?: number,
): Promise<WalletCreateResult>
Parameters
- owner: string
- OptionalrequiredSignatures: number
- OptionalrequiredGuardians: number
Returns Promise<WalletCreateResult>
Implementation of SmartWalletPluginInterface.createWallet

createWalletWithGuardians

createWalletWithGuardians(
    owner: string,
    guardians: string[],
    requiredSignatures?: number,
    requiredGuardians?: number,
): Promise<WalletCreateResult>
Parameters
- owner: string
- guardians: string[]
- OptionalrequiredSignatures: number
- OptionalrequiredGuardians: number
Returns Promise<WalletCreateResult>
Implementation of SmartWalletPluginInterface.createWalletWithGuardians

destroy

destroy(): void
Destroy the plugin and cleanup resources

Returns void
Overrides BasePlugin.destroy

emit

emit(event: EventType, data?: unknown): boolean
Emits an event with arguments
Parameters
- event: EventType
- Optionaldata: unknown
Returns boolean
Inherited from BasePlugin.emit

executeBatch

executeBatch(
    walletAddress: string,
    targets: string[],
    dataArray: string[],
    values: string[],
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- targets: string[]
- dataArray: string[]
- values: string[]
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.executeBatch

executeRecovery

executeRecovery(walletAddress: string): Promise<ExecutionResult>
Parameters
- walletAddress: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.executeRecovery

executeTransaction

executeTransaction(
    walletAddress: string,
    target: string,
    data: string,
    value?: string,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- target: string
- data: string
- value: string = "0"
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.executeTransaction

getOwnerWallets

getOwnerWallets(ownerAddress: string): Promise<string[]>
Parameters
- ownerAddress: string
Returns Promise<string[]>
Implementation of SmartWalletPluginInterface.getOwnerWallets

getProposalInfo

getProposalInfo(
walletAddress: string,
proposalId: number,
): Promise<null | ProposalInfo>
Parameters
- walletAddress: string
- proposalId: number
Returns Promise<null | ProposalInfo>
Implementation of SmartWalletPluginInterface.getProposalInfo

getRecoveryRequest

getRecoveryRequest(walletAddress: string): Promise<null | RecoveryRequest>
Parameters
- walletAddress: string
Returns Promise<null | RecoveryRequest>
Implementation of SmartWalletPluginInterface.getRecoveryRequest

getWalletInfo

getWalletInfo(walletAddress: string): Promise<null | WalletInfo>
Parameters
- walletAddress: string
Returns Promise<null | WalletInfo>
Implementation of SmartWalletPluginInterface.getWalletInfo

`Private`initFactoryContract

initFactoryContract(): void
Initialize factory contract

Returns void

initialize

initialize(core: ShogunCore): void
Initialize the plugin
Parameters
- core: ShogunCore
Returns void
Overrides BasePlugin.initialize

initiateRecovery

initiateRecovery(
walletAddress: string,
newOwner: string,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- newOwner: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.initiateRecovery

`Private`initProvider

initProvider(): void
Initialize provider and signer

Returns void

off

off(event: EventType, listener: (data: unknown) => void): void
Removes an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from BasePlugin.off

on

on(event: EventType, listener: (data: unknown) => void): void
Registers an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from BasePlugin.on

once

once(event: EventType, listener: (data: unknown) => void): void
Registers a one-time event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from BasePlugin.once

proposeExecution

proposeExecution(
    walletAddress: string,
    target: string,
    data: string,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- target: string
- data: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.proposeExecution

removeAllListeners

removeAllListeners(event?: EventType): void
Removes all listeners for an event or all events
Parameters
- Optionalevent: EventType
Returns void
Inherited from BasePlugin.removeAllListeners

removeGuardian

removeGuardian(
walletAddress: string,
guardian: string,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- guardian: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.removeGuardian

removeSigner

removeSigner(walletAddress: string, signer: string): Promise<ExecutionResult>
Parameters
- walletAddress: string
- signer: string
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.removeSigner

setRequiredSignatures

setRequiredSignatures(
walletAddress: string,
required: number,
): Promise<ExecutionResult>
Parameters
- walletAddress: string
- required: number
Returns Promise<ExecutionResult>
Implementation of SmartWalletPluginInterface.setRequiredSignatures

setSigner

setSigner(privateKeyOrAddress: string): Promise<void>
Set signer with private key or wallet instance This should be called after deriving the EOA from seed phrase
Parameters
- privateKeyOrAddress: string
Returns Promise<void>
Implementation of SmartWalletPluginInterface.setSigner

Class SmartWalletPlugin

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmartWalletPlugin

Properties

Optional_category

Privateconfig

Protectedcore

description

PrivatefactoryContract

name

Privatesigner

version

Methods

addGuardian

Parameters

Returns Promise<ExecutionResult>

addSigner

Parameters

Returns Promise<ExecutionResult>

approveProposal

Parameters

Returns Promise<ExecutionResult>

approveRecovery

Parameters

Returns Promise<ExecutionResult>

PrivateassertFactory

Returns Contract

ProtectedassertInitialized

Returns ShogunCore

Throws

PrivateassertSigner

Returns Signer

connectWallet

Returns Promise<void>

createWallet

Parameters

Returns Promise<WalletCreateResult>

createWalletWithGuardians

Parameters

Returns Promise<WalletCreateResult>

destroy

Returns void

emit

Parameters

Returns boolean

executeBatch

Parameters

Returns Promise<ExecutionResult>

executeRecovery

Parameters

Returns Promise<ExecutionResult>

executeTransaction

Parameters

Returns Promise<ExecutionResult>

getOwnerWallets

Parameters

Returns Promise<string[]>

getProposalInfo

Parameters

Returns Promise<null | ProposalInfo>

getRecoveryRequest

Parameters

Returns Promise<null | RecoveryRequest>

getWalletInfo

Parameters

Returns Promise<null | WalletInfo>

PrivateinitFactoryContract

Returns void

initialize

Parameters

Returns void

initiateRecovery

`Optional`_category

`Private`config

`Protected`core

`Private`factoryContract

`Private`signer

`Private`assertFactory

`Protected`assertInitialized

`Private`assertSigner

`Private`initFactoryContract

`Private`initProvider