مواد پر جائیں

تحریریں

Smart contract audit کی تیاری کی چیک لسٹ

Smart contract audit سے پہلے 30 چیکس: scope اور documentation، tests، Foundry fuzz اور invariant tests، Slither triage، access control، integrations اور deployment۔

sigmacode.io انجینئرنگ ٹیم8 منٹ کی قراءت

اس صفحے پر (9)
  1. 1. Scope اور documentation
  2. 2. Code hygiene اور static analysis
  3. 3. Tests
  4. 4. Fuzz اور invariant testing
  5. 5. Access control اور upgradeability
  6. 6. External integrations
  7. 7. Deployment اور operations
  8. 8. Audit کی logistics
  9. ہم کیسے مدد کر سکتے ہیں

smart contract audit مہنگا اور سخت محدود وقت والا ہوتا ہے۔ auditors کو دنوں کی ایک مقررہ تعداد ملتی ہے، اور ہر گھنٹہ جو وہ یہ سمجھنے میں لگاتے ہیں کہ code کو کرنا کیا چاہیے، کسی بدلتے ہوئے commit کے پیچھے بھاگنے میں یا وہ tests لکھنے میں جو آپ نے نہیں لکھے — وہ گھنٹہ اس logic پر نہیں لگتا جو واقعی فنڈز کھو سکتی ہے۔ پھر findings report غائب NatSpec، floating pragmas اور untested revert paths سے بھر جاتی ہے، بجائے ان مسائل کے جن کی تلاش کے لیے آپ پیسے دے رہے ہیں۔

اسی بجٹ میں اچھی طرح تیار شدہ codebase کو گہرا audit ملتا ہے۔ یہ چیک لسٹ وہ سب جمع کرتی ہے جو ہم code کو کسی external auditor کے حوالے کرنے سے پہلے مرتب کرتے ہیں: documentation، code hygiene، testing، access control، integrations، deployment اور logistics پر محیط 30 ٹھوس چیکس۔ یہ audit کا بدل نہیں ہے؛ یہ یقینی بناتی ہے کہ audit کا وقت وہاں لگے جہاں اہمیت ہے۔

1. Scope اور documentation#

auditors صرف اس intent کے خلاف رویّے کی تصدیق کر سکتے ہیں جسے وہ سمجھتے ہیں، اس لیے intent کو لکھا ہونا چاہیے۔

  • ایک commit hash freeze کریں۔ auditors کو ایک tagged commit دیں اور engagement کے دوران review کے تحت code کو نہ بدلیں۔ fixes ایک الگ branch پر جائیں اور fix-review round میں review ہوں۔
  • nSLOC کے ساتھ scope کی فائل فہرست publish کریں۔ scope میں موجود ہر contract کو اس کے path اور normalised source lines of code کے ساتھ فہرست کریں، اور واضح طور پر بتائیں کہ کیا out of scope ہے (libraries، mocks، scripts، پہلے سے audited files)۔ auditors nSLOC کی بنیاد پر قیمت اور منصوبہ بناتے ہیں، اس لیے درست گنتی دونوں اطراف کو حیرت و جھٹکے سے بچاتی ہے۔
  • architecture کا جائزہ لکھیں۔ ایک دو صفحات جو contracts، آپس میں ان کے calls، کون سے contracts فنڈز رکھتے ہیں اور بنیادی user flows بیان کریں۔ calls اور token flows کا ایک سادہ diagram auditors کے reverse engineering کے گھنٹے بچا دیتا ہے۔
  • نثر میں رویّہ اور invariants کی وضاحت کریں۔ بیان کریں کہ ہر external function کو کیا کرنا چاہیے اور کن properties کو ہمیشہ قائم رہنا چاہیے، مثلاً "user balances کا مجموعہ totalAssets کے برابر ہو" یا "صرف timelock fees بدل سکے"۔ یہ بیانات auditors کے review اور آپ کے اپنے invariant tests دونوں کی بنیاد بنتے ہیں۔
  • معروف مسائل اور قبول شدہ خطرات کو document کریں۔ وہ limitations فہرست کریں جن سے آپ پہلے سے واقف ہیں اور وہ design فیصلے جو آپ قبول کرتے ہیں، جیسے centralisation کے trade-offs یا unsupported token types۔ اس سے وہ findings report سے باہر رہتے ہیں اور auditors کو دکھاتا ہے کہ کہاں آپ پہلے ہی غور کر چکے ہیں۔

