feat: Byteslice class #490
Conversation
✅ Deploy Preview for tealscript ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -33,12 +33,12 @@ class Calculator extends Contract { | |||
| * | |||
| * @returns The result of the operation | |||
| */ | |||
| doMath(a: uint64, b: uint64, operation: string): uint64 { | |||
| doMath(a: uint64, b: uint64, operation: utf8): uint64 { | |||
There was a problem hiding this comment.
I wonder if str or utf8string is a clearer type name for this?
There was a problem hiding this comment.
I avoided str because I think it's a bit confusing since it's so close to string. I'm not opposed to utf8string but just went with utf8 since it's shorter
| let result: uint64; | ||
|
|
||
| if (operation === 'sum') { | ||
| if (operation === Bytes`sum`) { |
There was a problem hiding this comment.
It would be great to have a separate constructor function for utf-8 strings rather than using Bytes otherwise it's a bit confusing (e.g. "what does comparing a string with bytes mean?").
| if (operation === Bytes`sum`) { | |
| if (operation === Str`sum`) { |
There was a problem hiding this comment.
The answer to "what does comparing a string with bytes mean?" is "the same thing as comparing bytes to bytes". The underlying data is the exact same, utf8 here is just a signal of what the ABI type should be in the signature, nothing more or less.
| @@ -252,10 +252,17 @@ declare function Uint<N extends widths>(value: number | string): uint<N>; | |||
|
|
|||
| declare type ufixed<N extends widths, M extends precisions> = Brand<number, `ufixed${N}x${M}`>; | |||
|
|
|||
| declare class Byte {} | |||
|
|
|||
| declare class Byteslice<Length = void> {} | |||
There was a problem hiding this comment.
Byteslice isn't user-facing is it? It feels like a weird classname, but if users always use bytes instead then it doesn't matter
There was a problem hiding this comment.
Yeah the user facing type is bytes<N>. I had to go with Byteslice here because I wanted Bytes for the tag function
Due to the complexities of properly supporting EcmaScript utf-16 strings, a new class should be used to represent byteslices and utf-8 ABI strings. This PR is the implementation of the
Bytesliceclass.Migration
Literals
String literals must now use the
BytestagString Type
The
stringtype is no longer supported. Instead, useutf8which is an alias forByteslicePrototype Methods
bytes,bytes<N>, andutf8no longer support the string prototype methods. Most notably, you cannot access specific bytes/characters within a string via[idx]. This will likely be supported by a method onByteslicesuch asgetByte()