Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PathPaymentSendOperation

Structure representing a Stellar Path Payment Send Operation.

Hierarchy

  • Operation<Horizon.OperationResponseType.pathPaymentStrictSend, Horizon.OperationResponseTypeI.pathPaymentStrictSend>
    • PathPaymentSendOperation

Index

Constructors

constructor

Properties

amount

amount: number

The amount received designated in the source asset.

Optional assetCode

assetCode: string

The code for the asset being sent. Appears if assetType is not native.

Optional assetIssuerId

assetIssuerId: string

The Stellar address of the issuer of the asset being sent. Appears if assetType is not native.

assetType

assetType: AssetType

The type of asset being sent. Either native, credit_alphanum4, or credit_alphanum12.

Readonly client

client: Client

createdAt

createdAt: Date

The operation's creation date.

createdTimestamp

createdTimestamp: number

The operation's creation timestamp.

destinationMin

destinationMin: string

The minimum amount of destination asset expected to be received.

id

id: string

The id of the operation.

pagingToken

pagingToken: string

A cursor value for use in pagination.

path

The intermediary assets that this path hops through.

recipientId

recipientId: string

The payment recipient’s public key.

senderId

senderId: string

The payment sender’s public key.

sourceAccountId

sourceAccountId: string

The account that originates the operation.

sourceAmount

sourceAmount: number

The amount sent designated in the source asset.

Optional sourceAssetIssuerId

sourceAssetIssuerId: string

The Stellar address of the source asset’s issuer. Appears if sourceAssetType is not native.

sourceAssetType

sourceAssetType: AssetType

The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.

Optional sourceAssetcode

sourceAssetcode: string

The code for the source asset. Appears if sourceAssetType is not native.

transactionHash

transactionHash: string

A unique id for the transaction the operation belongs to.

type

type: pathPaymentStrictSend

The numeric type of the operation.

typeName

typeName: pathPaymentStrictSend

The name of the operation type.

Methods

$patch

  • $patch(data: PathPaymentStrictSendOperationRecord): void

getEffects

getIntermediaryAssets

  • getIntermediaryAssets(forceUpdate?: boolean): Promise<AssetManager>

getRecipientAccount

  • getRecipientAccount(forceUpdate?: boolean): Promise<Account>

getSenderAccount

  • getSenderAccount(forceUpdate?: boolean): Promise<Account>

getSentAsset

  • getSentAsset(forceUpdate?: boolean): Promise<undefined | Asset>

getSourceAccount

  • getSourceAccount(forceUpdate?: boolean): Promise<Account>

getSourceAsset

  • getSourceAsset(forceUpdate?: boolean): Promise<undefined | Asset>

getTransaction

  • getTransaction(forceUpdate?: boolean): Promise<Transaction>

Generated using TypeDoc