feat: Cleaning up technical debts (#295)

packages/core/interfaces/src/compilerSupport/aquaTypeDefinitions.ts

@@ -0,0 +1,273 @@
+/*
+ * Copyright 2023 Fluence Labs Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+type SomeNonArrowTypes = ScalarType | OptionType | ArrayType | StructType | TopType | BottomType;
+
+export type NonArrowType = SomeNonArrowTypes | ProductType<SomeNonArrowTypes>;
+
+export type TopType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'topType';
+};
+
+export type BottomType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'bottomType';
+};
+
+export type OptionType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'option';
+
+    /**
+     * Underlying type of the option
+     */
+    type: NonArrowType;
+};
+
+export type NilType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'nil';
+};
+
+export type ArrayType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'array';
+
+    /**
+     * Type of array elements
+     */
+    type: NonArrowType;
+};
+
+/**
+ * All possible scalar type names
+ */
+export type ScalarNames =
+    | 'u8'
+    | 'u16'
+    | 'u32'
+    | 'u64'
+    | 'i8'
+    | 'i16'
+    | 'i32'
+    | 'i64'
+    | 'f32'
+    | 'f64'
+    | 'bool'
+    | 'string';
+
+export type ScalarType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'scalar';
+
+    /**
+     * Name of the scalar type
+     */
+    name: ScalarNames;
+};
+
+export type StructType = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'struct';
+
+    /**
+     * Struct name
+     */
+    name: string;
+
+    /**
+     * Struct fields
+     */
+    fields: { [key: string]: NonArrowType };
+};
+
+export type LabeledProductType<T> =
+    | {
+          /**
+           * Type descriptor. Used for pattern-matching
+           */
+          tag: 'labeledProduct';
+
+          /**
+           * Labelled product fields
+           */
+          fields: { [key: string]: T };
+      }
+    | NilType;
+
+export type UnlabeledProductType<T> =
+    | {
+          /**
+           * Type descriptor. Used for pattern-matching
+           */
+          tag: 'unlabeledProduct';
+
+          /**
+           * Items in unlabelled product
+           */
+          items: Array<T>;
+      }
+    | NilType;
+
+export type ProductType<T> = UnlabeledProductType<T> | LabeledProductType<T>;
+
+/**
+ * ArrowType is a profunctor pointing its domain to codomain.
+ * Profunctor means variance: Arrow is contravariant on domain, and variant on codomain.
+ */
+export type ArrowType<T> = {
+    /**
+     * Type descriptor. Used for pattern-matching
+     */
+    tag: 'arrow';
+
+    /**
+     * Where this Arrow is defined
+     */
+    domain: ProductType<T>;
+
+    /**
+     * Where this Arrow points to
+     */
+    codomain: UnlabeledProductType<NonArrowType> | NilType;
+};
+
+/**
+ * Arrow which domain contains only non-arrow types
+ */
+export type ArrowWithoutCallbacks = ArrowType<NonArrowType>;
+
+/**
+ * Arrow which domain does can contain both non-arrow types and arrows (which themselves cannot contain arrows)
+ */
+export type ArrowWithCallbacks = ArrowType<NonArrowType | ArrowWithoutCallbacks>;
+
+export interface FunctionCallConstants {
+    /**
+     * The name of the relay variable
+     */
+    relay: string;
+
+    /**
+     * The name of the serviceId used load variables at the beginning of the script
+     */
+    getDataSrv: string;
+
+    /**
+     * The name of serviceId is used to execute callbacks for the current particle
+     */
+    callbackSrv: string;
+
+    /**
+     * The name of the serviceId which is called to propagate return value to the generated function caller
+     */
+    responseSrv: string;
+
+    /**
+     * The name of the functionName which is called to propagate return value to the generated function caller
+     */
+    responseFnName: string;
+
+    /**
+     * The name of the serviceId which is called to report errors to the generated function caller
+     */
+    errorHandlingSrv: string;
+
+    /**
+     * The name of the functionName which is called to report errors to the generated function caller
+     */
+    errorFnName: string;
+}
+
+/**
+ * Definition of function (`func` instruction) generated by the Aqua compiler
+ */
+export interface FunctionCallDef {
+    /**
+     * The name of the function in Aqua language
+     */
+    functionName: string;
+
+    /**
+     * Underlying arrow which represents function in aqua
+     */
+    arrow: ArrowWithCallbacks;
+
+    /**
+     * Names of the different entities used in generated air script
+     */
+    names: FunctionCallConstants;
+}
+
+/**
+ * Definition of service registration function (`service` instruction) generated by the Aqua compiler
+ */
+export interface ServiceDef {
+    /**
+     * Default service id. If the service has no default id the value should be undefined
+     */
+    defaultServiceId?: string;
+
+    /**
+     * List of functions which the service consists of
+     */
+    functions: LabeledProductType<ArrowWithoutCallbacks>;
+}
+
+/**
+ * Options to configure Aqua function execution
+ */
+export interface FnConfig {
+    /**
+     * Sets the TTL (time to live) for particle responsible for the function execution
+     * If the option is not set the default TTL from FluencePeer config is used
+     */
+    ttl?: number;
+}
+
+export const getArgumentTypes = (
+    def: FunctionCallDef,
+): {
+    [key: string]: NonArrowType | ArrowWithoutCallbacks;
+} => {
+    if (def.arrow.domain.tag !== 'labeledProduct') {
+        throw new Error('Should be impossible');
+    }
+
+    return def.arrow.domain.fields;
+};
+
+export const isReturnTypeVoid = (def: FunctionCallDef): boolean => {
+    if (def.arrow.codomain.tag === 'nil') {
+        return true;
+    }
+
+    return def.arrow.codomain.items.length == 0;
+};

packages/core/interfaces/src/compilerSupport/compilerSupportInterface.ts

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2023 Fluence Labs Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IFluenceInternalApi } from '../fluenceClient.js';
+import { FnConfig, FunctionCallDef, ServiceDef } from './aquaTypeDefinitions.js';
+
+/**
+ * Arguments passed to Aqua function
+ */
+export type PassedArgs = { [key: string]: any };
+
+/**
+ * Arguments for callAquaFunction function
+ */
+export interface CallAquaFunctionArgs {
+    /**
+     * Peer to call the function on
+     */
+    peer: IFluenceInternalApi;
+
+    /**
+     * Function definition
+     */
+    def: FunctionCallDef;
+
+    /**
+     * Air script used by the aqua function
+     */
+    script: string;
+
+    /**
+     * Function configuration
+     */
+    config: FnConfig;
+
+    /**
+     * Arguments to pass to the function
+     */
+    args: PassedArgs;
+}
+
+/**
+ * Call a function from Aqua script
+ */
+export type CallAquaFunctionType = (args: CallAquaFunctionArgs) => Promise<unknown>;
+
+/**
+ * Arguments for registerService function
+ */
+export interface RegisterServiceArgs {
+    /**
+     * Peer to register the service on
+     */
+    peer: IFluenceInternalApi;
+
+    /**
+     * Service definition
+     */
+    def: ServiceDef;
+
+    /**
+     * Service id
+     */
+    serviceId: string | undefined;
+
+    /**
+     * Service implementation
+     */
+    service: any;
+}
+
+/**
+ * Register a service defined in Aqua on a Fluence peer
+ */
+export type RegisterServiceType = (args: RegisterServiceArgs) => void;