hive-stream 3.0.5 → 3.1.0

package/dist/cli/scaffold.js

@@ -0,0 +1,281 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateProjectName = validateProjectName;
+exports.generateProjectFiles = generateProjectFiles;
+exports.writeProjectFiles = writeProjectFiles;
+exports.isDirectoryUsable = isDirectoryUsable;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const templates_1 = require("./templates");
+const NAME_PATTERN = /^[a-z0-9][a-z0-9._-]*$/;
+function validateProjectName(name) {
+    if (!name) {
+        return 'Project name is required.';
+    }
+    if (name.length > 214) {
+        return 'Project name must be 214 characters or fewer.';
+    }
+    if (!NAME_PATTERN.test(name)) {
+        return 'Project name must be lowercase and may only contain letters, numbers, dots, hyphens, and underscores.';
+    }
+    return null;
+}
+function indent(lines, spaces) {
+    const pad = ' '.repeat(spaces);
+    return lines
+        .map((line) => (line.length > 0 ? `${pad}${line}` : line))
+        .join('\n');
+}
+function generatePackageJson(options) {
+    const pkg = {
+        name: options.name,
+        version: '0.1.0',
+        description: `A Hive blockchain app built with hive-stream.`,
+        main: 'dist/index.js',
+        scripts: {
+            dev: 'ts-node src/index.ts',
+            build: 'tsc',
+            start: 'node dist/index.js'
+        },
+        dependencies: {
+            'hive-stream': `^${options.hiveStreamVersion}`,
+            zod: '^3.25.76'
+        },
+        devDependencies: {
+            '@types/node': '^24.1.0',
+            'ts-node': '^10.9.2',
+            typescript: '^5.9.2'
+        }
+    };
+    return `${JSON.stringify(pkg, null, 4)}\n`;
+}
+function generateTsconfig() {
+    const tsconfig = {
+        compilerOptions: {
+            target: 'es2022',
+            module: 'commonjs',
+            moduleResolution: 'node',
+            outDir: 'dist',
+            rootDir: 'src',
+            strict: true,
+            esModuleInterop: true,
+            skipLibCheck: true,
+            forceConsistentCasingInFileNames: true,
+            resolveJsonModule: true
+        },
+        include: ['src']
+    };
+    return `${JSON.stringify(tsconfig, null, 4)}\n`;
+}
+function generateGitignore() {
+    return [
+        'node_modules/',
+        'dist/',
+        '.env',
+        '*.db',
+        '*.log',
+        ''
+    ].join('\n');
+}
+function generateEnvExample(options, adapter) {
+    const lines = [
+        '# Your Hive account name (without the @)',
+        `HIVE_USERNAME=${options.username}`,
+        '',
+        '# Private posting key: used for posts, comments, votes, and custom_json',
+        'HIVE_POSTING_KEY=',
+        '',
+        '# Private active key: required for transfers and other financial operations',
+        'HIVE_ACTIVE_KEY='
+    ];
+    if (adapter.envLines.length > 0) {
+        lines.push('');
+        lines.push(...adapter.envLines.map((line) => line.replace(/APP_NAME_PLACEHOLDER/g, envSafeName(options.name))));
+    }
+    lines.push('');
+    if (options.api) {
+        lines.push('# Built-in HTTP API server');
+        lines.push('API_ENABLED=true');
+        lines.push('API_PORT=5001');
+    }
+    else {
+        lines.push('# Uncomment to enable the built-in HTTP API server');
+        lines.push('# API_ENABLED=true');
+        lines.push('# API_PORT=5001');
+    }
+    lines.push('');
+    return lines.join('\n');
+}
+function envSafeName(name) {
+    return name.replace(/[^a-z0-9_-]/g, '-');
+}
+function generateIndex(options, template, adapter) {
+    const namedImports = ['Streamer', 'loadEnv', adapter.importName, ...template.imports]
+        .sort((a, b) => a.localeCompare(b));
+    const sections = [];
+    sections.push(`import { ${namedImports.join(', ')} } from 'hive-stream';`);
+    sections.push('');
+    sections.push(`import { GreetingContract } from './contracts/greeting.contract';`);
+    sections.push('');
+    sections.push(`loadEnv();`);
+    sections.push('');
+    sections.push(`const HIVE_USERNAME = process.env.HIVE_USERNAME ?? '${options.username}';`);
+    sections.push('');
+    sections.push(`async function main() {`);
+    sections.push(`    // env: true reads HIVE_USERNAME, HIVE_POSTING_KEY, HIVE_ACTIVE_KEY,`);
+    sections.push(`    // API_ENABLED, and other settings from .env`);
+    sections.push(`    const streamer = new Streamer({ env: true });`);
+    sections.push('');
+    sections.push(`    await streamer.registerAdapter(${adapter.construct.replace(/APP_NAME_PLACEHOLDER/g, envSafeName(options.name))});`);
+    sections.push('');
+    sections.push(`    await streamer.registerContract(GreetingContract);`);
+    if (template.registrations.length > 0) {
+        sections.push(indent(template.registrations, 4));
+    }
+    if (template.setup.length > 0) {
+        sections.push('');
+        sections.push(indent(template.setup, 4));
+    }
+    sections.push('');
+    sections.push(`    await streamer.start();`);
+    sections.push('');
+    sections.push(`    console.log('${options.name} is streaming the Hive blockchain. Press Ctrl+C to stop.');`);
+    sections.push('');
+    sections.push(`    process.on('SIGINT', () => {`);
+    sections.push(`        void streamer.stop().then(() => {`);
+    sections.push(`            process.exit(0);`);
+    sections.push(`        });`);
+    sections.push(`    });`);
+    sections.push(`}`);
+    sections.push('');
+    sections.push(`main().catch((error) => {`);
+    sections.push(`    console.error(error);`);
+    sections.push(`    process.exit(1);`);
+    sections.push(`});`);
+    sections.push('');
+    return sections.join('\n');
+}
+function generateGreetingContract() {
+    return `import { action, defineContract } from 'hive-stream';
+import { z } from 'zod';
+
+const greetSchema = z.object({
+    name: z.string().min(1).max(80)
+});
+
+// A minimal custom contract. Users call it by broadcasting a custom_json
+// operation with id 'hivestream' and this JSON:
+// {"hive_stream":{"contract":"greeting","action":"greet","payload":{"name":"Hive"}}}
+export const GreetingContract = defineContract({
+    name: 'greeting',
+    actions: {
+        greet: action(async (payload, ctx) => {
+            const data = greetSchema.parse(payload);
+
+            console.log(\`Hello, \${data.name}! Greeted by @\${ctx.sender} in block \${ctx.block.number}.\`);
+        }, {
+            trigger: 'custom_json'
+        })
+    }
+});
+`;
+}
+function generateReadme(options, template, adapter) {
+    const lines = [];
+    lines.push(`# ${options.name}`);
+    lines.push('');
+    lines.push(`A Hive blockchain app built with [hive-stream](https://github.com/Vheissu/hive-stream), using the **${template.label}** template and **${adapter.label}** for persistence.`);
+    lines.push('');
+    lines.push('## Getting started');
+    lines.push('');
+    lines.push('```bash');
+    lines.push('npm install');
+    lines.push('cp .env.example .env   # then fill in your Hive account and keys');
+    lines.push('npm run dev');
+    lines.push('```');
+    lines.push('');
+    lines.push('Your app streams blocks from the Hive blockchain and reacts to operations addressed to it. Contract actions are invoked by transfers (with a JSON memo) or custom_json operations using the `hivestream` id and the `hive_stream` payload wrapper.');
+    lines.push('');
+    if (template.usage.length > 0) {
+        lines.push('## Try it');
+        lines.push('');
+        for (const example of template.usage) {
+            lines.push(`### ${example.title}`);
+            lines.push('');
+            lines.push(example.description);
+            lines.push('');
+            lines.push('```json');
+            lines.push(example.payload);
+            lines.push('```');
+            lines.push('');
+        }
+    }
+    lines.push('## Custom contracts');
+    lines.push('');
+    lines.push('A starter contract lives in `src/contracts/greeting.contract.ts`. Define actions with `defineContract` and `action`, validate payloads with zod, and register the contract in `src/index.ts`. Actions can be triggered by `custom_json`, `transfer`, `time`, escrow, and recurrent transfer operations.');
+    lines.push('');
+    if (options.api) {
+        lines.push('## HTTP API');
+        lines.push('');
+        lines.push('The built-in API server is enabled in `.env` and serves contract state and events at `http://localhost:5001`.');
+        lines.push('');
+    }
+    lines.push('## Learn more');
+    lines.push('');
+    lines.push('- [hive-stream documentation](https://github.com/Vheissu/hive-stream/blob/master/DOCUMENTATION.md)');
+    lines.push('- [Hive developer portal](https://developers.hive.io)');
+    lines.push('');
+    return lines.join('\n');
+}
+function generateProjectFiles(options) {
+    const template = (0, templates_1.getTemplate)(options.template);
+    if (!template) {
+        throw new Error(`Unknown template '${options.template}'.`);
+    }
+    const adapter = (0, templates_1.getAdapter)(options.adapter);
+    if (!adapter) {
+        throw new Error(`Unknown adapter '${options.adapter}'.`);
+    }
+    const nameError = validateProjectName(options.name);
+    if (nameError) {
+        throw new Error(nameError);
+    }
+    const files = {
+        'package.json': generatePackageJson(options),
+        'tsconfig.json': generateTsconfig(),
+        '.gitignore': generateGitignore(),
+        '.env.example': generateEnvExample(options, adapter),
+        'README.md': generateReadme(options, template, adapter),
+        'src/index.ts': generateIndex(options, template, adapter),
+        'src/contracts/greeting.contract.ts': generateGreetingContract()
+    };
+    return { files, template, adapter };
+}
+function writeProjectFiles(targetDir, files) {
+    const written = [];
+    for (const [relativePath, contents] of Object.entries(files)) {
+        const fullPath = path_1.default.join(targetDir, relativePath);
+        fs_1.default.mkdirSync(path_1.default.dirname(fullPath), { recursive: true });
+        fs_1.default.writeFileSync(fullPath, contents, 'utf8');
+        written.push(relativePath);
+    }
+    return written;
+}
+function isDirectoryUsable(targetDir) {
+    if (!fs_1.default.existsSync(targetDir)) {
+        return { usable: true };
+    }
+    const stats = fs_1.default.statSync(targetDir);
+    if (!stats.isDirectory()) {
+        return { usable: false, reason: 'A file with that name already exists.' };
+    }
+    const entries = fs_1.default.readdirSync(targetDir).filter((entry) => entry !== '.git');
+    if (entries.length > 0) {
+        return { usable: false, reason: 'Directory already exists and is not empty.' };
+    }
+    return { usable: true };
+}
+//# sourceMappingURL=scaffold.js.map

