create-canton-app 1.0.0

package/README.md

@@ -0,0 +1,51 @@
+# create-canton-app
+Scaffold Canton Network Daml projects in seconds. A CLI tool to quickly bootstrap Canton Network dApp.
+
+## Adding Custom Templates
+
+1. Create Your Template folder with a 'daml' subdir (rename 'my-template' as your desired template name)
+
+```bash
+mkdir -p src/templates/my-template/daml
+```
+
+2. Add your Daml contract
+
+Create `src/templates/my-template/daml/MyContract.daml`
+
+3. Update CLI choices
+
+Edit `src/commands/create.js` line 43:
+
+```javascript
+choices: [
+  { name: 'Token Contract', value: 'token' },
+
+  { name: 'Escrow Contract', value: 'escrow' },
+
+  { name: 'My Template', value: 'my-template' }, // ADD THIS
+
+  { name: '📄 Empty Template', value: 'empty' }
+]
+```
+
+4. Test it
+
+```bash
+cd test-my-template
+daml build
+daml test
+```
+
+## Template Checklist
+
+- [ ] Compiles with `daml build`
+- [ ] Tests pass with `daml test`
+- [ ] Includes inline comments
+- [ ] Has clear use case
+- [ ] daml.yaml includes `daml-script` dependency
+
+## Requirements
+- Node.js v16+
+- Daml SDK v3.4.9+
+- Java Runtime (for tests)

package/bin/create-canton-app.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const create = require('../src/commands/create');
+const compile = require('../src/commands/compile');
+const test = require('../src/commands/test');
+
+// Simple banner without chalk.bold
+console.log('\x1b[36m%s\x1b[0m', `
+   ____            _              
+  / ___|__ _ _ __ | |_ ___  _ __  
+ | |   / _\` | '_ \\| __/ _ \\| '_ \\ 
+ | |__| (_| | | | | || (_) | | | |
+  \\____\\__,_|_| |_|\\__\\___/|_| |_|
+                                   
+  Canton Network Developer CLI
+  Build privacy-first dApps in minutes
+`);
+
+program
+  .name('create-canton-app')
+  .description('Scaffold Canton/Daml projects instantly')
+  .version('0.1.0');
+
+// Main create command
+program
+  .argument('[project-name]', 'Name of your project')
+  .option('-t, --template <type>', 'Template to use (token, escrow, empty)', 'token')
+  .option('--no-tests', 'Skip test files')
+  .action(create);
+
+// Compile command
+program
+  .command('compile')
+  .description('Compile your Daml contracts')
+  .action(compile);
+
+// Test command
+program
+  .command('test')
+  .description('Run your contract tests')
+  .action(test);
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "create-canton-app",
+  "version": "1.0.0",
+  "description": "Scaffold Canton Network/Daml projects in seconds",
+  "main": "bin/create-canton-app.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jatinp26/create-canton-app.git"
+  },
+    "bin": {
+    "create-canton-app": "./bin/create-canton-app.js",
+    "canton-dev": "./bin/create-canton-app.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "canton",
+    "daml",
+    "blockchain"
+  ],
+  "author": "Jatin Pandya <Jatin@canton.foundation>",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "4.1.2",
+    "commander": "^11.1.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "8.2.6",
+    "ora": "5.4.1",
+    "shelljs": "^0.8.5"
+  }
+}

package/src/commands/compile.js

@@ -0,0 +1,39 @@
+const ora = require('ora');
+const shell = require('shelljs');
+
+const colors = {
+  red: (text) => `\x1b[31m${text}\x1b[0m`,
+  green: (text) => `\x1b[32m${text}\x1b[0m`,
+  yellow: (text) => `\x1b[33m${text}\x1b[0m`,
+  white: (text) => `\x1b[37m${text}\x1b[0m`
+};
+
+function compile() {
+  console.log('');
+  const spinner = ora('Compiling Daml contracts...').start();
+
+  // Check if daml is installed
+  if (!shell.which('daml')) {
+    spinner.fail(colors.red('Daml SDK not found!'));
+    console.log('');
+    console.log(colors.yellow('Install Daml SDK:'));
+    console.log(colors.white('  curl -sSL https://get.daml.com/ | sh'));
+    console.log('');
+    process.exit(1);
+  }
+
+  // Run daml build
+  const result = shell.exec('daml build', { silent: true });
+
+  if (result.code !== 0) {
+    spinner.fail(colors.red('Compilation failed!'));
+    console.log('');
+    console.log(colors.red(result.stderr));
+    process.exit(1);
+  }
+
+  spinner.succeed(colors.green('Contracts compiled successfully!'));
+  console.log('');
+}
+
+module.exports = compile;

