Phát triển smart contract: viết quy tắc trước khi viết code

Một dự án hợp đồng nên bàn giao những gì

Kiểm tra nhanh: Hãy mô tả từng chức năng của hợp đồng trong một câu mà người không phải lập trình viên có thể hiểu. Nếu bạn không thể, quy tắc chưa rõ ràng.

Phát triển smart contract chuyển các quy tắc đã thống nhất của sản phẩm thành mã có thể kiểm thử và chuẩn bị phát hành trên một blockchain đã chọn. Kết quả hữu ích không phải là mã đơn lẻ: đó là một triển khai mà hành vi, ranh giới và bàn giao dự kiến rõ ràng cho nhóm sản phẩm.

Dịch vụ này phù hợp khi dự án của bạn cần logic on-chain tùy chỉnh, chẳng hạn như hợp đồng liên quan đến token, lịch trình vesting, luồng staking hoặc các chức năng hợp đồng mà một dApp sẽ gọi. Nếu hợp đồng là một phần của sản phẩm rộng hơn, chúng tôi có thể điều chỉnh kế hoạch với Phát triển Web3 và Phát triển dApp, để giao diện và hợp đồng thống nhất về đầu vào, quyền hạn và hành động của người dùng.

Trước khi triển khai, hãy chuẩn bị:

• Mô tả bằng ngôn ngữ đơn giản về từng hành động của người dùng và kết quả dự kiến.
• Blockchain bạn định sử dụng và mọi phụ thuộc hợp đồng hoặc sản phẩm hiện có.
• Quy tắc về quyền truy cập, thời gian, thay đổi và các trường hợp ngoại lệ.
• Một người ra quyết định được chỉ định có thể giải quyết các câu hỏi sản phẩm còn mở.

Nếu bạn chưa thể xác định một quy tắc, hãy đánh dấu nó là chưa quyết định thay vì để nó trở thành một lựa chọn kỹ thuật ngầm. Chúng tôi biến các câu hỏi mở thành danh sách xem xét, sau đó xác nhận kế hoạch hợp đồng với bạn trước khi phát triển bắt đầu.

Làm thế nào các yêu cầu trở thành hành vi đã kiểm thử?

Chúng tôi ánh xạ từng yêu cầu thành hành vi hợp đồng có thể quan sát và một bài kiểm thử trước khi coi nó sẵn sàng phát hành. Điều đó cung cấp cho nhóm dự án một cách thực tế để kiểm tra xem triển khai có khớp với các quy tắc dự định hay không, thay vì dựa vào mô tả chung chung như "hỗ trợ staking."

Trình tự làm việc rất đơn giản: làm rõ vai trò người dùng và hành động được phép, xác định thay đổi trạng thái dự kiến, xác định đầu vào không hợp lệ hoặc không đầy đủ, sau đó triển khai và kiểm thử các ca đã thống nhất. Đối với mỗi chức năng, tiêu chí chấp nhận nên trả lời một lệnh gọi hợp lệ làm gì, ai có thể thực hiện nó và điều gì sẽ xảy ra khi một điều kiện không được đáp ứng. Chúng tôi xem xét các tiêu chí đó với chủ sở hữu sản phẩm của bạn trước khi chúng trở thành cơ sở cho việc phát triển.

Một điểm khác biệt hữu ích trong kế hoạch là giữa hành vi hợp đồng và trải nghiệm sản phẩm. Hợp đồng xử lý các quy tắc được gán cho nó; một ứng dụng kết nối vẫn có thể cần giải thích trạng thái, hiển thị dữ liệu hoặc hướng dẫn người dùng qua một giao dịch. Khi cả hai đều nằm trong kế hoạch, chúng tôi phối hợp ranh giới đó với Phát triển dApp. Đối với một token cần tạo và triển khai cũng như logic tùy chỉnh, hãy điều chỉnh các yêu cầu hợp đồng với Tạo và triển khai token.

