Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
378 lines (273 sloc) 23.9 KB
title
List of Operations

For a description of how operations work in Stellar, see Operations.

For the protocol specification, see stellar-transactions.x.

Create Account

JavaScript | Java | Go

This operation creates and funds a new account with the specified starting balance.

Threshold: Medium

Result: CreateAccountResult

Parameters:

Parameter Type Description
Destination account ID Account address that is created and funded.
Starting Balance integer Amount of XLM to send to the newly created account. This XLM comes from the source account.

Possible errors:

Error Code Description
CREATE_ACCOUNT_MALFORMED -1 The destination is invalid.
CREATE_ACCOUNT_UNDERFUNDED -2 The source account performing the command does not have enough funds to give destination the starting balance amount of XLM and still maintain its minimum XLM reserve plus satisfy its XLM selling liabilities.
CREATE_ACCOUNT_LOW_RESERVE -3 This operation would create an account with fewer than the minimum number of XLM an account must hold.
CREATE_ACCOUNT_ALREADY_EXIST -4 The destination account already exists.

Payment

JavaScript | Java | Go

Sends an amount in a specific asset to a destination account.

Threshold: Medium

Result: PaymentResult

Parameters:

Parameters Type Description
Destination account ID Account address that receives the payment.
Asset asset Asset to send to the destination account.
Amount integer Amount of the aforementioned asset to send.

Possible errors:

Error Code Description
PAYMENT_MALFORMED -1 The input to the payment is invalid.
PAYMENT_UNDERFUNDED -2 The source account (sender) does not have enough funds to send amount and still satisfy its selling liabilities. Note that if sending XLM then the sender must additionally maintain its minimum XLM reserve.
PAYMENT_SRC_NO_TRUST -3 The source account does not trust the issuer of the asset it is trying to send.
PAYMENT_SRC_NOT_AUTHORIZED -4 The source account is not authorized to send this payment.
PAYMENT_NO_DESTINATION -5 The receiving account does not exist.
PAYMENT_NO_TRUST -6 The receiver does not trust the issuer of the asset being sent. For more information, see the assets doc.
PAYMENT_NOT_AUTHORIZED -7 The destination account is not authorized by the asset's issuer to hold the asset.
PAYMENT_LINE_FULL -8 The destination account (receiver) does not have sufficient limits to receive amount and still satisfy its buying liabilities.
PAYMENT_NO_ISSUER -9 The issuer of the asset does not exist.

Path Payment

JavaScript | Java | Go

Sends an amount in a specific asset to a destination account through a path of offers. This allows the asset sent (e.g., 450 XLM) to be different from the asset received (e.g, 6 BTC).

Threshold: Medium

Result: PathPaymentResult

Parameters:

Parameters Type Description
Send asset asset The asset deducted from the sender's account.
Send max integer The maximum amount of send asset to deduct (excluding fees).
Destination account ID Account ID of the recipient.
Destination asset asset The asset the destination account receives.
Destination amount integer The amount of destination asset the destination account receives.
Path list of assets The assets (other than send asset and destination asset) involved in the offers the path takes. For example, if you can only find a path from USD to EUR through XLM and BTC, the path would be USD -> XLM -> BTC -> EUR and the path field would contain XLM and BTC.

Possible errors:

Error Code Description
PATH_PAYMENT_MALFORMED -1 The input to this path payment is invalid.
PATH_PAYMENT_UNDERFUNDED -2 The source account (sender) does not have enough funds to send and still satisfy its selling liabilities. Note that if sending XLM then the sender must additionally maintain its minimum XLM reserve.
PATH_PAYMENT_SRC_NO_TRUST -3 The source account does not trust the issuer of the asset it is trying to send.
PATH_PAYMENT_SRC_NOT_AUTHORIZED -4 The source account is not authorized to send this payment.
PATH_PAYMENT_NO_DESTINATION -5 The receiving account does not exist.
PATH_PAYMENT_NO_TRUST -6 The receiver does not trust the issuer of the asset being sent. For more, see the assets doc.
PATH_PAYMENT_NOT_AUTHORIZED -7 The destination account is not authorized by the asset's issuer to hold the asset.
PATH_PAYMENT_LINE_FULL -8 The destination account (receiver) does not have sufficient limits to receive destination amount and still satisfy its buying liabilities.
PATH_PAYMENT_NO_ISSUER -9 The issuer on one of assets is missing.
PATH_PAYMENT_TOO_FEW_OFFERS -10 There is no path of offers connecting the send asset and destination asset. Stellar only considers paths of length 5 or shorter.
PATH_PAYMENT_OFFER_CROSS_SELF -11 The payment would cross one of its own offers.
PATH_PAYMENT_OVER_SENDMAX -12 The paths that could send destination amount of destination asset would exceed send max.

