Skip to content

OperatorLifecycle.md

Latest commit

 

History

History
666 lines (370 loc) · 19.3 KB

OperatorLifecycle.md

File metadata and controls

666 lines (370 loc) · 19.3 KB
Raw

Defined in: operator/src/OperatorLifecycle.ts:19

OperatorLifecycle - L3 Pattern

Responsibilities:

  1. Managing the complete lifecycle of a Paymaster Operator
  2. Unifying setup (onboard), operation (config), and exit (withdraw)

Extends

Constructors

Constructor

new OperatorLifecycle(config): OperatorLifecycle

Defined in: operator/src/OperatorLifecycle.ts:21

Parameters

Parameter Type
config OperatorClientConfig

Returns

OperatorLifecycle

Overrides

PaymasterOperatorClient.constructor

Properties

client

client: WalletClient

Defined in: core/dist/clients/BaseClient.d.ts:5

Inherited from

PaymasterOperatorClient.client

entryPointAddress?

protected optional entryPointAddress: `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:11

Inherited from

PaymasterOperatorClient.entryPointAddress

ethUsdPriceFeed

ethUsdPriceFeed: `0x${string}`

Defined in: operator/src/PaymasterOperatorClient.ts:23

Inherited from

PaymasterOperatorClient.ethUsdPriceFeed

gTokenAddress?

protected optional gTokenAddress: `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:8

Inherited from

PaymasterOperatorClient.gTokenAddress

gTokenStakingAddress?

protected optional gTokenStakingAddress: `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:9

Inherited from

PaymasterOperatorClient.gTokenStakingAddress

paymasterFactoryAddress?

protected optional paymasterFactoryAddress: `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:10

Inherited from

PaymasterOperatorClient.paymasterFactoryAddress

publicClient?

optional publicClient: PublicClient

Defined in: core/dist/clients/BaseClient.d.ts:6

Inherited from

PaymasterOperatorClient.publicClient

registryAddress?

