mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-18 07:23:21 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
36 lines
1.3 KiB
JavaScript
36 lines
1.3 KiB
JavaScript
import { useEffect, useCallback } from 'react'
|
|
import { useDispatch, useSelector } from 'react-redux'
|
|
import { getContractMethodData as getContractMethodDataAction } from '../store/actions'
|
|
|
|
import { getKnownMethodData } from '../selectors/selectors'
|
|
|
|
/**
|
|
* Access known method data and attempt to resolve unknown method data
|
|
*
|
|
* encapsulates an effect that will fetch methodData when the component mounts,
|
|
* and subsequently anytime the provided data attribute changes. Note that
|
|
* the getContractMethodData action handles over-fetching prevention, first checking
|
|
* if the data is in the store and returning it directly. While using this hook
|
|
* in multiple places in a tree for the same data will create extra event ticks and
|
|
* hit the action more frequently, it should only ever result in a single store update
|
|
* @param {string} data - the transaction data to find method data for
|
|
* @return {Object} contract method data
|
|
*/
|
|
export function useMethodData(data) {
|
|
const dispatch = useDispatch()
|
|
const knownMethodData = useSelector((state) =>
|
|
getKnownMethodData(state, data),
|
|
)
|
|
const getContractMethodData = useCallback(
|
|
(methodData) => dispatch(getContractMethodDataAction(methodData)),
|
|
[dispatch],
|
|
)
|
|
|
|
useEffect(() => {
|
|
if (data) {
|
|
getContractMethodData(data)
|
|
}
|
|
}, [getContractMethodData, data])
|
|
return knownMethodData
|
|
}
|