0xweb/dequanto/src/gen/GeneratorStorageReader.ts

Contract package manager and other web3 tools

import alot from 'alot'
import { Web3Client } from '@dequanto/clients/Web3Client'
import { TAddress } from '@dequanto/models/TAddress'
import { TPlatform } from '@dequanto/models/TPlatform'
import { SlotsParser } from '@dequanto/solidity/SlotsParser'
import { $require } from '@dequanto/utils/$require'
import { File } from 'atma-io'
import { Str } from './utils/Str'
import { $abiType } from '@dequanto/utils/$abiType'
import { $path } from '@dequanto/utils/$path'
import { $gen } from './utils/$gen'
import { ISlotVarDefinition } from '@dequanto/solidity/SlotsParser/models'

export class GeneratorStorageReader {

    async generate(opts: {
        target?: 'js' | 'ts'

        network: TPlatform
        name: string
        contractName: string
        address: TAddress
        sources?: {
            [file: string]: { content: string }
        },
        client?: Web3Client
    }): Promise<{ code?: string, types?: string, className?: string, sourcePath?: string, error?: Error }> {

        let targetType = opts.target ?? 'ts';
        let { client, sources, contractName, address } = opts;
        let files = alot.fromObject(sources ?? {}).map(x => {
            return {
                path: x.key,
                content: x.value.content
            };
        }).toArray();

        if (files.length === 0) {
            return {
                error: new Error(`Not possible to generate the StorageReader class, without the source code`)
            };
        }
        let file = null as (typeof files[0]);
        if (files.length === 1) {
            file = files[0];
        } else {
            $require.notNull(contractName, `Contract name expected`);

            let rgx = new RegExp(`contract \\s*${contractName}\\b`, 'i')
            let main = files.reverse().find(x => {
                let r = rgx.test(x.content);
                return r;
            });
            file = main;
        }

        $require.String(file?.content ?? file?.path, `Expected a source content to resolve slots`)

        let slots = await SlotsParser.slots({ code: file.content, path: file.path }, contractName, { files })

        let methods = this.serializeSlots(slots);
        let codeMethods = methods.map(x => x[targetType]).join('\n\n');
        let codeMethodsTypings = methods.map(x => x.types).join('\n\n');

        let templatePath = $path.resolve(`/src/gen/templates/ContractStorageReaderTemplate.${targetType}.tmpl`);
        let template = await File.readAsync<string>(templatePath, { skipHooks: true });

        let templateTypingsPath = $path.resolve(`/src/gen/templates/ContractStorageReaderTemplate.d.ts.tmpl`);
        let templateTypings = await File.readAsync<string>(templateTypingsPath, { skipHooks: true });

        let className = $gen.toClassName(opts.name + 'StorageReader');
        let code = template
            .replace(`$NAME$`, className)
            .replace(`/* METHODS */`, () => codeMethods)
            .replace(`$SLOTS$`, () => JSON.stringify(slots, null, '    '))

        let codeTypings = templateTypings
            .replace(`$NAME$`, className)
            .replace(`/* METHODS */`, () => codeMethodsTypings)
            .replace(`$SLOTS$`, () => JSON.stringify(slots, null, '    '))

        return {
            className: className,
            code: code,
            types: codeTypings,
            sourcePath: file.path
        };
    }

    private serializeSlots (slots: ISlotVarDefinition[]) {
        return slots
            .map(slot => this.serializeSlot(slot))
            .map(entry => {
                return {
                    ts: Str.formatMethod(entry.ts),
                    js: Str.formatMethod(entry.js),
                    types: Str.formatMethod(entry.types),
                }
            });
    }

    private serializeSlot (slot: ISlotVarDefinition) {
        let name = slot.name;
        let type = slot.type;
        let { parametersTypes, parametersCall, returnType } = this.getParameters(type);
        return {
            ts: `
                async ${name}(${parametersTypes?.ts ?? ''}): Promise<${returnType}> {
                    return this.$storage.get(['${name}', ${ parametersCall ?? '' }]);
                }
            `,
            types: `
                ${name}(${parametersTypes?.ts ?? ''}): Promise<${returnType}>
            `,
            js: `
                async ${name}(${parametersTypes?.js ?? ''}) {
                    return this.$storage.get(['${name}', ${ parametersCall ?? '' }]);
                }
            `
        };
    }

    private getParameters (type: string): { parametersTypes?: { ts, js}, parametersCall?, returnType } {

        if (type.startsWith('mapping')) {
            let valueType = $abiType.mapping.getValueType(type);
            let keyType = $abiType.mapping.getKeyType(type);

            let keyTsType = $abiType.getTsTypeFromDefinition(keyType);
            let valueTsType = $abiType.getTsTypeFromDefinition(valueType);
            return {
                parametersTypes: {
                    ts: `key: ${keyTsType}`,
                    js: `key`
                },
                returnType: `${valueTsType}`,
                parametersCall: 'key',
            }
        }

        return {
            returnType: $abiType.getTsTypeFromDefinition(type)
        };
    }
}