Add hardhat task to seed contract with data #83

knoll3 · 2022-10-07T17:58:28Z

Add hardhat task to seed data to contract

Adds a hardhat task called generate-history that seeds the contract with archaeologists, accused sarcophagi, and successful sarcophagi.

npx hardhat generate-history --network localhost

Config

Use the config file in tasks/generate-history/config.ts to define config values.

archaeologistCount: The number of archaeologists to register. This has nothing to do with the archaeologist service, it only calls register on the contract.
sarcohpagusCount: The number of sarcophagi to create using random archaeologist that are registered and random values for minshards/requiredArchs.
accusedSarcophagusCount: the number of sarcophagi to call accuse on. Calling this includes all archaeologists on the sarcophagus.
archaeologistUnwrapChance: The chance that an archaeologist will unwrap their sarcophagi. Depending on the config values archs will likely have multiple sarcos. If the roll of the dice dictate that an arch will not unwrap, then they will not unwrap any of their sarcophagi.

Testing

Spin up a node

npx hardhat node

Run the script. Don't forget to include --network localhost.

npx hardhat generate-history --network localhost

This will register archs, create sarcos, accuse archs on sarcos, and then unwrap sarcos.

Test by opening the console in another terminal

npx hardhat console --network localhost

Run the following functions in the console to see that arch profiles were created

const diamond = await ethers.getContract("Diamond_DiamondProxy")
const view = await ethers.getContractAt("ViewStateFacet", diamond.address)
const addresses = await view.getArchaeologistProfileAddresses()
const profiles = await view.getArchaeologistProfiles(addresses)
const stats = await view.getArchaeologistProfiles(addresses)

sethhrbek · 2022-10-09T23:32:56Z

tasks/generate-history/createSarcophagi.ts

+        // const signature = await signHre(
+        //   hre,
+        //   selectedArchaeologistSigners[i],
+        //   [doubleHashedShard, fakeShardTxId],
+        //   ["bytes32", "string"]
+        // );


can this signature block go bye-bye b/c there is the one above?

Yeah forgot to take this out

sethhrbek · 2022-10-09T23:39:35Z

tasks/generate-history/registerArchaeologists.ts

+    const minimumDiggingFee = 10;
+
+    // 1 week
+    const maximumRewrapInterval = 604800;


Wondering if this should be randomized (or able to be customized), so that the front-end would display some hidden archaeologists as well as some non-hidden. Not sure the best way to accomplish this to ensure you get some of each bucket (shown + hidden based on maxRewrapInterval)

We can. I started out that way but then realized that the rewrap interval is part of message that each arch signs, so the arch's criteria need to match up with what's being passed into the createSarcophagus function. So I set this as a constant to make things easier but we can certainly modify it.

The original intent of this task was to create arch metrics, not to create archaeologists that can be viewed from the app. We can certainly add to this with a bit more work though.

@knoll3 -- yeah, I think we can break this extra work out into a separate branch.

Since the place the reputation stats are going to mainly be viewed is on the front-end archaeologist multi-select, it's probably worth figuring out how to tie these registered archs to the arch service. I'll create a project card for this.

sethhrbek · 2022-10-09T23:40:21Z

tasks/generate-history/registerArchaeologists.ts

