Skip to content

Network / Horizon

Horizon.AccountResponse

Do not create this object directly, use Horizon.Server#loadAccount.

Returns information and links relating to a single account. The balances section in the returned JSON will also list all the trust lines this account has set up. It also contains BaseAccount object and exposes it’s methods so can be used in TransactionBuilder.

class AccountResponse implements TransactionSource {
constructor(response: AccountRecord);
readonly account_id: string;
readonly balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];
readonly data: (options: { value: string }) => Promise<{ value: string }>;
readonly data_attr: Record<string, string>;
readonly effects: CallCollectionFunction<EffectRecord>;
readonly flags: Flags;
readonly home_domain?: string;
readonly id: string;
readonly inflation_destination?: string;
readonly last_modified_ledger: number;
readonly last_modified_time: string;
readonly num_sponsored: number;
readonly num_sponsoring: number;
readonly offers: CallCollectionFunction<OfferRecord>;
readonly operations: CallCollectionFunction<OperationRecord>;
readonly paging_token: string;
readonly payments: CallCollectionFunction<PaymentOperationRecord>;
sequence: string;
readonly sequence_ledger?: number;
readonly sequence_time?: string;
readonly signers: AccountRecordSigners[];
readonly sponsor?: string;
readonly subentry_count: number;
readonly thresholds: AccountThresholds;
readonly trades: CallCollectionFunction<TradeRecord>;
readonly transactions: CallCollectionFunction<TransactionRecord>;
accountId(): string;
incrementSequenceNumber(): void;
sequenceNumber(): string;
}

See also

  • Account Details

Source: src/horizon/account_response.ts:19

new AccountResponse(response)

constructor(response: AccountRecord);

Parameters

  • responseAccountRecord (required)

Source: src/horizon/account_response.ts:50

accountResponse.account_id

readonly account_id: string;

Source: src/horizon/account_response.ts:22

accountResponse.balances

readonly balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];

Source: src/horizon/account_response.ts:33

accountResponse.data

readonly data: (options: { value: string }) => Promise<{ value: string }>;

Parameters

  • options{ value: string } (required)

Source: src/horizon/account_response.ts:38

accountResponse.data_attr

readonly data_attr: Record<string, string>;

Source: src/horizon/account_response.ts:41

accountResponse.effects

readonly effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/account_response.ts:42

accountResponse.flags

readonly flags: Flags;

Source: src/horizon/account_response.ts:32

accountResponse.home_domain

readonly home_domain?: string;

Source: src/horizon/account_response.ts:27

accountResponse.id

readonly id: string;

Source: src/horizon/account_response.ts:20

accountResponse.inflation_destination

readonly inflation_destination?: string;

Source: src/horizon/account_response.ts:28

accountResponse.last_modified_ledger

readonly last_modified_ledger: number;

Source: src/horizon/account_response.ts:29

accountResponse.last_modified_time

readonly last_modified_time: string;

Source: src/horizon/account_response.ts:30

accountResponse.num_sponsored

readonly num_sponsored: number;

Source: src/horizon/account_response.ts:36

accountResponse.num_sponsoring

readonly num_sponsoring: number;

Source: src/horizon/account_response.ts:35

accountResponse.offers

readonly offers: CallCollectionFunction<OfferRecord>;

Source: src/horizon/account_response.ts:43

accountResponse.operations

readonly operations: CallCollectionFunction<OperationRecord>;

Source: src/horizon/account_response.ts:44

accountResponse.paging_token

readonly paging_token: string;

Source: src/horizon/account_response.ts:21

accountResponse.payments

readonly payments: CallCollectionFunction<PaymentOperationRecord>;

Source: src/horizon/account_response.ts:45

accountResponse.sequence

sequence: string;

Source: src/horizon/account_response.ts:23

accountResponse.sequence_ledger

readonly sequence_ledger?: number;

Source: src/horizon/account_response.ts:24

accountResponse.sequence_time

readonly sequence_time?: string;

Source: src/horizon/account_response.ts:25

accountResponse.signers

readonly signers: AccountRecordSigners[];

Source: src/horizon/account_response.ts:34

accountResponse.sponsor

readonly sponsor?: string;

Source: src/horizon/account_response.ts:37

accountResponse.subentry_count

readonly subentry_count: number;

Source: src/horizon/account_response.ts:26

accountResponse.thresholds

readonly thresholds: AccountThresholds;

Source: src/horizon/account_response.ts:31

accountResponse.trades

readonly trades: CallCollectionFunction<TradeRecord>;

Source: src/horizon/account_response.ts:46

accountResponse.transactions

readonly transactions: CallCollectionFunction<TransactionRecord>;

Source: src/horizon/account_response.ts:47

accountResponse.accountId()

Get Stellar account public key ex. GB3KJPLFUYN5VL6R3GU3EGCGVCKFDSD7BEDX42HWG5BWFKB3KQGJJRMA

accountId(): string;

Returns

accountId

Source: src/horizon/account_response.ts:85

accountResponse.incrementSequenceNumber()

Increments sequence number in this object by one.

incrementSequenceNumber(): void;

Source: src/horizon/account_response.ts:100

accountResponse.sequenceNumber()

Get the current sequence number

sequenceNumber(): string;

Returns

sequenceNumber

Source: src/horizon/account_response.ts:93

Horizon.SERVER_TIME_MAP

keep a local map of server times (export this purely for testing purposes)

each entry will map the server domain to the last-known time and the local time it was recorded, ex:

const SERVER_TIME_MAP: Record<string, ServerTime>

Example

"horizon-testnet.stellar.org": {
serverTime: 1552513039,
localTimeRecorded: 1552513052
}

Source: src/horizon/horizon_axios_client.ts:32

Horizon.Server

Server handles the network connection to a Horizon instance and exposes an interface for requests to that instance.

class Server {
constructor(serverURL: string, opts: Options = {});
readonly httpClient: HttpClient;
readonly serverURL: URL;
accounts(): AccountCallBuilder;
assets(): AssetsCallBuilder;
checkMemoRequired(transaction: Transaction | FeeBumpTransaction): Promise<void>;
claimableBalances(): ClaimableBalanceCallBuilder;
effects(): EffectCallBuilder;
feeStats(): Promise<FeeStatsResponse>;
fetchBaseFee(): Promise<number>;
fetchTimebounds(seconds: number, _isRetry: boolean = false): Promise<Timebounds>;
friendbot(address: string): FriendbotBuilder;
ledgers(): LedgerCallBuilder;
liquidityPools(): LiquidityPoolCallBuilder;
loadAccount(accountId: string): Promise<AccountResponse>;
offers(): OfferCallBuilder;
operations(): OperationCallBuilder;
orderbook(selling: Asset, buying: Asset): OrderbookCallBuilder;
payments(): PaymentCallBuilder;
root(): Promise<RootResponse>;
strictReceivePaths(source: string | Asset[], destinationAsset: Asset, destinationAmount: string): PathCallBuilder;
strictSendPaths(sourceAsset: Asset, sourceAmount: string, destination: string | Asset[]): PathCallBuilder;
submitAsyncTransaction(transaction: Transaction | FeeBumpTransaction, opts: SubmitTransactionOptions = ...): Promise<SubmitAsyncTransactionResponse>;
submitTransaction(transaction: Transaction | FeeBumpTransaction, opts: SubmitTransactionOptions = ...): Promise<SubmitTransactionResponse>;
tradeAggregation(base: Asset, counter: Asset, start_time: number, end_time: number, resolution: number, offset: number): TradeAggregationCallBuilder;
trades(): TradesCallBuilder;
transactions(): TransactionCallBuilder;
}

Source: src/horizon/server.ts:70

new Server(serverURL, opts)

constructor(serverURL: string, opts: Options = {});

Parameters

  • serverURLstring (required)
  • optsOptions (optional) (default: {})

Source: src/horizon/server.ts:95

server.httpClient

HTTP client instance for making requests to Horizon. Exposes interceptors, defaults, and other configuration options.

readonly httpClient: HttpClient;

Example

// Add authentication header
server.httpClient.defaults.headers['Authorization'] = 'Bearer token';
// Add request interceptor
server.httpClient.interceptors.request.use((config) => {
console.log('Request:', config.url);
return config;
});

Source: src/horizon/server.ts:94

server.serverURL

