Generate types from a given ABI

[janniksam]

Generate Types from a given smart contract interface description (abi)

Overview

This pull request introduces a typescript generator aimed at enhancing development workflows by automating the generation of typescript proxy types from a smart contract abi file.

The generated typescript file includes builders for all included endpoints and types, providing encoders and decoders for all of them. It makes the interaction with the smart contracts very straightforward.

One significant advantage of utilizing this typescript generator, and this is why I built this, is the inherent type safety it provides for all interactions with a smart contracts.

Usage

To use the generator, use the following command:

xsuite generateproxy --from-abi /path/foobar.abi.json --output=/path/foobar.ts

Usage of the generated file

Given that we can't find the following endpoint description in our ABI file:

{
    "name": "getOptionalMultiValue3",
    "mutability": "readonly",
    "inputs": [
        {
            "name": "_id",
            "type": "u64"
        },
        {
            "name": "value",
            "type": "optional<multi<u32,BigUint,u8>>",
            "multi_arg": true
        }
    ],
    "outputs": [
        {
            "type": "optional<multi<u32,BigUint,u8>>",
            "multi_result": true
        }
    ]
},

We can use the generated file like this:

// Import the endpoint builder from the generated typescript file
import { getOptionalMultiValue3Builder } from 'foobar';

// getOptionalMultiValue3 is the method we want to call.
// the convention is methodName + Builder
const builder = getFooBuilder();

// encode the inputs
const funcArgs = builder.encodeInput(77n, [1, 30n, 2]);

/// query the endpoint
const response = await world.query({
  callee: myContract,
  funcName: builder.functionName,
  funcArgs,
});

// decode the response
const decodedData = builder.decodeOutput(response.returnData);
expect(decodedData).toBe([1, 30n, 2]);

###Limitation:

The following things aren't supported yet:

• The type BigFloat
• Complex Rust Enums
• Endpoints with more than one MultiValue