solgrep
Version 0.0.10
[ ? ]
Итак, у вас есть набор смарт-контрактов и вы хотите найти все контракты, у которых есть public метод с withdrawEth но лексический grep выдает много ложных срабатываний? Вот где Solgrep может помочь! ?
? npm install -g solgrep
Solgrep рекурсивно находит смарт-контракты в целевом каталоге, анализирует исходные модули, чтобы понять семантику языка, и делает эту информацию доступной для мощной функции фильтрации на основе JavaScript. Таким образом, вы можете:
AST_EXACT и AST_FUZZY ) Вероятно, наиболее распространенный способ использования этого инструмента — запустить его с опцией --find=<js-filter-statement> , где js-filter-statement — это однострочный код JavaScript, сообщающий движку, что вас интересует. Вы либо предоставляете оператор, который возвращает boolean («режим поиска»), либо возвращает информацию, которую вы хотите извлечь («режим извлечения»).
--find=<js-filter-statement> , поскольку этот аргумент оценивается как JavaScript!
--find , --rule . См. Использование.
Запустить правила по умолчанию и отобразить статистику?
⇒ solgrep < folder > Запустить определенное или несколько встроенных правил ( solgrep -l для вывода списка доступных правил)?
⇒ solgrep < folder > -- rule = IsInitializable -- rule = Stats Вы хотите найти все исходные модули с контрактом, имеющим функцию с withdrawEth ?
⇒ solgrep < folder > -- find = "function.name=='withdrawEth'" Сделать то же самое, но без учета регистра?
⇒ solgrep < folder > -- find = "function.name.toLowerCase()=='withdraweth'" Найти все функции, вызывающие selfdestruct ?
⇒ solgrep < folder > -- find = "function.callsTo('selfdestruct')"Извлечь все имена функций из всех контрактов?
⇒ solgrep < folder > -- find = "function.name" Получить список всех external функций?
⇒ solgrep < folder > -- find = "function.visibility.includes('external')" Найти контракты ERC777 ?
⇒ solgrep < folder > -- find = "contract.name=='ERC777'" Извлечь все названия контрактов?
⇒ solgrep < folder > -- find = "contract.name"Извлечь все имена интерфейсов?
⇒ solgrep < folder > -- find = "contract.name && contract.kind=='interface'" Матч против чего-нибудь в AST ?
⇒ solgrep < folder > -- find = "Object.keys(function.modifiers).includes('nonReentrant')"Лексиальное соответствие исходному коду функции?
⇒ solgrep < folder > -- find = "function.getSource().includes('hi')"Нашли дубликаты контрактов? (Точное и нечеткое совпадение AST)
⇒ solgrep < folder > -- rule DupeFinder Используйте опцию --output=<output.json> чтобы записать все результаты в файл.
--findsourceUnit соответствует исходному файлу, который в данный момент обрабатывается движком.contract соответствует контракту, который в данный момент обрабатывается механизмом.function соответствует функции, которую механизм обрабатывает в данный момент. Доступны следующие методы:
<sourceUnit|contract|function>.getSource() — обеспечивает доступ к исходному коду юнитов.<sourceUnit|contract|function>.ast — обеспечивает прямой доступ к AST синтаксического анализатора Solidity.function.callsTo('withdrawEth') — найти все функции во всех контрактах, которые вызывают метод с withdrawEthСпециальные функции контракта могут быть ссылками как:
function.name == '__fallback__'function.name == '__receiveEther__'function.name == '__constructor__'Stats — собирает статистику о том, сколько файлов, контрактов, уникальных имен и т. д. было обработано.GenericGrep — это движок, лежащий в основе функции --find .ДЕЛИТЬСЯ ЭТО ЗАБОТА — представьте свои правила!
⇒ solgrep -- help
Usage: solgrep < folder | ... > [ options ]
Options:
- r , -- rule Enable rules [ array ] [ default : [ ] ]
- l , -- list - rules List available rules [ boolean ] [ default : false ]
- f , -- find Find / Extract information using custom pattern
[ array ] [ default : [ ] ]
- o , -- output Write "results" as JSON to output file path . [ string ]
- h , -- help Show help [ boolean ]
- v , -- version Show version number [ boolean ]--find , --rule ) обязательно используйте этот формат:
⇒ solgrep <folder|...> [options]
или
⇒ solgrep [options] -- <folder|...>
в противном случае дополнительные параметры могут быть интерпретированы как дополнительные параметры --find !
const solgrep = require ( 'solgrep' ) ;
let sg = new SolGrep ( '::memory::' , rules , callbacks ) ;
sg . analyzeDir ( "/path/to/smart/contracts" ) . then ( ( ) => {
console . log ( " ──────────────────────────── Results" )
console . log ( sg . results )
console . log ( " ────────────────────────────" )
sgrep . close ( ) ;
} )
Вот пример, который иллюстрирует, как извлечь все имена функций из всех sourceUnits и contracts .
⇒ solgrep . . / d0 -- find = 'function.name'
? SolGrep v0 .0 .3 ready !
Enabled Modules :
✔️ GenericGrep _function . name
[ ████████████████████████████████████████ ] 100 % | ? ETA : 0 s | 5 / 5 | ? 389 | 0 | . . / d0
────────────────────────────
{
'../d0/D0788Af7a613b81F437a51b96594A6387c7329b1_PendleLiquidityMiningBaseV2Multi.sol' : [
{
rule : 'GenericGrep' ,
tag : 'match-function: PendleLiquidityMiningBaseV2Multi.__constructor__' ,
info : '__constructor__' ,
loc : [ Object ]
} ,
{
rule : 'GenericGrep' ,
tag : 'match-function: PendleLiquidityMiningBaseV2Multi.setUpEmergencyMode' ,
info : 'setUpEmergencyMode' ,
loc : [ Object ]
} ,
... Если вы не предоставите никаких параметров конфигурации, будут использованы встроенные правила grep по умолчанию и обработаны цифры с помощью модуля stats .
⇒ solgrep . . / d6
? SolGrep v0 .0 .1 starting . . .
? . . / d6
████████████████████████████████████████ 100 % | ETA : 0 s | 5 / 5
──────────────────────────── Results
{
'../d6/d60a598998ed27a7C54315F2675908B628E434B1_LiquidityPool.sol' : [
{
rule : 'IsInitializable' ,
tag : 'INITIALIZEABLE' ,
info : 'initialize - public initialize function; likely proxy'
} ,
{
rule : 'IsInitializable' ,
tag : 'INITIALIZEABLE' ,
info : 'initialize - public initialize function; likely proxy'
}
] ,
'../d6/d64E77C7C6A1dcC7e302F8fe31A22745e223c39c_MyStrategy.sol' : [
{
rule : 'IsInitializable' ,
tag : 'INITIALIZEABLE' ,
info : 'initialize - public initialize function; likely proxy'
}
] ,
undefined : [ { rule : 'Stats' , tag : 'STATS' , info : [ Object ] } ]
}
────────────────────────────
{
sourceUnits : 4 ,
contracts : {
total : 13 ,
names : {
ERC20 : 1 ,
StrategySushiEthMimLp : 1 ,
LiquidityPool : 1 ,
Getter : 1 ,
Governance : 1 ,
LibraryEvents : 1 ,
Perpetual : 1 ,
Storage : 1 ,
ArbiBoneman : 1 ,
ERC721 : 1 ,
MyStrategy : 1 ,
PausableUpgradeable : 1 ,
SettAccessControl : 1
}
} ,
interfaces : {
total : 39 ,
names : {
IERC20 : 1 ,
IJar : 1 ,
IStakingRewards : 1 ,
IStakingRewardsFactory : 1 ,
IMasterchef : 1 ,
UniswapRouterV2 : 1 ,
IUniswapV2Pair : 1 ,
IUniswapV2Factory : 1 ,
IRewarder : 1 ,
IMiniChefV2 : 1 ,
ILiquidityPool : 1 ,
IOracle : 1 ,
IAccessControl : 1 ,
IGovernor : 1 ,
IPoolCreatorFull : 1 ,
ISymbolService : 1 ,
IPoolCreator : 1 ,
ITracer : 1 ,
IVersionControl : 1 ,
IVariables : 1 ,
IKeeperWhitelist : 1 ,
IProxyAdmin : 1 ,
IDecimals : 1 ,
ILiquidityPoolGetter : 1 ,
ILiquidityPoolGovernance : 1 ,
IPerpetual : 1 ,
IERC721Enumerable : 1 ,
IERC721 : 1 ,
IERC721Receiver : 1 ,
IERC721Metadata : 1 ,
IERC165 : 1 ,
ICurveGauge : 1 ,
ICurveStableSwapREN : 1 ,
IUniswapRouterV2 : 1 ,
IStrategy : 1 ,
IController : 2 ,
IERC20Upgradeable : 2
}
} ,
libraries : {
total : 31 ,
names : {
SafeMath : 1 ,
SafeERC20 : 1 ,
BoringERC20 : 1 ,
EnumerableSetUpgradeable : 1 ,
SafeCastUpgradeable : 1 ,
AMMModule : 1 ,
LiquidityPoolModule : 1 ,
PerpetualModule : 1 ,
SignedSafeMathUpgradeable : 1 ,
Constant : 1 ,
Math : 1 ,
SafeMathExt : 1 ,
Utils : 1 ,
MarginAccountModule : 1 ,
EnumerableSet : 1 ,
OrderData : 1 ,
CollateralModule : 1 ,
TradeModule : 1 ,
OrderModule : 1 ,
Signature : 1 ,
ECDSAUpgradeable : 1 ,
Strings : 1 ,
MathUpgradeable : 1 ,
Address : 2 ,
SafeMathUpgradeable : 2 ,
AddressUpgradeable : 2 ,
SafeERC20Upgradeable : 2
}
} ,
abstract : {
total : 13 ,
names : {
StrategyBase : 1 ,
StrategySushiFarmBase : 1 ,
ReentrancyGuardUpgradeable : 1 ,
ERC721Enumerable : 1 ,
Ownable : 1 ,
ERC165 : 1 ,
BaseStrategy : 1 ,
Context : 2 ,
ContextUpgradeable : 2 ,
Initializable : 2
}
}
}
TOTAL FILES : 5
ERRORS: 1
────────────────────────────
cheers ?
@ tintinweb
ConsenSys Diligence @ https : //consensys.net/diligence/
https : //github.com/tintinweb/solgrep/ 