Horizon Server URL (ex. https://horizon-testnet.stellar.org)

TODO: Solve this.serverURL.

readonly serverURL: URL;

Source: src/horizon/server.ts:76

server.accounts()

accounts(): AccountCallBuilder;

Returns

New AccountCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • accountId(id: string): CallBuilder<AccountRecord> — Returns information and links relating to a single account.
  • call(): Promise<CollectionPage<AccountRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAsset(asset: Asset): this — This endpoint filters all accounts who are trustees to an asset.
  • forLiquidityPool(id: string): this — This endpoint filters accounts holding a trustline to the given liquidity pool.
  • forSigner(id: string): this — This endpoint filters accounts by signer account.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • sponsor(id: string): this — This endpoint filters accounts where the given account is sponsoring the account or any of its sub-entries..
  • stream(options: EventSourceOptions<AccountRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:601

server.assets()

Get a new AssetsCallBuilder instance configured with the current Horizon server configuration.

assets(): AssetsCallBuilder;

Returns

New AssetsCallBuilder instance

Chainable methods

  • call(): Promise<CollectionPage<AssetRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forCode(value: string): AssetsCallBuilder — This endpoint filters all assets by the asset code.
  • forIssuer(value: string): AssetsCallBuilder — This endpoint filters all assets by the asset issuer.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<AssetRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:783

server.checkMemoRequired(transaction)

Check if any of the destination accounts requires a memo.

This function implements a memo required check as defined in SEP-29. It will load each account which is the destination and check if it has the data field config.memo_required set to "MQ==".

Each account is checked sequentially instead of loading multiple accounts at the same time from Horizon.

checkMemoRequired(transaction: Transaction | FeeBumpTransaction): Promise<void>;

Parameters

  • transactionTransaction | FeeBumpTransaction (required) — The transaction to check.

Returns

  • If any of the destination account requires a memo, the promise will throw AccountRequiresMemoError.

See also

  • SEP-29: Account Memo Requirements

Source: src/horizon/server.ts:849

server.claimableBalances()

claimableBalances(): ClaimableBalanceCallBuilder;

Returns

New ClaimableBalanceCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • asset(asset: Asset): this — Returns all claimable balances which provide a balance for the given asset.
  • call(): Promise<CollectionPage<ClaimableBalanceRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • claimableBalance(claimableBalanceId: string): CallBuilder<ClaimableBalanceRecord> — The claimable balance details endpoint provides information on a single claimable balance.
  • claimant(claimant: string): this — Returns all claimable balances which can be claimed by the given account ID.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • sponsor(sponsor: string): this — Returns all claimable balances which are sponsored by the given account ID.
  • stream(options: EventSourceOptions<ClaimableBalanceRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:608

server.effects()

effects(): EffectCallBuilder;

Returns

New EffectCallBuilder instance configured with the current Horizon server configuration

Chainable methods

  • call(): Promise<CollectionPage<EffectRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(accountId: string): this — This endpoint represents all effects that changed a given account.
  • forLedger(sequence: string | number): this — Effects are the specific ways that the ledger was changed by any operation.
  • forLiquidityPool(poolId: string): this — This endpoint represents all effects involving a particular liquidity pool.
  • forOperation(operationId: string): this — This endpoint represents all effects that occurred as a result of a given operation.
  • forTransaction(transactionId: string): this — This endpoint represents all effects that occurred as a result of a given transaction.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<EffectRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:765

server.feeStats()

Fetch the fee stats endpoint.

feeStats(): Promise<FeeStatsResponse>;

Returns

Promise that resolves to the fee stats returned by Horizon.

See also

  • Fee Stats

Source: src/horizon/server.ts:204

server.fetchBaseFee()

Fetch the base fee. Since this hits the server, if the server call fails, you might get an error. You should be prepared to use a default value if that happens!

fetchBaseFee(): Promise<number>;

Returns

Promise that resolves to the base fee.

Source: src/horizon/server.ts:193

server.fetchTimebounds(seconds, _isRetry)

Get timebounds for N seconds from now, when you’re creating a transaction with TransactionBuilder.

By default, TransactionBuilder uses the current local time, but your machine’s local time could be different from Horizon’s. This gives you more assurance that your timebounds will reflect what you want.

Note that this will generate your timebounds when you init the transaction, not when you build or submit the transaction! So give yourself enough time to get the transaction built and signed before submitting.

fetchTimebounds(seconds: number, _isRetry: boolean = false): Promise<Timebounds>;

Parameters

  • secondsnumber (required) — Number of seconds past the current time to wait.
  • _isRetryboolean (optional) (default: false) — (optional) True if this is a retry. Only set this internally! This is to avoid a scenario where Horizon is horking up the wrong date.

Returns

Promise that resolves a Timebounds object (with the shape { minTime: 0, maxTime: N }) that you can set the timebounds option to.

Example

const transaction = new StellarSdk.TransactionBuilder(accountId, {
fee: await StellarSdk.Server.fetchBaseFee(),
timebounds: await StellarSdk.Server.fetchTimebounds(100)
})
.addOperation(operation)
// normally we would need to call setTimeout here, but setting timebounds
// earlier does the trick!
.build();

Source: src/horizon/server.ts:155

server.friendbot(address)

friendbot(address: string): FriendbotBuilder;

Parameters

  • addressstring (required) — The Stellar ID that you want Friendbot to send lumens to

Returns

New FriendbotBuilder instance configured with the current Horizon server configuration

Chainable methods

  • call(): Promise<any> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<any> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:774

server.ledgers()

ledgers(): LedgerCallBuilder;

Returns

New LedgerCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<LedgerRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • ledger(sequence: string | number): this — Provides information on a single ledger.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<LedgerRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:615

server.liquidityPools()

liquidityPools(): LiquidityPoolCallBuilder;

Returns

New LiquidityPoolCallBuilder object configured to the current Horizon server settings.

Chainable methods

  • call(): Promise<CollectionPage<LiquidityPoolRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(id: string): this — Retrieves all pools an account is participating in.
  • forAssets(...assets: Asset[]): this — Filters out pools whose reserves don’t exactly match these assets.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • liquidityPoolId(id: string): CallBuilder<LiquidityPoolRecord> — Retrieves a specific liquidity pool by ID.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<LiquidityPoolRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:680

server.loadAccount(accountId)

Fetches an account’s most current state in the ledger, then creates and returns an AccountResponse object.

loadAccount(accountId: string): Promise<AccountResponse>;

Parameters

  • accountIdstring (required) — The account to load.

Returns

Returns a promise to the AccountResponse object with populated sequence number.

Source: src/horizon/server.ts:796

server.offers()

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the offers on the DEX.

You can query all offers for account using the function .accountId.

offers(): OfferCallBuilder;

Returns

New OfferCallBuilder object

Example

server.offers()
.forAccount(accountId).call()
.then(function(offers) {
console.log(offers);
});

Chainable methods

  • buying(asset: Asset): this — Returns all offers buying an asset.
  • call(): Promise<CollectionPage<OfferRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(id: string): this — Returns all offers where the given account is involved.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • offer(offerId: string): CallBuilder<OfferRecord> — The offer details endpoint provides information on a single offer.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • seller(seller: string): this — This endpoint filters offers where the given account is the seller.
  • selling(asset: Asset): this — Returns all offers selling an asset.
  • sponsor(id: string): this — This endpoint filters offers where the given account is sponsoring the offer entry.
  • stream(options: EventSourceOptions<OfferRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:642

server.operations()

operations(): OperationCallBuilder;

Returns

New OperationCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<OperationRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(accountId: string): this — This endpoint represents all operations that were included in valid transactions that affected a particular account.
  • forClaimableBalance(claimableBalanceId: string): this — This endpoint represents all operations that reference a given claimable_balance.
  • forLedger(sequence: string | number): this — This endpoint returns all operations that occurred in a given ledger.
  • forLiquidityPool(poolId: string): this — This endpoint represents all operations involving a particular liquidity pool.
  • forTransaction(transactionId: string): this — This endpoint represents all operations that are part of a given transaction.
  • includeFailed(value: boolean): this — Adds a parameter defining whether to include failed transactions.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • operation(operationId: string): CallBuilder<OperationRecord> — The operation details endpoint provides information on a single operation.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<OperationRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:672

server.orderbook(selling, buying)

orderbook(selling: Asset, buying: Asset): OrderbookCallBuilder;

Parameters

  • sellingAsset (required) — Asset being sold
  • buyingAsset (required) — Asset being bought

Returns

New OrderbookCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • call(): Promise<OrderbookRecord> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<OrderbookRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:651

server.payments()

payments(): PaymentCallBuilder;

Returns

New PaymentCallBuilder instance configured with the current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<CreateAccountOperationRecord | PaymentOperationRecord | PathPaymentOperationRecord | AccountMergeOperationRecord | PathPaymentStrictSendOperationRecord | InvokeHostFunctionOperationRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(accountId: string): this — This endpoint responds with a collection of Payment operations where the given account was either the sender or receiver.
  • forLedger(sequence: string | number): this — This endpoint represents all payment operations that are part of a valid transactions in a given ledger.
  • forTransaction(transactionId: string): this — This endpoint represents all payment operations that are part of a given transaction.
  • includeFailed(value: boolean): this — Adds a parameter defining whether to include failed transactions.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<CreateAccountOperationRecord | PaymentOperationRecord | PathPaymentOperationRecord | AccountMergeOperationRecord | PathPaymentStrictSendOperationRecord | InvokeHostFunctionOperationRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:757

server.root()

Fetch the Horizon server’s root endpoint.

root(): Promise<RootResponse>;

Returns

Promise that resolves to the root endpoint returned by Horizon.

Source: src/horizon/server.ts:217

server.strictReceivePaths(source, destinationAsset, destinationAmount)

The Stellar Network allows payments to be made between assets through path payments. A strict receive path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A strict receive path search is specified using:

  • The destination address.
  • The source address or source assets.
  • The asset and amount that the destination account should receive.

As part of the search, horizon will load a list of assets available to the source address and will find any payment paths from those source assets to the desired destination asset. The search’s amount parameter will be used to determine if there a given path can satisfy a payment of the desired amount.

If a list of assets is passed as the source, horizon will find any payment paths from those source assets to the desired destination asset.

strictReceivePaths(source: string | Asset[], destinationAsset: Asset, destinationAmount: string): PathCallBuilder;

Parameters

  • sourcestring | Asset[] (required) — The sender’s account ID or a list of assets. Any returned path will use a source that the sender can hold.
  • destinationAssetAsset (required) — The destination asset.
  • destinationAmountstring (required) — The amount, denominated in the destination asset, that any returned path should be able to satisfy.

Returns

New StrictReceivePathCallBuilder object configured with the current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<PaymentPathRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<PaymentPathRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:710

server.strictSendPaths(sourceAsset, sourceAmount, destination)

The Stellar Network allows payments to be made between assets through path payments. A strict send path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A strict send path search is specified using:

The asset and amount that is being sent. The destination account or the destination assets.

strictSendPaths(sourceAsset: Asset, sourceAmount: string, destination: string | Asset[]): PathCallBuilder;

Parameters

  • sourceAssetAsset (required) — The asset to be sent.
  • sourceAmountstring (required) — The amount, denominated in the source asset, that any returned path should be able to satisfy.
  • destinationstring | Asset[] (required) — The destination account or the destination assets.

Returns

New StrictSendPathCallBuilder object configured with the current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<PaymentPathRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<PaymentPathRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:739

server.submitAsyncTransaction(transaction, opts)

Submits an asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

By default, this function calls HorizonServer.checkMemoRequired, you can skip this check by setting the option skipMemoRequiredCheck to true.

submitAsyncTransaction(transaction: Transaction | FeeBumpTransaction, opts: SubmitTransactionOptions = ...): Promise<SubmitAsyncTransactionResponse>;

Parameters

  • transactionTransaction | FeeBumpTransaction (required) — The transaction to submit.
  • optsSubmitTransactionOptions (optional) (default: ...) — (optional) Options object
    • skipMemoRequiredCheck (optional): Allow skipping memo required check, default: false. See SEP0029.

Returns

Promise that resolves or rejects with response from horizon.

See also

Source: src/horizon/server.ts:559

server.submitTransaction(transaction, opts)

Submits a transaction to the network.

By default this function calls Horizon.Server.checkMemoRequired, you can skip this check by setting the option skipMemoRequiredCheck to true.

If you submit any number of manageOffer operations, this will add an attribute to the response that will help you analyze what happened with your offers.

For example, you’ll want to examine offerResults to add affordances like these to your app:

  • If wasImmediatelyFilled is true, then no offer was created. So if you normally watch the Server.offers endpoint for offer updates, you instead need to check Server.trades to find the result of this filled offer.
  • If wasImmediatelyDeleted is true, then the offer you submitted was deleted without reaching the orderbook or being matched (possibly because your amounts were rounded down to zero). So treat the just-submitted offer request as if it never happened.
  • If wasPartiallyFilled is true, you can tell the user that amountBought or amountSold have already been transferred.
submitTransaction(transaction: Transaction | FeeBumpTransaction, opts: SubmitTransactionOptions = ...): Promise<SubmitTransactionResponse>;

Parameters

  • transactionTransaction | FeeBumpTransaction (required) — The transaction to submit.
  • optsSubmitTransactionOptions (optional) (default: ...) — (optional) Options object
    • skipMemoRequiredCheck (optional): Allow skipping memo required check, default: false. See SEP0029.

Returns

Promise that resolves or rejects with response from horizon.

Example

const res = {
...response,
offerResults: [
{
// Exact ordered list of offers that executed, with the exception
// that the last one may not have executed entirely.
offersClaimed: [
sellerId: String,
offerId: String,
assetSold: {
type: 'native|credit_alphanum4|credit_alphanum12',
// these are only present if the asset is not native
assetCode: String,
issuer: String,
},
// same shape as assetSold
assetBought: {}
],
// What effect your manageOffer op had
effect: "manageOfferCreated|manageOfferUpdated|manageOfferDeleted",
// Whether your offer immediately got matched and filled
wasImmediatelyFilled: Boolean,
// Whether your offer immediately got deleted, if for example the order was too small
wasImmediatelyDeleted: Boolean,
// Whether the offer was partially, but not completely, filled
wasPartiallyFilled: Boolean,
// The full requested amount of the offer is open for matching
isFullyOpen: Boolean,
// The total amount of tokens bought / sold during transaction execution
amountBought: Number,
amountSold: Number,
// if the offer was created, updated, or partially filled, this is
// the outstanding offer
currentOffer: {
offerId: String,
amount: String,
price: {
n: String,
d: String,
},
selling: {
type: 'native|credit_alphanum4|credit_alphanum12',
// these are only present if the asset is not native
assetCode: String,
issuer: String,
},
// same as `selling`
buying: {},
},
// the index of this particular operation in the op stack
operationIndex: Number
}
]
}

See also

  • Submit a Transaction

Source: src/horizon/server.ts:328

server.tradeAggregation(base, counter, start_time, end_time, resolution, offset)

tradeAggregation(base: Asset, counter: Asset, start_time: number, end_time: number, resolution: number, offset: number): TradeAggregationCallBuilder;

Parameters

  • baseAsset (required) — base asset
  • counterAsset (required) — counter asset
  • start_timenumber (required) — lower time boundary represented as millis since epoch
  • end_timenumber (required) — upper time boundary represented as millis since epoch
  • resolutionnumber (required) — segment duration as millis since epoch. *Supported values are 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
  • offsetnumber (required) — segments can be offset using this parameter. Expressed in milliseconds. *Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours. Returns new TradeAggregationCallBuilder object configured with the current Horizon server configuration.

Returns

New TradeAggregationCallBuilder instance

Chainable methods

  • call(): Promise<CollectionPage<TradeAggregationRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<TradeAggregationRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:813

server.trades()

Returns

trades(): TradesCallBuilder;

Returns

New TradesCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<TradeRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(accountId: string): this — Filter trades for a specific account
  • forAssetPair(base: Asset, counter: Asset): this — Filter trades for a specific asset pair (orderbook)
  • forLiquidityPool(liquidityPoolId: string): this — Filter trades for a specific liquidity pool
  • forOffer(offerId: string): this — Filter trades for a specific offer
  • forType(tradeType: TradeType): this — Filter trades by a specific type.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<TradeRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.

Source: src/horizon/server.ts:665

server.transactions()

transactions(): TransactionCallBuilder;

Returns

New TransactionCallBuilder object configured by a current Horizon server configuration.

Chainable methods

  • call(): Promise<CollectionPage<TransactionRecord>> — Triggers a HTTP request using this builder’s current configuration.
  • cursor(cursor: string): this — Sets cursor parameter for the current call.
  • forAccount(accountId: string): this — This endpoint represents all transactions that affected a given account.
  • forClaimableBalance(claimableBalanceId: string): this — This endpoint represents all transactions that reference a given claimable_balance.
  • forLedger(sequence: string | number): this — This endpoint represents all transactions in a given ledger.
  • forLiquidityPool(poolId: string): this — This endpoint represents all transactions involving a particular liquidity pool.
  • includeFailed(value: boolean): this — Adds a parameter defining whether to include failed transactions.
  • join(include: "transactions"): this — Sets join parameter for the current call.
  • limit(recordsNumber: number): this — Sets limit parameter for the current call.
  • order(direction: "asc" | "desc"): this — Sets order parameter for the current call.
  • stream(options: EventSourceOptions<TransactionRecord> = {}): () => void — Creates an EventSource that listens for incoming messages from the server.
  • transaction(transactionId: string): CallBuilder<TransactionRecord> — The transaction details endpoint provides information on a single transaction.

Source: src/horizon/server.ts:622

Horizon.ServerApi.EffectType

const EffectType: typeof EffectType

Source: src/horizon/server_api.ts:86

Horizon.getCurrentServerTime

Given a hostname, get the current time of that server (i.e., use the last- recorded server time and offset it by the time since then.) If there IS no recorded server time, or it’s been 5 minutes since the last, return null.

getCurrentServerTime(hostname: string): number | null

Parameters

  • hostnamestring (required) — Hostname of a Horizon server.

Returns

The UNIX timestamp (in seconds, not milliseconds) representing the current time on that server, or null if we don’t have a record of that time.

Source: src/horizon/horizon_axios_client.ts:95

Types

Horizon.HorizonApi.AccountMergeOperationResponse

interface AccountMergeOperationResponse extends BaseOperationResponse<OperationResponseType.accountMerge, OperationResponseTypeI.accountMerge> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
into: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: accountMerge;
type_i: accountMerge;
}

Source: src/horizon/horizon_api.ts:416

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

accountMergeOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

accountMergeOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

accountMergeOperationResponse.into

into: string;

Source: src/horizon/horizon_api.ts:420

accountMergeOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

accountMergeOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

accountMergeOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

accountMergeOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

accountMergeOperationResponse.type

type: accountMerge;

Source: src/horizon/horizon_api.ts:266

accountMergeOperationResponse.type_i

type_i: accountMerge;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.AccountResponse

interface AccountResponse extends BaseResponse<"transactions" | "operations" | "payments" | "effects" | "offers" | "trades" | "data"> {
_links: { data: ResponseLink; effects: ResponseLink; offers: ResponseLink; operations: ResponseLink; payments: ResponseLink; self: ResponseLink; trades: ResponseLink; transactions: ResponseLink };
account_id: string;
balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];
data: { [key: string]: string };
flags: Flags;
id: string;
last_modified_ledger: number;
last_modified_time: string;
num_sponsored: number;
num_sponsoring: number;
paging_token: string;
sequence: string;
sequence_ledger?: number;
sequence_time?: string;
signers: AccountSigner[];
sponsor?: string;
subentry_count: number;
thresholds: AccountThresholds;
}

Source: src/horizon/horizon_api.ts:167

_links: { data: ResponseLink; effects: ResponseLink; offers: ResponseLink; operations: ResponseLink; payments: ResponseLink; self: ResponseLink; trades: ResponseLink; transactions: ResponseLink };

Source: src/horizon/horizon_api.ts:10

accountResponse.account_id

account_id: string;

Source: src/horizon/horizon_api.ts:178

accountResponse.balances

balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];

Source: src/horizon/horizon_api.ts:187

accountResponse.data

data: { [key: string]: string };

Source: src/horizon/horizon_api.ts:189

accountResponse.flags

flags: Flags;

Source: src/horizon/horizon_api.ts:186

accountResponse.id

id: string;

Source: src/horizon/horizon_api.ts:176

accountResponse.last_modified_ledger

last_modified_ledger: number;

Source: src/horizon/horizon_api.ts:184

accountResponse.last_modified_time

last_modified_time: string;

Source: src/horizon/horizon_api.ts:185

accountResponse.num_sponsored

num_sponsored: number;

Source: src/horizon/horizon_api.ts:194

accountResponse.num_sponsoring

num_sponsoring: number;

Source: src/horizon/horizon_api.ts:193

accountResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:177

accountResponse.sequence

sequence: string;

Source: src/horizon/horizon_api.ts:179

accountResponse.sequence_ledger

sequence_ledger?: number;

Source: src/horizon/horizon_api.ts:180

accountResponse.sequence_time

sequence_time?: string;

Source: src/horizon/horizon_api.ts:181

accountResponse.signers

signers: AccountSigner[];

Source: src/horizon/horizon_api.ts:188

accountResponse.sponsor

sponsor?: string;

Source: src/horizon/horizon_api.ts:192

accountResponse.subentry_count

subentry_count: number;

Source: src/horizon/horizon_api.ts:182

accountResponse.thresholds

thresholds: AccountThresholds;

Source: src/horizon/horizon_api.ts:183

Horizon.HorizonApi.AccountSigner

interface AccountSigner {
key: string;
sponsor?: string;
type: string;
weight: number;
}

Source: src/horizon/horizon_api.ts:161

accountSigner.key

key: string;

Source: src/horizon/horizon_api.ts:162

accountSigner.sponsor

sponsor?: string;

Source: src/horizon/horizon_api.ts:165

accountSigner.type

type: string;

Source: src/horizon/horizon_api.ts:164

accountSigner.weight

weight: number;

Source: src/horizon/horizon_api.ts:163

Horizon.HorizonApi.AccountThresholds

interface AccountThresholds {
high_threshold: number;
low_threshold: number;
med_threshold: number;
}

Source: src/horizon/horizon_api.ts:150

accountThresholds.high_threshold

high_threshold: number;

Source: src/horizon/horizon_api.ts:153

accountThresholds.low_threshold

low_threshold: number;

Source: src/horizon/horizon_api.ts:151

accountThresholds.med_threshold

med_threshold: number;

Source: src/horizon/horizon_api.ts:152

Horizon.HorizonApi.AllowTrustOperationResponse

interface AllowTrustOperationResponse extends BaseOperationResponse<OperationResponseType.allowTrust, OperationResponseTypeI.allowTrust> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
authorize: boolean;
authorize_to_maintain_liabilities: boolean;
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
trustee: string;
trustor: string;
type: allowTrust;
type_i: allowTrust;
}

Source: src/horizon/horizon_api.ts:404

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

allowTrustOperationResponse.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:409

allowTrustOperationResponse.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:410

allowTrustOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:408

allowTrustOperationResponse.authorize

authorize: boolean;

Source: src/horizon/horizon_api.ts:411

allowTrustOperationResponse.authorize_to_maintain_liabilities

authorize_to_maintain_liabilities: boolean;

Source: src/horizon/horizon_api.ts:412

allowTrustOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

allowTrustOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

allowTrustOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

allowTrustOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

allowTrustOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

allowTrustOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

allowTrustOperationResponse.trustee

trustee: string;

Source: src/horizon/horizon_api.ts:413

allowTrustOperationResponse.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:414

allowTrustOperationResponse.type

type: allowTrust;

Source: src/horizon/horizon_api.ts:266

allowTrustOperationResponse.type_i

type_i: allowTrust;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.AssetAccounts

interface AssetAccounts {
authorized: number;
authorized_to_maintain_liabilities: number;
unauthorized: number;
}

Source: src/horizon/horizon_api.ts:129

assetAccounts.authorized

authorized: number;

Source: src/horizon/horizon_api.ts:130

assetAccounts.authorized_to_maintain_liabilities

authorized_to_maintain_liabilities: number;

Source: src/horizon/horizon_api.ts:131

assetAccounts.unauthorized

unauthorized: number;

Source: src/horizon/horizon_api.ts:132

Horizon.HorizonApi.AssetBalances

interface AssetBalances {
authorized: string;
authorized_to_maintain_liabilities: string;
unauthorized: string;
}

Source: src/horizon/horizon_api.ts:134

assetBalances.authorized

authorized: string;

Source: src/horizon/horizon_api.ts:135

assetBalances.authorized_to_maintain_liabilities

authorized_to_maintain_liabilities: string;

Source: src/horizon/horizon_api.ts:136

assetBalances.unauthorized

unauthorized: string;

Source: src/horizon/horizon_api.ts:137

Horizon.HorizonApi.BalanceChange

interface BalanceChange {
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: string;
destination_muxed_id?: string;
from: string;
to: string;
type: string;
}

Source: src/horizon/horizon_api.ts:557

balanceChange.amount

amount: string;

Source: src/horizon/horizon_api.ts:565

balanceChange.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:559

balanceChange.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:560

balanceChange.asset_type

asset_type: string;

Source: src/horizon/horizon_api.ts:558

balanceChange.destination_muxed_id

destination_muxed_id?: string;

Source: src/horizon/horizon_api.ts:566

balanceChange.from

from: string;

Source: src/horizon/horizon_api.ts:563

balanceChange.to

to: string;

Source: src/horizon/horizon_api.ts:564

balanceChange.type

type: string;

Source: src/horizon/horizon_api.ts:562

Horizon.HorizonApi.BalanceLine

type BalanceLine<T extends AssetType = AssetType> = T extends AssetType.native ? BalanceLineNative : T extends (AssetType.credit4 | AssetType.credit12) ? BalanceLineAsset<T> : T extends AssetType.liquidityPoolShares ? BalanceLineLiquidityPool : BalanceLineNative | BalanceLineAsset | BalanceLineLiquidityPool

Source: src/horizon/horizon_api.ts:120

Horizon.HorizonApi.BalanceLineAsset

interface BalanceLineAsset<T extends AssetType.credit4 | AssetType.credit12 = AssetType.credit4 | AssetType.credit12> {
asset_code: string;
asset_issuer: string;
asset_type: T;
balance: string;
buying_liabilities: string;
is_authorized: boolean;
is_authorized_to_maintain_liabilities: boolean;
is_clawback_enabled: boolean;
last_modified_ledger: number;
limit: string;
selling_liabilities: string;
sponsor?: string;
}

Source: src/horizon/horizon_api.ts:102

balanceLineAsset.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:110

balanceLineAsset.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:111

balanceLineAsset.asset_type

asset_type: T;

Source: src/horizon/horizon_api.ts:109

balanceLineAsset.balance

balance: string;

Source: src/horizon/horizon_api.ts:107

balanceLineAsset.buying_liabilities

buying_liabilities: string;

Source: src/horizon/horizon_api.ts:112

balanceLineAsset.is_authorized

is_authorized: boolean;

Source: src/horizon/horizon_api.ts:115

balanceLineAsset.is_authorized_to_maintain_liabilities

is_authorized_to_maintain_liabilities: boolean;

Source: src/horizon/horizon_api.ts:116

balanceLineAsset.is_clawback_enabled

is_clawback_enabled: boolean;

Source: src/horizon/horizon_api.ts:117

balanceLineAsset.last_modified_ledger

last_modified_ledger: number;

Source: src/horizon/horizon_api.ts:114

balanceLineAsset.limit

limit: string;

Source: src/horizon/horizon_api.ts:108

balanceLineAsset.selling_liabilities

selling_liabilities: string;

Source: src/horizon/horizon_api.ts:113

balanceLineAsset.sponsor

sponsor?: string;

Source: src/horizon/horizon_api.ts:118

Horizon.HorizonApi.BalanceLineLiquidityPool

interface BalanceLineLiquidityPool {
asset_type: "liquidity_pool_shares";
balance: string;
is_authorized: boolean;
is_authorized_to_maintain_liabilities: boolean;
is_clawback_enabled: boolean;
last_modified_ledger: number;
limit: string;
liquidity_pool_id: string;
sponsor?: string;
}

Source: src/horizon/horizon_api.ts:91

balanceLineLiquidityPool.asset_type

asset_type: "liquidity_pool_shares";

Source: src/horizon/horizon_api.ts:93

balanceLineLiquidityPool.balance

balance: string;

Source: src/horizon/horizon_api.ts:94

balanceLineLiquidityPool.is_authorized

is_authorized: boolean;

Source: src/horizon/horizon_api.ts:97

balanceLineLiquidityPool.is_authorized_to_maintain_liabilities

is_authorized_to_maintain_liabilities: boolean;

Source: src/horizon/horizon_api.ts:98

balanceLineLiquidityPool.is_clawback_enabled

is_clawback_enabled: boolean;

Source: src/horizon/horizon_api.ts:99

balanceLineLiquidityPool.last_modified_ledger

last_modified_ledger: number;

Source: src/horizon/horizon_api.ts:96

balanceLineLiquidityPool.limit

limit: string;

Source: src/horizon/horizon_api.ts:95

balanceLineLiquidityPool.liquidity_pool_id

liquidity_pool_id: string;

Source: src/horizon/horizon_api.ts:92

balanceLineLiquidityPool.sponsor

sponsor?: string;

Source: src/horizon/horizon_api.ts:100

Horizon.HorizonApi.BalanceLineNative

interface BalanceLineNative {
asset_type: "native";
balance: string;
buying_liabilities: string;
selling_liabilities: string;
}

Source: src/horizon/horizon_api.ts:85

balanceLineNative.asset_type

asset_type: "native";

Source: src/horizon/horizon_api.ts:87

balanceLineNative.balance

balance: string;

Source: src/horizon/horizon_api.ts:86

balanceLineNative.buying_liabilities

buying_liabilities: string;

Source: src/horizon/horizon_api.ts:88

balanceLineNative.selling_liabilities

selling_liabilities: string;

Source: src/horizon/horizon_api.ts:89

Horizon.HorizonApi.BaseOperationResponse

interface BaseOperationResponse<T extends OperationResponseType = OperationResponseType, TI extends OperationResponseTypeI = OperationResponseTypeI> extends BaseResponse<"succeeds" | "precedes" | "effects" | "transaction"> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: T;
type_i: TI;
}

Source: src/horizon/horizon_api.ts:259

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

baseOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

baseOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

baseOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

baseOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

baseOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

baseOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

baseOperationResponse.type

type: T;

Source: src/horizon/horizon_api.ts:266

baseOperationResponse.type_i

type_i: TI;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.BaseResponse

interface BaseResponse<T extends string = never> {
_links: { [key in string]: ResponseLink };
}

Source: src/horizon/horizon_api.ts:9

_links: { [key in string]: ResponseLink };

Source: src/horizon/horizon_api.ts:10

