Skip to content

Commit

Permalink
✏ Operations as complete(r) sentences
Browse files Browse the repository at this point in the history
  • Loading branch information
@JFWooten4
JFWooten4 authored Jan 17, 2025
1 parent a7e985b commit 25dcb88
Showing 1 changed file with 33 additions and 31 deletions.
64 changes: 33 additions & 31 deletions docs/learn/fundamentals/transactions/list-of-operations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are currently 26 operations you can use on the Stellar network, these oper

## Create account

Creates and funds a new account with the specified starting balance
Creates and funds a new account with a specified starting balance.

**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.createAccount) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/CreateAccountOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#CreateAccount)
**Threshold**: Medium
Expand All @@ -34,7 +34,7 @@ Creates and funds a new account with the specified starting balance

## Payment

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

**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.payment) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/PaymentOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#Payment)
**Threshold**: Medium
Expand Down Expand Up @@ -62,7 +62,7 @@ Sends an amount in a specific asset to a destination account

## Path payment strict send

A payment where the asset sent can be different than the asset received, allowing the user to specify the amount of the asset to send
Facilitates a payment where the asset sent can be different from the asset received, allowing you to specify the amount of an asset to send.

Learn more about path payments: [Path Payments Encyclopedia Entry](../../encyclopedia/transactions-specialized/path-payments.mdx)

Expand Down Expand Up @@ -98,7 +98,7 @@ Learn more about path payments: [Path Payments Encyclopedia Entry](../../encyclo

## Path payment strict receive

A payment where the asset received can be different from the asset sent, allowing the user to specify the amount of the asset received
Facilitates a payment where the asset received can be different from the asset sent, allowing you to specify the amount of an asset to receive.

Learn more about path payments: [Path Payments Encyclopedia Entry](../../encyclopedia/transactions-specialized/path-payments.mdx)

Expand Down Expand Up @@ -134,7 +134,7 @@ Learn more about path payments: [Path Payments Encyclopedia Entry](../../encyclo

## Manage buy offer

Creates, updates, or deletes an offer to buy a specific amount of an asset for another
Creates, updates, or deletes an offer to buy a specific amount of an asset for another.

Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity Pools](../../encyclopedia/sdex/liquidity-on-stellar-sdex-liquidity-pools.mdx)

Expand Down Expand Up @@ -168,7 +168,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity

## Manage sell offer

Creates, updates, or deletes an offer to sell a specific amount of an asset for another
Creates, updates, or deletes an offer to sell a specific amount of an asset for another.

Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity Pools](../../encyclopedia/sdex/liquidity-on-stellar-sdex-liquidity-pools.mdx)

Expand Down Expand Up @@ -202,7 +202,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity

## Create passive sell offer

Creates an offer to sell one asset for another without taking a reverse offer of equal price
Creates an offer to sell an asset for another without taking a reverse offer of equal price.

Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity Pools](../../encyclopedia/sdex/liquidity-on-stellar-sdex-liquidity-pools.mdx)

