Contratos Inteligentes para Regras que Sua Equipe Pode Revisar

Por onde começar a construção de um contrato inteligente?

Comece pelas ações que seus usuários precisam realizar e pelas regras que governam cada uma. Usamos esses detalhes para descrever o comportamento do contrato antes de escrever o código.

Nomeie a ação do usuário. Descreva o que alguém precisa fazer, como reivindicar uma alocação ou depositar um ativo.
Defina as condições. Escreva quando a ação é permitida e o que deve acontecer quando não é.
Liste os papéis. Identifique quem pode usar cada função e quem, se houver, pode gerenciar as configurações.
Marque as dependências. Anote contratos, ativos, serviços ou trabalhos de interface relacionados.
Revise o comportamento. Concorde com casos de teste que reflitam o uso normal e ações restritas.

Isso dá à sua equipe uma descrição compartilhada para revisar antes da implementação. Também nos ajuda a identificar regras de produto não decididas cedo, enquanto as mudanças ainda são mais fáceis de discutir. Para trabalho relacionado a tokens, veja criação e implantação de token.

Se os usuários precisarem de uma interface on-chain, o desenvolvimento de dApp pode fazer parte do mesmo plano. Você não precisa ter todas as escolhas técnicas definidas antes de falar conosco. Traga as decisões que já tomou, marque as em aberto e ajudaremos a separar questões de produto de detalhes de implementação.

Mantenha o contrato próximo da forma como sua comunidade funciona

Um contrato é mais fácil de planejar quando suas regras correspondem às ações reais que as pessoas precisam realizar. Um pouco de contexto sobre seus usuários nos ajuda a fazer essa conexão sem assumir um modelo padrão de token ou recompensa.

Imagine um servidor Discord com um administrador de meio período, decidindo por qual canal começar. A equipe também está definindo como os contribuidores receberão uma alocação de token ao longo do tempo. Primeiro, ajudaríamos a descrever as regras de alocação, quem pode reivindicar e pelo que o administrador é responsável. Depois, separaríamos essas regras de contrato das decisões sobre como a comunidade compartilha atualizações.

Por exemplo, digamos que seu produto precise de staking junto com um token. Perguntaríamos como depósitos e saques devem funcionar, como as recompensas são representadas e em quais ativos ou outros serviços o plano depende. Registramos as respostas como comportamento para revisão, não como um design econômico assumido.

Esses limites importam quando há trabalho adjacente envolvido. Podemos coordenar os requisitos do contrato com um site Web3 e landing page, ou mapear a entrega para desenvolvimento de wallet de criptomoedas. Se sua equipe já tem desenvolvedores, podemos concordar quem é responsável por cada parte conectada antes do início do trabalho.

Uma entrega que sua equipe pode acompanhar

Você recebe o código e as notas de trabalho necessárias para entender o comportamento acordado do contrato. Confirmamos o conteúdo com você antes do desenvolvimento, para que a entrega se ajuste ao produto em vez de seguir uma lista genérica. Para necessidades de produto mais amplas, veja desenvolvimento Web3.

O que você recebe	Quando é útil
Descrição escrita das funções, papéis e suposições	Antes de sua equipe revisar as escolhas de implementação
Código-fonte e testes para o comportamento acordado	Durante a revisão técnica e verificação
Notas de teste e decisões em aberto	Quando os responsáveis pelo produto precisam verificar o comportamento esperado
Notas de implantação e responsabilidades de lançamento	Antes de sua equipe aprovar uma implantação
Materiais de coordenação de auditoria, se incluídos	Quando um revisor independente precisa de contexto do projeto

Um contrato de vesting pode precisar de uma descrição clara das condições de alocação e reivindicação. Uma construção de staking pode precisar do comportamento de depósito, saque e recompensa registrado. Moldamos os materiais escritos em torno das funções que você aprova, para que os revisores possam comparar as regras declaradas com os testes e o código. Isso também pode ajudar sua equipe a planejar o trabalho de interface com desenvolvimento de dApp.

Se o contrato faz parte de um produto maior, também anotamos onde suas responsabilidades terminam. Isso facilita o planejamento do trabalho conectado.

O que acontece entre a primeira revisão e o lançamento?

Passamos das decisões de produto para uma especificação revisada, depois construímos, testamos e preparamos a entrega acordada. Sua equipe tem pontos claros para verificar o comportamento antes que um lançamento seja considerado.

Começamos revisando o objetivo do produto, a blockchain, os usuários e os sistemas conectados. Uma lista de verificação inicial nos ajuda a reunir as regras do contrato, identificar escolhas em aberto e confirmar quem as aprovará. Depois que você aprova o comportamento escrito, implementamos as funções acordadas e compartilhamos o progresso com seu contato técnico.

Os testes seguem os casos acordados durante o design. Se a coordenação de auditoria estiver incluída, preparamos os materiais de revisão, roteirizamos as perguntas técnicas e organizamos as respostas às descobertas. Quando mudanças são acordadas, atualizamos o código relevante e executamos novamente os testes relacionados. Mantemos as decisões visíveis em uma nota de progresso escrita, para que sua equipe possa ver o que está pronto e o que ainda precisa de revisão.