Horizon.HorizonApi.BeginSponsoringFutureReservesOperationResponse

interface BeginSponsoringFutureReservesOperationResponse extends BaseOperationResponse<OperationResponseType.beginSponsoringFutureReserves, OperationResponseTypeI.beginSponsoringFutureReserves> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
paging_token: string;
source_account: string;
sponsored_id: string;
transaction_hash: string;
transaction_successful: boolean;
type: beginSponsoringFutureReserves;
type_i: beginSponsoringFutureReserves;
}

Source: src/horizon/horizon_api.ts:471

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

beginSponsoringFutureReservesOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

beginSponsoringFutureReservesOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

beginSponsoringFutureReservesOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

beginSponsoringFutureReservesOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

beginSponsoringFutureReservesOperationResponse.sponsored_id

sponsored_id: string;

Source: src/horizon/horizon_api.ts:475

beginSponsoringFutureReservesOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

beginSponsoringFutureReservesOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

beginSponsoringFutureReservesOperationResponse.type

type: beginSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:266

beginSponsoringFutureReservesOperationResponse.type_i

type_i: beginSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.BumpFootprintExpirationOperationResponse

interface BumpFootprintExpirationOperationResponse extends BaseOperationResponse<OperationResponseType.bumpFootprintExpiration, OperationResponseTypeI.bumpFootprintExpiration> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
ledgers_to_expire: number;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: bumpFootprintExpiration;
type_i: bumpFootprintExpiration;
}

Source: src/horizon/horizon_api.ts:583

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

bumpFootprintExpirationOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

bumpFootprintExpirationOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

bumpFootprintExpirationOperationResponse.ledgers_to_expire

ledgers_to_expire: number;

Source: src/horizon/horizon_api.ts:587

bumpFootprintExpirationOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

bumpFootprintExpirationOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

bumpFootprintExpirationOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

bumpFootprintExpirationOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

bumpFootprintExpirationOperationResponse.type

type: bumpFootprintExpiration;

Source: src/horizon/horizon_api.ts:266

bumpFootprintExpirationOperationResponse.type_i

type_i: bumpFootprintExpiration;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.BumpSequenceOperationResponse

interface BumpSequenceOperationResponse extends BaseOperationResponse<OperationResponseType.bumpSequence, OperationResponseTypeI.bumpSequence> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
bump_to: string;
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: bumpSequence;
type_i: bumpSequence;
}

Source: src/horizon/horizon_api.ts:434

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

bumpSequenceOperationResponse.bump_to

bump_to: string;

Source: src/horizon/horizon_api.ts:438

bumpSequenceOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

bumpSequenceOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

bumpSequenceOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

bumpSequenceOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

bumpSequenceOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

bumpSequenceOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

bumpSequenceOperationResponse.type

type: bumpSequence;

Source: src/horizon/horizon_api.ts:266

bumpSequenceOperationResponse.type_i

type_i: bumpSequence;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.ChangeTrustOperationResponse

interface ChangeTrustOperationResponse extends BaseOperationResponse<OperationResponseType.changeTrust, OperationResponseTypeI.changeTrust> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code?: string;
asset_issuer?: string;
asset_type: "credit_alphanum4" | "credit_alphanum12" | "liquidity_pool_shares";
created_at: string;
id: string;
limit: string;
liquidity_pool_id?: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
trustee?: string;
trustor: string;
type: changeTrust;
type_i: changeTrust;
}

Source: src/horizon/horizon_api.ts:389

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

changeTrustOperationResponse.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:397

changeTrustOperationResponse.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:398

changeTrustOperationResponse.asset_type

asset_type: "credit_alphanum4" | "credit_alphanum12" | "liquidity_pool_shares";

Source: src/horizon/horizon_api.ts:393

changeTrustOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

changeTrustOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

changeTrustOperationResponse.limit

limit: string;

Source: src/horizon/horizon_api.ts:402

changeTrustOperationResponse.liquidity_pool_id

liquidity_pool_id?: string;

Source: src/horizon/horizon_api.ts:399

changeTrustOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

changeTrustOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

changeTrustOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

changeTrustOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

changeTrustOperationResponse.trustee

trustee?: string;

Source: src/horizon/horizon_api.ts:400

changeTrustOperationResponse.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:401

changeTrustOperationResponse.type

type: changeTrust;

Source: src/horizon/horizon_api.ts:266

changeTrustOperationResponse.type_i

type_i: changeTrust;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.ClaimClaimableBalanceOperationResponse

interface ClaimClaimableBalanceOperationResponse extends BaseOperationResponse<OperationResponseType.claimClaimableBalance, OperationResponseTypeI.claimClaimableBalance> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
balance_id: string;
claimant: string;
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: claimClaimableBalance;
type_i: claimClaimableBalance;
}

Source: src/horizon/horizon_api.ts:463

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

claimClaimableBalanceOperationResponse.balance_id

balance_id: string;

Source: src/horizon/horizon_api.ts:467

claimClaimableBalanceOperationResponse.claimant

claimant: string;

Source: src/horizon/horizon_api.ts:468

claimClaimableBalanceOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

claimClaimableBalanceOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

claimClaimableBalanceOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

claimClaimableBalanceOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

claimClaimableBalanceOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

claimClaimableBalanceOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

claimClaimableBalanceOperationResponse.type

type: claimClaimableBalance;

Source: src/horizon/horizon_api.ts:266

claimClaimableBalanceOperationResponse.type_i

type_i: claimClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.Claimant

interface Claimant {
destination: string;
predicate: Predicate;
}

Source: src/horizon/horizon_api.ts:448

claimant.destination

destination: string;

Source: src/horizon/horizon_api.ts:449

claimant.predicate

predicate: Predicate;

Source: src/horizon/horizon_api.ts:450

Horizon.HorizonApi.ClawbackClaimableBalanceOperationResponse

interface ClawbackClaimableBalanceOperationResponse extends BaseOperationResponse<OperationResponseType.clawbackClaimableBalance, OperationResponseTypeI.clawbackClaimableBalance> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
balance_id: string;
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: clawbackClaimableBalance;
type_i: clawbackClaimableBalance;
}

Source: src/horizon/horizon_api.ts:512

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

clawbackClaimableBalanceOperationResponse.balance_id

balance_id: string;

Source: src/horizon/horizon_api.ts:516

clawbackClaimableBalanceOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

clawbackClaimableBalanceOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

clawbackClaimableBalanceOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

clawbackClaimableBalanceOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

clawbackClaimableBalanceOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

clawbackClaimableBalanceOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

clawbackClaimableBalanceOperationResponse.type

type: clawbackClaimableBalance;

Source: src/horizon/horizon_api.ts:266

clawbackClaimableBalanceOperationResponse.type_i

type_i: clawbackClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.ClawbackOperationResponse

interface ClawbackOperationResponse extends BaseOperationResponse<OperationResponseType.clawback, OperationResponseTypeI.clawback> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
created_at: string;
from: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: clawback;
type_i: clawback;
}

Source: src/horizon/horizon_api.ts:501

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

clawbackOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:509

clawbackOperationResponse.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:506

clawbackOperationResponse.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:507

clawbackOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:505

clawbackOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

clawbackOperationResponse.from

from: string;

Source: src/horizon/horizon_api.ts:508

clawbackOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

clawbackOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

clawbackOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

clawbackOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

clawbackOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

clawbackOperationResponse.type

type: clawback;

Source: src/horizon/horizon_api.ts:266

clawbackOperationResponse.type_i

type_i: clawback;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.CreateAccountOperationResponse

interface CreateAccountOperationResponse extends BaseOperationResponse<OperationResponseType.createAccount, OperationResponseTypeI.createAccount> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
account: string;
created_at: string;
funder: string;
id: string;
paging_token: string;
source_account: string;
starting_balance: string;
transaction_hash: string;
transaction_successful: boolean;
type: createAccount;
type_i: createAccount;
}

Source: src/horizon/horizon_api.ts:272

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

createAccountOperationResponse.account

account: string;

Source: src/horizon/horizon_api.ts:276

createAccountOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

createAccountOperationResponse.funder

funder: string;

Source: src/horizon/horizon_api.ts:277

createAccountOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

createAccountOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

createAccountOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

createAccountOperationResponse.starting_balance

starting_balance: string;

Source: src/horizon/horizon_api.ts:278

createAccountOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

createAccountOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

createAccountOperationResponse.type

type: createAccount;

Source: src/horizon/horizon_api.ts:266

createAccountOperationResponse.type_i

type_i: createAccount;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.CreateClaimableBalanceOperationResponse

interface CreateClaimableBalanceOperationResponse extends BaseOperationResponse<OperationResponseType.createClaimableBalance, OperationResponseTypeI.createClaimableBalance> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset: string;
claimants: Claimant[];
created_at: string;
id: string;
paging_token: string;
source_account: string;
sponsor: string;
transaction_hash: string;
transaction_successful: boolean;
type: createClaimableBalance;
type_i: createClaimableBalance;
}

Source: src/horizon/horizon_api.ts:453

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

createClaimableBalanceOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:458

createClaimableBalanceOperationResponse.asset

asset: string;

Source: src/horizon/horizon_api.ts:457

createClaimableBalanceOperationResponse.claimants

claimants: Claimant[];

Source: src/horizon/horizon_api.ts:460

createClaimableBalanceOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

createClaimableBalanceOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

createClaimableBalanceOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

createClaimableBalanceOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

createClaimableBalanceOperationResponse.sponsor

sponsor: string;

Source: src/horizon/horizon_api.ts:459

createClaimableBalanceOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

createClaimableBalanceOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

createClaimableBalanceOperationResponse.type

type: createClaimableBalance;

Source: src/horizon/horizon_api.ts:266

createClaimableBalanceOperationResponse.type_i

type_i: createClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.DepositLiquidityOperationResponse

interface DepositLiquidityOperationResponse extends BaseOperationResponse<OperationResponseType.liquidityPoolDeposit, OperationResponseTypeI.liquidityPoolDeposit> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
liquidity_pool_id: string;
max_price: string;
max_price_r: PriceRShorthand;
min_price: string;
min_price_r: PriceRShorthand;
paging_token: string;
reserves_deposited: Reserve[];
reserves_max: Reserve[];
shares_received: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: liquidityPoolDeposit;
type_i: liquidityPoolDeposit;
}

Source: src/horizon/horizon_api.ts:534

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

depositLiquidityOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

depositLiquidityOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

depositLiquidityOperationResponse.liquidity_pool_id

liquidity_pool_id: string;

Source: src/horizon/horizon_api.ts:538

depositLiquidityOperationResponse.max_price

max_price: string;

Source: src/horizon/horizon_api.ts:542

depositLiquidityOperationResponse.max_price_r

max_price_r: PriceRShorthand;

Source: src/horizon/horizon_api.ts:543

depositLiquidityOperationResponse.min_price

min_price: string;

Source: src/horizon/horizon_api.ts:540

depositLiquidityOperationResponse.min_price_r

min_price_r: PriceRShorthand;

Source: src/horizon/horizon_api.ts:541

depositLiquidityOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

depositLiquidityOperationResponse.reserves_deposited

reserves_deposited: Reserve[];

Source: src/horizon/horizon_api.ts:544

depositLiquidityOperationResponse.reserves_max

reserves_max: Reserve[];

Source: src/horizon/horizon_api.ts:539

depositLiquidityOperationResponse.shares_received

shares_received: string;

Source: src/horizon/horizon_api.ts:545

depositLiquidityOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

depositLiquidityOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

depositLiquidityOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

depositLiquidityOperationResponse.type

type: liquidityPoolDeposit;

Source: src/horizon/horizon_api.ts:266

depositLiquidityOperationResponse.type_i

type_i: liquidityPoolDeposit;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.EndSponsoringFutureReservesOperationResponse

interface EndSponsoringFutureReservesOperationResponse extends BaseOperationResponse<OperationResponseType.endSponsoringFutureReserves, OperationResponseTypeI.endSponsoringFutureReserves> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
begin_sponsor: string;
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: endSponsoringFutureReserves;
type_i: endSponsoringFutureReserves;
}

Source: src/horizon/horizon_api.ts:478

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

endSponsoringFutureReservesOperationResponse.begin_sponsor

begin_sponsor: string;

Source: src/horizon/horizon_api.ts:482

endSponsoringFutureReservesOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

endSponsoringFutureReservesOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

endSponsoringFutureReservesOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

endSponsoringFutureReservesOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

endSponsoringFutureReservesOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

endSponsoringFutureReservesOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

endSponsoringFutureReservesOperationResponse.type

type: endSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:266

endSponsoringFutureReservesOperationResponse.type_i

type_i: endSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.ErrorResponseData

type ErrorResponseData = ErrorResponseData.RateLimitExceeded | ErrorResponseData.InternalServerError | ErrorResponseData.TransactionFailed

Source: src/horizon/horizon_api.ts:633

Horizon.HorizonApi.ErrorResponseData.Base

interface Base {
details: string;
instance: string;
status: number;
title: string;
type: string;
}

Source: src/horizon/horizon_api.ts:639

base.details

details: string;

Source: src/horizon/horizon_api.ts:643

base.instance

instance: string;

Source: src/horizon/horizon_api.ts:644

base.status

status: number;

Source: src/horizon/horizon_api.ts:640

base.title

title: string;

Source: src/horizon/horizon_api.ts:641

base.type

type: string;

Source: src/horizon/horizon_api.ts:642

Horizon.HorizonApi.ErrorResponseData.InternalServerError

interface InternalServerError extends Base {
details: string;
instance: string;
status: 500;
title: "Internal Server Error";
type: string;
}

Source: src/horizon/horizon_api.ts:651

internalServerError.details

details: string;

Source: src/horizon/horizon_api.ts:643

internalServerError.instance

instance: string;

Source: src/horizon/horizon_api.ts:644

internalServerError.status

status: 500;

Source: src/horizon/horizon_api.ts:652

internalServerError.title

title: "Internal Server Error";

Source: src/horizon/horizon_api.ts:653

internalServerError.type

type: string;

Source: src/horizon/horizon_api.ts:642

Horizon.HorizonApi.ErrorResponseData.RateLimitExceeded

interface RateLimitExceeded extends Base {
details: string;
instance: string;
status: 429;
title: "Rate Limit Exceeded";
type: string;
}

Source: src/horizon/horizon_api.ts:647

rateLimitExceeded.details

details: string;

Source: src/horizon/horizon_api.ts:643

rateLimitExceeded.instance

instance: string;

Source: src/horizon/horizon_api.ts:644

rateLimitExceeded.status

status: 429;

Source: src/horizon/horizon_api.ts:648

rateLimitExceeded.title

title: "Rate Limit Exceeded";

Source: src/horizon/horizon_api.ts:649

rateLimitExceeded.type

type: string;

Source: src/horizon/horizon_api.ts:642

Horizon.HorizonApi.ErrorResponseData.TransactionFailed

interface TransactionFailed extends Base {
details: string;
extras: TransactionFailedExtras;
instance: string;
status: 400;
title: "Transaction Failed";
type: string;
}

Source: src/horizon/horizon_api.ts:655

transactionFailed.details

details: string;

Source: src/horizon/horizon_api.ts:643

transactionFailed.extras

extras: TransactionFailedExtras;

Source: src/horizon/horizon_api.ts:658

transactionFailed.instance

instance: string;

Source: src/horizon/horizon_api.ts:644

transactionFailed.status

status: 400;

Source: src/horizon/horizon_api.ts:656

transactionFailed.title

title: "Transaction Failed";

Source: src/horizon/horizon_api.ts:657

transactionFailed.type

type: string;

Source: src/horizon/horizon_api.ts:642

Horizon.HorizonApi.FeeBumpTransactionResponse

interface FeeBumpTransactionResponse {
hash: string;
signatures: string[];
}

Source: src/horizon/horizon_api.ts:29

feeBumpTransactionResponse.hash

hash: string;

Source: src/horizon/horizon_api.ts:30

feeBumpTransactionResponse.signatures

signatures: string[];

Source: src/horizon/horizon_api.ts:31

Horizon.HorizonApi.FeeDistribution

interface FeeDistribution {
max: string;
min: string;
mode: string;
p10: string;
p20: string;
p30: string;
p40: string;
p50: string;
p60: string;
p70: string;
p80: string;
p90: string;
p95: string;
p99: string;
}

Source: src/horizon/horizon_api.ts:609

feeDistribution.max

max: string;

Source: src/horizon/horizon_api.ts:610

feeDistribution.min

min: string;

Source: src/horizon/horizon_api.ts:611

feeDistribution.mode

mode: string;

Source: src/horizon/horizon_api.ts:612

feeDistribution.p10

p10: string;

Source: src/horizon/horizon_api.ts:613

feeDistribution.p20

p20: string;

Source: src/horizon/horizon_api.ts:614

feeDistribution.p30

p30: string;

Source: src/horizon/horizon_api.ts:615

feeDistribution.p40

p40: string;

Source: src/horizon/horizon_api.ts:616

feeDistribution.p50

p50: string;

Source: src/horizon/horizon_api.ts:617

feeDistribution.p60

p60: string;

Source: src/horizon/horizon_api.ts:618

feeDistribution.p70

p70: string;

Source: src/horizon/horizon_api.ts:619

feeDistribution.p80

p80: string;

Source: src/horizon/horizon_api.ts:620

feeDistribution.p90

p90: string;

Source: src/horizon/horizon_api.ts:621

feeDistribution.p95

p95: string;

Source: src/horizon/horizon_api.ts:622

feeDistribution.p99

p99: string;

Source: src/horizon/horizon_api.ts:623

Horizon.HorizonApi.FeeStatsResponse

interface FeeStatsResponse {
fee_charged: FeeDistribution;
last_ledger: string;
last_ledger_base_fee: string;
ledger_capacity_usage: string;
max_fee: FeeDistribution;
}

Source: src/horizon/horizon_api.ts:625

feeStatsResponse.fee_charged

fee_charged: FeeDistribution;

Source: src/horizon/horizon_api.ts:629

feeStatsResponse.last_ledger

last_ledger: string;

Source: src/horizon/horizon_api.ts:626

feeStatsResponse.last_ledger_base_fee

last_ledger_base_fee: string;

Source: src/horizon/horizon_api.ts:627

feeStatsResponse.ledger_capacity_usage

ledger_capacity_usage: string;

Source: src/horizon/horizon_api.ts:628

feeStatsResponse.max_fee

max_fee: FeeDistribution;

Source: src/horizon/horizon_api.ts:630

Horizon.HorizonApi.Flags

interface Flags {
auth_clawback_enabled: boolean;
auth_immutable: boolean;
auth_required: boolean;
auth_revocable: boolean;
}

Source: src/horizon/horizon_api.ts:155

flags.auth_clawback_enabled

auth_clawback_enabled: boolean;

Source: src/horizon/horizon_api.ts:159

flags.auth_immutable

auth_immutable: boolean;

Source: src/horizon/horizon_api.ts:156

flags.auth_required

auth_required: boolean;

Source: src/horizon/horizon_api.ts:157

flags.auth_revocable

auth_revocable: boolean;

Source: src/horizon/horizon_api.ts:158

Horizon.HorizonApi.InflationOperationResponse

interface InflationOperationResponse extends BaseOperationResponse<OperationResponseType.inflation, OperationResponseTypeI.inflation> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: inflation;
type_i: inflation;
}

Source: src/horizon/horizon_api.ts:423

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

inflationOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

inflationOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

inflationOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

inflationOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

inflationOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

inflationOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

inflationOperationResponse.type

type: inflation;

Source: src/horizon/horizon_api.ts:266

inflationOperationResponse.type_i

type_i: inflation;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.InnerTransactionResponse

