Introduce MinaProgram #2095
Introduce MinaProgram #2095
Conversation
Trivo25
requested review from
Shigoto-dev19 and
ymekuria
and removed request for
a team
| async method( | ||
| env: Experimental.V2.MinaProgramEnv<TestState>, | ||
| value: Field | ||
| ): Promise<Experimental.V2.MinaProgramMethodReturn<TestState>> { |
There was a problem hiding this comment.
this is really awful but no other way if we want to keep it in the experimental namesapce for now
| return UInt64.from(amount * 1e9); | ||
| } else return UInt64.from(amount * BigInt(1e9)); | ||
| }, | ||
| toMINA: (amount: MinaAmount): bigint => { |
There was a problem hiding this comment.
It might be nice to optionally throw if there is a remainder in this division. Personally, I would enable that param if it were offered to me.
| }; | ||
|
|
||
| // boo typescript | ||
| function mapObject<In extends { [key: string]: any }, Out extends { [key in keyof In]: any }>( |
There was a problem hiding this comment.
Something like this might be preferable. It will give a return type based on the function signature.
There was a problem hiding this comment.
| function mapObject<In extends { [key: string]: any }, Out extends { [key in keyof In]: any }>( | |
| function mapObject<In extends { [key: string]: any }, Out>( |
There was a problem hiding this comment.
In addition to that change, replace instances of Out[Key] with Out. You may also consider changing the name from Out to ValueOfOut or just T since it no longer represents the return type of the mapping function, just the return type of f.
There was a problem hiding this comment.
Yea, there are a lot of type errors and improvements we can and should do. I focused on getting everything to work first, fixing these will hoefully happen in the coming PRs. sadly its too much to fix everything right now but I agree
| }; | ||
|
|
||
| class MinaProgramEnv<State extends StateLayout> { | ||
| private expectedPreconditions: Unconstrained<{ |
There was a problem hiding this comment.
#expectedPreconditions: Unconstrained<{
This is another option to make the property truly private instead of typescript's fake private keyword.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_properties
https://www.typescriptlang.org/docs/handbook/classes.html#public-private-and-protected-modifiers
There was a problem hiding this comment.
I think we don't use the hashtag syntax anywhere, and that's fine. Just raising it as an option.
There was a problem hiding this comment.
We do use it in a few places and I agree! See #2095 (comment)
We'll have to go through everything and overhaul it to bring it up to date with the rest of the codebase and latest ts standards
| Event = Field[], | ||
| Action = Field[] | ||
| > = | ||
| | Omit< |
There was a problem hiding this comment.
This type is not very human-readable. Good candidate for a @link comment and a short description of why it can be either one thing or another.
| ...args: ProvableTupleInstances<PrivateInputs> | ||
| ) => Promise<AccountUpdateTree<AccountUpdate<State, Event, Action>, AccountUpdate>>; | ||
|
|
||
| interface MinaProgramDescription< |
There was a problem hiding this comment.
Is there a guide to when we prefer interface or type?
There was a problem hiding this comment.
No guide, but we do usually prefer types if possible
| >; | ||
| }; | ||
|
|
||
| // TODO really need to fix the types here... |
There was a problem hiding this comment.
Can you enumerate the issues you want to fix in the comment?
There was a problem hiding this comment.
Sadly one of many leftovers from the original prototype, see #2095 (comment)
| @@ -0,0 +1,127 @@ | |||
| import { Bool, Experimental, Field, PrivateKey, PublicKey, UInt32 } from 'o1js'; | |||
|
|
|||
| const V2 = Experimental.V2; | |||
There was a problem hiding this comment.
Bit of a nit pick, but I think MinaV2 is a better name within the experimental namespace than V2. It's more clear that we're working on a new API for interacting with Mina, not everything.
| const TestProgram = V2.MinaProgram({ | ||
| name: 'TestProgram', | ||
| State: TestState, | ||
| Event: V2.GenericData, |
There was a problem hiding this comment.
Idk what Event and Action are here
|
|
||
| setState: { | ||
| x: V2.Update.from(value, Field(0)) as never, | ||
| address: V2.Update.from(env.accountId.publicKey, PublicKey.empty()) as never, |
There was a problem hiding this comment.
Only the x value needs the casting as never. Do you know why the typing for setState doesn't allow an update for x?
|
@Trivo25 you can force merge this if you need to. I left several questions, mostly for my own understanding. |
No description provided.