Bạn nhận được một bản ghi có thể xem xét về các hành vi đã thống nhất và các bài kiểm thử tương ứng. Điều đó giúp việc đánh giá các thay đổi sản phẩm sau này dễ dàng hơn: nhóm có thể xác định quy tắc hiện tại nào bị ảnh hưởng trước khi phê duyệt bản cập nhật.

Danh sách kiểm tra 7 điểm để xác định hợp đồng của bạn

Hãy viết 7 mục này trước khi bất kỳ mã nào được viết. Chúng trở thành tiêu chí chấp nhận mà mọi bài kiểm thử được đối chiếu. Giữ danh sách đã đánh dấu cùng với hồ sơ của bạn, vì đó là cách nhanh nhất để giải thích sau này những gì đã được thống nhất.

1. Liệt kê từng hợp đồng và một nhiệm vụ của nó.
2. Viết ai có thể gọi từng chức năng.
3. Xác định lịch trình vesting và staking với các con số chính xác.
4. Quyết định xem hợp đồng có thể được nâng cấp hay không và bởi ai.
5. Liệt kê các trường hợp thất bại và kết quả dự kiến cho từng trường hợp.
6. Chọn chain và tiêu chuẩn token.
7. Lên kế hoạch kiểm duyệt độc lập trước khi phát hành.

Thuật ngữ trong một dòng

Vesting: phát hành token dần dần cho người nắm giữ theo một lịch trình cố định.

Hợp đồng có thể nâng cấp (nói một cách đơn giản: một hợp đồng mà logic của nó có thể được thay thế sau khi triển khai).

Xác định quy tắc vesting và staking

Hợp đồng vesting và staking cần các quy tắc rõ ràng về điều kiện đủ, thời gian, hành động của người dùng và kết quả mà sản phẩm hiển thị. Chỉ đặt tên cho tính năng là chưa đủ; kế hoạch hợp đồng nên mô tả các trường hợp triển khai phải hỗ trợ và các trường hợp nó phải từ chối.

Đối với vesting, hãy quyết định ai nhận được phân bổ, sự kiện nào bắt đầu lịch trình, cách tính toán các đợt phát hành và liệu có bất kỳ thay đổi nào được phép sau khi lịch trình được thiết lập hay không. Xác nhận cách sản phẩm nên xử lý khi người dùng kiểm tra phân bổ hoặc yêu cầu một đợt phát hành có sẵn. Đối với staking, hãy xác định các hành động mà người tham gia có thể thực hiện, điều kiện nào áp dụng cho việc vào và ra, và cách hợp đồng thể hiện số dư hoặc trạng thái liên quan. Đây là các yêu cầu cần xác nhận với nhóm của bạn, không phải cài đặt mặc định mà chúng tôi âm thầm chọn.

Sử dụng danh sách kiểm tra chuẩn bị này:

• Xác định các vai trò có thể tạo, quản trị hoặc sử dụng từng chức năng hợp đồng.
• Viết ra các quy tắc thời gian và điều gì được coi là một hành động hợp lệ.
• Quyết định cách xử lý và thông báo các trường hợp ngoại lệ.
• Tách biệt các quy tắc sản phẩm đã xác nhận khỏi các quyết định chính sách hoặc token vẫn đang được xem xét.

Khi nguồn cung hoặc phân phối token là một phần của cùng một bản phát hành, hãy phối hợp kế hoạch với Tạo và triển khai token. Nếu người dùng sẽ tương tác thông qua trải nghiệm wallet chuyên dụng, hãy thảo luận kết nối với Phát triển crypto wallet sớm, để các yêu cầu về hợp đồng và giao diện được xem xét cùng nhau.

Dự án bao gồm những gì

Nguyên tắc chung: Kiểm thử cho thấy bạn đã nghĩ đến điều gì. Một đánh giá độc lập cho thấy bạn đã không nghĩ đến điều gì.

