Abi - Refactor / Kickoff

[arboleya]

Instead of merely combining both packages in a single folder, the aim is to refactor them using the same structural approach. After recently modified Spec and Encoding strategies, and with future-proofing in mind, we can look ahead and strategize a proper foundation that should be resilient to future needs.

• Draft new directory structure
• Draft high-level package diagram/flowchart
• Define basic concepts for types' classes (oop, functions, etc.)
  • We will follow the general principles that internally we will strive for functional based, with external entrypoint generally exposed a class.
• Define essential layers: AbiParser, AbiCoder, AbiGen (typegen)
• Add foundation for the new abi package, basic infra for tests, etc.
• Consolidate and share existent fixtures between all layers
• Favor feature-complete contracts over small minimalistic ones
  • Consolidate + refactor abi-coder/exhaustive-examples test and to fuel-gauge/abi-contract
  • Consolidate abi-typegen/* tests and merge into the related fuel-gauge/abi-* Sway program.
  • Consolidate all abi-coder/encoding/**Coder related tests into Sway

[arboleya]

[arboleya]

Basic sketch of what could be a starting point for the file structure.

abi
├── coder
│   ├── AbiCoder.ts
│   ├── encodings
│   │   ├── v1
│   │   │   ├── array.ts
│   │   │   └── enum.ts
│   │   └── v2
│   │       ├── array.ts
│   │       └── enum.ts
│   └── types
├── gen
│   ├── AbiGen.ts
│   ├── formatters
│   │   ├── configurables.ts
│   │   ├── enums.ts
│   │   ├── functions.ts
│   │   └── ...
│   ├── renders
│   │   ├── renderContract.ts
│   │   └── ...
│   ├── templates
│   │   ├── typescript
│   │   │   ├── contract-factory.hbs
│   │   │   ├── contract.hbs
│   │   │   └── ...
│   │   └── javascript
│   └── types
├── parser
│   ├── AbiParser.ts
│   ├── specs
│   │   ├── v1
│   │   │   ├── interface.ts
│   │   │   └── transpiler.ts
│   │   └── v2
│   └── types
└── test
    ├── fixtures
    │   └── forc-projects
    └── integration

[petertonysmith94]

We have addressed the key issues of this PR, so I am closing this as complete.