@jpool/bond-sdk 0.11.0-next.6 → 0.11.0-next.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -263,8 +263,8 @@ type Jbond = {
263
263
  {
264
264
  "name": "bondLockFunds";
265
265
  "docs": [
266
- "Locks funds for the upcoming epoch.",
267
- "Moves collateral from available to locked state which cannot be withdrawn.",
266
+ "Locks funds for both the current and upcoming epoch.",
267
+ "Moves collateral from available to locked state, making it unavailable for withdrawal for the current and next epoch.",
268
268
  "# Errors",
269
269
  "Fails if the validator is not active, or if there are insufficient available funds."
270
270
  ];
@@ -633,6 +633,17 @@ type Jbond = {
633
633
  },
634
634
  {
635
635
  "name": "bondUpdate";
636
+ "docs": [
637
+ "Transitions locked funds between epochs for a validator bond.",
638
+ "",
639
+ "This function should be called at epoch boundaries to update the bond's",
640
+ "`last_update_epoch` and move the `next_epoch_locked` amount into",
641
+ "`current_epoch_locked`. It ensures that the update only occurs once per epoch.",
642
+ "",
643
+ "# Errors",
644
+ "Returns [`BondError::InvalidEpoch`] if called more than once in the same epoch,",
645
+ "or if the system clock cannot be accessed."
646
+ ];
636
647
  "discriminator": [
637
648
  237,
638
649
  102,
package/dist/index.d.ts CHANGED
@@ -263,8 +263,8 @@ type Jbond = {
263
263
  {
264
264
  "name": "bondLockFunds";
265
265
  "docs": [
266
- "Locks funds for the upcoming epoch.",
267
- "Moves collateral from available to locked state which cannot be withdrawn.",
266
+ "Locks funds for both the current and upcoming epoch.",
267
+ "Moves collateral from available to locked state, making it unavailable for withdrawal for the current and next epoch.",
268
268
  "# Errors",
269
269
  "Fails if the validator is not active, or if there are insufficient available funds."
270
270
  ];
@@ -633,6 +633,17 @@ type Jbond = {
633
633
  },
634
634
  {
635
635
  "name": "bondUpdate";
636
+ "docs": [
637
+ "Transitions locked funds between epochs for a validator bond.",
638
+ "",
639
+ "This function should be called at epoch boundaries to update the bond's",
640
+ "`last_update_epoch` and move the `next_epoch_locked` amount into",
641
+ "`current_epoch_locked`. It ensures that the update only occurs once per epoch.",
642
+ "",
643
+ "# Errors",
644
+ "Returns [`BondError::InvalidEpoch`] if called more than once in the same epoch,",
645
+ "or if the system clock cannot be accessed."
646
+ ];
636
647
  "discriminator": [
637
648
  237,
638
649
  102,
package/dist/index.js CHANGED
@@ -5011,8 +5011,8 @@ var jbond_default = {
5011
5011
  {
5012
5012
  name: "bond_lock_funds",
5013
5013
  docs: [
5014
- "Locks funds for the upcoming epoch.",
5015
- "Moves collateral from available to locked state which cannot be withdrawn.",
5014
+ "Locks funds for both the current and upcoming epoch.",
5015
+ "Moves collateral from available to locked state, making it unavailable for withdrawal for the current and next epoch.",
5016
5016
  "# Errors",
5017
5017
  "Fails if the validator is not active, or if there are insufficient available funds."
5018
5018
  ],
@@ -5381,6 +5381,17 @@ var jbond_default = {
5381
5381
  },
5382
5382
  {
5383
5383
  name: "bond_update",
5384
+ docs: [
5385
+ "Transitions locked funds between epochs for a validator bond.",
5386
+ "",
5387
+ "This function should be called at epoch boundaries to update the bond's",
5388
+ "`last_update_epoch` and move the `next_epoch_locked` amount into",
5389
+ "`current_epoch_locked`. It ensures that the update only occurs once per epoch.",
5390
+ "",
5391
+ "# Errors",
5392
+ "Returns [`BondError::InvalidEpoch`] if called more than once in the same epoch,",
5393
+ "or if the system clock cannot be accessed."
5394
+ ],
5384
5395
  discriminator: [
5385
5396
  237,
5386
5397
  102,