Pengembangan kontrak cerdas: tulis aturannya sebelum kode

Apa yang harus dihasilkan oleh sebuah engagement kontrak?

Tes cepat: Deskripsikan setiap fungsi kontrak dalam satu kalimat yang dapat diikuti oleh non-pengembang. Jika Anda tidak bisa, aturannya belum jelas.

Pengembangan kontrak cerdas menerjemahkan aturan produk yang disepakati menjadi kode yang dapat diuji dan disiapkan untuk rilis di blockchain yang dipilih. Hasil yang berguna bukanlah kode secara terpisah: melainkan implementasi yang perilaku yang diharapkan, batasan, dan serah terimanya jelas bagi tim produk.

Layanan ini cocok ketika proyek Anda membutuhkan logika on-chain kustom, seperti kontrak terkait token, jadwal vesting, alur staking, atau fungsi kontrak yang akan dipanggil oleh dApp. Jika kontrak adalah salah satu bagian dari produk yang lebih luas, kami dapat menyelaraskan rencana dengan Pengembangan Web3 dan Pengembangan dApp, sehingga antarmuka dan kontrak sepakat tentang input, izin, dan tindakan pengguna.

Sebelum implementasi, siapkan:

• Deskripsi bahasa sederhana dari setiap tindakan pengguna dan hasil yang diharapkan.
• Blockchain yang ingin Anda gunakan dan ketergantungan kontrak atau produk yang ada.
• Aturan untuk akses, waktu, perubahan, dan kasus luar biasa.
• Seorang pengambil keputusan yang ditunjuk yang dapat menyelesaikan pertanyaan produk yang terbuka.

Jika Anda belum dapat menentukan suatu aturan, tandai sebagai belum diputuskan daripada membiarkannya menjadi pilihan rekayasa implisit. Kami mengubah pertanyaan terbuka menjadi daftar review, lalu mengonfirmasi rencana kontrak dengan Anda sebelum pengembangan dimulai.

Bagaimana persyaratan menjadi perilaku yang teruji?

Kami memetakan setiap persyaratan ke perilaku kontrak yang dapat diamati dan sebuah pengujian sebelum memperlakukannya sebagai siap rilis. Itu memberi tim produk cara praktis untuk memeriksa apakah implementasi sesuai dengan aturan yang dimaksud, daripada mengandalkan deskripsi luas seperti “mendukung staking.”

Urutan kerjanya sederhana: perjelas peran pengguna dan tindakan yang diizinkan, tentukan perubahan status yang diharapkan, identifikasi input yang tidak valid atau tidak lengkap, lalu implementasikan dan uji kasus yang disepakati. Untuk setiap fungsi, kriteria penerimaan harus menjawab apa yang dilakukan panggilan yang valid, siapa yang boleh melakukannya, dan apa yang harus terjadi ketika suatu kondisi tidak terpenuhi. Kami meninjau kriteria tersebut dengan pemilik produk Anda sebelum menjadi dasar pengembangan.

Perbedaan rencana yang berguna adalah antara perilaku kontrak dan pengalaman produk. Kontrak menangani aturan yang ditugaskan padanya; aplikasi yang terhubung mungkin masih perlu menjelaskan status, menampilkan data, atau memandu pengguna melalui transaksi. Jika keduanya ada dalam rencana, kami mengoordinasikan batasan itu dengan Pengembangan dApp. Untuk token yang membutuhkan pembuatan dan deployment serta logika kustom, selaraskan persyaratan kontrak dengan pembuatan dan deployment token.

Anda menerima catatan yang dapat direview dari perilaku yang disepakati dan pengujian yang sesuai. Itu membuat perubahan produk di kemudian hari lebih mudah dinilai: tim dapat mengidentifikasi aturan mana yang terpengaruh sebelum menyetujui pembaruan.

Checklist spesifikasi kontrak 7 poin Anda

Tulis 7 item ini sebelum kode apa pun ditulis. Item-item ini menjadi kriteria penerimaan yang akan diperiksa oleh setiap pengujian. Simpan daftar yang sudah dicentang dengan catatan Anda, karena ini adalah cara tercepat untuk menjelaskan nanti apa yang telah disepakati.

1. Daftar setiap kontrak dan satu tugasnya.
2. Tulis siapa yang boleh memanggil setiap fungsi.
3. Tentukan jadwal vesting dan staking dengan angka yang tepat.
4. Putuskan apakah kontrak dapat di-upgrade, dan oleh siapa.
5. Daftar kasus kegagalan dan hasil yang diharapkan untuk masing-masing.
6. Pilih rantai dan standar token.
7. Rencanakan review independen sebelum rilis.