interface InnerTransactionResponse {
hash: string;
max_fee: string;
signatures: string[];
}

Source: src/horizon/horizon_api.ts:34

innerTransactionResponse.hash

hash: string;

Source: src/horizon/horizon_api.ts:35

innerTransactionResponse.max_fee

max_fee: string;

Source: src/horizon/horizon_api.ts:37

innerTransactionResponse.signatures

signatures: string[];

Source: src/horizon/horizon_api.ts:36

Horizon.HorizonApi.InvokeHostFunctionOperationResponse

interface InvokeHostFunctionOperationResponse extends BaseOperationResponse<OperationResponseType.invokeHostFunction, OperationResponseTypeI.invokeHostFunction> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
address: string;
asset_balance_changes: BalanceChange[];
created_at: string;
function: string;
id: string;
paging_token: string;
parameters: { type: string; value: string }[];
salt: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: invokeHostFunction;
type_i: invokeHostFunction;
}

Source: src/horizon/horizon_api.ts:569

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

invokeHostFunctionOperationResponse.address

address: string;

Source: src/horizon/horizon_api.ts:578

invokeHostFunctionOperationResponse.asset_balance_changes

asset_balance_changes: BalanceChange[];

Source: src/horizon/horizon_api.ts:580

invokeHostFunctionOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

invokeHostFunctionOperationResponse.function

function: string;

Source: src/horizon/horizon_api.ts:573

invokeHostFunctionOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

invokeHostFunctionOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

invokeHostFunctionOperationResponse.parameters

parameters: { type: string; value: string }[];

Source: src/horizon/horizon_api.ts:574

invokeHostFunctionOperationResponse.salt

salt: string;

Source: src/horizon/horizon_api.ts:579

invokeHostFunctionOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

invokeHostFunctionOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

invokeHostFunctionOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

invokeHostFunctionOperationResponse.type

type: invokeHostFunction;

Source: src/horizon/horizon_api.ts:266

invokeHostFunctionOperationResponse.type_i

type_i: invokeHostFunction;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.LiquidityPoolType

enum LiquidityPoolType

Source: src/horizon/horizon_api.ts:197

Horizon.HorizonApi.ManageDataOperationResponse

interface ManageDataOperationResponse extends BaseOperationResponse<OperationResponseType.manageData, OperationResponseTypeI.manageData> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
name: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: manageData;
type_i: manageData;
value: Buffer;
}

Source: src/horizon/horizon_api.ts:427

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

manageDataOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

manageDataOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

manageDataOperationResponse.name

name: string;

Source: src/horizon/horizon_api.ts:431

manageDataOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

manageDataOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

manageDataOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

manageDataOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

manageDataOperationResponse.type

type: manageData;

Source: src/horizon/horizon_api.ts:266

manageDataOperationResponse.type_i

type_i: manageData;

Source: src/horizon/horizon_api.ts:267

manageDataOperationResponse.value

value: Buffer;

Source: src/horizon/horizon_api.ts:432

Horizon.HorizonApi.ManageOfferOperationResponse

interface ManageOfferOperationResponse extends BaseOperationResponse<OperationResponseType.manageOffer, OperationResponseTypeI.manageOffer> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
buying_asset_code?: string;
buying_asset_issuer?: string;
buying_asset_type: AssetType;
created_at: string;
id: string;
offer_id: string | number;
paging_token: string;
price: string;
price_r: PriceR;
selling_asset_code?: string;
selling_asset_issuer?: string;
selling_asset_type: AssetType;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: manageOffer;
type_i: manageOffer;
}

Source: src/horizon/horizon_api.ts:335

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

manageOfferOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:340

manageOfferOperationResponse.buying_asset_code

buying_asset_code?: string;

Source: src/horizon/horizon_api.ts:342

manageOfferOperationResponse.buying_asset_issuer

buying_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:343

manageOfferOperationResponse.buying_asset_type

buying_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:341

manageOfferOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

manageOfferOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

manageOfferOperationResponse.offer_id

offer_id: string | number;

Source: src/horizon/horizon_api.ts:339

manageOfferOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

manageOfferOperationResponse.price

price: string;

Source: src/horizon/horizon_api.ts:344

manageOfferOperationResponse.price_r

price_r: PriceR;

Source: src/horizon/horizon_api.ts:345

manageOfferOperationResponse.selling_asset_code

selling_asset_code?: string;

Source: src/horizon/horizon_api.ts:347

manageOfferOperationResponse.selling_asset_issuer

selling_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:348

manageOfferOperationResponse.selling_asset_type

selling_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:346

manageOfferOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

manageOfferOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

manageOfferOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

manageOfferOperationResponse.type

type: manageOffer;

Source: src/horizon/horizon_api.ts:266

manageOfferOperationResponse.type_i

type_i: manageOffer;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.OperationResponseType

enum OperationResponseType

Source: src/horizon/horizon_api.ts:201

Horizon.HorizonApi.OperationResponseTypeI

enum OperationResponseTypeI

Source: src/horizon/horizon_api.ts:230

Horizon.HorizonApi.PassiveOfferOperationResponse

interface PassiveOfferOperationResponse extends BaseOperationResponse<OperationResponseType.createPassiveOffer, OperationResponseTypeI.createPassiveOffer> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
buying_asset_code?: string;
buying_asset_issuer?: string;
buying_asset_type: AssetType;
created_at: string;
id: string;
offer_id: string | number;
paging_token: string;
price: string;
price_r: PriceR;
selling_asset_code?: string;
selling_asset_issuer?: string;
selling_asset_type: AssetType;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: createPassiveOffer;
type_i: createPassiveOffer;
}

Source: src/horizon/horizon_api.ts:350

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

passiveOfferOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:355

passiveOfferOperationResponse.buying_asset_code

buying_asset_code?: string;

Source: src/horizon/horizon_api.ts:357

passiveOfferOperationResponse.buying_asset_issuer

buying_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:358

passiveOfferOperationResponse.buying_asset_type

buying_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:356

passiveOfferOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

passiveOfferOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

passiveOfferOperationResponse.offer_id

offer_id: string | number;

Source: src/horizon/horizon_api.ts:354

passiveOfferOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

passiveOfferOperationResponse.price

price: string;

Source: src/horizon/horizon_api.ts:359

passiveOfferOperationResponse.price_r

price_r: PriceR;

Source: src/horizon/horizon_api.ts:360

passiveOfferOperationResponse.selling_asset_code

selling_asset_code?: string;

Source: src/horizon/horizon_api.ts:362

passiveOfferOperationResponse.selling_asset_issuer

selling_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:363

passiveOfferOperationResponse.selling_asset_type

selling_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:361

passiveOfferOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

passiveOfferOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

passiveOfferOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

passiveOfferOperationResponse.type

type: createPassiveOffer;

Source: src/horizon/horizon_api.ts:266

passiveOfferOperationResponse.type_i

type_i: createPassiveOffer;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.PathPaymentOperationResponse

interface PathPaymentOperationResponse extends BaseOperationResponse<OperationResponseType.pathPayment, OperationResponseTypeI.pathPayment> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
from: string;
id: string;
paging_token: string;
path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];
source_account: string;
source_amount: string;
source_asset_code?: string;
source_asset_issuer?: string;
source_asset_type: AssetType;
source_max: string;
to: string;
transaction_hash: string;
transaction_successful: boolean;
type: pathPayment;
type_i: pathPayment;
}

Source: src/horizon/horizon_api.ts:293

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

pathPaymentOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:297

pathPaymentOperationResponse.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:298

pathPaymentOperationResponse.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:299

pathPaymentOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:300

pathPaymentOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

pathPaymentOperationResponse.from

from: string;

Source: src/horizon/horizon_api.ts:301

pathPaymentOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

pathPaymentOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

pathPaymentOperationResponse.path

path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];

Source: src/horizon/horizon_api.ts:302

pathPaymentOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

pathPaymentOperationResponse.source_amount

source_amount: string;

Source: src/horizon/horizon_api.ts:307

pathPaymentOperationResponse.source_asset_code

source_asset_code?: string;

Source: src/horizon/horizon_api.ts:308

pathPaymentOperationResponse.source_asset_issuer

source_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:309

pathPaymentOperationResponse.source_asset_type

source_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:310

pathPaymentOperationResponse.source_max

source_max: string;

Source: src/horizon/horizon_api.ts:311

pathPaymentOperationResponse.to

to: string;

Source: src/horizon/horizon_api.ts:312

pathPaymentOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

pathPaymentOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

pathPaymentOperationResponse.type

type: pathPayment;

Source: src/horizon/horizon_api.ts:266

pathPaymentOperationResponse.type_i

type_i: pathPayment;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.PathPaymentStrictSendOperationResponse

interface PathPaymentStrictSendOperationResponse extends BaseOperationResponse<OperationResponseType.pathPaymentStrictSend, OperationResponseTypeI.pathPaymentStrictSend> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
destination_min: string;
from: string;
id: string;
paging_token: string;
path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];
source_account: string;
source_amount: string;
source_asset_code?: string;
source_asset_issuer?: string;
source_asset_type: AssetType;
to: string;
transaction_hash: string;
transaction_successful: boolean;
type: pathPaymentStrictSend;
type_i: pathPaymentStrictSend;
}

Source: src/horizon/horizon_api.ts:314

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

pathPaymentStrictSendOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:318

pathPaymentStrictSendOperationResponse.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:319

pathPaymentStrictSendOperationResponse.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:320

pathPaymentStrictSendOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:321

pathPaymentStrictSendOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

pathPaymentStrictSendOperationResponse.destination_min

destination_min: string;

Source: src/horizon/horizon_api.ts:322

pathPaymentStrictSendOperationResponse.from

from: string;

Source: src/horizon/horizon_api.ts:323

pathPaymentStrictSendOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

pathPaymentStrictSendOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

pathPaymentStrictSendOperationResponse.path

path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];

Source: src/horizon/horizon_api.ts:324

pathPaymentStrictSendOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

pathPaymentStrictSendOperationResponse.source_amount

source_amount: string;

Source: src/horizon/horizon_api.ts:329

pathPaymentStrictSendOperationResponse.source_asset_code

source_asset_code?: string;

Source: src/horizon/horizon_api.ts:330

pathPaymentStrictSendOperationResponse.source_asset_issuer

source_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:331

pathPaymentStrictSendOperationResponse.source_asset_type

source_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:332

pathPaymentStrictSendOperationResponse.to

to: string;

Source: src/horizon/horizon_api.ts:333

pathPaymentStrictSendOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

pathPaymentStrictSendOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

pathPaymentStrictSendOperationResponse.type

type: pathPaymentStrictSend;

Source: src/horizon/horizon_api.ts:266

pathPaymentStrictSendOperationResponse.type_i

type_i: pathPaymentStrictSend;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.PaymentOperationResponse

interface PaymentOperationResponse extends BaseOperationResponse<OperationResponseType.payment, OperationResponseTypeI.payment> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
from: string;
id: string;
paging_token: string;
source_account: string;
to: string;
to_muxed?: string;
to_muxed_id?: string;
transaction_hash: string;
transaction_successful: boolean;
type: payment;
type_i: payment;
}

Source: src/horizon/horizon_api.ts:280

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

paymentOperationResponse.amount

amount: string;

Source: src/horizon/horizon_api.ts:289

paymentOperationResponse.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:287

paymentOperationResponse.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:288

paymentOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:286

paymentOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

paymentOperationResponse.from

from: string;

Source: src/horizon/horizon_api.ts:284

paymentOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

paymentOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

paymentOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

paymentOperationResponse.to

to: string;

Source: src/horizon/horizon_api.ts:285

paymentOperationResponse.to_muxed

to_muxed?: string;

Source: src/horizon/horizon_api.ts:290

paymentOperationResponse.to_muxed_id

to_muxed_id?: string;

Source: src/horizon/horizon_api.ts:291

paymentOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

paymentOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

paymentOperationResponse.type

type: payment;

Source: src/horizon/horizon_api.ts:266

paymentOperationResponse.type_i

type_i: payment;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.Predicate

interface Predicate {
abs_before?: string;
and?: Predicate[];
not?: Predicate;
or?: Predicate[];
rel_before?: string;
}

Source: src/horizon/horizon_api.ts:440

predicate.abs_before

abs_before?: string;

Source: src/horizon/horizon_api.ts:444

predicate.and

and?: Predicate[];

Source: src/horizon/horizon_api.ts:441

predicate.not

not?: Predicate;

Source: src/horizon/horizon_api.ts:443

predicate.or

or?: Predicate[];

Source: src/horizon/horizon_api.ts:442

predicate.rel_before

rel_before?: string;

Source: src/horizon/horizon_api.ts:445

Horizon.HorizonApi.PriceR

interface PriceR {
denominator: number;
numerator: number;
}

Source: src/horizon/horizon_api.ts:140

priceR.denominator

denominator: number;

Source: src/horizon/horizon_api.ts:142

priceR.numerator

numerator: number;

Source: src/horizon/horizon_api.ts:141

Horizon.HorizonApi.PriceRShorthand

interface PriceRShorthand {
d: number;
n: number;
}

Source: src/horizon/horizon_api.ts:145

priceRShorthand.d

d: number;

Source: src/horizon/horizon_api.ts:147

priceRShorthand.n

n: number;

Source: src/horizon/horizon_api.ts:146

Horizon.HorizonApi.Reserve

interface Reserve {
amount: string;
asset: string;
}

Source: src/horizon/horizon_api.ts:530

reserve.amount

amount: string;

Source: src/horizon/horizon_api.ts:532

reserve.asset

asset: string;

Source: src/horizon/horizon_api.ts:531

Horizon.HorizonApi.ResponseCollection

interface ResponseCollection<T extends BaseResponse = BaseResponse> {
_embedded: { records: T[] };
_links: { next: ResponseLink; prev: ResponseLink; self: ResponseLink };
}

Source: src/horizon/horizon_api.ts:596

responseCollection._embedded

_embedded: { records: T[] };

Source: src/horizon/horizon_api.ts:602

_links: { next: ResponseLink; prev: ResponseLink; self: ResponseLink };

Source: src/horizon/horizon_api.ts:597

interface ResponseLink {
href: string;
templated?: boolean;
}

Source: src/horizon/horizon_api.ts:5

responseLink.href

href: string;

Source: src/horizon/horizon_api.ts:6

responseLink.templated

templated?: boolean;

Source: src/horizon/horizon_api.ts:7

Horizon.HorizonApi.RestoreFootprintOperationResponse

interface RestoreFootprintOperationResponse extends BaseOperationResponse<OperationResponseType.restoreFootprint, OperationResponseTypeI.restoreFootprint> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
paging_token: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: restoreFootprint;
type_i: restoreFootprint;
}

Source: src/horizon/horizon_api.ts:591

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

restoreFootprintOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

restoreFootprintOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

restoreFootprintOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

restoreFootprintOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

restoreFootprintOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

restoreFootprintOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

restoreFootprintOperationResponse.type

type: restoreFootprint;

Source: src/horizon/horizon_api.ts:266

restoreFootprintOperationResponse.type_i

type_i: restoreFootprint;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.RevokeSponsorshipOperationResponse

interface RevokeSponsorshipOperationResponse extends BaseOperationResponse<OperationResponseType.revokeSponsorship, OperationResponseTypeI.revokeSponsorship> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
account_id?: string;
claimable_balance_id?: string;
created_at: string;
data_account_id?: string;
data_name?: string;
id: string;
offer_id?: string;
paging_token: string;
signer_account_id?: string;
signer_key?: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
trustline_account_id?: string;
trustline_asset?: string;
trustline_liquidity_pool_id?: string;
type: revokeSponsorship;
type_i: revokeSponsorship;
}

Source: src/horizon/horizon_api.ts:485

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

revokeSponsorshipOperationResponse.account_id

account_id?: string;

Source: src/horizon/horizon_api.ts:489

revokeSponsorshipOperationResponse.claimable_balance_id

claimable_balance_id?: string;

Source: src/horizon/horizon_api.ts:490

revokeSponsorshipOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

revokeSponsorshipOperationResponse.data_account_id

data_account_id?: string;

Source: src/horizon/horizon_api.ts:491

revokeSponsorshipOperationResponse.data_name

data_name?: string;

Source: src/horizon/horizon_api.ts:492

revokeSponsorshipOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

revokeSponsorshipOperationResponse.offer_id

offer_id?: string;

Source: src/horizon/horizon_api.ts:493

revokeSponsorshipOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

revokeSponsorshipOperationResponse.signer_account_id

signer_account_id?: string;

Source: src/horizon/horizon_api.ts:497

revokeSponsorshipOperationResponse.signer_key

signer_key?: string;

Source: src/horizon/horizon_api.ts:498

revokeSponsorshipOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

revokeSponsorshipOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

revokeSponsorshipOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

revokeSponsorshipOperationResponse.trustline_account_id

trustline_account_id?: string;

Source: src/horizon/horizon_api.ts:494

revokeSponsorshipOperationResponse.trustline_asset

trustline_asset?: string;

Source: src/horizon/horizon_api.ts:495

revokeSponsorshipOperationResponse.trustline_liquidity_pool_id

trustline_liquidity_pool_id?: string;

Source: src/horizon/horizon_api.ts:496

revokeSponsorshipOperationResponse.type

type: revokeSponsorship;

Source: src/horizon/horizon_api.ts:266

revokeSponsorshipOperationResponse.type_i

type_i: revokeSponsorship;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.RootResponse

interface RootResponse {
core_latest_ledger: number;
core_supported_protocol_version: number;
core_version: string;
current_protocol_version: number;
history_elder_ledger: number;
history_latest_ledger: number;
history_latest_ledger_closed_at: string;
horizon_version: string;
ingest_latest_ledger: number;
network_passphrase: string;
supported_protocol_version: number;
}

Source: src/horizon/horizon_api.ts:689

rootResponse.core_latest_ledger

core_latest_ledger: number;

Source: src/horizon/horizon_api.ts:696

rootResponse.core_supported_protocol_version

core_supported_protocol_version: number;

Source: src/horizon/horizon_api.ts:700

rootResponse.core_version

core_version: string;

Source: src/horizon/horizon_api.ts:691

rootResponse.current_protocol_version

current_protocol_version: number;

Source: src/horizon/horizon_api.ts:698

rootResponse.history_elder_ledger

history_elder_ledger: number;

Source: src/horizon/horizon_api.ts:695

rootResponse.history_latest_ledger

history_latest_ledger: number;

Source: src/horizon/horizon_api.ts:693

rootResponse.history_latest_ledger_closed_at

history_latest_ledger_closed_at: string;

Source: src/horizon/horizon_api.ts:694

rootResponse.horizon_version

horizon_version: string;

Source: src/horizon/horizon_api.ts:690

rootResponse.ingest_latest_ledger

ingest_latest_ledger: number;

Source: src/horizon/horizon_api.ts:692

rootResponse.network_passphrase

network_passphrase: string;

Source: src/horizon/horizon_api.ts:697

rootResponse.supported_protocol_version

supported_protocol_version: number;

Source: src/horizon/horizon_api.ts:699

Horizon.HorizonApi.SetOptionsOperationResponse

interface SetOptionsOperationResponse extends BaseOperationResponse<OperationResponseType.setOptions, OperationResponseTypeI.setOptions> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
clear_flags: (1 | 2 | 4)[];
clear_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];
created_at: string;
high_threshold?: number;
home_domain?: string;
id: string;
low_threshold?: number;
master_key_weight?: number;
med_threshold?: number;
paging_token: string;
set_flags: (1 | 2 | 4)[];
set_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];
signer_key?: string;
signer_weight?: number;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: setOptions;
type_i: setOptions;
}

