ic-mops 0.12.4 → 0.13.0

package/cli.js

@@ -18,6 +18,7 @@ import {test} from './commands/test.js';
 import {template} from './commands/template.js';
 import {selfUpdate} from './commands/self-update.js';
 import {remove} from './commands/remove.js';
+import {getUserProp, setUserProp} from './commands/user.js';
 // import {docs} from './commands/docs.js';
 
 program.name('mops');
@@ -79,6 +80,7 @@ program
 		}
 
 		if (pkg) {
+			// @deprecated
 			console.log(chalk.yellow('Consider using the \'mops add\' command to install a specific package.'));
 			await add(pkg, options);
 		}
@@ -127,7 +129,7 @@ program
 	.description('Import .pem file data to use as identity')
 	.action(async (data) => {
 		await importPem(data);
-		whoami();
+		await whoami();
 	});
 
 // sources
@@ -149,7 +151,7 @@ program
 	.command('whoami')
 	.description('Print your principal')
 	.action(async () => {
-		whoami();
+		await whoami();
 	});
 
 // search
@@ -224,4 +226,24 @@ program
 		}
 	});
 
+// user
+program
+	.command('user set|get <prop> [value]')
+	.description('User settings')
+	.action(async (sub, prop, value) => {
+		if (sub == 'get') {
+			await getUserProp(prop);
+		}
+		else if (sub == 'set') {
+			if (!value) {
+				console.log('error: missing required argument "value"');
+				return;
+			}
+			await setUserProp(prop, value);
+		}
+		else {
+			console.log('Unknown sub command. Available sub commands: set, get');
+		}
+	});
+
 program.parse();

package/commands/import-identity.js

@@ -1,35 +1,53 @@
 import fs from 'fs';
 import chalk from 'chalk';
 import path from 'path';
+import prompts from 'prompts';
+import del from 'del';
 import {globalCacheDir} from '../mops.js';
+import {encrypt} from '../pem.js';
 
 export async function importPem(data) {
 	try {
 		if (!fs.existsSync(globalCacheDir)) {
 			fs.mkdirSync(globalCacheDir);
 		}
+
+		let res = await prompts({
+			type: 'password',
+			name: 'password',
+			message: 'Enter password to encrypt identity.pem',
+		});
+		let password = res.password;
+
+		if (!password) {
+			let res = await prompts({
+				type: 'confirm',
+				name: 'ok',
+				message: 'Are you sure you don\'t want to protect your identity.pem with a password?',
+			});
+			if (!res.ok) {
+				console.log('aborted');
+				return;
+			}
+		}
+
 		let identityPem = path.resolve(globalCacheDir, 'identity.pem');
-		fs.writeFileSync(identityPem, data);
+		let identityPemEncrypted = path.resolve(globalCacheDir, 'identity.pem.encrypted');
+
+		del.sync([identityPem, identityPemEncrypted], {force: true});
+
+		// encrypted
+		if (password) {
+			data = await encrypt(Buffer.from(data), password);
+			fs.writeFileSync(identityPemEncrypted, data);
+		}
+		// unencrypted
+		else {
+			fs.writeFileSync(identityPem, data);
+		}
 		console.log(chalk.green('Success'));
 	}
 	catch (err) {
 		console.log(chalk.red('Error: ') + err);
 	}
-}
-
-// export async function pemFile(file) {
-// 	try {
-// 		if (!file.endsWith('.pem')) {
-// 			throw 'Please specify .pem file';
-// 		}
-// 		if (!fs.existsSync(file)) {
-// 			throw 'File not found ' + file;
-// 		}
-// 		let url = new URL('./pem-file', import.meta.url);
-// 		fs.writeFileSync(url, file);
-// 		console.log(chalk.green('Success'));
-// 	}
-// 	catch (e) {
-// 		console.log(chalk.red('Error: ') + e);
-// 	}
-// }
+}

package/commands/publish.js

@@ -2,11 +2,10 @@ import fs from 'fs';
 import path from 'path';
 import chalk from 'chalk';
 import logUpdate from 'log-update';
-import {Principal} from '@dfinity/principal';
 import {globbySync} from 'globby';
 import minimatch from 'minimatch';
 import prompts from 'prompts';
