Caracal

Caracal, Starknet स्मार्ट कॉन्ट्रैक्ट्स के लिए SIERRA प्रतिनिधित्व पर एक स्थैतिक विश्लेषक उपकरण है।

विशेषताएँ

• कमजोर Cairo कोड का पता लगाने के लिए डिटेक्टर
• जानकारी रिपोर्ट करने के लिए प्रिंटर
• टैंट विश्लेषण
• डेटा प्रवाह विश्लेषण ढाँचा
• Scarb प्रोजेक्ट्स में चलाना आसान

स्थापना

पूर्व-संकलित बाइनरी

पूर्व-संकलित बाइनरी हमारे रिलीज़ पेज पर उपलब्ध हैं। यदि आप Cairo कंपाइलर 1.x.x का उपयोग कर रहे हैं तो बाइनरी v0.1.x का उपयोग करें, अन्यथा यदि आप Cairo कंपाइलर 2.x.x का उपयोग कर रहे हैं तो v0.2.x का उपयोग करें।

स्रोत से निर्माण

आपको Rust कंपाइलर और Cargo की आवश्यकता है। Git से निर्माण:

cargo install --git https://github.com/crytic/caracal --profile release --force

स्थानीय प्रतिलिपि से निर्माण:

git clone https://github.com/crytic/caracal
cd caracal
cargo install --path . --profile release --force

उपयोग

डिटेक्टरों की सूची बनाएँ:

caracal detectors

प्रिंटरों की सूची बनाएँ:

caracal printers

स्टैंडअलोन

एक स्टैंडअलोन cairo फ़ाइल के साथ उपयोग करने के लिए और यदि आपके पास स्थानीय cairo कंपाइलर बाइनरी है तो यह फ़ाइल को इंगित करने के लिए पर्याप्त है। अन्यथा एक बंडल कंपाइलर का उपयोग किया जाता है और आपको --corelib CLI विकल्प या CORELIB_PATH पर्यावरण चर सेट करके corelib लाइब्रेरी का पथ प्रदान करना होगा।
डिटेक्टर चलाएँ:

caracal detect path/file/to/analyze

caracal detect path/file/to/analyze --corelib path/to/corelib/src

प्रिंटर चलाएँ:

caracal print path/file/to/analyze --printer printer_to_use --corelib path/to/corelib/src

Cairo प्रोजेक्ट

यदि आपके पास कई फ़ाइलों और कॉन्ट्रैक्ट्स वाला cairo प्रोजेक्ट है तो आपको --contract-path के साथ कॉन्ट्रैक्ट्स निर्दिष्ट करने की आवश्यकता हो सकती है। स्थानीय cairo कंपाइलर बाइनरी का उपयोग किया जाता है यदि उपलब्ध हो अन्यथा बंडल कंपाइलर का उपयोग किया जाता है। बाद के मामले में आपको ऊपर स्टैंडअलोन मामले के रूप में corelib निर्दिष्ट करने की भी आवश्यकता है। पथ वह निर्देशिका है जहाँ cairo_project.toml स्थित है।
डिटेक्टर चलाएँ:

caracal detect path/to/dir

caracal detect path/to/dir --contract-path token::myerc20::... token::myerc721::...

प्रिंटर चलाएँ:

caracal print path/to/dir --printer printer_to_use

Scarb

यदि आपके पास Scarb का उपयोग करने वाला प्रोजेक्ट है तो आपको Scarb.toml में निम्नलिखित जोड़ने की आवश्यकता है:

[[target.starknet-contract]]
sierra = true

[cairo]
sierra-replace-ids = true

फिर वह पथ पास करें जहाँ Scarb.toml स्थित है। डिटेक्टर चलाएँ:

caracal detect path/to/dir

प्रिंटर चलाएँ:

caracal print path/to/dir --printer printer_to_use

डिटेक्टर

Cairo स्तंभ उन कंपाइलर संस्करण(ों) को दर्शाता है जिनके लिए डिटेक्टर मान्य है।

प्रिंटर

• cfg: प्रत्येक फ़ंक्शन के CFG को .dot फ़ाइल में निर्यात करें
• callgraph: फ़ंक्शन कॉल ग्राफ को .dot फ़ाइल में निर्यात करें

योगदान कैसे करें

निम्नलिखित विषयों पर विकी देखें:

• डिटेक्टर कैसे लिखें
• प्रिंटर कैसे लिखें

सीमाएँ

• इनलाइन किए गए फ़ंक्शन सही ढंग से संभाले नहीं जाते।
• चूँकि यह SIERRA प्रतिनिधित्व पर काम करता है, इसलिए यह रिपोर्ट करना संभव नहीं है कि स्रोत कोड में त्रुटि कहाँ है, लेकिन हम केवल SIERRA निर्देश/जो कुछ SIERRA प्रोग्राम में उपलब्ध है, रिपोर्ट कर सकते हैं।