Add hello world to program-examples

Author: ksolana

basics/hello-solana/move/Move.toml

@@ -0,0 +1,7 @@
+[package]
+name = "hello"
+version = "1.0.0"
+
+[addresses]
+hello = "0xba31"
+

basics/hello-solana/move/bin/hello_solana_move_program.so

@@ -0,0 +1,16 @@
+{
+    "program_id": "DozgQiYtGbdyniV2T74xMdmjZJvYDzoRFFqw7UR5MwPK",
+    "accounts": [
+        {
+            "key": "524HMdYYBy6TAn4dK5vCcjiTmT2sxV6Xoue5EXrz22Ca",
+            "owner": "BPFLoaderUpgradeab1e11111111111111111111111",
+            "is_signer": false,
+            "is_writable": true,
+            "lamports": 1000,
+            "data": [0, 0, 0, 3]
+        }
+    ],
+    "instruction_data": [
+        11, 0, 0, 0, 0, 0, 0, 0,
+        104, 101, 108, 108, 111, 95, 95, 109, 97, 105, 110]
+}

basics/hello-solana/move/bin/input.json

@@ -0,0 +1,21 @@
+{
+  "scripts": {
+    "test": "pnpm ts-mocha -p ./tsconfig.json -t 1000000 ./tests/test.ts",
+    "build-and-test": "cargo build-sbf --manifest-path=./program/Cargo.toml --sbf-out-dir=./tests/fixtures && pnpm test",
+    "build": "cargo build-sbf --manifest-path=./program/Cargo.toml --sbf-out-dir=./program/target/so",
+    "deploy": "pnpm ts-mocha -p ./tsconfig.json -t 1000000 ./tests/deploy.ts"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.47.3"
+  },
+  "devDependencies": {
+    "@types/bn.js": "^5.1.0",
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "chai": "^4.3.4",
+    "mocha": "^9.0.3",
+    "solana-bankrun": "^0.3.0",
+    "ts-mocha": "^10.0.0",
+    "typescript": "^4.3.5"
+  }
+}

basics/hello-solana/move/package.json

@@ -0,0 +1,15 @@
+module 0x10::debug {
+  native public fun print<T>(x: &T);
+}
+
+module hello::hello {
+    use 0x10::debug;
+    use 0x1::string;
+
+    public entry fun main() : u64 {
+        let rv = 0;
+        let s = string::utf8(b"Hello Solana");
+        debug::print(&s);
+        rv
+    }
+}

basics/hello-solana/move/sources/lib.move

@@ -0,0 +1,45 @@
+// Deploy a solana program by execing a shell.
+// Returns stdout when the deploy was successful.
+export async function deployProgramShell(programPath: string) {
+  const util = require('util');
+  const exec = util.promisify(require('child_process').exec);
+  try {
+    const { stdout, stderr } = await exec(`solana program deploy ${programPath}`);
+    if (stderr) {
+      return stderr;
+    }
+    return stdout;
+  } catch (e) {
+    console.error(e);
+    return e;
+  }
+}
+
+export function parseProgramID(programIdLog: string) : string {
+  // The string should of of the following form, else it is an error.
+  // Program Id: 5K4yQ8KW2CKsBVRUw2193GMnkKBKXDm6sdXnYY1cB4Hy
+  programIdLog = programIdLog.trim();
+  let templateString : string = 'Program Id: 5K4yQ8KW2CKsBVRUw2193GMnkKBKXDm6sdXnYY1cB4Hy';
+  let logLength = templateString.length;
+  if (programIdLog.length != logLength) {
+    console.log(`Different lenghts. Expected: ${logLength} vs. ${programIdLog.length}`);
+    return null;
+  }
+  if (!programIdLog.startsWith('Program Id:')){
+    console.log('program does not starts with.');
+    return null;
+  }
+  const programId = programIdLog.substring('Program Id: '.length);
+  return programId;
+}
+
+async function main() {
+  const programPath = 'bin/hello_solana_move_program.so';
+  const programIdLog = await deployProgramShell(programPath);
+  const programId = parseProgramID(programIdLog);
+  if (programId) {
+    console.log('Program deployed with', programId);
+    return 0;
+  }
+  return -1;
+}

basics/hello-solana/move/tests/deploy.ts

@@ -0,0 +1,72 @@
+import { describe, test } from 'node:test';
+import { assert } from 'chai';
+import {deployProgramShell, parseProgramID} from './deploy';
+
+import {
+    Connection,
+    Keypair,
+    PublicKey,
+    sendAndConfirmTransaction,
+    Transaction,
+    TransactionInstruction,
+} from '@solana/web3.js';
+
+function createKeypairFromFile(path: string): Keypair {
+    return Keypair.fromSecretKey(
+        Buffer.from(JSON.parse(require('fs').readFileSync(path, "utf-8")))
+    )
+};
+
+function getInstructionData(path: string): Buffer {
+  // instruction_data (See: sui/external-crates/move/solana/move-mv-llvm-compiler/docs/Entrypoint.md)
+  let j = JSON.parse(require('fs').readFileSync(path, "utf-8"));
+  return j['instruction_data'];
+}
+
+async function deployProgram(programPath: string) : Promise<string> {
+  const programIdLog = await deployProgramShell(programPath);
+  const programId = await parseProgramID(programIdLog);
+  if (programId) {
+    console.log('Program deployed with', programId);
+    return programId;
+  }
+  console.log('Program could not be deployed');
+  return null;
+}
+
+describe("hello-solana", async () => {
+    // Loading these from local files for development
+    const connection = new Connection(`http://localhost:8899`, 'confirmed');
+    const payer = createKeypairFromFile(require('os').homedir() + '/.config/solana/id.json');
+    // PublicKey of the deployed program.
+    const programPath = 'bin/hello_solana_move_program.so';
+    const programIdStr = await deployProgram(programPath);
+    const programId = new PublicKey(programIdStr);
+    const instructionData = getInstructionData('bin/input.json');
+
+    it("Say hello!", async () => {
+        // Set up transaction instructions first.
+        let ix = new TransactionInstruction({
+            keys: [
+                {pubkey: payer.publicKey, isSigner: true, isWritable: true}
+            ],
+            programId,
+            data: instructionData,
+        });
+
+        // Send the transaction over RPC
+        let signature = await sendAndConfirmTransaction(
+            connection,
+            new Transaction().add(ix), // Add our instruction (you can add more than one)
+            [payer]
+        );
+
+        let transaction = await connection.getTransaction(signature, {commitment: "confirmed"});
+        console.log(transaction);
+        assert(transaction?.meta?.logMessages[0].startsWith(`Program ${programId}`));
+        // 'Hello Solana' as bytes
+        assert(transaction?.meta?.logMessages[1] === 'Program log: 0000000000000000000000000000000000000000000000000000000000000001::string::String { bytes: [72, 101, 108, 108, 111, 32, 83, 111, 108, 97, 110, 97], }');
+        assert(transaction?.meta?.logMessages[2] === `Program ${programId} consumed 5331 of 200000 compute units`);
+        assert(transaction?.meta?.logMessages[3] === `Program ${programId} success`);
+    });
+  });

basics/hello-solana/move/tests/test.ts

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "types": ["mocha", "chai"],
+    "typeRoots": ["./node_modules/@types"],
+    "lib": ["es2015"],
+    "module": "commonjs",
+    "target": "es6",
+    "esModuleInterop": true
+  }
+}