CodeChain-io / CodeChain-io/foundry

Project organization plan

Abierto
#512 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Rust
Estrellas
36
Forks
11
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Current Foundry's project structure is somewhat tangled.
I suggest following new structure.

1. We have a separate repo for types/traits/utilities widely used in the host and modules. (Let's say `foundry-suite`) Some types might have their `async-graphql` implementations. The module author will import both `module-rt` and `foundry-suite`.
Also, the coordinator - module interfaces are included here as well.

2. App descriptor is separated into two independent parts: Foundry configuration (genesis config, transaction services) and general linking instructions (export, import, init config). Let's say the latter as a 'link descriptor'.

3. We keep the module system (Mold) pure, not involved in any blockchain context. It will be only about sandbox, links, communication and bootstrapping. Here are the components included
- RTO
- `module-rt`
- sandbox implementations
- link-desc (see section 2)
- weaver
- `codechain-module` (linkable, linker, Port, ...)

4. Coordinator will be just one use case of Mold, with some predefined services to import and export (coordinator - module interfaces).

5. We publish Mold as a general framework, which can be used widely out of blockchain context.

Doing this, we can have three clearly separated groups.

1. The consensus engine: Anything below the engine interface. DB, Tendermint, P2P, GraphQL server and so on. Current `foundry` repo will be about them.

2. The general module system: As described above.

3. The bridge between 1. and 2. : Coordinator, types, predefined services, utilities, ...

Any comments are welcome.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

La payload no menciona archivos ni pruebas; empieza revisando la estructura actual del repositorio Foundry y los componentes module, coordinator, app-descriptor y Mold mencionados en la propuesta. Mapea esos componentes con los tres grupos propuestos y define el alcance de la migración; se considera terminado cuando exista un plan de organización aprobado por un maintainer.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
rust
Área
backend, blockchain
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.