2. Code hygiene اور static analysis#

codebase میں شور audit کا وقت کھاتا ہے اور کم قیمت کی findings پیدا کرتا ہے، اس لیے auditors کے دیکھنے سے پہلے اسے ہٹا دیں۔

  • compiler کو pin کریں اور zero warnings تک پہنچیں۔ floating ^0.8.0 کے بجائے exact pragma solidity 0.8.x; استعمال کریں، اور foundry.toml میں version، optimizer runs، via_ir اور evm_version کو اس سے match کریں جو آپ deploy کریں گے۔ ہر compiler warning کو یا تو fix کیا جائے یا شعوری طور پر explain کیا جائے۔
  • dependencies کو pin اور فہرست کریں۔ OpenZeppelin Contracts اور ہر دوسری library کو exact release پر lock کریں، مثلاً کوئی tagged v5.x submodule یا package.json میں exact version۔ audit documentation میں تمام dependencies فہرست کریں اور ان files کو نشان زد کریں جو آپ نے copy یا modify کی ہیں۔
  • dead code، TODOs اور debug output ہٹائیں۔ scoped contracts سے unused functions، commented-out code، console.log imports اور بچے ہوئے test helpers delete کریں۔ کھلے TODOs ادھورے logic کا اشارہ دیتے ہیں اور اسی طرح report ہوں گے۔
  • external اور public functions پر NatSpec مکمل کریں۔ ہر external اور public function میں @notice، @param، @return اور جہاں متعلق ہو access control اور reverts پر نوٹ ہونا چاہیے۔ custom errors استعمال کریں اور ہر اس state change کے لیے events emit کریں جو off-chain اہم ہے۔
  • Slither چلائیں اور ہر finding کی triage کریں۔ frozen commit پر slither چلائیں اور ہر finding کو fixed، false positive یا accepted کے طور پر درجہ بند کریں، ایک سطر کی justification کے ساتھ۔ Aderyn جیسا دوسرا tool اکثر مختلف patterns پکڑتا ہے، اور triage شدہ output share کرنا auditors کو بتاتا ہے کہ کون سی automated findings پہلے ہی handle ہو چکی ہیں۔

3. Tests#

tests auditors کو دکھاتے ہیں کہ code کو کیسے استعمال ہونا چاہیے اور انہیں proofs of concept جلدی لکھنے دیتے ہیں۔

  • ہر external function کو cover کریں اور report publish کریں۔ ہر external اور public function کو happy path کا کم از کم ایک test چاہیے۔ forge coverage سے line اور branch coverage report بنائیں اور uncovered branches کو چھپانے کے بجائے explain کریں۔
  • revert paths اور edge cases کو test کریں۔ vm.expectRevert کے ذریعے یہ assert کریں کہ unauthorised calls، invalid parameters، zero amounts اور boundary values متوقع custom error کے ساتھ revert ہوں۔ untested revert paths وہ جگہ ہیں جہاں validation اور access-control کے bugs چھپتے ہیں۔
  • حقیقی integrations کے خلاف fork tests چلائیں۔ اگر protocol DEXes، lending markets یا oracles جیسے external contracts سے بات کرتا ہے تو pinned block numbers کے ساتھ mainnet یا L2 fork کے خلاف test کریں۔ mocks صرف یہ ثابت کرتے ہیں کہ آپ کا code دوسری طرف کے بارے میں آپ کے مفروضات کے ساتھ کام کرتا ہے۔

4. Fuzz اور invariant testing#

