Skip to content

Adds typing hints documentation #3514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Adds typing hints documentation #3514

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba967ed
docs: adds typing hints for web3 documentation
flamiedev Oct 17, 2024
9227d01
Merge branch 'ethereum:main' into adds-typing-hints-documentation
flamiedev Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions docs/web3.types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
TYPES
=====

.. py:module:: web3.types

The ``web3.types`` exposes the available modules that enables you to define the data types for the various web3 methods

The following types are available on the ``web3.types``:

.. py:class:: TFunc
.. py:class:: TParams
.. py:class:: TReturn
.. py:class:: TValue
.. py:class:: BlockParams
.. py:class:: BlockIdentifier
.. py:class:: LatestBlockParam
.. py:class:: ABIElementIdentifier
.. py:class:: _Hash32
.. py:class:: EnodeURI
.. py:class:: ENS
.. py:class:: Nonce
.. py:class:: RPCEndpoint
.. py:class:: Timestamp
.. py:class:: Wei
.. py:class:: Gwei
.. py:class:: Formatters
.. py:class:: AccessListEntry
.. py:class:: AccessList
.. py:class:: EventData
.. py:class:: RPCError
.. py:class:: TxData
.. py:class:: TxParams
.. py:class:: WithdrawalData
.. py:class:: BlockData
.. py:class:: LogReceipt
.. py:class:: SubscriptionResponse
.. py:class:: BlockTypeSubscriptionResponse
.. py:class:: TransactionTypeSubscriptionResponse
.. py:class:: LogsSubscriptionResponse
.. py:class:: SyncProgress
.. py:class:: SyncingSubscriptionResponse
.. py:class:: GethSyncingStatus
.. py:class:: GethSyncingSubscriptionResult
.. py:class:: GethSyncingSubscriptionResponse
.. py:class:: EthSubscriptionParams
.. py:class:: RPCId
.. py:class:: RPCResponse
.. py:class:: FormattedEthSubscriptionResponse
.. py:class:: CreateAccessListResponse
.. py:class:: MakeRequestFn
.. py:class:: MakeBatchRequestFn
.. py:class:: AsyncMakeRequestFn
.. py:class:: AsyncMakeBatchRequestFn
.. py:class:: FormattersDict
.. py:class:: FilterParams
.. py:class:: FeeHistory
.. py:class:: StateOverrideParams
.. py:class:: StateOverride
.. py:class:: GasPriceStrategy
.. py:class:: TxReceipt
.. py:class:: BlockReceipts
.. py:class:: SignedTx
.. py:class:: StorageProof
.. py:class:: MerkleProof
.. py:class:: Protocol
.. py:class:: NodeInfo
.. py:class:: Peer
.. py:class:: SyncStatus
.. py:class:: Uncle
.. py:class:: PendingTx
.. py:class:: TxPoolContent
.. py:class:: TxPoolInspect
.. py:class:: TxPoolStatus
.. py:class:: GethWallet
.. py:class:: TContractFn
.. py:class:: BlockTrace
.. py:class:: FilterTrace
.. py:class:: TraceMode
.. py:class:: TraceFilterParams
.. py:class:: SubscriptionType
.. py:class:: LogsSubscriptionArg