CairoByteArray #1469

tabaktoni · 2025-08-06T16:05:25Z

Motivation and Resolution

Fix: #1455
Fix: #1014

RPC version (if applicable)

Usage related changes

TODO

Development related changes

TODO

Checklist:

Performed a self-review of the code
Rebased to the last commit of the target branch (or merged it into my branch)
Linked the issues which this PR resolves
Documented the changes in code (API docs will be generated automatically)
Updated the tests
All tests are passing

…31, CairoFelt252, CairoUint32

PhilippeR26

Just few comments.

src/utils/encode.ts

src/utils/cairoDataTypes/uint32.ts

src/utils/cairoDataTypes/felt.ts

src/utils/cairoDataTypes/bytes31.ts

src/utils/cairoDataTypes/byteArray.ts

…ByteArray

…Compiler + custom parser

…d narrow response type

…ParsingStrategy

…TX flow

* feat: reduce TX wait time, and provide known failed reasons based on TX flow * test: eventless write bytearray xtest * feat: uint static factory methods * refactor: cleanup * feat: missing primitive integers implemented as cairo types * chore: cleanup

penovicp

The comments I would emphasize relate to the usage of Buffer, the rest are mostly concerned with tidying up.

src/utils/cairoDataTypes/byteArray.ts

src/utils/cairoDataTypes/bytes31.ts

src/utils/typed.ts

src/channel/rpc_0_8_1.ts

src/utils/cairoDataTypes/felt.ts

penovicp · 2025-08-14T00:00:47Z

__tests__/utils/shortString.test.ts

    expect(isShortString(shortStr)).toBe(true);
  });

+  test('should return true for short strings', () => {


Should this test be kept? Would it make sense to add an isASCII check inside isShortString and note that constraint in its description?

isShortString is bugged. I left a note below for todo, it should be fixed or removed. But I tried to minimize the scope of this PR, as it already gets huge.

penovicp · 2025-08-14T00:03:40Z

src/utils/encode.ts

+ * @param hex string to check
+ * @returns true if hex string
+ */
+function isHexString(hex: string): boolean {


A hex check function is present in both encode and num.

Yes circular issue so this was the simplest solution.

penovicp · 2025-08-14T00:07:05Z

src/utils/calldata/requestParser.ts

-    case isTypeBytes31(type):
-      return encodeShortString(val.toString());
+      return parser.getRequestParser(type)(val);
+    case CairoUint8.isAbiType(type):


Could have all the uint/int cases fall through to a shared return. Same thing in the response parser.

Good point, I also taught about this, but
It would break the pattern of enclosed class, so I would need to have a generic CairoInt class that only has this check, or a generic Inc Class that spawns all Int types. In any case, I leave it for some future PR where it would need to be taught true.

Or some other solution...

src/utils/cairoDataTypes/uint8.ts

penovicp · 2025-08-14T00:22:50Z

src/utils/transactionReceipt/transactionReceipt.ts


 /**
+ * !! Main design decision:
+ * Class can't extend GetTransactionReceiptResponse because it is union type


Since the union members from GetTransactionReceiptResponse overlap in their properties, it might be worth trying implements SomeType where SomeType is:

{ [k in keyof GetTransactionReceiptResponse]: GetTransactionReceiptResponse[k] } //or Pick<GetTransactionReceiptResponse, keyof GetTransactionReceiptResponse>

I tried and failed miserably, I see a solution in not having an error case, but for the scope of PR, i leave this to some other PR.

Extending this way return type would have only common props and not base props spread from the Api, and that was the point of this refactor, to have those props visible to TS.

Co-authored-by: Petar Penović <[email protected]>

# [8.2.0](v8.1.2...v8.2.0) (2025-08-15) ### Features * a CairoByteArray, CairoTypes, updates ([#1469](#1469)) ([430fb70](430fb70)), closes [#1472](#1472)

github-actions · 2025-08-15T15:42:31Z

🎉 This PR is included in version 8.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

tabaktoni added 4 commits August 4, 2025 23:48

feat: byteArray for byte arrays

60327b5

chore: unstaged files

06e3c11

feat: initial impl. ByteArray using composable Cairo types, Cairobyte…

e898ea4

…31, CairoFelt252, CairoUint32

Merge branch 'develop' into fix/1455

cce9d16

PhilippeR26 reviewed Aug 7, 2025

View reviewed changes

tabaktoni added 14 commits August 7, 2025 19:27

feat: polish tests and implementation, Api factory added

10dd269

fix: bytearray integration tests without parser, fix padding and compile

031b043

chore: integration test

9f8b5a8

feat: extend parser to configurable response parsing, integrate Cairo…

9bc92dd

…ByteArray

fix: compiled api request calldata should be hex not decimal string

3884f13

feat: parserHR, contract integration, contract prop req/res parsing, …

dfae30f

…Compiler + custom parser

feat: contract optional waitForTransaction on ivoke

770c304

feat: contract invoke waitForTransaction, fix: tx receipt helper fixe…

509e072

…d narrow response type

feat: new data driven parsing strategy,def hdParsingStrategy and fast…

13e39b8

…ParsingStrategy

feat: init parsing strategies, test: event byteArray, fix: decodeUtf8

11389fe

feat: integrate rest of the simplest CairoTypes in parsing strategy

c2ca0b3

feat: reduce TX wait time, and provide known failed reasons based on …

2f58ae6

…TX flow

test: eventless write bytearray xtest

b09edc6

feat: uint static factory methods

1dbd9fc

tabaktoni marked this pull request as ready for review August 13, 2025 12:22

tabaktoni added 4 commits August 13, 2025 15:18

refactor: cleanup

0b27d0d

feat: missing primitive integers implemented as cairo types

228bc6b

chore: cleanup

2dd92e9

feat: CairoType integers (#1472)

e901466

* feat: reduce TX wait time, and provide known failed reasons based on TX flow * test: eventless write bytearray xtest * feat: uint static factory methods * refactor: cleanup * feat: missing primitive integers implemented as cairo types * chore: cleanup

penovicp reviewed Aug 14, 2025

View reviewed changes

tabaktoni and others added 5 commits August 14, 2025 11:27

fix: signed int hex format, compiled helper

cffa8c6

chore: resolve merge

131a54f

feat: a Buffer in browser and Buffer config

37e951b

chore: typeof clenup

2c4d15d

Update src/utils/cairoDataTypes/felt.ts

74a8069

Co-authored-by: Petar Penović <[email protected]>

tabaktoni requested review from PhilippeR26 and penovicp August 14, 2025 13:37

test: message fix

b20a690

tabaktoni merged commit 430fb70 into develop Aug 15, 2025
3 checks passed

github-actions bot pushed a commit that referenced this pull request Aug 15, 2025

chore(release): 8.2.0 [skip ci]

500ad74

# [8.2.0](v8.1.2...v8.2.0) (2025-08-15) ### Features * a CairoByteArray, CairoTypes, updates ([#1469](#1469)) ([430fb70](430fb70)), closes [#1472](#1472)

github-actions bot added the released on @next label Aug 15, 2025

penovicp deleted the fix/1455 branch August 27, 2025 12:59

CairoByteArray #1469

CairoByteArray #1469

Uh oh!

Conversation

tabaktoni commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Resolution

RPC version (if applicable)

Usage related changes

Development related changes

Checklist:

Uh oh!

PhilippeR26 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

penovicp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Aug 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tabaktoni commented Aug 6, 2025 •

edited

Loading