Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreatePassiveSellOfferOperation

Structure representing a Stellar Create Passive Sell Offer Operation.

Hierarchy

  • Operation<Horizon.OperationResponseType.createPassiveOffer, Horizon.OperationResponseTypeI.createPassiveOffer>
    • CreatePassiveSellOfferOperation

Index

Constructors

constructor

Properties

amount

amount: number

The amount of sellingAsset that the account making the offer is willing to sell.

Optional buyingAssetCode

buyingAssetCode: string

The code for the buying asset. Appears if the buyingAssetType is not native.

Optional buyingAssetIssuerId

buyingAssetIssuerId: string

The Stellar address of the buying asset’s issuer. Appears if the buyingAssetType is not native.

buyingAssetType

buyingAssetType: AssetType

The type for the buying asset. 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.

id

id: string

The id of the operation.

offerId

offerId: string

The id of the offer.

pagingToken

pagingToken: string

A cursor value for use in pagination.

price

price: number

How many units of sellingAsset it takes to get 1 unit of buyingAsset. A number representing the decimal form of priceRational.

priceRational

priceRational: PriceRational

A precise representation of the buy and sell price of the assets on offer.

Optional sellingAssetCode

sellingAssetCode: string

The code for the selling asset. Appears if the sellingAssetType is not native.

Optional sellingAssetIssuerId

sellingAssetIssuerId: string

The Stellar address of the selling asset’s issuer. Appears if the sellingAssetType is not native.

sellingAssetType

sellingAssetType: AssetType

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

sourceAccountId

sourceAccountId: string

The account that originates the operation.

transactionHash

transactionHash: string

A unique id for the transaction the operation belongs to.

type

type: createPassiveOffer

The numeric type of the operation.

typeName

typeName: createPassiveOffer

The name of the operation type.

Methods

$patch

  • $patch(data: PassiveOfferOperationRecord): void

getBuyingAsset

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

getEffects

getSellingAsset

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

getSourceAccount

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

getTransaction

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

Generated using TypeDoc