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

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[];

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 22, 2025 2:53pm
fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 2:53pm
ts-api-docs	❌ Failed (Inspect)			Jan 22, 2025 2:53pm
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 2:53pm
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 2:53pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
create-fuels-counter-example	⬜️ Ignored (Inspect)			Jan 22, 2025 2:53pm

[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👌.