Source: src/horizon/horizon_api.ts:365

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

setOptionsOperationResponse.clear_flags

clear_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:382

setOptionsOperationResponse.clear_flags_s

clear_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];

Source: src/horizon/horizon_api.ts:383

setOptionsOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

setOptionsOperationResponse.high_threshold

high_threshold?: number;

Source: src/horizon/horizon_api.ts:374

setOptionsOperationResponse.home_domain

home_domain?: string;

Source: src/horizon/horizon_api.ts:375

setOptionsOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

setOptionsOperationResponse.low_threshold

low_threshold?: number;

Source: src/horizon/horizon_api.ts:372

setOptionsOperationResponse.master_key_weight

master_key_weight?: number;

Source: src/horizon/horizon_api.ts:371

setOptionsOperationResponse.med_threshold

med_threshold?: number;

Source: src/horizon/horizon_api.ts:373

setOptionsOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

setOptionsOperationResponse.set_flags

set_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:376

setOptionsOperationResponse.set_flags_s

set_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];

Source: src/horizon/horizon_api.ts:377

setOptionsOperationResponse.signer_key

signer_key?: string;

Source: src/horizon/horizon_api.ts:369

setOptionsOperationResponse.signer_weight

signer_weight?: number;

Source: src/horizon/horizon_api.ts:370

setOptionsOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

setOptionsOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

setOptionsOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

setOptionsOperationResponse.type

type: setOptions;

Source: src/horizon/horizon_api.ts:266

setOptionsOperationResponse.type_i

type_i: setOptions;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.SetTrustLineFlagsOperationResponse

interface SetTrustLineFlagsOperationResponse extends BaseOperationResponse<OperationResponseType.setTrustLineFlags, OperationResponseTypeI.setTrustLineFlags> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
clear_flags: (1 | 2 | 4)[];
created_at: string;
id: string;
paging_token: string;
set_flags: (1 | 2 | 4)[];
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
trustor: string;
type: setTrustLineFlags;
type_i: setTrustLineFlags;
}

Source: src/horizon/horizon_api.ts:519

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

setTrustLineFlagsOperationResponse.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:524

setTrustLineFlagsOperationResponse.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:525

setTrustLineFlagsOperationResponse.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:523

setTrustLineFlagsOperationResponse.clear_flags

clear_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:528

setTrustLineFlagsOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

setTrustLineFlagsOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

setTrustLineFlagsOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

setTrustLineFlagsOperationResponse.set_flags

set_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:527

setTrustLineFlagsOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

setTrustLineFlagsOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

setTrustLineFlagsOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

setTrustLineFlagsOperationResponse.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:526

setTrustLineFlagsOperationResponse.type

type: setTrustLineFlags;

Source: src/horizon/horizon_api.ts:266

setTrustLineFlagsOperationResponse.type_i

type_i: setTrustLineFlags;

Source: src/horizon/horizon_api.ts:267

Horizon.HorizonApi.SubmitAsyncTransactionResponse

interface SubmitAsyncTransactionResponse {
error_result_xdr: string;
hash: string;
tx_status: string;
}

Source: src/horizon/horizon_api.ts:23

submitAsyncTransactionResponse.error_result_xdr

error_result_xdr: string;

Source: src/horizon/horizon_api.ts:26

submitAsyncTransactionResponse.hash

hash: string;

Source: src/horizon/horizon_api.ts:24

submitAsyncTransactionResponse.tx_status

tx_status: string;

Source: src/horizon/horizon_api.ts:25

Horizon.HorizonApi.SubmitTransactionResponse

interface SubmitTransactionResponse {
envelope_xdr: string;
hash: string;
ledger: number;
paging_token: string;
result_meta_xdr: string;
result_xdr: string;
successful: boolean;
}

Source: src/horizon/horizon_api.ts:13

submitTransactionResponse.envelope_xdr

envelope_xdr: string;

Source: src/horizon/horizon_api.ts:17

submitTransactionResponse.hash

hash: string;

Source: src/horizon/horizon_api.ts:14

submitTransactionResponse.ledger

ledger: number;

Source: src/horizon/horizon_api.ts:15

submitTransactionResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:20

submitTransactionResponse.result_meta_xdr

result_meta_xdr: string;

Source: src/horizon/horizon_api.ts:19

submitTransactionResponse.result_xdr

result_xdr: string;

Source: src/horizon/horizon_api.ts:18

submitTransactionResponse.successful

successful: boolean;

Source: src/horizon/horizon_api.ts:16

Horizon.HorizonApi.TransactionFailedExtras

interface TransactionFailedExtras {
envelope_xdr: string;
result_codes: { operations: string[]; transaction: TransactionFailedResultCodes };
result_xdr: string;
}

Source: src/horizon/horizon_api.ts:680

transactionFailedExtras.envelope_xdr

envelope_xdr: string;

Source: src/horizon/horizon_api.ts:681

transactionFailedExtras.result_codes

result_codes: { operations: string[]; transaction: TransactionFailedResultCodes };

Source: src/horizon/horizon_api.ts:682

transactionFailedExtras.result_xdr

result_xdr: string;

Source: src/horizon/horizon_api.ts:686

Horizon.HorizonApi.TransactionFailedResultCodes

enum TransactionFailedResultCodes

Source: src/horizon/horizon_api.ts:662

Horizon.HorizonApi.TransactionPreconditions

interface TransactionPreconditions {
extra_signers?: string[];
ledgerbounds?: { max_ledger: number; min_ledger: number };
min_account_sequence?: string;
min_account_sequence_age?: string;
min_account_sequence_ledger_gap?: number;
timebounds?: { max_time: string; min_time: string };
}

Source: src/horizon/horizon_api.ts:40

transactionPreconditions.extra_signers

extra_signers?: string[];

Source: src/horizon/horizon_api.ts:52

transactionPreconditions.ledgerbounds

ledgerbounds?: { max_ledger: number; min_ledger: number };

Source: src/horizon/horizon_api.ts:45

transactionPreconditions.min_account_sequence

min_account_sequence?: string;

Source: src/horizon/horizon_api.ts:49

transactionPreconditions.min_account_sequence_age

min_account_sequence_age?: string;

Source: src/horizon/horizon_api.ts:50

transactionPreconditions.min_account_sequence_ledger_gap

min_account_sequence_ledger_gap?: number;

Source: src/horizon/horizon_api.ts:51

transactionPreconditions.timebounds

timebounds?: { max_time: string; min_time: string };

Source: src/horizon/horizon_api.ts:41

Horizon.HorizonApi.TransactionResponse

interface TransactionResponse extends SubmitTransactionResponse, BaseResponse<"account" | "ledger" | "operations" | "effects" | "succeeds" | "precedes"> {
_links: { account: ResponseLink; effects: ResponseLink; ledger: ResponseLink; operations: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink };
created_at: string;
envelope_xdr: string;
fee_account: string;
fee_bump_transaction?: FeeBumpTransactionResponse;
fee_charged: string | number;
fee_meta_xdr: string;
hash: string;
id: string;
inner_transaction?: InnerTransactionResponse;
ledger: number;
max_fee: string | number;
memo?: string;
memo_bytes?: string;
memo_type: MemoType;
operation_count: number;
paging_token: string;
preconditions?: TransactionPreconditions;
result_meta_xdr: string;
result_xdr: string;
signatures: string[];
source_account: string;
source_account_sequence: string;
successful: boolean;
}

Source: src/horizon/horizon_api.ts:55

_links: { account: ResponseLink; effects: ResponseLink; ledger: ResponseLink; operations: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink };

Source: src/horizon/horizon_api.ts:10

transactionResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:66

transactionResponse.envelope_xdr

envelope_xdr: string;

Source: src/horizon/horizon_api.ts:17

transactionResponse.fee_account

fee_account: string;

Source: src/horizon/horizon_api.ts:79

transactionResponse.fee_bump_transaction

fee_bump_transaction?: FeeBumpTransactionResponse;

Source: src/horizon/horizon_api.ts:81

transactionResponse.fee_charged

fee_charged: string | number;

Source: src/horizon/horizon_api.ts:68

transactionResponse.fee_meta_xdr

fee_meta_xdr: string;

Source: src/horizon/horizon_api.ts:67

transactionResponse.hash

hash: string;

Source: src/horizon/horizon_api.ts:14

transactionResponse.id

id: string;

Source: src/horizon/horizon_api.ts:70

transactionResponse.inner_transaction

inner_transaction?: InnerTransactionResponse;

Source: src/horizon/horizon_api.ts:80

transactionResponse.ledger

ledger: number;

Source: src/horizon/horizon_api.ts:15

transactionResponse.max_fee

max_fee: string | number;

Source: src/horizon/horizon_api.ts:69

transactionResponse.memo

memo?: string;

Source: src/horizon/horizon_api.ts:72

transactionResponse.memo_bytes

memo_bytes?: string;

Source: src/horizon/horizon_api.ts:73

transactionResponse.memo_type

memo_type: MemoType;

Source: src/horizon/horizon_api.ts:71

transactionResponse.operation_count

operation_count: number;

Source: src/horizon/horizon_api.ts:74

transactionResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:75

transactionResponse.preconditions

preconditions?: TransactionPreconditions;

Source: src/horizon/horizon_api.ts:82

transactionResponse.result_meta_xdr

result_meta_xdr: string;

Source: src/horizon/horizon_api.ts:19

transactionResponse.result_xdr

result_xdr: string;

Source: src/horizon/horizon_api.ts:18

transactionResponse.signatures

signatures: string[];

Source: src/horizon/horizon_api.ts:76

transactionResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:77

transactionResponse.source_account_sequence

source_account_sequence: string;

Source: src/horizon/horizon_api.ts:78

transactionResponse.successful

successful: boolean;

Source: src/horizon/horizon_api.ts:16

Horizon.HorizonApi.TransactionResponseCollection

interface TransactionResponseCollection extends ResponseCollection<TransactionResponse> {
_embedded: { records: TransactionResponse[] };
_links: { next: ResponseLink; prev: ResponseLink; self: ResponseLink };
}

Source: src/horizon/horizon_api.ts:607

transactionResponseCollection._embedded

_embedded: { records: TransactionResponse[] };

Source: src/horizon/horizon_api.ts:602

_links: { next: ResponseLink; prev: ResponseLink; self: ResponseLink };

Source: src/horizon/horizon_api.ts:597

Horizon.HorizonApi.WithdrawLiquidityOperationResponse

interface WithdrawLiquidityOperationResponse extends BaseOperationResponse<OperationResponseType.liquidityPoolWithdraw, OperationResponseTypeI.liquidityPoolWithdraw> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
id: string;
liquidity_pool_id: string;
paging_token: string;
reserves_min: Reserve[];
reserves_received: Reserve[];
shares: string;
source_account: string;
transaction_hash: string;
transaction_successful: boolean;
type: liquidityPoolWithdraw;
type_i: liquidityPoolWithdraw;
}

Source: src/horizon/horizon_api.ts:547

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

withdrawLiquidityOperationResponse.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

withdrawLiquidityOperationResponse.id

id: string;

Source: src/horizon/horizon_api.ts:263

withdrawLiquidityOperationResponse.liquidity_pool_id

liquidity_pool_id: string;

Source: src/horizon/horizon_api.ts:551

withdrawLiquidityOperationResponse.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

withdrawLiquidityOperationResponse.reserves_min

reserves_min: Reserve[];

Source: src/horizon/horizon_api.ts:552

withdrawLiquidityOperationResponse.reserves_received

reserves_received: Reserve[];

Source: src/horizon/horizon_api.ts:554

withdrawLiquidityOperationResponse.shares

shares: string;

Source: src/horizon/horizon_api.ts:553

withdrawLiquidityOperationResponse.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

withdrawLiquidityOperationResponse.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

withdrawLiquidityOperationResponse.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

withdrawLiquidityOperationResponse.type

type: liquidityPoolWithdraw;

Source: src/horizon/horizon_api.ts:266

withdrawLiquidityOperationResponse.type_i

type_i: liquidityPoolWithdraw;

Source: src/horizon/horizon_api.ts:267

Horizon.Server.Options

Options for configuring connections to Horizon servers.

interface Options {
allowHttp?: boolean;
appName?: string;
appVersion?: string;
authToken?: string;
headers?: Record<string, string>;
}

Source: src/horizon/server.ts:916

options.allowHttp

Allow connecting to http servers, default: false. This must be set to false in production deployments! You can also use Config class to set this globally.

allowHttp?: boolean;

Source: src/horizon/server.ts:918

options.appName

Allow set custom header X-App-Name, default: undefined.

appName?: string;

Source: src/horizon/server.ts:920

options.appVersion

Allow set custom header X-App-Version, default: undefined.

appVersion?: string;

Source: src/horizon/server.ts:922

options.authToken

Allow set custom header X-Auth-Token, default: undefined.

authToken?: string;

Source: src/horizon/server.ts:924

options.headers

headers?: Record<string, string>;

Source: src/horizon/server.ts:925

Horizon.Server.SubmitTransactionOptions

interface SubmitTransactionOptions {
skipMemoRequiredCheck?: boolean;
}

Source: src/horizon/server.ts:933

submitTransactionOptions.skipMemoRequiredCheck

skipMemoRequiredCheck?: boolean;

Source: src/horizon/server.ts:934

Horizon.Server.Timebounds

interface Timebounds {
maxTime: number;
minTime: number;
}

Source: src/horizon/server.ts:928

timebounds.maxTime

maxTime: number;

Source: src/horizon/server.ts:930

timebounds.minTime

minTime: number;

Source: src/horizon/server.ts:929

Horizon.ServerApi.AccountMergeOperationRecord

interface AccountMergeOperationRecord extends BaseOperationRecord<OperationResponseType.accountMerge, OperationResponseTypeI.accountMerge>, AccountMergeOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
into: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: accountMerge;
type_i: accountMerge;
}

Source: src/horizon/server_api.ts:249

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

accountMergeOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

accountMergeOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

accountMergeOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

accountMergeOperationRecord.into

into: string;

Source: src/horizon/horizon_api.ts:420

accountMergeOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

accountMergeOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

accountMergeOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

accountMergeOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

accountMergeOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

accountMergeOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

accountMergeOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

accountMergeOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

accountMergeOperationRecord.type

type: accountMerge;

Source: src/horizon/horizon_api.ts:266

accountMergeOperationRecord.type_i

type_i: accountMerge;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.AccountRecord

interface AccountRecord extends BaseResponse {
_links: { self: ResponseLink };
account_id: string;
balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];
data: (options: { value: string }) => Promise<{ value: string }>;
data_attr: { [key: string]: string };
effects: CallCollectionFunction<EffectRecord>;
flags: Flags;
home_domain?: string;
id: string;
inflation_destination?: string;
last_modified_ledger: number;
last_modified_time: string;
num_sponsored: number;
num_sponsoring: number;
offers: CallCollectionFunction<OfferRecord>;
operations: CallCollectionFunction<OperationRecord>;
paging_token: string;
payments: CallCollectionFunction<PaymentOperationRecord>;
sequence: string;
sequence_ledger?: number;
sequence_time?: string;
signers: AccountRecordSigners[];
sponsor?: string;
subentry_count: number;
thresholds: AccountThresholds;
trades: CallCollectionFunction<TradeRecord>;
transactions: CallCollectionFunction<TransactionRecord>;
}

Source: src/horizon/server_api.ts:96

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

accountRecord.account_id

account_id: string;

Source: src/horizon/server_api.ts:99

accountRecord.balances

balances: (BalanceLineNative | BalanceLineLiquidityPool | BalanceLineAsset<"credit_alphanum4"> | BalanceLineAsset<"credit_alphanum12">)[];

Source: src/horizon/server_api.ts:110

accountRecord.data

data: (options: { value: string }) => Promise<{ value: string }>;

Parameters

  • options{ value: string } (required)

Source: src/horizon/server_api.ts:112

accountRecord.data_attr

data_attr: { [key: string]: string };

Source: src/horizon/server_api.ts:113

accountRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:120

accountRecord.flags

flags: Flags;

Source: src/horizon/server_api.ts:109

accountRecord.home_domain

home_domain?: string;

Source: src/horizon/server_api.ts:104

accountRecord.id

id: string;

Source: src/horizon/server_api.ts:97

accountRecord.inflation_destination

inflation_destination?: string;

Source: src/horizon/server_api.ts:105

accountRecord.last_modified_ledger

last_modified_ledger: number;

Source: src/horizon/server_api.ts:106

accountRecord.last_modified_time

last_modified_time: string;

Source: src/horizon/server_api.ts:107

accountRecord.num_sponsored

num_sponsored: number;

Source: src/horizon/server_api.ts:118

accountRecord.num_sponsoring

num_sponsoring: number;

Source: src/horizon/server_api.ts:117

accountRecord.offers

offers: CallCollectionFunction<OfferRecord>;

Source: src/horizon/server_api.ts:121

accountRecord.operations

operations: CallCollectionFunction<OperationRecord>;

Source: src/horizon/server_api.ts:122

accountRecord.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:98

accountRecord.payments

payments: CallCollectionFunction<PaymentOperationRecord>;

Source: src/horizon/server_api.ts:123

accountRecord.sequence

sequence: string;

Source: src/horizon/server_api.ts:100

accountRecord.sequence_ledger

sequence_ledger?: number;

Source: src/horizon/server_api.ts:101

accountRecord.sequence_time

sequence_time?: string;

Source: src/horizon/server_api.ts:102

accountRecord.signers

signers: AccountRecordSigners[];

Source: src/horizon/server_api.ts:111

accountRecord.sponsor

sponsor?: string;

Source: src/horizon/server_api.ts:116

accountRecord.subentry_count

subentry_count: number;

Source: src/horizon/server_api.ts:103

accountRecord.thresholds

thresholds: AccountThresholds;

Source: src/horizon/server_api.ts:108

accountRecord.trades

trades: CallCollectionFunction<TradeRecord>;

Source: src/horizon/server_api.ts:124

accountRecord.transactions

transactions: CallCollectionFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:119

Horizon.ServerApi.AccountRecordSigners

type AccountRecordSigners = AccountRecordSignersType

Source: src/horizon/server_api.ts:14

Horizon.ServerApi.AllowTrustOperationRecord

interface AllowTrustOperationRecord extends BaseOperationRecord<OperationResponseType.allowTrust, OperationResponseTypeI.allowTrust>, AllowTrustOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
authorize: boolean;
authorize_to_maintain_liabilities: boolean;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
trustee: string;
trustor: string;
type: allowTrust;
type_i: allowTrust;
}

Source: src/horizon/server_api.ts:242

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

allowTrustOperationRecord.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:409

allowTrustOperationRecord.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:410

allowTrustOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:408

allowTrustOperationRecord.authorize

authorize: boolean;

Source: src/horizon/horizon_api.ts:411

allowTrustOperationRecord.authorize_to_maintain_liabilities

authorize_to_maintain_liabilities: boolean;

Source: src/horizon/horizon_api.ts:412

allowTrustOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

allowTrustOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

allowTrustOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

allowTrustOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

allowTrustOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

allowTrustOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

allowTrustOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

allowTrustOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

allowTrustOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

allowTrustOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

allowTrustOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

allowTrustOperationRecord.trustee

trustee: string;

Source: src/horizon/horizon_api.ts:413

allowTrustOperationRecord.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:414

allowTrustOperationRecord.type

type: allowTrust;

Source: src/horizon/horizon_api.ts:266

allowTrustOperationRecord.type_i

type_i: allowTrust;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.AssetRecord

type AssetRecord = AssetRecordType

Source: src/horizon/server_api.ts:15

Horizon.ServerApi.BaseOperationRecord