A blockchain e o design do contrato determinam quais controles de lançamento estão disponíveis. Os testes cobrem apenas os casos que descrevem. Uma auditoria independente é limitada à sua revisão acordada. Após a implantação, se o código pode ser alterado depende do design e da blockchain.

Planeje o trabalho Web3 conectado em torno do limite do contrato

Construa componentes relacionados juntos quando o contrato depende de um token, interface ou fluxo de wallet. Concordar quem é responsável por cada parte ajuda sua equipe a evitar lacunas entre o comportamento on-chain e o produto ao redor.

Uma primeira verificação útil é listar as partes já planejadas e nomear um responsável para cada uma. Seu contrato pode se conectar a um lançamento de token, uma interface de usuário, um fluxo de wallet ou outro serviço. Podemos mapear essas conexões com seus desenvolvedores e manter o trabalho do contrato distinto do que outra equipe construirá.

Daremos ao seu projeto um contato técnico e uma nota de progresso escrita. Essa pessoa acompanha as perguntas em aberto, compartilha o trabalho para revisão e mantém a próxima decisão clara. Traga-nos estes 3 pontos de partida:

Seu resumo do produto e as ações do usuário que o contrato deve suportar.
A blockchain alvo, se escolhida, além de qualquer código existente ou notas técnicas.
Suas regras atuais de vesting, staking ou token, incluindo perguntas sem resposta.

Envie esses materiais para Brand Community. Vamos revisá-los com você, identificar decisões a serem resolvidas e preparar um plano claro para a construção do contrato.

Como funciona

Mapear o limite do contratoRevisamos o objetivo do produto, usuários, blockchain alvo e partes conectadas. Você identifica as decisões que precisam de uma resposta do responsável pelo produto.
Concordar sobre o comportamento escritoRegistramos as funções, papéis, condições e casos de teste. Sua equipe revisa a descrição antes do início da implementação.
Construir e testar as funçõesImplementamos o comportamento acordado e preparamos testes para ações esperadas e restritas. Compartilhamos o progresso e as perguntas em aberto com seu contato técnico.
Coordenar uma revisão independenteQuando a coordenação de auditoria está incluída, preparamos os materiais de revisão e organizamos as respostas às descobertas. Fazemos as mudanças acordadas e executamos novamente os testes relacionados.
Preparar o lançamento e a entregaFornecemos o código acordado, notas de teste e materiais de implantação. Sua equipe confirma a responsabilidade pelo lançamento e verifica os detalhes da implantação.

Perguntas frequentes

O que devo reunir antes de discutirmos a construção de um contrato?

Traga um resumo curto do produto, as ações do usuário que o contrato deve suportar e quaisquer regras que você já conhece. Inclua a blockchain alvo se já escolheu uma, além de código existente ou notas técnicas. Marque também as perguntas sem resposta. Por exemplo, você pode saber os destinatários do vesting, mas ainda precisa decidir quem pode aprovar uma mudança.

Vocês podem ajustar vesting ou staking em torno de regras que já usamos?

Sim. Usamos suas regras aprovadas como ponto de partida, em vez de assumir um design de alocação ou recompensa predefinido. Para vesting, compartilhe quem recebe os tokens, quando podem reivindicar e quem gerencia as permissões. Para staking, descreva depósitos, saques e recompensas. Transformamos esses detalhes em funções e testes para sua equipe revisar.

O que a entrega do contrato inclui?

A entrega inclui os itens acordados para sua construção, como código-fonte, testes, uma descrição em linguagem simples do comportamento do contrato e notas de implantação. Também podemos preparar materiais para uma revisão independente quando a coordenação de auditoria está incluída. Antes da implementação, confirmamos quais arquivos e notas sua equipe precisa para levar o trabalho adiante.

Vocês podem coordenar com um auditor que já escolhemos?

Sim. Se a coordenação estiver incluída, podemos preparar a especificação e o código para revisão, organizar perguntas com sua equipe técnica e acompanhar as respostas às descobertas. A parte revisora realiza a auditoria. Diga-nos quem é seu auditor durante o planejamento, para que possamos concordar como compartilhar materiais e roteirizar perguntas.

Quanto tempo normalmente leva uma construção de contrato personalizado?

Definimos um cronograma de trabalho após revisar as regras, a blockchain, as partes conectadas e as necessidades de revisão. Uma construção focada com comportamento definido é mais fácil de planejar do que uma com decisões de permissão ou integração em aberto. Confirmamos o cronograma antes da implementação e sinalizamos escolhas que podem afetar o cronograma acordado.

Passar nos testes mostra que todos os caminhos do contrato são seguros?

Não. Uma aprovação nos testes mostra como o código se comportou nos casos escritos para ele; não mostra que todos os caminhos possíveis foram examinados. Uma auditoria independente também reflete sua revisão acordada. Documentamos os testes e as suposições restantes para que sua equipe possa tomar uma decisão de lançamento considerada.

Vocês podem construir o contrato junto com nossa equipe de produto existente?

Sim. Podemos concordar como nosso trabalho se conecta com seus desenvolvedores, equipe de interface ou trabalho de wallet. Por exemplo, identificaremos quem é responsável pelo contrato, quem fornece os requisitos de interface e quem aprova os detalhes de lançamento. Isso torna os pontos de entrega claros antes que a construção avance para a implementação.

Desenvolvimento de contratos inteligentes para regras que sua equipe pode revisar