Expand Down Expand Up @@ -235,7 +235,7 @@ Learn more about passive sell offers: [Liquidity on Stellar: SDEX and Liquidity

## Set options

Set options for an account such as flags, inflation destination, signers, home domain, and master key weight
Sets account-level options such as flags, inflation destination, signers, home domain, and master key weight.

Learn more about flags: [Flags Encyclopedia Entry](../../glossary.mdx#flags)
Learn more about the home domain: [Stellar Ecosystem Proposals SEP-0001](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md)
Expand Down Expand Up @@ -274,7 +274,7 @@ Learn more about signers operations and key weight: [Signature and Multisignatur

## Change trust

Creates, updates, or deletes a trustline
Creates, updates, or deletes a trustline for an asset.

Learn more about trustlines: [Trustlines section](../stellar-data-structures/accounts.mdx#trustlines)

Expand Down Expand Up @@ -303,9 +303,9 @@ Learn more about trustlines: [Trustlines section](../stellar-data-structures/acc

## Allow trust

Updates the authorized flag of an existing trustline
Updates the authorization flag of an existing trustline.

Protocol 17 depricated this operation in favor of [SetTrustlineFlags](#set-trustline-flags).
Protocol 17 depricated this operation in favor of [`SetTrustlineFlags`](#set-trustline-flags).

**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.allowTrust) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/AllowTrustOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#AllowTrust)
**Threshold**: Low
Expand All @@ -331,7 +331,7 @@ Protocol 17 depricated this operation in favor of [SetTrustlineFlags](#set-trust

## Account merge

Transfers the XLM balance of an account to another account and removes the source account from the ledger
Transfers the XLM balance of one account to another account and removes the source account from the ledger.

**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.accountMerge) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/AccountMergeOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#AccountMerge)
**Threshold**: High
Expand All @@ -356,7 +356,7 @@ Transfers the XLM balance of an account to another account and removes the sourc

## Manage data

Sets, modifies, or deletes a data entry (name/value pair) that is attached to an account
Adds, modifies, or deletes a data entry ([name-value pair](../../../data/horizon/api-reference/resources/operations/object/manage-data.mdx)) attached to an account.

Learn more about entries and subentries: [Accounts section](../stellar-data-structures/accounts.mdx#subentries)

Expand All @@ -381,7 +381,7 @@ Learn more about entries and subentries: [Accounts section](../stellar-data-stru

## Bump sequence

Bumps forward the sequence number of the source account to the given sequence number, invalidating any transaction with a smaller sequence number
Bumps forward the sequence number of the source account to the given sequence number, invalidating any transaction with a smaller sequence number.

**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.bumpSequence) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/BumpSequenceOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#BumpSequence)
**Threshold**: Low
Expand All @@ -400,7 +400,7 @@ Bumps forward the sequence number of the source account to the given sequence nu

## Create claimable balance

Moves an amount of asset from the operation source account into a new ClaimableBalanceEntry
Creates a `ClaimableBalanceEntry`, transferring an amount of an asset from the operation source account into a new ledger entry.

Learn more about claimable balances: [Claimable Balances Encyclopedia Entry](../../encyclopedia/transactions-specialized/claimable-balances.mdx)

Expand All @@ -427,7 +427,7 @@ Learn more about claimable balances: [Claimable Balances Encyclopedia Entry](../

## Claim claimable balance

Claims a ClaimableBalanceEntry that corresponds to the BalanceID and adds the amount of an asset on the entry to the source account
Claims a `ClaimableBalanceEntry` that corresponds to the `BalanceID`, transferring its assets to the claiming account.

Learn more about claimable balances and view more parameters: [Claimable Balances Encyclopedia Entry](../../encyclopedia/transactions-specialized/claimable-balances.mdx)

Expand All @@ -452,9 +452,9 @@ Learn more about claimable balances and view more parameters: [Claimable Balance

## Begin sponsoring future reserves

Allows an account to pay the base reserves for another account; sponsoring account establishes the is-sponsoring-future-reserves relationship
Allows an account to pay the base reserves for another account, whereby the sponsoring account establishes the `is-sponsoring-future-reserves` relationship.

There must also be an end sponsoring future reserves operation in the same transaction
There must also be an [end sponsoring future reserves](#end-sponsoring-future-reserves) operation in the same transaction.

Learn more about sponsored reserves: [Sponsored Reserves Encyclopedia Entry](../../encyclopedia/transactions-specialized/sponsored-reserves.mdx)

Expand All @@ -477,7 +477,7 @@ Learn more about sponsored reserves: [Sponsored Reserves Encyclopedia Entry](../

## End sponsoring future reserves

Terminates the current is-sponsoring-future-reserves relationship in which the source account is sponsored
Terminates the current `is-sponsoring-future-reserves` relationship between the source account and the sponsored account.

Learn more about sponsored reserves: [Sponsored Reserves Encyclopedia Entry](../../encyclopedia/transactions-specialized/sponsored-reserves.mdx)

Expand All @@ -498,7 +498,9 @@ Learn more about sponsored reserves: [Sponsored Reserves Encyclopedia Entry](../

## Revoke sponsorship

The sponsoring account can remove or transfer sponsorships of existing ledgerEntries and signers. The logic of this operation depends on the state of the source account.
Removes or transfers the sponsoring account's sponsorship of existing ledgerEntries or signers.

The logic of this operation depends on the state of the source account.

Learn more about sponsored reserves: [Sponsored Reserves Encyclopedia Entry](../../encyclopedia/transactions-specialized/sponsored-reserves.mdx)

Expand All @@ -511,7 +513,7 @@ This operation is a union with **two** possible types:
| --- | --- | --- | --- |
| REVOKE_SPONSORSHIP_LEDGER_ENTRY | LedgerKey | ledgerKey | Ledger key that holds information to identify a specific ledgerEntry that may have its sponsorship modified. See [LedgerKey](../../glossary.mdx#ledgerkey) for more information. |

Or
or

| Union Type | Parameters | Type | Description |
| --- | --- | --- | --- |
Expand All @@ -529,7 +531,7 @@ Or

## Clawback

Burns an amount in a specific asset from a receiving account
Burns an amount of an asset from the account holding it, as allowed by the asset's issuing account.

Learn more about clawbacks: [Clawback Encyclopedia Entry](../../encyclopedia/transactions-specialized/clawbacks.mdx)

Expand All @@ -555,7 +557,7 @@ Learn more about clawbacks: [Clawback Encyclopedia Entry](../../encyclopedia/tra

## Clawback claimable balance

Claws back an unclaimed ClaimableBalanceEntry, burning the pending amount of the asset
Burns the unclaimed amount of an asset from a `ClaimableBalanceEntry`.

Learn more about clawbacks: [Clawback Encyclopedia Entry](../../encyclopedia/transactions-specialized/clawbacks.mdx)

Expand All @@ -580,12 +582,12 @@ Learn more about claimable balances: [Claimable Balances Encyclopedia Entry](../

## Set trustline flags

Allows issuing account to configure authorization and trustline flags to an asset

The Asset parameter is of the `TrustLineAsset` type. If you are modifying a trustline to a regular asset (i.e. one in a Code:Issuer format), this is equivalent to the Asset type. If you are modifying a trustline to a pool share, however, this is composed of the liquidity pool's unique ID.
Allows [issuing accounts](../../../tokens/control-asset-access.mdx#issuing-and-distribution-accounts) to configure future authorization or other trustline flags for an asset.

Learn more about flags: [Flags Glossary Entry](../../glossary.mdx#flags)

The Asset parameter is of the `TrustLineAsset` type. If you are modifying a trustline to a regular asset (i.e. one in a `Code:Issuer` format), this is equivalent to the Asset type. If you are modifying a trustline to a pool share, however, this is composed of the liquidity pool's [unique ID](../../encyclopedia/sdex/liquidity-on-stellar-sdex-liquidity-pools.mdx#TODO).

**SDKs**: [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/SetTrustlineFlagsOperation.java)
**Threshold**: Low
**Result**: `SetTrustLineFlagsResult`
Expand All @@ -610,9 +612,9 @@ Learn more about flags: [Flags Glossary Entry](../../glossary.mdx#flags)

## Liquidity pool deposit

Deposits assets into a liquidity pool, increasing the reserves of a liquidity pool in exchange for pool shares
Deposits assets into a liquidity pool, increasing its reserves in exchange for pool shares.

Parameters to this operation depend on the ordering of assets in the liquidity pool: “A” refers to the first asset in the liquidity pool, and “B” refers to the second asset in the liquidity pool.
Parameters to this operation depend on the ordering of assets in the liquidity pool: "A" refers to the first asset in the liquidity pool, and "B" refers to the second asset in the liquidity pool.

If the pool is empty, then this operation deposits maxAmountA of A and maxAmountB of B into the pool. If the pool is not empty, then this operation deposits at most maxAmountA of A and maxAmountB of B into the pool. The actual amounts deposited are determined using the current reserves of the pool. You can use these parameters to control a percentage of slippage.

Expand Down Expand Up @@ -645,7 +647,7 @@ Learn more about liquidity pools: [Liquidity Pools Encyclopedia Entry](../../enc

## Liquidity pool withdraw

Withdraw assets from a liquidity pool, reducing the number of pool shares in exchange for reserves of a liquidity pool
Withdraw assets from a liquidity pool, reducing the number of pool shares in exchange for its constituent reserves.

The minAmountA and minAmountB parameters can be used to control a percentage of slippage from the "spot price" on the pool.

Expand Down Expand Up @@ -675,9 +677,9 @@ Learn more about liquidity pools: [Liquidity Pools Encyclopedia Entry](../../enc

## Invoke Host Function

Invoke and deploy Soroban smart contracts with `InvokeHostFunctionOp`.
Invokes Soroban smart-contract functions, deploys contracts, or uploads WebAssembly to the network.

The `InvokeHostFunctionOp` can be used to perform the following Soroban operations:
Soroban operations performed by `InvokeHostFunctionOp`:

- Invoke contract functions: `HOST_FUNCTION_TYPE_INVOKE_CONTRACT`
- Upload Wasm of the contracts: `HOST_FUNCTION_TYPE_UPLOAD_CONTRACT_WASM`
Expand Down

0 comments on commit 25dcb88

Please sign in to comment.