Skip to content

Commit 34e312a

Browse files
fix: documentation update
1 parent eea9749 commit 34e312a

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Sources/web3swift/Operations/WriteOperation.swift

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,13 @@ public class WriteOperation: ReadOperation {
1313
// FIXME: Rewrite this to CodableTransaction
1414
/// Sends raw transaction for write operation.
1515
/// - Parameters:
16-
/// - password: Password for private key.
17-
/// - policies: Custom policies for how to resolve (optional). Default is auto.
16+
/// - password: Password for the private key in the keystore manager attached to the provider
17+
/// you set to `web3` passed in the initializer.
18+
/// - policies: Determining the behaviour of how transaction attributes like gas limit and
19+
/// nonce are resolved. Default value is ``Policies/auto``.
20+
/// - sendRaw: If set to `true` transaction will be signed and sent using `eth_sendRawTransaction`.
21+
/// Otherwise, no signing attempts will take place and the `eth_sendTransaction` RPC will be used instead.
22+
/// Default value is `false`.
1823
public func writeToChain(password: String, policies: Policies = .auto, sendRaw: Bool = false) async throws -> TransactionSendingResult {
1924
try await policyResolver.resolveAll(for: &transaction, with: policies)
2025

0 commit comments

Comments
 (0)