Feature/support instances

package.json

@@ -1,6 +1,6 @@
 {
     "name": "aleph-sdk-ts",
-    "version": "3.5.0",
+    "version": "3.6.1",
     "description": "Aleph.im Typescript SDK",
     "keywords": [
         "web3",
@@ -48,7 +48,7 @@
         "@types/bs58": "^4.0.1",
         "@types/elliptic": "^6.4.13",
         "@types/jest": "^27.4.1",
-        "@types/node": "^17.0.25",
+        "@types/node": "^17.0.45",
         "@types/node-fetch": "^2.6.2",
         "@types/node-hid": "^1.3.1",
         "@types/ripemd160": "^2.0.0",

src/accounts/account.ts

@@ -1,4 +1,4 @@
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { ProviderEncryptionLabel } from "./providers/ProviderEncryptionLib";
 
 /**

src/accounts/avalanche.ts

@@ -1,7 +1,7 @@
 import shajs from "sha.js";
 import { ECIESAccount } from "./account";
 import { GetVerificationBuffer } from "../messages";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { decrypt as secp256k1_decrypt, encrypt as secp256k1_encrypt } from "eciesjs";
 import { KeyPair } from "avalanche/dist/apis/avm";
 import { Avalanche, BinTools, Buffer as AvaBuff } from "avalanche";

src/accounts/cosmos.ts

@@ -7,7 +7,7 @@ import {
 } from "@cosmjs/amino";
 import { Account } from "./account";
 import { GetVerificationBuffer } from "../messages";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 
 /**
  * CosmosAccount implements the Account class for the Cosmos protocol.

src/accounts/ethereum.ts

@@ -2,7 +2,7 @@ import * as bip39 from "bip39";
 import { ethers } from "ethers";
 import { ECIESAccount } from "./account";
 import { GetVerificationBuffer } from "../messages";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { decrypt as secp256k1_decrypt, encrypt as secp256k1_encrypt } from "eciesjs";
 import { ChangeRpcParam, JsonRPCWallet, RpcChainType } from "./providers/JsonRPCWallet";
 import { BaseProviderWallet } from "./providers/BaseProviderWallet";

src/accounts/nuls2.ts

@@ -3,7 +3,7 @@ import * as bip32 from "bip32";
 import secp256k1 from "secp256k1";
 import { generateMnemonic } from "bip39";
 import { ECIESAccount } from "./account";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { GetVerificationBuffer } from "../messages";
 import { decrypt as secp256k1_decrypt, encrypt as secp256k1_encrypt } from "eciesjs";
 import bs58 from "bs58";

src/accounts/providers/Ledger/ethereum.ts

@@ -2,7 +2,7 @@ import EthApp from "@ledgerhq/hw-app-eth";
 import semver from "semver";
 
 import { Account } from "../../account";
-import { Chain, BaseMessage } from "../../../messages/message";
+import { Chain, BaseMessage } from "../../../messages/types";
 import { GetVerificationBuffer } from "../../../messages";
 import { getTransport } from "./transport";
 import { JSExecutionEnvironment } from "../../../utils/env";

src/accounts/solana.ts

@@ -1,5 +1,5 @@
 import { Account } from "./account";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { GetVerificationBuffer } from "../messages";
 import { Keypair, PublicKey } from "@solana/web3.js";
 import nacl from "tweetnacl";

src/accounts/substrate.ts

@@ -1,5 +1,5 @@
 import { Account } from "./account";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { GetVerificationBuffer } from "../messages";
 
 import { Keyring } from "@polkadot/keyring";

src/accounts/tezos.ts

@@ -1,5 +1,5 @@
 import { Account } from "./account";
-import { BaseMessage, Chain } from "../messages/message";
+import { BaseMessage, Chain } from "../messages/types";
 import { GetVerificationBuffer } from "../messages";
 import { InMemorySigner } from "@taquito/signer";
 import { b58cdecode, b58cencode, prefix } from "@taquito/utils";

src/messages/aggregate/publish.ts

@@ -1,6 +1,6 @@
 import { Account } from "../../accounts/account";
 import { DEFAULT_API_V2 } from "../../global";
-import { AggregateContent, AggregateContentKey, AggregateMessage, ItemType, MessageType } from "../message";
+import { AggregateContent, AggregateContentKey, AggregateMessage, ItemType, MessageType } from "../types";
 import { PutContentToStorageEngine } from "../create/publish";
 import { SignAndBroadcast } from "../create/signature";
 import { MessageBuilder } from "../../utils/messageBuilder";

src/messages/any/getMessage.ts

@@ -1,5 +1,5 @@
 import { DEFAULT_API_V2 } from "../../global";
-import { BaseMessage, MessageType } from "../message";
+import { BaseMessage, MessageType } from "../types";
 import { GetMessages } from "./getMessages";
 
 type GetMessageParams = {

src/messages/any/getMessages.ts

@@ -1,7 +1,7 @@
 import axios from "axios";
 import { DEFAULT_API_V2 } from "../../global";
 import { getSocketPath, stripTrailingSlash } from "../../utils/url";
-import { BaseMessage, Chain, MessageType } from "../message";
+import { BaseMessage, Chain, MessageType } from "../types";
 
 type MessageQueryResponse = {
     messages: BaseMessage[];

src/messages/any/getType.ts

@@ -1,4 +1,4 @@
-import { AggregateMessage, BaseMessage, ForgetMessage, PostMessage, ProgramMessage, StoreMessage } from "../message";
+import { AggregateMessage, BaseMessage, ForgetMessage, PostMessage, ProgramMessage, StoreMessage } from "../types";
 
 export function Program(message: BaseMessage): message is ProgramMessage {
     if (message !== null && typeof message === "object") {

src/messages/constants.ts

@@ -0,0 +1,14 @@
+import { FunctionEnvironment, MachineResources } from "./types";
+
+export const defaultExecutionEnvironment: FunctionEnvironment = {
+    reproducible: false,
+    internet: true,
+    aleph_api: true,
+    shared_cache: false,
+};
+
+export const defaultResources: MachineResources = {
+    memory: 128,
+    vcpus: 1,
+    seconds: 30,
+};

src/messages/create/publish.ts

@@ -1,6 +1,6 @@
 import shajs from "sha.js";
 
-import { BaseMessage, ItemType } from "../message";
+import { BaseMessage, ItemType } from "../types";
 import axios from "axios";
 import FormDataNode from "form-data";
 import { getSocketPath, stripTrailingSlash } from "../../utils/url";

src/messages/create/signature.ts

@@ -1,4 +1,4 @@
-import { BaseMessage } from "../message";
+import { BaseMessage } from "../types";
 import { Account } from "../../accounts/account";
 import axios from "axios";
 import { getSocketPath, stripTrailingSlash } from "../../utils/url";

src/messages/forget/publish.ts

@@ -1,5 +1,5 @@
 import { PutContentToStorageEngine } from "../create/publish";
-import { ForgetContent, ForgetMessage, ItemType, MessageType } from "../message";
+import { ForgetContent, ForgetMessage, ItemType, MessageType } from "../types";
 import { Account } from "../../accounts/account";
 import { DEFAULT_API_V2 } from "../../global";
 import { SignAndBroadcast } from "../create/signature";

src/messages/index.ts

@@ -1,12 +1,13 @@
-import { BaseMessage } from "./message";
+import { BaseMessage } from "./types";
 import * as aggregate from "./aggregate";
 import * as forget from "./forget";
 import * as post from "./post";
 import * as program from "./program";
+import * as instance from "./instance";
 import * as store from "./store";
 import * as any from "./any";
 
-export { aggregate, forget, post, program, store, any };
+export { aggregate, forget, post, program, instance, store, any };
 
 /**
  * Extracts some fields from an Aleph message to sign it using an account.

src/messages/instance/index.ts

@@ -0,0 +1,3 @@
+import { publish } from "./publish";
+
+export { publish };

src/messages/instance/publish.ts

@@ -0,0 +1,105 @@
+import { Account } from "../../accounts/account";
+import {
+    ItemType,
+    MessageType,
+    InstanceMessage,
+    MachineVolume,
+    HostRequirements,
+    FunctionEnvironment,
+    MachineResources,
+    VolumePersistence,
+} from "../types";
+import { InstanceContent } from "./types";
+import { PutContentToStorageEngine } from "../create/publish";
+import { SignAndBroadcast } from "../create/signature";
+import { DEFAULT_API_V2 } from "../../global";
+import { MessageBuilder } from "../../utils/messageBuilder";
+import { defaultExecutionEnvironment, defaultResources } from "../constants";
+
+export type InstancePublishConfiguration = {
+    account: Account;
+    channel: string;
+    metadata?: Record<string, unknown>;
+    variables?: Record<string, string>;
+    authorized_keys?: string[];
+    resources?: Partial<MachineResources>;
+    requirements?: HostRequirements;
+    environment?: Partial<FunctionEnvironment>;
+    image?: string;
+    volumes?: MachineVolume[];
+    inlineRequested?: boolean;
+    storageEngine?: ItemType.ipfs | ItemType.storage;
+    APIServer?: string;
+};
+
+// TODO: Check that program_ref, runtime and data_ref exist
+// Guard some numbers values
+export async function publish({
+    account,
+    channel,
+    metadata,
+    variables,
+    authorized_keys,
+    resources,
+    requirements,
+    environment,
+    image = "549ec451d9b099cad112d4aaa2c00ac40fb6729a92ff252ff22eef0b5c3cb613",
+    volumes = [],
+    inlineRequested = true,
+    storageEngine = ItemType.ipfs,
+    APIServer = DEFAULT_API_V2,
+}: InstancePublishConfiguration): Promise<InstanceMessage> {
+    const timestamp = Date.now() / 1000;
+    const { address } = account;
+
+    const instanceContent: InstanceContent = {
+        address,
+        time: timestamp,
+        metadata,
+        authorized_keys,
+        volumes,
+        variables,
+        requirements,
+        allow_amend: false,
+        resources: {
+            ...defaultResources,
+            ...resources,
+        },
+        environment: {
+            ...defaultExecutionEnvironment,
+            ...environment,
+        },
+        rootfs: {
+            parent: {
+                ref: image,
+                use_latest: true,
+            },
+            persistence: VolumePersistence.host,
+            size_mib: 5000,
+        },
+    };
+
+    const message = MessageBuilder<InstanceContent, MessageType.instance>({
+        account,
+        channel,
+        timestamp,
+        storageEngine,
+        content: instanceContent,
+        type: MessageType.instance,
+    });
+
+    await PutContentToStorageEngine({
+        message: message,
+        content: instanceContent,
+        inline: inlineRequested,
+        APIServer,
+    });
+
+    await SignAndBroadcast({
+        message: message,
+        account,
+        APIServer,
+    });
+
+    return message as unknown as InstanceMessage;
+}

src/messages/instance/types.ts

@@ -0,0 +1,20 @@
+import { BaseExecutableContent, ParentVolume, VolumePersistence } from "../types";
+
+/**
+ * Root file system of a VM instance.
+ * The root file system of an instance is built as a copy of a reference image, named parent image. The user determines a custom size and persistence model.
+ */
+export type RootfsVolume = {
+    parent: ParentVolume;
+    persistence: VolumePersistence;
+    size_mib: number; //Limit to 1 GiB
+};
+
+/**
+ * Message content for scheduling a VM instance on the network.
+ *
+ * rootfs: Root filesystem of the system, will be booted by the kernel"
+ */
+export type InstanceContent = BaseExecutableContent & {
+    rootfs: RootfsVolume;
+};

src/messages/post/publish.ts

@@ -1,5 +1,5 @@
 import { Account } from "../../accounts/account";
-import { ChainRef, ItemType, MessageType, PostContent, PostMessage } from "../message";
+import { ChainRef, ItemType, MessageType, PostContent, PostMessage } from "../types";
 import { PutContentToStorageEngine } from "../create/publish";
 import { SignAndBroadcast } from "../create/signature";
 import { DEFAULT_API_V2 } from "../../global";