Fuzzing وہ input combinations ڈھونڈتی ہے جن کا کسی نے خیال نہیں کیا، اور invariant tests چیک کرتے ہیں کہ calls کی ترتیبوں میں system مستقل رہتا ہے۔

  • ہر اس function کو fuzz کریں جو numeric input لیتا ہے۔ amounts، timestamps، share calculations اور fee math کے لیے Foundry fuzz tests لکھیں، اور inputs کو bound() سے constrain کریں، نہ کہ excessive vm.assume سے۔ rounding direction اور extreme values پر overflow عام اہداف ہیں۔
  • handlers کے ساتھ stateful invariant tests لکھیں۔ Foundry invariant testing کو handler contracts کے ساتھ استعمال کریں جو کئی actors سے حقیقی ترتیبوں میں system کو call کریں۔ ہر call sequence کے بعد solvency، value کے تحفظ اور access-control properties چیک کریں۔
  • لکھے گئے invariants اور test suite کو sync میں رکھیں۔ آپ کی specification کا ہر invariant کسی invariant test پر map ہو، اور ہر invariant test specification تک trace ہو۔ suite کو CI میں runs اور depth کی ایک بامعنی تعداد کے ساتھ چلائیں، نہ کہ صرف locally defaults کے ساتھ۔

5. Access control اور upgradeability#

privileged functions اور upgrades system کے ہر asset کو منتقل یا lock کر سکتے ہیں، اس لیے trust model کو واضح ہونا چاہیے۔

  • ہر privileged role اور function کو فہرست کریں۔ ہر role کو document کریں، وہ کون سے functions call کر سکتا ہے، کون اسے رکھتا ہے، اور اگر اس کی key compromise ہو جائے تو بدترین صورت کیا ہوگی۔ یہ trust assumptions کا وہ حصہ ہے جو auditors سب سے پہلے مانگیں گے۔
  • admin طاقت کو multisig اور timelock کے پیچھے رکھیں۔ critical parameters اور upgrades کو Safe جیسے multisig سے کنٹرول کیا جانا چاہیے، اور user فنڈز پر اثر ڈالنے والی تبدیلیوں کے لیے TimelockController یا اس جیسی delay کے ساتھ۔ signer threshold اور delay کو document کریں۔
  • upgradeable contracts کے لیے storage layout چیک کریں۔ proxies کے لیے OpenZeppelin v5 upgradeable contracts کو ERC-7201 namespaced storage کے ساتھ استعمال کریں اور upgrades کو OpenZeppelin upgrades tooling سے validate کریں۔ اگر upgrade scope میں ہے تو versions کے درمیان storage layout کا diff شامل کریں۔
  • initializers اور upgrade functions کی حفاظت کریں۔ implementation constructor میں _disableInitializers() call کریں، initializer اور reinitializer modifiers کو درست استعمال کریں اور UUPS proxies (ERC-1822) کے لیے _authorizeUpgrade کو محدود کریں۔ ایک unprotected implementation contract ایسی finding ہے جسے auditors کو کبھی report نہ کرنا پڑے۔

6. External integrations#

ہر external call کسی اور کے code کے بارے میں ایک مفروضہ ہے، اور ہر مفروضے کو لکھا اور test کیا جانا چاہیے۔

  • oracle کے staleness اور failure کو handle کریں۔ feed کے heartbeat کے خلاف updatedAt چیک کریں، صفر یا منفی prices کو مسترد کریں، اور L2s پر sequencer uptime feed چیک کریں۔ طے کریں کہ oracle unavailable ہونے پر protocol کیا کرتا ہے اور اسے document کریں۔
  • token کی خصوصیات کا حساب رکھیں۔ بتائیں کہ کون سے token types supported ہیں اور fee-on-transfer، rebasing، non-18-decimal اور non-standard ERC-20 tokens کو handle کریں یا explicitly خارج کریں۔ transfers کے لیے SafeERC20 استعمال کریں اور جہاں وصول شدہ رقم اہم ہو وہاں balance کے فرق ناپیں۔
  • reentrancy surfaces کا نقشہ بنائیں۔ ہر external call اور token transfer کو فہرست کریں، checks-effects-interactions کی پیروی کریں اور جہاں state shared ہو وہاں ReentrancyGuard (یا EIP-1153 کے ساتھ ReentrancyGuardTransient) استعمال کریں۔ cross-function اور read-only reentrancy، اور ERC-721، ERC-1155 اور ERC-777 tokens کے callbacks پر غور کریں۔
  • MEV اور front-running پر غور کریں۔ swaps اور deposits پر slippage limits اور deadlines لگائیں، ERC-4626 vaults کو first-depositor inflation attack سے بچائیں اور ہر اس logic کا review کریں جو transaction ordering پر منحصر ہو۔ document کریں کہ آپ کون سے ordering خطرات قبول کرتے ہیں۔