Manage Offer

JavaScript | Java | Go

Creates, updates, or deletes an offer.

If you want to create a new offer set Offer ID to 0.

If you want to update an existing offer set Offer ID to existing offer ID.

If you want to delete an existing offer set Offer ID to existing offer ID and set Amount to 0.

Threshold: Medium

Result: ManageOfferResult

Parameters Type Description
Selling asset Asset the offer creator is selling.
Buying asset Asset the offer creator is buying.
Amount integer Amount of selling being sold. Set to 0 if you want to delete an existing offer.
Price {numerator, denominator} Price of 1 unit of selling in terms of buying. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}.
Offer ID unsigned integer The ID of the offer. 0 for new offer. Set to existing offer ID to update or delete.

Possible errors:

Error Code Description
MANAGE_OFFER_MALFORMED -1 The input is incorrect and would result in an invalid offer.
MANAGE_OFFER_SELL_NO_TRUST -2 The account creating the offer does not have a trustline for the asset it is selling.
MANAGE_OFFER_BUY_NO_TRUST -3 The account creating the offer does not have a trustline for the asset it is buying.
MANAGE_OFFER_SELL_NOT_AUTHORIZED -4 The account creating the offer is not authorized to sell this asset.
MANAGE_OFFER_BUY_NOT_AUTHORIZED -5 The account creating the offer is not authorized to buy this asset.
MANAGE_OFFER_LINE_FULL -6 The account creating the offer does not have sufficient limits to receive buying and still satisfy its buying liabilities.
MANAGE_OFFER_UNDERFUNDED -7 The account creating the offer does not have sufficient limits to send selling and still satisfy its selling liabilities. Note that if selling XLM then the account must additionally maintain its minimum XLM reserve, which is calculated assuming this offer will not completely execute immediately.
MANAGE_OFFER_CROSS_SELF -8 The account has opposite offer of equal or lesser price active, so the account creating this offer would immediately cross itself.
MANAGE_OFFER_SELL_NO_ISSUER -9 The issuer of selling asset does not exist.
MANAGE_OFFER_BUY_NO_ISSUER -10 The issuer of buying asset does not exist.
MANAGE_OFFER_NOT_FOUND -11 An offer with that offerID cannot be found.
MANAGE_OFFER_LOW_RESERVE -12 The account creating this offer does not have enough XLM to satisfy the minimum XLM reserve increase caused by adding a subentry and still satisfy its XLM selling liabilities. For every offer an account creates, the minimum amount of XLM that account must hold will increase.

Create Passive Offer

JavaScript | Java | Go

A passive offer is an offer that does not act on and take a reverse offer of equal price. Instead, they only take offers of lesser price. For example, if an offer exists to buy 5 BTC for 30 XLM, and you make a passive offer to buy 30 XLM for 5 BTC, your passive offer does not take the first offer.

Note that regular offers made later than your passive offer can act on and take your passive offer, even if the regular offer is of the same price as your passive offer.

Passive offers allow market makers to have zero spread. If you want to trade EUR for USD at 1:1 price and USD for EUR also at 1:1, you can create two passive offers so the two offers don't immediately act on each other.

Once the passive offer is created, you can manage it like any other offer using the manage offer operation.

Threshold: Medium

Result: CreatePassiveOfferResult

Parameters Type Description
Selling asset The asset you would like to sell.
Buying asset The asset you would like to buy.
Amount integer Amount of selling being sold.
Price {numerator, denominator} Price of 1 unit of selling in terms of buying. For example, if you wanted to sell 30 XLM and buy 5 BTC, the price would be {5,30}.

Possible errors:

