تطوير العقود الذكية للكريبتو: اكتب القواعد قبل الكود

ما الذي يجب أن يقدمه التعاقد على العقد الذكي؟

اختبار سريع: صف كل وظيفة من وظائف العقد في جملة واحدة يمكن لغير المطور فهمها. إذا لم تستطع، فهذا يعني أن القاعدة ليست واضحة بعد.

تطوير العقود الذكية يترجم القواعد المتفق عليها للمنتج إلى كود يمكن اختباره وتجهيزه للإطلاق على سلسلة كتل محددة. الناتج المفيد ليس مجرد كود منفرد: بل هو تنفيذ يكون سلوكه المتوقع وحدوده وتسليمه واضحاً لفريق المنتج.

هذه الخدمة مناسبة عندما يحتاج مشروعك إلى منطق مخصص على السلسلة، مثل عقد متعلق بالتوكن، جداول فيستينغ، تدفقات ستيكينغ، أو وظائف عقد سيتصل بها تطبيق dApp. إذا كان العقد جزءاً من منتج أوسع، يمكننا مواءمة الخطة مع تطوير Web3 و تطوير dApp، بحيث يتوافق الواجهة والعقد على المدخلات والأذونات وإجراءات المستخدم.

قبل التنفيذ، جهز:

• وصفاً بلغة بسيطة لكل إجراء مستخدم ونتيجته المتوقعة.
• سلسلة الكتل التي تنوي استخدامها وأي تبعيات عقد أو منتج موجودة.
• قواعد الوصول، التوقيت، التغييرات، والحالات الاستثنائية.
• صانع قرار محدد يمكنه حل الأسئلة المفتوحة للمنتج.

إذا لم تستطع تحديد قاعدة بعد، ضع علامة عليها بأنها غير محسومة بدلاً من تركها تصبح خياراً هندسياً ضمنياً. نحول الأسئلة المفتوحة إلى قائمة مراجعة، ثم نؤكد خطة العقد معك قبل بدء التطوير.

كيف تتحول المتطلبات إلى سلوك مُختبر؟

نربط كل متطلب بسلوك عقدي قابل للملاحظة واختبار قبل اعتباره جاهزاً للإطلاق. هذا يمنح فريق المشروع طريقة عملية للتحقق مما إذا كان التنفيذ يطابق القواعد المقصودة، بدلاً من الاعتماد على وصف عام مثل "دعم الستيكينغ".

تسلسل العمل واضح: توضيح أدوار المستخدمين والإجراءات المسموح بها، تحديد تغييرات الحالة المتوقعة، تحديد المدخلات غير الصالحة أو غير المكتملة، ثم تنفيذ واختبار الحالات المتفق عليها. لكل وظيفة، يجب أن تجيب معايير القبول على ما يفعله الاستدعاء الصحيح، ومن يمكنه القيام به، وماذا يحدث عندما لا يتم استيفاء شرط. نراجع تلك المعايير مع مالك منتجك قبل أن تصبح أساساً للتطوير.

التمييز المفيد في الخطة هو بين سلوك العقد وتجربة المنتج. العقد يتعامل مع القواعد الموكلة إليه؛ التطبيق المتصل قد لا يزال بحاجة لشرح الحالات، عرض البيانات، أو توجيه المستخدمين خلال معاملة. حيث يكون كلاهما في الخطة، ننسق تلك الحدود مع تطوير dApp. بالنسبة لتوكن يحتاج إلى إنشاء ونشر بالإضافة إلى منطق مخصص، قم بمواءمة متطلبات العقد مع إنشاء ونشر التوكن.

تتلقى سجلاً قابلاً للمراجعة للسلوكيات المتفق عليها واختباراتها المقابلة. هذا يسهل تقييم تغييرات المنتج لاحقاً: يمكن للفريق تحديد القواعد الحالية المتأثرة قبل الموافقة على تحديث.

قائمة التحقق المكونة من 7 نقاط لمواصفات العقد الذكي

اكتب هذه العناصر السبعة قبل كتابة أي كود. ستصبح معايير القبول التي يتم التحقق من كل اختبار مقابلها. احتفظ بالقائمة المحددة مع سجلاتك، لأنها أسرع طريقة لشرح ما تم الاتفاق عليه لاحقاً.

1. اذكر كل عقد ومهمته الوحيدة.
2. اكتب من يمكنه استدعاء كل وظيفة.
3. حدد جداول الفيستينغ والستيكينغ بأرقام دقيقة.
4. قرر ما إذا كان يمكن ترقية العقد، ومن يقوم بذلك.
5. اذكر حالات الفشل والنتيجة المتوقعة لكل منها.
6. اختر السلسلة ومعيار التوكن.
7. خطط لمراجعة مستقلة قبل الإطلاق.

