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

package/dist/core.d.ts

@@ -716,18 +716,20 @@ declare function getVaultRevenueTokens(this: Origin, tokenId: bigint): Promise<A
 
 /**
  * Returns the amount of revenue claimable by a holder for a given token and revenue token.
- * If no holder is provided, the connected wallet address is used.
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
+ * since RT tokens are held in the TBA by default.
  *
  * @param tokenId The token ID whose vault to query.
  * @param revenueToken The ERC20 revenue token address.
- * @param holder Optional holder address. Defaults to connected wallet.
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
  * @returns The claimable amount in the revenue token's smallest unit.
  */
 declare function claimableRevenue(this: Origin, tokenId: bigint, revenueToken: Address, holder?: Address): Promise<bigint>;
 
 /**
  * Claims accumulated revenue for a token from a specific revenue token.
- * The caller must hold Royalty Tokens to claim their proportional share.
+ * Executes the claim through the NFT's Token Bound Account (TBA),
+ * since the TBA holds the Royalty Tokens.
  *
  * @param tokenId The token ID whose vault to claim from.
  * @param revenueToken The ERC20 revenue token address to claim.
@@ -737,7 +739,8 @@ declare function claimRevenue(this: Origin, tokenId: bigint, revenueToken: Addre
 
 /**
  * Claims accumulated revenue for a token from multiple revenue tokens in a single transaction.
- * The caller must hold Royalty Tokens to claim their proportional share.
+ * Executes the claim through the NFT's Token Bound Account (TBA),
+ * since the TBA holds the Royalty Tokens.
  *
  * @param tokenId The token ID whose vault to claim from.
  * @param revenueTokens Array of ERC20 revenue token addresses to claim.
@@ -763,10 +766,11 @@ interface RoyaltyTokenBalance {
 }
 /**
  * Gets the Royalty Token balance for a holder in a token's vault.
- * If no holder is provided, the connected wallet address is used.
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
+ * since RT tokens are minted to the TBA by default.
  *
  * @param tokenId The token ID whose vault to query.
- * @param holder Optional holder address. Defaults to connected wallet.
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
  * @returns The royalty token balance info including vault address, balance, total supply, percentage, and decimals.
  */
 declare function getRoyaltyTokenBalance(this: Origin, tokenId: bigint, holder?: Address): Promise<RoyaltyTokenBalance>;

package/dist/core.esm.d.ts

@@ -716,18 +716,20 @@ declare function getVaultRevenueTokens(this: Origin, tokenId: bigint): Promise<A
 
 /**
  * Returns the amount of revenue claimable by a holder for a given token and revenue token.
- * If no holder is provided, the connected wallet address is used.
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
+ * since RT tokens are held in the TBA by default.
  *
  * @param tokenId The token ID whose vault to query.
  * @param revenueToken The ERC20 revenue token address.
- * @param holder Optional holder address. Defaults to connected wallet.
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
  * @returns The claimable amount in the revenue token's smallest unit.
  */
 declare function claimableRevenue(this: Origin, tokenId: bigint, revenueToken: Address, holder?: Address): Promise<bigint>;
 
 /**
  * Claims accumulated revenue for a token from a specific revenue token.
- * The caller must hold Royalty Tokens to claim their proportional share.
+ * Executes the claim through the NFT's Token Bound Account (TBA),
+ * since the TBA holds the Royalty Tokens.
  *
  * @param tokenId The token ID whose vault to claim from.
  * @param revenueToken The ERC20 revenue token address to claim.
@@ -737,7 +739,8 @@ declare function claimRevenue(this: Origin, tokenId: bigint, revenueToken: Addre
 
 /**
  * Claims accumulated revenue for a token from multiple revenue tokens in a single transaction.
- * The caller must hold Royalty Tokens to claim their proportional share.
+ * Executes the claim through the NFT's Token Bound Account (TBA),
+ * since the TBA holds the Royalty Tokens.
  *
  * @param tokenId The token ID whose vault to claim from.
  * @param revenueTokens Array of ERC20 revenue token addresses to claim.
@@ -763,10 +766,11 @@ interface RoyaltyTokenBalance {
 }
 /**
  * Gets the Royalty Token balance for a holder in a token's vault.
- * If no holder is provided, the connected wallet address is used.
+ * If no holder is provided, the NFT's Token Bound Account (TBA) is used,
+ * since RT tokens are minted to the TBA by default.
  *
  * @param tokenId The token ID whose vault to query.
- * @param holder Optional holder address. Defaults to connected wallet.
+ * @param holder Optional holder address. Defaults to the NFT's TBA.
  * @returns The royalty token balance info including vault address, balance, total supply, percentage, and decimals.
  */
 declare function getRoyaltyTokenBalance(this: Origin, tokenId: bigint, holder?: Address): Promise<RoyaltyTokenBalance>;