Class SmartWallet

Hierarchy

AbstractClientWallet<SmartWalletConfig, SmartWalletConnectionArgs>
- SmartWallet
  - TokenBoundSmartWallet

Implements

IWalletConnectReceiver

Index

Constructors

constructor

new SmartWallet(options): SmartWallet
Parameters
- options: WalletOptions<SmartWalletConfig>
Returns SmartWallet
Overrides AbstractClientWallet.constructor
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:60

Properties

`Private` #connectParams

#connectParams: undefined | ConnectParams<SmartWalletConnectionArgs>

`Protected` chains

chains: Chain[]

`Optional` connector

connector?: SmartWalletConnector

`Protected` dappMetadata

dappMetadata: DAppMetaData

enableConnectApp

enableConnectApp: boolean = false

`Protected` `Optional` options

options?: WalletOptions<SmartWalletConfig>

type

type: "evm" = "evm"

walletId

walletId: string

`Protected` walletStorage

walletStorage: AsyncStorage

`Protected` wcWallet

wcWallet: WalletConnectHandler

`Static` id

id: string = ...

`Static` meta

meta: {
iconURL: string;
name: string;
} = ...

Type declaration

iconURL: string
name: string

Accessors

walletName

get walletName(): string
Returns string
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:56

Methods

`Private` #connect

#connect(isAutoConnect, connectOptions?): Promise<string>
Parameters
- isAutoConnect: boolean
- Optional connectOptions: ConnectParams<SmartWalletConnectionArgs>
Returns Promise<string>
Inherited from AbstractClientWallet.#connect
- Defined in packages/wallets/src/evm/wallets/base.ts:93

`Private` #subscribeToEvents

#subscribeToEvents(connector): Promise<void>
Parameters
- connector: Connector<{}>
Returns Promise<void>
Inherited from AbstractClientWallet.#subscribeToEvents
- Defined in packages/wallets/src/evm/wallets/base.ts:145

`Private` #trackConnection

#trackConnection(address): void
Parameters
- address: string
Returns void
Inherited from AbstractClientWallet.#trackConnection
- Defined in packages/wallets/src/evm/wallets/base.ts:135

addAdmin

addAdmin(adminAddress): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Add another admin to the smart wallet.
Parameters
- adminAddress: string
  
  the address of the admin to add.
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:307

approveRequest

approveRequest(): Promise<void>
Returns Promise<void>
Implementation of IWalletConnectReceiver.approveRequest
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:370

approveSession

approveSession(): Promise<void>
Returns Promise<void>
Implementation of IWalletConnectReceiver.approveSession
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:360

autoConnect

autoConnect(params): Promise<string>
tries to auto connect to the wallet
Parameters
- params: ConnectParams<SmartWalletConnectionArgs>
Returns Promise<string>
Overrides AbstractClientWallet.autoConnect
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:347

connect

connect(connectOptions?): Promise<string>
connect to the wallet
Parameters
- Optional connectOptions: ConnectParams<SmartWalletConnectionArgs>
Returns Promise<string>
Inherited from AbstractClientWallet.connect
- Defined in packages/wallets/src/evm/wallets/base.ts:78

connectApp

connectApp(uri): Promise<void>
Parameters
- uri: string
Returns Promise<void>
Implementation of IWalletConnectReceiver.connectApp
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:352

createSessionKey

createSessionKey(keyAddress, permissions): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Create and add a session key to the smart wallet.
Parameters
- keyAddress: string
  
  the address of the session key to add.
- permissions: {
      approvedCallTargets: Object;
      expirationDate?: number | Date;
      nativeTokenLimitPerTransaction?: string | number;
      startDate?: number | Date;
  }
  
  the permissions to grant to the session key.
  - approvedCallTargets: Object
  - Optional expirationDate?: number | Date
  - Optional nativeTokenLimitPerTransaction?: string | number
  - Optional startDate?: number | Date
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:286

deploy

deploy(): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Manually deploy the smart wallet contract. If already deployed this will throw an error. Note that this is not necessary as the smart wallet will be deployed automatically on the first transaction the user makes.

Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:257

deployIfNeeded

