From cab016a76b0787789a74c42ee903c5963f35ad54 Mon Sep 17 00:00:00 2001 From: guestn Date: Tue, 5 Nov 2024 11:44:36 +0000 Subject: [PATCH] [Github Actions] Release v1.9.0 --- docs/docs/api/api/puffer-client-helpers.md | 8 +- docs/docs/api/api/puffer-client.md | 5 +- docs/docs/api/chains/constants.md | 2 +- .../contracts/abis/holesky/PufferDepositor.md | 2 +- .../contracts/abis/holesky/PufferVaultV2.md | 2 +- .../contracts/abis/l1-reward-manager-abis.md | 2 +- .../contracts/abis/l2-reward-manager-abis.md | 2 +- .../api/contracts/abis/mainnet/Accountant.md | 2 +- .../contracts/abis/mainnet/AtomicQueue-1.md | 7 + .../api/contracts/abis/mainnet/AtomicQueue.md | 11 + .../api/contracts/abis/mainnet/BoringVault.md | 2 +- .../api/contracts/abis/mainnet/ERC20Permit.md | 2 +- .../contracts/abis/mainnet/L1RewardManager.md | 2 +- .../contracts/abis/mainnet/L2RewardManager.md | 2 +- .../api/contracts/abis/mainnet/PufLocker.md | 2 +- .../contracts/abis/mainnet/PufferDepositor.md | 2 +- .../abis/mainnet/PufferL2Depositor.md | 2 +- .../contracts/abis/mainnet/PufferVaultV2.md | 2 +- .../abis/mainnet/PufferWithdrawalManager.md | 2 +- .../docs/api/contracts/abis/mainnet/Teller.md | 2 +- .../contracts/abis/nucleus-accountant-abis.md | 2 +- .../abis/nucleus-atomic-queue-abis-1.md | 7 + .../abis/nucleus-atomic-queue-abis.md | 11 + .../abis/nucleus-boring-vault-abis.md | 2 +- .../api/contracts/abis/nucleus-teller-abis.md | 2 +- .../api/contracts/abis/puf-locker-abis.md | 2 +- .../contracts/abis/puffer-depositor-abis.md | 4 +- .../api/contracts/abis/puffer-vault-abis.md | 2 +- .../abis/puffer-withdrawal-manager-abis.md | 2 +- docs/docs/api/contracts/abis/tokens-abis.md | 2 +- docs/docs/api/contracts/addresses.md | 2 +- .../handlers/erc20-permit-handler.md | 14 +- .../handlers/l1-reward-manager-handler.md | 8 +- .../handlers/l2-reward-manager-handler.md | 22 +- .../handlers/nucleus-accountant-handler.md | 16 +- .../nucleus-atomic-queue-handler-1.md | 15 ++ .../handlers/nucleus-atomic-queue-handler.md | 237 ++++++++++++++++++ .../handlers/nucleus-boring-vault-handler.md | 22 +- .../handlers/nucleus-teller-handler.md | 22 +- .../contracts/handlers/puf-locker-handler.md | 16 +- .../handlers/puffer-depositor-handler.md | 8 +- .../handlers/puffer-l2-depositor-handler.md | 8 +- .../handlers/puffer-vault-handler.md | 26 +- .../puffer-withdrawal-manager-handler.md | 12 +- docs/docs/api/contracts/tokens.md | 8 +- docs/docs/api/errors/base-error.md | 4 +- docs/docs/api/errors/types.md | 2 +- docs/docs/api/errors/validation-errors.md | 8 +- docs/docs/api/index.md | 7 + docs/docs/api/utils/time.md | 2 +- docs/docs/api/utils/types.md | 4 +- docs/docs/api/utils/version.md | 2 +- package.json | 2 +- 53 files changed, 431 insertions(+), 135 deletions(-) create mode 100644 docs/docs/api/contracts/abis/mainnet/AtomicQueue-1.md create mode 100644 docs/docs/api/contracts/abis/mainnet/AtomicQueue.md create mode 100644 docs/docs/api/contracts/abis/nucleus-atomic-queue-abis-1.md create mode 100644 docs/docs/api/contracts/abis/nucleus-atomic-queue-abis.md create mode 100644 docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler-1.md create mode 100644 docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler.md diff --git a/docs/docs/api/api/puffer-client-helpers.md b/docs/docs/api/api/puffer-client-helpers.md index 12a3463..680de85 100644 --- a/docs/docs/api/api/puffer-client-helpers.md +++ b/docs/docs/api/api/puffer-client-helpers.md @@ -39,7 +39,7 @@ The public client created with viem. ###### Source -[lib/api/puffer-client-helpers.ts:33](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client-helpers.ts#L33) +[lib/api/puffer-client-helpers.ts:33](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client-helpers.ts#L33) ##### createWalletClient() @@ -62,7 +62,7 @@ The wallet client created with viem. ###### Source -[lib/api/puffer-client-helpers.ts:47](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client-helpers.ts#L47) +[lib/api/puffer-client-helpers.ts:47](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client-helpers.ts#L47) ##### extractTransportConfig() @@ -80,7 +80,7 @@ The wallet client created with viem. ###### Source -[lib/api/puffer-client-helpers.ts:54](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client-helpers.ts#L54) +[lib/api/puffer-client-helpers.ts:54](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client-helpers.ts#L54) ## Type Aliases @@ -96,4 +96,4 @@ The wallet client created with viem. #### Source -[lib/api/puffer-client-helpers.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client-helpers.ts#L15) +[lib/api/puffer-client-helpers.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client-helpers.ts#L15) diff --git a/docs/docs/api/api/puffer-client.md b/docs/docs/api/api/puffer-client.md index 1bd395c..026ceeb 100644 --- a/docs/docs/api/api/puffer-client.md +++ b/docs/docs/api/api/puffer-client.md @@ -28,7 +28,7 @@ Create the Puffer Client. ###### Source -[lib/api/puffer-client.ts:61](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client.ts#L61) +[lib/api/puffer-client.ts:64](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client.ts#L64) #### Properties @@ -40,6 +40,7 @@ Create the Puffer Client. | `l2Depositor` | `public` | [`PufferL2DepositorHandler`](../contracts/handlers/puffer-l2-depositor-handler.md#pufferl2depositorhandler) | Handler for the `PufferL2Depositor` contract. | | `l2RewardManager` | `public` | [`L2RewardManagerHandler`](../contracts/handlers/l2-reward-manager-handler.md#l2rewardmanagerhandler) | Handler for the `L2RewardManager` contract. | | `nucleusAccountant` | `public` | [`NucleusAccountantHandler`](../contracts/handlers/nucleus-accountant-handler.md#nucleusaccountanthandler) | Handler for the `NucleusAccountant` contract. | +| `nucleusAtomicQueue` | `public` | [`NucleusAtomicQueueHandler`](../contracts/handlers/nucleus-atomic-queue-handler.md#nucleusatomicqueuehandler) | Handler for the `NucleusAtomicQueue` contract. | | `nucleusBoringVault` | `public` | [`NucleusBoringVaultHandler`](../contracts/handlers/nucleus-boring-vault-handler.md#nucleusboringvaulthandler) | Handler for the `NucleusBoringVault` contract. | | `nucleusTeller` | `public` | [`NucleusTellerHandler`](../contracts/handlers/nucleus-teller-handler.md#nucleustellerhandler) | Handler for the `NucleusTeller` contract. | | `publicClient` | `private` | `object` | - | @@ -64,4 +65,4 @@ An array of wallet addresses. ###### Source -[lib/api/puffer-client.ts:144](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/api/puffer-client.ts#L144) +[lib/api/puffer-client.ts:152](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/api/puffer-client.ts#L152) diff --git a/docs/docs/api/chains/constants.md b/docs/docs/api/chains/constants.md index eb5b0a7..2dd686d 100644 --- a/docs/docs/api/chains/constants.md +++ b/docs/docs/api/chains/constants.md @@ -21,4 +21,4 @@ #### Source -[lib/chains/constants.ts:11](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/chains/constants.ts#L11) +[lib/chains/constants.ts:11](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/chains/constants.ts#L11) diff --git a/docs/docs/api/contracts/abis/holesky/PufferDepositor.md b/docs/docs/api/contracts/abis/holesky/PufferDepositor.md index 72ab906..66a5829 100644 --- a/docs/docs/api/contracts/abis/holesky/PufferDepositor.md +++ b/docs/docs/api/contracts/abis/holesky/PufferDepositor.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/holesky/PufferDepositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/holesky/PufferDepositor.ts#L1) +[lib/contracts/abis/holesky/PufferDepositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/holesky/PufferDepositor.ts#L1) diff --git a/docs/docs/api/contracts/abis/holesky/PufferVaultV2.md b/docs/docs/api/contracts/abis/holesky/PufferVaultV2.md index 5c692d3..8678f2f 100644 --- a/docs/docs/api/contracts/abis/holesky/PufferVaultV2.md +++ b/docs/docs/api/contracts/abis/holesky/PufferVaultV2.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/holesky/PufferVaultV2.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/holesky/PufferVaultV2.ts#L1) +[lib/contracts/abis/holesky/PufferVaultV2.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/holesky/PufferVaultV2.ts#L1) diff --git a/docs/docs/api/contracts/abis/l1-reward-manager-abis.md b/docs/docs/api/contracts/abis/l1-reward-manager-abis.md index ed45a91..813122b 100644 --- a/docs/docs/api/contracts/abis/l1-reward-manager-abis.md +++ b/docs/docs/api/contracts/abis/l1-reward-manager-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/l1-reward-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/l1-reward-manager-abis.ts#L4) +[lib/contracts/abis/l1-reward-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/l1-reward-manager-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/l2-reward-manager-abis.md b/docs/docs/api/contracts/abis/l2-reward-manager-abis.md index 7620e7b..1e67455 100644 --- a/docs/docs/api/contracts/abis/l2-reward-manager-abis.md +++ b/docs/docs/api/contracts/abis/l2-reward-manager-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/l2-reward-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/l2-reward-manager-abis.ts#L4) +[lib/contracts/abis/l2-reward-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/l2-reward-manager-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/mainnet/Accountant.md b/docs/docs/api/contracts/abis/mainnet/Accountant.md index 9e2131a..d627537 100644 --- a/docs/docs/api/contracts/abis/mainnet/Accountant.md +++ b/docs/docs/api/contracts/abis/mainnet/Accountant.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/Accountant.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/Accountant.ts#L1) +[lib/contracts/abis/mainnet/Accountant.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/Accountant.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/AtomicQueue-1.md b/docs/docs/api/contracts/abis/mainnet/AtomicQueue-1.md new file mode 100644 index 0000000..974e4b0 --- /dev/null +++ b/docs/docs/api/contracts/abis/mainnet/AtomicQueue-1.md @@ -0,0 +1,7 @@ +# contracts/abis/mainnet/AtomicQueue + +## References + +### AtomicQueue + +Re-exports [AtomicQueue](AtomicQueue.md#atomicqueue) diff --git a/docs/docs/api/contracts/abis/mainnet/AtomicQueue.md b/docs/docs/api/contracts/abis/mainnet/AtomicQueue.md new file mode 100644 index 0000000..77d0f6d --- /dev/null +++ b/docs/docs/api/contracts/abis/mainnet/AtomicQueue.md @@ -0,0 +1,11 @@ +# contracts/abis/mainnet/AtomicQueue + +## Variables + +### AtomicQueue + +> `const` **AtomicQueue**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] + +#### Source + +[lib/contracts/abis/mainnet/AtomicQueue.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/AtomicQueue.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/BoringVault.md b/docs/docs/api/contracts/abis/mainnet/BoringVault.md index ba9b4cd..7655e27 100644 --- a/docs/docs/api/contracts/abis/mainnet/BoringVault.md +++ b/docs/docs/api/contracts/abis/mainnet/BoringVault.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/BoringVault.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/BoringVault.ts#L1) +[lib/contracts/abis/mainnet/BoringVault.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/BoringVault.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/ERC20Permit.md b/docs/docs/api/contracts/abis/mainnet/ERC20Permit.md index d21552a..e629870 100644 --- a/docs/docs/api/contracts/abis/mainnet/ERC20Permit.md +++ b/docs/docs/api/contracts/abis/mainnet/ERC20Permit.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/ERC20Permit.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/ERC20Permit.ts#L1) +[lib/contracts/abis/mainnet/ERC20Permit.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/ERC20Permit.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/L1RewardManager.md b/docs/docs/api/contracts/abis/mainnet/L1RewardManager.md index 5eba431..bacf3b2 100644 --- a/docs/docs/api/contracts/abis/mainnet/L1RewardManager.md +++ b/docs/docs/api/contracts/abis/mainnet/L1RewardManager.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/L1RewardManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/L1RewardManager.ts#L1) +[lib/contracts/abis/mainnet/L1RewardManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/L1RewardManager.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/L2RewardManager.md b/docs/docs/api/contracts/abis/mainnet/L2RewardManager.md index 02db869..9cbb0d4 100644 --- a/docs/docs/api/contracts/abis/mainnet/L2RewardManager.md +++ b/docs/docs/api/contracts/abis/mainnet/L2RewardManager.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/L2RewardManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/L2RewardManager.ts#L1) +[lib/contracts/abis/mainnet/L2RewardManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/L2RewardManager.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/PufLocker.md b/docs/docs/api/contracts/abis/mainnet/PufLocker.md index 358b5b3..04778f4 100644 --- a/docs/docs/api/contracts/abis/mainnet/PufLocker.md +++ b/docs/docs/api/contracts/abis/mainnet/PufLocker.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/PufLocker.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/PufLocker.ts#L1) +[lib/contracts/abis/mainnet/PufLocker.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/PufLocker.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/PufferDepositor.md b/docs/docs/api/contracts/abis/mainnet/PufferDepositor.md index f78b11a..2de02de 100644 --- a/docs/docs/api/contracts/abis/mainnet/PufferDepositor.md +++ b/docs/docs/api/contracts/abis/mainnet/PufferDepositor.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/PufferDepositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/PufferDepositor.ts#L1) +[lib/contracts/abis/mainnet/PufferDepositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/PufferDepositor.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/PufferL2Depositor.md b/docs/docs/api/contracts/abis/mainnet/PufferL2Depositor.md index 51e4f36..3238986 100644 --- a/docs/docs/api/contracts/abis/mainnet/PufferL2Depositor.md +++ b/docs/docs/api/contracts/abis/mainnet/PufferL2Depositor.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/PufferL2Depositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/PufferL2Depositor.ts#L1) +[lib/contracts/abis/mainnet/PufferL2Depositor.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/PufferL2Depositor.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/PufferVaultV2.md b/docs/docs/api/contracts/abis/mainnet/PufferVaultV2.md index ff0918a..a066b76 100644 --- a/docs/docs/api/contracts/abis/mainnet/PufferVaultV2.md +++ b/docs/docs/api/contracts/abis/mainnet/PufferVaultV2.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/PufferVaultV2.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/PufferVaultV2.ts#L1) +[lib/contracts/abis/mainnet/PufferVaultV2.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/PufferVaultV2.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/PufferWithdrawalManager.md b/docs/docs/api/contracts/abis/mainnet/PufferWithdrawalManager.md index a97bf58..9485b7b 100644 --- a/docs/docs/api/contracts/abis/mainnet/PufferWithdrawalManager.md +++ b/docs/docs/api/contracts/abis/mainnet/PufferWithdrawalManager.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/PufferWithdrawalManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/PufferWithdrawalManager.ts#L1) +[lib/contracts/abis/mainnet/PufferWithdrawalManager.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/PufferWithdrawalManager.ts#L1) diff --git a/docs/docs/api/contracts/abis/mainnet/Teller.md b/docs/docs/api/contracts/abis/mainnet/Teller.md index 3d73d27..b65fee0 100644 --- a/docs/docs/api/contracts/abis/mainnet/Teller.md +++ b/docs/docs/api/contracts/abis/mainnet/Teller.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/mainnet/Teller.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/mainnet/Teller.ts#L1) +[lib/contracts/abis/mainnet/Teller.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/mainnet/Teller.ts#L1) diff --git a/docs/docs/api/contracts/abis/nucleus-accountant-abis.md b/docs/docs/api/contracts/abis/nucleus-accountant-abis.md index 6697305..c087b3f 100644 --- a/docs/docs/api/contracts/abis/nucleus-accountant-abis.md +++ b/docs/docs/api/contracts/abis/nucleus-accountant-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/nucleus-accountant-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/nucleus-accountant-abis.ts#L4) +[lib/contracts/abis/nucleus-accountant-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/nucleus-accountant-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis-1.md b/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis-1.md new file mode 100644 index 0000000..0d6aa57 --- /dev/null +++ b/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis-1.md @@ -0,0 +1,7 @@ +# contracts/abis/nucleus-atomic-queue-abis + +## References + +### NUCLEUS\_ATOMIC\_QUEUE\_ABIS + +Re-exports [NUCLEUS_ATOMIC_QUEUE_ABIS](nucleus-atomic-queue-abis.md#nucleus_atomic_queue_abis) diff --git a/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis.md b/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis.md new file mode 100644 index 0000000..b2d8f44 --- /dev/null +++ b/docs/docs/api/contracts/abis/nucleus-atomic-queue-abis.md @@ -0,0 +1,11 @@ +# contracts/abis/nucleus-atomic-queue-abis + +## Variables + +### NUCLEUS\_ATOMIC\_QUEUE\_ABIS + +> `const` **NUCLEUS\_ATOMIC\_QUEUE\_ABIS**: `object` + +#### Source + +[lib/contracts/abis/nucleus-atomic-queue-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/nucleus-atomic-queue-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/nucleus-boring-vault-abis.md b/docs/docs/api/contracts/abis/nucleus-boring-vault-abis.md index 50381ef..94ae871 100644 --- a/docs/docs/api/contracts/abis/nucleus-boring-vault-abis.md +++ b/docs/docs/api/contracts/abis/nucleus-boring-vault-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/nucleus-boring-vault-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/nucleus-boring-vault-abis.ts#L4) +[lib/contracts/abis/nucleus-boring-vault-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/nucleus-boring-vault-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/nucleus-teller-abis.md b/docs/docs/api/contracts/abis/nucleus-teller-abis.md index f3941d3..c91b96d 100644 --- a/docs/docs/api/contracts/abis/nucleus-teller-abis.md +++ b/docs/docs/api/contracts/abis/nucleus-teller-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/nucleus-teller-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/nucleus-teller-abis.ts#L4) +[lib/contracts/abis/nucleus-teller-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/nucleus-teller-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/puf-locker-abis.md b/docs/docs/api/contracts/abis/puf-locker-abis.md index c7f1e6f..8bba2a0 100644 --- a/docs/docs/api/contracts/abis/puf-locker-abis.md +++ b/docs/docs/api/contracts/abis/puf-locker-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/puf-locker-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/puf-locker-abis.ts#L4) +[lib/contracts/abis/puf-locker-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/puf-locker-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/puffer-depositor-abis.md b/docs/docs/api/contracts/abis/puffer-depositor-abis.md index dd912b3..eead70c 100644 --- a/docs/docs/api/contracts/abis/puffer-depositor-abis.md +++ b/docs/docs/api/contracts/abis/puffer-depositor-abis.md @@ -8,7 +8,7 @@ #### Source -[lib/contracts/abis/puffer-depositor-abis.ts:6](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/puffer-depositor-abis.ts#L6) +[lib/contracts/abis/puffer-depositor-abis.ts:6](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/puffer-depositor-abis.ts#L6) *** @@ -18,4 +18,4 @@ #### Source -[lib/contracts/abis/puffer-depositor-abis.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/puffer-depositor-abis.ts#L15) +[lib/contracts/abis/puffer-depositor-abis.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/puffer-depositor-abis.ts#L15) diff --git a/docs/docs/api/contracts/abis/puffer-vault-abis.md b/docs/docs/api/contracts/abis/puffer-vault-abis.md index 96501de..a2ed32c 100644 --- a/docs/docs/api/contracts/abis/puffer-vault-abis.md +++ b/docs/docs/api/contracts/abis/puffer-vault-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/puffer-vault-abis.ts:5](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/puffer-vault-abis.ts#L5) +[lib/contracts/abis/puffer-vault-abis.ts:5](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/puffer-vault-abis.ts#L5) diff --git a/docs/docs/api/contracts/abis/puffer-withdrawal-manager-abis.md b/docs/docs/api/contracts/abis/puffer-withdrawal-manager-abis.md index fa2c59c..1285934 100644 --- a/docs/docs/api/contracts/abis/puffer-withdrawal-manager-abis.md +++ b/docs/docs/api/contracts/abis/puffer-withdrawal-manager-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/puffer-withdrawal-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/puffer-withdrawal-manager-abis.ts#L4) +[lib/contracts/abis/puffer-withdrawal-manager-abis.ts:4](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/puffer-withdrawal-manager-abis.ts#L4) diff --git a/docs/docs/api/contracts/abis/tokens-abis.md b/docs/docs/api/contracts/abis/tokens-abis.md index ded0497..0227584 100644 --- a/docs/docs/api/contracts/abis/tokens-abis.md +++ b/docs/docs/api/contracts/abis/tokens-abis.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/abis/tokens-abis.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/abis/tokens-abis.ts#L3) +[lib/contracts/abis/tokens-abis.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/abis/tokens-abis.ts#L3) diff --git a/docs/docs/api/contracts/addresses.md b/docs/docs/api/contracts/addresses.md index 2f99c48..42a6d04 100644 --- a/docs/docs/api/contracts/addresses.md +++ b/docs/docs/api/contracts/addresses.md @@ -8,4 +8,4 @@ #### Source -[lib/contracts/addresses.ts:5](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/addresses.ts#L5) +[lib/contracts/addresses.ts:5](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/addresses.ts#L5) diff --git a/docs/docs/api/contracts/handlers/erc20-permit-handler.md b/docs/docs/api/contracts/handlers/erc20-permit-handler.md index 05d02a4..3104579 100644 --- a/docs/docs/api/contracts/handlers/erc20-permit-handler.md +++ b/docs/docs/api/contracts/handlers/erc20-permit-handler.md @@ -28,7 +28,7 @@ Create the handler for processing tokens. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:36](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L36) +[lib/contracts/handlers/erc20-permit-handler.ts:36](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L36) #### Properties @@ -64,7 +64,7 @@ Hash of the transaction. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:136](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L136) +[lib/contracts/handlers/erc20-permit-handler.ts:136](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L136) ##### getContract() @@ -81,7 +81,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:62](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L62) +[lib/contracts/handlers/erc20-permit-handler.ts:62](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L62) ##### getPermitSalt() @@ -99,7 +99,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:151](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L151) +[lib/contracts/handlers/erc20-permit-handler.ts:151](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L151) ##### getPermitSignature() @@ -124,7 +124,7 @@ Permit signature in the form `{ r, s, v?, yParity }`. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:83](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L83) +[lib/contracts/handlers/erc20-permit-handler.ts:83](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L83) ##### getPermitVersion() @@ -142,7 +142,7 @@ Permit signature in the form `{ r, s, v?, yParity }`. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:147](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L147) +[lib/contracts/handlers/erc20-permit-handler.ts:147](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L147) ##### withToken() @@ -164,4 +164,4 @@ The handler. ###### Source -[lib/contracts/handlers/erc20-permit-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/erc20-permit-handler.ts#L51) +[lib/contracts/handlers/erc20-permit-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/erc20-permit-handler.ts#L51) diff --git a/docs/docs/api/contracts/handlers/l1-reward-manager-handler.md b/docs/docs/api/contracts/handlers/l1-reward-manager-handler.md index 74f82ee..8679570 100644 --- a/docs/docs/api/contracts/handlers/l1-reward-manager-handler.md +++ b/docs/docs/api/contracts/handlers/l1-reward-manager-handler.md @@ -29,7 +29,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/l1-reward-manager-handler.ts:28](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l1-reward-manager-handler.ts#L28) +[lib/contracts/handlers/l1-reward-manager-handler.ts:28](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l1-reward-manager-handler.ts#L28) #### Properties @@ -66,7 +66,7 @@ The bridge data. ###### Source -[lib/contracts/handlers/l1-reward-manager-handler.ts:60](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l1-reward-manager-handler.ts#L60) +[lib/contracts/handlers/l1-reward-manager-handler.ts:60](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l1-reward-manager-handler.ts#L60) ##### getContract() @@ -83,7 +83,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/l1-reward-manager-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l1-reward-manager-handler.ts#L42) +[lib/contracts/handlers/l1-reward-manager-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l1-reward-manager-handler.ts#L42) ##### setL2RewardClaimer() @@ -129,4 +129,4 @@ transaction. ###### Source -[lib/contracts/handlers/l1-reward-manager-handler.ts:78](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l1-reward-manager-handler.ts#L78) +[lib/contracts/handlers/l1-reward-manager-handler.ts:78](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l1-reward-manager-handler.ts#L78) diff --git a/docs/docs/api/contracts/handlers/l2-reward-manager-handler.md b/docs/docs/api/contracts/handlers/l2-reward-manager-handler.md index 5459d6c..37be791 100644 --- a/docs/docs/api/contracts/handlers/l2-reward-manager-handler.md +++ b/docs/docs/api/contracts/handlers/l2-reward-manager-handler.md @@ -29,7 +29,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:37](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L37) +[lib/contracts/handlers/l2-reward-manager-handler.ts:37](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L37) #### Properties @@ -56,7 +56,7 @@ The authority address. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:68](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L68) +[lib/contracts/handlers/l2-reward-manager-handler.ts:68](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L68) ##### claimRewards() @@ -104,7 +104,7 @@ If `claimOrders` is empty. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:156](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L156) +[lib/contracts/handlers/l2-reward-manager-handler.ts:156](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L156) ##### getClaimingDelay() @@ -120,7 +120,7 @@ The claiming delay. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:77](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L77) +[lib/contracts/handlers/l2-reward-manager-handler.ts:77](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L77) ##### getContract() @@ -137,7 +137,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L51) +[lib/contracts/handlers/l2-reward-manager-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L51) ##### getEpochRecord() @@ -187,7 +187,7 @@ The epoch record of exchange rate and reward root. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:88](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L88) +[lib/contracts/handlers/l2-reward-manager-handler.ts:88](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L88) ##### getIntervalId() @@ -210,7 +210,7 @@ Interval ID for the given start and end epoch. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:99](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L99) +[lib/contracts/handlers/l2-reward-manager-handler.ts:99](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L99) ##### getRewardsClaimer() @@ -232,7 +232,7 @@ Rewards claimer address. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:109](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L109) +[lib/contracts/handlers/l2-reward-manager-handler.ts:109](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L109) ##### isClaimed() @@ -256,7 +256,7 @@ Whether the reward has been claimed. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:121](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L121) +[lib/contracts/handlers/l2-reward-manager-handler.ts:121](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L121) ##### isClaimingLocked() @@ -278,7 +278,7 @@ Whether the claiming is locked for the given interval. ###### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:132](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L132) +[lib/contracts/handlers/l2-reward-manager-handler.ts:132](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L132) ## Type Aliases @@ -310,4 +310,4 @@ Whether the claiming is locked for the given interval. #### Source -[lib/contracts/handlers/l2-reward-manager-handler.ts:13](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/l2-reward-manager-handler.ts#L13) +[lib/contracts/handlers/l2-reward-manager-handler.ts:13](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/l2-reward-manager-handler.ts#L13) diff --git a/docs/docs/api/contracts/handlers/nucleus-accountant-handler.md b/docs/docs/api/contracts/handlers/nucleus-accountant-handler.md index 0cb0e22..cd794ab 100644 --- a/docs/docs/api/contracts/handlers/nucleus-accountant-handler.md +++ b/docs/docs/api/contracts/handlers/nucleus-accountant-handler.md @@ -28,7 +28,7 @@ Create the handler for processing tokens. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:27](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L27) +[lib/contracts/handlers/nucleus-accountant-handler.ts:27](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L27) #### Properties @@ -55,7 +55,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:39](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L39) +[lib/contracts/handlers/nucleus-accountant-handler.ts:39](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L39) ##### getRate() @@ -71,7 +71,7 @@ Rate for the given token address. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:78](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L78) +[lib/contracts/handlers/nucleus-accountant-handler.ts:78](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L78) ##### getRateInQuote() @@ -93,7 +93,7 @@ Rate for the given quote address. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:96](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L96) +[lib/contracts/handlers/nucleus-accountant-handler.ts:96](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L96) ##### getRateInQuoteSafe() @@ -115,7 +115,7 @@ Rate for the given quote address for safe. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:105](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L105) +[lib/contracts/handlers/nucleus-accountant-handler.ts:105](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L105) ##### getRateSafe() @@ -131,7 +131,7 @@ Rate for the given token address for safe. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:87](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L87) +[lib/contracts/handlers/nucleus-accountant-handler.ts:87](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L87) ##### rateProviderData() @@ -161,7 +161,7 @@ Rate provider data for the given token address. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:57](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L57) +[lib/contracts/handlers/nucleus-accountant-handler.ts:57](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L57) ##### vault() @@ -177,4 +177,4 @@ Vault for the given token address. ###### Source -[lib/contracts/handlers/nucleus-accountant-handler.ts:69](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-accountant-handler.ts#L69) +[lib/contracts/handlers/nucleus-accountant-handler.ts:69](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-accountant-handler.ts#L69) diff --git a/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler-1.md b/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler-1.md new file mode 100644 index 0000000..94cbb68 --- /dev/null +++ b/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler-1.md @@ -0,0 +1,15 @@ +# contracts/handlers/nucleus-atomic-queue-handler + +## References + +### AtomicRequest + +Re-exports [AtomicRequest](nucleus-atomic-queue-handler.md#atomicrequest) + +### NucleusAtomicQueueHandler + +Re-exports [NucleusAtomicQueueHandler](nucleus-atomic-queue-handler.md#nucleusatomicqueuehandler) + +### SolveMetaData + +Re-exports [SolveMetaData](nucleus-atomic-queue-handler.md#solvemetadata) diff --git a/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler.md b/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler.md new file mode 100644 index 0000000..0516996 --- /dev/null +++ b/docs/docs/api/contracts/handlers/nucleus-atomic-queue-handler.md @@ -0,0 +1,237 @@ +# contracts/handlers/nucleus-atomic-queue-handler + +## Classes + +### NucleusAtomicQueueHandler + +Handler for the `AtomicQueue` contract. + +#### Constructors + +##### new NucleusAtomicQueueHandler() + +> **new NucleusAtomicQueueHandler**(`chain`, `walletClient`, `publicClient`): [`NucleusAtomicQueueHandler`](nucleus-atomic-queue-handler.md#nucleusatomicqueuehandler) + +###### Parameters + +| Parameter | Type | +| :------ | :------ | +| `chain` | [`Chain`](../../chains/constants.md#chain) | +| `walletClient` | `object` | +| `publicClient` | `object` | + +###### Returns + +[`NucleusAtomicQueueHandler`](nucleus-atomic-queue-handler.md#nucleusatomicqueuehandler) + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:34](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L34) + +#### Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `chain` | `private` | [`Chain`](../../chains/constants.md#chain) | +| `publicClient` | `private` | `object` | +| `viemChain` | `private` | `Chain` | +| `walletClient` | `private` | `object` | + +#### Methods + +##### getContract() + +> **getContract**(): `object` + +###### Returns + +`object` + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L42) + +##### getUserAtomicRequest() + +> **getUserAtomicRequest**(`user`, `offerToken`, `wantToken`): `Promise`\<`object`\> + +Get the atomic request details for a specific user (wallet address). + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `user` | \`0x$\{string\}\` | User address | +| `offerToken` | \`0x$\{string\}\` | Token being offered | +| `wantToken` | \`0x$\{string\}\` | Token being requested | + +###### Returns + +`Promise`\<`object`\> + +###### atomicPrice + +> **atomicPrice**: `bigint` + +###### deadline + +> **deadline**: `bigint` + +###### inSolve + +> **inSolve**: `boolean` + +###### offerAmount + +> **offerAmount**: `bigint` + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:60](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L60) + +##### isAtomicRequestValid() + +> **isAtomicRequestValid**(`offerToken`, `user`, `request`): `Promise`\<`boolean`\> + +Check if an atomic request is valid. + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `offerToken` | \`0x$\{string\}\` | Token being offered | +| `user` | \`0x$\{string\}\` | User address | +| `request` | [`AtomicRequest`](nucleus-atomic-queue-handler.md#atomicrequest) | Atomic request details | + +###### Returns + +`Promise`\<`boolean`\> + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:78](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L78) + +##### solve() + +> **solve**(`offerToken`, `wantToken`, `users`, `runData`, `solver`): `Promise`\<\`0x$\{string\}\`\> + +Solve atomic requests for multiple users. + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `offerToken` | \`0x$\{string\}\` | Token being offered | +| `wantToken` | \`0x$\{string\}\` | Token being requested | +| `users` | \`0x$\{string\}\`[] | Array of user addresses | +| `runData` | \`0x$\{string\}\` | Execution data for the solve | +| `solver` | \`0x$\{string\}\` | Address of the solver | + +###### Returns + +`Promise`\<\`0x$\{string\}\`\> + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:98](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L98) + +##### updateAtomicRequest() + +> **updateAtomicRequest**(`offerToken`, `wantToken`, `request`, `ownerAddress`): `Promise`\<\`0x$\{string\}\`\> + +Update an atomic request. + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `offerToken` | \`0x$\{string\}\` | Token being offered | +| `wantToken` | \`0x$\{string\}\` | Token being requested | +| `request` | [`AtomicRequest`](nucleus-atomic-queue-handler.md#atomicrequest) | New atomic request details | +| `ownerAddress` | \`0x$\{string\}\` | - | + +###### Returns + +`Promise`\<\`0x$\{string\}\`\> + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:120](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L120) + +##### userAtomicRequest() + +> **userAtomicRequest**(`user`, `offerToken`, `wantToken`): `Promise`\ + +Get user's atomic request details directly from storage. + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `user` | \`0x$\{string\}\` | User address | +| `offerToken` | \`0x$\{string\}\` | Token being offered | +| `wantToken` | \`0x$\{string\}\` | Token being requested | + +###### Returns + +`Promise`\ + +###### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:138](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L138) + +## Type Aliases + +### AtomicRequest + +> **AtomicRequest**: `object` + +#### Type declaration + +##### atomicPrice + +> **atomicPrice**: `bigint` + +##### deadline + +> **deadline**: `bigint` + +##### inSolve + +> **inSolve**: `boolean` + +##### offerAmount + +> **offerAmount**: `bigint` + +#### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L14) + +*** + +### SolveMetaData + +> **SolveMetaData**: `object` + +#### Type declaration + +##### assetsForWant + +> **assetsForWant**: `bigint` + +##### assetsToOffer + +> **assetsToOffer**: `bigint` + +##### flags + +> **flags**: `number` + +##### user + +> **user**: `Address` + +#### Source + +[lib/contracts/handlers/nucleus-atomic-queue-handler.ts:21](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-atomic-queue-handler.ts#L21) diff --git a/docs/docs/api/contracts/handlers/nucleus-boring-vault-handler.md b/docs/docs/api/contracts/handlers/nucleus-boring-vault-handler.md index 77ed0fa..bd85910 100644 --- a/docs/docs/api/contracts/handlers/nucleus-boring-vault-handler.md +++ b/docs/docs/api/contracts/handlers/nucleus-boring-vault-handler.md @@ -29,7 +29,7 @@ Create the handler for processing UniFi tokens. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:41](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L41) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:41](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L41) #### Properties @@ -64,7 +64,7 @@ Hash of the transaction. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:115](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L115) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:115](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L115) ##### balanceOf() @@ -86,7 +86,7 @@ Token balance in wei. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:94](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L94) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:94](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L94) ##### getAllowance() @@ -109,7 +109,7 @@ Allowance for the given owner and spender. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:75](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L75) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:75](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L75) ##### getContract() @@ -126,7 +126,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:55](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L55) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:55](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L55) ##### getTotalSupply() @@ -142,7 +142,7 @@ Total supply of the token. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:84](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L84) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:84](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L84) ##### permit() @@ -184,7 +184,7 @@ transaction. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:203](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L203) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:203](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L203) ##### totalSupply() @@ -200,7 +200,7 @@ Total supply of the token. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:103](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L103) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:103](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L103) ##### transfer() @@ -244,7 +244,7 @@ transaction. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:138](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L138) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:138](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L138) ##### transferFrom() @@ -289,7 +289,7 @@ transaction. ###### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:165](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L165) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:165](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L165) ## Type Aliases @@ -333,4 +333,4 @@ transaction. #### Source -[lib/contracts/handlers/nucleus-boring-vault-handler.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L14) +[lib/contracts/handlers/nucleus-boring-vault-handler.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-boring-vault-handler.ts#L14) diff --git a/docs/docs/api/contracts/handlers/nucleus-teller-handler.md b/docs/docs/api/contracts/handlers/nucleus-teller-handler.md index d3980a9..b4d6168 100644 --- a/docs/docs/api/contracts/handlers/nucleus-teller-handler.md +++ b/docs/docs/api/contracts/handlers/nucleus-teller-handler.md @@ -28,7 +28,7 @@ Create the handler for processing tokens. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:50](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L50) +[lib/contracts/handlers/nucleus-teller-handler.ts:50](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L50) #### Properties @@ -56,7 +56,7 @@ The address of the `Accountant` contract. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:86](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L86) +[lib/contracts/handlers/nucleus-teller-handler.ts:86](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L86) ##### deposit() @@ -100,7 +100,7 @@ transaction. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:145](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L145) +[lib/contracts/handlers/nucleus-teller-handler.ts:145](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L145) ##### depositWithPermit() @@ -142,7 +142,7 @@ transaction. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:224](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L224) +[lib/contracts/handlers/nucleus-teller-handler.ts:224](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L224) ##### getContract() @@ -159,7 +159,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:69](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L69) +[lib/contracts/handlers/nucleus-teller-handler.ts:69](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L69) ##### isPaused() @@ -175,7 +175,7 @@ The paused state of the contract. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:123](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L123) +[lib/contracts/handlers/nucleus-teller-handler.ts:123](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L123) ##### shareLockPeriod() @@ -191,7 +191,7 @@ The share lock period. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:104](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L104) +[lib/contracts/handlers/nucleus-teller-handler.ts:104](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L104) ##### shareUnlockTime() @@ -213,7 +213,7 @@ The share unlock time. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:114](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L114) +[lib/contracts/handlers/nucleus-teller-handler.ts:114](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L114) ##### vault() @@ -229,7 +229,7 @@ The address of the `BoringVault` contract. ###### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:95](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L95) +[lib/contracts/handlers/nucleus-teller-handler.ts:95](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L95) ## Type Aliases @@ -265,7 +265,7 @@ The address of the `BoringVault` contract. #### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L14) +[lib/contracts/handlers/nucleus-teller-handler.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L14) *** @@ -309,4 +309,4 @@ The address of the `BoringVault` contract. #### Source -[lib/contracts/handlers/nucleus-teller-handler.ts:23](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/nucleus-teller-handler.ts#L23) +[lib/contracts/handlers/nucleus-teller-handler.ts:23](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/nucleus-teller-handler.ts#L23) diff --git a/docs/docs/api/contracts/handlers/puf-locker-handler.md b/docs/docs/api/contracts/handlers/puf-locker-handler.md index df03a41..3f00a3e 100644 --- a/docs/docs/api/contracts/handlers/puf-locker-handler.md +++ b/docs/docs/api/contracts/handlers/puf-locker-handler.md @@ -30,7 +30,7 @@ interact with the contract. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L42) +[lib/contracts/handlers/puf-locker-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L42) #### Properties @@ -86,7 +86,7 @@ transaction. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:139](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L139) +[lib/contracts/handlers/puf-locker-handler.ts:139](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L139) ##### getAllDeposits() @@ -109,7 +109,7 @@ The amount and deposits of the given account address. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:80](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L80) +[lib/contracts/handlers/puf-locker-handler.ts:80](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L80) ##### getContract() @@ -126,7 +126,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:61](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L61) +[lib/contracts/handlers/puf-locker-handler.ts:61](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L61) ##### getDeposits() @@ -151,7 +151,7 @@ The amount and release time of the deposits. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:96](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L96) +[lib/contracts/handlers/puf-locker-handler.ts:96](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L96) ##### getLockPeriods() @@ -168,7 +168,7 @@ The minimum and maximum lock period in seconds. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:116](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L116) +[lib/contracts/handlers/puf-locker-handler.ts:116](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L116) ##### withdraw() @@ -210,7 +210,7 @@ Hash of the withdrawal transaction. ###### Source -[lib/contracts/handlers/puf-locker-handler.ts:207](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L207) +[lib/contracts/handlers/puf-locker-handler.ts:207](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L207) ## Type Aliases @@ -246,4 +246,4 @@ Hash of the withdrawal transaction. #### Source -[lib/contracts/handlers/puf-locker-handler.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puf-locker-handler.ts#L15) +[lib/contracts/handlers/puf-locker-handler.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puf-locker-handler.ts#L15) diff --git a/docs/docs/api/contracts/handlers/puffer-depositor-handler.md b/docs/docs/api/contracts/handlers/puffer-depositor-handler.md index cfa35bb..3108914 100644 --- a/docs/docs/api/contracts/handlers/puffer-depositor-handler.md +++ b/docs/docs/api/contracts/handlers/puffer-depositor-handler.md @@ -30,7 +30,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/puffer-depositor-handler.ts:32](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-depositor-handler.ts#L32) +[lib/contracts/handlers/puffer-depositor-handler.ts:32](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-depositor-handler.ts#L32) #### Properties @@ -87,7 +87,7 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-depositor-handler.ts:76](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-depositor-handler.ts#L76) +[lib/contracts/handlers/puffer-depositor-handler.ts:76](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-depositor-handler.ts#L76) ##### depositWstETH() @@ -132,7 +132,7 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-depositor-handler.ts:120](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-depositor-handler.ts#L120) +[lib/contracts/handlers/puffer-depositor-handler.ts:120](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-depositor-handler.ts#L120) ##### getContract() @@ -149,4 +149,4 @@ The viem contract. ###### Source -[lib/contracts/handlers/puffer-depositor-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-depositor-handler.ts#L51) +[lib/contracts/handlers/puffer-depositor-handler.ts:51](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-depositor-handler.ts#L51) diff --git a/docs/docs/api/contracts/handlers/puffer-l2-depositor-handler.md b/docs/docs/api/contracts/handlers/puffer-l2-depositor-handler.md index 24c0e54..a18ba60 100644 --- a/docs/docs/api/contracts/handlers/puffer-l2-depositor-handler.md +++ b/docs/docs/api/contracts/handlers/puffer-l2-depositor-handler.md @@ -30,7 +30,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/puffer-l2-depositor-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L42) +[lib/contracts/handlers/puffer-l2-depositor-handler.ts:42](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L42) #### Properties @@ -91,7 +91,7 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-l2-depositor-handler.ts:97](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L97) +[lib/contracts/handlers/puffer-l2-depositor-handler.ts:97](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L97) ##### getContract() @@ -108,7 +108,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/puffer-l2-depositor-handler.ts:61](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L61) +[lib/contracts/handlers/puffer-l2-depositor-handler.ts:61](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L61) ## Type Aliases @@ -144,4 +144,4 @@ The viem contract. #### Source -[lib/contracts/handlers/puffer-l2-depositor-handler.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L15) +[lib/contracts/handlers/puffer-l2-depositor-handler.ts:15](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-l2-depositor-handler.ts#L15) diff --git a/docs/docs/api/contracts/handlers/puffer-vault-handler.md b/docs/docs/api/contracts/handlers/puffer-vault-handler.md index 50ef765..00d5f1a 100644 --- a/docs/docs/api/contracts/handlers/puffer-vault-handler.md +++ b/docs/docs/api/contracts/handlers/puffer-vault-handler.md @@ -30,7 +30,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:29](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L29) +[lib/contracts/handlers/puffer-vault-handler.ts:29](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L29) #### Properties @@ -63,7 +63,7 @@ pufETH balance in wei. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:89](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L89) +[lib/contracts/handlers/puffer-vault-handler.ts:89](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L89) ##### convertToAssets() @@ -86,7 +86,7 @@ Amount of equivalent WETH. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:246](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L246) +[lib/contracts/handlers/puffer-vault-handler.ts:246](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L246) ##### depositETH() @@ -136,7 +136,7 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:67](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L67) +[lib/contracts/handlers/puffer-vault-handler.ts:67](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L67) ##### getAllowance() @@ -159,7 +159,7 @@ Allowance for the given owner and spender. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:110](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L110) +[lib/contracts/handlers/puffer-vault-handler.ts:110](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L110) ##### getContract() @@ -176,7 +176,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:43](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L43) +[lib/contracts/handlers/puffer-vault-handler.ts:43](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L43) ##### getExitFeeBasisPoints() @@ -195,7 +195,7 @@ Basis points of the exit fee. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:186](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L186) +[lib/contracts/handlers/puffer-vault-handler.ts:186](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L186) ##### getPufETHRate() @@ -211,7 +211,7 @@ Rate of pufETH compared to 1 ETH. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:98](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L98) +[lib/contracts/handlers/puffer-vault-handler.ts:98](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L98) ##### getRemainingAssetsDailyWithdrawalLimit() @@ -227,7 +227,7 @@ Remaining WETH daily withdrawal limit. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:195](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L195) +[lib/contracts/handlers/puffer-vault-handler.ts:195](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L195) ##### maxRedeem() @@ -250,7 +250,7 @@ Maximum amount of pufETH shares that can be redeemed. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:174](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L174) +[lib/contracts/handlers/puffer-vault-handler.ts:174](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L174) ##### previewRedeem() @@ -273,7 +273,7 @@ Preview of the amount of WETH that can be redeemed. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:163](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L163) +[lib/contracts/handlers/puffer-vault-handler.ts:163](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L163) ##### redeem() @@ -320,7 +320,7 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:214](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L214) +[lib/contracts/handlers/puffer-vault-handler.ts:214](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L214) ##### withdraw() @@ -366,4 +366,4 @@ transaction. ###### Source -[lib/contracts/handlers/puffer-vault-handler.ts:131](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-vault-handler.ts#L131) +[lib/contracts/handlers/puffer-vault-handler.ts:131](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-vault-handler.ts#L131) diff --git a/docs/docs/api/contracts/handlers/puffer-withdrawal-manager-handler.md b/docs/docs/api/contracts/handlers/puffer-withdrawal-manager-handler.md index 8996ed6..f14d1aa 100644 --- a/docs/docs/api/contracts/handlers/puffer-withdrawal-manager-handler.md +++ b/docs/docs/api/contracts/handlers/puffer-withdrawal-manager-handler.md @@ -30,7 +30,7 @@ methods to interact with the contract. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:32](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L32) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:32](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L32) #### Properties @@ -81,7 +81,7 @@ The transaction hash of the withdrawal. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:142](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L142) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:142](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L142) ##### getContract() @@ -97,7 +97,7 @@ The viem contract. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:50](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L50) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:50](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L50) ##### getWithdrawal() @@ -131,7 +131,7 @@ The withdrawal at the given index. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:167](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L167) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:167](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L167) ##### requestWithdrawal() @@ -170,7 +170,7 @@ The transaction hash of the withdrawal. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:71](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L71) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:71](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L71) ##### requestWithdrawalWithPermit() @@ -209,4 +209,4 @@ The transaction hash of the withdrawal. ###### Source -[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:97](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L97) +[lib/contracts/handlers/puffer-withdrawal-manager-handler.ts:97](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/handlers/puffer-withdrawal-manager-handler.ts#L97) diff --git a/docs/docs/api/contracts/tokens.md b/docs/docs/api/contracts/tokens.md index a5aa27b..5898db1 100644 --- a/docs/docs/api/contracts/tokens.md +++ b/docs/docs/api/contracts/tokens.md @@ -37,7 +37,7 @@ #### Source -[lib/contracts/tokens.ts:21](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/tokens.ts#L21) +[lib/contracts/tokens.ts:21](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/tokens.ts#L21) ## Variables @@ -47,7 +47,7 @@ #### Source -[lib/contracts/tokens.ts:23](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/tokens.ts#L23) +[lib/contracts/tokens.ts:23](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/tokens.ts#L23) *** @@ -57,7 +57,7 @@ #### Source -[lib/contracts/tokens.ts:77](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/tokens.ts#L77) +[lib/contracts/tokens.ts:77](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/tokens.ts#L77) *** @@ -67,4 +67,4 @@ #### Source -[lib/contracts/tokens.ts:99](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/contracts/tokens.ts#L99) +[lib/contracts/tokens.ts:99](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/contracts/tokens.ts#L99) diff --git a/docs/docs/api/errors/base-error.md b/docs/docs/api/errors/base-error.md index e0e6862..47999f6 100644 --- a/docs/docs/api/errors/base-error.md +++ b/docs/docs/api/errors/base-error.md @@ -42,7 +42,7 @@ ###### Source -[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L9) +[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L9) #### Methods @@ -63,4 +63,4 @@ ###### Source -[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L14) +[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L14) diff --git a/docs/docs/api/errors/types.md b/docs/docs/api/errors/types.md index d096e67..d8e8574 100644 --- a/docs/docs/api/errors/types.md +++ b/docs/docs/api/errors/types.md @@ -18,4 +18,4 @@ #### Source -[lib/errors/types.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/types.ts#L1) +[lib/errors/types.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/types.ts#L1) diff --git a/docs/docs/api/errors/validation-errors.md b/docs/docs/api/errors/validation-errors.md index c974e57..fd27a5b 100644 --- a/docs/docs/api/errors/validation-errors.md +++ b/docs/docs/api/errors/validation-errors.md @@ -31,7 +31,7 @@ ###### Source -[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L9) +[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L9) #### Methods @@ -56,7 +56,7 @@ ###### Source -[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L14) +[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L14) *** @@ -89,7 +89,7 @@ ###### Source -[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L9) +[lib/errors/base-error.ts:9](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L9) #### Methods @@ -114,4 +114,4 @@ ###### Source -[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/errors/base-error.ts#L14) +[lib/errors/base-error.ts:14](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/errors/base-error.ts#L14) diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md index d2db872..faf39ff 100644 --- a/docs/docs/api/index.md +++ b/docs/docs/api/index.md @@ -18,6 +18,9 @@ - [contracts/abis/mainnet/Accountant](contracts/abis/mainnet/Accountant.md) - [contracts/abis/mainnet/Accountant](contracts/abis/mainnet/Accountant-1.md) - [contracts/abis/mainnet/Accountant](contracts/abis/mainnet/Accountant-1.md) +- [contracts/abis/mainnet/AtomicQueue](contracts/abis/mainnet/AtomicQueue.md) +- [contracts/abis/mainnet/AtomicQueue](contracts/abis/mainnet/AtomicQueue-1.md) +- [contracts/abis/mainnet/AtomicQueue](contracts/abis/mainnet/AtomicQueue-1.md) - [contracts/abis/mainnet/BoringVault](contracts/abis/mainnet/BoringVault.md) - [contracts/abis/mainnet/BoringVault](contracts/abis/mainnet/BoringVault-1.md) - [contracts/abis/mainnet/BoringVault](contracts/abis/mainnet/BoringVault-1.md) @@ -50,6 +53,8 @@ - [contracts/abis/mainnet/Teller](contracts/abis/mainnet/Teller-1.md) - [contracts/abis/nucleus-accountant-abis](contracts/abis/nucleus-accountant-abis.md) - [contracts/abis/nucleus-accountant-abis](contracts/abis/nucleus-accountant-abis-1.md) +- [contracts/abis/nucleus-atomic-queue-abis](contracts/abis/nucleus-atomic-queue-abis.md) +- [contracts/abis/nucleus-atomic-queue-abis](contracts/abis/nucleus-atomic-queue-abis-1.md) - [contracts/abis/nucleus-boring-vault-abis](contracts/abis/nucleus-boring-vault-abis.md) - [contracts/abis/nucleus-boring-vault-abis](contracts/abis/nucleus-boring-vault-abis-1.md) - [contracts/abis/nucleus-teller-abis](contracts/abis/nucleus-teller-abis.md) @@ -73,6 +78,8 @@ - [contracts/handlers/l2-reward-manager-handler](contracts/handlers/l2-reward-manager-handler-1.md) - [contracts/handlers/nucleus-accountant-handler](contracts/handlers/nucleus-accountant-handler.md) - [contracts/handlers/nucleus-accountant-handler](contracts/handlers/nucleus-accountant-handler-1.md) +- [contracts/handlers/nucleus-atomic-queue-handler](contracts/handlers/nucleus-atomic-queue-handler.md) +- [contracts/handlers/nucleus-atomic-queue-handler](contracts/handlers/nucleus-atomic-queue-handler-1.md) - [contracts/handlers/nucleus-boring-vault-handler](contracts/handlers/nucleus-boring-vault-handler.md) - [contracts/handlers/nucleus-boring-vault-handler](contracts/handlers/nucleus-boring-vault-handler-1.md) - [contracts/handlers/nucleus-teller-handler](contracts/handlers/nucleus-teller-handler.md) diff --git a/docs/docs/api/utils/time.md b/docs/docs/api/utils/time.md index 42f8d3f..62e7381 100644 --- a/docs/docs/api/utils/time.md +++ b/docs/docs/api/utils/time.md @@ -12,4 +12,4 @@ #### Source -[lib/utils/time.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/utils/time.ts#L1) +[lib/utils/time.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/utils/time.ts#L1) diff --git a/docs/docs/api/utils/types.md b/docs/docs/api/utils/types.md index 7660daa..ea80bb2 100644 --- a/docs/docs/api/utils/types.md +++ b/docs/docs/api/utils/types.md @@ -24,7 +24,7 @@ #### Source -[lib/utils/types.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/utils/types.ts#L3) +[lib/utils/types.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/utils/types.ts#L3) *** @@ -40,4 +40,4 @@ #### Source -[lib/utils/types.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/utils/types.ts#L1) +[lib/utils/types.ts:1](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/utils/types.ts#L1) diff --git a/docs/docs/api/utils/version.md b/docs/docs/api/utils/version.md index 06c9ae4..48a7d51 100644 --- a/docs/docs/api/utils/version.md +++ b/docs/docs/api/utils/version.md @@ -8,4 +8,4 @@ #### Source -[lib/utils/version.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/fdee675745314d4bdd8ce8a62cebad3f5d73a957/lib/utils/version.ts#L3) +[lib/utils/version.ts:3](https://github.com/PufferFinance/puffer-sdk/blob/06a39bc3698c30dd13fb1bc00df2e907256639ac/lib/utils/version.ts#L3) diff --git a/package.json b/package.json index 486dec0..40e723a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@pufferfinance/puffer-sdk", "description": "SDK for interacting with the puffer smart contracts", - "version": "1.8.1", + "version": "1.9.0", "repository": { "type": "git", "url": "https://github.com/PufferFinance/puffer-sdk.git"