chore!: internalize old JsonAbi format

[nedsalk]

Note

This PR merges into #2856.

Summary

1. All public-facing APIs are taking in the new JsonAbi type instead of the old one, which has been renamed to JsonAbiOld.
2. Transpilation happens on the Interface level and is an internal detail. Typegen includes the new abi format in its generated code and doesn't transpile it.
3. AbiCoder is no longer exported and its functionality has been added to Interface via encodeType/decodeType methods (ee734b9).
4. Removed Interface.findTypeById method in 157bdba because the concept of a type in the new abi differs from the old one. Whoever wants to get a specific type, be it a concrete or metadata type, can do so directly from the abi that they have on the Interface.jsonAbi property.

Breaking Changes

AbiCoder is no longer available to import

AbiCoder is no longer exported and the way to do encoding and decoding of specific types is now via the Interface.encodeType and Interface.decodeType methods:

// before
const abi = yourAbi;
const functionArg = abi.functions.inputs[0];

const encoded = AbiCoder.encode(abi, functionArg, valueToEncode);
const decoded = AbiCoder.decode(abi, functionArg, valueToDecode, 0);

// after
const abi = yourAbi;
const functionArg = abi.functions.inputs[0];

const abiInterface = new Interface(abi);

const encoded = abiInterface.encodeType(functionArg.concreteTypeId, valueToEncode);
const decoded = abiInterface.decodeType(functionArg.concreteTypeId, valueToDecode);

Interface.findTypeById has been removed

Previously, you could get a type from the abi via the Interface.findTypeById. This method has been removed after introduction of the new abi specification because the concept of a type has been split into concrete types and metadata types. If you want a specific type, you can get it from the abi directly.

// before
const abiInterface = new Interface(abi);

// internally this method searched the abi types:
// abi.types.find(t => t.typeId === id);
const type = abiInterface.findTypeById(id);

// after
// search the types on the abi directly
const concreteType = abi.concreteTypes.find(ct => ct.concreteTypeId === id);
const metadataType = abiInterface.jsonAbi.metadataTypes.find(mt => mt.metadataTypeId === id);

JsonAbiArgument is no longer exported

The JsonAbiArgument type isn't part of the new ABI spec (#596, #599) as such so we stopped exporting it. Its closest equivalent now would be a concrete type because it fully defines a type.

// before
const arg: JsonAbiArgument = {...};

// after
type ConcreteType = JsonAbi["concreteTypes"][number]
const arg: ConcreteType = {...};

Checklist

• I added — tests to prove my changes
• I updated — all the necessary docs
• I reviewed — the entire PR myself, using the GitHub UI
• I described — all breaking changes and the Migration Guide

[petertonysmith94]

May be worth adding to the breaking changes the removal of the JsonAbiArgument type.

I did a pretty rigorous review of what is exposed publicly and I'm happy with this now - nice one 🍏

[petertonysmith94]

@nedsalk @arboleya this looks ready to go now - shall we get this merged into aa/feat/adding-abi-transpiler?