-import {checkConfigFile, getIdentity, getRootDir, mainActor, progressBar, readConfig} from '../mops.js';
+import {checkConfigFile, getRootDir, mainActor, progressBar, readConfig} from '../mops.js';
 import {parallel} from '../parallel.js';
 import {docs} from './docs.js';
 
@@ -160,7 +159,6 @@ export async function publish({noDocs} = {}) {
 		baseDir: 'src',
 		readme: 'README.md',
 		license: config.package.license || '',
-		owner: getIdentity()?.getPrincipal() || Principal.anonymous(),
 		dfx: config.package.dfx || '',
 		moc: config.package.moc || '',
 		donation: config.package.donation || '',
@@ -217,8 +215,9 @@ export async function publish({noDocs} = {}) {
 	}
 
 	// upload config
+	let actor = await mainActor(true);
+
 	progress();
-	let actor = await mainActor();
 	let publishing = await actor.startPublish(backendPkgConfig);
 	if (publishing.err) {
 		console.log(chalk.red('Error: ') + publishing.err);

package/commands/user.js

@@ -0,0 +1,20 @@
+import chalk from 'chalk';
+import {getIdentity, mainActor} from '../mops.js';
+
+export async function getUserProp(prop) {
+	let actor = await mainActor();
+	let identity = await getIdentity();
+	let res = await actor.getUser(identity.getPrincipal());
+	console.log(res[0]?.[prop] || '');
+}
+
+export async function setUserProp(prop, value) {
+	let actor = await mainActor(true);
+	let res = await actor.setUserProp(prop, value);
+	if ('ok' in res) {
+		console.log(chalk.green('Success!'));
+	}
+	else {
+		console.log(chalk.red('Error: ') + res.err);
+	}
+}

package/commands/whoami.js

@@ -1,12 +1,9 @@
 import chalk from 'chalk';
-import fs from 'fs';
-import path from 'path';
-import {getIdentity, globalCacheDir} from '../mops.js';
+import {getIdentity} from '../mops.js';
 
-export function whoami() {
-	let identityPem = path.resolve(globalCacheDir, 'identity.pem');
-	if (fs.existsSync(identityPem)) {
-		let identity = getIdentity();
+export async function whoami() {
+	let identity = await getIdentity();
+	if (identity) {
 		console.log(identity.getPrincipal().toText());
 	}
 	else {

package/declarations/main/index.js

@@ -4,8 +4,14 @@ import { Actor, HttpAgent } from "@dfinity/agent";
 import { idlFactory } from "./main.did.js";
 export { idlFactory } from "./main.did.js";
 
-// CANISTER_ID is replaced by webpack based on node environment
-export const canisterId = process.env.MAIN_CANISTER_ID;
+/* CANISTER_ID is replaced by webpack based on node environment
+ * Note: canister environment variable will be standardized as
+ * process.env.CANISTER_ID_<CANISTER_NAME_UPPERCASE>
+ * beginning in dfx 0.15.0
+ */
+export const canisterId =
+  process.env.CANISTER_ID_MAIN ||
+  process.env.MAIN_CANISTER_ID;
 
 export const createActor = (canisterId, options = {}) => {
   const agent = options.agent || new HttpAgent({ ...options.agentOptions });

package/declarations/main/main.did

@@ -1,5 +1,31 @@
 type Version = text;
 type Ver = text;
+type User__1 = 
+ record {
+   displayName: text;
+   email: text;
+   emailVerified: bool;
+   github: text;
+   githubVerified: bool;
+   id: principal;
+   name: text;
+   site: text;
+   twitter: text;
+   twitterVerified: bool;
+ };
+type User = 
+ record {
+   displayName: text;
+   email: text;
+   emailVerified: bool;
+   github: text;
+   githubVerified: bool;
+   id: principal;
+   name: text;
+   site: text;
+   twitter: text;
+   twitterVerified: bool;
+ };
 type Time = int;
 type Text = text;
 type StorageStats = 
@@ -14,21 +40,26 @@ type Script =
    name: text;
    value: text;
  };
-type Result_5 = 
+type Result_6 = 
  variant {
    err: Err;
    ok: vec FileId;
  };
-type Result_4 = 
+type Result_5 = 
  variant {
    err: Err;
    ok: Ver;
  };
-type Result_3 = 
+type Result_4 = 
  variant {
    err: Err;
    ok: PackageDetails;
  };
+type Result_3 = 
+ variant {
+   err: text;
+   ok;
+ };
 type Result_2 = 
  variant {
    err: Err;
@@ -53,6 +84,7 @@ type PackageSummary__1 =
    downloadsInLast7Days: nat;
    downloadsTotal: nat;
    owner: principal;
+   ownerInfo: User;
    publication: PackagePublication;
  };
 type PackageSummary = 
@@ -62,6 +94,7 @@ type PackageSummary =
    downloadsInLast7Days: nat;
    downloadsTotal: nat;
    owner: principal;
+   ownerInfo: User;
    publication: PackagePublication;
  };
 type PackagePublication = 
@@ -84,6 +117,7 @@ type PackageDetails =
    downloadsInLast7Days: nat;
    downloadsTotal: nat;
    owner: principal;
+   ownerInfo: User;
    publication: PackagePublication;
    versionHistory: vec PackageSummary__1;
  };
@@ -156,11 +190,11 @@ service : {
    (vec DownloadsSnapshot__1) query;
   getDownloadTrendByPackageName: (PackageName__1) ->
    (vec DownloadsSnapshot__1) query;
-  getFileIds: (PackageName__1, Ver) -> (Result_5) query;
-  getHighestVersion: (PackageName__1) -> (Result_4) query;
+  getFileIds: (PackageName__1, Ver) -> (Result_6) query;
+  getHighestVersion: (PackageName__1) -> (Result_5) query;
   getMostDownloadedPackages: () -> (vec PackageSummary) query;
   getMostDownloadedPackagesIn7Days: () -> (vec PackageSummary) query;
-  getPackageDetails: (PackageName__1, Ver) -> (Result_3) query;
+  getPackageDetails: (PackageName__1, Ver) -> (Result_4) query;
   getRecentlyUpdatedPackages: () -> (vec PackageSummary) query;
   getStoragesStats: () -> (vec record {
                                  StorageId;
@@ -168,8 +202,10 @@ service : {
                                }) query;
   getTotalDownloads: () -> (nat) query;
   getTotalPackages: () -> (nat) query;
+  getUser: (principal) -> (opt User__1) query;
   notifyInstall: (PackageName__1, Ver) -> () oneway;
   search: (Text) -> (vec PackageSummary) query;
+  setUserProp: (text, text) -> (Result_3);
   startFileUpload: (PublishingId, Text, nat, blob) -> (Result_2);
   startPublish: (PackageConfigV2) -> (Result_1);
   uploadFileChunk: (PublishingId, FileId, nat, blob) -> (Result);

package/declarations/main/main.did.d.ts

@@ -55,6 +55,7 @@ export interface PackageConfigV2__1 {
   'readme' : string,
 }
 export interface PackageDetails {
+  'ownerInfo' : User,
   'owner' : Principal,
   'deps' : Array<PackageSummary__1>,
   'downloadsTotal' : bigint,
@@ -76,6 +77,7 @@ export interface PackagePublication {
   'user' : Principal,
 }
 export interface PackageSummary {
+  'ownerInfo' : User,
   'owner' : Principal,
   'downloadsTotal' : bigint,
   'downloadsInLast30Days' : bigint,
@@ -84,6 +86,7 @@ export interface PackageSummary {
   'publication' : PackagePublication,
 }
 export interface PackageSummary__1 {
+  'ownerInfo' : User,
   'owner' : Principal,
   'downloadsTotal' : bigint,
   'downloadsInLast30Days' : bigint,
@@ -99,11 +102,13 @@ export type Result_1 = { 'ok' : PublishingId } |
   { 'err' : PublishingErr };
 export type Result_2 = { 'ok' : FileId } |
   { 'err' : Err };
-export type Result_3 = { 'ok' : PackageDetails } |
+export type Result_3 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : PackageDetails } |
   { 'err' : Err };
-export type Result_4 = { 'ok' : Ver } |
+export type Result_5 = { 'ok' : Ver } |
   { 'err' : Err };
-export type Result_5 = { 'ok' : Array<FileId> } |
+export type Result_6 = { 'ok' : Array<FileId> } |
   { 'err' : Err };
 export interface Script { 'value' : string, 'name' : string }
 export type StorageId = Principal;
@@ -114,6 +119,30 @@ export interface StorageStats {
 }
 export type Text = string;
 export type Time = bigint;
+export interface User {
+  'id' : Principal,
+  'emailVerified' : boolean,
+  'twitter' : string,
+  'displayName' : string,
+  'name' : string,
+  'site' : string,
+  'email' : string,
+  'twitterVerified' : boolean,
+  'githubVerified' : boolean,
+  'github' : string,
+}
+export interface User__1 {
+  'id' : Principal,
+  'emailVerified' : boolean,
+  'twitter' : string,
+  'displayName' : string,
+  'name' : string,
+  'site' : string,
+  'email' : string,
+  'twitterVerified' : boolean,
+  'githubVerified' : boolean,
+  'github' : string,
+}
 export type Ver = string;
 export type Version = string;
 export interface _SERVICE {
@@ -131,17 +160,19 @@ export interface _SERVICE {
     [PackageName__1],
     Array<DownloadsSnapshot__1>
   >,
-  'getFileIds' : ActorMethod<[PackageName__1, Ver], Result_5>,
-  'getHighestVersion' : ActorMethod<[PackageName__1], Result_4>,
+  'getFileIds' : ActorMethod<[PackageName__1, Ver], Result_6>,
+  'getHighestVersion' : ActorMethod<[PackageName__1], Result_5>,
   'getMostDownloadedPackages' : ActorMethod<[], Array<PackageSummary>>,
   'getMostDownloadedPackagesIn7Days' : ActorMethod<[], Array<PackageSummary>>,
-  'getPackageDetails' : ActorMethod<[PackageName__1, Ver], Result_3>,
+  'getPackageDetails' : ActorMethod<[PackageName__1, Ver], Result_4>,
   'getRecentlyUpdatedPackages' : ActorMethod<[], Array<PackageSummary>>,
   'getStoragesStats' : ActorMethod<[], Array<[StorageId, StorageStats]>>,
   'getTotalDownloads' : ActorMethod<[], bigint>,
   'getTotalPackages' : ActorMethod<[], bigint>,
+  'getUser' : ActorMethod<[Principal], [] | [User__1]>,
   'notifyInstall' : ActorMethod<[PackageName__1, Ver], undefined>,
   'search' : ActorMethod<[Text], Array<PackageSummary>>,
+  'setUserProp' : ActorMethod<[string, string], Result_3>,
   'startFileUpload' : ActorMethod<
     [PublishingId, Text, bigint, Uint8Array | number[]],
     Result_2

package/declarations/main/main.did.js

@@ -14,8 +14,20 @@ export const idlFactory = ({ IDL }) => {
   });
   const Ver = IDL.Text;
   const FileId = IDL.Text;
-  const Result_5 = IDL.Variant({ 'ok' : IDL.Vec(FileId), 'err' : Err });
-  const Result_4 = IDL.Variant({ 'ok' : Ver, 'err' : Err });
+  const Result_6 = IDL.Variant({ 'ok' : IDL.Vec(FileId), 'err' : Err });
+  const Result_5 = IDL.Variant({ 'ok' : Ver, 'err' : Err });
+  const User = IDL.Record({
+    'id' : IDL.Principal,
+    'emailVerified' : IDL.Bool,
+    'twitter' : IDL.Text,
+    'displayName' : IDL.Text,
+    'name' : IDL.Text,
+    'site' : IDL.Text,
+    'email' : IDL.Text,
+    'twitterVerified' : IDL.Bool,
+    'githubVerified' : IDL.Bool,
+    'github' : IDL.Text,
+  });
   const Script = IDL.Record({ 'value' : IDL.Text, 'name' : IDL.Text });
   const PackageName = IDL.Text;
   const DependencyV2 = IDL.Record({
@@ -47,6 +59,7 @@ export const idlFactory = ({ IDL }) => {
     'user' : IDL.Principal,
   });
   const PackageSummary = IDL.Record({
+    'ownerInfo' : User,
     'owner' : IDL.Principal,
     'downloadsTotal' : IDL.Nat,
     'downloadsInLast30Days' : IDL.Nat,
@@ -55,6 +68,7 @@ export const idlFactory = ({ IDL }) => {
     'publication' : PackagePublication,
   });
   const PackageSummary__1 = IDL.Record({
+    'ownerInfo' : User,
     'owner' : IDL.Principal,
     'downloadsTotal' : IDL.Nat,
     'downloadsInLast30Days' : IDL.Nat,
@@ -68,6 +82,7 @@ export const idlFactory = ({ IDL }) => {
     'downloads' : IDL.Nat,
   });
   const PackageDetails = IDL.Record({
+    'ownerInfo' : User,
     'owner' : IDL.Principal,
     'deps' : IDL.Vec(PackageSummary__1),
     'downloadsTotal' : IDL.Nat,
@@ -80,13 +95,26 @@ export const idlFactory = ({ IDL }) => {
     'config' : PackageConfigV2__1,
     'publication' : PackagePublication,
   });
-  const Result_3 = IDL.Variant({ 'ok' : PackageDetails, 'err' : Err });
+  const Result_4 = IDL.Variant({ 'ok' : PackageDetails, 'err' : Err });
   const StorageId = IDL.Principal;
   const StorageStats = IDL.Record({
     'fileCount' : IDL.Nat,
     'cyclesBalance' : IDL.Nat,
     'memorySize' : IDL.Nat,
   });
+  const User__1 = IDL.Record({
+    'id' : IDL.Principal,
+    'emailVerified' : IDL.Bool,
+    'twitter' : IDL.Text,
+    'displayName' : IDL.Text,
+    'name' : IDL.Text,
+    'site' : IDL.Text,
+    'email' : IDL.Text,
+    'twitterVerified' : IDL.Bool,
+    'githubVerified' : IDL.Bool,
+    'github' : IDL.Text,
+  });
+  const Result_3 = IDL.Variant({ 'ok' : IDL.Null, 'err' : IDL.Text });
   const Result_2 = IDL.Variant({ 'ok' : FileId, 'err' : Err });
   const PackageConfigV2 = IDL.Record({
     'dfx' : IDL.Text,
@@ -126,8 +154,8 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(DownloadsSnapshot__1)],
         ['query'],
       ),
-    'getFileIds' : IDL.Func([PackageName__1, Ver], [Result_5], ['query']),
-    'getHighestVersion' : IDL.Func([PackageName__1], [Result_4], ['query']),
+    'getFileIds' : IDL.Func([PackageName__1, Ver], [Result_6], ['query']),
+    'getHighestVersion' : IDL.Func([PackageName__1], [Result_5], ['query']),
     'getMostDownloadedPackages' : IDL.Func(
         [],
         [IDL.Vec(PackageSummary)],
@@ -140,7 +168,7 @@ export const idlFactory = ({ IDL }) => {
       ),
     'getPackageDetails' : IDL.Func(
         [PackageName__1, Ver],
-        [Result_3],
+        [Result_4],
         ['query'],
       ),
     'getRecentlyUpdatedPackages' : IDL.Func(
@@ -155,8 +183,10 @@ export const idlFactory = ({ IDL }) => {
       ),
     'getTotalDownloads' : IDL.Func([], [IDL.Nat], ['query']),
     'getTotalPackages' : IDL.Func([], [IDL.Nat], ['query']),
+    'getUser' : IDL.Func([IDL.Principal], [IDL.Opt(User__1)], ['query']),
     'notifyInstall' : IDL.Func([PackageName__1, Ver], [], ['oneway']),
     'search' : IDL.Func([Text], [IDL.Vec(PackageSummary)], ['query']),
+    'setUserProp' : IDL.Func([IDL.Text, IDL.Text], [Result_3], []),
     'startFileUpload' : IDL.Func(
         [PublishingId, Text, IDL.Nat, IDL.Vec(IDL.Nat8)],
         [Result_2],

package/mops.js

@@ -4,6 +4,7 @@ import chalk from 'chalk';
 import fetch from 'node-fetch';
 import path from 'path';
 import fs from 'fs';
+import prompts from 'prompts';
 
 import {idlFactory} from './declarations/main/main.did.js';
 import {idlFactory as storageIdlFactory} from './declarations/storage/storage.did.js';
@@ -53,19 +54,28 @@ export function getNetwork() {
 	}
 }
 
-export let getIdentity = () => {
+export let getIdentity = async () => {
 	let identityPem = path.resolve(globalCacheDir, 'identity.pem');
+	let identityPemEncrypted = path.resolve(globalCacheDir, 'identity.pem.encrypted');
+	if (fs.existsSync(identityPemEncrypted)) {
+		let res = await prompts({
+			type: 'password',
+			name: 'value',
+			message: 'Enter password:'
+		});
+		return await decodeFile(identityPemEncrypted, res.value);
+	}
 	if (fs.existsSync(identityPem)) {
 		return decodeFile(identityPem);
 	}
 };
 
-export let mainActor = async () => {
+export let mainActor = async (useIdentity = false) => {
 	let network = getNetwork().network;
 	let host = getNetwork().host;
 	let canisterId = getNetwork().canisterId;
 
-	let identity = getIdentity();
+	let identity = useIdentity && await getIdentity();
 	let agent = new HttpAgent({host, identity});
 
 	if (network === 'local') {
@@ -78,11 +88,11 @@ export let mainActor = async () => {
 	});
 };
 
-export let storageActor = async (storageId) => {
+export let storageActor = async (storageId, useIdentity = false) => {
 	let network = getNetwork().network;
 	let host = getNetwork().host;
 
-	let identity = getIdentity();
+	let identity = useIdentity && await getIdentity();
 	let agent = new HttpAgent({host, identity});
 
 	if (network === 'local') {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.12.4",
+	"version": "0.13.0",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"

package/pem.js

@@ -1,13 +1,17 @@
 import fs from 'fs';
 import {Ed25519KeyIdentity, Secp256k1KeyIdentity} from '@dfinity/identity';
 import pemfile from 'pem-file';
+import crypto from 'crypto';
 
-export function decodeFile(file) {
-	const rawKey = fs.readFileSync(file).toString();
+export function decodeFile(file, password) {
+	let rawKey = fs.readFileSync(file);
+	if (password) {
+		return decode(decrypt(rawKey, password));
+	}
 	return decode(rawKey);
 }
 
-export function decode(rawKey) {
+function decode(rawKey) {
 	var buf = pemfile.decode(rawKey);
 	if (rawKey.includes('EC PRIVATE KEY')) {
 		if (buf.length != 118) {
@@ -20,4 +24,30 @@ export function decode(rawKey) {
 	}
 	let secretKey = Buffer.concat([buf.slice(16, 48), buf.slice(53, 85)]);
 	return Ed25519KeyIdentity.fromSecretKey(secretKey);
+}
+
+let algorithm = 'aes-256-ctr';
+
+export function encrypt(buffer, password) {
+	let key = crypto.createHash('sha256').update(password).digest('base64').slice(0, 32);
+	// Create an initialization vector
+	let iv = crypto.randomBytes(16);
+	// Create a new cipher using the algorithm, key, and iv
+	let cipher = crypto.createCipheriv(algorithm, key, iv);
+	// Create the new (encrypted) buffer
+	let result = Buffer.concat([iv, cipher.update(buffer), cipher.final()]);
+	return result;
+}
+
+function decrypt(encrypted, password) {
+	let key = crypto.createHash('sha256').update(password).digest('base64').slice(0, 32);
+	// Get the iv: the first 16 bytes
+	let iv = encrypted.slice(0, 16);
+	// Get the rest
+	encrypted = encrypted.slice(16);
+	// Create a decipher
+	let decipher = crypto.createDecipheriv(algorithm, key, iv);
+	// Actually decrypt it
+	let result = Buffer.concat([decipher.update(encrypted), decipher.final()]);
+	return result;
 }