deployIfNeeded(): Promise<void>
Manually deploy the smart wallet contract. If already deployed this will do nothing. Note that this is not necessary as the smart wallet will be deployed automatically on the first transaction the user makes.

Returns Promise<void>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:267

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from AbstractClientWallet.disconnect
- Defined in packages/wallets/src/evm/wallets/base.ts:176

disconnectSession

disconnectSession(): Promise<void>
Returns Promise<void>
Implementation of IWalletConnectReceiver.disconnectSession
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:388

estimate

estimate(transaction): Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
Estimate the gas cost of a single transaction
Parameters
- transaction: Transaction<any>
Returns Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:189

estimateBatch

estimateBatch(transactions): Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
Estimate the gas cost of a batch of transactions
Parameters
- transactions: Transaction<any>[]
Returns Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:199

estimateBatchRaw

estimateBatchRaw(transactions): Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
Estimate the gas cost of a batch of raw transactions
Parameters
- transactions: Deferrable<TransactionRequest>[]
Returns Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:221

estimateRaw

estimateRaw(transactions): Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
Estimate the gas cost of a single raw transaction
Parameters
- transactions: Deferrable<TransactionRequest>
Returns Promise<{
    details: {
        deployCost: BigNumber;
        deployGasLimit: BigNumber;
        gasPrice: BigNumber;
        totalCost: BigNumber;
        transactionCost: BigNumber;
        transactionGasLimit: BigNumber;
    };
    ether: string;
    wei: BigNumber;
}>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:209

execute

execute(transaction): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Execute a single transaction and wait for confirmations
Parameters
- transaction: Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:131

executeBatch

executeBatch(transactions): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Execute multiple transactions in a single batch and wait for confirmations
Parameters
- transactions: Transaction<any>[]
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:153

executeBatchRaw

executeBatchRaw(transactions): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Execute multiple raw transactions in a single batch and wait for confirmations
Parameters
- transactions: Deferrable<TransactionRequest>[]
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:245

executeRaw

executeRaw(transaction): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Execute a single raw transaction and wait for confirmations
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
the transaction receipt
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:177

getAccountContract

getAccountContract(): Promise<SmartContract<BaseContract>>
Get the underlying account contract of the smart wallet.

Returns Promise<SmartContract<BaseContract>>
the account contract of the smart wallet.
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:333

getActiveSessions

getActiveSessions(): WCSession[]
Returns WCSession[]
Implementation of IWalletConnectReceiver.getActiveSessions
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:378

getAddress

getAddress(): Promise<string>
Returns Promise<string>
the account address from connected wallet
Inherited from AbstractClientWallet.getAddress
- Defined in packages/wallets/src/evm/wallets/abstract.ts:75

getAllActiveSigners

getAllActiveSigners(): Promise<SignerWithPermissions[]>
Get all the admins and session keys active on the smart wallet.

Returns Promise<SignerWithPermissions[]>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:324

getBalance

getBalance(currencyAddress?): Promise<{
    decimals: number;
    displayValue: string;
    name: string;
    symbol: string;
    value: BigNumber;
}>
Parameters
- currencyAddress: string = NATIVE_TOKEN_ADDRESS
Returns Promise<{
    decimals: number;
    displayValue: string;
    name: string;
    symbol: string;
    value: BigNumber;
}>
the native token balance of the connected wallet
Inherited from AbstractClientWallet.getBalance
- Defined in packages/wallets/src/evm/wallets/abstract.ts:83

getChainId

getChainId(): Promise<number>
Returns Promise<number>
the chain id from connected wallet
Inherited from AbstractClientWallet.getChainId
- Defined in packages/wallets/src/evm/wallets/abstract.ts:106

getConnectParams

getConnectParams(): undefined | ConnectParams<SmartWalletConnectionArgs>
Returns undefined | ConnectParams<SmartWalletConnectionArgs>
Inherited from AbstractClientWallet.getConnectParams
- Defined in packages/wallets/src/evm/wallets/base.ts:89

getConnector

getConnector(): Promise<SmartWalletConnector>
Returns Promise<SmartWalletConnector>
Overrides AbstractClientWallet.getConnector
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:84

