Contract Types Plugin - Initial Implementation #91

ricklove · 2022-01-20T19:13:59Z

Full readme: taqueria-plugin-contract-type-generator/Readme.md

Requires:

Add Types for Contract methods, storage, views, etc. ecadlabs/taquito#1343 [Merged, pending release v 11.2]

Related Issues:

Completes

contract.methods and contract.methodsObject parameters are fully typed
contract.storage is fully typed
originate storage parameter is fully typed

This plugin will generate typescript types for a contract.

In the simple case, it reads the artifacts folder for any *.tz Michelson files and will generate a types file with the matching filename for each.

Example Usage (based on an nft auction contract from open minter sdk)

export const exampleContractMethods1 = async () => {

    const Tezos = new TezosToolkit(`https://YOUR_PREFERRED_RPC_URL`)

    const contract = await Tezos.contract.at<TestContract>(`tz123`);

    contract.methods.bid(tas.nat(0));
    contract.methods.configure(
        /*opening_price:*/ tas.mutez(10),
        /*min_raise_percent:*/ tas.nat(10),
        /*min_raise:*/ tas.mutez(10),
        /*round_time:*/ tas.nat(10),
        /*extend_time:*/ tas.nat(10),
        /*asset:*/ [{
            fa2_address: tas.address(`tz123`),
            fa2_batch: [{
                amount: tas.nat(100),
                token_id: tas.nat(`100000000000000`),
            }],
        }],
        /*start_time:*/ tas.timestamp(new Date()),
        /*end_time:*/ tas.timestamp(`2020-01-01`),
    );

    // methodsObject
    contract.methodsObject.bid(tas.nat(0));
    contract.methodsObject.configure({
        asset: [{
            fa2_address: tas.address(`tz123`),
            fa2_batch: [{
                amount: tas.nat(100),
                token_id: tas.nat(`100000000000000`),
            }],
        }],
        start_time: tas.timestamp(new Date()),
        end_time: tas.timestamp(`2020-01-01`),
        extend_time: tas.nat(10),
        min_raise: tas.mutez(10),
        min_raise_percent: tas.nat(10),
        opening_price: tas.mutez(10),
        round_time: tas.nat(10),
    });

};

Example typegen task

$ taqueria typegen --typescriptDir ./types
generateTypes
{
  "typescriptDir": "./types"
}
Generating Types: /home/rick/projects/crypto/taqueria/example/artifacts => /home/rick/projects/crypto/taqueria/example/types
Contracts Found:
        - /home/rick/projects/crypto/taqueria/example/artifacts/example-contract-1.tz
Processing /example-contract-1.tz...example-contract-1.tz: Types generated

Example type output

type Storage = {
    pauseable_admin?: {
        admin: address;
        paused: boolean;
        pending_admin?: address;
    };
    current_id: nat;
    max_auction_time: nat;
    max_config_to_start_time: nat;
    auctions: BigMap<nat, {
        seller: address;
        current_bid: mutez;
        start_time: timestamp;
        last_bid_time: timestamp;
        round_time: int;
        extend_time: int;
        asset: Array<{
            fa2_address: address;
            fa2_batch: Array<{
                token_id: nat;
                amount: nat;
            }>;
        }>;
        min_raise_percent: nat;
        min_raise: mutez;
        end_time: timestamp;
        highest_bidder: address;
    }>;
};

type Methods = {
    confirm_admin: () => Promise<void>;
    pause: (param: boolean) => Promise<void>;
    set_admin: (param: address) => Promise<void>;
    bid: (param: nat) => Promise<void>;
    cancel: (param: nat) => Promise<void>;
    configure: (
        opening_price: mutez,
        min_raise_percent: nat,
        min_raise: mutez,
        round_time: nat,
        extend_time: nat,
        asset: Array<{
            fa2_address: address;
            fa2_batch: Array<{
                token_id: nat;
                amount: nat;
            }>;
        }>,
        start_time: timestamp,
        end_time: timestamp,
    ) => Promise<void>;
    resolve: (param: nat) => Promise<void>;
};

…s-generator-plugin

github-actions · 2022-01-20T19:15:32Z

Git Commit	Artifacts
`23dfbbd`	Linux MacOS Windows

npm package installation instructions
npm install @taqueria/[email protected]
taq install @taqueria/[email protected]
taq install @taqueria/[email protected]
taq install @taqueria/[email protected]
taq install @taqueria/[email protected]
taq install @taqueria/[email protected]

github-actions · 2022-01-21T18:46:37Z