Dự án bao gồm kế hoạch hợp đồng đã thống nhất và các tài liệu mà nhóm của bạn cần để xem xét, kiểm thử và chuẩn bị công việc đó cho việc phát hành. Chúng tôi xác nhận những gì bạn nhận được khi bắt đầu để có một định nghĩa chung về sự hoàn thành, bao gồm bất kỳ công việc nào phụ thuộc vào nhóm của bạn hoặc một kiểm toán viên bên ngoài.

Tùy thuộc vào kế hoạch đã được phê duyệt, những gì bạn nhận được có thể bao gồm:

• Bản tóm tắt bằng văn bản về các yêu cầu hợp đồng và tiêu chí chấp nhận.
• Triển khai hợp đồng tùy chỉnh cho blockchain đã chọn và các chức năng đã thống nhất.
• Các bài kiểm thử bao gồm các hành vi và trường hợp biên được xác định trong quá trình lập kế hoạch.
• Ghi chú xây dựng và phát hành giải thích những gì đã sẵn sàng để xem xét và những gì còn bỏ ngỏ.
• Phối hợp kiểm duyệt độc lập, bao gồm đóng gói các tài liệu đã thống nhất và tổ chức phản hồi cho các phát hiện.

Phối hợp audit có nghĩa là giúp nhóm chuẩn bị một bàn giao đánh giá rõ ràng và theo dõi phản hồi thành các thay đổi mã. Nó khác với việc tuyên bố rằng một cuộc audit đã diễn ra hoặc kiểm toán viên đã phê duyệt mã. Nếu sản phẩm của bạn cần một trang web hoặc landing page để giải thích hành vi hợp đồng, kế hoạch kỹ thuật có thể được phối hợp với Phát triển trang web và landing Web3.

Một bàn giao mạnh mẽ cho phép nhóm nội bộ của bạn hiểu những gì đã được xây dựng, những gì đã được kiểm thử và những quyết định nào vẫn thuộc về họ. Chúng tôi xem xét những gì bạn nhận được với chủ sở hữu dự án của bạn, ghi lại các thay đổi được chấp nhận và làm rõ trạng thái phát hành trước khi công việc được coi là hoàn tất.

Dự án được lập kế hoạch và xem xét như thế nào

Dự án chuyển từ yêu cầu sang triển khai thông qua các điểm xem xét được đặt tên, với thời gian được thiết lập từ kế hoạch đã xác nhận. Một hợp đồng nhỏ, được xác định rõ ràng và một hệ thống nhiều tính năng không cần cùng một kế hoạch, vì vậy trước tiên chúng tôi xác định những gì đang được xây dựng và ai sẽ đưa ra quyết định.

Khi bắt đầu, chúng tôi kiểm tra blockchain đã chọn, các phụ thuộc hợp đồng, quy tắc sản phẩm, mã hiện có và những người chịu trách nhiệm phê duyệt. Trong quá trình phát triển, chúng tôi chia sẻ tiến độ so với các yêu cầu đã thống nhất và đặt ra các câu hỏi có thể thay đổi hành vi trước khi chúng trở thành bất ngờ vào phút cuối. Bạn xem xét triển khai dựa trên các tiêu chí chấp nhận và chúng tôi ghi lại các thay đổi được yêu cầu dưới dạng các mục cụ thể để xác nhận.

Lịch trình cũng tính đến đánh giá bên ngoài nếu được yêu cầu. Chúng tôi phối hợp khi các tài liệu đã sẵn sàng, giữ phản hồi của kiểm toán viên kết nối với yêu cầu liên quan và xác nhận những thay đổi nào được bao gồm trong kế hoạch đã thống nhất. Nhóm của bạn nên lên kế hoạch cung cấp câu trả lời kịp thời cho các câu hỏi về sản phẩm và quyền truy cập; các quyết định chưa được giải quyết có thể làm trì hoãn việc triển khai hoặc chuẩn bị phát hành.

