-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
StarknetByteArray; Support revision 1 string in `StarknetType…
…dData` (#175)
- Loading branch information
Showing
7 changed files
with
180 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import Foundation | ||
|
|
||
| private let shortStringMaxLen = 31 | ||
|
|
||
| /// Represents a ByteArray struct from Cairo. | ||
| /// | ||
| /// The ByteArray struct is used to represent a string in Cairo. | ||
| /// | ||
| /// - Parameters: | ||
| /// - data: list of 31-byte chunks of the byte array | ||
| /// - pendingWord: the last chunk of the byte array, which consists of at most 30 bytes | ||
| /// - pendingWordLen: the number of bytes in `pendingWord` | ||
| public struct StarknetByteArray: Equatable, Hashable, ExpressibleByStringLiteral { | ||
| let data: [Felt] | ||
| let pendingWord: Felt | ||
| let pendingWordLen: Int | ||
|
|
||
| public init?(data: [Felt], pendingWord: Felt, pendingWordLen: Int) { | ||
| self.data = data | ||
| self.pendingWord = pendingWord | ||
| self.pendingWordLen = pendingWordLen | ||
|
|
||
| guard self.data.allSatisfy({ $0.byteWidth == shortStringMaxLen }), | ||
| self.pendingWordLen >= 0, | ||
| self.pendingWordLen < shortStringMaxLen, | ||
| self.pendingWord.byteWidth == self.pendingWordLen | ||
| else { | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| public init(fromString string: String) { | ||
| let shortStrings = string.splitToShortStrings() | ||
| let encodedShortStrings = shortStrings.map { Felt.fromShortString($0)! } | ||
|
|
||
| if shortStrings.isEmpty || shortStrings.last!.count == shortStringMaxLen { | ||
| self.data = encodedShortStrings | ||
| self.pendingWord = .zero | ||
| self.pendingWordLen = 0 | ||
| } else { | ||
| self.data = encodedShortStrings.dropLast() | ||
| self.pendingWord = encodedShortStrings.last! | ||
| self.pendingWordLen = shortStrings.last!.count | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public extension StarknetByteArray { | ||
| typealias StringLiteralType = String | ||
|
|
||
| init(stringLiteral value: String) { | ||
| self.init(fromString: value) | ||
| } | ||
| } | ||
|
|
||
| private extension Felt { | ||
| var byteWidth: Int { | ||
| (value.bitWidth + 7) / 8 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import Foundation | ||
|
|
||
| public extension String { | ||
| func splitToShortStrings() -> [String] { | ||
| self.components(withMaxLength: 31) | ||
| } | ||
| } | ||
|
|
||
| extension String { | ||
| func components(withMaxLength length: Int) -> [String] { | ||
| stride(from: 0, to: self.count, by: length).map { | ||
| let start = self.index(self.startIndex, offsetBy: $0) | ||
| let end = self.index(start, offsetBy: length, limitedBy: self.endIndex) ?? self.endIndex | ||
| return String(self[start ..< end]) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import XCTest | ||
|
|
||
| @testable import Starknet | ||
|
|
||
| final class ByteArrayTests: XCTestCase { | ||
| static let cases: [(String, StarknetByteArray)] = [ | ||
| ("hello", .init(data: [], pendingWord: "0x68656c6c6f", pendingWordLen: 5)!), | ||
| ("Long string, more than 31 characters.", .init(data: ["0x4c6f6e6720737472696e672c206d6f7265207468616e203331206368617261"], pendingWord: "0x63746572732e", pendingWordLen: 6)!), | ||
| ("ABCDEFGHIJKLMNOPQRSTUVWXYZ12345AAADEFGHIJKLMNOPQRSTUVWXYZ12345A", .init(data: ["0x4142434445464748494a4b4c4d4e4f505152535455565758595a3132333435", "0x4141414445464748494a4b4c4d4e4f505152535455565758595a3132333435"], pendingWord: "0x41", pendingWordLen: 1)!), | ||
| ("ABCDEFGHIJKLMNOPQRSTUVWXYZ12345", .init(data: ["0x4142434445464748494a4b4c4d4e4f505152535455565758595a3132333435"], pendingWord: .zero, pendingWordLen: 0)!), | ||
| ("ABCDEFGHIJKLMNOPQRSTUVWXYZ1234", .init(data: [], pendingWord: "0x4142434445464748494a4b4c4d4e4f505152535455565758595a31323334", pendingWordLen: 30)!), | ||
| ("", .init(data: [], pendingWord: .zero, pendingWordLen: 0)!), | ||
| ] | ||
|
|
||
| func testByteArrayFromString() { | ||
| for (string, expected) in ByteArrayTests.cases { | ||
| print(string) | ||
| let actual = StarknetByteArray(fromString: string) | ||
| XCTAssertEqual(actual, expected) | ||
| } | ||
| } | ||
|
|
||
| func testExpressibleByStringLiteral() { | ||
| let byteArray: StarknetByteArray = "hello" | ||
| XCTAssertEqual(byteArray, StarknetByteArray(data: [], pendingWord: "0x68656c6c6f", pendingWordLen: 5)) | ||
| } | ||
|
|
||
| func testInvalidByteArray() { | ||
| XCTAssertNil(StarknetByteArray(data: [], pendingWord: "0x68656c6c6f", pendingWordLen: 31)) // pendingWordLen too big | ||
| XCTAssertNil(StarknetByteArray(data: [], pendingWord: "0x68656c6c6f6", pendingWordLen: 4)) // pendingWordLen is not equal to the length of pendingWord | ||
| XCTAssertNil(StarknetByteArray(data: ["0x4142434445464748494a4b4c4d4e4f505152535455565758595a3132333435", "0x68656c6c6f"], pendingWord: .zero, pendingWordLen: 0)) // Not all data elements have length 31 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
Tests/StarknetTests/Resources/TypedData/typed_data_rev_1_basic_types_example.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| { | ||
| "types": { | ||
| "StarknetDomain": [ | ||
| { "name": "name", "type": "shortstring" }, | ||
| { "name": "version", "type": "shortstring" }, | ||
| { "name": "chainId", "type": "shortstring" }, | ||
| { "name": "revision", "type": "shortstring" } | ||
| ], | ||
| "Example": [ | ||
| { "name": "n0", "type": "felt" }, | ||
| { "name": "n1", "type": "bool" }, | ||
| { "name": "n2", "type": "string" }, | ||
| { "name": "n3", "type": "selector" }, | ||
| { "name": "n4", "type": "u128" }, | ||
| { "name": "n5", "type": "i128" }, | ||
| { "name": "n6", "type": "ContractAddress" }, | ||
| { "name": "n7", "type": "ClassHash" }, | ||
| { "name": "n8", "type": "timestamp" }, | ||
| { "name": "n9", "type": "shortstring" } | ||
| ] | ||
| }, | ||
| "primaryType": "Example", | ||
| "domain": { | ||
| "name": "StarkNet Mail", | ||
| "version": "1", | ||
| "chainId": "1", | ||
| "revision": "1" | ||
| }, | ||
| "message": { | ||
| "n0": "0x3e8", | ||
| "n1": true, | ||
| "n2": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", | ||
| "n3": "transfer", | ||
| "n4": "0x3e8", | ||
| "n5": "-170141183460469231731687303715884105727", | ||
| "n6": "0x3e8", | ||
| "n7": "0x3e8", | ||
| "n8": 1000, | ||
| "n9": "transfer" | ||
| } | ||
| } |