interface BaseOperationRecord<T extends OperationResponseType = OperationResponseType, TI extends OperationResponseTypeI = OperationResponseTypeI> extends BaseOperationResponse<T, TI> {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: T;
type_i: TI;
}

Source: src/horizon/server_api.ts:173

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

baseOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

baseOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

baseOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

baseOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

baseOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

baseOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

baseOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

baseOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

baseOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

baseOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

baseOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

baseOperationRecord.type

type: T;

Source: src/horizon/horizon_api.ts:266

baseOperationRecord.type_i

type_i: TI;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.BeginSponsoringFutureReservesOperationRecord

interface BeginSponsoringFutureReservesOperationRecord extends BaseOperationRecord<OperationResponseType.beginSponsoringFutureReserves, OperationResponseTypeI.beginSponsoringFutureReserves>, BeginSponsoringFutureReservesOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
sponsored_id: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: beginSponsoringFutureReserves;
type_i: beginSponsoringFutureReserves;
}

Source: src/horizon/server_api.ts:291

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

beginSponsoringFutureReservesOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

beginSponsoringFutureReservesOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

beginSponsoringFutureReservesOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

beginSponsoringFutureReservesOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

beginSponsoringFutureReservesOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

beginSponsoringFutureReservesOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

beginSponsoringFutureReservesOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

beginSponsoringFutureReservesOperationRecord.sponsored_id

sponsored_id: string;

Source: src/horizon/horizon_api.ts:475

beginSponsoringFutureReservesOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

beginSponsoringFutureReservesOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

beginSponsoringFutureReservesOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

beginSponsoringFutureReservesOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

beginSponsoringFutureReservesOperationRecord.type

type: beginSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:266

beginSponsoringFutureReservesOperationRecord.type_i

type_i: beginSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.BumpFootprintExpirationOperationRecord

interface BumpFootprintExpirationOperationRecord extends BaseOperationRecord<OperationResponseType.bumpFootprintExpiration, OperationResponseTypeI.bumpFootprintExpiration>, BumpFootprintExpirationOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
ledgers_to_expire: number;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: bumpFootprintExpiration;
type_i: bumpFootprintExpiration;
}

Source: src/horizon/server_api.ts:354

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

bumpFootprintExpirationOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

bumpFootprintExpirationOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

bumpFootprintExpirationOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

bumpFootprintExpirationOperationRecord.ledgers_to_expire

ledgers_to_expire: number;

Source: src/horizon/horizon_api.ts:587

bumpFootprintExpirationOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

bumpFootprintExpirationOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

bumpFootprintExpirationOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

bumpFootprintExpirationOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

bumpFootprintExpirationOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

bumpFootprintExpirationOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

bumpFootprintExpirationOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

bumpFootprintExpirationOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

bumpFootprintExpirationOperationRecord.type

type: bumpFootprintExpiration;

Source: src/horizon/horizon_api.ts:266

bumpFootprintExpirationOperationRecord.type_i

type_i: bumpFootprintExpiration;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.BumpSequenceOperationRecord

interface BumpSequenceOperationRecord extends BaseOperationRecord<OperationResponseType.bumpSequence, OperationResponseTypeI.bumpSequence>, BumpSequenceOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
bump_to: string;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: bumpSequence;
type_i: bumpSequence;
}

Source: src/horizon/server_api.ts:270

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

bumpSequenceOperationRecord.bump_to

bump_to: string;

Source: src/horizon/horizon_api.ts:438

bumpSequenceOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

bumpSequenceOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

bumpSequenceOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

bumpSequenceOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

bumpSequenceOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

bumpSequenceOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

bumpSequenceOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

bumpSequenceOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

bumpSequenceOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

bumpSequenceOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

bumpSequenceOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

bumpSequenceOperationRecord.type

type: bumpSequence;

Source: src/horizon/horizon_api.ts:266

bumpSequenceOperationRecord.type_i

type_i: bumpSequence;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.CallCollectionFunction

type CallCollectionFunction<T extends HorizonApi.BaseResponse = HorizonApi.BaseResponse> = (options?: CallFunctionTemplateOptions) => Promise<CollectionPage<T>>

Source: src/horizon/server_api.ts:33

Horizon.ServerApi.CallFunction

type CallFunction<T extends HorizonApi.BaseResponse = HorizonApi.BaseResponse> = () => Promise<T>

Source: src/horizon/server_api.ts:30

Horizon.ServerApi.CallFunctionTemplateOptions

interface CallFunctionTemplateOptions {
cursor?: string | number;
limit?: number;
order?: "desc" | "asc";
}

Source: src/horizon/server_api.ts:24

callFunctionTemplateOptions.cursor

cursor?: string | number;

Source: src/horizon/server_api.ts:25

callFunctionTemplateOptions.limit

limit?: number;

Source: src/horizon/server_api.ts:26

callFunctionTemplateOptions.order

order?: "desc" | "asc";

Source: src/horizon/server_api.ts:27

Horizon.ServerApi.ChangeTrustOperationRecord

interface ChangeTrustOperationRecord extends BaseOperationRecord<OperationResponseType.changeTrust, OperationResponseTypeI.changeTrust>, ChangeTrustOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code?: string;
asset_issuer?: string;
asset_type: "credit_alphanum4" | "credit_alphanum12" | "liquidity_pool_shares";
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
limit: string;
liquidity_pool_id?: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
trustee?: string;
trustor: string;
type: changeTrust;
type_i: changeTrust;
}

Source: src/horizon/server_api.ts:235

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

changeTrustOperationRecord.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:397

changeTrustOperationRecord.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:398

changeTrustOperationRecord.asset_type

asset_type: "credit_alphanum4" | "credit_alphanum12" | "liquidity_pool_shares";

Source: src/horizon/horizon_api.ts:393

changeTrustOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

changeTrustOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

changeTrustOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

changeTrustOperationRecord.limit

limit: string;

Source: src/horizon/horizon_api.ts:402

changeTrustOperationRecord.liquidity_pool_id

liquidity_pool_id?: string;

Source: src/horizon/horizon_api.ts:399

changeTrustOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

changeTrustOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

changeTrustOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

changeTrustOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

changeTrustOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

changeTrustOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

changeTrustOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

changeTrustOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

changeTrustOperationRecord.trustee

trustee?: string;

Source: src/horizon/horizon_api.ts:400

changeTrustOperationRecord.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:401

changeTrustOperationRecord.type

type: changeTrust;

Source: src/horizon/horizon_api.ts:266

changeTrustOperationRecord.type_i

type_i: changeTrust;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.ClaimClaimableBalanceOperationRecord

interface ClaimClaimableBalanceOperationRecord extends BaseOperationRecord<OperationResponseType.claimClaimableBalance, OperationResponseTypeI.claimClaimableBalance>, ClaimClaimableBalanceOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
balance_id: string;
claimant: string;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: claimClaimableBalance;
type_i: claimClaimableBalance;
}

Source: src/horizon/server_api.ts:284

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

claimClaimableBalanceOperationRecord.balance_id

balance_id: string;

Source: src/horizon/horizon_api.ts:467

claimClaimableBalanceOperationRecord.claimant

claimant: string;

Source: src/horizon/horizon_api.ts:468

claimClaimableBalanceOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

claimClaimableBalanceOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

claimClaimableBalanceOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

claimClaimableBalanceOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

claimClaimableBalanceOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

claimClaimableBalanceOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

claimClaimableBalanceOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

claimClaimableBalanceOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

claimClaimableBalanceOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

claimClaimableBalanceOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

claimClaimableBalanceOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

claimClaimableBalanceOperationRecord.type

type: claimClaimableBalance;

Source: src/horizon/horizon_api.ts:266

claimClaimableBalanceOperationRecord.type_i

type_i: claimClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.ClaimableBalanceRecord

interface ClaimableBalanceRecord extends BaseResponse {
_links: { self: ResponseLink };
amount: string;
asset: string;
claimants: Claimant[];
id: string;
last_modified_ledger: number;
paging_token: string;
sponsor?: string;
}

Source: src/horizon/server_api.ts:87

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

claimableBalanceRecord.amount

amount: string;

Source: src/horizon/server_api.ts:91

claimableBalanceRecord.asset

asset: string;

Source: src/horizon/server_api.ts:90

claimableBalanceRecord.claimants

claimants: Claimant[];

Source: src/horizon/server_api.ts:94

claimableBalanceRecord.id

id: string;

Source: src/horizon/server_api.ts:88

claimableBalanceRecord.last_modified_ledger

last_modified_ledger: number;

Source: src/horizon/server_api.ts:93

claimableBalanceRecord.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:89

claimableBalanceRecord.sponsor

sponsor?: string;

Source: src/horizon/server_api.ts:92

Horizon.ServerApi.ClawbackClaimableBalanceOperationRecord

interface ClawbackClaimableBalanceOperationRecord extends BaseOperationRecord<OperationResponseType.clawbackClaimableBalance, OperationResponseTypeI.clawbackClaimableBalance>, ClawbackClaimableBalanceOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
balance_id: string;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: clawbackClaimableBalance;
type_i: clawbackClaimableBalance;
}

Source: src/horizon/server_api.ts:319

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

clawbackClaimableBalanceOperationRecord.balance_id

balance_id: string;

Source: src/horizon/horizon_api.ts:516

clawbackClaimableBalanceOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

clawbackClaimableBalanceOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

clawbackClaimableBalanceOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

clawbackClaimableBalanceOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

clawbackClaimableBalanceOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

clawbackClaimableBalanceOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

clawbackClaimableBalanceOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

clawbackClaimableBalanceOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

clawbackClaimableBalanceOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

clawbackClaimableBalanceOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

clawbackClaimableBalanceOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

clawbackClaimableBalanceOperationRecord.type

type: clawbackClaimableBalance;

Source: src/horizon/horizon_api.ts:266

clawbackClaimableBalanceOperationRecord.type_i

type_i: clawbackClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.ClawbackOperationRecord

interface ClawbackOperationRecord extends BaseOperationRecord<OperationResponseType.clawback, OperationResponseTypeI.clawback>, ClawbackOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
from: string;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: clawback;
type_i: clawback;
}

Source: src/horizon/server_api.ts:312

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

clawbackOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:509

clawbackOperationRecord.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:506

clawbackOperationRecord.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:507

clawbackOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:505

clawbackOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

clawbackOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

clawbackOperationRecord.from

from: string;

Source: src/horizon/horizon_api.ts:508

clawbackOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

clawbackOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

clawbackOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

clawbackOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

clawbackOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

clawbackOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

clawbackOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

clawbackOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

clawbackOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

clawbackOperationRecord.type

type: clawback;

Source: src/horizon/horizon_api.ts:266

clawbackOperationRecord.type_i

type_i: clawback;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.CollectionPage

interface CollectionPage<T extends HorizonApi.BaseResponse = HorizonApi.BaseResponse> {
next: () => Promise<CollectionPage<T>>;
prev: () => Promise<CollectionPage<T>>;
records: T[];
}

Source: src/horizon/server_api.ts:16

collectionPage.next

next: () => Promise<CollectionPage<T>>;

Source: src/horizon/server_api.ts:20

collectionPage.prev

prev: () => Promise<CollectionPage<T>>;

Source: src/horizon/server_api.ts:21

collectionPage.records

records: T[];

Source: src/horizon/server_api.ts:19

Horizon.ServerApi.CreateAccountOperationRecord

interface CreateAccountOperationRecord extends BaseOperationRecord<OperationResponseType.createAccount, OperationResponseTypeI.createAccount>, CreateAccountOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
account: string;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
funder: string;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
starting_balance: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: createAccount;
type_i: createAccount;
}

Source: src/horizon/server_api.ts:183

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

createAccountOperationRecord.account

account: string;

Source: src/horizon/horizon_api.ts:276

createAccountOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

createAccountOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

createAccountOperationRecord.funder

funder: string;

Source: src/horizon/horizon_api.ts:277

createAccountOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

createAccountOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

createAccountOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

createAccountOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

createAccountOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

createAccountOperationRecord.starting_balance

starting_balance: string;

Source: src/horizon/horizon_api.ts:278

createAccountOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

createAccountOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

createAccountOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

createAccountOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

createAccountOperationRecord.type

type: createAccount;

Source: src/horizon/horizon_api.ts:266

createAccountOperationRecord.type_i

type_i: createAccount;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.CreateClaimableBalanceOperationRecord

interface CreateClaimableBalanceOperationRecord extends BaseOperationRecord<OperationResponseType.createClaimableBalance, OperationResponseTypeI.createClaimableBalance>, CreateClaimableBalanceOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset: string;
claimants: Claimant[];
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
sponsor: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: createClaimableBalance;
type_i: createClaimableBalance;
}

Source: src/horizon/server_api.ts:277

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

createClaimableBalanceOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:458

createClaimableBalanceOperationRecord.asset

asset: string;

Source: src/horizon/horizon_api.ts:457

createClaimableBalanceOperationRecord.claimants

claimants: Claimant[];

Source: src/horizon/horizon_api.ts:460

createClaimableBalanceOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

createClaimableBalanceOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

createClaimableBalanceOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

createClaimableBalanceOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

createClaimableBalanceOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

createClaimableBalanceOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

createClaimableBalanceOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

createClaimableBalanceOperationRecord.sponsor

sponsor: string;

Source: src/horizon/horizon_api.ts:459

createClaimableBalanceOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

createClaimableBalanceOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

createClaimableBalanceOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

createClaimableBalanceOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

createClaimableBalanceOperationRecord.type

type: createClaimableBalance;

Source: src/horizon/horizon_api.ts:266

createClaimableBalanceOperationRecord.type_i

type_i: createClaimableBalance;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.DepositLiquidityOperationRecord

interface DepositLiquidityOperationRecord extends BaseOperationRecord<OperationResponseType.liquidityPoolDeposit, OperationResponseTypeI.liquidityPoolDeposit>, DepositLiquidityOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
liquidity_pool_id: string;
max_price: string;
max_price_r: PriceRShorthand;
min_price: string;
min_price_r: PriceRShorthand;
paging_token: string;
precedes: CallFunction<OperationRecord>;
reserves_deposited: Reserve[];
reserves_max: Reserve[];
self: CallFunction<OperationRecord>;
shares_received: string;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: liquidityPoolDeposit;
type_i: liquidityPoolDeposit;
}

Source: src/horizon/server_api.ts:333

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

depositLiquidityOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

depositLiquidityOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

depositLiquidityOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

depositLiquidityOperationRecord.liquidity_pool_id

liquidity_pool_id: string;

Source: src/horizon/horizon_api.ts:538

depositLiquidityOperationRecord.max_price

max_price: string;

Source: src/horizon/horizon_api.ts:542

depositLiquidityOperationRecord.max_price_r

max_price_r: PriceRShorthand;

Source: src/horizon/horizon_api.ts:543

depositLiquidityOperationRecord.min_price

min_price: string;

Source: src/horizon/horizon_api.ts:540

depositLiquidityOperationRecord.min_price_r

min_price_r: PriceRShorthand;

Source: src/horizon/horizon_api.ts:541

depositLiquidityOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

depositLiquidityOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

depositLiquidityOperationRecord.reserves_deposited

reserves_deposited: Reserve[];

Source: src/horizon/horizon_api.ts:544

depositLiquidityOperationRecord.reserves_max

reserves_max: Reserve[];

Source: src/horizon/horizon_api.ts:539

depositLiquidityOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

depositLiquidityOperationRecord.shares_received

shares_received: string;

Source: src/horizon/horizon_api.ts:545

depositLiquidityOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

depositLiquidityOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

depositLiquidityOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

depositLiquidityOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

depositLiquidityOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

depositLiquidityOperationRecord.type

type: liquidityPoolDeposit;

Source: src/horizon/horizon_api.ts:266

depositLiquidityOperationRecord.type_i

type_i: liquidityPoolDeposit;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.EffectRecord

type EffectRecord = BaseEffectRecordFromTypes & EffectRecordMethods

Source: src/horizon/server_api.ts:85

Horizon.ServerApi.EndSponsoringFutureReservesOperationRecord

interface EndSponsoringFutureReservesOperationRecord extends BaseOperationRecord<OperationResponseType.endSponsoringFutureReserves, OperationResponseTypeI.endSponsoringFutureReserves>, EndSponsoringFutureReservesOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
begin_sponsor: string;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: endSponsoringFutureReserves;
type_i: endSponsoringFutureReserves;
}

Source: src/horizon/server_api.ts:298

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

endSponsoringFutureReservesOperationRecord.begin_sponsor

begin_sponsor: string;

Source: src/horizon/horizon_api.ts:482

endSponsoringFutureReservesOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

endSponsoringFutureReservesOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

endSponsoringFutureReservesOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

endSponsoringFutureReservesOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

endSponsoringFutureReservesOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

endSponsoringFutureReservesOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

endSponsoringFutureReservesOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

endSponsoringFutureReservesOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

endSponsoringFutureReservesOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

endSponsoringFutureReservesOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

endSponsoringFutureReservesOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

endSponsoringFutureReservesOperationRecord.type

type: endSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:266

endSponsoringFutureReservesOperationRecord.type_i

type_i: endSponsoringFutureReserves;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.InflationOperationRecord

interface InflationOperationRecord extends BaseOperationRecord<OperationResponseType.inflation, OperationResponseTypeI.inflation>, InflationOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: inflation;
type_i: inflation;
}

Source: src/horizon/server_api.ts:256

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

inflationOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

inflationOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

inflationOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

inflationOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

inflationOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

inflationOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

inflationOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

inflationOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

inflationOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

inflationOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

inflationOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

inflationOperationRecord.type

type: inflation;

Source: src/horizon/horizon_api.ts:266

inflationOperationRecord.type_i

type_i: inflation;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.InvokeHostFunctionOperationRecord

interface InvokeHostFunctionOperationRecord extends BaseOperationRecord<OperationResponseType.invokeHostFunction, OperationResponseTypeI.invokeHostFunction>, InvokeHostFunctionOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
address: string;
asset_balance_changes: BalanceChange[];
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
function: string;
id: string;
paging_token: string;
parameters: { type: string; value: string }[];
precedes: CallFunction<OperationRecord>;
salt: string;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: invokeHostFunction;
type_i: invokeHostFunction;
}

Source: src/horizon/server_api.ts:347

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

invokeHostFunctionOperationRecord.address

address: string;

Source: src/horizon/horizon_api.ts:578

invokeHostFunctionOperationRecord.asset_balance_changes

asset_balance_changes: BalanceChange[];

Source: src/horizon/horizon_api.ts:580

invokeHostFunctionOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

invokeHostFunctionOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

invokeHostFunctionOperationRecord.function

function: string;

Source: src/horizon/horizon_api.ts:573

invokeHostFunctionOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

invokeHostFunctionOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

invokeHostFunctionOperationRecord.parameters

parameters: { type: string; value: string }[];

Source: src/horizon/horizon_api.ts:574

invokeHostFunctionOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

invokeHostFunctionOperationRecord.salt

salt: string;

Source: src/horizon/horizon_api.ts:579

invokeHostFunctionOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

invokeHostFunctionOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

invokeHostFunctionOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

invokeHostFunctionOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

invokeHostFunctionOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

invokeHostFunctionOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

invokeHostFunctionOperationRecord.type

type: invokeHostFunction;

Source: src/horizon/horizon_api.ts:266

invokeHostFunctionOperationRecord.type_i

type_i: invokeHostFunction;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.LedgerRecord

