SolidityDesignPatternAnalyzer

Analisador de padrões de design de solidez

Uma utilidade para o reconhecimento do padrão de design no blockchain através da análise estática do código

Este ReadMe está disponível nos seguintes idiomas:
Italiano · inglês

Tabela de conteúdo

1. Eu notifico
2. Informações do projeto
   • Baseado em
3. Guia de uso
   • Pré -requisitos
   • Como usá -lo
4. Licença
5. Bibliografia

Eu notifico

Após o grau, o projeto passou por uma variedade e melhorias, portanto, o que é descrito no elaborado da tese pode não refletir mais confiável.

Para ver o projeto no formulário descrito no elaborado da tese e da própria tese, consulte o ramo frozen , clique aqui.

Informações do projeto

Solidity Design Pattern Analyzer é um aplicativo de software desenvolvido para minha tese de graduação para o CDL de três anos em ciência da computação na Universidade de Catania.

O aplicativo de software e capaz de executar as seguintes operações:

• Detectar, dentro das lingüísticas e dependências utilizadas, todos e vinte e dois padrões de design documentados na tese, cujo descritor relativo são incluídos no código -fonte, e é possível, através da combinação de controles genéricos, para definir o novo descritor para reconhecer o design de padrões futuros;
• Descrever um contrato inteligente ou extrair informações úteis para criar um novo descritor;

(de volta ao topo)

Baseado em

• Python
• Python-Solity-Parser
• Python-hsonschema
• matplotlib

(de volta ao topo)

Guia de uso

Antes de usar o aplicativo, é necessário instalar vícios.

Pré -requisitos

Para instalar funcionários, você pode usar o pacote de instalador Python chamado PIP :

• Como pacotes globais:

  pip install -r requirements.txt

• Via ambiente virtual:

  python3 -m venv /path/to/new/virtual/environment
  source /path/to/new/virtual/environment/bin/activate
  pip install -r requirements.txt

Como usá -lo

Para usar o analisador, é necessário fornecer uma série de parâmetros, listados aqui:

Parâmetro	Descrição
-h, --help	Um parâmetro opcional que, se fornecido, fará um guia sobre o uso no terminal
-a, --action	Um parâmetro obrigatório que aceita apenas analyze e describe valores, dependendo da operação que você deseja executar.
-t, --target	Um parâmetro obrigatório que representa o caminho absoluto ou relativo do arquivo ou pasta que contém o código -fonte soliditário. Se um diretório for fornecido, o modalità batch será executado que salvará todos os resultados obtidos em um único arquivo.
-d, --descriptor	Um parâmetro opcional para a operação analyze que representa o caminho, absoluto ou relativo, do arquivo ou pasta que contém o Design Pattern Descriptor . Se você omitir um caminho predefinido, ele será usado.
-v, --verbose	Um parâmetro opcional que, se fornecido, pode imprimir debugs de login no terminal, normalmente não é exibido.
-ai, --allow-incompatible	Um parâmetro opcional que determina o controle da compatibilidade da versão do Solditch usada no arquivo fornecido. Aceita como valores: ask , skip , always . Padrão: ask , pede confirmação.
-p, --plot	Um parâmetro opcional que determina a exibição de um gráfico de resumo. Aceita como valores: ask , skip , always . Padrão: ask , pede confirmação.
-pr, --print-result	Um parâmetro opcional que, se fornecido, fará um resumo dos resultados obtidos da análise de análise no terminal.
-wr, --write-result	Um parâmetro opcional que determina o resgate no disco dos resultados obtidos a partir da análise dos arquivos individuais. Aceita como valores: ask , skip , always . Padrão: ask , pede confirmação.
-fr, --format-result	Um parâmetro opcional que determina o formato com o qual os dados obtidos são salvos. Aceita como valores: json , csv . Padrão: json .
--debug-analysis	Um parâmetro opcional que, se fornecido, fará uma análise de depuração no AST.

Por exemplo, querendo analisar um contrato inteligente para identificar o uso do padrão de próprias empresas e precisar executar o comando:

python analyzer.py -a analyze -t ./source_code.sol -d ./Ownership_descriptor.json --print-result --write-result always --plot always

(de volta ao topo)

Licença

O software é lançado sob licença do MIT. Veja LICENSE para obter mais informações.

(de volta ao topo)

Bibliografia

• O que é Ethereum?
• Documentação da Solidez.
• A casa oficial da linguagem de programação Python.
• Outra ferramenta para reconhecimento de idiomas.
• [Um analisador de solidez experimental para Python construído em cima de uma robusta gramática antlr4.] (Https://github.com/consensys/ python-solity-parsser)
• [JSON Scheme- The Home of JSON Scheme.] (Https: // json- Scheme.org/)
• [JSON Draft-07 Notas de lançamento.
• Uma implementação da especificação do esquema JSON para Python.
• M. Wohrer e U. Zdun. "Do idioma específico do domínio ao código: contratos inteligentes e a aplicação de padrões de design". In: IEEE Software 37.05 (conjunto de 2020), pp. 37–1. ISSN: 1937-4194. Doi: 10.1109/- ms.2020.293470
• Lodovica Marchesi et al. "Padrões de design para otimização de gás no Ethereum". In: 2020 IEEE International Workshop sobre engenharia de software orientada a blockchain (IWBOSE) 2020.9050163
• Contratos inteligentes Padrões de design no ecossistema Ethereum e Código de Solidez.
• Padrões de contrato inteligente escritos em Solide, reunidos para o bem da comunidade.
• Uma compilação de padrões e práticas recomendadas para a solidez da linguagem de programação de contratos inteligentes.
• Maximiliano Wohrer e Uwe Zdun. "Contratos inteligentes: padrões de segurança no ecossistema e solidez do Ethereum". In: 2018 Workshop Internacional sobre Engenharia de Software Orientada a Blockchain (IWBOSE). - março de 2018, pp.2–8.doi: 10.1109/iwbose.2018.8327565
• O Openzeppelin Contracts é uma biblioteca para o desenvolvimento seguro de contratos inteligentes.

(de volta ao topo)