مصطلحات في سطر واحد

الفيستينغ: إصدار التوكن للحاملين تدريجياً وفق جدول زمني ثابت.

العقد القابل للترقية (بعبارة بسيطة: عقد يمكن استبدال منطقه بعد النشر).

تحديد قواعد الفيستينغ والستيكينغ

عقود الفيستينغ والستيكينغ تحتاج إلى قواعد واضحة للأهلية، التوقيت، إجراءات المستخدم، والنتائج التي يعرضها المنتج. تسمية الميزة لست كافية؛ خطة العقد يجب أن تصف الحالات التي يج أن يدعمها التنفيذ والحالات التي يج أن يرفضها.

بالنسبة للفيستينغ، قرر من يتلقى التخصيص، ما الحدث الذي يبدأ الجدول، كيف يتم حساب الإصدارات، وما إذا كانت أي تغييرات مسموحة بعد تعيين الجدول. أكد كيف يجب أن يتعامل المنتج مع مستخدم يتحقق من تخصيص أو يطلب إصداراً متاحاً. بالنسبة للستيكينغ، حدد الإجراءات التي يمكن للمشارك القيام بها، الشروط التي تنطبق على الدخول والخروج، وكيف يمثل العقد الأرصدة أو الحالات ذات الصلة. هذه متطلبات يجب تأكيدها مع فريقك، وليست إعدادات افتراضية نختارها بصمت.

استخدم قائمة التحقق هذه للتحضير:

• حدد الأدوار التي يمكنها إنشاء أو إدارة أو استخدام كل وظيفة عقد.
• اكتب قواعد التوقيت وما يعتبر إجراءً صالحاً.
• قرر كيف يجب معالجة الحالات الاستثنائية وإبلاغها.
• افصل قواعد المنتج المؤكدة عن قرارات السياسة أو التوكن التي لا تزال قيد المراجعة.

حيث يكون عرض أو توزيع التوكن جزءاً من نفس الإصدار، نسق الخطة مع إنشاء ونشر التوكن. إذا كان المستخدمون سيتفاعلون من خلال تجربة محفظة مخصصة، ناقش الاتصال مع تطوير محفظة العملات المشفرة مبكراً، بحيث تتم مراجعة متطلبات العقد والواجهة معاً.

ما يتضمنه التعاقد

قاعدة عامة: الاختبارات تظهر ما فكرت به. المراجعة المستقلة تظهر ما لم تفكر به.

التعاقد يغطي خطة العقد المتفق عليها والمواد التي يحتاجها فريقك للمراجعة والاختبار وتجهيز ذلك العمل للإطلاق. نؤكد ما تتلقاه عند بدء العمل بحيث يكون هناك تعريف مشترك للاكتمال، بما في ذلك أي عمل يعتمد على فريقك أو مدقق خارجي.

اعتماداً على الخطة المعتمدة، ما تتلقاه يمكن أن يشمل:

• ملخص مكتوب لمتطلبات العقد ومعايير القبول.
• تنفيذ عقد مخصص لسلسلة الكتل المختارة والوظائف المتفق عليها.
• اختبارات تغطي السلوكيات والحالات الحدودية المحددة أثناء التخطيط.
• ملاحظات البناء والإصدار التي تشرح ما هو جاهز للمراجعة وما لا يزال مفتوحاً.
• تنسيق تدقيق مستقل، بما في ذلك تجهيز المواد المتفق عليها وتنظيم الردود على النتائج.

تنسيق التدقيق يعني مساعدة الفريق في تجهيز تسليم مراجعة واضح وتتبع الملاحظات إلى تغييرات الكود. هو مختلف عن تمثيل أن التدقيق قد تم أو أن المدقق قد وافق على الكود. إذا كان منتجك يحتاج إلى موقع ويب أو صفحة هبوط لشرح سلوك العقد، يمكن تنسيق الخطة الفنية مع تطوير مواقع Web3 وصفحات الهبوط.

التسليم القوي يسمح لفريقك الداخلي بفهم ما تم بناؤه، وما تم اختباره، وأي القرارات تظل ملكاً لهم. نراجع ما تتلقاه مع مالك مشروعك، ونسجل التغييرات المقبولة، ونجعل حالة الإصدار واضحة قبل اعتبار العمل مكتملاً.

كيف يتم تخطيط المشروع ومراجعته؟

ينتقل المشروع من المتطلبات إلى التنفيذ من خلال نقاط مراجعة مسماة، مع تحديد التوقيت بناءً على الخطة المؤكدة. العقد الصغير المحدد جيداً والنظام متعدد الميزات لا يحتاجان نفس الخطة، لذلك نحدد أولاً ما يتم بناؤه ومن سيتخذ القرارات.

