Interface CallContractMethodArgs

The argument object for ContractApi.callContractMethod

Param: amountPlanck

The amount in planck to be paid for contract execution

Param: assetQuantities

The list of assets to be sent to the contract

Param: contractId

The id of the contract

Param: methodArgs

The arguments to be passed to the contract method

Param: methodId

The id of the contract method

interface CallContractMethodArgs {
    amountPlanck: string;
    assetQuantities?: MultioutAssetQuantities[];
    attachment?: Attachment;
    contractId: string;
    deadline?: number;
    feePlanck: string;
    methodArgs?: ContractData[];
    methodId: string;
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
}

Hierarchy

  • DefaultSendArgs
    • CallContractMethodArgs

Properties

amountPlanck assetQuantities? attachment? contractId deadline? feePlanck methodArgs? methodId referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck?

Properties

amountPlanck

amountPlanck: string

OptionalassetQuantities

assetQuantities?: MultioutAssetQuantities[]

Optionalattachment

attachment?: Attachment

An optional attachment

contractId

contractId: string

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

feePlanck

feePlanck: string

The fee expressed in Planck

It's recommended to use util.Amount

OptionalmethodArgs

methodArgs?: ContractData[]

methodId

methodId: string

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