/
defaultSendArgs.ts
48 lines (45 loc) · 1.58 KB
/
defaultSendArgs.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
import {Attachment} from '../attachment';
/**
* The base argument object for common transactions
*
* @module core
*/
export interface DefaultSendArgs {
/**
* The fee expressed in Planck
* @note It's recommended to use [[util.Amount]]
*/
feePlanck: string;
/**
* The senders public key, i.e. the [[crypto.Keys.publicKey]]
*/
senderPublicKey: string;
/**
* The senders private key, i.e. the [[crypto.Keys.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]]
*/
senderPrivateKey?: string;
/**
* An optional attachment
*/
attachment?: Attachment;
/**
* The deadline when after how many minutes the transaction will be discarded, if it was not
* processed, e.g. due to very low fee
*/
deadline?: number;
/**
* Using this field allows to make a transaction dependent on other transactions.
*/
referencedTransactionFullHash?: string;
/**
* 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.
*
*/
skipAdditionalSecurityCheck?: boolean;
}