getFactoryContract

getFactoryContract(): Promise<SmartContract<BaseContract>>
Get the underlying account factory contract of the smart wallet.

Returns Promise<SmartContract<BaseContract>>
the account factory contract.
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:342

getMeta

getMeta(): WalletMeta
Returns WalletMeta
Inherited from AbstractClientWallet.getMeta
- Defined in packages/wallets/src/evm/wallets/base.ts:44

getPersonalWallet

getPersonalWallet(): undefined | EVMWallet
If the wallet uses a personal wallet under the hood, return it

Returns undefined | EVMWallet
Overrides AbstractClientWallet.getPersonalWallet
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:102

getSigner

getSigner(): Promise<Signer>
Returns Promise<Signer>
Inherited from AbstractClientWallet.getSigner
- Defined in packages/wallets/src/evm/wallets/base.ts:168

hasPermissionToExecute

hasPermissionToExecute(transaction): Promise<boolean>
Check whether the connected signer can execute a given transaction using the smart wallet.
Parameters
- transaction: Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
  
  the transaction to execute using the smart wallet.
Returns Promise<boolean>
whether the connected signer can execute the transaction using the smart wallet.
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:111

isDeployed

isDeployed(): Promise<boolean>
Check if the smart wallet contract is deployed

Returns Promise<boolean>
true if the smart wallet contract is deployed
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:276

isWCReceiverEnabled

isWCReceiverEnabled(): boolean
Returns boolean
Implementation of IWalletConnectReceiver.isWCReceiverEnabled
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:392

rejectRequest

rejectRequest(): Promise<void>
Returns Promise<void>
Implementation of IWalletConnectReceiver.rejectRequest
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:374

rejectSession

rejectSession(): Promise<void>
Returns Promise<void>
Implementation of IWalletConnectReceiver.rejectSession
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:366

removeAdmin

removeAdmin(adminAddress): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Remove an admin from the smart wallet.
Parameters
- adminAddress: string
  
  the address of the admin to remove.
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:316

revokeSessionKey

revokeSessionKey(keyAddress): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Remove a session key from the smart wallet.
Parameters
- keyAddress: string
  
  the address of the session key to remove.
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:298

send

send(transaction): Promise<TransactionResponse>
Send a single transaction without waiting for confirmations
Parameters
- transaction: Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
Returns Promise<TransactionResponse>
the transaction result
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:121

sendBatch

sendBatch(transactions): Promise<TransactionResponse>
Send a multiple transaction in a batch without waiting for confirmations
Parameters
- transactions: Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>[]
Returns Promise<TransactionResponse>
the transaction result
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:141

sendBatchRaw

sendBatchRaw(transactions): Promise<TransactionResponse>
Send multiple raw transaction in a batch without waiting for confirmations
Parameters
- transactions: Deferrable<TransactionRequest>[]
Returns Promise<TransactionResponse>
the transaction result
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:233

sendRaw

sendRaw(transaction): Promise<TransactionResponse>
Send a single raw transaction without waiting for confirmations
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<TransactionResponse>
the transaction result
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:165

setupWalletConnectEventsListeners

setupWalletConnectEventsListeners(): void
Returns void
- Defined in packages/wallets/src/evm/wallets/smart-wallet.ts:396

signMessage

signMessage(message): Promise<string>
Parameters
- message: string | Bytes
Returns Promise<string>
the signature of the message
Inherited from AbstractClientWallet.signMessage
- Defined in packages/wallets/src/evm/wallets/abstract.ts:146

switchChain

switchChain(chainId): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
Inherited from AbstractClientWallet.switchChain
- Defined in packages/wallets/src/evm/wallets/base.ts:185

transfer

transfer(to, amount, currencyAddress?): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Parameters
- to: string
- amount: string | number
- currencyAddress: string = NATIVE_TOKEN_ADDRESS
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Inherited from AbstractClientWallet.transfer
- Defined in packages/wallets/src/evm/wallets/abstract.ts:111

updateChains

updateChains(chains): Promise<void>
Parameters
- chains: Chain[]
Returns Promise<void>
Inherited from AbstractClientWallet.updateChains
- Defined in packages/wallets/src/evm/wallets/base.ts:196