Để công việc dễ dàng đánh giá, hãy yêu cầu cập nhật tiến độ phân tách các mục đã hoàn thành, các quyết định còn mở, trạng thái kiểm thử và các hành động tiếp theo. MarketingExtra sử dụng đánh giá trực tiếp giữa kỹ sư và khách hàng về các tiêu chí chấp nhận và phạm vi kiểm thử, để những người phê duyệt hành vi sản phẩm có thể thấy mỗi bài kiểm thử nhằm thiết lập điều gì. Kế hoạch bàn giao kết quả được xác nhận với bạn trước khi quá trình xây dựng tiến hành.

Những điều cần biết trước khi bạn phát hành mã

Một quy trình phát triển cẩn thận cải thiện khả năng xem xét, nhưng kiểm thử và phối hợp audit không loại bỏ mọi rủi ro phát hành. Kiểm thử chỉ có thể kiểm tra các trường hợp chúng bao phủ, và một kiểm toán viên độc lập có thể xác định vấn đề hoặc yêu cầu thay đổi; việc triển khai nên chờ cho đến khi nhóm của bạn phê duyệt chính xác bản phát hành và mạng lưới mục tiêu.

Để bàn giao có trách nhiệm, hãy xác nhận rằng phiên bản đã triển khai khớp với phiên bản nhóm của bạn đã xem xét, rằng các quyền phát hành đã được hiểu rõ và dự án có chủ sở hữu cho các câu hỏi sau phát hành. Giữ một bản ghi về các yêu cầu đã được chấp nhận, kết quả kiểm thử, phản hồi của kiểm toán viên nếu có và quyết định phát hành cuối cùng. Những tài liệu này giúp nhóm của bạn phân biệt công việc đã được xác minh với các quyết định hoặc trách nhiệm vận hành vẫn nằm ngoài kế hoạch phát triển.

Nếu phát triển hợp đồng là một phần của một bản dựng lớn hơn, hãy điều chỉnh kế hoạch phát hành với kế hoạch Phát triển Web3 rộng hơn thay vì coi hợp đồng như một vạch đích riêng biệt. Chia sẻ blockchain mục tiêu của bạn, mô tả ngắn gọn về mục đích của hợp đồng và bất kỳ thông số kỹ thuật hoặc mã hiện có nào với MarketingExtra. Chúng tôi sẽ xem xét các tài liệu, xác định các quyết định sản phẩm chưa được trả lời và trả lại một kế hoạch bằng văn bản cho công việc.

Gửi 3 thứ: quy tắc sản phẩm của bạn, chain mục tiêu của bạn và mốc thời gian của bạn cho việc xem xét.

Cách hoạt động

1. Chia sẻ quy tắc sản phẩmGửi hành vi hợp đồng dự kiến, blockchain mục tiêu, mã hoặc thông số kỹ thuật hiện có và mọi phụ thuộc đã biết. Đánh dấu rõ ràng các quyết định chưa được giải quyết.
2. Xác nhận kế hoạch và tiêu chí chấp nhậnChúng tôi xem xét vai trò, hành động, trường hợp ngoại lệ và những gì bạn nhận được với người ra quyết định của bạn. Các tiêu chí đã thống nhất thiết lập những gì phát triển và kiểm thử sẽ bao gồm.
3. Xây dựng và kiểm thử hành vi đã thống nhấtKỹ sư triển khai hợp đồng đã lên kế hoạch và kiểm tra nó dựa trên các ca kiểm thử đã được chấp nhận. Các câu hỏi ảnh hưởng đến hành vi sẽ được đưa trở lại để bạn quyết định.
4. Phối hợp đánh giá độc lậpNếu phối hợp audit được bao gồm, chúng tôi chuẩn bị các tài liệu đã thống nhất, tổ chức phản hồi và theo dõi các thay đổi được yêu cầu với nhóm của bạn.
5. Xem xét bàn giao phát hànhBạn xem xét những gì bạn nhận được cuối cùng, bản ghi kiểm thử và các mục còn mở trước khi phê duyệt kế hoạch phát hành cho mạng lưới đã chọn.