package/src/commands/create.js

@@ -0,0 +1,163 @@
+const inquirer = require('inquirer');
+const ora = require('ora');
+const fs = require('fs-extra');
+const path = require('path');
+const shell = require('shelljs');
+
+const colors = {
+  red: (text) => `\x1b[31m${text}\x1b[0m`,
+  green: (text) => `\x1b[32m${text}\x1b[0m`,
+  cyan: (text) => `\x1b[36m${text}\x1b[0m`,
+  yellow: (text) => `\x1b[33m${text}\x1b[0m`,
+  white: (text) => `\x1b[37m${text}\x1b[0m`,
+  dim: (text) => `\x1b[2m${text}\x1b[0m`,
+  bold: (text) => `\x1b[1m${text}\x1b[0m`
+};
+
+async function create(projectName, options) {
+  try {
+    if (!projectName) {
+      const answers = await inquirer.prompt([
+        {
+          type: 'input',
+          name: 'projectName',
+          message: 'What is your project name?',
+          default: 'my-canton-app'
+        }
+      ]);
+      projectName = answers.projectName;
+    }
+
+    let template = options.template;
+    if (!template) {
+      const answers = await inquirer.prompt([
+        {
+          type: 'list',
+          name: 'template',
+          message: 'Which template would you like to use?',
+          choices: [
+            { name: '🪙  Token Contract (fungible token like ERC20)', value: 'token' },
+            { name: '🤝  Escrow Contract (multi-party escrow)', value: 'escrow' },
+            { name: '📄  Empty Template (blank starter)', value: 'empty' }
+          ]
+        }
+      ]);
+      template = answers.template;
+    }
+
+    console.log('');
+    const spinner = ora('Creating your Canton project...').start();
+
+    const projectPath = path.join(process.cwd(), projectName);
+    
+    if (fs.existsSync(projectPath)) {
+      spinner.fail(colors.red(`Folder ${projectName} already exists!`));
+      process.exit(1);
+    }
+
+    fs.mkdirSync(projectPath);
+
+    const templatePath = path.join(__dirname, '../templates', template);
+    if (fs.existsSync(templatePath)) {
+      fs.copySync(templatePath, projectPath);
+    } else {
+      spinner.warn(colors.yellow(`Template ${template} not found, creating empty structure...`));
+      fs.mkdirSync(path.join(projectPath, 'daml'), { recursive: true });
+    }
+
+    fs.mkdirSync(path.join(projectPath, 'scripts'), { recursive: true });
+    fs.mkdirSync(path.join(projectPath, 'config'), { recursive: true });
+
+    createScripts(projectPath);
+    createConfig(projectPath, projectName);
+    createReadme(projectPath, projectName, template);
+    createGitignore(projectPath);
+
+    spinner.succeed(colors.green('✨ Project created successfully!'));
+
+    console.log('');
+    console.log(colors.cyan(colors.bold('📚 Next steps:')));
+    console.log('');
+    console.log(colors.white(`  cd ${projectName}`));
+    console.log(colors.white(`  daml build          ${colors.dim('# Compile your contracts')}`));
+    console.log(colors.white(`  daml test           ${colors.dim('# Run tests')}`));
+    console.log('');
+    console.log(colors.dim('📖 Read README.md for more information'));
+    console.log('');
+
+  } catch (error) {
+    console.error(colors.red('❌ Error creating project:'), error.message);
+    process.exit(1);
+  }
+}
+
+function createScripts(projectPath) {
+  const compileScript = `#!/bin/bash
+echo "🔨 Compiling Daml contracts..."
+daml build
+`;
+  fs.writeFileSync(path.join(projectPath, 'scripts/compile.sh'), compileScript);
+
+  const testScript = `#!/bin/bash
+echo "🧪 Running tests..."
+daml test
+`;
+  fs.writeFileSync(path.join(projectPath, 'scripts/test.sh'), testScript);
+
+  try {
+    shell.chmod('+x', path.join(projectPath, 'scripts/*.sh'));
+  } catch (e) {}
+}
+
+function createConfig(projectPath, projectName) {
+  // THE FIX: Added daml-script dependency!
+  const damlConfig = `sdk-version: 3.4.9
+name: ${projectName}
+source: daml
+version: 1.0.0
+dependencies:
+  - daml-prim
+  - daml-stdlib
+  - daml-script
+`;
+  fs.writeFileSync(path.join(projectPath, 'daml.yaml'), damlConfig);
+}
+
+function createGitignore(projectPath) {
+  const gitignore = `.daml/
+*.dar
+*.log
+node_modules/
+.DS_Store
+`;
+  fs.writeFileSync(path.join(projectPath, '.gitignore'), gitignore);
+}
+
+function createReadme(projectPath, projectName, template) {
+  const readme = `# ${projectName}
+
+> A Canton Network dApp built with create-canton-app
+
+## Template: ${template}
+
+## Quick Start
+
+\`\`\`bash
+# Compile contracts
+daml build
+
+# Run tests
+daml test
+\`\`\`
+
+## Learn More
+
+- [Canton Docs](https://docs.digitalasset.com)
+- [Daml Docs](https://docs.daml.com)
+- [Canton Network](https://canton.network)
+`;
+  
+  fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
+}
+
+module.exports = create;

