@harmoniclabs/pebble-cli 0.1.3-dev4 → 0.1.3-dev6

package/dist/init/initPebbleProject.js

@@ -10,11 +10,18 @@ export async function initPebbleProject() {
         message: "What is the name of your project?",
         default: "my-pebble-project",
     });
+    const includeClaudeMd = await confirm({
+        message: "Do you want to include a CLAUDE.md file? (helps AI assistants understand Pebble)",
+        default: true
+    });
     let offchain = undefined;
-    const includeOffchain = await confirm({
+    const includeOffchain = /*
+    await confirm({
         message: "Do you want to include offchain code using buildooor?",
         default: false
     });
+    /*/ false;
+    //*/
     if (includeOffchain) {
         const network = await select({
             message: "Which network would you like to target?",
@@ -196,6 +203,123 @@ contract MyContract {
     // propose proposeGovernanceAction () {}
 }`);
     await writeFile(indexPebblePath, indexPebble);
+    // CLAUDE.md
+    if (includeClaudeMd) {
+        const claudeMdPath = path.join(projectRoot, "CLAUDE.md");
+        const claudeMd = (`# Pebble Project
+
+This is a Pebble smart contract project. Pebble is a language with JavaScript-like syntax that compiles to UPLC for Cardano smart contracts.
+
+## Project structure
+
+- \`src/index.pebble\` - main contract entry point
+- \`pebble.config.json\` - compiler config (entry, outDir, removeTraces)
+- \`out/\` - compiled output (generated)
+${includeOffchain ? "- \\`offchain/\\` - offchain code using buildooor\n" : ""}\
+## CLI commands
+
+- \`pebble compile --config ./pebble.config.json\` - compile the project
+- \`pebble export --function-name <name>\` - export a single function
+- \`npm run compile\` - shortcut for compile
+
+## Pebble language reference
+
+### Contracts
+
+\`\`\`pebble
+contract ContractName {
+    param owner: PubKeyHash;
+
+    spend methodName(arg: int) {
+        const { tx } = context;
+        assert tx.requiredSigners.includes(this.owner);
+    }
+}
+\`\`\`
+
+A contract with no methods is an always-failing validator.
+
+### Method types
+
+\`spend\`, \`mint\`, \`cert\`, \`withdraw\`, \`vote\`, \`propose\`
+
+### Context
+
+Inside contract methods, \`context\` provides:
+- \`tx\` - the transaction (always available)
+- \`spendingInputRef\` - reference to the UTxO being spent (\`spend\` methods)
+- \`optionalDatum\` - optional datum on the spent UTxO (\`spend\` methods)
+
+### Tx fields
+
+\`tx.inputs\`, \`tx.refInputs\`, \`tx.outputs\`, \`tx.fee\`, \`tx.mint\`,
+\`tx.certificates\`, \`tx.withdrawals\`, \`tx.validityInterval\`,
+\`tx.requiredSigners\`, \`tx.redeemers\`, \`tx.datums\`, \`tx.hash\`,
+\`tx.votes\`, \`tx.proposals\`, \`tx.currentTreasury\`, \`tx.treasuryDonation\`
+
+### Structs
+
+\`\`\`pebble
+struct Order {
+    ownerPaymentCreds: PubKeyHash,
+    policy: bytes,
+    minAmount: int
+}
+\`\`\`
+
+Sum types (data structs):
+
+\`\`\`pebble
+struct OutputDatum {
+    NoDatum {}
+    DatumHash { hash: Hash32 }
+    InlineDatum { datum: data }
+}
+\`\`\`
+
+### Built-in types
+
+\`int\`, \`bytes\`, \`bool\`, \`data\`,
+\`PubKeyHash\`, \`ScriptHash\`, \`Hash32\`, \`Hash28\`,
+\`PolicyId\`, \`TokenName\`, \`TxHash\`,
+\`Credential\`, \`Address\`, \`Value\`, \`TxOut\`, \`TxIn\`, \`TxOutRef\`,
+\`List<T>\`, \`Optional<T>\`, \`LinearMap<K,V>\`, \`Interval\`
+
+### Variables and control flow
+
+- \`const x = value;\` / \`let x = value;\`
+- \`if/else\`, ternary \`? :\`
+- \`for(const x of list)\`, \`for(let i = 0; i < n; i++)\`
+- \`assert condition;\` - fails the contract if false
+- \`trace value;\` - debug output
+- \`fail;\` - explicitly fail
+
+### Pattern matching
+
+\`\`\`pebble
+assert case ownerCreds
+    is PubKeyHash{ hash } => tx.signatories.includes(hash)
+    is Validator{ hash } => tx.inputs.some(input => input.resolved.address.payment.hash() === hash);
+\`\`\`
+
+### Datum extraction
+
+\`\`\`pebble
+const InlineDatum{ datum: { field1, field2 } as MyStruct } = someOutput.datum;
+\`\`\`
+
+### Common operations
+
+- \`list.includes(item)\`, \`list.filter(fn)\`, \`list.find(fn)\`, \`list.some(fn)\`
+- \`list.head()\`, \`list.tail()\`, \`list.isEmpty()\`, \`list.length()\`
+- \`value.lovelaces()\`, \`value.amountOf(policy, tokenName)\`
+- \`credential.hash()\`
+- Hex literals: \`#aabbcc\`
+- Numeric separators: \`5_000_000\`
+- Access contract params with \`this.paramName\`
+`);
+        await writeFile(claudeMdPath, claudeMd);
+    }
     // optional offchain scaffolding
     if (includeOffchain && offchain) {
         const offchainReadme = `# Offchain

package/dist/version.generated.d.ts

@@ -1,3 +1,3 @@
-export declare const PEBBLE_VERSION = "0.1.3-dev4";
-export declare const PEBBLE_LIB_VERSION = "0.1.3-dev4";
-export declare const PEBBLE_COMMIT_HASH = "a29d13ab47da3ed8bd8f3fbf597fd7e27a105cc9";
+export declare const PEBBLE_VERSION = "0.1.3-dev6";
+export declare const PEBBLE_LIB_VERSION = "0.1.3-dev6 (local)";
+export declare const PEBBLE_COMMIT_HASH = "e6215f4969bf146ef3e6cccaa0b9802dd852690b";

package/dist/version.generated.js

@@ -1,4 +1,4 @@
 // This file is auto-generated by scripts/genVersions.js. Do not edit.
-export const PEBBLE_VERSION = "0.1.3-dev4";
-export const PEBBLE_LIB_VERSION = "0.1.3-dev4";
-export const PEBBLE_COMMIT_HASH = "a29d13ab47da3ed8bd8f3fbf597fd7e27a105cc9";
+export const PEBBLE_VERSION = "0.1.3-dev6";
+export const PEBBLE_LIB_VERSION = "0.1.3-dev6 (local)";
+export const PEBBLE_COMMIT_HASH = "e6215f4969bf146ef3e6cccaa0b9802dd852690b";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harmoniclabs/pebble-cli",
-  "version": "0.1.3-dev4",
+  "version": "0.1.3-dev6",
   "description": "A simple, yet rock solid, functional language with an imperative bias, targeting UPLC",
   "bin": {
     "pebble": "./dist/index.js",
@@ -50,7 +50,7 @@
   "dependencies": {
     "@harmoniclabs/crypto": "^0.3.0",
     "@harmoniclabs/obj-utils": "^1.0.0",
-    "@harmoniclabs/pebble": "^0.1.3-dev4",
+    "@harmoniclabs/pebble": "harmoniclabs-pebble-0.1.3-dev6.tgz",
     "@harmoniclabs/plutus-machine": "^3.0.0",
     "@harmoniclabs/uint8array-utils": "^1.0.4",
     "@harmoniclabs/uplc": "^2.0.5",
@@ -65,4 +65,4 @@
     "typescript": "^4.6.3"
   },
   "funding": "https://github.com/sponsors/HarmonicLabs"
-}
+}