+  const archaeologistSigners: SignerWithAddress[] = [];
+  for (let i = 0; i < count; i++) {
+    const account = accounts[i];
+    const minimumDiggingFee = 10;


Could this be a randomized big number? That might help us test the digging fee filters on the front-end

https://ethereum.stackexchange.com/questions/97067/random-bignumber-in-ethers-js

example in that article looks like it lets you set a max value

Same answer from the rewrap interval. I started out making it random then made it a constant to simplify the code.

sethhrbek · 2022-10-09T23:43:27Z

tasks/generate-history/createSarcophagi.ts

+  const maximumRewrapInterval = 604800;
+  const diggingFee = 100;


Left a couple comments on the register archaeologist about randomizing these values, and that would affect these -- the digging fees would need to be set to a per-archaeologist value (based on their minDiggingFee) and the maximumRewrapInterval may need to be set to the maximum of the maximumRewrapInterval values (unless this value is automatically larger than the randomized vals, then it could be static)

sethhrbek · 2022-10-09T23:50:33Z

tasks/generate-history/index.ts

+  await increaseTo(hre, resurrectionTime + 100);
+
+  // Filter out the accuased sarcophagi for unwrapping
+  const unaccusedSarcophagiData = sarcophagiData.filter(
+    sarcophagus => !accusedSarcophagi.includes(sarcophagus.sarcoId)
+  );
+
+  // Unwrap some sarcohpagi
+  await unwrapSarcophagi(hre, archaeologistSigners, unaccusedSarcophagiData);


Will this automatically attempt to unwrap all unaccused sarcophagi?

We will probably want a way to have some sarcophagi that are not yet at the unwrap time yet.

Maybe an easy way would be to optionally skip this part of the script (to avoid fast-forwarding the block time). Another more involved version of this would be something like having 2 resurrection times, and fast-forwarding the block time between them.

sethhrbek · 2022-10-09T23:55:54Z

tasks/generate-history/registerArchaeologists.ts

+      await archaeologistFacet
+        .connect(account)
+        .registerArchaeologist(
+          "some-peer-id",


If we wanted to be able to hook up real archaeologists to these accounts (which may be useful), this could generate a real peerId. We would probably need to output the full peer Id JSON + signer private key (either via logs or write to a file) so archs could be hooked up with the registering account.

Otherwise we would need to disable the "check if online" portion of the front-end to see the archs, as they won't show up, which maybe what we want to do at this point to save time (we could discuss this).

sethhrbek · 2022-10-10T00:06:51Z

@knoll3 -- most of my comments are related to modifying this to scaffold data for additional sarcophagi that are in the future (not just the past), and also so that the archaeologists generated could be attached to real online archs.

Since this PR does a great job of setting up historical sarcophagi, these modifications could be done in a separate PR later, whenever testing these scenarios with larger sets of data would be useful.

knoll3 added 2 commits October 7, 2022 10:45

Add hardhat task to seed contract with data

3b34d7d

Fix errors after rebase

61897a8

knoll3 linked an issue Oct 7, 2022 that may be closed by this pull request

Add hardhat task to setup contract state for testing #72

Closed

Fix typechain error

5c77737

sethhrbek reviewed Oct 9, 2022

View reviewed changes

Add local hardhat network account info file

153a414

sethhrbek approved these changes Oct 10, 2022

View reviewed changes

sethhrbek merged commit 0164803 into main Oct 10, 2022

sethhrbek deleted the 72-add-hardhat-task-to-setup-contract-state-for-testing branch October 10, 2022 22:37

sethhrbek mentioned this pull request Oct 11, 2022

Generate-History updates #85

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hardhat task to seed contract with data #83

Add hardhat task to seed contract with data #83

knoll3 commented Oct 7, 2022 •

edited

Loading

sethhrbek Oct 9, 2022 •

edited

Loading

knoll3 Oct 10, 2022

sethhrbek Oct 9, 2022

knoll3 Oct 10, 2022

knoll3 Oct 10, 2022

sethhrbek Oct 10, 2022

sethhrbek Oct 9, 2022

knoll3 Oct 10, 2022

sethhrbek Oct 9, 2022

sethhrbek Oct 9, 2022 •

edited

Loading

sethhrbek Oct 9, 2022

sethhrbek commented Oct 10, 2022 •

edited

Loading

		const maximumRewrapInterval = 604800;
		const diggingFee = 100;

Add hardhat task to seed contract with data #83

Add hardhat task to seed contract with data #83

Conversation

knoll3 commented Oct 7, 2022 • edited Loading

Add hardhat task to seed data to contract

Config

Testing

sethhrbek Oct 9, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sethhrbek Oct 9, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sethhrbek commented Oct 10, 2022 • edited Loading

knoll3 commented Oct 7, 2022 •

edited

Loading

sethhrbek Oct 9, 2022 •

edited

Loading

sethhrbek Oct 9, 2022 •

edited

Loading

sethhrbek commented Oct 10, 2022 •

edited

Loading