package/src/commands/test.js

@@ -0,0 +1,41 @@
+const ora = require('ora');
+const shell = require('shelljs');
+
+const colors = {
+  red: (text) => `\x1b[31m${text}\x1b[0m`,
+  green: (text) => `\x1b[32m${text}\x1b[0m`,
+  yellow: (text) => `\x1b[33m${text}\x1b[0m`,
+  white: (text) => `\x1b[37m${text}\x1b[0m`,
+  dim: (text) => `\x1b[2m${text}\x1b[0m`
+};
+
+function test() {
+  console.log('');
+  const spinner = ora('Running tests...').start();
+
+  // Check if daml is installed
+  if (!shell.which('daml')) {
+    spinner.fail(colors.red('Daml SDK not found!'));
+    console.log('');
+    console.log(colors.yellow('Install Daml SDK:'));
+    console.log(colors.white('  curl -sSL https://get.daml.com/ | sh'));
+    console.log('');
+    process.exit(1);
+  }
+
+  // Run daml test
+  const result = shell.exec('daml test', { silent: true });
+
+  if (result.code !== 0) {
+    spinner.fail(colors.red('Tests failed!'));
+    console.log('');
+    console.log(colors.red(result.stderr));
+    process.exit(1);
+  }
+
+  spinner.succeed(colors.green('All tests passed!'));
+  console.log('');
+  console.log(colors.dim(result.stdout));
+}
+
+module.exports = test;

package/src/templates/empty/daml/Main.daml

@@ -0,0 +1,22 @@
+-- Main.daml
+-- Your Canton smart contract starts here!
+
+module Main where
+
+import Daml.Script
+
+template MyContract
+  with
+    party1 : Party
+  where
+    signatory party1
+
+setup : Script ()
+setup = script do
+  alice <- allocateParty "Alice"
+  
+  submit alice do
+    createCmd MyContract with
+      party1 = alice
+
+  return ()

package/src/templates/escrow/daml/Escrow.daml

