diff --git a/src/contract/assembled_transaction.ts b/src/contract/assembled_transaction.ts index b3158a164..09c07833d 100644 --- a/src/contract/assembled_transaction.ts +++ b/src/contract/assembled_transaction.ts @@ -394,10 +394,11 @@ export class AssembledTransaction { * If you don't want to simulate the transaction, you can set `simulate` to * `false` in the options. * - * const tx = await AssembledTransaction.build({ - * ..., - * simulate: false, - * }) + * @example + * const tx = await AssembledTransaction.build({ + * ..., + * simulate: false, + * }) */ static async build( options: AssembledTransactionOptions, diff --git a/src/contract/types.ts b/src/contract/types.ts index 8b92276c2..c41171038 100644 --- a/src/contract/types.ts +++ b/src/contract/types.ts @@ -3,7 +3,6 @@ import { BASE_FEE, Memo, MemoType, Operation, Transaction, xdr } from "@stellar/stellar-base"; import type { Client } from "./client"; import type { AssembledTransaction } from "./assembled_transaction"; -import { DEFAULT_TIMEOUT } from "./utils"; export type XDR_BASE64 = string; export type u32 = number; @@ -99,8 +98,10 @@ export type MethodOptions = { fee?: string; /** - * The maximum amount of time to wait for the transaction to complete. - * Default: {@link DEFAULT_TIMEOUT} + * The timebounds which should be set for transactions generated by this + * contract client. + * @see {@link module:contract.Client#DEFAULT_TIMEOUT} + * @default module:contract.Client#DEFAULT_TIMEOUT */ timeoutInSeconds?: number; diff --git a/src/contract/utils.ts b/src/contract/utils.ts index b9aec797a..c25088a90 100644 --- a/src/contract/utils.ts +++ b/src/contract/utils.ts @@ -3,6 +3,8 @@ import type { AssembledTransaction } from "./assembled_transaction"; /** * The default timebounds, in seconds, during which a transaction will be valid. + * This is attached to the transaction at the time it is built, which takes + * place _before_ transaction simulation, and _before_ transaction signing. * @constant {number} * @default 300 * @memberof module:contract.Client