Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

An brief description on how the project is configured and deployment works #30

Open
wants to merge 8 commits into
base: v6
Choose a base branch
from

Conversation

ohatland
Copy link
Member

No description provided.

@ohatland ohatland requested a review from ramvi January 29, 2024 09:34
Copy link
Collaborator

@ramvi ramvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dritbra og spesifikk dokumentasjon — spesielt tabellene! 🤩 Har kommet med spesifiseringer og kommentarer i reviewen

packages/captable/README.md Outdated Show resolved Hide resolved
@@ -75,7 +75,7 @@ services:
depends_on:
- hardhat
environment:
CONTAINER_HARDHAT: http://hardhat:8545
RPC_CONTAINER: http://hardhat:8545
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Har du kjørt koden med disse endringene, slik at vi vet det fungerer?

DEV_ENTERPRISE_SYSTEM_ADDRESS=0x4cCE8E0e2Ba902FE7D2D1fD894d85883E7cd720d
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Har du kjørt koden med disse endringene, slik at vi vet det fungerer?

packages/api/README.md Outdated Show resolved Hide resolved
packages/captable/README.md Outdated Show resolved Hide resolved
| `abis/` | ABIS files for CapTable and CapTableRegistry, ***NB: These files are generated and copy manually*** |
| `build/` | Generated files from `graph codegen && graph build`, based on the content of `subgraph.yaml` |
| `docker-compose/` | Specs for running TheGraph locally with Docker compose |
| `generated/` | Some manually generated files @jon ? |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "build" folder contains compiled and ready-to-deploy files such as ABI files for smart contracts, necessary for deploying the subgraph.

The "generated" folder includes TypeScript types and auxiliary files generated from the smart contracts' ABI, mainly used to ensure type safety and facilitate a smoother development experience when working with GraphQL queries or smart contract interactions.

| `generated/` | Some manually generated files @jon ? |
| `podman-compose/` | Specs for running TheGraph locally with Podman compose
| `scripts/` | Takes constant variables from `packages/captable/deployment/` and creates `subgraph.yaml` |
| `src/` | Some more files copy @jon ? |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Contains TypeScript mapping scripts that handle blockchain events, updating the subgraph's state with entities like CapTable, TokenHolder, and Balance, effectively transforming raw blockchain data into a structured, queryable format.

| `podman-compose/` | Specs for running TheGraph locally with Podman compose
| `scripts/` | Takes constant variables from `packages/captable/deployment/` and creates `subgraph.yaml` |
| `src/` | Some more files copy @jon ? |
| `tests/` | I dont know @jon ? |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used for tracking the version and timestamp of the latest test run, aiding in test management and version control.

"deploy:localhost": "pnpm prepare:localhost && pnpm build && pnpm create:local && pnpm deploy:local",
"deploy:container-compose": "pnpm prepare:localhost && pnpm build && pnpm create:container && pnpm deploy:container",
"prepare:brokDev": "node scripts/prepare.js brokDev && pnpm build",
"prepare:brokStage": "node scripts/prepare.js brokStage && pnpm build",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Har du kjørt koden med disse endringene, slik at vi vet det fungerer?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Er ikke subgraph.yaml konfigurasjonsfilen til TheGraph? Da skal den vel ikke slettes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants