feat(entrykit): initial release (#3419)

Co-authored-by: alvarius <alvarius@lattice.xyz>

Author: frolic

.changeset/dirty-buttons-tickle.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/entrykit": patch
+---
+
+Initial, experimental release of EntryKit.

packages/common/src/deploy/ensureContract.ts

@@ -8,6 +8,7 @@ export type Contract = {
   bytecode: Hex;
   deployedBytecodeSize?: number;
   debugLabel?: string;
+  salt?: Hex;
 };
 
 export async function ensureContract({
@@ -16,6 +17,7 @@ export async function ensureContract({
   bytecode,
   deployedBytecodeSize,
   debugLabel = "contract",
+  salt = singletonSalt,
 }: {
   readonly client: Client<Transport, Chain | undefined, Account>;
   readonly deployerAddress: Hex;
@@ -24,7 +26,7 @@ export async function ensureContract({
     throw new Error(`Found unlinked public library in ${debugLabel} bytecode`);
   }
 
-  const address = getCreate2Address({ from: deployerAddress, salt: singletonSalt, bytecode });
+  const address = getCreate2Address({ from: deployerAddress, salt, bytecode });
 
   const contractCode = await getCode(client, { address, blockTag: "pending" });
   if (contractCode) {
@@ -50,7 +52,7 @@ export async function ensureContract({
     await sendTransaction(client, {
       chain: client.chain ?? null,
       to: deployerAddress,
-      data: concatHex([singletonSalt, bytecode]),
+      data: concatHex([salt, bytecode]),
     }),
   ];
 }

packages/common/src/deploy/getContractAddress.ts

@@ -4,9 +4,11 @@ import { singletonSalt } from "./common";
 export function getContractAddress({
   deployerAddress,
   bytecode,
+  salt = singletonSalt,
 }: {
   readonly deployerAddress: Hex;
   readonly bytecode: Hex;
+  readonly salt?: Hex;
 }): Hex {
-  return getCreate2Address({ from: deployerAddress, bytecode, salt: singletonSalt });
+  return getCreate2Address({ from: deployerAddress, bytecode, salt });
 }

packages/common/src/utils/uniqueBy.ts

@@ -1,7 +1,10 @@
 export function uniqueBy<value, key>(values: readonly value[], getKey: (value: value) => key): readonly value[] {
   const map = new Map<key, value>();
   for (const value of values) {
-    map.set(getKey(value), value);
+    const key = getKey(value);
+    if (!map.has(key)) {
+      map.set(key, value);
+    }
   }
   return Array.from(map.values());
 }

packages/common/src/waitForTransactions.ts

@@ -9,7 +9,7 @@ export async function waitForTransactions({
 }: {
   readonly client: Client<Transport, Chain | undefined, Account>;
   readonly hashes: readonly Hex[];
-  readonly debugLabel: string;
+  readonly debugLabel?: string;
 }): Promise<void> {
   if (!hashes.length) return;
 

packages/entrykit/.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["../../.eslintrc", "plugin:react/recommended", "plugin:react-hooks/recommended"],
+  "plugins": ["react", "react-hooks"],
+  "rules": {
+    "react/react-in-jsx-scope": "off"
+  }
+}

packages/entrykit/README.md

@@ -0,0 +1,13 @@
+# EntryKit
+
+UI kit to streamline signing in to MUD apps.
+
+## Installation
+
+```
+npm install @latticexyz/entrykit
+```
+
+## Usage
+
+TODO

packages/entrykit/bin/deploy-local-prereqs.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// workaround for https://github.com/pnpm/pnpm/issues/1801
+import "../dist/tsup/bin/deploy-local-prereqs.js";

packages/entrykit/inline-import.d.ts

@@ -0,0 +1,4 @@
+declare module "*?inline" {
+  const content: string;
+  export default content;
+}

packages/entrykit/mprocs.deploy.yaml

@@ -0,0 +1,29 @@
+scrollback: 10000
+procs:
+  anvil:
+    shell: anvil --dump-state playground/anvil-state.json
+
+  deploy-prereqs:
+    shell: ./bin/deploy-local-prereqs.js
+    env:
+      DEBUG: "mud:*"
+      # Anvil default account (0x70997970C51812dc3A010C7d01b50e0d17dc79C8)
+      PRIVATE_KEY: "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d"
+
+  # deploy-quarry-paymaster:
+  #   cwd: ../../../quarry-paymaster/packages/contracts
+  #   shell: pnpm mud deploy --salt 0x && pnpm fund:paymaster:local && pnpm fund:issuer:local
+  #   env:
+  #     DEBUG: "mud:*"
+
+  deploy-game:
+    cwd: ../../test/mock-game-contracts
+    shell: pnpm deploy:local --salt 0x
+    env:
+      DEBUG: "mud:*"
+      # Anvil default account (0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc)
+      PRIVATE_KEY: "0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba"
+
+  # deploy-bundler:
+  #   cwd: ../../../alto
+  #   shell: pnpm ts-node scripts/localDeployer/index.ts