Istilah dalam satu baris

Vesting: melepaskan token kepada pemegang secara bertahap dengan jadwal tetap.

Kontrak yang dapat di-upgrade (dengan kata sederhana: kontrak yang logikanya dapat diganti setelah deployment).

Menentukan aturan vesting dan staking

Kontrak vesting dan staking membutuhkan aturan yang eksplisit untuk kelayakan, waktu, tindakan pengguna, dan hasil yang ditampilkan produk. Menyebutkan fitur saja tidak cukup; rencana kontrak harus menjelaskan kasus yang harus didukung implementasi dan kasus yang harus ditolak.

Untuk vesting, putuskan siapa yang menerima alokasi, peristiwa apa yang memulai jadwal, bagaimana pelepasan dihitung, dan apakah ada perubahan yang diizinkan setelah jadwal ditetapkan. Konfirmasi bagaimana produk harus menangani pengguna yang memeriksa alokasi atau meminta pelepasan yang tersedia. Untuk staking, tentukan tindakan yang dapat dilakukan peserta, kondisi apa yang berlaku untuk masuk dan keluar, dan bagaimana kontrak mewakili saldo atau status yang relevan. Ini adalah persyaratan untuk dikonfirmasi dengan tim Anda, bukan pengaturan default yang kami pilih secara diam-diam.

Gunakan checklist persiapan ini:

• Identifikasi peran yang dapat membuat, mengelola, atau menggunakan setiap fungsi kontrak.
• Tulis aturan waktu dan apa yang dianggap sebagai tindakan yang valid.
• Putuskan bagaimana kasus luar biasa harus ditangani dan dikomunikasikan.
• Pisahkan aturan produk yang dikonfirmasi dari keputusan kebijakan atau token yang masih ditinjau.

Jika pasokan atau distribusi token adalah bagian dari rilis yang sama, koordinasikan rencana dengan pembuatan dan deployment token. Jika pengguna akan berinteraksi melalui pengalaman wallet khusus, diskusikan koneksi dengan pengembangan wallet kripto sejak awal, sehingga persyaratan kontrak dan antarmuka ditinjau bersama.

Apa yang termasuk dalam engagement?

Aturan praktis: Pengujian menunjukkan apa yang Anda pikirkan. Review independen menunjukkan apa yang tidak Anda pikirkan.

Engagement mencakup rencana kontrak yang disepakati dan materi yang dibutuhkan tim Anda untuk meninjau, menguji, dan mempersiapkan pekerjaan tersebut untuk rilis. Kami mengonfirmasi apa yang Anda terima saat kickoff sehingga ada definisi penyelesaian yang sama, termasuk pekerjaan apa pun yang bergantung pada tim Anda atau auditor eksternal.

Tergantung pada rencana yang disetujui, apa yang Anda terima dapat mencakup:

• Ringkasan tertulis dari persyaratan kontrak dan kriteria penerimaan.
• Implementasi kontrak kustom untuk blockchain yang dipilih dan fungsi yang disepakati.
• Pengujian yang mencakup perilaku dan kasus tepi yang ditentukan selama perencanaan.
• Catatan build dan rilis yang menjelaskan apa yang siap untuk ditinjau dan apa yang masih terbuka.
• Koordinasi audit independen, termasuk mengemas materi yang disepakati dan mengatur tanggapan terhadap temuan.

Koordinasi audit berarti membantu tim menyiapkan serah terima review yang jelas dan melacak umpan balik ke dalam perubahan kode. Ini berbeda dengan menyatakan bahwa audit telah terjadi atau bahwa auditor telah menyetujui kode. Jika produk Anda membutuhkan situs web atau landing page untuk menjelaskan perilaku kontrak, rencana teknis dapat dikoordinasikan dengan Pengembangan situs web dan landing Web3.

Serah terima yang kuat memungkinkan tim internal Anda memahami apa yang dibangun, apa yang diuji, dan keputusan mana yang tetap menjadi keputusan mereka. Kami meninjau apa yang Anda terima dengan pemilik proyek Anda, mencatat perubahan yang diterima, dan memperjelas status rilis sebelum pekerjaan dianggap selesai.

Bagaimana proyek direncanakan dan ditinjau?

Proyek bergerak dari persyaratan ke implementasi melalui titik review yang disebutkan, dengan waktu yang ditentukan dari rencana yang dikonfirmasi. Kontrak kecil yang terdefinisi dengan baik dan sistem multi-fitur tidak memerlukan rencana yang sama, jadi pertama-tama kami menetapkan apa yang sedang dibangun dan siapa yang akan membuat keputusan.

