@campnetwork/origin 1.4.0-alpha.1 → 1.4.0-alpha.2

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/core.d.ts CHANGED
@@ -716,18 +716,20 @@ declare function getVaultRevenueTokens(this: Origin, tokenId: bigint): Promise<A
716
716
 
717
717
  /**
718
718
  * Returns the amount of revenue claimable by a holder for a given token and revenue token.
719
- * If no holder is provided, the connected wallet address is used.
719
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
720
+ * since RT tokens are held in the TBA by default.
720
721
  *
721
722
  * @param tokenId The token ID whose vault to query.
722
723
  * @param revenueToken The ERC20 revenue token address.
723
- * @param holder Optional holder address. Defaults to connected wallet.
724
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
724
725
  * @returns The claimable amount in the revenue token's smallest unit.
725
726
  */
726
727
  declare function claimableRevenue(this: Origin, tokenId: bigint, revenueToken: Address, holder?: Address): Promise<bigint>;
727
728
 
728
729
  /**
729
730
  * Claims accumulated revenue for a token from a specific revenue token.
730
- * The caller must hold Royalty Tokens to claim their proportional share.
731
+ * Executes the claim through the NFT's Token Bound Account (TBA),
732
+ * since the TBA holds the Royalty Tokens.
731
733
  *
732
734
  * @param tokenId The token ID whose vault to claim from.
733
735
  * @param revenueToken The ERC20 revenue token address to claim.
@@ -737,7 +739,8 @@ declare function claimRevenue(this: Origin, tokenId: bigint, revenueToken: Addre
737
739
 
738
740
  /**
739
741
  * Claims accumulated revenue for a token from multiple revenue tokens in a single transaction.
740
- * The caller must hold Royalty Tokens to claim their proportional share.
742
+ * Executes the claim through the NFT's Token Bound Account (TBA),
743
+ * since the TBA holds the Royalty Tokens.
741
744
  *
742
745
  * @param tokenId The token ID whose vault to claim from.
743
746
  * @param revenueTokens Array of ERC20 revenue token addresses to claim.
@@ -716,18 +716,20 @@ declare function getVaultRevenueTokens(this: Origin, tokenId: bigint): Promise<A
716
716
 
717
717
  /**
718
718
  * Returns the amount of revenue claimable by a holder for a given token and revenue token.
719
- * If no holder is provided, the connected wallet address is used.
719
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
720
+ * since RT tokens are held in the TBA by default.
720
721
  *
721
722
  * @param tokenId The token ID whose vault to query.
722
723
  * @param revenueToken The ERC20 revenue token address.
723
- * @param holder Optional holder address. Defaults to connected wallet.
724
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
724
725
  * @returns The claimable amount in the revenue token's smallest unit.
725
726
  */
726
727
  declare function claimableRevenue(this: Origin, tokenId: bigint, revenueToken: Address, holder?: Address): Promise<bigint>;
727
728
 
728
729
  /**
729
730
  * Claims accumulated revenue for a token from a specific revenue token.
730
- * The caller must hold Royalty Tokens to claim their proportional share.
731
+ * Executes the claim through the NFT's Token Bound Account (TBA),
732
+ * since the TBA holds the Royalty Tokens.
731
733
  *
732
734
  * @param tokenId The token ID whose vault to claim from.
733
735
  * @param revenueToken The ERC20 revenue token address to claim.
@@ -737,7 +739,8 @@ declare function claimRevenue(this: Origin, tokenId: bigint, revenueToken: Addre
737
739
 
738
740
  /**
739
741
  * Claims accumulated revenue for a token from multiple revenue tokens in a single transaction.
740
- * The caller must hold Royalty Tokens to claim their proportional share.
742
+ * Executes the claim through the NFT's Token Bound Account (TBA),
743
+ * since the TBA holds the Royalty Tokens.
741
744
  *
742
745
  * @param tokenId The token ID whose vault to claim from.
743
746
  * @param revenueTokens Array of ERC20 revenue token addresses to claim.