Skip to content

Commit

Permalink
client: satisfy yard docs for transfer kwargs (#170)
Browse files Browse the repository at this point in the history
  • Loading branch information
q9f committed Nov 30, 2022
1 parent 7b3c67a commit ec50ed1
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions lib/eth/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,15 @@ def transfer_and_wait(destination, amount, **kwargs)
# **Note**, that many remote providers (e.g., Infura) do not provide
# any accounts. Provide a `sender_key` if you experience issues.
#
# @param destination [Eth::Address] the destination address.
# @param amount [Integer] the transfer amount in Wei.
# @param **sender_key [Eth::Key] the sender private key.
# @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
# @param **nonce [Integer] optional specific nonce for transaction.
# @overload transfer(destination, amount)
# @param destination [Eth::Address] the destination address.
# @param amount [Integer] the transfer amount in Wei.
# @overload transfer(destination, amount, **kwargs)
# @param destination [Eth::Address] the destination address.
# @param amount [Integer] the transfer amount in Wei.
# @param **sender_key [Eth::Key] the sender private key.
# @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
# @param **nonce [Integer] optional specific nonce for transaction.
# @return [String] the local transaction hash.
def transfer(destination, amount, **kwargs)
params = {
Expand Down

0 comments on commit ec50ed1

Please sign in to comment.