Effect

A successful operation will yield zero or more effects. These effects represent specific changes that occur in the ledger, but are not necessarily directly reflected in the ledger or history, as transactions and operations are.

Effect types

We can distinguish 4 effect groups:

  • Account effects
  • Signer effects
  • Trustline effects
  • Trading effects

Account effects

Type Operation
Account Created create_account
Account Removed merge_account
Account Credited create_account, payment, path_payment, merge_account
Account Debited create_account, payment, path_payment, merge_account
Account Thresholds Updated set_options
Account Home Domain Updated set_options
Account Flags Updated set_options

Signer effects

Type Operation
Signer Created set_options
Signer Removed set_options
Signer Updated set_options

Trustline effects

Type Operation
Trustline Created change_trust
Trustline Removed change_trust
Trustline Updated change_trust, allow_trust
Trustline Authorized allow_trust
Trustline Deauthorized allow_trust

Trading effects

Type Operation
Offer Created manage_offer, create_passive_offer
Offer Removed manage_offer, create_passive_offer, path_payment
Offer Updated manage_offer, create_passive_offer, path_payment
Trade manage_offer, create_passive_offer, path_payment

Attributes

Attributes depend on effect type.

rel Example Relation
self /effects?order=asc\u0026limit=1
prev /effects?order=desc\u0026limit=1\u0026cursor=141733924865-1
next /effects?order=asc\u0026limit=1\u0026cursor=141733924865-1
operation /operations/141733924865 Operation that created the effect

Example

{
  "_embedded": {
    "records": [
      {
        "_links": {
          "operation": {
            "href": "/operations/141733924865"
          },
          "precedes": {
            "href": "/effects?cursor=141733924865-1\u0026order=asc"
          },
          "succeeds": {
            "href": "/effects?cursor=141733924865-1\u0026order=desc"
          }
        },
        "account": "GBS43BF24ENNS3KPACUZVKK2VYPOZVBQO2CISGZ777RYGOPYC2FT6S3K",
        "paging_token": "141733924865-1",
        "starting_balance": "10000000.0",
        "type_i": 0,
        "type": "account_created"
      }
    ]
  },
  "_links": {
    "next": {
      "href": "/effects?order=asc\u0026limit=1\u0026cursor=141733924865-1"
    },
    "prev": {
      "href": "/effects?order=desc\u0026limit=1\u0026cursor=141733924865-1"
    },
    "self": {
      "href": "/effects?order=asc\u0026limit=1\u0026cursor="
    }
  }
}

Endpoints

Resource Type Resource URI Template
All Effects Collection /effects
Operation Effects Collection /operations/:id/effects
Account Effects Collection /accounts/:account_id/effects
Ledger Effects Collection /ledgers/:ledger_id/effects

Edit this doc in GitHub

THE FUTURE OF LOYALTY STARTS HERE

Stay up to date on the latest happenings at DigitalBits. Get the latest news.