boot script #429

frankiebee · 2024-11-05T08:18:56Z

This adds a sort of "boot script" to the dev dir. It will jump start and deploy and fund faucets
it also fixs a bug with registering where we were getting "stale" events for a previous registration attempt found while writing this script includes this doc add in the dev/README.md:

sdk "boot script"

For convince at ./deploy-faucets.mjs is a script we use to "deploy" and fund the faucets for our entropy network you can refer to this section and the script itself to deploy your own faucets! Here is it running with a dev environment setup from the root of this project:

dev/bin/spin-up.sh four-nodes

I would take a deep breath here to allow for the 4 nodes to connect before running the next command bellow. On that note the deploy faucet script takes 3 arguments as you can see right now this script assumes you know what your doing if you are running it. So not a lot of bells and whitelist here.

the first argument is the endpoint to target, the second is the fundingSeed and the third faucetLookUpSeed

node dev/deploy-facuets.mjs ws://127.0.0.1:9944 0x786ad0e2df456fe43dd1f91ebca22e235bc162e0bb8d53c633e8c85b2af68b7a 0x20423b5ff4984bcb8922483c98afb7eaa056c40fc431f8a314211e3d94a4222f

this example above should run in a dev enviroment the funding seed is eve and the report looks something like this and will log to your console:

{
  'jump start status at start': 'Ready',
  'using faucet program pointer': '0x3a1d45fecdee990925286ccce71f78693ff2bb27eae62adf8cfb7d3d61e142aa',
  'faucet program pointer from deployment': '0x3a1d45fecdee990925286ccce71f78693ff2bb27eae62adf8cfb7d3d61e142aa',
  'faucet config': {
    max_transfer_amount: 20000000000,
    genesis_hash: 'a4b29c6895ae775fd291377fde31882f66244eaecbdc81e017ebb64d13b27b72'
  },
  'initial balance for funding account': 99999880954644628n,
  'initial funding faucet amount': 24999970238661157n,
  'modifiableKeys on chain': [
    '0x03cd98af667e48b4912c66576f5cdf18aee3764c7aad1c40b9c61d5ac012acf1f6',
    '0x0228aba3e529d3b78b0cd7454a5f694eb09a648ec488b0b4b8ce7cd9abedd96c28',
    '0x03b7c87542f57895d37f1a37a3460e27ec74de7216e6ed48609ffd2fac976ea94a'
  ],
  'faucet look up address': '5EqZMUYz7jjaG2baQWJRzUzM7YhBP4E8TAj6GgqDqWdXriTn',
  faucets: [
    {
      vk: '0x03cd98af667e48b4912c66576f5cdf18aee3764c7aad1c40b9c61d5ac012acf1f6',
      address: '5Gm6JA2ikMK1FfNn3MRmUPLWfi4p6eBzcFtKE1dnJvQpJgpg',
      balance: '24,999,970,238,661,157'
    },
    {
      vk: '0x0228aba3e529d3b78b0cd7454a5f694eb09a648ec488b0b4b8ce7cd9abedd96c28',
      address: '5FqourMb6c3z4rogDnaBb36Ku53ndy3eCiSdjRg2TUAztJ3X',
      balance: '24,999,970,238,661,157'
    },
    {
      vk: '0x03b7c87542f57895d37f1a37a3460e27ec74de7216e6ed48609ffd2fac976ea94a',
      address: '5CUQuSMxTzx74Zb8gsDobhaYSte9vt9a3Db5X6oio4X1pSX1',
      balance: '24,999,970,238,661,157'
    }
  ],
  endpoint: 'ws://127.0.0.1:9944'
}

… breaks the get funtion

…amModAddress get the key back from tx rather then in events

dev/README.md

rh0delta · 2024-11-05T13:11:37Z

dev/README.md