package/dist/cli/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../src/cli/scaffold.ts"],"names":[],"mappings":";;;;;AAsBA,kDAcC;AA8OD,oDA8BC;AAED,8CAYC;AAED,8CAkBC;AAlVD,4CAAoB;AACpB,gDAAwB;AAExB,2CAA6F;AAiB7F,MAAM,YAAY,GAAG,wBAAwB,CAAC;AAE9C,SAAgB,mBAAmB,CAAC,IAAY;IAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,2BAA2B,CAAC;IACvC,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACpB,OAAO,+CAA+C,CAAC;IAC3D,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,uGAAuG,CAAC;IACnH,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAC,KAAe,EAAE,MAAc;IAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE/B,OAAO,KAAK;SACP,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACzD,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAwB;IACjD,MAAM,GAAG,GAAG;QACR,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,OAAO;QAChB,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE;YACL,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,oBAAoB;SAC9B;QACD,YAAY,EAAE;YACV,aAAa,EAAE,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC9C,GAAG,EAAE,UAAU;SAClB;QACD,eAAe,EAAE;YACb,aAAa,EAAE,SAAS;YACxB,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,QAAQ;SACvB;KACJ,CAAC;IAEF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,gBAAgB;IACrB,MAAM,QAAQ,GAAG;QACb,eAAe,EAAE;YACb,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,UAAU;YAClB,gBAAgB,EAAE,MAAM;YACxB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,IAAI;YACZ,eAAe,EAAE,IAAI;YACrB,YAAY,EAAE,IAAI;YAClB,gCAAgC,EAAE,IAAI;YACtC,iBAAiB,EAAE,IAAI;SAC1B;QACD,OAAO,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;IAEF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AACpD,CAAC;AAED,SAAS,iBAAiB;IACtB,OAAO;QACH,eAAe;QACf,OAAO;QACP,MAAM;QACN,MAAM;QACN,OAAO;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAwB,EAAE,OAA0B;IAC5E,MAAM,KAAK,GAAG;QACV,0CAA0C;QAC1C,iBAAiB,OAAO,CAAC,QAAQ,EAAE;QACnC,EAAE;QACF,yEAAyE;QACzE,mBAAmB;QACnB,EAAE;QACF,6EAA6E;QAC7E,kBAAkB;KACrB,CAAC;IAEF,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACpH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACJ,KAAK,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;QACjE,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,aAAa,CAAC,OAAwB,EAAE,QAA4B,EAAE,OAA0B;IACrG,MAAM,YAAY,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC;SAChF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,QAAQ,CAAC,IAAI,CAAC,YAAY,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAC3E,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;IACnF,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,uDAAuD,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;IAC3F,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;IAC1F,QAAQ,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IAClE,QAAQ,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;IACnE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,sCAAsC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,uBAAuB,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACvI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IAExE,IAAI,QAAQ,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC7C,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,IAAI,6DAA6D,CAAC,CAAC;IAC7G,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAClD,QAAQ,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;IAC3D,QAAQ,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC9C,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7B,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC3C,QAAQ,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC3C,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACtC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,wBAAwB;IAC7B,OAAO;;;;;;;;;;;;;;;;;;;;;;CAsBV,CAAC;AACF,CAAC;AAED,SAAS,cAAc,CAAC,OAAwB,EAAE,QAA4B,EAAE,OAA0B;IACtG,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAChC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,uGAAuG,QAAQ,CAAC,KAAK,qBAAqB,OAAO,CAAC,KAAK,qBAAqB,CAAC,CAAC;IACzL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;IAC/E,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,oPAAoP,CAAC,CAAC;IACjQ,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,ySAAyS,CAAC,CAAC;IACtT,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,+GAA+G,CAAC,CAAC;QAC5H,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,oGAAoG,CAAC,CAAC;IACjH,KAAK,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;IACpE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,SAAgB,oBAAoB,CAAC,OAAwB;IACzD,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE/C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,sBAAU,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,SAAS,GAAG,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,SAAS,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,KAAK,GAA2B;QAClC,cAAc,EAAE,mBAAmB,CAAC,OAAO,CAAC;QAC5C,eAAe,EAAE,gBAAgB,EAAE;QACnC,YAAY,EAAE,iBAAiB,EAAE;QACjC,cAAc,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;QACpD,WAAW,EAAE,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACvD,cAAc,EAAE,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACzD,oCAAoC,EAAE,wBAAwB,EAAE;KACnE,CAAC;IAEF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACxC,CAAC;AAED,SAAgB,iBAAiB,CAAC,SAAiB,EAAE,KAA6B;IAC9E,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAEpD,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7C,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,SAAgB,iBAAiB,CAAC,SAAiB;IAC/C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED,MAAM,KAAK,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAErC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,uCAAuC,EAAE,CAAC;IAC9E,CAAC;IAED,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;IAE9E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,4CAA4C,EAAE,CAAC;IACnF,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC5B,CAAC"}

