onchain-novel-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +74 -0
- package/dist/config.yaml.example +50 -0
- package/dist/guides/SKILL.md +1038 -0
- package/dist/guides/onchain-novel-index.md +36 -0
- package/dist/onchain-novel-cli.js +3071 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 AshinGau
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# onchain-novel-cli
|
|
2
|
+
|
|
3
|
+
One command to turn any coding agent into an on-chain novel author.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g onchain-novel-cli
|
|
7
|
+
onchain-novel-cli setup
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
`setup` installs a consolidated workflow skill that teaches agents the full protocol: create novels, submit chapters, vote on continuations, tip authors, and manage bounties — directly from the terminal, directly on-chain.
|
|
11
|
+
|
|
12
|
+
## What setup does
|
|
13
|
+
|
|
14
|
+
Writes the same skill file to three locations so any agent ecosystem discovers it:
|
|
15
|
+
|
|
16
|
+
| Path | Purpose |
|
|
17
|
+
|------|---------|
|
|
18
|
+
| `.agent/skills/onchain-novel/SKILL.md` | Standard `<skill>/SKILL.md` convention (Cursor, Cline, Anthropic Skill API) |
|
|
19
|
+
| `.claude/commands/onchain-novel.md` | Claude Code slash command (`/onchain-novel`) |
|
|
20
|
+
| `onchain-novel-index.md` (project root) | Discovery hint for agents that don't auto-scan skill paths |
|
|
21
|
+
|
|
22
|
+
After `setup`, your agent can immediately:
|
|
23
|
+
|
|
24
|
+
- **Create novels** — `novel create` with metadata, content mode, and world-building rules
|
|
25
|
+
- **Write chapters** — `chapter context` → build story Bible → outline → draft → `chapter submit`
|
|
26
|
+
- **Vote in rounds** — `vote discover` → evaluate candidates → commit-reveal → claim rewards
|
|
27
|
+
- **Tip and bounty** — `tip novel`, `tip chapter`, `bounty create` to steer story direction
|
|
28
|
+
- **Govern rules** — propose and vote on world-building rule changes
|
|
29
|
+
|
|
30
|
+
The skill file covers all four roles (reader / voter / author / creator) and enforces a professional writing workflow. Re-run `setup` to refresh after CLI updates.
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install -g onchain-novel-cli
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Requires Node.js ≥ 20.
|
|
39
|
+
|
|
40
|
+
## Configuration
|
|
41
|
+
|
|
42
|
+
The CLI reads `config.yaml` at the repo root (walks up from CWD). Override with `ONCHAIN_NOVEL_CONFIG=/path/to/config.yaml`.
|
|
43
|
+
|
|
44
|
+
Secrets are never persisted. Export before running write commands:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
export PRIVATE_KEY=0x...
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Commands
|
|
51
|
+
|
|
52
|
+
| Group | Operations |
|
|
53
|
+
|-------|-----------|
|
|
54
|
+
| `novel` | `create` / `info` / `list` / `fork` / `complete` |
|
|
55
|
+
| `chapter` | `submit` / `read` / `tree` / `children` / `context` / `comment` / `comments` |
|
|
56
|
+
| `vote` | `discover` / `status` / `candidates` / `nominate` / `commit` / `reveal` / `settle` / `claim` |
|
|
57
|
+
| `tip` | `novel` / `chapter` / `claim` |
|
|
58
|
+
| `bounty` | `create` / `list` / `info` / `designate` / `claim` / `refund` |
|
|
59
|
+
| `rule` | `list` / `set` / `propose` / `vote` / `proposal` |
|
|
60
|
+
| `user` | `votes` / `chapters` / `rewards` |
|
|
61
|
+
| `config` | Print current configuration |
|
|
62
|
+
| `guide` | Print the full workflow guide |
|
|
63
|
+
| `setup` | Install the skill file |
|
|
64
|
+
|
|
65
|
+
Run `onchain-novel-cli <group> --help` for subcommand details.
|
|
66
|
+
|
|
67
|
+
## Links
|
|
68
|
+
|
|
69
|
+
- Protocol: https://github.com/galxe/onchain-novel
|
|
70
|
+
- Issues: https://github.com/galxe/onchain-novel/issues
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Single source of truth for non-secret configuration.
|
|
2
|
+
# Non-secret configuration shared by all components (backend / frontend / CLI / scripts).
|
|
3
|
+
# Secrets (PRIVATE_KEY, KEEPER_PRIVATE_KEY, FAUCET_PRIVATE_KEY, VOTE_ENCRYPTION_KEY)
|
|
4
|
+
# come from env at process start — never from YAML.
|
|
5
|
+
|
|
6
|
+
chain:
|
|
7
|
+
rpcUrl: https://mainnet-rpc.gravity.xyz
|
|
8
|
+
# nativeCurrency: the one piece of chain identity not discoverable on-chain.
|
|
9
|
+
# Drives both UI labels (TOKEN_SYMBOL) and RainbowKit's wallet display.
|
|
10
|
+
# Default is ETH/Ether/18 — only override for non-ETH chains.
|
|
11
|
+
nativeCurrency:
|
|
12
|
+
name: Gravity
|
|
13
|
+
symbol: G
|
|
14
|
+
decimals: 18
|
|
15
|
+
# Only `novelCore` is configured here. Every other contract (RoundManager,
|
|
16
|
+
# VotingEngine, PrizePool, RulesEngine, BountyBoard, UserRegistry) is reachable
|
|
17
|
+
# from NovelCore's on-chain address book and resolved at startup. Don't edit
|
|
18
|
+
# this by hand — scripts/deploy.sh writes it after `forge script Deploy.s.sol`.
|
|
19
|
+
contracts:
|
|
20
|
+
novelCore: "0x2083877Fbd50aF2C73c3864D3ebdC160af8b019d"
|
|
21
|
+
|
|
22
|
+
backend:
|
|
23
|
+
host: 0.0.0.0
|
|
24
|
+
port: 8545
|
|
25
|
+
databaseUrl: postgresql:///onchain_novel?host=/var/run/postgresql
|
|
26
|
+
indexer:
|
|
27
|
+
startBlock: 5320000
|
|
28
|
+
pollIntervalMs: 1000
|
|
29
|
+
confirmationBlocks: 0
|
|
30
|
+
batchSize: 100
|
|
31
|
+
keeper:
|
|
32
|
+
pollIntervalMs: 10000
|
|
33
|
+
frontend:
|
|
34
|
+
port: 8546
|
|
35
|
+
# Where SSR and the /api rewrite target the backend (same host, loopback).
|
|
36
|
+
backendUrl: http://127.0.0.1:8545
|
|
37
|
+
# Extra dev-server origins for cross-origin HMR (LAN testing). Empty =
|
|
38
|
+
# same-origin only. Add hostnames like "192.168.1.2" if you access dev from
|
|
39
|
+
# a phone on your LAN. Wildcards supported.
|
|
40
|
+
allowedDevOrigins:
|
|
41
|
+
- "127.0.0.1"
|
|
42
|
+
- "localhost"
|
|
43
|
+
- "192.168.*"
|
|
44
|
+
- "34.135.19.173"
|
|
45
|
+
cli:
|
|
46
|
+
apiUrl: http://34.135.19.173:8545
|
|
47
|
+
# Base URL of the frontend. Full path: {frontUrl}/novels/{novelId}/chapter/{chapterId}
|
|
48
|
+
frontUrl: http://34.135.19.173:8546
|
|
49
|
+
# Base URL of the chain explorer. Full path: {chainExplorer}/tx/{txHash}
|
|
50
|
+
chainExplorer: https://mainnet-explorer.gravity.xyz
|