+```
+I would take a deep breath here to allow for the 4 nodes to connect before running the next command bellow. On that note the deploy faucet script takes 3 arguments as you can see right now this script assumes you know what your doing if you are running it. So not a lot of bells and whitelist here.
+
+the first argument is the `endpoint` to target, the second is the `fundingSeed` and the third `faucetLookUpSeed` <!--yes seeds()! not mnemonic go play alone this script will never take a mnemonic maybe one day i'll make it preterite to use like asci fireworks or something else integrated with the cli-->


can't really decipher what youre trying to say here, so we can go through it when youre online

dev/README.md

rh0delta · 2024-11-05T13:14:15Z

dev/README.md

+    max_transfer_amount: 20000000000,
+    genesis_hash: 'a4b29c6895ae775fd291377fde31882f66244eaecbdc81e017ebb64d13b27b72'
+  },
+  'initial balance for funding account': 99999880954644628n,


are we able to update the report to show human readable numbers with commas and such?

or just an inline comment here saying what that unit is. This doesn't need to be super pretty, it's diagnostic

rh0delta · 2024-11-05T13:14:34Z

dev/README.md

+    genesis_hash: 'a4b29c6895ae775fd291377fde31882f66244eaecbdc81e017ebb64d13b27b72'
+  },
+  'initial balance for funding account': 99999880954644628n,
+  'initial funding faucet amount': 24999970238661157n,


same here, re: human readable numbers

rh0delta · 2024-11-05T14:06:44Z

dev/deploy-facuets.mjs

+if (!endpoint) throw new Error('please provide arguments for endpoint, fundingSeed, faucetLookUpSeed')
+if (!fundingSeed) throw new Error('please provide arguments for fundingSeed, faucetLookUpSeed')
+if (!faucetLookUpSeed) throw new Error('please provide arguments for faucetLookUpSeed')


Suggested change

if (!endpoint) throw new Error('please provide arguments for endpoint, fundingSeed, faucetLookUpSeed')

if (!fundingSeed) throw new Error('please provide arguments for fundingSeed, faucetLookUpSeed')

if (!faucetLookUpSeed) throw new Error('please provide arguments for faucetLookUpSeed')

if (!endpoint || !fundingSeed || !faucetLookUpSeed) throw new Error('endpoint, fundingSeed, and faucetLookupSeed are required arguments')

dev/deploy-facuets.mjs

Co-authored-by: Nayyir Jutha <nayyir.jutha@gmail.com>

dev/README.md

…when running the script and move reporter proxy to a reusable function in testing-utils.mjs

…frankie/boot-script

src/index.ts

mixmix · 2024-11-05T20:28:54Z

dev/faucet_program.wasm

🌶️ Trade offs!

this is a large file to include in repo / every CLI install?

might be needed if deploy-faucets.mjs is gonna be exported?

just double checking before we commit to this.... I wonder if this "deploy faucets" would be better in an optional stand-alone. It's likely too late for this release (no desire to rush), fine to kick that question down the road

i'm kicking down the road this one

mixmix · 2024-11-05T20:30:24Z

src/programs/dev.ts

@@ -78,7 +78,7 @@ export default class ProgramDev extends ExtrinsicBaseClass {
    const responseOption = await this.substrate.query.programs.programs(pointer)

    const programInfo = responseOption.toJSON()
-
+    if (programInfo === null) return null


🌶️ why would it ever be null ?
That feels more like it should throw an Error?

I see your test, seems reasonable. I was worried it might have further reaching implications.

This is "new/ fixed" behaviour => CHANGELOG

program info is null if the program doesn't exist, which is still a valid return type so i don;t believe it constitutes an error

it's null if it's not on chain

mixmix · 2024-11-05T21:04:50Z

src/registration/index.ts


-    await registrationTxResult
-    const verifyingKey = await dataFromEvents
+    const result = await registrationTxResult


Recommend: consolidate with above line, i.e.

const result = await this.sendAndWaitFor(registerTx, {

mixmix · 2024-11-05T21:06:51Z

src/registration/index.ts

-    const verifyingKey = await dataFromEvents
+    const result = await registrationTxResult
+    // @ts-ignore: not sure where the void is coming from
+    const verifyingKey = result.toHuman().event.data[1]


Something like this could more clearly document what's being pulled and why data[1]

Suggested change

const verifyingKey = result.toHuman().event.data[1]

const [ address, verifyingKey ] = result.toHuman().event.data

we don't use the address here, not sure if this is a valid updated for now

mixmix · 2024-11-05T21:09:53Z

dev/deploy-faucets.mjs

+const endpoint = process.argv[2]
+const fundingSeed = process.argv[3]
+const faucetLookUpSeed = process.argv[4]


Suggested change

const endpoint = process.argv[2]

const fundingSeed = process.argv[3]

const faucetLookUpSeed = process.argv[4]

const [_, __, endpoint, fundingSeed, faucetLookupSeed] = process.argv

not sure if this is a necessary improvement at this moment, we can clean up the code after the initial release, and just push out a minor patch

mixmix · 2024-11-05T21:12:02Z

dev/deploy-faucets.mjs

+if (!endpoint) throw new Error('please provide arguments for endpoint, fundingSeed, faucetLookUpSeed')
+if (!fundingSeed) throw new Error('please provide arguments for fundingSeed, faucetLookUpSeed')
+if (!faucetLookUpSeed) throw new Error('please provide arguments for faucetLookUpSeed')


move these into checkEndpoint functions etc

mixmix · 2024-11-05T21:14:50Z

dev/deploy-faucets.mjs

+  const jumpStartStatus = (await moneyBags.substrate.query.stakingExtension.jumpStartProgress()).toHuman().jumpStartStatus
+  report['jump start status at start'] = jumpStartStatus
+  // deploy faucet program to chain if not already up
+  if (jumpStartStatus === 'Ready') await jumpStartNetwork(moneyBags, true)


Break the steps up a bit more with space + comments?

Suggested change

const jumpStartStatus = (await moneyBags.substrate.query.stakingExtension.jumpStartProgress()).toHuman().jumpStartStatus

report['jump start status at start'] = jumpStartStatus

// deploy faucet program to chain if not already up

if (jumpStartStatus === 'Ready') await jumpStartNetwork(moneyBags, true)

// Jump Start

const jumpStartStatus = (await moneyBags.substrate.query.stakingExtension.jumpStartProgress()).toHuman().jumpStartStatus

report['jump start status at start'] = jumpStartStatus

if (jumpStartStatus === 'Ready') await jumpStartNetwork(moneyBags, true)

mixmix · 2024-11-05T21:18:17Z

dev/deploy-faucets.mjs

+    report['faucet program pointer from deployment'] = await moneyBags.programs.dev.deploy(faucetProgram, configurationSchema, auxDataSchema)
+  }
+  // transfer funds to faucet account "enough" to register (5 whole tokens)
+  await sendMoney(moneyBags, faucetRing.accounts.registration.address, BigInt(5 * 10 ** 10))


🔥
Do we have the 1e10 / 10**10 constant defined anywhere in this Repo
I'd like to see at least at top of file

const BITS_PER_TOKEN = 1e10

Suggested change

await sendMoney(moneyBags, faucetRing.accounts.registration.address, BigInt(5 * 10 ** 10))

await sendMoney(moneyBags, faucetRing.accounts.registration.address, BigInt(5 * BITS_PER_TOKEN))

This number should be related to the FAUCET_COUNT ??

mixmix · 2024-11-05T21:20:36Z

dev/deploy-faucets.mjs

+const faucetCount = 3
+// change me if you change the schemas!
+const pointer = '0x3a1d45fecdee990925286ccce71f78693ff2bb27eae62adf8cfb7d3d61e142aa'


style: I like these things as CONST so when I see them I know to look at top of file

Suggested change

const faucetCount = 3

// change me if you change the schemas!

const pointer = '0x3a1d45fecdee990925286ccce71f78693ff2bb27eae62adf8cfb7d3d61e142aa'

const FAUCET_COUNT = 3

// change me if you change the schemas!

const POINTER = '0x3a1d45fecdee990925286ccce71f78693ff2bb27eae62adf8cfb7d3d61e142aa'

i don't think style updates are needed right now to get this out the door, we can polish the boot script after the release sicne we don't really have that many devs that are going to be using the script at the moment

falls in category "important but not urgent" - if we align our code styles a little we get faster parsing + code reviews.

yes will do this my side so i can make sure it's every where

mixmix · 2024-11-05T21:29:15Z

dev/deploy-faucets.mjs

+  const modifiableKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)
+  report['modifiableKeys on chain'] = modifiableKeys.toHuman()


Suggested change

const modifiableKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)

report['modifiableKeys on chain'] = modifiableKeys.toHuman()

const verifiyingKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)

report['verifyingKeys on chain'] = verifyingKeys.toHuman()

// These should be the same as faucets.map(faucet => faucet['verification key'])

rh0delta · 2024-11-06T00:45:03Z

dev/fun-bucket.mjs

@@ -0,0 +1,20 @@
+const monkeys = ['🙉 - pandemonium', '🙈 - chaos', '🙊 - anarchy', '🐵 - entropy']


great addition

…frankie/boot-script

Co-authored-by: mix irving <mix@protozoa.nz>

mixmix

Looks good to me

frankiebee added 7 commits October 30, 2024 11:03

side mission fix: null return when a program does not exist no longer…

fb221b9

… breaks the get funtion

test non existant program

8d25ac7

wip: boot script for jump start and deploying faucets on a network

c9e1fac

registration parmas now matchs core language programDeployer -> progr…

e8e934f

…amModAddress get the key back from tx rather then in events

fix grabing data from result

4a49923

cleanup boot script reporting

037e6a0

nerding out about docs and time reporting

a8b74b6

frankiebee requested review from mixmix and rh0delta as code owners November 5, 2024 08:18

rh0delta suggested changes Nov 5, 2024

View reviewed changes

frankiebee and others added 3 commits November 5, 2024 07:52

Update dev/README.md

59f3d46

Co-authored-by: Nayyir Jutha <nayyir.jutha@gmail.com>

fix file spelling

260329c

Update dev/README.md

a8c7e04

Co-authored-by: Nayyir Jutha <nayyir.jutha@gmail.com>

mixmix reviewed Nov 5, 2024

View reviewed changes

dev/README.md Show resolved Hide resolved

frankiebee added 2 commits November 5, 2024 10:30

fix some formating; create a monkey amnimation so i dont loose focus …

d5bf9d8

…when running the script and move reporter proxy to a reusable function in testing-utils.mjs

Merge branch 'frankie/boot-script' of github.com:entropyxyz/sdk into …

496cd1c

…frankie/boot-script

mixmix suggested changes Nov 5, 2024

View reviewed changes

mixmix reviewed Nov 5, 2024

View reviewed changes

frankiebee added 3 commits November 5, 2024 12:20

time check steps and add more steps for the report

a99a16a

monkey animation!

7a67b1e

mokeys!

894754f

rh0delta reviewed Nov 6, 2024

View reviewed changes

rh0delta previously approved these changes Nov 6, 2024

View reviewed changes

rh0delta and others added 5 commits November 5, 2024 18:52

Merge branch 'main' into frankie/boot-script

cfed503

cleanup const names

8dbd2be

adjust CHANGELOG

c592b74

more changelog

6ed7fb9

Merge branch 'frankie/boot-script' of github.com:entropyxyz/sdk into …

38200b9

…frankie/boot-script

frankiebee dismissed rh0delta’s stale review via 38200b9 November 6, 2024 05:05

cleanup

7f08a3f

mix is the best

2ea1561

Co-authored-by: mix irving <mix@protozoa.nz>

mixmix approved these changes Nov 6, 2024

View reviewed changes

frankiebee mentioned this pull request Nov 6, 2024

break out dev dir to it's own repo and package #432

Open

frankiebee merged commit 5cfbb7c into main Nov 6, 2024
3 checks passed

frankiebee deleted the frankie/boot-script branch November 6, 2024 09:28

github-actions bot locked and limited conversation to collaborators Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

boot script #429

boot script #429

frankiebee commented Nov 5, 2024

rh0delta Nov 5, 2024

rh0delta Nov 5, 2024

mixmix Nov 5, 2024

rh0delta Nov 5, 2024

rh0delta Nov 5, 2024

mixmix Nov 5, 2024

frankiebee Nov 6, 2024

mixmix Nov 5, 2024

mixmix Nov 5, 2024

rh0delta Nov 6, 2024

frankiebee Nov 6, 2024

mixmix Nov 5, 2024

mixmix Nov 5, 2024

rh0delta Nov 6, 2024

mixmix Nov 5, 2024

rh0delta Nov 6, 2024

mixmix Nov 5, 2024

mixmix Nov 5, 2024

mixmix Nov 5, 2024 •

edited

Loading

mixmix Nov 5, 2024

frankiebee Nov 6, 2024

mixmix Nov 5, 2024

rh0delta Nov 6, 2024

mixmix Nov 6, 2024

frankiebee Nov 6, 2024

mixmix Nov 5, 2024

rh0delta Nov 6, 2024

mixmix left a comment

	const verifyingKey = result.toHuman().event.data[1]
	const [ address, verifyingKey ] = result.toHuman().event.data

	await sendMoney(moneyBags, faucetRing.accounts.registration.address, BigInt(5 * 10 ** 10))
	await sendMoney(moneyBags, faucetRing.accounts.registration.address, BigInt(5 * BITS_PER_TOKEN))

		const modifiableKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)
		report['modifiableKeys on chain'] = modifiableKeys.toHuman()

-  const modifiableKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)
-  report['modifiableKeys on chain'] = modifiableKeys.toHuman()
+  const verifiyingKeys = await moneyBags.substrate.query.registry.modifiableKeys(faucetRing.accounts.registration.address)
+  report['verifyingKeys on chain'] = verifyingKeys.toHuman()
+  // These should be the same as faucets.map(faucet => faucet['verification key'])

		@@ -0,0 +1,20 @@
		const monkeys = ['🙉 - pandemonium', '🙈 - chaos', '🙊 - anarchy', '🐵 - entropy']

boot script #429

boot script #429

Conversation

frankiebee commented Nov 5, 2024

sdk "boot script"

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

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

mixmix Nov 5, 2024 • 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

mixmix left a comment

Choose a reason for hiding this comment

mixmix Nov 5, 2024 •

edited

Loading