interface LedgerRecord extends BaseResponse {
_links: { self: ResponseLink };
base_fee_in_stroops: number;
base_reserve_in_stroops: number;
closed_at: string;
effects: CallCollectionFunction<EffectRecord>;
failed_transaction_count: number;
fee_pool: string;
hash: string;
header_xdr: string;
id: string;
max_tx_set_size: number;
operation_count: number;
operations: CallCollectionFunction<OperationRecord>;
paging_token: string;
prev_hash: string;
protocol_version: number;
self: CallFunction<LedgerRecord>;
sequence: number;
successful_transaction_count: number;
total_coins: string;
transactions: CallCollectionFunction<TransactionRecord>;
tx_set_operation_count: number | null;
}

Source: src/horizon/server_api.ts:145

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

ledgerRecord.base_fee_in_stroops

base_fee_in_stroops: number;

Source: src/horizon/server_api.ts:161

ledgerRecord.base_reserve_in_stroops

base_reserve_in_stroops: number;

Source: src/horizon/server_api.ts:162

ledgerRecord.closed_at

closed_at: string;

Source: src/horizon/server_api.ts:155

ledgerRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:164

ledgerRecord.failed_transaction_count

failed_transaction_count: number;

Source: src/horizon/server_api.ts:152

ledgerRecord.fee_pool

fee_pool: string;

Source: src/horizon/server_api.ts:157

ledgerRecord.hash

hash: string;

Source: src/horizon/server_api.ts:148

ledgerRecord.header_xdr

header_xdr: string;

Source: src/horizon/server_api.ts:160

ledgerRecord.id

id: string;

Source: src/horizon/server_api.ts:146

ledgerRecord.max_tx_set_size

max_tx_set_size: number;

Source: src/horizon/server_api.ts:158

ledgerRecord.operation_count

operation_count: number;

Source: src/horizon/server_api.ts:153

ledgerRecord.operations

operations: CallCollectionFunction<OperationRecord>;

Source: src/horizon/server_api.ts:165

ledgerRecord.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:147

ledgerRecord.prev_hash

prev_hash: string;

Source: src/horizon/server_api.ts:149

ledgerRecord.protocol_version

protocol_version: number;

Source: src/horizon/server_api.ts:159

ledgerRecord.self

self: CallFunction<LedgerRecord>;

Source: src/horizon/server_api.ts:166

ledgerRecord.sequence

sequence: number;

Source: src/horizon/server_api.ts:150

ledgerRecord.successful_transaction_count

successful_transaction_count: number;

Source: src/horizon/server_api.ts:151

ledgerRecord.total_coins

total_coins: string;

Source: src/horizon/server_api.ts:156

ledgerRecord.transactions

transactions: CallCollectionFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:167

ledgerRecord.tx_set_operation_count

tx_set_operation_count: number | null;

Source: src/horizon/server_api.ts:154

Horizon.ServerApi.LiquidityPoolRecord

interface LiquidityPoolRecord extends BaseResponse {
_links: { self: ResponseLink };
fee_bp: number;
id: string;
paging_token: string;
reserves: Reserve[];
total_shares: string;
total_trustlines: string;
type: LiquidityPoolType;
}

Source: src/horizon/server_api.ts:126

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

liquidityPoolRecord.fee_bp

fee_bp: number;

Source: src/horizon/server_api.ts:129

liquidityPoolRecord.id

id: string;

Source: src/horizon/server_api.ts:127

liquidityPoolRecord.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:128

liquidityPoolRecord.reserves

reserves: Reserve[];

Source: src/horizon/server_api.ts:133

liquidityPoolRecord.total_shares

total_shares: string;

Source: src/horizon/server_api.ts:132

liquidityPoolRecord.total_trustlines

total_trustlines: string;

Source: src/horizon/server_api.ts:131

liquidityPoolRecord.type

type: LiquidityPoolType;

Source: src/horizon/server_api.ts:130

Horizon.ServerApi.ManageDataOperationRecord

interface ManageDataOperationRecord extends BaseOperationRecord<OperationResponseType.manageData, OperationResponseTypeI.manageData>, ManageDataOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
name: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: manageData;
type_i: manageData;
value: Buffer;
}

Source: src/horizon/server_api.ts:263

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

manageDataOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

manageDataOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

manageDataOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

manageDataOperationRecord.name

name: string;

Source: src/horizon/horizon_api.ts:431

manageDataOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

manageDataOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

manageDataOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

manageDataOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

manageDataOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

manageDataOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

manageDataOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

manageDataOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

manageDataOperationRecord.type

type: manageData;

Source: src/horizon/horizon_api.ts:266

manageDataOperationRecord.type_i

type_i: manageData;

Source: src/horizon/horizon_api.ts:267

manageDataOperationRecord.value

value: Buffer;

Source: src/horizon/horizon_api.ts:432

Horizon.ServerApi.ManageOfferOperationRecord

interface ManageOfferOperationRecord extends BaseOperationRecord<OperationResponseType.manageOffer, OperationResponseTypeI.manageOffer>, ManageOfferOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
buying_asset_code?: string;
buying_asset_issuer?: string;
buying_asset_type: AssetType;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
offer_id: string | number;
paging_token: string;
precedes: CallFunction<OperationRecord>;
price: string;
price_r: PriceR;
self: CallFunction<OperationRecord>;
selling_asset_code?: string;
selling_asset_issuer?: string;
selling_asset_type: AssetType;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: manageOffer;
type_i: manageOffer;
}

Source: src/horizon/server_api.ts:214

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

manageOfferOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:340

manageOfferOperationRecord.buying_asset_code

buying_asset_code?: string;

Source: src/horizon/horizon_api.ts:342

manageOfferOperationRecord.buying_asset_issuer

buying_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:343

manageOfferOperationRecord.buying_asset_type

buying_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:341

manageOfferOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

manageOfferOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

manageOfferOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

manageOfferOperationRecord.offer_id

offer_id: string | number;

Source: src/horizon/horizon_api.ts:339

manageOfferOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

manageOfferOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

manageOfferOperationRecord.price

price: string;

Source: src/horizon/horizon_api.ts:344

manageOfferOperationRecord.price_r

price_r: PriceR;

Source: src/horizon/horizon_api.ts:345

manageOfferOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

manageOfferOperationRecord.selling_asset_code

selling_asset_code?: string;

Source: src/horizon/horizon_api.ts:347

manageOfferOperationRecord.selling_asset_issuer

selling_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:348

manageOfferOperationRecord.selling_asset_type

selling_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:346

manageOfferOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

manageOfferOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

manageOfferOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

manageOfferOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

manageOfferOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

manageOfferOperationRecord.type

type: manageOffer;

Source: src/horizon/horizon_api.ts:266

manageOfferOperationRecord.type_i

type_i: manageOffer;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.OfferRecord

type OfferRecord = OfferRecordType

Source: src/horizon/server_api.ts:13

Horizon.ServerApi.OperationRecord

type OperationRecord = CreateAccountOperationRecord | PaymentOperationRecord | PathPaymentOperationRecord | ManageOfferOperationRecord | PassiveOfferOperationRecord | SetOptionsOperationRecord | ChangeTrustOperationRecord | AllowTrustOperationRecord | AccountMergeOperationRecord | InflationOperationRecord | ManageDataOperationRecord | BumpSequenceOperationRecord | PathPaymentStrictSendOperationRecord | CreateClaimableBalanceOperationRecord | ClaimClaimableBalanceOperationRecord | BeginSponsoringFutureReservesOperationRecord | EndSponsoringFutureReservesOperationRecord | RevokeSponsorshipOperationRecord | ClawbackClaimableBalanceOperationRecord | ClawbackOperationRecord | SetTrustLineFlagsOperationRecord | DepositLiquidityOperationRecord | WithdrawLiquidityOperationRecord | InvokeHostFunctionOperationRecord | BumpFootprintExpirationOperationRecord | RestoreFootprintOperationRecord

Source: src/horizon/server_api.ts:369

Horizon.ServerApi.OrderbookRecord

interface OrderbookRecord extends BaseResponse {
_links: { self: ResponseLink };
asks: { amount: string; price: string; price_r: { d: number; n: number } }[];
base: Asset;
bids: { amount: string; price: string; price_r: { d: number; n: number } }[];
counter: Asset;
}

Source: src/horizon/server_api.ts:456

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

orderbookRecord.asks

asks: { amount: string; price: string; price_r: { d: number; n: number } }[];

Source: src/horizon/server_api.ts:465

orderbookRecord.base

base: Asset;

Source: src/horizon/server_api.ts:473

orderbookRecord.bids

bids: { amount: string; price: string; price_r: { d: number; n: number } }[];

Source: src/horizon/server_api.ts:457

orderbookRecord.counter

counter: Asset;

Source: src/horizon/server_api.ts:474

Horizon.ServerApi.PassiveOfferOperationRecord

interface PassiveOfferOperationRecord extends BaseOperationRecord<OperationResponseType.createPassiveOffer, OperationResponseTypeI.createPassiveOffer>, PassiveOfferOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
buying_asset_code?: string;
buying_asset_issuer?: string;
buying_asset_type: AssetType;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
offer_id: string | number;
paging_token: string;
precedes: CallFunction<OperationRecord>;
price: string;
price_r: PriceR;
self: CallFunction<OperationRecord>;
selling_asset_code?: string;
selling_asset_issuer?: string;
selling_asset_type: AssetType;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: createPassiveOffer;
type_i: createPassiveOffer;
}

Source: src/horizon/server_api.ts:221

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

passiveOfferOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:355

passiveOfferOperationRecord.buying_asset_code

buying_asset_code?: string;

Source: src/horizon/horizon_api.ts:357

passiveOfferOperationRecord.buying_asset_issuer

buying_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:358

passiveOfferOperationRecord.buying_asset_type

buying_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:356

passiveOfferOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

passiveOfferOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

passiveOfferOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

passiveOfferOperationRecord.offer_id

offer_id: string | number;

Source: src/horizon/horizon_api.ts:354

passiveOfferOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

passiveOfferOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

passiveOfferOperationRecord.price

price: string;

Source: src/horizon/horizon_api.ts:359

passiveOfferOperationRecord.price_r

price_r: PriceR;

Source: src/horizon/horizon_api.ts:360

passiveOfferOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

passiveOfferOperationRecord.selling_asset_code

selling_asset_code?: string;

Source: src/horizon/horizon_api.ts:362

passiveOfferOperationRecord.selling_asset_issuer

selling_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:363

passiveOfferOperationRecord.selling_asset_type

selling_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:361

passiveOfferOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

passiveOfferOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

passiveOfferOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

passiveOfferOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

passiveOfferOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

passiveOfferOperationRecord.type

type: createPassiveOffer;

Source: src/horizon/horizon_api.ts:266

passiveOfferOperationRecord.type_i

type_i: createPassiveOffer;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.PathPaymentOperationRecord

interface PathPaymentOperationRecord extends BaseOperationRecord<OperationResponseType.pathPayment, OperationResponseTypeI.pathPayment>, PathPaymentOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
from: string;
id: string;
paging_token: string;
path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
source_amount: string;
source_asset_code?: string;
source_asset_issuer?: string;
source_asset_type: AssetType;
source_max: string;
succeeds: CallFunction<OperationRecord>;
to: string;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: pathPayment;
type_i: pathPayment;
}

Source: src/horizon/server_api.ts:200

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

pathPaymentOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:297

pathPaymentOperationRecord.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:298

pathPaymentOperationRecord.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:299

pathPaymentOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:300

pathPaymentOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

pathPaymentOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

pathPaymentOperationRecord.from

from: string;

Source: src/horizon/horizon_api.ts:301

pathPaymentOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

pathPaymentOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

pathPaymentOperationRecord.path

path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];

Source: src/horizon/horizon_api.ts:302

pathPaymentOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

pathPaymentOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

pathPaymentOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

pathPaymentOperationRecord.source_amount

source_amount: string;

Source: src/horizon/horizon_api.ts:307

pathPaymentOperationRecord.source_asset_code

source_asset_code?: string;

Source: src/horizon/horizon_api.ts:308

pathPaymentOperationRecord.source_asset_issuer

source_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:309

pathPaymentOperationRecord.source_asset_type

source_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:310

pathPaymentOperationRecord.source_max

source_max: string;

Source: src/horizon/horizon_api.ts:311

pathPaymentOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

pathPaymentOperationRecord.to

to: string;

Source: src/horizon/horizon_api.ts:312

pathPaymentOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

pathPaymentOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

pathPaymentOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

pathPaymentOperationRecord.type

type: pathPayment;

Source: src/horizon/horizon_api.ts:266

pathPaymentOperationRecord.type_i

type_i: pathPayment;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.PathPaymentStrictSendOperationRecord

interface PathPaymentStrictSendOperationRecord extends BaseOperationRecord<OperationResponseType.pathPaymentStrictSend, OperationResponseTypeI.pathPaymentStrictSend>, PathPaymentStrictSendOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
destination_min: string;
effects: CallCollectionFunction<EffectRecord>;
from: string;
id: string;
paging_token: string;
path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
source_amount: string;
source_asset_code?: string;
source_asset_issuer?: string;
source_asset_type: AssetType;
succeeds: CallFunction<OperationRecord>;
to: string;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: pathPaymentStrictSend;
type_i: pathPaymentStrictSend;
}

Source: src/horizon/server_api.ts:207

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

pathPaymentStrictSendOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:318

pathPaymentStrictSendOperationRecord.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:319

pathPaymentStrictSendOperationRecord.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:320

pathPaymentStrictSendOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:321

pathPaymentStrictSendOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

pathPaymentStrictSendOperationRecord.destination_min

destination_min: string;

Source: src/horizon/horizon_api.ts:322

pathPaymentStrictSendOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

pathPaymentStrictSendOperationRecord.from

from: string;

Source: src/horizon/horizon_api.ts:323

pathPaymentStrictSendOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

pathPaymentStrictSendOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

pathPaymentStrictSendOperationRecord.path

path: { asset_code: string; asset_issuer: string; asset_type: AssetType }[];

Source: src/horizon/horizon_api.ts:324

pathPaymentStrictSendOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

pathPaymentStrictSendOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

pathPaymentStrictSendOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

pathPaymentStrictSendOperationRecord.source_amount

source_amount: string;

Source: src/horizon/horizon_api.ts:329

pathPaymentStrictSendOperationRecord.source_asset_code

source_asset_code?: string;

Source: src/horizon/horizon_api.ts:330

pathPaymentStrictSendOperationRecord.source_asset_issuer

source_asset_issuer?: string;

Source: src/horizon/horizon_api.ts:331

pathPaymentStrictSendOperationRecord.source_asset_type

source_asset_type: AssetType;

Source: src/horizon/horizon_api.ts:332

pathPaymentStrictSendOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

pathPaymentStrictSendOperationRecord.to

to: string;

Source: src/horizon/horizon_api.ts:333

pathPaymentStrictSendOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

pathPaymentStrictSendOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

pathPaymentStrictSendOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

pathPaymentStrictSendOperationRecord.type

type: pathPaymentStrictSend;

Source: src/horizon/horizon_api.ts:266

pathPaymentStrictSendOperationRecord.type_i

type_i: pathPaymentStrictSend;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.PaymentOperationRecord

interface PaymentOperationRecord extends BaseOperationRecord<OperationResponseType.payment, OperationResponseTypeI.payment>, PaymentOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
amount: string;
asset_code?: string;
asset_issuer?: string;
asset_type: AssetType;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
from: string;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
receiver: CallFunction<AccountRecord>;
self: CallFunction<OperationRecord>;
sender: CallFunction<AccountRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
to: string;
to_muxed?: string;
to_muxed_id?: string;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: payment;
type_i: payment;
}

Source: src/horizon/server_api.ts:190

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

paymentOperationRecord.amount

amount: string;

Source: src/horizon/horizon_api.ts:289

paymentOperationRecord.asset_code

asset_code?: string;

Source: src/horizon/horizon_api.ts:287

paymentOperationRecord.asset_issuer

asset_issuer?: string;

Source: src/horizon/horizon_api.ts:288

paymentOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:286

paymentOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

paymentOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

paymentOperationRecord.from

from: string;

Source: src/horizon/horizon_api.ts:284

paymentOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

paymentOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

paymentOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

paymentOperationRecord.receiver

receiver: CallFunction<AccountRecord>;

Source: src/horizon/server_api.ts:198

paymentOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

paymentOperationRecord.sender

sender: CallFunction<AccountRecord>;

Source: src/horizon/server_api.ts:197

paymentOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

paymentOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

paymentOperationRecord.to

to: string;

Source: src/horizon/horizon_api.ts:285

paymentOperationRecord.to_muxed

to_muxed?: string;

Source: src/horizon/horizon_api.ts:290

paymentOperationRecord.to_muxed_id

to_muxed_id?: string;

Source: src/horizon/horizon_api.ts:291

paymentOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

paymentOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

paymentOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

paymentOperationRecord.type

type: payment;

Source: src/horizon/horizon_api.ts:266

paymentOperationRecord.type_i

type_i: payment;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.PaymentPathRecord

interface PaymentPathRecord extends BaseResponse {
_links: { self: ResponseLink };
destination_amount: string;
destination_asset_code: string;
destination_asset_issuer: string;
destination_asset_type: string;
path: { asset_code: string; asset_issuer: string; asset_type: string }[];
source_amount: string;
source_asset_code: string;
source_asset_issuer: string;
source_asset_type: string;
}

Source: src/horizon/server_api.ts:476

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

paymentPathRecord.destination_amount

destination_amount: string;

Source: src/horizon/server_api.ts:486

paymentPathRecord.destination_asset_code

destination_asset_code: string;

Source: src/horizon/server_api.ts:488

paymentPathRecord.destination_asset_issuer

destination_asset_issuer: string;

Source: src/horizon/server_api.ts:489

paymentPathRecord.destination_asset_type

destination_asset_type: string;

Source: src/horizon/server_api.ts:487

paymentPathRecord.path

path: { asset_code: string; asset_issuer: string; asset_type: string }[];

Source: src/horizon/server_api.ts:477

paymentPathRecord.source_amount

source_amount: string;

Source: src/horizon/server_api.ts:482

paymentPathRecord.source_asset_code

source_asset_code: string;

Source: src/horizon/server_api.ts:484

paymentPathRecord.source_asset_issuer

source_asset_issuer: string;

Source: src/horizon/server_api.ts:485

paymentPathRecord.source_asset_type

source_asset_type: string;

Source: src/horizon/server_api.ts:483

Horizon.ServerApi.RestoreFootprintOperationRecord

interface RestoreFootprintOperationRecord extends BaseOperationRecord<OperationResponseType.restoreFootprint, OperationResponseTypeI.restoreFootprint>, RestoreFootprintOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: restoreFootprint;
type_i: restoreFootprint;
}

Source: src/horizon/server_api.ts:361

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

restoreFootprintOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

restoreFootprintOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

restoreFootprintOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

restoreFootprintOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

restoreFootprintOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

restoreFootprintOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

restoreFootprintOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

restoreFootprintOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

restoreFootprintOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

restoreFootprintOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

restoreFootprintOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

restoreFootprintOperationRecord.type

type: restoreFootprint;

Source: src/horizon/horizon_api.ts:266

restoreFootprintOperationRecord.type_i

type_i: restoreFootprint;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.RevokeSponsorshipOperationRecord

interface RevokeSponsorshipOperationRecord extends BaseOperationRecord<OperationResponseType.revokeSponsorship, OperationResponseTypeI.revokeSponsorship>, RevokeSponsorshipOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
account_id?: string;
claimable_balance_id?: string;
created_at: string;
data_account_id?: string;
data_name?: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
offer_id?: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
signer_account_id?: string;
signer_key?: string;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
trustline_account_id?: string;
trustline_asset?: string;
trustline_liquidity_pool_id?: string;
type: revokeSponsorship;
type_i: revokeSponsorship;
}