Error Code Description
MANAGE_OFFER_MALFORMED -1 The input is incorrect and would result in an invalid offer.
MANAGE_OFFER_SELL_NO_TRUST -2 The account creating the offer does not have a trustline for the asset it is selling.
MANAGE_OFFER_BUY_NO_TRUST -3 The account creating the offer does not have a trustline for the asset it is buying.
MANAGE_OFFER_SELL_NOT_AUTHORIZED -4 The account creating the offer is not authorized to sell this asset.
MANAGE_OFFER_BUY_NOT_AUTHORIZED -5 The account creating the offer is not authorized to buy this asset.
MANAGE_OFFER_LINE_FULL -6 The account creating the offer does not have sufficient limits to receive buying and still satisfy its buying liabilities.
MANAGE_OFFER_UNDERFUNDED -7 The account creating the offer does not have sufficient limits to send selling and still satisfy its selling liabilities. Note that if selling XLM then the account must additionally maintain its minimum XLM reserve, which is calculated assuming this offer will not completely execute immediately.
MANAGE_OFFER_CROSS_SELF -8 The account has opposite offer of equal or lesser price active, so the account creating this offer would immediately cross itself.
MANAGE_OFFER_SELL_NO_ISSUER -9 The issuer of selling asset does not exist.
MANAGE_OFFER_BUY_NO_ISSUER -10 The issuer of buying asset does not exist.
MANAGE_OFFER_NOT_FOUND -11 An offer with that offerID cannot be found.
MANAGE_OFFER_LOW_RESERVE -12 The account creating this offer does not have enough XLM to satisfy the minimum XLM reserve increase caused by adding a subentry and still satisfy its XLM selling liabilities. For every offer an account creates, the minimum amount of XLM that account must hold will increase.

Set Options

JavaScript | Java | Go

This operation sets the options for an account.

For more information on the signing options, please refer to the multi-sig doc.

When updating signers or other thresholds, the threshold of this operation is high.

Threshold: Medium or High

Result: SetOptionsResult

Parameters:

Parameters Type Description
inflation Destination account ID Account of the inflation destination.
Clear flags integer Indicates which flags to clear. For details about the flags, please refer to the accounts doc. The bit mask integer subtracts from the existing flags of the account. This allows for setting specific bits without knowledge of existing flags.
Set flags integer Indicates which flags to set. For details about the flags, please refer to the accounts doc. The bit mask integer adds onto the existing flags of the account. This allows for setting specific bits without knowledge of existing flags.
Master weight integer Weight of the master key. This account may also add other keys with which to sign transactions using signer below.
Low threshold integer A number from 0-255 representing the threshold this account sets on all operations it performs that have a low threshold.
Medium threshold integer A number from 0-255 representing the threshold this account sets on all operations it performs that have a medium threshold.
High threshold integer A number from 0-255 representing the threshold this account sets on all operations it performs that have a high threshold.
Home domain string Sets the home domain of an account. See Federation.
Signer {Public Key, weight} Add, update, or remove a signer from an account. The signer is deleted if the weight is 0.

Possible errors:

Error Code Description
SET_OPTIONS_LOW_RESERVE -1 This account does not have enough XLM to satisfy the minimum XLM reserve increase caused by adding a subentry and still satisfy its XLM selling liabilities. For every new signer added to an account, the minimum reserve of XLM that account must hold increases.
SET_OPTIONS_TOO_MANY_SIGNERS -2 20 is the maximum number of signers an account can have, and adding another signer would exceed that.
SET_OPTIONS_BAD_FLAGS -3 The flags set and/or cleared are invalid by themselves or in combination.
SET_OPTIONS_INVALID_INFLATION -4 The destination account set in the inflation field does not exist.
SET_OPTIONS_CANT_CHANGE -5 This account can no longer change the option it wants to change.
SET_OPTIONS_UNKNOWN_FLAG -6 The account is trying to set a flag that is unknown.
SET_OPTIONS_THRESHOLD_OUT_OF_RANGE -7 The value for a key weight or threshold is invalid.
SET_OPTIONS_BAD_SIGNER -8 Any additional signers added to the account cannot be the master key.
SET_OPTIONS_INVALID_HOME_DOMAIN -9 Home domain is malformed.

Change Trust

JavaScript | Java | Go

Creates, updates, or deletes a trustline. For more on trustlines, please refer to the assets documentation.

Threshold: Medium

Result: ChangeTrustResult

Parameters Type Description
Line asset The asset of the trustline. For example, if a user extends a trustline of up to 200 USD to an anchor, the line is USD:anchor.
Limit integer The limit of the trustline. In the previous example, the limit would be 200.

Possible errors:

Error Code Description
CHANGE_TRUST_MALFORMED -1 The input to this operation is invalid.
CHANGE_TRUST_NO_ISSUER -2 The issuer of the asset cannot be found.
CHANGE_TRUST_INVALID_LIMIT -3 The limit is not sufficient to hold the current balance of the trustline and still satisfy its buying liabilities.
CHANGE_TRUST_LOW_RESERVE -4 This account does not have enough XLM to satisfy the minimum XLM reserve increase caused by adding a subentry and still satisfy its XLM selling liabilities. For every new trustline added to an account, the minimum reserve of XLM that account must hold increases.

Allow Trust

JavaScript | Java | Go

Updates the authorized flag of an existing trustline. This can only be called by the issuer of a trustline's asset.

