Interface PlaceOrderArgs

The argument object for AssetApi.placeAskOrder and AssetApi.placeBidOrder

interface PlaceOrderArgs {
    assetId: string;
    attachment?: Attachment;
    deadline?: number;
    decimals?: number;
    feePlanck: string;
    pricePlanck: string;
    quantity: string | number;
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
}

Hierarchy

  • DefaultSendArgs
    • PlaceOrderArgs

Properties

assetId attachment? deadline? decimals? feePlanck pricePlanck quantity referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck?

Properties

assetId

assetId: string

The assets id

Optionalattachment

attachment?: Attachment

An optional attachment

Optionaldeadline

deadline?: number

The deadline when after how many minutes the transaction will be discarded, if it was not processed, e.g. due to very low fee

Optionaldecimals

decimals?: number

The decimals of the targeted token, as it's required to calculate the correct price for the order. If it is not passed, the decimals will be fetched from the chain (which includes an additional request)

feePlanck

feePlanck: string

The fee expressed in Planck

It's recommended to use util.Amount

pricePlanck

pricePlanck: string

The price that is offered for bid/ask

quantity

quantity: string | number

The amount of assets to ask/bid for

OptionalreferencedTransactionFullHash

referencedTransactionFullHash?: string

Using this field allows to make a transaction dependent on other transactions.

OptionalsenderPrivateKey

senderPrivateKey?: string

The senders private key, i.e. the crypto.SignKeys.signPrivateKey If the private key is not given, then the transaction method will return the unsigned byte string. The transaction won't be processed until the unsigned bytes are being signed and broadcasted using TransactionApi.signAndBroadcastTransaction

senderPublicKey

senderPublicKey: string

The senders public key, i.e. the crypto.SignKeys.publicKey

OptionalskipAdditionalSecurityCheck

skipAdditionalSecurityCheck?: boolean

Setting this option to true, skips the additional security check, i.e. the verification of the unsigned transaction bytes, which detects tampered node responses. By default, the option is false. Usually, you won't use this option, but can be useful when a method cannot be verified, because the verification is not implemented yet.

Settings

Member Visibility

On This Page

Properties