Artifacts
Linux
Windows
MacOS

cloudflare-workers-and-pages · 2022-01-21T18:49:08Z

Deploying with Cloudflare Pages

Latest commit:	`7725e38`
Status:	✅ Deploy successful!
Preview URL:	https://7d5bffd8.taqueria.pages.dev

View logs

github-actions · 2022-01-21T21:19:11Z

Artifacts
Linux
Windows
MacOS

github-actions · 2022-01-21T21:46:50Z

Artifacts
Linux
Windows
MacOS

github-actions · 2022-01-21T21:57:25Z

Artifacts
Linux
Windows
MacOS

github-actions · 2022-01-21T22:06:57Z

Artifacts
Linux
Windows
MacOS

github-actions · 2022-01-21T22:17:17Z

Artifacts
Linux
Windows
MacOS

taqueria-plugin-contract-types/tasks.ts

mweichert

@ricklove as usual, good stuff!

A few thoughts/suggestions:

The init and scaffold tasks accept the output directory as a positional argument. Perhaps to keep to the UE consistent, we could accept a positional argument here as well instead of the typescriptDir option?
We're using verbs for task names everywhere else. Similarly to the above, to achieve consistently, perhaps we could rename the task from "types" to "gen types"? @russellmorton any verb suggestions?
There were a couple of inline TODOs, which is fine. Could we also create issues for those and list the issue #s beside the TODOs please?
I'm glad to see all of the automated tests. I just need to check with the SDET guys to see if they have any preference to move these somewhere else. @alexzbusko ?
I took forever to get you a code review on this. As such, this branch has diverged from main quite a bit. Do you mind merging main into your branch please? I promise not to take so long for the final sign-off.

Thanks again Rick. Really appreciate all of the effort on this. @alexzbusko when you're able, would you be able to pull this branch down, build it, and give it a spin once Rick makes some of the adjustments above? I'll do the same. We'll then have some manual test coverage on both Windows and Mac.

mweichert

Can't wait to see this merged in. Just a few minor adjustments @ricklove

taqueria-plugin-contract-types/package.json

ricklove · 2022-02-17T15:29:03Z

@ricklove as usual, good stuff!

A few thoughts/suggestions:

The init and scaffold tasks accept the output directory as a positional argument. Perhaps to keep to the UE consistent, we could accept a positional argument here as well instead of the typescriptDir option?

We're using verbs for task names everywhere else. Similarly to the above, to achieve consistently, perhaps we could rename the task from "types" to "gen types"? @russellmorton any verb suggestions?

There were a couple of inline TODOs, which is fine. Could we also create issues for those and list the issue #s beside the TODOs please?

I'm glad to see all of the automated tests. I just need to check with the SDET guys to see if they have any preference to move these somewhere else. @alexzbusko ?

I took forever to get you a code review on this. As such, this branch has diverged from main quite a bit. Do you mind merging main into your branch please? I promise not to take so long for the final sign-off.

Thanks again Rick. Really appreciate all of the effort on this. @alexzbusko when you're able, would you be able to pull this branch down, build it, and give it a spin once Rick makes some of the adjustments above? I'll do the same. We'll then have some manual test coverage on both Windows and Mac.

@mweichert

✔ Makes sense, will fix that
✔Changed to generate types with alias for gen types and gentypes
✔ Actually, those were obsolete comments. I cleaned up and removed old comments like that.
❗ I don't think it would make sense to move these outside the plugin, they aren't tests about the plugin, but are about the correctness of the internal implementation, i.e. they are very tightly coupled to the implementation (and are more the domain of the implementer, not of testers).

If anything it might make sense to move these to a peer folder (so they can have a different node_modules dependency set), but it would not make sense to move these tests out of the control of the plugin implementation or far away from the implementation code.

I do have an idea to expand these substantially, so this will require a longer discussion.
✔ Sure - will merge in latest main

…s-generator-plugin

ricklove · 2022-02-18T01:35:10Z

This should be ready, just need to test the positional argument

ricklove · 2022-02-18T14:33:29Z

Having trouble using the positional argument, debugging now

.github/workflows/main.yml

mweichert

Looks great!

ricklove added 8 commits January 13, 2022 10:35

Setup plugin project

eeb28d6

Copy code from old project

3d894fc

WIP Run tests

ec7d2f2

Cleanup

e25f600

Merge remote-tracking branch 'origin/main' into feature/contract-type…

56e36e7

…s-generator-plugin

Add example for contract types generator

ce019fa