7. Deployment اور operations#

audited code اتنا ہی محفوظ ہے جتنا اس کے deploy اور چلانے کا طریقہ۔

  • deploy scripts کو reproducible اور parameters کو documented بنائیں۔ frozen commit سے Foundry scripts کے ساتھ deploy کریں، ہر constructor اور initializer parameter کو version-controlled config میں رکھیں اور scripts کو audit scope یا کم از کم handoff میں شامل کریں۔ غلط parameters کے ساتھ deploy کیا ہوا درست contract بھی ٹوٹا ہوا ہے۔
  • verified sources کے ساتھ testnet پر مشق کریں۔ بالکل وہی deployment script testnet اور mainnet fork پر چلائیں، block explorer پر sources verify کریں اور چیک کریں کہ roles intended addresses کو ملے۔ auditors کو testnet addresses دیں تاکہ وہ حقیقی deployment کے ساتھ interact کر سکیں۔
  • pause، runbook اور monitoring تیار کریں۔ طے کریں کہ کون کیا pause کر سکتا ہے، ایک مختصر incident runbook لکھیں اور role کی تبدیلیوں، upgrades، بڑی withdrawals اور paused states کے لیے alerts لگائیں۔ auditors emergency paths کا review کریں گے، اس لیے ان کا audit سے پہلے موجود ہونا ضروری ہے۔

8. Audit کی logistics#

اچھی logistics audit کو چلتی رکھتی ہے اور یقینی بناتی ہے کہ fix round واقعی استعمال ہو۔

  • ایک technical رابطہ شخص اور ایک channel مقرر کریں۔ ایک ایسا developer تفویض کریں جو codebase جانتا ہو اور گھنٹوں میں سوالوں کے جواب دے سکے، اور audit کی مدت کے لیے ایک shared channel پر اتفاق کریں۔ ہر غیر جواب شدہ سوال review کو روک دیتا ہے۔
  • fixes اور fix-review round کے لیے وقت رکھیں۔ report آنے کے فوراً بعد developer کی گنجائش plan کریں اور پہلے سے اس پر اتفاق کریں کہ auditors fixes کا review کریں گے۔ unreviewed fixes audit کے sign-off کے بعد نئے bugs لا سکتی ہیں۔
  • پچھلے audits اور reviews ظاہر کریں۔ پہلے کی audit reports، ان کا fix status اور کوئی internal reviews share کریں۔ پھر auditors اس پر توجہ دے سکتے ہیں کہ کیا بدلا اور چیک کر سکتے ہیں کہ پہلی findings regress نہیں ہوئیں۔

ہم کیسے مدد کر سکتے ہیں#

ہم ایک سے دو ہفتے کا fixed-scope Audit-Readiness Sprint پیش کرتے ہیں: threat model، test-suite کا gap analysis، Foundry fuzz اور invariant tests، Slither triage، fixes کی ترجیحی فہرست اور scope، documentation اور known issues کے ساتھ audit handoff pack۔ ہم کوئی audit firm نہیں اور یہ sprint کسی external audit کا بدل نہیں؛ یہ آپ کے code کو اس قابل بناتا ہے کہ auditors اپنا وقت logic پر لگا سکیں۔ تفصیلات ہمارے pricing page اور ہماری Blockchain & Web3 services پر موجود ہیں۔

اگر آپ اپنی codebase کے لیے مفت estimate چاہتے ہیں تو اپنے پروجیکٹ کے بارے میں بتائیں۔ آپ کوئی code share کرنے سے پہلے ہمیں mutual NDA پر دستخط کرنے میں خوشی ہوگی۔

کوئی پروجیکٹ ذہن میں ہے؟

ہمیں بتائیں کہ آپ کیا بنا رہے ہیں۔ کام کے دنوں میں ایک سینئر انجینئر ایک گھنٹے کے اندر جواب دیتا ہے — پھر آپ کو دیانتدارانہ جائزہ، واضح دائرۂ کار اور مقررہ قیمت یا سنگ میل پر مبنی تجویز ملتی ہے، عام طور پر چند کام کے دنوں میں۔

پہلے لکھنا پسند کریں گے؟ ہمیں لکھیں

آپ براہِ راست Ing. Ismet Mesic، ٹیک لیڈ سے بات کریں گے۔