@@ -0,0 +1,53 @@
+-- Escrow.daml
+-- A two-party escrow with an arbiter
+
+module Escrow where
+
+import Daml.Script
+
+template EscrowAgreement
+  with
+    buyer : Party
+    seller : Party
+    arbiter : Party
+    amount : Decimal
+    description : Text
+  where
+    signatory buyer, seller, arbiter
+
+    choice Release : ()
+      controller buyer
+      do
+        return ()
+
+    choice Dispute : ()
+      with
+        decision : Text
+      controller arbiter
+      do
+        return ()
+
+    choice Cancel : ()
+      controller buyer, seller
+      do
+        return ()
+
+setup : Script ()
+setup = script do
+  alice <- allocateParty "Alice"
+  bob <- allocateParty "Bob"
+  charlie <- allocateParty "Charlie"
+
+  escrow <- submit alice do
+    submitMulti [alice, bob, charlie] [] do
+      createCmd EscrowAgreement with
+        buyer = alice
+        seller = bob
+        arbiter = charlie
+        amount = 1000.0
+        description = "Laptop purchase"
+
+  submit alice do
+    exerciseCmd escrow Release
+
+  return ()

package/src/templates/token/daml/Tests.daml

@@ -0,0 +1,67 @@
+-- Tests.daml
+-- Test suite for the Token contract
+
+module Tests where
+
+import Daml.Script
+import Token
+
+-- Test: Token creation
+testTokenCreation : Script ()
+testTokenCreation = script do
+  alice <- allocateParty "Alice"
+  issuer <- allocateParty "Issuer"
+
+  token <- submit issuer do
+    createCmd Token with
+      issuer = issuer
+      owner = alice
+      amount = 100.0
+      symbol = "TEST"
+
+  Some tokenData <- queryContractId alice token
+  assert (tokenData.amount == 100.0)
+  assert (tokenData.symbol == "TEST")
+
+-- Test: Token transfer
+testTokenTransfer : Script ()
+testTokenTransfer = script do
+  alice <- allocateParty "Alice"
+  bob <- allocateParty "Bob"
+  issuer <- allocateParty "Issuer"
+
+  token <- submit issuer do
+    createCmd Token with
+      issuer = issuer
+      owner = alice
+      amount = 50.0
+      symbol = "TEST"
+
+  newToken <- submit alice do
+    exerciseCmd token Transfer with newOwner = bob
+
+  Some tokenData <- queryContractId bob newToken
+  assert (tokenData.owner == bob)
+  assert (tokenData.amount == 50.0)
+
+-- Test: Token split
+testTokenSplit : Script ()
+testTokenSplit = script do
+  alice <- allocateParty "Alice"
+  issuer <- allocateParty "Issuer"
+
+  token <- submit issuer do
+    createCmd Token with
+      issuer = issuer
+      owner = alice
+      amount = 100.0
+      symbol = "TEST"
+
+  (token1, token2) <- submit alice do
+    exerciseCmd token Split with splitAmount = 30.0
+
+  Some data1 <- queryContractId alice token1
+  Some data2 <- queryContractId alice token2
+  
+  assert (data1.amount == 30.0)
+  assert (data2.amount == 70.0)

package/src/templates/token/daml/Token.daml

@@ -0,0 +1,56 @@
+-- Token.daml
+-- A simple fungible token on Canton Network
+
+module Token where
+
+import Daml.Script
+
+-- The Token template represents a token holding
+template Token
+  with
+    issuer : Party
+    owner : Party
+    amount : Decimal
+    symbol : Text
+  where
+    signatory issuer
+    observer owner
+
+    -- Transfer tokens to another party
+    choice Transfer : ContractId Token
+      with
+        newOwner : Party
+      controller owner
+      do
+        create this with owner = newOwner
+
+    -- Split tokens (for partial transfers)
+    choice Split : (ContractId Token, ContractId Token)
+      with
+        splitAmount : Decimal
+      controller owner
+      do
+        assertMsg "Split amount must be less than total" (splitAmount < amount)
+        token1 <- create this with amount = splitAmount
+        token2 <- create this with amount = amount - splitAmount
+        return (token1, token2)
+
+-- Example: How to use this in practice
+setup : Script ()
+setup = script do
+  alice <- allocateParty "Alice"
+  bob <- allocateParty "Bob"
+  issuer <- allocateParty "TokenIssuer"
+
+  aliceToken <- submit issuer do
+    createCmd Token with
+      issuer = issuer
+      owner = alice
+      amount = 1000.0
+      symbol = "TEST"
+
+  submit alice do
+    exerciseCmd aliceToken Transfer with
+      newOwner = bob
+
+  return ()