alberta-buck-contracts 0.1.0

package/deployments.json

@@ -0,0 +1 @@
+{}

package/index.d.ts

@@ -0,0 +1,22 @@
+export interface Artifact {
+  abi: object[];
+  bytecode: string;
+  deployedBytecode: string;
+}
+
+export interface Compiler {
+  solc: string;
+  viaIR: boolean;
+  optimizer: { enabled?: boolean; runs?: number };
+  evmVersion: string;
+  commit: string;
+  sha256: string;
+  /** Third-party contracts a BUCK world also needs, and the package to get them from. */
+  external: Record<string, string>;
+}
+
+export declare const contracts: Record<string, Artifact>;
+export declare const compiler: Compiler;
+export declare const deployments: Record<string, Record<string, string>>;
+export declare function artifact(name: string): Artifact;
+export default contracts;

package/index.mjs

@@ -0,0 +1,43 @@
+// alberta-buck-contracts -- compiled ABI + bytecode for the Alberta Buck
+// contracts, for any EVM: anvil, Tevm in a browser, a testnet.
+//
+// Nothing here is deployed at a fixed address.  Every BUCK world deploys
+// fresh and learns its addresses from the receipts, so what this package
+// ships is (abi, bytecode) pairs -- not a deployment registry.  The
+// deployments export exists so that publishing real addresses later is not
+// a breaking change to the package's shape.
+
+import contractsJson from "./contracts.json" with { type: "json" };
+import compilerJson from "./compiler.json" with { type: "json" };
+import deploymentsJson from "./deployments.json" with { type: "json" };
+
+/** Every published contract, keyed by name: { abi, bytecode, deployedBytecode }. */
+export const contracts = contractsJson.contracts;
+
+/** Build provenance: solc version, optimizer settings, git commit, bundle sha256. */
+export const compiler = compilerJson;
+
+/** Known deployments by chain id.  Empty: BUCK worlds deploy their own. */
+export const deployments = deploymentsJson;
+
+/**
+ * One contract's artifact, by name.
+ * @param {string} name e.g. "Buck", "BuckCredit", "IdentityRegistry"
+ * @returns {{abi: object[], bytecode: string, deployedBytecode: string}}
+ */
+export function artifact(name) {
+  const a = contracts[name];
+  if (!a) {
+    const known = Object.keys(contracts).join(", ");
+    const external = compilerJson.external?.[name];
+    if (external) {
+      throw new Error(
+        `${name} is not published here -- it is a third-party contract. ` +
+        `Install ${external} and take it from there.`);
+    }
+    throw new Error(`unknown contract ${name}; this package ships: ${known}`);
+  }
+  return a;
+}
+
+export default contracts;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "alberta-buck-contracts",
+  "version": "0.1.0",
+  "description": "Compiled ABI and bytecode for the Alberta Buck contracts (unaudited prototype): the BUCK token, BuckCredit, the BUCK_K controller, the identity registry and the baskets, built with a pinned compiler",
+  "type": "module",
+  "license": "GPL-3.0-or-later",
+  "author": "Perry Kundert <perry@dominionrnd.com>",
+  "homepage": "https://github.com/alberta-buck/alberta-buck",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alberta-buck/alberta-buck.git",
+    "directory": "core/contracts"
+  },
+  "bugs": "https://github.com/alberta-buck/alberta-buck/issues",
+  "keywords": [
+    "ethereum",
+    "solidity",
+    "abi",
+    "stablecoin",
+    "artifacts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "//files": "contracts.json and compiler.json are generated by scripts/contracts-dist.py and therefore gitignored; npm falls back to .gitignore without an .npmignore, so they must be listed here or the tarball ships no bytecode.",
+  "files": [
+    "index.mjs",
+    "index.d.ts",
+    "contracts.json",
+    "compiler.json",
+    "deployments.json",
+    "README.md"
+  ],
+  "main": "./index.mjs",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": "./index.mjs",
+    "./contracts.json": "./contracts.json",
+    "./compiler.json": "./compiler.json",
+    "./deployments.json": "./deployments.json",
+    "./package.json": "./package.json"
+  }
+}