ic-mops 0.39.2 → 0.41.0

package/.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+bundle
 cli.js
 identity.pem
 network.txt

package/.npmrc

@@ -1 +1,2 @@
-save-exact = true
+save-exact = true
+# omit = optional

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Mops CLI Changelog
+
+## 0.41.0
+- Add `mops self update` command to update the CLI to the latest version
+- Add `mops self uninstall` command to uninstall the CLI
+
+## 0.40.0
+- Publish package benchmarks

package/DEVELOPMENT.md

@@ -0,0 +1,25 @@
+# Mops CLI
+
+1. Update the version in `package.json` using `npm version` command.
+
+2. Update changelog in `CHANGELOG.md` file.
+
+3. Publish.
+
+## Publish to npm
+```
+npm publish
+```
+
+## Publish on chain
+
+1. Prepeare release
+```
+npm run release
+```
+
+2. Deploy canister
+(from root of the project)
+```
+dfx deploy --network ic --no-wallet cli
+```

package/api/actors.ts

@@ -9,7 +9,7 @@ import {_SERVICE as _STORAGE_SERVICE} from '../declarations/storage/storage.did.
 import {getEndpoint} from './network.js';
 import {getNetwork} from './network.js';
 
-export let mainActor = async (identity?: Identity): Promise<_SERVICE> => {
+export let mainActor = async (identity ?: Identity) : Promise<_SERVICE> => {
 	let network = getNetwork();
 	let host = getEndpoint(network).host;
 	let canisterId = getEndpoint(network).canisterId;
@@ -27,7 +27,7 @@ export let mainActor = async (identity?: Identity): Promise<_SERVICE> => {
 	});
 };
 
