@inkd/cli 0.1.0

package/README.md

@@ -0,0 +1,226 @@
+# @inkd/cli
+
+> Command-line interface for the [Inkd Protocol](https://inkdprotocol.xyz) — permanent on-chain file ownership on Base.
+
+[![npm](https://img.shields.io/npm/v/@inkd/cli)](https://www.npmjs.com/package/@inkd/cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](../../LICENSE)
+[![Built on Base](https://img.shields.io/badge/Built%20on-Base-0052FF)](https://base.org)
+
+## Installation
+
+```bash
+# Global install
+npm install -g @inkd/cli
+
+# Or use without installing
+npx @inkd/cli help
+```
+
+## Quick Start
+
+```bash
+# 1. Scaffold config
+inkd init
+
+# 2. Set your wallet private key
+export INKD_PRIVATE_KEY=0xabc123...
+
+# 3. Check network status
+inkd status
+
+# 4. Create your first project (locks 1 $INKD)
+inkd project create --name my-agent --agent --endpoint https://api.example.com
+
+# 5. Push a version
+inkd version push --id 1 --hash <arweave-hash> --tag v0.1.0 --changelog "initial release"
+```
+
+## Configuration
+
+The CLI reads from `inkd.config.json` in the current directory. Scaffold it with:
+
+```bash
+inkd init           # testnet (default)
+inkd init --mainnet # mainnet
+```
+
+**inkd.config.json**
+```json
+{
+  "network": "testnet",
+  "rpcUrl": "https://your-rpc-endpoint"
+}
+```
+
+> ⚠️ **Never store your private key in the config file.** Use the environment variable instead.
+
+### Environment Variables
+
+| Variable           | Description                                   |
+|--------------------|-----------------------------------------------|
+| `INKD_PRIVATE_KEY` | Wallet private key (hex, `0x` optional)       |
+| `INKD_NETWORK`     | `mainnet` or `testnet` (overrides config)     |
+| `INKD_RPC_URL`     | Custom RPC endpoint                           |
+| `INKD_DEBUG`       | Set to any value to show full error stacks    |
+
+## Commands
+
+### `inkd init`
+
+Scaffold `inkd.config.json` in the current directory.
+
+```bash
+inkd init           # testnet
+inkd init --mainnet # mainnet
+inkd init --force   # overwrite existing
+```
+
+---
+
+### `inkd status`
+
+Show network info, contract addresses, and current protocol fees.
+
+```bash
+inkd status
+```
+
+---
+
+### `inkd project create`
+
+Register a new project. Locks 1 $INKD in the registry contract.
+
+```bash
+inkd project create \
+  --name my-agent \
+  --description "An AI agent that does things" \
+  --license MIT \
+  --agent \
+  --endpoint https://api.example.com
+```
+
+**Flags:**
+
+| Flag            | Required | Description                                     |
+|-----------------|----------|-------------------------------------------------|
+| `--name`        | ✅        | Project name (unique, lowercased)               |
+| `--description` |           | Short description                               |
+| `--license`     |           | SPDX license ID (default: MIT)                 |
+| `--readme`      |           | Arweave hash of README document                |
+| `--private`     |           | Make project private (default: public)         |
+| `--agent`       |           | Flag as AI agent project                       |
+| `--endpoint`    |           | Agent endpoint URL (used with `--agent`)       |
+
+---
+
+### `inkd project get <id>`
+
+Fetch and display project details.
+
+```bash
+inkd project get 1
+inkd project get --id 42
+```
+
+---
+
+### `inkd project list <address>`
+
+List all projects owned by an address.
+
+```bash
+inkd project list 0xDead...
+```
+
+---
+
+### `inkd project transfer`
+
+Transfer ownership of a project. Requires `transferFee` ETH.
+
+```bash
+inkd project transfer --id 1 --to 0xNewOwner...
+```
+
+---
+
+### `inkd project collab add|remove`
+
+Add or remove a collaborator on a project.
+
+```bash
+inkd project collab add    --id 1 --address 0xCollaborator...
+inkd project collab remove --id 1 --address 0xCollaborator...
+```
+
+---
+
+### `inkd version push`
+
+Push a new version to a project. Requires `versionFee` ETH.
+
+```bash
+inkd version push \
+  --id 1 \
+  --hash <arweave-tx-id> \
+  --tag v0.2.0 \
+  --changelog "Bug fixes and performance improvements"
+```
+
+---
+
+### `inkd version list <id>`
+
+List all versions for a project (newest first).
+
+```bash
+inkd version list 1
+```
+
+---
+
+### `inkd version show`
+
+Show details for a specific version by index.
+
+```bash
+inkd version show --id 1 --index 0
+```
+
+---
+
+### `inkd agent list`
+
+Browse registered AI agent projects.
+
+```bash
+inkd agent list
+inkd agent list --offset 25 --limit 50
+```
+
+---
+
+### `inkd agent lookup <name>`
+
+Find an agent project by name.
+
+```bash
+inkd agent lookup my-agent
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/inkdprotocol/inkd-protocol.git
+cd inkd-protocol/cli
+npm install
+npm run build
+node dist/index.js help
+```
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

package/dist/abi.d.ts

@@ -0,0 +1,408 @@
+/**
+ * Inkd CLI — Minimal ABIs for registry + token interactions
+ */
+export declare const REGISTRY_ABI: readonly [{
+    readonly name: "createProject";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "name";
+        readonly type: "string";
+    }, {
+        readonly name: "description";
+        readonly type: "string";
+    }, {
+        readonly name: "license";
+        readonly type: "string";
+    }, {
+        readonly name: "isPublic";
+        readonly type: "bool";
+    }, {
+        readonly name: "readmeHash";
+        readonly type: "string";
+    }, {
+        readonly name: "isAgent";
+        readonly type: "bool";
+    }, {
+        readonly name: "agentEndpoint";
+        readonly type: "string";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "pushVersion";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "arweaveHash";
+        readonly type: "string";
+    }, {
+        readonly name: "versionTag";
+        readonly type: "string";
+    }, {
+        readonly name: "changelog";
+        readonly type: "string";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "transferProject";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "newOwner";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "addCollaborator";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "collaborator";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "removeCollaborator";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "collaborator";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "setVisibility";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "isPublic";
+        readonly type: "bool";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "setReadme";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "arweaveHash";
+        readonly type: "string";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "setAgentEndpoint";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "endpoint";
+        readonly type: "string";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "getProject";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "id";
+            readonly type: "uint256";
+        }, {
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "description";
+            readonly type: "string";
+        }, {
+            readonly name: "license";
+            readonly type: "string";
+        }, {
+            readonly name: "readmeHash";
+            readonly type: "string";
+        }, {
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly name: "isPublic";
+            readonly type: "bool";
+        }, {
+            readonly name: "isAgent";
+            readonly type: "bool";
+        }, {
+            readonly name: "agentEndpoint";
+            readonly type: "string";
+        }, {
+            readonly name: "createdAt";
+            readonly type: "uint256";
+        }, {
+            readonly name: "versionCount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "exists";
+            readonly type: "bool";
+        }];
+    }];
+}, {
+    readonly name: "getVersion";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "versionIndex";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "projectId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "arweaveHash";
+            readonly type: "string";
+        }, {
+            readonly name: "versionTag";
+            readonly type: "string";
+        }, {
+            readonly name: "changelog";
+            readonly type: "string";
+        }, {
+            readonly name: "pushedBy";
+            readonly type: "address";
+        }, {
+            readonly name: "pushedAt";
+            readonly type: "uint256";
+        }];
+    }];
+}, {
+    readonly name: "getVersionCount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "getCollaborators";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "projectId";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "address[]";
+    }];
+}, {
+    readonly name: "getOwnerProjects";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner_";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256[]";
+    }];
+}, {
+    readonly name: "getAgentProjects";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "offset";
+        readonly type: "uint256";
+    }, {
+        readonly name: "limit";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "id";
+            readonly type: "uint256";
+        }, {
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "description";
+            readonly type: "string";
+        }, {
+            readonly name: "license";
+            readonly type: "string";
+        }, {
+            readonly name: "readmeHash";
+            readonly type: "string";
+        }, {
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly name: "isPublic";
+            readonly type: "bool";
+        }, {
+            readonly name: "isAgent";
+            readonly type: "bool";
+        }, {
+            readonly name: "agentEndpoint";
+            readonly type: "string";
+        }, {
+            readonly name: "createdAt";
+            readonly type: "uint256";
+        }, {
+            readonly name: "versionCount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "exists";
+            readonly type: "bool";
+        }];
+    }];
+}, {
+    readonly name: "projectCount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "versionFee";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "transferFee";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "nameTaken";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "name";
+        readonly type: "string";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}];
+export declare const TOKEN_ABI: readonly [{
+    readonly name: "approve";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}, {
+    readonly name: "allowance";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "balanceOf";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "totalSupply";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "transfer";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}, {
+    readonly name: "name";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "string";
+    }];
+}, {
+    readonly name: "symbol";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "string";
+    }];
+}, {
+    readonly name: "decimals";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint8";
+    }];
+}];
+//# sourceMappingURL=abi.d.ts.map

package/dist/abi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abi.d.ts","sourceRoot":"","sources":["../src/abi.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgNf,CAAA;AAEV,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkEZ,CAAA"}