[WIP] General Cairo Types starting with bytes31 & ByteArray

[tabaktoni]

I would like to propose using custom Classes for each Cairo-type representation in JS.
We discussed this also for Abi One as the extension for the js type system.

• For now, leave a naive approach for existing types (without classes with opinionated conversion)

• for prototype:
  .compile() // compile from internal JS to Api format (HexString[]) // will be used in requestParser
  .decompile(data: HexString[]) // convert Api format to JS Data representation depending on data type // will be used in responseParser
  .constructor(....) // per class implementation depending on type
  .value() // default representation of the data

Goal

• Preserve distinction for data after parsing. One can know that it was X type (ex. ByteArray) in Cairo and not Y (ex. Felt*) or some other type
• Preserve knowledge on how to compile and decompile it.
• Preserve un-opinionated value as data.
• When doing static compile without abi we can distinguish Cairo-defined types instead of complex detection with ever-groving cairo custom types.
• When doing with Abi compile we can easily validate provided data to Abi and reorder parameters.
• Can we achieve a default return value the same as the Number or String class does?

bytes31

• represent 31 bytes data. In JS this can be stored as Uint8Array(31)
• Compiled (API format): [length, data0, data1, data2, ...dataX, pending_word, pending_word_len]
• Abi Cairo format: Cairo primitive: core::bytes_31::bytes31
• Can be created from HexString, number, BigInt, TextString
• Can have internal validation

 class Bytes31 {
  public data: Uint8Array(31)
  
  constructor(agr?: HexString | number  | BigInt | TextString)
  
  public compile(): HexString[]
  
  public decompile(args: HexString[])
  
  public toSring(): string
  
  public value() // opinionated what should be the default value? string?
 }

ByteArray

• represent Array of bytes31. In JS this can be stored as Bytes31[]
• Compiled (API format): [length, data0, data1, data2, ...dataX, pending_word, pending_word_len]
• Abi Cairo format: Cairo Struct:

  ByteArrayStruct = {
      data: Bytes31,
      pending_word,
      pending_word_len,
   }

• Can be created from which types of data? TextString, Bytes31[], ByteArrayStruct, HexString[]

 class ByteArray {
  public data: Bytes31[]
  
  constructor(agr?: HexString | number | BigInt | TextString)
  
  public compile(): HexString[]
  
  public decompile(args: HexString[])
  
  public toSring(): string
  
  public value() // opinionated what should be the default value? string?
 }