Pada kickoff, kami memeriksa blockchain yang dipilih, ketergantungan kontrak, aturan produk, kode yang ada, dan orang-orang yang bertanggung jawab atas persetujuan. Selama pengembangan, kami membagikan kemajuan terhadap persyaratan yang disepakati dan mengajukan pertanyaan yang dapat mengubah perilaku sebelum menjadi kejutan di menit-menit terakhir. Anda meninjau implementasi terhadap kriteria penerimaan, dan kami menangkap perubahan yang diminta sebagai item spesifik untuk konfirmasi.

Jadwal juga memperhitungkan review eksternal jika diminta. Kami berkoordinasi ketika materi siap, menjaga umpan balik auditor tetap terhubung dengan persyaratan yang relevan, dan mengonfirmasi perubahan mana yang termasuk dalam rencana yang disepakati. Tim Anda harus merencanakan untuk memberikan jawaban cepat atas pertanyaan produk dan akses; keputusan yang belum terselesaikan dapat menunda implementasi atau persiapan rilis.

Untuk menjaga agar pekerjaan mudah dinilai, mintalah pembaruan kemajuan yang memisahkan item yang selesai, keputusan terbuka, status pengujian, dan tindakan selanjutnya. MarketingExtra menggunakan review langsung engineer-ke-klien tentang kriteria penerimaan dan cakupan pengujian, sehingga orang yang menyetujui perilaku produk dapat melihat apa yang ingin ditetapkan oleh setiap pengujian. Rencana pengiriman yang dihasilkan dikonfirmasi dengan Anda sebelum build berlangsung.

Apa yang perlu diketahui sebelum Anda merilis kode?

Proses pengembangan yang cermat meningkatkan kemampuan review, tetapi pengujian dan koordinasi audit tidak menghilangkan setiap risiko rilis. Pengujian hanya dapat memeriksa kasus yang mereka cakup, dan auditor independen dapat mengidentifikasi masalah atau meminta perubahan; deployment harus menunggu sampai tim Anda menyetujui rilis yang tepat dan jaringan target.

Untuk serah terima yang bertanggung jawab, konfirmasi bahwa versi yang di-deploy sesuai dengan versi yang ditinjau tim Anda, bahwa izin rilis dipahami, dan bahwa proyek memiliki pemilik untuk pertanyaan pasca-rilis. Simpan catatan persyaratan yang diterima, hasil pengujian, umpan balik auditor jika berlaku, dan keputusan rilis akhir. Materi ini membantu tim Anda membedakan pekerjaan yang terverifikasi dari keputusan atau tanggung jawab operasional yang tetap berada di luar rencana pengembangan.

Jika pengembangan kontrak adalah bagian dari build yang lebih besar, selaraskan rencana rilis dengan rencana Pengembangan Web3 yang lebih luas daripada memperlakukan kontrak sebagai garis finish yang terpisah. Bagikan blockchain target Anda, deskripsi singkat tentang tujuan kontrak, dan spesifikasi atau kode yang ada dengan MarketingExtra. Kami akan meninjau materi, mengidentifikasi keputusan produk yang belum terjawab, dan mengembalikan rencana tertulis untuk pekerjaan tersebut.

Kirim 3 hal: aturan produk Anda, rantai target Anda, dan jadwal Anda untuk review.

Cara kerja

1. Bagikan aturan produkKirim perilaku kontrak yang dimaksud, blockchain target, kode atau spesifikasi yang ada, dan ketergantungan yang diketahui. Tandai keputusan yang belum terselesaikan dengan jelas.
2. Konfirmasi rencana dan kriteria penerimaanKami meninjau peran, tindakan, kasus luar biasa, dan apa yang Anda terima dengan pengambil keputusan Anda. Kriteria yang disepakati menetapkan apa yang akan dicakup oleh pengembangan dan pengujian.
3. Bangun dan uji perilaku yang disepakatiInsinyur mengimplementasikan kontrak yang direncanakan dan memeriksanya terhadap kasus uji yang diterima. Pertanyaan yang mempengaruhi perilaku dibawa kembali untuk keputusan Anda.
4. Koordinasikan review independenJika koordinasi audit termasuk, kami menyiapkan materi yang disepakati, mengatur umpan balik, dan melacak perubahan yang diminta dengan tim Anda.
5. Tinjau serah terima rilisAnda meninjau apa yang Anda terima, catatan pengujian, dan item terbuka sebelum menyetujui rencana rilis untuk jaringan yang dipilih.