protected optional registryAddress: `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:7

Inherited from

PaymasterOperatorClient.registryAddress

superPaymasterAddress

superPaymasterAddress: `0x${string}`

Defined in: operator/src/PaymasterOperatorClient.ts:21

Inherited from

PaymasterOperatorClient.superPaymasterAddress

tokenAddress?

optional tokenAddress: `0x${string}`

Defined in: operator/src/PaymasterOperatorClient.ts:22

Inherited from

PaymasterOperatorClient.tokenAddress

xpntsFactory

xpntsFactory: `0x${string}`

Defined in: operator/src/PaymasterOperatorClient.ts:24

Inherited from

PaymasterOperatorClient.xpntsFactory

Methods

addGasToken()

addGasToken(token, price, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:409

Parameters

Parameter Type
token `0x${string}`
price bigint
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.addGasToken

checkReadiness()

checkReadiness(): Promise<OperatorStatus>

Defined in: operator/src/OperatorLifecycle.ts:33

Check if the account is ready to become an operator (e.g., has GToken, has ROLE_COMMUNITY, etc.)

Returns

Promise<OperatorStatus>

configureOperator()

configureOperator(xPNTsToken?, treasury?, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:324

Configure operator parameters (Token, Treasury). Exchange rate is now read live from xPNTsToken.exchangeRate() at runtime. If parameters are undefined, existing values are preserved.

Parameters

Parameter Type
xPNTsToken? `0x${string}`
treasury? `0x${string}`
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.configureOperator

deployAndRegisterPaymasterV4()

deployAndRegisterPaymasterV4(params?, options?): Promise<{ deployHash: `0x${string}`; paymasterAddress: `0x${string}`; registerHash: `0x${string}`; }>

Defined in: operator/src/PaymasterOperatorClient.ts:142

Deploy a new Paymaster V4 and Register as AOA Operator (one-stop API). This method handles:

  1. Checks prerequisites (ROLE_COMMUNITY)
  2. Predicts new Paymaster address
  3. Deploys Paymaster V4 via Factory
  4. Registers ROLE_PAYMASTER_AOA with staking

Parameters

Parameter Type Description
params? { priceFeed?: `0x${string}`; salt?: bigint; stakeAmount?: bigint; version?: string; } Deployment parameters
params.priceFeed? `0x${string}` -
params.salt? bigint -
params.stakeAmount? bigint -
params.version? string -
options? TransactionOptions Transaction options

Returns

Promise<{ deployHash: `0x${string}`; paymasterAddress: `0x${string}`; registerHash: `0x${string}`; }>

Object containing new paymaster address and transaction hashes

Inherited from

PaymasterOperatorClient.deployAndRegisterPaymasterV4

depositCollateral()

depositCollateral(amount, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:283

Deposit collateral (aPNTs/GToken) to SuperPaymaster. This is a helper method used by registerAsSuperPaymasterOperator.

Parameters

Parameter Type
amount bigint
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.depositCollateral

getAddress()

getAddress(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:16

Get the account address of the connected wallet

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.getAddress

getOperatorDetails()

getOperatorDetails(operator?): Promise<any>

Defined in: operator/src/PaymasterOperatorClient.ts:372

Parameters

Parameter Type
operator? `0x${string}`

Returns

Promise<any>

Inherited from

PaymasterOperatorClient.getOperatorDetails

getOperatorStats()

getOperatorStats(): Promise<any>

Defined in: operator/src/OperatorLifecycle.ts:93

Returns

Promise<any>

getStartPublicClient()

getStartPublicClient(): PublicClient | WalletClient<Transport, Chain | undefined, Account | undefined>

Defined in: core/dist/clients/BaseClient.d.ts:20

Helper to ensure public client exists or fallback to wallet client (if it supports read)

Returns

PublicClient | WalletClient<Transport, Chain | undefined, Account | undefined>

Inherited from

PaymasterOperatorClient.getStartPublicClient

getTokenPrice()

getTokenPrice(token): Promise<bigint>

Defined in: operator/src/PaymasterOperatorClient.ts:422

Parameters

Parameter Type
token `0x${string}`

Returns

Promise<bigint>

Inherited from

PaymasterOperatorClient.getTokenPrice

initiateExit()

initiateExit(options?): Promise<`0x${string}`>

Defined in: operator/src/OperatorLifecycle.ts:104

Start the exit process: Unstake from Registry/SuperPaymaster and Unlock funds

Parameters

Parameter Type
options? TransactionOptions

Returns

Promise<`0x${string}`>

Overrides

PaymasterOperatorClient.initiateExit

isOperator()

isOperator(operator): Promise<boolean>

Defined in: operator/src/PaymasterOperatorClient.ts:362

Parameters

Parameter Type
operator `0x${string}`

Returns

Promise<boolean>

Inherited from

PaymasterOperatorClient.isOperator

registerAsSuperPaymasterOperator()

registerAsSuperPaymasterOperator(params?, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:50

Register as SuperPaymaster Operator (one-stop API). This method handles all necessary steps:

  1. Checks prerequisites (must have ROLE_COMMUNITY)
  2. Checks and approves GToken to GTokenStaking
  3. Registers ROLE_PAYMASTER_SUPER
  4. Optionally deposits collateral to SuperPaymaster

Parameters

Parameter Type Description
params? { depositAmount?: bigint; stakeAmount?: bigint; } Registration parameters
params.depositAmount? bigint -
params.stakeAmount? bigint -
options? TransactionOptions Transaction options

Returns

Promise<`0x${string}`>

Transaction hash of role registration

Inherited from

PaymasterOperatorClient.registerAsSuperPaymasterOperator

requireEntryPoint()

protected requireEntryPoint(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:25

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.requireEntryPoint

requireGToken()

protected requireGToken(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:22

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.requireGToken

requireGTokenStaking()

protected requireGTokenStaking(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:23

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.requireGTokenStaking

requirePaymasterFactory()

protected requirePaymasterFactory(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:24

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.requirePaymasterFactory

requireRegistry()

protected requireRegistry(): `0x${string}`

Defined in: core/dist/clients/BaseClient.d.ts:21

Returns

`0x${string}`

Inherited from

PaymasterOperatorClient.requireRegistry

setupNode()

setupNode(params, options?): Promise<`0x${string}`[]>

Defined in: operator/src/OperatorLifecycle.ts:50

One-click Setup: Register + Deposit + Deploy Node Wraps existing registerAsSuperPaymasterOperator or deployAndRegisterPaymasterV4

Parameters

Parameter Type
params { depositAmount?: bigint; stakeAmount?: bigint; type: "V4" | "SUPER"; }
params.depositAmount? bigint
params.stakeAmount? bigint
params.type? "V4" | "SUPER"
options? TransactionOptions

Returns

Promise<`0x${string}`[]>

setupPaymasterDeposit()

setupPaymasterDeposit(params, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:431

Parameters

Parameter Type
params { amount: bigint; paymaster: `0x${string}`; token: `0x${string}`; user: `0x${string}`; }
params.amount bigint
params.paymaster? `0x${string}`
params.token? `0x${string}`
params.user? `0x${string}`
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.setupPaymasterDeposit

withdrawAllFunds()

withdrawAllFunds(to?, options?): Promise<`0x${string}`[]>

Defined in: operator/src/OperatorLifecycle.ts:112

Finalize exit: Withdraw all funds (Collateral + Rewards)

Parameters

Parameter Type
to? `0x${string}`
options? TransactionOptions

Returns

Promise<`0x${string}`[]>

withdrawCollateral()

withdrawCollateral(to, amount, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:349

Parameters

Parameter Type
to `0x${string}`
amount bigint
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.withdrawCollateral

withdrawStake()

withdrawStake(to, options?): Promise<`0x${string}`>

Defined in: operator/src/PaymasterOperatorClient.ts:393

Parameters

Parameter Type
to `0x${string}`
options? TransactionOptions

Returns

Promise<`0x${string}`>

Inherited from

PaymasterOperatorClient.withdrawStake