infra-sdk-typescript 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -352,8 +352,27 @@ declare class WalletResource extends APIResource {
 
 type TokenType = "ASSET" | "YIELD_BEARING";
 type TokenStatus = LooseUnion<"PENDING" | "ACTIVE" | "PAUSED" | "RETIRED">;
-type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT" | "FORCED_TRANSFER">;
+type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT" | "FORCED_TRANSFER" | "CLAIM" | "RECLAIM">;
 type TokenTransactionStatus = LooseUnion<"PENDING" | "CONFIRMED" | "FAILED">;
+/**
+ * Where pushing a distribution's yield to investors stands, on a `SNAPSHOT` transaction created
+ * with `pushYield: true`.
+ *
+ * - `PENDING` — requested; the push runs once the snapshot confirms.
+ * - `SUBMITTED` — the push transaction was sent but hasn't settled yet.
+ * - `PUSHED` — the push transaction was mined and succeeded.
+ * - `FAILED` — the push failed; see `pushFailureReason`.
+ */
+type YieldPushStatus = LooseUnion<"PENDING" | "SUBMITTED" | "PUSHED" | "FAILED">;
+/**
+ * Outcome of a yield claim or reclaim when the call returns.
+ *
+ * - `COMPLETED` — the transaction was mined and succeeded.
+ * - `SUBMITTED` — the transaction was sent but hasn't settled yet. Poll
+ *   {@link TokenizationResource.getTokenTransaction} with the result's `operationRef`; its `status`
+ *   becomes `CONFIRMED` or `FAILED`.
+ */
+type YieldSettlementStatus = LooseUnion<"COMPLETED" | "SUBMITTED">;
 /**
  * Chain id a token is deployed on, e.g. `84532` (Base Sepolia). The API accepts it as a number
  * or a numeric string; responses always return it as a string.
@@ -522,6 +541,11 @@ interface TokenOperationResult {
 /** Result of {@link TokenizationResource.transferToken}. */
 interface TokenTransferResult {
     tokenId: string;
+    /**
+     * `CONFIRMED` once mined. `FAILED` when the transfer was rejected or reverted on-chain; the call
+     * still resolves in that case, so check this rather than relying on an error. `txHash` is set
+     * when the failed transfer was mined.
+     */
     status: TokenTransactionStatus;
     transactionId: string;
     fromAddressIndex: number;
@@ -566,8 +590,24 @@ interface TokenWalletBalance {
     /** Balance in token units, as a decimal string. */
     balance: string;
     decimals: number;
-    /** The wallet's cNGN (payout token) balance, as a decimal string. Coupons, yield and principal are paid in cNGN. */
-    cNgnBalance: string;
+}
+interface GetPayoutBalanceParams {
+    chainId: TokenChainId;
+    walletAddress: string;
+}
+/**
+ * A wallet's balance of the chain's payout token, returned by
+ * {@link TokenizationResource.getPayoutBalance}. Coupons, yield and principal are all paid in it.
+ */
+interface PayoutBalance {
+    chainId: string;
+    walletAddress: string;
+    payoutToken: YieldPayoutToken;
+    /** The payout token's contract address on this chain. */
+    tokenAddress: string;
+    /** Balance in payout-token units, as a decimal string, e.g. `"1234.56"`. */
+    balance: string;
+    decimals: number;
 }
 interface ListTokenTransactionsParams {
     tokenId?: string;
@@ -581,7 +621,10 @@ interface ListTokenTransactionsParams {
     txHash?: string;
     operationRef?: string;
 }
-/** A recorded on-chain operation against a token (mint, burn, or transfer). */
+/**
+ * A recorded on-chain operation against a token: a mint, burn or transfer, a deployment, a yield
+ * distribution (`SNAPSHOT`), or a yield claim (`CLAIM`) or reclaim (`RECLAIM`).
+ */
 interface TokenTransactionRecord {
     id: string;
     tokenId: string;
@@ -602,8 +645,18 @@ interface TokenTransactionRecord {
     memo?: string;
     createdAt?: string;
     confirmedAt?: string;
-    /** Distribution snapshot id, set on `SNAPSHOT` transactions. */
+    /** Distribution snapshot id, set on `SNAPSHOT`, `CLAIM` and `RECLAIM` transactions. */
     snapshotId?: number;
+    /** Why the transaction failed, when `status` is `FAILED`. */
+    failureReason?: string;
+    /** Whether the distribution pushes yield to investors. Set on `SNAPSHOT` transactions. */
+    pushYield?: boolean;
+    /** Progress of the push, on `SNAPSHOT` transactions with `pushYield`. Absent when no push was requested or made. */
+    pushStatus?: YieldPushStatus;
+    /** Hash of the push transaction, once sent. */
+    pushTxHash?: string;
+    /** Why the push failed, when `pushStatus` is `FAILED`. */
+    pushFailureReason?: string;
 }
 interface UpdateTokenYieldParams {
     /** Yield-bearing token id. */
@@ -750,17 +803,22 @@ interface ReclaimUnclaimedYieldParams {
 /** Result of {@link TokenizationResource.reclaimUnclaimedYield}. */
 interface ReclaimUnclaimedYieldResult {
     tokenId: string;
-    /** Snapshot id, as a numeric string. */
-    snapshotId: string;
-    /** Amount reclaimed, as a decimal string. */
+    snapshotId: number;
+    /** Amount reclaimed, in cNGN base units (6 decimals), as an integer string. */
     reclaimed: string;
     operationRef: string;
+    /** Id of the `RECLAIM` transaction record. */
+    transactionId: string;
     txHash: string;
+    status: YieldSettlementStatus;
 }
 /** Result of {@link TokenizationResource.claimYield}. */
 interface YieldTxResult {
     operationRef: string;
+    /** Id of the `CLAIM` transaction record. */
+    transactionId: string;
     txHash: string;
+    status: YieldSettlementStatus;
 }
 /** Result of {@link TokenizationResource.distributeYield} / {@link TokenizationResource.payCoupon}. */
 interface YieldOperationResult {
@@ -799,7 +857,10 @@ declare class TokenizationResource extends APIResource {
     mintToken(params: MintTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
     /** Burns units of a token from a holder address. */
     burnToken(params: BurnTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
-    /** Transfers token units between holder addresses. */
+    /**
+     * Transfers token units between holder addresses. A transfer that is rejected or reverts
+     * on-chain still resolves, with `status: "FAILED"`, so check `status` rather than relying on an error.
+     */
     transferToken(params: TransferTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenTransferResult>;
     /**
      * Force-transfers token units out of a holder's address without the holder's signature
@@ -811,8 +872,13 @@ declare class TokenizationResource extends APIResource {
     registerWallet(params: RegisterTokenWalletParams, overrides?: IdempotentRequestOverrides): Promise<RegisterTokenWalletResult>;
     /** Returns the paginated list of holder wallet addresses and balances for a token on a chain. */
     getTokenHolders(params: GetTokenHoldersParams, overrides?: RequestOverrides): Promise<Page<TokenHolder>>;
-    /** Returns a single wallet's balance of a token on a chain, plus its cNGN (payout token) balance. */
+    /** Returns a single wallet's balance of a token on a chain. For its cNGN balance, use {@link getPayoutBalance}. */
     getWalletBalance(params: GetWalletBalanceParams, overrides?: RequestOverrides): Promise<TokenWalletBalance>;
+    /**
+     * Returns a wallet's balance of the chain's payout token (cNGN), in which coupons, yield and
+     * principal are paid. It depends only on the chain and wallet, so no token is needed.
+     */
+    getPayoutBalance(params: GetPayoutBalanceParams, overrides?: RequestOverrides): Promise<PayoutBalance>;
     /** Fetches a single token transaction by its reference. */
     getTokenTransaction(ref: string, overrides?: RequestOverrides): Promise<TokenTransactionRecord>;
     /** Returns token transactions, optionally filtered by token. */
@@ -826,7 +892,11 @@ declare class TokenizationResource extends APIResource {
     distributeYield(params: DistributeYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
     payCoupon(params: PayCouponParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
-    /** Claims an investor's yield for a given distribution snapshot. */
+    /**
+     * Claims an investor's yield for a given distribution snapshot. `status` is `COMPLETED` once the
+     * claim is mined. If it's `SUBMITTED`, the outcome isn't known yet: poll
+     * {@link getTokenTransaction} with the result's `operationRef` until its `status` is `CONFIRMED` or `FAILED`.
+     */
     claimYield(params: ClaimYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
     /**
      * Returns the bond's next coupon date and where it stands on its schedule. Whether a coupon is
@@ -851,7 +921,8 @@ declare class TokenizationResource extends APIResource {
     redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<RedeemPrincipalResult>;
     /**
      * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
-     * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+     * passed. An `Idempotency-Key` is generated per call unless you pass your own. As with
+     * {@link claimYield}, a `SUBMITTED` status means the outcome should be polled by `operationRef`.
      */
     reclaimUnclaimedYield(params: ReclaimUnclaimedYieldParams, overrides?: IdempotentRequestOverrides): Promise<ReclaimUnclaimedYieldResult>;
 }
@@ -1108,4 +1179,4 @@ declare function verifyIndexerWebhookSignature(options: VerifyIndexerWebhookOpti
 /** Generates a UUIDv4 suitable for use as an `Idempotency-Key` header value. */
 declare function generateIdempotencyKey(): string;
 
-export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetNextCouponParams, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, type NextCoupon, type NextCouponStatus, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RedemptionSkipReason, type RedemptionSkippedHolder, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };
+export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetNextCouponParams, type GetPayoutBalanceParams, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, type NextCoupon, type NextCouponStatus, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, type PayoutBalance, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RedemptionSkipReason, type RedemptionSkippedHolder, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldPushStatus, type YieldSettlementStatus, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };

package/dist/index.d.ts

@@ -352,8 +352,27 @@ declare class WalletResource extends APIResource {
 
 type TokenType = "ASSET" | "YIELD_BEARING";
 type TokenStatus = LooseUnion<"PENDING" | "ACTIVE" | "PAUSED" | "RETIRED">;
-type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT" | "FORCED_TRANSFER">;
+type TokenTransactionType = LooseUnion<"MINT" | "BURN" | "TRANSFER" | "DEPLOY" | "REDEEM" | "SNAPSHOT" | "FORCED_TRANSFER" | "CLAIM" | "RECLAIM">;
 type TokenTransactionStatus = LooseUnion<"PENDING" | "CONFIRMED" | "FAILED">;
+/**
+ * Where pushing a distribution's yield to investors stands, on a `SNAPSHOT` transaction created
+ * with `pushYield: true`.
+ *
+ * - `PENDING` — requested; the push runs once the snapshot confirms.
+ * - `SUBMITTED` — the push transaction was sent but hasn't settled yet.
+ * - `PUSHED` — the push transaction was mined and succeeded.
+ * - `FAILED` — the push failed; see `pushFailureReason`.
+ */
+type YieldPushStatus = LooseUnion<"PENDING" | "SUBMITTED" | "PUSHED" | "FAILED">;
+/**
+ * Outcome of a yield claim or reclaim when the call returns.
+ *
+ * - `COMPLETED` — the transaction was mined and succeeded.
+ * - `SUBMITTED` — the transaction was sent but hasn't settled yet. Poll
+ *   {@link TokenizationResource.getTokenTransaction} with the result's `operationRef`; its `status`
+ *   becomes `CONFIRMED` or `FAILED`.
+ */
+type YieldSettlementStatus = LooseUnion<"COMPLETED" | "SUBMITTED">;
 /**
  * Chain id a token is deployed on, e.g. `84532` (Base Sepolia). The API accepts it as a number
  * or a numeric string; responses always return it as a string.
@@ -522,6 +541,11 @@ interface TokenOperationResult {
 /** Result of {@link TokenizationResource.transferToken}. */
 interface TokenTransferResult {
     tokenId: string;
+    /**
+     * `CONFIRMED` once mined. `FAILED` when the transfer was rejected or reverted on-chain; the call
+     * still resolves in that case, so check this rather than relying on an error. `txHash` is set
+     * when the failed transfer was mined.
+     */
     status: TokenTransactionStatus;
     transactionId: string;
     fromAddressIndex: number;
@@ -566,8 +590,24 @@ interface TokenWalletBalance {
     /** Balance in token units, as a decimal string. */
     balance: string;
     decimals: number;
-    /** The wallet's cNGN (payout token) balance, as a decimal string. Coupons, yield and principal are paid in cNGN. */
-    cNgnBalance: string;
+}
+interface GetPayoutBalanceParams {
+    chainId: TokenChainId;
+    walletAddress: string;
+}
+/**
+ * A wallet's balance of the chain's payout token, returned by
+ * {@link TokenizationResource.getPayoutBalance}. Coupons, yield and principal are all paid in it.
+ */
+interface PayoutBalance {
+    chainId: string;
+    walletAddress: string;
+    payoutToken: YieldPayoutToken;
+    /** The payout token's contract address on this chain. */
+    tokenAddress: string;
+    /** Balance in payout-token units, as a decimal string, e.g. `"1234.56"`. */
+    balance: string;
+    decimals: number;
 }
 interface ListTokenTransactionsParams {
     tokenId?: string;
@@ -581,7 +621,10 @@ interface ListTokenTransactionsParams {
     txHash?: string;
     operationRef?: string;
 }
-/** A recorded on-chain operation against a token (mint, burn, or transfer). */
+/**
+ * A recorded on-chain operation against a token: a mint, burn or transfer, a deployment, a yield
+ * distribution (`SNAPSHOT`), or a yield claim (`CLAIM`) or reclaim (`RECLAIM`).
+ */
 interface TokenTransactionRecord {
     id: string;
     tokenId: string;
@@ -602,8 +645,18 @@ interface TokenTransactionRecord {
     memo?: string;
     createdAt?: string;
     confirmedAt?: string;
-    /** Distribution snapshot id, set on `SNAPSHOT` transactions. */
+    /** Distribution snapshot id, set on `SNAPSHOT`, `CLAIM` and `RECLAIM` transactions. */
     snapshotId?: number;
+    /** Why the transaction failed, when `status` is `FAILED`. */
+    failureReason?: string;
+    /** Whether the distribution pushes yield to investors. Set on `SNAPSHOT` transactions. */
+    pushYield?: boolean;
+    /** Progress of the push, on `SNAPSHOT` transactions with `pushYield`. Absent when no push was requested or made. */
+    pushStatus?: YieldPushStatus;
+    /** Hash of the push transaction, once sent. */
+    pushTxHash?: string;
+    /** Why the push failed, when `pushStatus` is `FAILED`. */
+    pushFailureReason?: string;
 }
 interface UpdateTokenYieldParams {
     /** Yield-bearing token id. */
@@ -750,17 +803,22 @@ interface ReclaimUnclaimedYieldParams {
 /** Result of {@link TokenizationResource.reclaimUnclaimedYield}. */
 interface ReclaimUnclaimedYieldResult {
     tokenId: string;
-    /** Snapshot id, as a numeric string. */
-    snapshotId: string;
-    /** Amount reclaimed, as a decimal string. */
+    snapshotId: number;
+    /** Amount reclaimed, in cNGN base units (6 decimals), as an integer string. */
     reclaimed: string;
     operationRef: string;
+    /** Id of the `RECLAIM` transaction record. */
+    transactionId: string;
     txHash: string;
+    status: YieldSettlementStatus;
 }
 /** Result of {@link TokenizationResource.claimYield}. */
 interface YieldTxResult {
     operationRef: string;
+    /** Id of the `CLAIM` transaction record. */
+    transactionId: string;
     txHash: string;
+    status: YieldSettlementStatus;
 }
 /** Result of {@link TokenizationResource.distributeYield} / {@link TokenizationResource.payCoupon}. */
 interface YieldOperationResult {
@@ -799,7 +857,10 @@ declare class TokenizationResource extends APIResource {
     mintToken(params: MintTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
     /** Burns units of a token from a holder address. */
     burnToken(params: BurnTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
-    /** Transfers token units between holder addresses. */
+    /**
+     * Transfers token units between holder addresses. A transfer that is rejected or reverts
+     * on-chain still resolves, with `status: "FAILED"`, so check `status` rather than relying on an error.
+     */
     transferToken(params: TransferTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenTransferResult>;
     /**
      * Force-transfers token units out of a holder's address without the holder's signature
@@ -811,8 +872,13 @@ declare class TokenizationResource extends APIResource {
     registerWallet(params: RegisterTokenWalletParams, overrides?: IdempotentRequestOverrides): Promise<RegisterTokenWalletResult>;
     /** Returns the paginated list of holder wallet addresses and balances for a token on a chain. */
     getTokenHolders(params: GetTokenHoldersParams, overrides?: RequestOverrides): Promise<Page<TokenHolder>>;
-    /** Returns a single wallet's balance of a token on a chain, plus its cNGN (payout token) balance. */
+    /** Returns a single wallet's balance of a token on a chain. For its cNGN balance, use {@link getPayoutBalance}. */
     getWalletBalance(params: GetWalletBalanceParams, overrides?: RequestOverrides): Promise<TokenWalletBalance>;
+    /**
+     * Returns a wallet's balance of the chain's payout token (cNGN), in which coupons, yield and
+     * principal are paid. It depends only on the chain and wallet, so no token is needed.
+     */
+    getPayoutBalance(params: GetPayoutBalanceParams, overrides?: RequestOverrides): Promise<PayoutBalance>;
     /** Fetches a single token transaction by its reference. */
     getTokenTransaction(ref: string, overrides?: RequestOverrides): Promise<TokenTransactionRecord>;
     /** Returns token transactions, optionally filtered by token. */
@@ -826,7 +892,11 @@ declare class TokenizationResource extends APIResource {
     distributeYield(params: DistributeYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
     payCoupon(params: PayCouponParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
-    /** Claims an investor's yield for a given distribution snapshot. */
+    /**
+     * Claims an investor's yield for a given distribution snapshot. `status` is `COMPLETED` once the
+     * claim is mined. If it's `SUBMITTED`, the outcome isn't known yet: poll
+     * {@link getTokenTransaction} with the result's `operationRef` until its `status` is `CONFIRMED` or `FAILED`.
+     */
     claimYield(params: ClaimYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
     /**
      * Returns the bond's next coupon date and where it stands on its schedule. Whether a coupon is
@@ -851,7 +921,8 @@ declare class TokenizationResource extends APIResource {
     redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<RedeemPrincipalResult>;
     /**
      * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
-     * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+     * passed. An `Idempotency-Key` is generated per call unless you pass your own. As with
+     * {@link claimYield}, a `SUBMITTED` status means the outcome should be polled by `operationRef`.
      */
     reclaimUnclaimedYield(params: ReclaimUnclaimedYieldParams, overrides?: IdempotentRequestOverrides): Promise<ReclaimUnclaimedYieldResult>;
 }
@@ -1108,4 +1179,4 @@ declare function verifyIndexerWebhookSignature(options: VerifyIndexerWebhookOpti
 /** Generates a UUIDv4 suitable for use as an `Idempotency-Key` header value. */
 declare function generateIdempotencyKey(): string;
 
-export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetNextCouponParams, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, type NextCoupon, type NextCouponStatus, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RedemptionSkipReason, type RedemptionSkippedHolder, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };
+export { type AssetClass, AuthenticationError, BadRequestError, type BurnTokenParams, type Chain, type ChainType, type ClaimYieldParams, ConflictError, type CreateSubscriptionParams, type CreateTokenParams, type DeactivateWalletParams, type DistributeYieldParams, type EventCatalogEntry, type EventFamily, type EventKind, type FlatPaginatedResponse, type ForcedTransferTokenParams, type GenerateWalletsParams, type GeneratedWallet, type GetNextCouponParams, type GetPayoutBalanceParams, type GetTokenHoldersParams, type GetTransactionHistoryParams, type GetWalletBalanceParams, type GetWalletByAddressIndexParams, type GetWalletByAddressParams, type GetWalletCountParams, type HdEnabledStatus, type HttpMethod, type IdempotentRequestOverrides, IndexerResource, type IndexerSubscription, type IndexerSubscriptionWithSecret, InfraAPIError, InfraAuthTokenError, InfraClient, type InfraClientOptions, InfraConnectionError, InfraConnectionTimeoutError, InfraError, type InitiateTransferParams, InternalServerError, type ListEventCatalogParams, type ListSubscriptionsParams, type ListTokenTransactionsParams, type ListTokensParams, type ListWalletsParams, type LooseUnion, type MetaPaginatedResponse, type MintTokenParams, type Network, type NextCoupon, type NextCouponStatus, NotFoundError, type OffsetPaginatedResponse, Page, type PayCouponParams, PaymentRequiredError, type PayoutBalance, PermissionDeniedError, type QueryValue, RateLimitError, type ReclaimUnclaimedYieldParams, type ReclaimUnclaimedYieldResult, type RedeemPrincipalParams, type RedeemPrincipalResult, type RedemptionSkipReason, type RedemptionSkippedHolder, type RegisterTokenWalletParams, type RegisterTokenWalletResult, type RequestOptions, type RequestOverrides, ServiceUnavailableError, type SignTransactionParams, type SignTransactionRequest, type SignedTransactionResult, type SubscriptionStatus, type SupportedChain, type TokenChainDeployment, type TokenChainId, type TokenDeploymentResult, type TokenDetail, type TokenHolder, type TokenOperationResult, type TokenStatus, type TokenSummary, type TokenTransactionRecord, type TokenTransactionStatus, type TokenTransactionType, type TokenTransferResult, type TokenType, type TokenWalletBalance, TokenizationResource, type TransactionStatus, type TransferTokenParams, UnknownAPIError, UnprocessableEntityError, type UpdateSubscriptionParams, type UpdateTokenYieldParams, type UpdateYieldResult, type VerifyIndexerWebhookOptions, type VerifyWalletWebhookOptions, type Wallet, type WalletBalance, type WalletCount, WalletResource, type WalletTransaction, WebhookSignatureVerificationError, type YieldDayCount, type YieldOperationResult, type YieldParams, type YieldPayoutToken, type YieldPushStatus, type YieldSettlementStatus, type YieldTxResult, generateIdempotencyKey, verifyIndexerWebhookSignature, verifyWalletWebhookSignature };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { randomUUID, createHmac, timingSafeEqual } from 'crypto';
 
 // src/core/version.ts
-var SDK_VERSION = "0.4.0";
+var SDK_VERSION = "0.5.0";
 
 // src/core/errors.ts
 var InfraError = class extends Error {
@@ -626,7 +626,10 @@ var TokenizationResource = class extends APIResource {
       ...rest
     });
   }
-  /** Transfers token units between holder addresses. */
+  /**
+   * Transfers token units between holder addresses. A transfer that is rejected or reverts
+   * on-chain still resolves, with `status: "FAILED"`, so check `status` rather than relying on an error.
+   */
   async transferToken(params, overrides = {}) {
     const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
@@ -673,7 +676,7 @@ var TokenizationResource = class extends APIResource {
     }).then((raw) => pageFromFlatResponse(raw, fetchPage));
     return fetchPage({ page: params.page, pageSize: params.pageSize });
   }
-  /** Returns a single wallet's balance of a token on a chain, plus its cNGN (payout token) balance. */
+  /** Returns a single wallet's balance of a token on a chain. For its cNGN balance, use {@link getPayoutBalance}. */
   async getWalletBalance(params, overrides = {}) {
     return this.client.request({
       method: "GET",
@@ -682,6 +685,18 @@ var TokenizationResource = class extends APIResource {
       ...overrides
     });
   }
+  /**
+   * Returns a wallet's balance of the chain's payout token (cNGN), in which coupons, yield and
+   * principal are paid. It depends only on the chain and wallet, so no token is needed.
+   */
+  async getPayoutBalance(params, overrides = {}) {
+    return this.client.request({
+      method: "GET",
+      path: "/v1/tokens/payout-balance",
+      query: { ...params },
+      ...overrides
+    });
+  }
   /** Fetches a single token transaction by its reference. */
   async getTokenTransaction(ref, overrides = {}) {
     return this.client.request({
@@ -736,7 +751,11 @@ var TokenizationResource = class extends APIResource {
       ...rest
     });
   }
-  /** Claims an investor's yield for a given distribution snapshot. */
+  /**
+   * Claims an investor's yield for a given distribution snapshot. `status` is `COMPLETED` once the
+   * claim is mined. If it's `SUBMITTED`, the outcome isn't known yet: poll
+   * {@link getTokenTransaction} with the result's `operationRef` until its `status` is `CONFIRMED` or `FAILED`.
+   */
   async claimYield(params, overrides = {}) {
     const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
@@ -786,7 +805,8 @@ var TokenizationResource = class extends APIResource {
   }
   /**
    * Returns a snapshot's unclaimed yield to the issuer once its `reclaimAfter` window has
-   * passed. An `Idempotency-Key` is generated per call unless you pass your own.
+   * passed. An `Idempotency-Key` is generated per call unless you pass your own. As with
+   * {@link claimYield}, a `SUBMITTED` status means the outcome should be polled by `operationRef`.
    */
   async reclaimUnclaimedYield(params, overrides = {}) {
     const { idempotencyKey, ...rest } = overrides;