Hello World Example

The repository is intended as part of the tutorial flow for the hello-world example in the Midnight documentation. It does not operate as a complete repository without the accompanying documentation.

The below documentation will be provided here to "finish" this example.

Set up project

git clone https://github.com/nstanford5/compact-hello-world.git

Install dependencies:

npm install

Create the required directories:

mkdir contracts

The contracts folder will contain your Compact smart contract source files.

Create the contract file

Create a new file named hello-world.compact in the contracts directory:

touch contracts/hello-world.compact

Open this file in VS Code:

code .

Create the Compact Smart Contract

pragma language_version 0.21;

export ledger message: Opaque<"string">;

export circuit storeMessage(newMessage: Opaque<"string">): [] {
  message = disclose(newMessage);
}

• pragma language_version specifies which version of Compact your contract uses.
• ledger message creates a state variable named message that stores a string value in the on-chain state. On-chain state is public and persistent on the blockchain.
• circuit storeMessage is a Compact circuit (function) that defines the logic to modify on-chain state.
• newMessage: Opaque<"string"> is the input parameter. Circuit parameters are always private by default. The disclose() function marks the private value as safe to store publicly. Without it, trying to assign newMessage directly to the ledger returns a compiler error.

Compile the contract

Compiling transforms your Compact code into zero-knowledge circuits, generates cryptographic keys, and creates TypeScript APIs and a JavaScript implementation for the contract to be used by DApps.

Run the compiler from your project root:

npm run compile

You should see the following output:

Compiling 1 circuits:
  circuit "storeMessage" (k=6, rows=26)

The compilation process will:

1. Parse and validate your Compact code.
2. Generate zero-knowledge circuits from your logic.
3. Create proving and verifying keys for the circuits.
4. Generate the TypeScript API and JavaScript implementation for the contract.

When compilation completes, you'll see a new directory structure:

contracts/
├── managed/
|   └── hello-world/
|        ├── compiler/
|        ├── contract/
|        ├── keys/
|        └── zkir/
└── hello-world.compact

Here's what each directory contains:

• contract/: The compiled contract artifacts, which includes the JavaScript implementation and type definitions.
• keys/: Cryptographic proving and verifying keys that enable zero-knowledge proofs.
• zkir/: Zero-Knowledge Intermediate Representation—the bridge between Compact and the ZK backend.
• compiler/: Compiler-generated JSON output that other tools can use to understand the contract structure.

Deploy Contract to Preprod

Now that your contract is compiled, it needs to be deployed to the blockchain so that you can interact with it.

Be sure the Docker engine is running and in a separate terminal start the proof server from the project root:

npm run start-proof-server

Leave the proof server running for the following steps.

To deploy the contract, you'll need a wallet. The deploy script will help you create a new wallet.

:::note Be sure to save the seed phrase as you'll need it in the following steps. :::

Run the deployment script:

npm run deploy

Deployment Failed!

You should have noticed a failure in deploying your contract:

(FiberFailure) Wallet.Transacting: Not enough Dust generated to pay the fee

This is because the Midnight network requires DUST to pay for your transactions. DUST is generated by the NIGHT you received from the faucet, but it takes time to generate. The more NIGHT you have, the faster DUST generates. Enough tricks, let's deploy and interact with your Compact contract.

Run the deployment script again, this time choosing option 2 'Restore from seed'. Be sure to paste the seed from your previously created wallet:

npm run deploy

When deployment completes, you'll see output similar to the following:

✅ Contract deployed successfully!

Contract Address: 0x1234567890abcdef...

Saved to deployment.json

Contract interaction

Now that the contract has been successfully deployed, let's interact with it:

npm run cli

Enter your wallet seed when prompted and wait to connect to the Preprod network.

Choose option [2] to verify the current message is an "(empty)" string:

  [1] Store a message
  [2] Read current message
  [3] Exit

Then choose option 1 and enter "Hello World!" when prompted. You should then see a successful storage of your message:

 ✅ Message stored!
  Transaction: 0007f15ce66f14b01ff7d5c2b4fbf4a40f65630cd7950785a81832b11103c5a0f1
  Block: 402893

Now choose option [2] again, this time returning your "Hello World!" message:

  Reading message from blockchain...
  Current message: "Hello World!"

Hello World! You are now ready to explore Tutorials for more detailed instructions on building DApps on Midnight!