Create plugin instructions in readme

1417cab

Add typescript-plugin-boilerplate

5ee9eba

Update example usage

2a2580e

ricklove added 5 commits January 21, 2022 15:06

Add methodsObject generation

088d6ad

Use contract abstract types

b9bb029

Simplifed usage

49e0715

Add methodsObject example usage

50057c1

Cleanup

8a9214c

ricklove added 2 commits January 21, 2022 15:38

Add type utils

6d71b92

Remove examples from repo

a06bbf6

Using taquito typefix

f95750a

Update notes

85a8c54

Update readme

e9f9fd2

ricklove mentioned this pull request Jan 21, 2022

Add Types for Contract methods, storage, views, etc. ecadlabs/taquito#1343

Merged

6 tasks

ricklove added 2 commits January 25, 2022 19:28

Update npm ref and example usages

70a36a6

Add withOrigination examples

8d89ea5

mweichert reviewed Feb 9, 2022

View reviewed changes

taqueria-plugin-contract-types/tasks.ts Outdated Show resolved Hide resolved

mweichert reviewed Feb 9, 2022

View reviewed changes

taqueria-plugin-contract-types/tasks.ts Show resolved Hide resolved

mweichert requested changes Feb 9, 2022

View reviewed changes

mweichert requested changes Feb 11, 2022

View reviewed changes

taqueria-plugin-contract-types/package.json Outdated Show resolved Hide resolved

mweichert assigned ricklove Feb 11, 2022

mweichert added the feature New feature or request label Feb 11, 2022

mweichert added this to the Milestone 2 milestone Feb 11, 2022

rick mentioned this pull request Feb 14, 2022

Hithere! rick/you-rang#1

Open

russellmorton removed this from the Stage 2 milestone Feb 16, 2022

ricklove added 4 commits February 17, 2022 09:42

Merge remote-tracking branch 'origin/main' into feature/contract-type…

96fde73

…s-generator-plugin

Merge branch 'main' into feature/contract-types-generator-plugin

87682d6

Cleanup

c2174b8

Cleanup

05a831f

FIX positional arg

c406d93

FIX positional arg

35a7740

ricklove assigned mweichert Feb 18, 2022

mweichert reviewed Feb 18, 2022

View reviewed changes

.github/workflows/main.yml Outdated Show resolved Hide resolved

ricklove added 4 commits February 18, 2022 09:28

FIX taq install instructions

353035c

Remove unneeded change

8c27a94

Remove unneeded change

c33c159

Change task to generate types

7725e38

mweichert approved these changes Feb 18, 2022

View reviewed changes

mweichert merged commit 576e84f into main Feb 18, 2022

mweichert modified the milestones: Current Release, v0.1.0 Feb 18, 2022

hu3man deleted the feature/contract-types-generator-plugin branch August 5, 2022 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contract Types Plugin - Initial Implementation #91

Contract Types Plugin - Initial Implementation #91

ricklove commented Jan 20, 2022 •

edited

Loading

github-actions bot commented Jan 20, 2022 •

edited

Loading

github-actions bot commented Jan 21, 2022

cloudflare-workers-and-pages bot commented Jan 21, 2022 •

edited

Loading

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

mweichert left a comment

mweichert left a comment

ricklove commented Feb 17, 2022 •

edited

Loading

ricklove commented Feb 18, 2022

ricklove commented Feb 18, 2022

mweichert left a comment

Contract Types Plugin - Initial Implementation #91

Contract Types Plugin - Initial Implementation #91

Conversation

ricklove commented Jan 20, 2022 • edited Loading

Related Issues:

Completes

Example Usage (based on an nft auction contract from open minter sdk)

Example typegen task

Example type output

github-actions bot commented Jan 20, 2022 • edited Loading

github-actions bot commented Jan 21, 2022

cloudflare-workers-and-pages bot commented Jan 21, 2022 • edited Loading

Deploying with Cloudflare Pages

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

github-actions bot commented Jan 21, 2022

mweichert left a comment

Choose a reason for hiding this comment

mweichert left a comment

Choose a reason for hiding this comment

ricklove commented Feb 17, 2022 • edited Loading

ricklove commented Feb 18, 2022

ricklove commented Feb 18, 2022

mweichert left a comment

Choose a reason for hiding this comment

ricklove commented Jan 20, 2022 •

edited

Loading

github-actions bot commented Jan 20, 2022 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 21, 2022 •

edited

Loading

ricklove commented Feb 17, 2022 •

edited

Loading