Emulator Feature: Bootstrap with default contracts

[srinjoyc]

👋   If you are interested in working on this issue, please check out the Getting Started guide on HackerEarth!

Description (Problem Statement)

The emulator is currently bootstrapped with (original contracts):

• FlowFees
• FlowServiceAccount
• FlowStorageFees
• FlowToken
• FungibleToken

There are also other contracts that are very commonly used and it would be practical if emulator came with those as well (new contracts):

• NFT contract
• Marketplace contract

An emulator flag should be introduced -onlyBasicContracts (choose better name if possible) when it is true only the original contracts should be deployed. By default it should be false, so all contracts are deployed.

The output of the deployed emulator contracts, when you start the emulator:

Should reflect the change. Also this display should be improved for readability (one line per contract).

Experience Required

• Familiarity with Go - able to parse and read emulator repo
• Familiarity with Cadence - able to parse and read the deployed contracts

Minimum Feature Set (Acceptance Criteria)

When starting the emulator the default deployed contracts should also include the new ones by default.

When starting the emulator with a -onlyBasicContracts flag only the original contracts should be deployed

The output of the emulator when starting it up should reflect actually deployed contracts.

Software Requirements

Maintainability

• The tools or libraries used to construct the solution should be well vetted and well maintained
• Code should be written in a way that can be extended with new functionality and clear enough for open-source developers to contribute to.

Other Requirements

Documentation

• The existing documentation needs to reflect this change

Judging Criteria

• For all projects, technical & high-level judging criteria apply.

Resources

• General Resource Guide
• Emulator
  • Repository
  • Documentation

[devbugging]

Hi 👋
my name is Gregor, and as a software engineer working on developer tools, I will be your point of contact for this task, so good luck, and don't hesitate to reach out to me with any problems or questions.

I'll keep an eye on your progress and will be reviewing your code.

You can comment here or find me on Discord (I'm sideninja#1970). Join the Flow Discord server if you're not there already!

[mwufi]

Hi Gregor! I'm kind of curious about the emulator in general, so happy to take this on!

I made a team for the hackathon named Team FlashyTigers, but no one's in the team yet except for me

[psiemens]

I made a team for the hackathon named Team FlashyTigers, but no one's in the team yet except for me

That's totally ok! You can submit as a solo team if you'd like.

Great to have you working on this. You can ping @sideninja with any questions you have.

@mwufi Do you need any help getting started on the implementation?

[mwufi]

@psiemens sure! i'm just getting started on it now and will ping you/@sideninja on the Discord!!

[mwufi]

Hey! I've taken a first stab at this here (onflow/flow-go#1353), by including the NFT contracts!

Does this look like a good approach?

(the flow-emulator change is rather small onflow/flow-emulator#86)

[devbugging]

Hi, @mwufi as quickly discussed on Discord I would suggest you move all the bootstrap contract code from FVM to the emulator as these contracts are specific to the emulator use and not generic to all other networks. You could create a bootstrap procedure in the emulator to achieve this. But anyhow great work so far. Going forward I also suggest you to open a PR on this repository with included links as mentioned in the flip fest instructions.

[mwufi]

OMG! almost there!

[mwufi]

Hm... does anyone want to review the change in flow-emulator? Could be fun!