عند بدء العمل، نتحقق من سلسلة الكتل المختارة، تبعيات العقد، قواعد المنتج، الكود الموجود، والأشخاص المسؤولين عن الموافقات. أثناء التطوير، نشارك التقدم مقابل المتطلبات المتفق عليها ونطرح الأسئلة التي قد تغير السلوك قبل أن تصبح مفاجآت في اللحظة الأخيرة. تراجع أنت التنفيذ مقابل معايير القبول، ونلتقط التغييرات المطلوبة كعناصر محددة للتأكيد.

الجدول الزمني يأخذ في الاعتبار أيضاً المراجعة الخارجية عند الطلب. ننسق عندما تكون المواد جاهزة، ونربط ملاحظات المدقق بالمتطلب ذي الصلة، ونؤكد أي تغييرات مدرجة في الخطة المتفق عليها. يجب على فريقك التخطيط لتقديم إجابات سريعة لأسئلة المنتج والوصول؛ القرارات غير المحسومة يمكن أن تعيق التنفيذ أو تحضير الإصدار.

للحفاظ على سهولة تقييم العمل، اطلب تحديثاً للتقدم يفصل العناصر المكتملة، القرارات المفتوحة، حالة الاختبار، والإجراءات التالية. MarketingExtra تستخدم مراجعة مباشرة بين المهندس والعميل لمعايير القبول وتغطية الاختبار، بحيث يمكن للأشخاص الذين يوافقون على سلوك المنتج رؤية ما يهدف كل اختبار إلى إثباته. يتم تأكيد خطة التسليم الناتجة معك قبل المتابعة في البناء.

ما يجب معرفته قبل إصدار الكود

عملية التطوير الدقيقة تحسن قابلية المراجعة، لكن الاختبار وتنسيق التدقيق لا يزيلان كل مخاطر الإصدار. الاختبارات يمكنها فقط التحقق من الحالات التي تغطيها، والمدقق المستقل قد يحدد مشكلات أو يطلب تغييرات؛ يجب أن ينتظر النشر حتى يوافق فريقك على الإصدار الدقيق والشبكة المستهدفة.

للتسليم المسؤول، تأكد من أن النسخة المنشورة تطابق النسخة التي راجعها فريقك، وأن أذونات الإصدار مفهومة، وأن للمشروع مالكاً للأسئلة بعد الإصدار. احتفظ بسجل للمتطلبات المقبولة، نتائج الاختبار، ملاحظات المدقق حيثما ينطبق، وقرار الإصدار النهائي. هذه المواد تساعد فريقك على تمييز العمل المُتحقق منه عن القرارات أو مسؤوليات التشغيل التي تبقى خارج خطة التطوير.

إذا كان تطوير العقد جزءاً من بناء أكبر، قم بمواءمة خطة الإصدار مع خطة تطوير Web3 الأوسع بدلاً من معاملة العقد كخط نهاية منفصل. شارك سلسلة الكتل المستهدفة، وصفاً موجزاً لغرض العقد، وأي مواصفات أو كود موجود مع MarketingExtra. سنراجع المواد، ونحدد قرارات المنتج غير المجابة، ونعيد خطة مكتوبة للعمل.

أرسل 3 أشياء: قواعد منتجك، سلسلة الكتل المستهدفة، والجدول الزمني للمراجعة.

كيف نعمل

1. شارك قواعد المنتجأرسل سلوك العقد المقصود، سلسلة الكتل المستهدفة، الكود أو المواصفات الموجودة، وأي تبعيات معروفة. ضع علامة واضحة على القرارات غير المحسومة.
2. تأكيد الخطة ومعايير القبولنراجع الأدوار، الإجراءات، الحالات الاستثنائية، وما تتلقاه مع صانع القرار لديك. المعايير المتفق عليها تحدد ما سيغطيه التطوير والاختبار.
3. بناء واختبار السلوك المتفق عليهينفذ المهندس العقد المخطط ويفحصه مقابل حالات الاختبار المقبولة. الأسئلة التي تؤثر على السلوك تعاد إليك لاتخاذ القرار.
4. تنسيق المراجعة المستقلةإذا كان تنسيق التدقيق مضمنًا، نقوم بتجهيز المواد المتفق عليها، تنظيم الملاحظات، وتتبع التغييرات المطلوبة مع فريقك.
5. مراجعة تسليم الإصدارتراجع ما تتلقاه نهائياً، سجل الاختبار، والعناصر المفتوحة قبل الموافقة على خطة الإصدار للشبكة المختارة.