ClaimableBalanceCreatedEffectResponse class

Represents a claimable balance created effect response from Horizon.

This effect occurs when an account creates a claimable balance that can be claimed by one or more designated claimants. Claimable balances allow for conditional payments and escrow-like functionality.

Triggered by: CreateClaimableBalanceOperation Returned by: Horizon API effects endpoint when querying for claimable balance creation effects

Example:

final effects = await sdk.effects.forAccount('account_id').execute();
for (var effect in effects.records) {
  if (effect is ClaimableBalanceCreatedEffectResponse) {
    print('Claimable balance created: ${effect.amount} ${effect.asset.code}');
    print('Balance ID: ${effect.balanceId}');
  }
}

See also:

Inheritance

Constructors

ClaimableBalanceCreatedEffectResponse(String balanceId, Asset asset, String amount, String id, int type_i, String type, String createdAt, String pagingToken, String account, EffectResponseLinks links)
Creates a ClaimableBalanceCreatedEffectResponse from Horizon API effect data.
ClaimableBalanceCreatedEffectResponse.fromJson(Map<String, dynamic> json)
factory

Properties

account ↔ String
Account ID affected by this effect
getter/setter pairinherited
accountMuxed ↔ String?
Muxed account address if the account is a muxed account
getter/setter pairinherited
accountMuxedId ↔ String?
Muxed account sub-account ID if applicable
getter/setter pairinherited
amount ↔ String
The amount of the asset in the claimable balance
getter/setter pair
asset ↔ Asset
The asset type and code of the claimable balance
getter/setter pair
balanceId ↔ String
The unique ID of the claimable balance
getter/setter pair
createdAt ↔ String
When this effect occurred in ISO 8601 format
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String
Unique identifier for this effect
getter/setter pairinherited
Links to related resources
getter/setter pairinherited
pagingToken ↔ String
Cursor for pagination
getter/setter pairinherited
rateLimitLimit ↔ int?
Maximum number of requests allowed in the current rate limit window.
getter/setter pairinherited
rateLimitRemaining ↔ int?
Number of requests remaining in the current rate limit window.
getter/setter pairinherited
rateLimitReset ↔ int?
Unix timestamp when the rate limit window will reset.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type ↔ String
Human-readable effect type name
getter/setter pairinherited
type_i ↔ int
Effect type as integer code
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setHeaders(Map<String, String> headers) → void
Populates rate limit fields from HTTP response headers.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited