@iqlabs-official/git-sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,49 +1,80 @@
-# @iqlabs/git
+# @iqlabs-official/git-sdk
 
-IQ Labs 의 on-chain git SDK. 브라우저 / Node 양쪽 지원. IQ Git v2 스키마 구현체.
+Embed on-chain Git into your Solana dApp. Browser SDK for letting users browse, create, and commit to repositories from your website, with a Node entry for tooling.
 
-## 상위 문서
+## Install
 
-이 repo 는 `iq-git-cli` 에 있는 v2 설계 문서의 일부를 구현합니다.
+```bash
+npm install @iqlabs-official/git-sdk
+```
+
+Peer deps: `@solana/web3.js`, `@iqlabs-official/solana-sdk` (aliased as `iqlabs-sdk`), `buffer`.
+
+## Usage
 
-- 전체 설계: [../iq-git-cli/IQGIT-V2-PLAN.md](../iq-git-cli/IQGIT-V2-PLAN.md)
-- 글로벌 TODO: [../iq-git-cli/IQGIT-V2-TODO.md](../iq-git-cli/IQGIT-V2-TODO.md)
-- 코드 법칙: [../iq-git-cli/CODE-RULES.md](../iq-git-cli/CODE-RULES.md)
-- 본 repo TODO: [./TODO.md](./TODO.md)
+### Browser (frontend / dApp)
 
-## 구조
+```ts
+import { GitClient, readRegistryPage } from "@iqlabs-official/git-sdk/browser";
+import { useConnection, useWallet } from "@solana/wallet-adapter-react";
 
+const { connection } = useConnection();
+const wallet = useWallet();
+
+// Read-only — no wallet required.
+const entries = await readRegistryPage(connection, { limit: 50 });
+
+// Write — needs a connected wallet adapter.
+const client = new GitClient({
+  connection,
+  signer: {
+    publicKey: wallet.publicKey!,
+    signTransaction: wallet.signTransaction!,
+    signAllTransactions: wallet.signAllTransactions!,
+  },
+});
+
+await client.createRepo({
+  name: "my-repo",
+  description: "hello on-chain",
+  isPublic: true,
+  timestamp: Date.now(),
+});
 ```
-src/
-├─ index.ts         ← "@iqlabs/git" (shared)
-├─ browser.ts       ← "@iqlabs/git/browser"
-├─ node.ts          ← "@iqlabs/git/node"
-├─ core/            ← L0 types, seed, hash, chunk, codec, errors
-├─ wallet/          ← L0 Signer 추상
-├─ chain/           ← L1 iqlabs-sdk 래퍼 + gateway fallback
-├─ storage/         ← L2 BlobStore, TreeStore
-├─ model/           ← L3 RepoService, CommitService, RegistryService
-├─ client/          ← L4 GitClient (facade)
-└─ platform/        ← fs-node / fs-browser
-
-scripts/
-└─ bootstrap-registry.ts   ← git_repos:all createTable (admin, 1회)
+
+### Node (CLI / scripts)
+
+```ts
+import { GitClient } from "@iqlabs-official/git-sdk/node";
+import { Connection, Keypair } from "@solana/web3.js";
+
+const connection = new Connection(process.env.SOLANA_RPC_ENDPOINT!);
+const signer = Keypair.fromSecretKey(/* your secret key */);
+const client = new GitClient({ connection, signer });
+
+await client.commit("my-repo", "initial", scan);
 ```
 
-## 레이어 규칙
+## API surface
 
-`CODE-RULES.md` 를 따르며 추가로:
+- `GitClient` — high-level workflows: `createRepo`, `commit`, `checkout`, `clone`, `log`, `status`.
+- `readOwnerRepos`, `readRegistryPage` — owner repo list + public gallery.
+- `readLatestCommit`, `readCommitHistory` — direct commit-table reads.
+- `loadTree`, `loadBlob` — pull a stored `tree.json` or file blob by tx signature.
+- `bootstrapRegistry` — one-time admin call to initialize the global registry table on a fresh network.
 
-- 상위 레이어는 **바로 아래 레이어만** import
-- `core/` 는 DOM / node fs 금지
-- `browser.ts` 는 `@solana/wallet-adapter-base` (타입만) OK
-- `node.ts` 는 `node:fs`, `node:crypto` OK
-- 위반은 eslint `no-restricted-imports` 로 빌드 시 차단
+`SignerInput` from `@iqlabs-official/solana-sdk` is accepted everywhere a signer is needed: a `Keypair`, a web3.js `Signer`, or a wallet adapter object with `signTransaction` / `signAllTransactions`.
 
-## 로컬 개발
+## Subpath entries
 
-```bash
-npm install
-npm run build -- --watch
-npm link                       # 다른 repo 에서 npm link @iqlabs/git
-```
+| Import | When to use |
+|---|---|
+| `@iqlabs-official/git-sdk` | Types and pure functions only. No SHA-256 backend installed. |
+| `@iqlabs-official/git-sdk/browser` | Installs SubtleCrypto SHA-256. Use this in browser apps. |
+| `@iqlabs-official/git-sdk/node` | Installs `node:crypto` SHA-256. Use this in CLI / server. |
+
+Importing the appropriate platform entry exactly once is required before calling any function that hashes content (e.g. `commit`, `status`).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iqlabs-official/git-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Embed on-chain Git into your Solana dApp. Browser SDK for letting users browse, create, and commit to repositories from your website, with a Node entry for tooling.",
   "keywords": [
     "solana",
@@ -18,16 +18,28 @@
     "./dist/browser/index.js"
   ],
   "exports": {
-    ".":         { "types": "./dist/shared/index.d.ts",  "import": "./dist/shared/index.js"  },
-    "./browser": { "types": "./dist/browser/index.d.ts", "import": "./dist/browser/index.js" },
-    "./node":    { "types": "./dist/node/index.d.ts",    "import": "./dist/node/index.js"    }
+    ".": {
+      "types": "./dist/shared/index.d.ts",
+      "import": "./dist/shared/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser/index.d.ts",
+      "import": "./dist/browser/index.js"
+    },
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.js"
+    }
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
-    "build":   "tsup",
+    "build": "tsup",
     "typecheck": "tsc --noEmit",
-    "lint":    "eslint src --max-warnings=0",
-    "test":    "vitest run"
+    "lint": "eslint src --max-warnings=0",
+    "test": "vitest run"
   },
   "peerDependencies": {
     "@solana/web3.js": "^1.98.0",