Skip to content

Commit c46c740

Browse files
authored
Merge pull request #1 from gapview01/codex/initialize-front-door-for-goblin-project
meta: front-door repo scaffolding
2 parents 160a5b2 + 703a10b commit c46c740

6 files changed

Lines changed: 70 additions & 3 deletions

File tree

.github/workflows/ci.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: CI (lint-readme)
2+
on:
3+
pull_request:
4+
push:
5+
branches: [ main ]
6+
jobs:
7+
readme-lint:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
- name: Check files exist
12+
run: |
13+
test -f README.md
14+
test -f ARCHITECTURE.md
15+
test -f REPO-MAP.md

ARCHITECTURE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Architecture (4 Buckets)
2+
3+
Goblin is organised into four conceptual buckets. Buckets are **meta categories**; the real units are the repos they group.
4+
5+
1) **User, Developer & Agentic Experiences**
6+
Wallet (web/mobile), Developer Console, first bot (tranched staking), agentic UX.
7+
8+
2) **On-Chain Core (Solana)**
9+
Anchor programs: Bot Factory, Master, Individual Bot; token configs; treasuries.
10+
11+
3) **Off-Chain Smarts (platform-agnostic)**
12+
API, Indexer, Timekeeper; SDK + CLI; CI/CD and observability. Cloud-agnostic.
13+
14+
4) **Governance & Economics**
15+
Treasury policy, upgrade/pause rules, tokenomics, future DAO.
16+
17+
**Now vs Future**
18+
- Now: wallet, dev console, programs, services (API/indexer/timekeeper), SDK/CLI, first bot.
19+
- Future: more bots (added as separate repos), Swap, Stake UX, DAO.
20+
21+
Principle: **Open where it builds trust. Private where it protects money.**

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 gapview01
3+
Copyright (c) 2025 Goblin contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
# goblin
2-
Goblin is a Solana agent wallet – more creature than app. It’s your entry to our modular ecosystem of bots, on‑chain programs, off‑chain services and governance. This repo maps the pieces and links you to the code.
1+
# Goblin — Solana Agent Wallet
2+
Not an app, a money creature.
3+
4+
This is the **front door** to the Goblin ecosystem: a minimal map of what Goblin is, how it’s structured, and where to find the code.
5+
6+
- Vision & layers: see **ARCHITECTURE.md**
7+
- Repos & links: see **REPO-MAP.md**
8+
9+
We keep Goblin modular and open. Critical ops remain private.

REPO-MAP.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Repository Map
2+
3+
Buckets are conceptual; repos are the unit of analysis. Links are added as repos go live.
4+
5+
## 1) User, Developer & Agentic Experiences (public)
6+
- goblin-wallet — Web/Mobile wallet
7+
- goblin-developer-console — Dev portal & control panel
8+
- goblin-bot-staking — First bot (tranched liquid staking)
9+
10+
## 2) On-Chain Core (public)
11+
- goblin-programs — Anchor programs (Factory, Master, Bot)
12+
- goblin-tokens — Token metadata/configs
13+
14+
## 3) Off-Chain Smarts (public/private)
15+
- goblin-services — API, Indexer, Timekeeper (logic only)
16+
- goblin-sdk — Client SDK
17+
- goblin-cli — CLI tools
18+
- goblin-infra — *(private)* IaC, pipelines, secrets
19+
20+
## 4) Governance & Economics
21+
- goblin-dao — *(public scaffold)* future DAO/contracts/UI
22+
- goblin-governance-private — *(private)* treasury policy, tokenomics, governance docs

docs/diagram-placeholder.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Diagram Placeholder
2+
A simple diagram of the 4 buckets and satellites will live here. Keep the front door minimal.

0 commit comments

Comments
 (0)