Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Contract Development Workflow Issues and Missing Documentation

オープン
  • 何か問題がありますか？
#217 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
shell, solidity
領域
build-system, developer-experience, documentation, testing

調査の方向性

.devkit/contracts/Makefile、.devkit/scripts/build、.devkit/contracts/foundry.toml を調べることから始め、次にそれらのターゲットを ./contracts/ ディレクトリおよび devkit avs build flow と比較します。Done には、依存関係のセットアップを文書化したものに加えて、custom contracts を対象とし、より速いコンパイルフィードバックを提供する実用的な build と test の手順を含める必要があります。

索引モデルが issue の本文から書いたものです。

説明

Summary

While developing custom contracts with DevKit, I've encountered several workflow issues and gaps in documentation that make contract development more difficult than it should be. These issues primarily relate to dependency management, build processes, and the lack of fast feedback loops for contract compilation.

Issues Identified

1. Missing Documentation for Adding Contract Dependencies

Problem: When developers need to install libraries or packages for custom contracts, there's no clear documentation on how to properly add dependencies.

Current Workaround Required:

  • For Forge-based dependencies:
    1. Navigate to .devkit/contracts/ and use forge install <dependency>
    2. Update remappings in .devkit/contracts/foundry.toml if needed
  • For Node.js-based dependencies:
    1. Create a package.json file in .devkit/contracts/
    2. Update remapping in .devkit/contracts/foundry.toml
    3. Manually modify the build command in .devkit/scripts/build to: 
      cd .devkit/contracts && npm install && forge clean && forge build -- --include ../../contracts/**/*.sol >&2

Impact: This creates a poor developer experience and requires deep knowledge of the DevKit internals.

2. Build and Test Process Doesn't Include Custom Contracts Directory

Problem: Both the build and test targets in .devkit/contracts/Makefile only work with contracts within the .devkit/contracts/ directory and don't include the main ./contracts/ directory where custom contracts are placed.

build:
    forge clean
    forge build

test:
    forge test -vvv

While there is a deploy-custom-contracts target that references custom contracts, the basic build and test commands don't validate that custom contracts compile correctly or run tests for them.

Impact:

  • Developers may write custom contracts in ./contracts/ that have compilation errors, but these errors won't be caught until deployment time
  • Custom contract tests placed in ./contracts/test/ won't be executed by the standard test command
  • No way to run targeted tests for custom contracts during development
3. No Fast Contract Compilation Feedback Loop

Problem: There's no quick way to verify contract compilation without running the full devkit avs build command, which includes many time-consuming steps beyond contract compilation.

Current Limitations:

  • devkit avs build takes significant time due to multiple build steps (binaries, contracts, etc.)
  • Calling the build command in the Makefile directly doesn't build contracts outside the .devkit folder
  • No dedicated contract-only build command for rapid iteration

Impact: Slow feedback loops significantly impact development productivity when iterating on contract code.

Additional Context

These issues became apparent while following the standard DevKit workflow for custom contract development. The current process requires significant manual intervention and deep knowledge of the build system internals, which may deter developers from effectively using DevKit for contract development.

主要言語
Go
スター
28
フォーク
10
30日以内にマージされた PR はありません

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Layr-Labs/devkit-cli のほかの issue

Layr-Labs/devkit-cli の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。