arkavo-org / arkavo-org/arkavo-node

README issues

Open
#22 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Key issues in that README (and what to fix)

1) License contradiction (must fix)
• GitHub header shows GPL-3.0, but the README “License” section says Apache-2.0.
• Action: make LICENSE and README agree (and ensure Cargo.toml license fields match).

2) Docker instructions don’t match the tree shown
• README says cd docker then docker-compose up -d, but your repo listing shows compose.yaml at the root (and no docker/ directory is shown).
• Action: either:
• move compose files into /docker and keep docs, or
• update docs to docker compose up -d from repo root.

3) Runtime text contradicts recent refactor notes
• Repo activity mentions “Migrate runtime from pallet-contracts to pallet-revive”, but README still says “runtime/: … with pallet-contracts enabled”.
• Action: update “Project Structure / Runtime” to reflect the current pallet (pallet-revive vs pallet-contracts) and remove stale references.

4) Repeated/contradictory Testing section
• The “Run all tests” command is duplicated and still excludes contracts (so it’s not “all tests”).
• Action: make it explicit:
• “Node/runtime tests”
• “Contracts tests (from contracts/)”
• “CI-equivalent: run both”

5) Contract examples are written like free functions

Examples like:

grant_entitlement(account, EntitlementLevel::VIP)
has_entitlement(account, EntitlementLevel::Premium)

look like standalone calls, not Ink! message invocations.
• Action: either label them “pseudo-code”, or show a realistic call style:
• #[ink(message)] fn grant_entitlement(...)
• polkadot.js “Contracts → call message” flow
• deployer CLI invocation examples

6) Build/deploy paths likely inconsistent
• You say “Contract artifacts will be available in contracts/*/target/ink/”, but deploy-all --contracts-dir ./target/ink implies a unified output dir.
• Action: choose one:
• per-contract output dirs, or
• a standardized artifacts staging directory (and have CI/deployer produce it)

7) “Access Registry / Attribute Store / Policy Engine / Payment Integration” naming vs actual layout
• README uses those as canonical components; ensure folder names and contract crate names match (or document the mapping).

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare README with LICENSE, Cargo.toml, the root compose.yaml, runtime/, and contracts/ to identify the documented license, runtime, test, artifact, and component names. Check the deploy-all --contracts-dir path and the existing test layout first; done means the README, repository metadata, and commands consistently describe the current structure and workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
blockchain, docker, rust, wasm
Domain
blockchain, build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.