-export let storageActor = async (storageId: Principal, identity?: Identity): Promise<_STORAGE_SERVICE> => {
+export let storageActor = async (storageId : Principal, identity ?: Identity) : Promise<_STORAGE_SERVICE> => {
 	let network = getNetwork();
 	let host = getEndpoint(network).host;
 

package/api/downloadPackageFiles.ts

@@ -4,14 +4,14 @@ import {resolveVersion} from './resolveVersion.js';
 import {parallel} from '../parallel.js';
 import {Storage} from '../declarations/storage/storage.did.js';
 
-export async function downloadPackageFiles(pkg: string, version = '', threads = 8, onLoad = (_fileIds: string[], _fileId: string) => {}): Promise<Map<string, Array<number>>> {
+export async function downloadPackageFiles(pkg : string, version = '', threads = 8, onLoad = (_fileIds : string[], _fileId : string) => {}) : Promise<Map<string, Array<number>>> {
 	version = await resolveVersion(pkg, version);
 
 	let {storageId, fileIds} = await getPackageFilesInfo(pkg, version);
 	let storage = await storageActor(storageId);
 
 	let filesData = new Map<string, Array<number>>();
-	await parallel(threads, fileIds, async (fileId: string) => {
+	await parallel(threads, fileIds, async (fileId : string) => {
 		let {path, data} = await downloadFile(storage, fileId);
 		filesData.set(path, data);
 		onLoad(fileIds, fileId);
@@ -21,7 +21,7 @@ export async function downloadPackageFiles(pkg: string, version = '', threads =
 }
 
 // get package files meta
-export async function getPackageFilesInfo(pkg: string, version: string): Promise<{ storageId: Principal, fileIds: string[] }> {
+export async function getPackageFilesInfo(pkg : string, version : string) : Promise<{ storageId : Principal, fileIds : string[] }> {
 	let actor = await mainActor();
 
 	let [packageDetailsRes, fileIds] = await Promise.all([
@@ -41,7 +41,7 @@ export async function getPackageFilesInfo(pkg: string, version: string): Promise
 }
 
 // get package files ids
-export async function getFileIds(pkg: string, version: string): Promise<string[]> {
+export async function getFileIds(pkg : string, version : string) : Promise<string[]> {
 	let actor = await mainActor();
 	let fileIdsRes = await actor.getFileIds(pkg, version);
 
@@ -54,14 +54,17 @@ export async function getFileIds(pkg: string, version: string): Promise<string[]
 }
 
 // download single file
-export async function downloadFile(storage: Storage, fileId: string): Promise<{ path: string, data: Array<number> }> {
+export async function downloadFile(storage : Storage | string, fileId : string) : Promise<{path : string, data : Array<number>;}> {
+	if (typeof storage === 'string') {
+		storage = await storageActor(Principal.fromText(storage));
+	}
 	let fileMetaRes = await storage.getFileMeta(fileId);
 	if ('err' in fileMetaRes) {
 		throw fileMetaRes.err;
 	}
 	let fileMeta = fileMetaRes.ok;
 
-	let data: Array<number> = [];
+	let data : Array<number> = [];
 	for (let i = 0n; i < fileMeta.chunkCount; i++) {
 		let chunkRes = await storage.downloadChunk(fileId, i);
 		if ('err' in chunkRes) {

package/api/getHighestVersion.ts

@@ -1,6 +1,6 @@
 import {mainActor} from './actors.js';
 
-export async function getHighestVersion(pkgName: string) {
+export async function getHighestVersion(pkgName : string) {
 	let actor = await mainActor();
 	return actor.getHighestVersion(pkgName);
 }

package/api/network.ts

@@ -2,7 +2,7 @@ export function getNetwork() {
 	return globalThis.MOPS_NETWORK || 'ic';
 }
 
-export function getEndpoint(network: string) {
+export function getEndpoint(network : string) {
 	if (network === 'staging') {
 		return {
 			host: 'https://icp-api.io',

package/api/resolveVersion.ts

@@ -1,6 +1,6 @@
 import {getHighestVersion} from './getHighestVersion.js';
 
-export async function resolveVersion(pkg: string, version = ''): Promise<string> {
+export async function resolveVersion(pkg : string, version = '') : Promise<string> {
 	if (!version) {
 		let versionRes = await getHighestVersion(pkg);
 		if ('err' in versionRes) {

package/bundle/bench/bench-canister.mo

@@ -0,0 +1,87 @@
+import Nat64 "mo:base/Nat64";
+import Nat "mo:base/Nat";
+import Debug "mo:base/Debug";
+import ExperimentalInternetComputer "mo:base/ExperimentalInternetComputer";
+import Prim "mo:prim";
+import Bench "mo:bench";
+
+import UserBench "./user-bench"; // file path will be replaced with the *.bench.mo file path
+
+actor class() {
+	var benchOpt : ?Bench.Bench = null;
+
+	public func init() : async Bench.BenchSchema {
+		let bench = UserBench.init();
+		benchOpt := ?bench;
+		bench.getSchema();
+	};
+
+	public query func getSchema() : async Bench.BenchSchema {
+		let ?bench = benchOpt else Debug.trap("bench not initialized");
+		bench.getSchema();
+	};
+
+	func _getStats() : Bench.BenchResult {
+		{
+			instructions = 0;
+			rts_heap_size = Prim.rts_heap_size();
+			rts_memory_size = Prim.rts_memory_size();
+			rts_total_allocation = Prim.rts_total_allocation();
+			rts_mutator_instructions = Prim.rts_mutator_instructions();
+			rts_collector_instructions = Prim.rts_collector_instructions();
+		}
+	};
+
+	func _diffStats(before : Bench.BenchResult, after : Bench.BenchResult) : Bench.BenchResult {
+		{
+			instructions = after.instructions - before.instructions;
+			rts_heap_size = after.rts_heap_size - before.rts_heap_size;
+			rts_memory_size = after.rts_memory_size - before.rts_memory_size;
+			rts_total_allocation = after.rts_total_allocation - before.rts_total_allocation;
+			rts_mutator_instructions = after.rts_mutator_instructions - before.rts_mutator_instructions;
+			rts_collector_instructions = after.rts_collector_instructions - before.rts_collector_instructions;
+		}
+	};
+
+	func _runCell(rowIndex : Nat, colIndex : Nat) : Bench.BenchResult {
+		let ?bench = benchOpt else Debug.trap("bench not initialized");
+		let statsBefore = _getStats();
+
+		let instructions = Nat64.toNat(ExperimentalInternetComputer.countInstructions(func() {
+			bench.runCell(rowIndex, colIndex);
+		}));
+
+		let statsAfter = _getStats();
+		_diffStats(statsBefore, { statsAfter with instructions });
+	};
+
+	func _runCellAwait(rowIndex : Nat, colIndex : Nat) : async Bench.BenchResult {
+		let ?bench = benchOpt else Debug.trap("bench not initialized");
+		let statsBefore = _getStats();
+
+		let instructions = Nat64.toNat(ExperimentalInternetComputer.countInstructions(func() {
+			bench.runCell(rowIndex, colIndex);
+		}));
+
+		await (func() : async () {})();
+
+		let statsAfter = _getStats();
+		_diffStats(statsBefore, { statsAfter with instructions });
+	};
+
+	public query func getStats() : async Bench.BenchResult {
+		_getStats();
+	};
+
+	public query func runCellQuery(rowIndex : Nat, colIndex : Nat) : async Bench.BenchResult {
+		_runCell(rowIndex, colIndex);
+	};
+
+	public func runCellUpdate(rowIndex : Nat, colIndex : Nat) : async Bench.BenchResult {
+		_runCell(rowIndex, colIndex);
+	};
+
+	public func runCellUpdateAwait(rowIndex : Nat, colIndex : Nat) : async Bench.BenchResult {
+		await _runCellAwait(rowIndex, colIndex);
+	};
+};

package/bundle/bench/user-bench.mo

@@ -0,0 +1,14 @@
+import Nat "mo:base/Nat";
+import Iter "mo:base/Iter";
+import Buffer "mo:base/Buffer";
+import Vector "mo:vector/Class";
+import Bench "mo:bench";
+
+// placeholder file that will be replaced with the *.bench.mo file
+module {
+	public func init() : Bench.Bench {
+		let bench = Bench.Bench();
+		// benchmark code goes here...
+		bench;
+	};
+};

package/bundle/bin/moc-wrapper.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+mocPath="$(mops toolchain bin moc --fallback)"
+$mocPath "$@"

package/bundle/bin/mops.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../cli.js';