verifySignature

verifySignature(message, signature, address, chainId?): Promise<boolean>
verify the signature of a message
Parameters
- message: string
- signature: string
- address: string
- Optional chainId: number
Returns Promise<boolean>
true if the signature is valid, false otherwise
Inherited from AbstractClientWallet.verifySignature
- Defined in packages/wallets/src/evm/wallets/abstract.ts:155

Class SmartWallet

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: WalletOptions<SmartWalletConfig>

Returns SmartWallet

Properties

Private #connectParams

Protected chains

Optional connector

Protected dappMetadata

enableConnectApp

Protected Optional options

type

walletId

Protected walletStorage

Protected wcWallet

Static id

Static meta

Type declaration

iconURL: string

name: string

Accessors

walletName

Returns string

Methods

Private #connect

Parameters

isAutoConnect: boolean

Optional connectOptions: ConnectParams<SmartWalletConnectionArgs>

Returns Promise<string>

Private #subscribeToEvents

Parameters

connector: Connector<{}>

Returns Promise<void>

Private #trackConnection

Parameters

address: string

Returns void

addAdmin

Parameters

adminAddress: string

Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>

approveRequest

Returns Promise<void>

approveSession

Returns Promise<void>

autoConnect

Parameters

params: ConnectParams<SmartWalletConnectionArgs>

Returns Promise<string>

connect

Parameters

Optional connectOptions: ConnectParams<SmartWalletConnectionArgs>

Returns Promise<string>

connectApp

Parameters

uri: string

Returns Promise<void>

createSessionKey

Parameters

keyAddress: string

permissions: { approvedCallTargets: Object; expirationDate?: number | Date; nativeTokenLimitPerTransaction?: string | number; startDate?: number | Date; }

approvedCallTargets: Object

Optional expirationDate?: number | Date

Optional nativeTokenLimitPerTransaction?: string | number

Optional startDate?: number | Date

Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>

deploy

Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>

deployIfNeeded

Returns Promise<void>

disconnect

`Private` #connectParams

`Protected` chains

`Optional` connector

`Protected` dappMetadata

`Protected` `Optional` options

`Protected` walletStorage

`Protected` wcWallet

`Static` id

`Static` meta

`Private` #connect

`Optional` connectOptions: ConnectParams<SmartWalletConnectionArgs>

`Private` #subscribeToEvents

`Private` #trackConnection

`Optional` connectOptions: ConnectParams<SmartWalletConnectionArgs>

permissions: {
approvedCallTargets: Object;
expirationDate?: number | Date;
nativeTokenLimitPerTransaction?: string | number;
startDate?: number | Date;
}

`Optional` expirationDate?: number | Date

`Optional` nativeTokenLimitPerTransaction?: string | number

`Optional` startDate?: number | Date

Returns Promise<{
details: {
deployCost: BigNumber;
deployGasLimit: BigNumber;
gasPrice: BigNumber;
totalCost: BigNumber;
transactionCost: BigNumber;
transactionGasLimit: BigNumber;
};
ether: string;
wei: BigNumber;
}>

Returns Promise<{
details: {
deployCost: BigNumber;
deployGasLimit: BigNumber;
gasPrice: BigNumber;
totalCost: BigNumber;
transactionCost: BigNumber;
transactionGasLimit: BigNumber;
};
ether: string;
wei: BigNumber;
}>

Returns Promise<{
details: {
deployCost: BigNumber;
deployGasLimit: BigNumber;
gasPrice: BigNumber;
totalCost: BigNumber;
transactionCost: BigNumber;
transactionGasLimit: BigNumber;
};
ether: string;
wei: BigNumber;
}>

Returns Promise<{
details: {
deployCost: BigNumber;
deployGasLimit: BigNumber;
gasPrice: BigNumber;
totalCost: BigNumber;
transactionCost: BigNumber;
transactionGasLimit: BigNumber;
};
ether: string;
wei: BigNumber;
}>

Returns Promise<{
decimals: number;
displayValue: string;
name: string;
symbol: string;
value: BigNumber;
}>