LumeWeb
/
ethers-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document EthEvent proc macro attributes and add example

This commit is contained in:
Matthias Seitz 2021-03-17 19:44:21 +01:00
parent e201e85486
commit 2513e1f3ff
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
ethers-contract/ethers-contract-derive/src/lib.rs
View File

@ -79,6 +79,8 @@ pub fn abigen(input: TokenStream) -> TokenStream {
/// ///
/// Additional arguments can be specified using the `#[ethevent(...)]` attribute: /// Additional arguments can be specified using the `#[ethevent(...)]` attribute:
/// ///
/// For the struct:
///
/// - `name`, `name = "..."`: Overrides the generated `EthEvent` name, default is the /// - `name`, `name = "..."`: Overrides the generated `EthEvent` name, default is the
/// struct's name. /// struct's name.
/// - `signature`, `signature = "..."`: The signature as hex string to override the /// - `signature`, `signature = "..."`: The signature as hex string to override the
@ -86,9 +88,17 @@ pub fn abigen(input: TokenStream) -> TokenStream {
/// - `abi`, `abi = "..."`: The ABI signature for the event this event's data corresponds to. /// - `abi`, `abi = "..."`: The ABI signature for the event this event's data corresponds to.
/// The `abi` should be solidity event definition or a tuple of the event's types in case the /// The `abi` should be solidity event definition or a tuple of the event's types in case the
/// event has non elementary (other `EthAbiType`) types as members /// event has non elementary (other `EthAbiType`) types as members
/// - `anonymous`: A flag to mark this as an anonymous event
///
/// For fields:
///
/// - `indexed`: flag to mark a field as an indexed event input
/// - `name`: override the name of an indexed event input, default is the rust field name
/// ///
/// # Example /// # Example
/// ```ignore /// ```no_run
/// # use ethers_core::types::Address;
///
/// #[derive(Debug, EthAbiType)] /// #[derive(Debug, EthAbiType)]
/// struct Inner { /// struct Inner {
/// inner: Address, /// inner: Address,
@ -98,8 +108,10 @@ pub fn abigen(input: TokenStream) -> TokenStream {
/// #[derive(Debug, EthEvent)] /// #[derive(Debug, EthEvent)]
/// #[ethevent(abi = "ValueChangedEvent((address,string),string)")] /// #[ethevent(abi = "ValueChangedEvent((address,string),string)")]
/// struct ValueChangedEvent { /// struct ValueChangedEvent {
/// inner: Inner, /// #[ethevent(indexed, name = "_target")]
/// target: Address,
/// msg: String, /// msg: String,
/// inner: Inner,
/// } /// }
/// ``` /// ```
#[proc_macro_derive(EthEvent, attributes(ethevent))] #[proc_macro_derive(EthEvent, attributes(ethevent))]
@ -843,7 +855,7 @@ fn parse_attributes(input: &DeriveInput) -> Result<Attributes, proc_macro2::Toke
match meta { match meta {
Meta::Path(path) => { Meta::Path(path) => {
if let Some(name) = path.get_ident() { if let Some(name) = path.get_ident() {
if *name.to_string() == "anonymous" { if &*name.to_string() == "anonymous" {
if result.anonymous.is_none() { if result.anonymous.is_none() {
result.anonymous = Some((true, name.span())); result.anonymous = Some((true, name.span()));
continue; continue;