chore(deploy-script-support): Sync code patterns across files

[gibson042]

Description

• Rename parameters and variables for clarity
• Improve JSDoc annotation
• Fix package reference in comment
• Clarify script completion value as pseudo-exports
• Update assert(cond, X`...`) calls to cond || Fail`...`

best reviewed commit-by-commit

Security Considerations

This should be a pure refactor, and even preserves lack of a makeEnactCoreProposals binding in the script code generated by extractCoreProposalBundles.

Scaling Considerations

n/a

Documentation Considerations

n/a

Testing Considerations

No new tests should be required.

Upgrade Considerations

I don't think anything outside of agoric-sdk relies upon the parameter field names (which should be self-contained in generated script), but if so then we'll need to update or accommodate them.

[michaelfig]

Thanks for making this code clearer! My only comments are around the (granted, preexisting) use of IIFEs where assigning names may make the intent easier to understand.

I'll leave it to your discretion whether or how to address that.

[michaelfig]

Wow! I found this really tricky to understand, but eventually puzzled through it... I take it the IFFE default arguments are used just to create local bindings?

I'm not sure that's as clear as creating them at the top level. Would you be able to write a very clear explanation of what these lines are trying to do?

If it's too hard to render in English, I'd prefer something like:

Suggested change

	// Make an enactCoreProposals function and "export" it by way of script completion value.
	((
	makeCoreProposalBehavior = ${makeCoreProposalBehavior},
	makeEnactCoreProposals = ${makeEnactCoreProposals},
	) => makeEnactCoreProposals({ metadataRecords, E }))();
	const makeCoreProposalBehavior = ${makeCoreProposalBehavior};
	const makeEnactCoreProposals = ${makeEnactCoreProposals};
	// Make an enactCoreProposals function and "export" it by way of script completion value.
	const enactCoreProposals = makeEnactCoreProposals({ metadataRecords, E });
	enactCoreProposals;

[michaelfig]

Consider this for clarity, as well:

Suggested change

	// Make a behavior function and "export" it by way of script completion value.
	const behavior = (${makeCoreProposalBehavior})({ manifestBundleRef, getManifestCall, customManifest, E });
	behavior;
	const makeCoreProposalBehavior = ${makeCoreProposalBehavior};
	// Make a behavior function and "export" it by way of script completion value.
	const behavior = makeCoreProposalBehavior({ manifestBundleRef, getManifestCall, customManifest, E });
	behavior;