feat: ABI refactor

[petertonysmith94]

Closes TS-598, TS-599, TS-600
Part of TS-597, TS-601

• Closes Abi - Refactor / Parser #3030
• Closes Abi - Refactor / Coder #3031
• Closes Abi - Refactor / Gen #3032
• Related Abi - Refactor / Kickoff #3029
• Related Abi - Refactor / Conclusion #3033

Release notes

In this release, we:

• A brand new package @fuel-ts/abi for all things ABI related

Summary

• Introduction of the AbiParser which will transform an ABI into an easier to use entity.

Breakdown

ABI Parser

• feat: ABI parser #3089

Summary

• Adds the parsing functionality for an ABI. The Abi interface outputted by AbiParser will be the (hopefully) unchanging interface that will be used both by us in coders and typers, as well as external users who wish to work with the abi but not be affected by changing specifications.

• The AbiParser output is tested both by a comprehensive test in this PR as well as feat!: ABI Gen #3249 and feat: ABI coder #3402 which are based off of this PR and are directly consuming the output.

Flow diagrams

ABI Typegen

• feat!: ABI Gen #3249

Summary

The implementation has two parts:
1. AbiGen and its type generation which is done by using the AbiParser outputs,
2. The CLI providing inputs to AbiGen and saving its outputs to disk

ABI Coder

• feat: ABI coder #3402

Summary

• This PR encompasses the refactoring and revamping of the encoding.
• The following diagram outlines all the different encoding types and how the encoded types look in bytes.

Breaking Changes

fuels typegen no longer accepts -s, -p and -c flags

pnpm fuels typegen can now automatically recognize the type of program it's building so the flags --script, --predicate and --contract and their shorthands have been removed.

The storageSlots static field has been moved from a typegen'd contract into its factory

Storage slots don't need to be on the typegen'd Contract because they are only used during contract deployment.

// before
import { MyContract } from './typegend/contracts'

const defaultStorageSlots = MyContract.storageSlots;

// after
import { MyContractFactory } from './typegend/contracts'

const defaultStorageSlots = MyContractFactory.storageSlots;

Typegen'd simple sway enums don't have the Input/Output suffix anymore

Given the following enum:

enum Color {
    Red: (),
    Green: (),
}

The outputted type looks like this:

// before
import { ColorInput, ColorOutput } from './typegend/contracts/MyContract';

// after
import { Color } from './typegend/contracts/MyContract';

Vec<T> has been removed in favor of T[] and cannot be imported anymore

// before
import { Vec } from './typegend/common';
type MyInputVector = Vec<number>;

// now
type MyInputVector = number[];

The Interface class has been removed in favour of the AbiCoder.

// Before
const abiInterface = new Interface({ ...abi });

// After
const abiCoder = new AbiCoder({ ...abi });

The Interface.decodeFunctionResult has moved to the AbiCoderFunction.decodeOutput

// Before
const data = new Uint8Array(...);
abiInterface.decodeFunctionResult('fn_name', data)

// After
const data = new Uint8Array(...);
abiCoder.getFunction('fn_name').decodeOutput(data)

The Interface.decodeLog has moved to the AbiCoderLog.decode

// Before
const data = new Uint8Array(...);
abiInterface.decodeLog(data, 'log_id')

// After
const data = new Uint8Array(...);
abiCoder.getLog('log_id').decode(data);

The Interface.encodeConfigurable has moved to the AbiCoderConfigurable.encode

// Before
const value = 'Configurable Value';
abiInterface.encodeConfigurable('configurable_name', value);

// After
const value = 'Configurable Value';
abiInterface.getConfigurable('configurable_name').encode(value);

The Interface.encodeType and Interface.encodeType has moved to the AbiCoderType

// Before
abiInterface.encodeType('concrete_type_id', 'Type value');
abiInterface.decodeType('concrete_type_id', new Uint8Array(...));

// After
abiInterface.getType('concrete_type_id').encode('Type value');
abiInterface.getType('concrete_type_id').decode(new Uint8Array(...));

Accessing underlying coders is now achieved through a convenient class, AbiEncoding.

// Before
import { NumberCoder, BigNumberCoder, B256Coder, B512Coder, VoidCoder, BooleanCoder, RawSliceCoder, StrSliceCoder, StdStringCoder } from '@fuel-ts/abi-coder';

const u8Coder = new NumberCoder('u8');
const u16Coder = new NumberCoder('u16');
const u32Coder = new NumberCoder('u32');
const u64Coder = new BigNumberCoder('u64');
const u256Coder = new BigNumberCoder('u256');
const b256Coder = new B256Coder();
const b512Coder = new B512Coder();
const boolCoder = new BooleanCoder();
const voidCoder = new VoidCoder();

const byteCoder = new ByteCoder();
const rawSliceCoder = new RawSliceCoder();
const strSliceCoder = new StrSliceCoder();
const stdStringCoder = new StdStringCoder();
const stringCoder = new StringCoder(4);

const arrayCoder = new ArrayCoder(u8Coder, 3);
const tupleCoder = new TupleCoder([u8Coder, u8Coder]);
const vectorCoder = new VecCoder(u8Coder);

const enumCoder = new EnumCoder('name of enum', { u8: u8Coder });
const optionCoder = new OptionCoder('name of option', { None: voidCoder, Some: voidCoder });
const structCoder = new StructCoder('name of struct', { u8: u8Coder });

// After
import { encoding } from '@fuel-ts/abi';

const u8Coder = encoding.u8;
const u16Coder = encoding.u16;
const u32Coder = encoding.u32;
const u64Coder = encoding.u64;
const u256Coder = encoding.u256;
const b256Coder = encoding.b256;
const b512Coder = encoding.b512;
const boolCoder = encoding.bool;
const voidCoder = encoding.void;

const byteCoder = encoding.byte;
const rawSliceCoder = encoding.rawSlice;
const strSliceCoder = encoding.str;
const stdStringCoder = encoding.stdString;
const stringCoder = encoding.string(4);

const arrayCoder = encoding.array(u8Coder, 3);
const tupleCoder = encoding.tuple([u8Coder, u8Coder]);
const vectorCoder = encoding.vector(u8Coder);

const enumCoder = encoding.enum({ u8: u8Coder });
const optionCoder = encoding.option({ None: voidCoder, Some: voidCoder });
const structCoder = encoding.struct({ u8: u8Coder });

Removal of the constant INPUT_COIN_FIXED_SIZE

import { INPUT_COIN_FIXED_SIZE } from 'fuels';

Renamed Encoding from the @fuel-ts/crypto package to BufferEncoding.

// Before
import { Encoding } from '@fuel-ts/crypto';

// After
import { BufferEncoding } from '@fuel-ts/crypto';

Checklist

• All changes are covered by tests (or not applicable)
• All changes are documented (or not applicable)
• I reviewed the entire PR myself (preferably, on GH UI)
• I described all Breaking Changes (or there's none)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
create-fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 23, 2025 3:15pm
fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 23, 2025 3:15pm
ts-api-docs	❌ Failed (Inspect)			Jan 23, 2025 3:15pm
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 23, 2025 3:15pm
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 23, 2025 3:15pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
create-fuels-counter-example	⬜️ Ignored (Inspect)			Jan 23, 2025 3:15pm

[petertonysmith94]

Note

This is not to be merged until we've concluded development

[github-actions]

Coverage Report:

Lines	Branches	Functions	Statements
79.26%(+0%)	71.93%(+0%)	77.55%(+0%)	79.33%(+0%)

Changed Files:

Coverage values did not change👌.