The issuer can only clear the authorized flag if the issuer has the AUTH_REVOCABLE_FLAG set. Otherwise, the issuer can only set the authorized flag.

If the issuer clears the authorized flag, all offers owned by the trustor that are either selling type or buying type will be deleted. (protocol version 10 and above)

Threshold: Low

Result: AllowTrustResult

Parameters Type Description
Trustor account ID The account of the recipient of the trustline.
Type asset The asset of the trustline the source account is authorizing. For example, if an anchor wants to allow another account to hold its USD credit, the type is USD:anchor.
Authorize boolean Flag indicating whether the trustline is authorized.

Possible errors:

Error Code Description
ALLOW_TRUST_MALFORMED -1 The asset specified in type is invalid.
ALLOW_TRUST_NO_TRUST_LINE -2 The trustor does not have a trustline with the issuer performing this operation.
ALLOW_TRUST_TRUST_NOT_REQUIRED -3 The source account (issuer performing this operation) does not require trust. In other words, it does not have the flag AUTH_REQUIRED_FLAG set.
ALLOW_TRUST_CANT_REVOKE -4 The source account is trying to revoke the trustline of the trustor, but it cannot do so.

Account Merge

JavaScript | Java | Go

Transfers the native balance (the amount of XLM an account holds) to another account and removes the source account from the ledger.

Threshold: High

Result: AccountMergeResult

Parameters Type Description
Destination account ID The account that receives the remaining XLM balance of the source account.

Possible errors:

Error Code Description
ACCOUNT_MERGE_MALFORMED -1 The operation is malformed because the source account cannot merge with itself. The destination must be a different account.
ACCOUNT_MERGE_NO_ACCOUNT -2 The destination account does not exist.
ACCOUNT_MERGE_IMMUTABLE_SET -3 The source account has AUTH_IMMUTABLE flag set.
ACCOUNT_MERGE_HAS_SUB_ENTRIES -4 The source account has trust lines/offers.
ACCOUNT_MERGE_SEQNUM_TOO_FAR -5 Source's account sequence number is too high. It must be less than (ledgerSeq << 32) = (ledgerSeq * 0x100000000). (protocol version 10 and above)
ACCOUNT_MERGE_DEST_FULL -6 The destination account cannot receive the balance of the source account and still satisfy its lumen buying liabilities. (protocol version 10 and above)

Inflation

JavaScript | Java | Go

This operation runs inflation.

Threshold: Low

Result: InflationResult

Possible errors:

Error Code Description
INFLATION_NOT_TIME -1 Inflation only runs once a week. This failure means it is not time for a new inflation round yet.

Manage Data

JavaScript | Java | Go

Allows you to set,modify or delete a Data Entry (name/value pair) that is attached to a particular account. An account can have an arbitrary amount of DataEntries attached to it. Each DataEntry increases the minimum balance needed to be held by the account.

DataEntries can be used for application specific things. They are not used by the core Stellar protocol.

Threshold: Medium

Result: ManageDataResult

Parameters Type Description
Name string String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified.
Value binary data (optional) If not present then the existing Name will be deleted. If present then this value will be set in the DataEntry. Up to 64 bytes long.

Possible errors:

Error Code Description
MANAGE_DATA_NOT_SUPPORTED_YET -1 The network hasn't moved to this protocol change yet. This failure means the network doesn't support this feature yet.
MANAGE_DATA_NAME_NOT_FOUND -2 Trying to remove a Data Entry that isn't there. This will happen if Name is set (and Value isn't) but the Account doesn't have a DataEntry with that Name.
MANAGE_DATA_LOW_RESERVE -3 This account does not have enough XLM to satisfy the minimum XLM reserve increase caused by adding a subentry and still satisfy its XLM selling liabilities. For every new DataEntry added to an account, the minimum reserve of XLM that account must hold increases.
MANAGE_DATA_INVALID_NAME -4 Name not a valid string.

Bump Sequence

JavaScript | Java | Go

Only available in protocol version 10 and above

Bump sequence allows to bump forward the sequence number of the source account of the operation, allowing to invalidate any transactions with a smaller sequence number.

If the specified bumpTo sequence number is greater than the source account's sequence number, the account's sequence number is updated with that value, otherwise it's not modified.

Threshold: Low

Result: BumpSequenceResult

Parameters Type Description
bumpTo SequenceNumber desired value for the operation's source account sequence number.

Possible errors:

Error Code Description
BUMP_SEQUENCE_BAD_SEQ -1 The specified bumpTo sequence number is not a valid sequence number. It must be between 0 and INT64_MAX (9223372036854775807 or 0x7fffffffffffffff).