contracts/handlers/puf-locker-handler
Classes
PufLockerHandler
Handler for the PufLocker contract exposing methods to interact
with the contract.
Constructors
new PufLockerHandler()
new PufLockerHandler(
chain,walletClient,publicClient):PufLockerHandler
Create the handler for the PufLocker contract exposing methods to
interact with the contract.
Parameters
| Parameter | Type | Description |
|---|---|---|
chain | Chain | Chain to use for the client. |
walletClient | object | The wallet client to use for wallet interactions. |
publicClient | object | The public client to use for public interactions. |
Returns
Source
lib/contracts/handlers/puf-locker-handler.ts:42
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
chain | private | Chain | Chain to use for the client. |
erc20PermitHandler | private | ERC20PermitHandler | - |
publicClient | private | object | The public client to use for public interactions. |
viemChain | private | Chain | - |
walletClient | private | object | The wallet client to use for wallet interactions. |
Methods
deposit()
deposit(
depositParams):Promise<object>
Deposit the given PufToken into the locker. This doesn't make the
transaction but returns two methods namely transact and
estimate.
Parameters
| Parameter | Type |
|---|---|
depositParams | LockerDepositParams |
Returns
Promise<object>
transact: () => Promise<Address> - Used to make the
transaction.
estimate: () => Promise<bigint> - Gas estimate of the
transaction.
estimate()
estimate: () =>
Promise<bigint>
Returns
Promise<bigint>
transact()
transact: () =>
Promise<`0x${string}`>
Returns
Promise<`0x${string}`>
Source
lib/contracts/handlers/puf-locker-handler.ts:139
getAllDeposits()
getAllDeposits(
pufToken,walletAddress):Promise<readonlyobject[]>
Get all deposits of the given account address.
Parameters
| Parameter | Type | Description |
|---|---|---|
pufToken | unifiETH | The PufToken to get the deposits for. |
walletAddress | `0x${string}` | The wallet address to get the deposits for. |
Returns
Promise<readonly object[]>
The amount and deposits of the given account address.
Source
lib/contracts/handlers/puf-locker-handler.ts:80
getContract()
getContract():
object
Get the contract. This is a method because the typings are complex and lost when trying to make it a member.
Returns
object
The viem contract.
Source
lib/contracts/handlers/puf-locker-handler.ts:61
getDeposits()
getDeposits(
pufToken,userAddress,start,limit):Promise<readonlyobject[]>
Get the user's deposits for the given token and deposit index.
Parameters
| Parameter | Type | Description |
|---|---|---|
pufToken | unifiETH | PufToken to get the deposits of. |
userAddress | `0x${string}` | User address to get the deposits for. |
start | bigint | The starting index of the deposits. |
limit | bigint | The maximum number of deposits to retrieve. |
Returns
Promise<readonly object[]>
The amount and release time of the deposits.
Source
lib/contracts/handlers/puf-locker-handler.ts:96
getLockPeriods()
getLockPeriods():
Promise<readonly [bigint,bigint]>
Get the minimum and maximum lock periods allowed for deposits.
Returns
Promise<readonly [bigint, bigint]>
The minimum and maximum lock period in seconds.
([minLock, maxLock])
Source
lib/contracts/handlers/puf-locker-handler.ts:116
withdraw()
withdraw(
pufToken,walletAddress,recipient,depositIndexes):object
Withdraw the deposits identified by the deposit indexes from the locker.
Parameters
| Parameter | Type | Description |
|---|---|---|
pufToken | unifiETH | PufToken to withdraw. |
walletAddress | `0x${string}` | Address of the account making the transaction. |
recipient | `0x${string}` | Recipient of the withdrawal. |
depositIndexes | bigint[] | Deposit indexes to withdraw. |
Returns
object
Hash of the withdrawal transaction.
estimate()
estimate: () =>
Promise<bigint>
Returns
Promise<bigint>
transact()
transact: () =>
Promise<`0x${string}`>
Returns
Promise<`0x${string}`>
Source
lib/contracts/handlers/puf-locker-handler.ts:207
Type Aliases
LockerDepositParams
LockerDepositParams:
object
Type declaration
account
account:
Address
isPreapproved?
optionalisPreapproved:boolean
lockPeriod
lockPeriod:
bigint
recipient
recipient:
Address
token
token:
UnifiToken
value
value:
bigint