package/dist/cli/templates.d.ts

@@ -0,0 +1,28 @@
+export type TemplateId = 'minimal' | 'game' | 'exchange' | 'social' | 'blog' | 'token' | 'assets';
+export type AdapterId = 'sqlite' | 'mongodb' | 'postgresql';
+export interface UsageExample {
+    title: string;
+    description: string;
+    payload: string;
+}
+export interface TemplateDefinition {
+    id: TemplateId;
+    label: string;
+    description: string;
+    imports: string[];
+    registrations: string[];
+    setup: string[];
+    usage: UsageExample[];
+}
+export interface AdapterDefinition {
+    id: AdapterId;
+    label: string;
+    description: string;
+    importName: string;
+    construct: string;
+    envLines: string[];
+}
+export declare const TEMPLATES: TemplateDefinition[];
+export declare const ADAPTERS: AdapterDefinition[];
+export declare function getTemplate(id: string): TemplateDefinition | undefined;
+export declare function getAdapter(id: string): AdapterDefinition | undefined;

package/dist/cli/templates.js

@@ -0,0 +1,329 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADAPTERS = exports.TEMPLATES = void 0;
+exports.getTemplate = getTemplate;
+exports.getAdapter = getAdapter;
+const wrap = (contract, actionName, payload) => {
+    return `{"hive_stream":{"contract":"${contract}","action":"${actionName}","payload":${payload}}}`;
+};
+exports.TEMPLATES = [
+    {
+        id: 'minimal',
+        label: 'Minimal',
+        description: 'A bare streamer with subscriptions and a custom contract to build on.',
+        imports: [],
+        registrations: [],
+        setup: [
+            `streamer.onTransfer(HIVE_USERNAME, (op, blockNumber) => {`,
+            `    console.log(\`Received \${op.amount} from @\${op.from} in block \${blockNumber}\`);`,
+            `});`,
+            ``,
+            `streamer.onPost((op, blockNumber) => {`,
+            `    console.log(\`New post by @\${op.author} in block \${blockNumber}\`);`,
+            `});`
+        ],
+        usage: [
+            {
+                title: 'Call the greeting contract',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('greeting', 'greet', '{"name":"Hive"}')
+            }
+        ]
+    },
+    {
+        id: 'game',
+        label: 'Game',
+        description: 'Provably-fair games of chance: dice, coinflip, roulette, and rock-paper-scissors.',
+        imports: [
+            'createCoinflipContract',
+            'createDiceContract',
+            'createRouletteContract',
+            'createRpsContract'
+        ],
+        registrations: [
+            `await streamer.registerContract(createDiceContract({ account: HIVE_USERNAME }));`,
+            `await streamer.registerContract(createCoinflipContract({ account: HIVE_USERNAME }));`,
+            `await streamer.registerContract(createRouletteContract({ account: HIVE_USERNAME }));`,
+            `await streamer.registerContract(createRpsContract({ account: HIVE_USERNAME }));`
+        ],
+        setup: [],
+        usage: [
+            {
+                title: 'Roll the dice',
+                description: 'Send HIVE to your app account with this transfer memo:',
+                payload: wrap('dice', 'roll', '{"roll":50}')
+            },
+            {
+                title: 'Flip a coin',
+                description: 'Send HIVE with this transfer memo:',
+                payload: wrap('coinflip', 'flip', '{"guess":"heads"}')
+            },
+            {
+                title: 'Spin the roulette wheel',
+                description: 'Send HIVE with this transfer memo:',
+                payload: wrap('roulette', 'spin', '{"betType":"color","value":"red"}')
+            },
+            {
+                title: 'Play rock-paper-scissors',
+                description: 'Send HIVE with this transfer memo:',
+                payload: wrap('rps', 'play', '{"move":"rock"}')
+            }
+        ]
+    },
+    {
+        id: 'exchange',
+        label: 'Exchange',
+        description: 'An on-chain order book exchange with deposits, orders, and a matching engine.',
+        imports: ['createExchangeContract', 'TimeAction'],
+        registrations: [
+            `await streamer.registerContract(createExchangeContract({`,
+            `    account: HIVE_USERNAME,`,
+            `    feeAccount: HIVE_USERNAME,`,
+            `    makerFeeBps: 10,`,
+            `    takerFeeBps: 20`,
+            `}));`
+        ],
+        setup: [
+            `// Run the order matcher every 30 seconds and snapshot the order book`,
+            `await streamer.registerAction(new TimeAction('30s', 'exchange-matcher', 'exchange', 'matchOrders', { limit: 50, snapshot: true, depth: 20 }));`
+        ],
+        usage: [
+            {
+                title: 'Create a trading pair',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('exchange', 'createPair', '{"base":"HIVE","quote":"HBD"}')
+            },
+            {
+                title: 'Deposit funds',
+                description: 'Send HIVE or HBD to your app account with this transfer memo:',
+                payload: wrap('exchange', 'deposit', '{}')
+            },
+            {
+                title: 'Place an order',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('exchange', 'placeOrder', '{"side":"buy","base":"HIVE","quote":"HBD","price":"2","amount":"5"}')
+            }
+        ]
+    },
+    {
+        id: 'social',
+        label: 'Social',
+        description: 'A social platform backend: fan clubs, subscriptions, tips, and post streaming.',
+        imports: [
+            'createFanClubContract',
+            'createSubscriptionContract',
+            'createTipJarContract'
+        ],
+        registrations: [
+            `await streamer.registerContract(createFanClubContract());`,
+            `await streamer.registerContract(createSubscriptionContract());`,
+            `await streamer.registerContract(createTipJarContract());`
+        ],
+        setup: [
+            `streamer.onPost((op, blockNumber) => {`,
+            `    console.log(\`New post by @\${op.author}: \${op.permlink} (block \${blockNumber})\`);`,
+            `});`,
+            ``,
+            `streamer.onComment((op, blockNumber) => {`,
+            `    console.log(\`New comment by @\${op.author} on @\${op.parent_author}/\${op.parent_permlink} (block \${blockNumber})\`);`,
+            `});`
+        ],
+        usage: [
+            {
+                title: 'Create a fan club',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('fanclub', 'createClub', '{"clubId":"my-club","title":"My Club","joinPrice":"1.000","asset":"HIVE"}')
+            },
+            {
+                title: 'Join a fan club',
+                description: 'Send the join price to your app account with this transfer memo:',
+                payload: wrap('fanclub', 'joinClub', '{"clubId":"my-club"}')
+            },
+            {
+                title: 'Create a subscription plan',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('subscription', 'createPlan', '{"planId":"monthly","title":"Monthly Supporter","price":"5.000","asset":"HIVE","intervalDays":30}')
+            },
+            {
+                title: 'Leave a tip',
+                description: 'Send any amount to your app account with this transfer memo:',
+                payload: wrap('tipjar', 'tip', '{"message":"Great work!"}')
+            }
+        ]
+    },
+    {
+        id: 'blog',
+        label: 'Blog',
+        description: 'A blogging backend: paywalled content, tips, and post/comment streaming.',
+        imports: ['createPaywallContract', 'createTipJarContract'],
+        registrations: [
+            `await streamer.registerContract(createPaywallContract());`,
+            `await streamer.registerContract(createTipJarContract());`
+        ],
+        setup: [
+            `streamer.onPost((op, blockNumber) => {`,
+            `    console.log(\`New post by @\${op.author}: \${op.permlink} (block \${blockNumber})\`);`,
+            `});`,
+            ``,
+            `streamer.onComment((op, blockNumber) => {`,
+            `    console.log(\`New comment by @\${op.author} on @\${op.parent_author}/\${op.parent_permlink} (block \${blockNumber})\`);`,
+            `});`
+        ],
+        usage: [
+            {
+                title: 'Create a paywalled resource',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('paywall', 'createResource', '{"resourceId":"premium-post","title":"Premium Post","price":"1.000","asset":"HBD","accessDays":30}')
+            },
+            {
+                title: 'Buy access',
+                description: 'Send the price to your app account with this transfer memo:',
+                payload: wrap('paywall', 'grantAccess', '{"resourceId":"premium-post"}')
+            },
+            {
+                title: 'Leave a tip',
+                description: 'Send any amount to your app account with this transfer memo:',
+                payload: wrap('tipjar', 'tip', '{"message":"Loved this post!"}')
+            }
+        ]
+    },
+    {
+        id: 'token',
+        label: 'Token & NFT',
+        description: 'Custom tokens and NFT collections with minting, transfers, and a marketplace.',
+        imports: ['createNFTContract', 'createTokenContract'],
+        registrations: [
+            `await streamer.registerContract(createTokenContract());`,
+            `await streamer.registerContract(createNFTContract({ name: 'nft' }));`
+        ],
+        setup: [],
+        usage: [
+            {
+                title: 'Create a token',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('token', 'createToken', '{"symbol":"MYTOKEN","name":"My Token","maxSupply":"1000000","precision":3}')
+            },
+            {
+                title: 'Issue tokens',
+                description: 'Broadcast a custom_json operation with id `hivestream` (token creator only):',
+                payload: wrap('token', 'issueTokens', '{"symbol":"MYTOKEN","to":"some-account","amount":"100"}')
+            },
+            {
+                title: 'Create an NFT collection',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('nft', 'createCollection', '{"symbol":"MYNFT","name":"My Collection"}')
+            }
+        ]
+    },
+    {
+        id: 'assets',
+        label: 'Assets & Tickets',
+        description: 'Non-custodial NFTs and event tickets: batch minting, direct peer-to-peer sales, and on-chain state checkpoints.',
+        imports: [
+            'createCheckpointContract',
+            'createNFTContract',
+            'createTicketingContract',
+            'TimeAction'
+        ],
+        registrations: [
+            `await streamer.registerContract(createNFTContract({ name: 'nft' }));`,
+            `await streamer.registerContract(createTicketingContract());`,
+            `await streamer.registerContract(createCheckpointContract({`,
+            `    account: HIVE_USERNAME,`,
+            `    tables: ['nft_collections', 'nft_tokens', 'nft_listings', 'ticket_events', 'tickets', 'ticket_listings']`,
+            `}));`
+        ],
+        setup: [
+            `// Publish a verifiable state hash on-chain every hour so anyone running`,
+            `// this open-source app can confirm they derive the same state`,
+            `await streamer.registerAction(new TimeAction('1h', 'state-checkpoint', 'checkpoint', 'publishCheckpoint', {}));`
+        ],
+        usage: [
+            {
+                title: 'Create an NFT collection',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('nft', 'createCollection', '{"symbol":"TICKETS","name":"Event Tickets","maxSupply":1000}')
+            },
+            {
+                title: 'Batch mint numbered editions',
+                description: 'Broadcast a custom_json operation with id `hivestream` (collection creator only):',
+                payload: wrap('nft', 'mintBatchNFT', '{"collectionSymbol":"TICKETS","to":"some-account","editions":{"baseTokenId":"GA","count":100}}')
+            },
+            {
+                title: 'List an NFT for sale',
+                description: 'Broadcast a custom_json operation with id `hivestream` (token owner only):',
+                payload: wrap('nft', 'listNFT', '{"collectionSymbol":"TICKETS","tokenId":"GA-1","price":"5.000","currency":"HIVE"}')
+            },
+            {
+                title: 'Buy an NFT non-custodially',
+                description: 'Send the exact price directly to the seller with this transfer memo (funds never touch the app account):',
+                payload: wrap('nft', 'buyNFTDirect', '{"collectionSymbol":"TICKETS","tokenId":"GA-1"}')
+            },
+            {
+                title: 'Create a ticketed event',
+                description: 'Broadcast a custom_json operation with id `hivestream`:',
+                payload: wrap('ticketing', 'createEvent', '{"eventId":"launch-party","title":"Launch Party","venue":"Online","startsAt":"2026-12-01T18:00:00Z","ticketPrice":"2.000","asset":"HBD","capacity":500}')
+            },
+            {
+                title: 'Buy a ticket',
+                description: 'Send the ticket price to your app account with this transfer memo:',
+                payload: wrap('ticketing', 'purchaseTicket', '{"eventId":"launch-party","ticketId":"launch-party:1"}')
+            },
+            {
+                title: 'Transfer a ticket',
+                description: 'Broadcast a custom_json operation with id `hivestream` (ticket owner only):',
+                payload: wrap('ticketing', 'transferTicket', '{"ticketId":"launch-party:1","to":"friend-account"}')
+            },
+            {
+                title: 'List a ticket for resale',
+                description: 'Broadcast a custom_json operation with id `hivestream` (ticket owner only):',
+                payload: wrap('ticketing', 'listTicket', '{"ticketId":"launch-party:1","price":"3.000"}')
+            },
+            {
+                title: 'Buy a resale ticket non-custodially',
+                description: 'Send the resale price directly to the seller with this transfer memo (funds never touch the app account):',
+                payload: wrap('ticketing', 'buyTicketDirect', '{"ticketId":"launch-party:1"}')
+            }
+        ]
+    }
+];
+exports.ADAPTERS = [
+    {
+        id: 'sqlite',
+        label: 'SQLite',
+        description: 'Zero-config local database. Great for development and single-node apps.',
+        importName: 'SqliteAdapter',
+        construct: `new SqliteAdapter()`,
+        envLines: []
+    },
+    {
+        id: 'mongodb',
+        label: 'MongoDB',
+        description: 'Document database for apps that need external or shared persistence.',
+        importName: 'MongodbAdapter',
+        construct: `new MongodbAdapter(process.env.MONGODB_URI ?? 'mongodb://localhost:27017', process.env.MONGODB_DATABASE ?? 'APP_NAME_PLACEHOLDER')`,
+        envLines: [
+            '# MongoDB connection',
+            'MONGODB_URI=mongodb://localhost:27017',
+            'MONGODB_DATABASE=APP_NAME_PLACEHOLDER'
+        ]
+    },
+    {
+        id: 'postgresql',
+        label: 'PostgreSQL',
+        description: 'SQL database with support for SQL-backed contract state.',
+        importName: 'PostgreSQLAdapter',
+        construct: `new PostgreSQLAdapter({ connectionString: process.env.DATABASE_URL ?? 'postgres://localhost:5432/APP_NAME_PLACEHOLDER' })`,
+        envLines: [
+            '# PostgreSQL connection',
+            'DATABASE_URL=postgres://localhost:5432/APP_NAME_PLACEHOLDER'
+        ]
+    }
+];
+function getTemplate(id) {
+    return exports.TEMPLATES.find((template) => template.id === id);
+}
+function getAdapter(id) {
+    return exports.ADAPTERS.find((adapter) => adapter.id === id);
+}
+//# sourceMappingURL=templates.js.map