package op
- Alphabetic
- Public
- Protected
Type Members
- case class AccountMergeOperation(destination: AccountId, sourceAccount: Option[AccountId] = None) extends PayOperation with Product with Serializable
Deletes account and transfers remaining balance to destination account.
Deletes account and transfers remaining balance to destination account.
- destination
the account to receive the residual balances of the account to be merged
- sourceAccount
the account to be merged, if different from the owning account of the transaction
- See also
- case class BeginSponsoringFutureReservesOperation(sponsored: AccountId, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Begin sponsoring (paying for) any reserve that the sponsored account would have to pay.
Begin sponsoring (paying for) any reserve that the sponsored account would have to pay.
- sponsored
the id of the account that is being sponsored.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class BumpSequenceOperation(bumpTo: Long, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Bumps forward the sequence number of the source account of the operation, allowing it to invalidate any transactions with a smaller sequence number.
Bumps forward the sequence number of the source account of the operation, allowing it to invalidate any transactions with a smaller sequence number.
- bumpTo
the number to increase the sequence number to
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class ChangeTrustOperation(limit: IssuedAmount, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
The source account is stating that it will trust the asset of the limit up to the amount of the limit.
The source account is stating that it will trust the asset of the limit up to the amount of the limit.
- limit
the asset to be trusted and the limit of that trust
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class ClaimClaimableBalanceOperation(id: ClaimableBalanceId, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Claims a previously created claimable balance.
Claims a previously created claimable balance.
- id
the id of the claimable balance entry to attempt to claim.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class ClawBackClaimableBalanceOperation(id: ClaimableBalanceId, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Claw back a claimable balance by its id.
- case class ClawBackOperation(from: AccountId, amount: IssuedAmount, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Claw back an asset from an account.
- case class CreateAccountOperation(destinationAccount: AccountId, startingBalance: NativeAmount = Amount.lumens(1), sourceAccount: Option[AccountId] = None) extends PayOperation with Product with Serializable
Funds and creates a new account.
Funds and creates a new account.
- destinationAccount
the account to be created
- startingBalance
the amount of funds to send to it
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class CreateBuyOfferOperation(selling: Asset, buying: Amount, price: Price, sourceAccount: Option[AccountId] = None) extends ManageBuyOfferOperation with Product with Serializable
Creates a buy offer in the Stellar network.
- case class CreateClaimableBalanceOperation(amount: Amount, claimants: List[Claimant], sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Creates a payment reservation, referred to as a claimable balance.
Creates a payment reservation, referred to as a claimable balance.
- amount
the reserved payment amount
- claimants
the accounts who can claim this payment, along with the requirements for doing so.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class CreatePassiveSellOfferOperation(selling: Amount, buying: Asset, price: Price, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Creates an offer that won’t consume a counter offer that exactly matches this offer.
Creates an offer that won’t consume a counter offer that exactly matches this offer.
- selling
the total amount of tokens being offered
- buying
the asset being sought
- price
the price the offerer is willing to accept
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class CreateSellOfferOperation(selling: Amount, buying: Asset, price: Price, sourceAccount: Option[AccountId] = None) extends ManageSellOfferOperation with Product with Serializable
Creates a sell offer in the Stellar network.
- case class DeleteBuyOfferOperation(offerId: Long, selling: Asset, buying: Asset, price: Price, sourceAccount: Option[AccountId] = None) extends ManageBuyOfferOperation with Product with Serializable
Deletes a buy offer in the Stellar network.
Deletes a buy offer in the Stellar network.
- offerId
the id of the offer to be deleted
- selling
the asset previously offered
- buying
the asset previously sought
- price
the price being offered
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class DeleteDataOperation(name: String, sourceAccount: Option[AccountId] = None) extends ManageDataOperation with Product with Serializable
Deletes a Data Entry (name/value pair) for an account.
Deletes a Data Entry (name/value pair) for an account.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class DeleteSellOfferOperation(offerId: Long, selling: Asset, buying: Asset, price: Price, sourceAccount: Option[AccountId] = None) extends ManageSellOfferOperation with Product with Serializable
Deletes a sell offer in the Stellar network.
Deletes a sell offer in the Stellar network.
- offerId
the id of the offer to be deleted
- selling
the asset being offered
- buying
the asset previously sought
- price
the price being offered
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class EndSponsoringFutureReservesOperation(sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
End sponsoring all reserves from the source account.
- case class InflationOperation(sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Requests that the network runs the inflation process.
Requests that the network runs the inflation process. As of Stellar Core v12, this operation does nothing.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- sealed trait IssuerFlag extends AnyRef
- sealed trait ManageBuyOfferOperation extends Operation
- sealed trait ManageDataOperation extends Operation
- sealed trait ManageSellOfferOperation extends Operation
- sealed trait Operation extends AnyRef
An Operation represents a change to the ledger.
An Operation represents a change to the ledger. It is the action, as opposed to the effects resulting from that action.
- case class PathPaymentStrictReceiveOperation(sendMax: Amount, destinationAccount: AccountId, destinationAmount: Amount, path: Seq[Asset] = Nil, sourceAccount: Option[AccountId] = None) extends PayOperation with Product with Serializable
Represents a payment from one account to another through a path.
Represents a payment from one account to another through a path. This type of payment starts as one type of asset and ends as another type of asset. There can be other assets that are traded into and out of along the path. Suitable orders must exist on the relevant order books for this operation to be successful. This operation specifies a precise amount to be received, and a maximum amount that can be sent. If you need to specify the amount sent, use PathPaymentStrictSendOperation instead.
- sendMax
the maximum amount willing to be spent to effect the payment
- destinationAccount
the payment recipient
- destinationAmount
the exact amount to be received
- path
the intermediate assets to traverse (may be empty)
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class PathPaymentStrictSendOperation(sendAmount: Amount, destinationAccount: AccountId, destinationMin: Amount, path: Seq[Asset] = Nil, sourceAccount: Option[AccountId] = None) extends PayOperation with Product with Serializable
Represents a payment from one account to another through a path.
Represents a payment from one account to another through a path. This type of payment starts as one type of asset and ends as another type of asset. There can be other assets that are traded into and out of along the path. Suitable orders must exist on the relevant order books for this operation to be successful. This operation specifies a precise amount to be sent, and a minimum amount that can be received. If you need to specify the amount received, use PathPaymentStrictReceiveOperation instead.
- sendAmount
the amount to be spent to effect the payment
- destinationAccount
the payment recipient
- destinationMin
the minimum amount that should be received
- path
the intermediate assets to traverse (may be empty)
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- sealed trait PayOperation extends Operation
Marker trait for any operation that involves a payment (
CreateAccountOperation,PaymentOperation,PathPaymentOperation,AccountMergeOperation) - case class PaymentOperation(destinationAccount: AccountId, amount: Amount, sourceAccount: Option[AccountId] = None) extends PayOperation with Product with Serializable
Represents a payment from one account to another.
Represents a payment from one account to another. This payment can be either a simple native asset payment or a fiat asset payment.
- destinationAccount
the recipient of the payment
- amount
the amount to be paid
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class RevokeAccountSponsorshipOperation(revokeAccountKey: AccountKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove the sponsorship of ledger account entries.
Remove the sponsorship of ledger account entries.
- revokeAccountKey
the key for the account ledger entry to have its sponsorship removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class RevokeClaimableBalanceSponsorshipOperation(revokeClaimableBalanceKey: ClaimableBalanceKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove the sponsorship of ledger claimable balance entries.
Remove the sponsorship of ledger claimable balance entries.
- revokeClaimableBalanceKey
the key for the claimable balance entry to have its sponsorship removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class RevokeDataSponsorshipOperation(revokeDataKey: DataKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove the sponsorship of ledger data entries.
Remove the sponsorship of ledger data entries.
- revokeDataKey
the key for the data ledger entry to have its sponsorship removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class RevokeOfferSponsorshipOperation(revokeOfferKey: OfferKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove the sponsorship of ledger offer entries.
Remove the sponsorship of ledger offer entries.
- revokeOfferKey
the key for the offer ledger entry to have its sponsorship removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class RevokeSignerSponsorshipOperation(accountId: AccountId, signerKey: SignerStrKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove a signer's sponsorship of an account.
Remove a signer's sponsorship of an account.
- accountId
the id for the account to have a sponsor removed.
- signerKey
the signer's key of the sponsor to be removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- sealed trait RevokeSponsorshipOperation extends Operation
- case class RevokeTrustLineSponsorshipOperation(revokeTrustLineKey: TrustLineKey, sourceAccount: Option[AccountId] = None) extends RevokeSponsorshipOperation with Product with Serializable
Remove the sponsorship of ledger trustline entries.
Remove the sponsorship of ledger trustline entries.
- revokeTrustLineKey
the key for the trustline ledger entry to have its sponsorship removed.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction.
- case class SetOptionsOperation(inflationDestination: Option[PublicKeyOps] = None, clearFlags: Option[Set[IssuerFlag]] = None, setFlags: Option[Set[IssuerFlag]] = None, masterKeyWeight: Option[Int] = None, lowThreshold: Option[Int] = None, mediumThreshold: Option[Int] = None, highThreshold: Option[Int] = None, homeDomain: Option[String] = None, signer: Option[Signer] = None, sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Modify an account, setting one or more options.
Modify an account, setting one or more options.
- inflationDestination
the account's inflation destination
- clearFlags
issuer flags to be turned off
- setFlags
issuer flags to be turned on
- masterKeyWeight
the weight of the master key
- lowThreshold
the minimum weight required for low threshold operations
- mediumThreshold
the minimum weight required for medium threshold operations
- highThreshold
the minimum weight required for highthreshold operations
- homeDomain
the home domain used for reverse federation lookup
- signer
the key and weight of the signer for this account
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class SetTrustLineFlagsOperation(asset: NonNativeAsset, trustor: PublicKeyOps, setFlags: Set[TrustLineFlags], clearFlags: Set[TrustLineFlags], sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Set flags on the trustline for an account.
- case class Transacted[+O <: Operation](id: Long, txnHash: String, createdAt: ZonedDateTime, operation: O) extends Product with Serializable
Provides access to additional information related to an operation after it has been transacted in the network.
- sealed trait TrustLineFlag extends AnyRef
- case class UpdateBuyOfferOperation(offerId: Long, selling: Asset, buying: Amount, price: Price, sourceAccount: Option[AccountId] = None) extends ManageBuyOfferOperation with Product with Serializable
Updates a sell offer in the Stellar network.
Updates a sell offer in the Stellar network.
- offerId
the id of the offer to be modified
- selling
the asset offered
- buying
the asset and amount being sought
- price
the price being sought
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class UpdateSellOfferOperation(offerId: Long, selling: Amount, buying: Asset, price: Price, sourceAccount: Option[AccountId] = None) extends ManageSellOfferOperation with Product with Serializable
Updates a sell offer in the Stellar network.
Updates a sell offer in the Stellar network.
- offerId
the id of the offer to be modified
- selling
the asset and amount being offered
- buying
the asset sought
- price
the price being offered
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
- case class WriteDataOperation(name: String, value: Seq[Byte], sourceAccount: Option[AccountId] = None) extends ManageDataOperation with Product with Serializable
Creates or updates a Data Entry (name/value pair) for an account.
Creates or updates a Data Entry (name/value pair) for an account.
- sourceAccount
the account effecting this operation, if different from the owning account of the transaction
- See also
Deprecated Type Members
- case class AllowTrustOperation(trustor: PublicKeyOps, assetCode: String, trustLineFlags: Set[TrustLineFlag], sourceAccount: Option[AccountId] = None) extends Operation with Product with Serializable
Updates the “authorized” flag of an existing trust line.
Updates the “authorized” flag of an existing trust line. This is called by the issuer of the related asset.
- Annotations
- @deprecated
- Deprecated
(Since version v0.20.0) Use SetTrustLineFlagsOperation instead
Value Members
- object AccountMergeOperation extends Serializable
- object AllowTrustOperation extends Serializable
- case object AuthorizationClawbackEnabledFlag extends IssuerFlag with Product with Serializable
- case object AuthorizationImmutableFlag extends IssuerFlag with Product with Serializable
- case object AuthorizationRequiredFlag extends IssuerFlag with Product with Serializable
- case object AuthorizationRevocableFlag extends IssuerFlag with Product with Serializable
- object BeginSponsoringFutureReservesOperation extends Serializable
- object BumpSequenceOperation extends Serializable
- object ChangeTrustOperation extends Serializable
- object ClaimClaimableBalanceOperation extends Serializable
- object CreateAccountOperation extends Serializable
- object CreateClaimableBalanceOperation extends Serializable
- object CreatePassiveSellOfferOperation extends Serializable
- object EndSponsoringFutureReservesOperation extends Serializable
- object InflationOperation extends Serializable
- object IssuerFlags
- object ManageBuyOfferOperation
- object ManageDataOperation
- object ManageSellOfferOperation
- object Operation
- object OperationDeserializer extends ResponseParser[Operation]
- object PathPaymentStrictReceiveOperation extends Serializable
- object PathPaymentStrictSendOperation extends Serializable
- object PaymentOperation extends Serializable
- object RevokeSponsorshipOperation
- object SetOptionsOperation extends Serializable
- object TransactedOperationDeserializer extends ResponseParser[Transacted[Operation]]
- case object TrustLineAuthorized extends TrustLineFlag with Product with Serializable
- case object TrustLineCanMaintainLiabilities extends TrustLineFlag with Product with Serializable
- object TrustLineFlags
- object WriteDataOperation extends Serializable