Source: src/horizon/server_api.ts:305

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

revokeSponsorshipOperationRecord.account_id

account_id?: string;

Source: src/horizon/horizon_api.ts:489

revokeSponsorshipOperationRecord.claimable_balance_id

claimable_balance_id?: string;

Source: src/horizon/horizon_api.ts:490

revokeSponsorshipOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

revokeSponsorshipOperationRecord.data_account_id

data_account_id?: string;

Source: src/horizon/horizon_api.ts:491

revokeSponsorshipOperationRecord.data_name

data_name?: string;

Source: src/horizon/horizon_api.ts:492

revokeSponsorshipOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

revokeSponsorshipOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

revokeSponsorshipOperationRecord.offer_id

offer_id?: string;

Source: src/horizon/horizon_api.ts:493

revokeSponsorshipOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

revokeSponsorshipOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

revokeSponsorshipOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

revokeSponsorshipOperationRecord.signer_account_id

signer_account_id?: string;

Source: src/horizon/horizon_api.ts:497

revokeSponsorshipOperationRecord.signer_key

signer_key?: string;

Source: src/horizon/horizon_api.ts:498

revokeSponsorshipOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

revokeSponsorshipOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

revokeSponsorshipOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

revokeSponsorshipOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

revokeSponsorshipOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

revokeSponsorshipOperationRecord.trustline_account_id

trustline_account_id?: string;

Source: src/horizon/horizon_api.ts:494

revokeSponsorshipOperationRecord.trustline_asset

trustline_asset?: string;

Source: src/horizon/horizon_api.ts:495

revokeSponsorshipOperationRecord.trustline_liquidity_pool_id

trustline_liquidity_pool_id?: string;

Source: src/horizon/horizon_api.ts:496

revokeSponsorshipOperationRecord.type

type: revokeSponsorship;

Source: src/horizon/horizon_api.ts:266

revokeSponsorshipOperationRecord.type_i

type_i: revokeSponsorship;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.SetOptionsOperationRecord

interface SetOptionsOperationRecord extends BaseOperationRecord<OperationResponseType.setOptions, OperationResponseTypeI.setOptions>, SetOptionsOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
clear_flags: (1 | 2 | 4)[];
clear_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
high_threshold?: number;
home_domain?: string;
id: string;
low_threshold?: number;
master_key_weight?: number;
med_threshold?: number;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
set_flags: (1 | 2 | 4)[];
set_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];
signer_key?: string;
signer_weight?: number;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: setOptions;
type_i: setOptions;
}

Source: src/horizon/server_api.ts:228

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

setOptionsOperationRecord.clear_flags

clear_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:382

setOptionsOperationRecord.clear_flags_s

clear_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];

Source: src/horizon/horizon_api.ts:383

setOptionsOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

setOptionsOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

setOptionsOperationRecord.high_threshold

high_threshold?: number;

Source: src/horizon/horizon_api.ts:374

setOptionsOperationRecord.home_domain

home_domain?: string;

Source: src/horizon/horizon_api.ts:375

setOptionsOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

setOptionsOperationRecord.low_threshold

low_threshold?: number;

Source: src/horizon/horizon_api.ts:372

setOptionsOperationRecord.master_key_weight

master_key_weight?: number;

Source: src/horizon/horizon_api.ts:371

setOptionsOperationRecord.med_threshold

med_threshold?: number;

Source: src/horizon/horizon_api.ts:373

setOptionsOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

setOptionsOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

setOptionsOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

setOptionsOperationRecord.set_flags

set_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:376

setOptionsOperationRecord.set_flags_s

set_flags_s: ("auth_required_flag" | "auth_revocable_flag" | "auth_clawback_enabled_flag")[];

Source: src/horizon/horizon_api.ts:377

setOptionsOperationRecord.signer_key

signer_key?: string;

Source: src/horizon/horizon_api.ts:369

setOptionsOperationRecord.signer_weight

signer_weight?: number;

Source: src/horizon/horizon_api.ts:370

setOptionsOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

setOptionsOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

setOptionsOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

setOptionsOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

setOptionsOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

setOptionsOperationRecord.type

type: setOptions;

Source: src/horizon/horizon_api.ts:266

setOptionsOperationRecord.type_i

type_i: setOptions;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.SetTrustLineFlagsOperationRecord

interface SetTrustLineFlagsOperationRecord extends BaseOperationRecord<OperationResponseType.setTrustLineFlags, OperationResponseTypeI.setTrustLineFlags>, SetTrustLineFlagsOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
asset_code: string;
asset_issuer: string;
asset_type: AssetType;
clear_flags: (1 | 2 | 4)[];
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
self: CallFunction<OperationRecord>;
set_flags: (1 | 2 | 4)[];
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
trustor: string;
type: setTrustLineFlags;
type_i: setTrustLineFlags;
}

Source: src/horizon/server_api.ts:326

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

setTrustLineFlagsOperationRecord.asset_code

asset_code: string;

Source: src/horizon/horizon_api.ts:524

setTrustLineFlagsOperationRecord.asset_issuer

asset_issuer: string;

Source: src/horizon/horizon_api.ts:525

setTrustLineFlagsOperationRecord.asset_type

asset_type: AssetType;

Source: src/horizon/horizon_api.ts:523

setTrustLineFlagsOperationRecord.clear_flags

clear_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:528

setTrustLineFlagsOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

setTrustLineFlagsOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

setTrustLineFlagsOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

setTrustLineFlagsOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

setTrustLineFlagsOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

setTrustLineFlagsOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

setTrustLineFlagsOperationRecord.set_flags

set_flags: (1 | 2 | 4)[];

Source: src/horizon/horizon_api.ts:527

setTrustLineFlagsOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

setTrustLineFlagsOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

setTrustLineFlagsOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

setTrustLineFlagsOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

setTrustLineFlagsOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

setTrustLineFlagsOperationRecord.trustor

trustor: string;

Source: src/horizon/horizon_api.ts:526

setTrustLineFlagsOperationRecord.type

type: setTrustLineFlags;

Source: src/horizon/horizon_api.ts:266

setTrustLineFlagsOperationRecord.type_i

type_i: setTrustLineFlags;

Source: src/horizon/horizon_api.ts:267

Horizon.ServerApi.TradeRecord

type TradeRecord = TradeRecord.Orderbook | TradeRecord.LiquidityPool

Source: src/horizon/server_api.ts:397

Horizon.ServerApi.TradeRecord.LiquidityPool

interface LiquidityPool extends Base {
_links: { self: ResponseLink };
base: CallFunction<AccountRecord | LiquidityPoolRecord>;
base_account?: string;
base_amount: string;
base_asset_code?: string;
base_asset_issuer?: string;
base_asset_type: string;
base_is_seller: boolean;
base_liquidity_pool_id?: string;
counter: CallFunction<AccountRecord | LiquidityPoolRecord>;
counter_account?: string;
counter_amount: string;
counter_asset_code?: string;
counter_asset_issuer?: string;
counter_asset_type: string;
counter_liquidity_pool_id?: string;
id: string;
ledger_close_time: string;
liquidity_pool_fee_bp: number;
operation: CallFunction<OperationRecord>;
paging_token: string;
price?: { d: string; n: string };
trade_type: liquidityPools;
}

Source: src/horizon/server_api.ts:431

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

liquidityPool.base

base: CallFunction<AccountRecord | LiquidityPoolRecord>;

Source: src/horizon/server_api.ts:437

liquidityPool.base_account

base_account?: string;

Source: src/horizon/server_api.ts:403

liquidityPool.base_amount

base_amount: string;

Source: src/horizon/server_api.ts:404

liquidityPool.base_asset_code

base_asset_code?: string;

Source: src/horizon/server_api.ts:406

liquidityPool.base_asset_issuer

base_asset_issuer?: string;

Source: src/horizon/server_api.ts:407

liquidityPool.base_asset_type

base_asset_type: string;

Source: src/horizon/server_api.ts:405

liquidityPool.base_is_seller

base_is_seller: boolean;

Source: src/horizon/server_api.ts:413

liquidityPool.base_liquidity_pool_id

base_liquidity_pool_id?: string;

Source: src/horizon/server_api.ts:433

liquidityPool.counter

counter: CallFunction<AccountRecord | LiquidityPoolRecord>;

Source: src/horizon/server_api.ts:438

liquidityPool.counter_account

counter_account?: string;

Source: src/horizon/server_api.ts:408

liquidityPool.counter_amount

counter_amount: string;

Source: src/horizon/server_api.ts:409

liquidityPool.counter_asset_code

counter_asset_code?: string;

Source: src/horizon/server_api.ts:411

liquidityPool.counter_asset_issuer

counter_asset_issuer?: string;

Source: src/horizon/server_api.ts:412

liquidityPool.counter_asset_type

counter_asset_type: string;

Source: src/horizon/server_api.ts:410

liquidityPool.counter_liquidity_pool_id

counter_liquidity_pool_id?: string;

Source: src/horizon/server_api.ts:434

liquidityPool.id

id: string;

Source: src/horizon/server_api.ts:399

liquidityPool.ledger_close_time

ledger_close_time: string;

Source: src/horizon/server_api.ts:401

liquidityPool.liquidity_pool_fee_bp

liquidity_pool_fee_bp: number;

Source: src/horizon/server_api.ts:435

liquidityPool.operation

operation: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:419

liquidityPool.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:400

liquidityPool.price

price?: { d: string; n: string };

Source: src/horizon/server_api.ts:414

liquidityPool.trade_type

trade_type: liquidityPools;

Source: src/horizon/server_api.ts:432

Horizon.ServerApi.TradeRecord.Orderbook

interface Orderbook extends Base {
_links: { self: ResponseLink };
base: CallFunction<AccountRecord>;
base_account: string;
base_amount: string;
base_asset_code?: string;
base_asset_issuer?: string;
base_asset_type: string;
base_is_seller: boolean;
base_offer_id: string;
counter: CallFunction<AccountRecord>;
counter_account: string;
counter_amount: string;
counter_asset_code?: string;
counter_asset_issuer?: string;
counter_asset_type: string;
counter_offer_id: string;
id: string;
ledger_close_time: string;
operation: CallFunction<OperationRecord>;
paging_token: string;
price?: { d: string; n: string };
trade_type: orderbook;
}

Source: src/horizon/server_api.ts:421

_links: { self: ResponseLink };

Source: src/horizon/horizon_api.ts:10

orderbook.base

base: CallFunction<AccountRecord>;

Source: src/horizon/server_api.ts:428

orderbook.base_account

base_account: string;

Source: src/horizon/server_api.ts:424

orderbook.base_amount

base_amount: string;

Source: src/horizon/server_api.ts:404

orderbook.base_asset_code

base_asset_code?: string;

Source: src/horizon/server_api.ts:406

orderbook.base_asset_issuer

base_asset_issuer?: string;

Source: src/horizon/server_api.ts:407

orderbook.base_asset_type

base_asset_type: string;

Source: src/horizon/server_api.ts:405

orderbook.base_is_seller

base_is_seller: boolean;

Source: src/horizon/server_api.ts:413

orderbook.base_offer_id

base_offer_id: string;

Source: src/horizon/server_api.ts:423

orderbook.counter

counter: CallFunction<AccountRecord>;

Source: src/horizon/server_api.ts:429

orderbook.counter_account

counter_account: string;

Source: src/horizon/server_api.ts:426

orderbook.counter_amount

counter_amount: string;

Source: src/horizon/server_api.ts:409

orderbook.counter_asset_code

counter_asset_code?: string;

Source: src/horizon/server_api.ts:411

orderbook.counter_asset_issuer

counter_asset_issuer?: string;

Source: src/horizon/server_api.ts:412

orderbook.counter_asset_type

counter_asset_type: string;

Source: src/horizon/server_api.ts:410

orderbook.counter_offer_id

counter_offer_id: string;

Source: src/horizon/server_api.ts:425

orderbook.id

id: string;

Source: src/horizon/server_api.ts:399

orderbook.ledger_close_time

ledger_close_time: string;

Source: src/horizon/server_api.ts:401

orderbook.operation

operation: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:419

orderbook.paging_token

paging_token: string;

Source: src/horizon/server_api.ts:400

orderbook.price

price?: { d: string; n: string };

Source: src/horizon/server_api.ts:414

orderbook.trade_type

trade_type: orderbook;

Source: src/horizon/server_api.ts:422

Horizon.ServerApi.TradeType

enum TradeType

Source: src/horizon/server_api.ts:135

Horizon.ServerApi.TransactionRecord

interface TransactionRecord extends Omit<HorizonApi.TransactionResponse, "ledger"> {
_links: { account: ResponseLink; effects: ResponseLink; ledger: ResponseLink; operations: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink };
account: CallFunction<AccountRecord>;
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
envelope_xdr: string;
fee_account: string;
fee_bump_transaction?: FeeBumpTransactionResponse;
fee_charged: string | number;
fee_meta_xdr: string;
hash: string;
id: string;
inner_transaction?: InnerTransactionResponse;
ledger: CallFunction<LedgerRecord>;
ledger_attr: number;
max_fee: string | number;
memo?: string;
memo_bytes?: string;
memo_type: MemoType;
operation_count: number;
operations: CallCollectionFunction<OperationRecord>;
paging_token: string;
precedes: CallFunction<TransactionRecord>;
preconditions?: TransactionPreconditions;
result_meta_xdr: string;
result_xdr: string;
self: CallFunction<TransactionRecord>;
signatures: string[];
source_account: string;
source_account_sequence: string;
succeeds: CallFunction<TransactionRecord>;
successful: boolean;
}

Source: src/horizon/server_api.ts:442

_links: { account: ResponseLink; effects: ResponseLink; ledger: ResponseLink; operations: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink };

Source: src/horizon/horizon_api.ts:10

transactionRecord.account

account: CallFunction<AccountRecord>;

Source: src/horizon/server_api.ts:448

transactionRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:66

transactionRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:449

transactionRecord.envelope_xdr

envelope_xdr: string;

Source: src/horizon/horizon_api.ts:17

transactionRecord.fee_account

fee_account: string;

Source: src/horizon/horizon_api.ts:79

transactionRecord.fee_bump_transaction

fee_bump_transaction?: FeeBumpTransactionResponse;

Source: src/horizon/horizon_api.ts:81

transactionRecord.fee_charged

fee_charged: string | number;

Source: src/horizon/horizon_api.ts:68

transactionRecord.fee_meta_xdr

fee_meta_xdr: string;

Source: src/horizon/horizon_api.ts:67

transactionRecord.hash

hash: string;

Source: src/horizon/horizon_api.ts:14

transactionRecord.id

id: string;

Source: src/horizon/horizon_api.ts:70

transactionRecord.inner_transaction

inner_transaction?: InnerTransactionResponse;

Source: src/horizon/horizon_api.ts:80

transactionRecord.ledger

ledger: CallFunction<LedgerRecord>;

Source: src/horizon/server_api.ts:450

transactionRecord.ledger_attr

ledger_attr: number;

Source: src/horizon/server_api.ts:446

transactionRecord.max_fee

max_fee: string | number;

Source: src/horizon/horizon_api.ts:69

transactionRecord.memo

memo?: string;

Source: src/horizon/horizon_api.ts:72

transactionRecord.memo_bytes

memo_bytes?: string;

Source: src/horizon/horizon_api.ts:73

transactionRecord.memo_type

memo_type: MemoType;

Source: src/horizon/horizon_api.ts:71

transactionRecord.operation_count

operation_count: number;

Source: src/horizon/horizon_api.ts:74

transactionRecord.operations

operations: CallCollectionFunction<OperationRecord>;

Source: src/horizon/server_api.ts:451

transactionRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:75

transactionRecord.precedes

precedes: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:452

transactionRecord.preconditions

preconditions?: TransactionPreconditions;

Source: src/horizon/horizon_api.ts:82

transactionRecord.result_meta_xdr

result_meta_xdr: string;

Source: src/horizon/horizon_api.ts:19

transactionRecord.result_xdr

result_xdr: string;

Source: src/horizon/horizon_api.ts:18

transactionRecord.self

self: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:453

transactionRecord.signatures

signatures: string[];

Source: src/horizon/horizon_api.ts:76

transactionRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:77

transactionRecord.source_account_sequence

source_account_sequence: string;

Source: src/horizon/horizon_api.ts:78

transactionRecord.succeeds

succeeds: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:454

transactionRecord.successful

successful: boolean;

Source: src/horizon/horizon_api.ts:16

Horizon.ServerApi.WithdrawLiquidityOperationRecord

interface WithdrawLiquidityOperationRecord extends BaseOperationRecord<OperationResponseType.liquidityPoolWithdraw, OperationResponseTypeI.liquidityPoolWithdraw>, WithdrawLiquidityOperationResponse {
_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };
created_at: string;
effects: CallCollectionFunction<EffectRecord>;
id: string;
liquidity_pool_id: string;
paging_token: string;
precedes: CallFunction<OperationRecord>;
reserves_min: Reserve[];
reserves_received: Reserve[];
self: CallFunction<OperationRecord>;
shares: string;
source_account: string;
succeeds: CallFunction<OperationRecord>;
transaction: CallFunction<TransactionRecord>;
transaction_hash: string;
transaction_successful: boolean;
type: liquidityPoolWithdraw;
type_i: liquidityPoolWithdraw;
}

Source: src/horizon/server_api.ts:340

_links: { effects: ResponseLink; precedes: ResponseLink; self: ResponseLink; succeeds: ResponseLink; transaction: ResponseLink };

Source: src/horizon/horizon_api.ts:10

withdrawLiquidityOperationRecord.created_at

created_at: string;

Source: src/horizon/horizon_api.ts:268

withdrawLiquidityOperationRecord.effects

effects: CallCollectionFunction<EffectRecord>;

Source: src/horizon/server_api.ts:180

withdrawLiquidityOperationRecord.id

id: string;

Source: src/horizon/horizon_api.ts:263

withdrawLiquidityOperationRecord.liquidity_pool_id

liquidity_pool_id: string;

Source: src/horizon/horizon_api.ts:551

withdrawLiquidityOperationRecord.paging_token

paging_token: string;

Source: src/horizon/horizon_api.ts:264

withdrawLiquidityOperationRecord.precedes

precedes: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:179

withdrawLiquidityOperationRecord.reserves_min

reserves_min: Reserve[];

Source: src/horizon/horizon_api.ts:552

withdrawLiquidityOperationRecord.reserves_received

reserves_received: Reserve[];

Source: src/horizon/horizon_api.ts:554

withdrawLiquidityOperationRecord.self

self: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:177

withdrawLiquidityOperationRecord.shares

shares: string;

Source: src/horizon/horizon_api.ts:553

withdrawLiquidityOperationRecord.source_account

source_account: string;

Source: src/horizon/horizon_api.ts:265

withdrawLiquidityOperationRecord.succeeds

succeeds: CallFunction<OperationRecord>;

Source: src/horizon/server_api.ts:178

withdrawLiquidityOperationRecord.transaction

transaction: CallFunction<TransactionRecord>;

Source: src/horizon/server_api.ts:181

withdrawLiquidityOperationRecord.transaction_hash

transaction_hash: string;

Source: src/horizon/horizon_api.ts:269

withdrawLiquidityOperationRecord.transaction_successful

transaction_successful: boolean;

Source: src/horizon/horizon_api.ts:270

withdrawLiquidityOperationRecord.type

type: liquidityPoolWithdraw;

Source: src/horizon/horizon_api.ts:266

withdrawLiquidityOperationRecord.type_i

type_i: liquidityPoolWithdraw;

Source: src/horizon/horizon_api.ts:267