@gnosis-guild/zodiac-core - npm Package Compare versions

Comparing version 1.1.0 to 2.0.0

dist/cjs/artifact/internal/etherscan.d.ts

@@ -31,3 +31,2 @@ /**
 }): Promise<{
-    ok: boolean;
     noop: boolean;
@@ -34,0 +33,0 @@ }>;

dist/cjs/artifact/internal/etherscan.js

@@ -35,3 +35,2 @@ "use strict";
         return {
-            ok: true,
             noop: true,
@@ -65,3 +64,2 @@ };
     return {
-        ok: true,
         noop: false,
@@ -90,7 +88,2 @@ };
     const { status, message, result } = (await response.json());
-    // SourceCode
-    // ContractName
-    // ABI
-    // CompilerVersion
-    // ConstructorArguments
     if (!isOk(status)) {
@@ -97,0 +90,0 @@ throw new Error(`Retrieve Error: ${status} ${message}`);

dist/cjs/index.d.ts

 import encodeDeployProxy from "./encoding/encodeDeployProxy";
 import predictProxyAddress from "./encoding/predictProxyAddress";
 import encodeDeploySingleton from "./encoding/encodeDeploySingleton";
-import deployFactories from "./deploy/deployFactories";
-import deployMastercopy from "./deploy/deployMastercopy";
-import deployProxy from "./deploy/deployProxy";
 import predictSingletonAddress from "./encoding/predictSingletonAddress";
+import deployFactories from "./tooling/deployFactories";
+import deployMastercopy from "./tooling/deployMastercopy";
+import deployProxy from "./tooling/deployProxy";
+import verifyMastercopy from "./tooling/verifyMastercopy";
+import readMastercopies from "./artifact/readMastercopies";
 import writeMastercopyFromBuild from "./artifact/writeMastercopyFromBuild";
 import writeMastercopyFromExplorer from "./artifact/writeMastercopyFromExplorer";
-import readMastercopy from "./artifact/readMastercopy";
-import deployAllMastercopies from "./artifact/deployAllMastercopies";
-import verifyAllMastercopies from "./artifact/verifyAllMastercopies";
-export { encodeDeploySingleton, predictSingletonAddress, encodeDeployProxy, predictProxyAddress, deployFactories, deployMastercopy, deployProxy, writeMastercopyFromBuild, writeMastercopyFromExplorer, readMastercopy, deployAllMastercopies, verifyAllMastercopies, };
+export { encodeDeploySingleton, predictSingletonAddress, encodeDeployProxy, predictProxyAddress, deployFactories, deployMastercopy, deployProxy, verifyMastercopy, readMastercopies, writeMastercopyFromBuild, writeMastercopyFromExplorer, };
 import type { EIP1193Provider } from "./types";
 export type { EIP1193Provider };

dist/cjs/index.js

@@ -6,4 +6,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyAllMastercopies = exports.deployAllMastercopies = exports.readMastercopy = exports.writeMastercopyFromExplorer = exports.writeMastercopyFromBuild = exports.deployProxy = exports.deployMastercopy = exports.deployFactories = exports.predictProxyAddress = exports.encodeDeployProxy = exports.predictSingletonAddress = exports.encodeDeploySingleton = void 0;
-// Core
+exports.writeMastercopyFromExplorer = exports.writeMastercopyFromBuild = exports.readMastercopies = exports.verifyMastercopy = exports.deployProxy = exports.deployMastercopy = exports.deployFactories = exports.predictProxyAddress = exports.encodeDeployProxy = exports.predictSingletonAddress = exports.encodeDeploySingleton = void 0;
+// encoding
 const encodeDeployProxy_1 = __importDefault(require("./encoding/encodeDeployProxy"));
@@ -15,11 +15,16 @@ exports.encodeDeployProxy = encodeDeployProxy_1.default;
 exports.encodeDeploySingleton = encodeDeploySingleton_1.default;
-// Tooling Scripts
-const deployFactories_1 = __importDefault(require("./deploy/deployFactories"));
+const predictSingletonAddress_1 = __importDefault(require("./encoding/predictSingletonAddress"));
+exports.predictSingletonAddress = predictSingletonAddress_1.default;
+// tooling
+const deployFactories_1 = __importDefault(require("./tooling/deployFactories"));
 exports.deployFactories = deployFactories_1.default;
-const deployMastercopy_1 = __importDefault(require("./deploy/deployMastercopy"));
+const deployMastercopy_1 = __importDefault(require("./tooling/deployMastercopy"));
 exports.deployMastercopy = deployMastercopy_1.default;
-const deployProxy_1 = __importDefault(require("./deploy/deployProxy"));
+const deployProxy_1 = __importDefault(require("./tooling/deployProxy"));
 exports.deployProxy = deployProxy_1.default;
-const predictSingletonAddress_1 = __importDefault(require("./encoding/predictSingletonAddress"));
-exports.predictSingletonAddress = predictSingletonAddress_1.default;
+const verifyMastercopy_1 = __importDefault(require("./tooling/verifyMastercopy"));
+exports.verifyMastercopy = verifyMastercopy_1.default;
+// artifact
+const readMastercopies_1 = __importDefault(require("./artifact/readMastercopies"));
+exports.readMastercopies = readMastercopies_1.default;
 const writeMastercopyFromBuild_1 = __importDefault(require("./artifact/writeMastercopyFromBuild"));
@@ -29,7 +34,1 @@ exports.writeMastercopyFromBuild = writeMastercopyFromBuild_1.default;
 exports.writeMastercopyFromExplorer = writeMastercopyFromExplorer_1.default;
-const readMastercopy_1 = __importDefault(require("./artifact/readMastercopy"));
-exports.readMastercopy = readMastercopy_1.default;
-const deployAllMastercopies_1 = __importDefault(require("./artifact/deployAllMastercopies"));
-exports.deployAllMastercopies = deployAllMastercopies_1.default;
-const verifyAllMastercopies_1 = __importDefault(require("./artifact/verifyAllMastercopies"));
-exports.verifyAllMastercopies = verifyAllMastercopies_1.default;

dist/esm/artifact/internal/etherscan.d.ts

@@ -31,3 +31,2 @@ /**
 }): Promise<{
-    ok: boolean;
     noop: boolean;
@@ -34,0 +33,0 @@ }>;

dist/esm/artifact/internal/etherscan.js

@@ -41,3 +41,2 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
             return {
-                ok: true,
                 noop: true,
@@ -71,3 +70,2 @@ };
         return {
-            ok: true,
             noop: false,
@@ -98,7 +96,2 @@ };
         const { status, message, result } = (yield response.json());
-        // SourceCode
-        // ContractName
-        // ABI
-        // CompilerVersion
-        // ConstructorArguments
         if (!isOk(status)) {
@@ -105,0 +98,0 @@ throw new Error(`Retrieve Error: ${status} ${message}`);

dist/esm/index.d.ts

 import encodeDeployProxy from "./encoding/encodeDeployProxy";
 import predictProxyAddress from "./encoding/predictProxyAddress";
 import encodeDeploySingleton from "./encoding/encodeDeploySingleton";
-import deployFactories from "./deploy/deployFactories";
-import deployMastercopy from "./deploy/deployMastercopy";
-import deployProxy from "./deploy/deployProxy";
 import predictSingletonAddress from "./encoding/predictSingletonAddress";
+import deployFactories from "./tooling/deployFactories";
+import deployMastercopy from "./tooling/deployMastercopy";
+import deployProxy from "./tooling/deployProxy";
+import verifyMastercopy from "./tooling/verifyMastercopy";
+import readMastercopies from "./artifact/readMastercopies";
 import writeMastercopyFromBuild from "./artifact/writeMastercopyFromBuild";
 import writeMastercopyFromExplorer from "./artifact/writeMastercopyFromExplorer";
-import readMastercopy from "./artifact/readMastercopy";
-import deployAllMastercopies from "./artifact/deployAllMastercopies";
-import verifyAllMastercopies from "./artifact/verifyAllMastercopies";
-export { encodeDeploySingleton, predictSingletonAddress, encodeDeployProxy, predictProxyAddress, deployFactories, deployMastercopy, deployProxy, writeMastercopyFromBuild, writeMastercopyFromExplorer, readMastercopy, deployAllMastercopies, verifyAllMastercopies, };
+export { encodeDeploySingleton, predictSingletonAddress, encodeDeployProxy, predictProxyAddress, deployFactories, deployMastercopy, deployProxy, verifyMastercopy, readMastercopies, writeMastercopyFromBuild, writeMastercopyFromExplorer, };
 import type { EIP1193Provider } from "./types";
 export type { EIP1193Provider };

dist/esm/index.js

@@ -1,15 +0,15 @@
-// Core
+// encoding
 import encodeDeployProxy from "./encoding/encodeDeployProxy";
 import predictProxyAddress from "./encoding/predictProxyAddress";
 import encodeDeploySingleton from "./encoding/encodeDeploySingleton";
-// Tooling Scripts
-import deployFactories from "./deploy/deployFactories";
-import deployMastercopy from "./deploy/deployMastercopy";
-import deployProxy from "./deploy/deployProxy";
 import predictSingletonAddress from "./encoding/predictSingletonAddress";
+// tooling
+import deployFactories from "./tooling/deployFactories";
+import deployMastercopy from "./tooling/deployMastercopy";
+import deployProxy from "./tooling/deployProxy";
+import verifyMastercopy from "./tooling/verifyMastercopy";
+// artifact
+import readMastercopies from "./artifact/readMastercopies";
 import writeMastercopyFromBuild from "./artifact/writeMastercopyFromBuild";
 import writeMastercopyFromExplorer from "./artifact/writeMastercopyFromExplorer";
-import readMastercopy from "./artifact/readMastercopy";
-import deployAllMastercopies from "./artifact/deployAllMastercopies";
-import verifyAllMastercopies from "./artifact/verifyAllMastercopies";
 export { 
@@ -19,4 +19,4 @@ // encoding
 // low-level tasks
-deployFactories, deployMastercopy, deployProxy, 
+deployFactories, deployMastercopy, deployProxy, verifyMastercopy, 
 // mastercopy artifact helpers
-writeMastercopyFromBuild, writeMastercopyFromExplorer, readMastercopy, deployAllMastercopies, verifyAllMastercopies, };
+readMastercopies, writeMastercopyFromBuild, writeMastercopyFromExplorer, };

package.json

 {
   "name": "@gnosis-guild/zodiac-core",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Zodiac is a composable design philosophy and collection of standards for building DAO ecosystem tooling.",
@@ -36,3 +36,3 @@ "author": "Auryn Macmillan <[e-mail]>",
     "prerelease": "yarn clean && yarn build",
-    "release": "yarn publish --access public"
+    "release": "yarn publish --access public --non-interactive"
   },
@@ -39,0 +39,0 @@ "directories": {

README.md

@@ -202,11 +202,11 @@ # Zodiac-Core
 
-#### `readMastercopy`
+#### `readMastercopies`
 
-Retrieves the Mastercopy artifact information from the artifacts file. This function is used to access stored data for a specific contract version or the latest available version if no version is specified.
+Retrieves a collection of Mastercopy artifacts from a JSON artifacts file. This function allows access to stored mastercopy data, with optional filters for contractName and contractVersion to refine the results. If no filters are provided, all artifacts are returned.
 
 **Inputs**
 
-• **`contractName`** - The name of the contract.
+• **`contractName`** - (Optional) The name of the contract.
 
-• **`contractVersion`** - (Optional) The version of the contract. If not provided, the latest version will be used.
+• **`contractVersion`** - (Optional) The version of the contract or "latest". If not provided, all versions will be retrieved.
 
@@ -216,3 +216,3 @@ • **`mastercopyArtifactsFile`** - (Optional) The path to the mastercopy artifacts file. Defaults to defaultMastercopyArtifactsFile().
 ```ts
-import { readMastercopy } from "@gnosis-guild/zodiac-core";
+import { readMastercopies } from "@gnosis-guild/zodiac-core";
 
@@ -224,40 +224,1 @@ const artifact = readMastercopy({
 ```
-
-`deployAllMastercopies`
-
-Deploys each Mastercopy listed in the artifacts file using the provided provider. If a Mastercopy is already deployed, it will be skipped.
-
-**Inputs**
-
-• **`provider`** - An EIP1193-compliant provider to interact with the blockchain.
-
-• **`mastercopyArtifactsFile`** - (Optional) The path to the mastercopy artifacts file. Defaults to defaultMastercopyArtifactsFile().
-
-```ts
-import { deployAllMastercopies } from "zodiac-core";
-
-await deployAllMastercopies({
-  provider, // an EIP1193 compliant provider
-});
-```
-
-#### `verifyAllMastercopies`
-
-Verifies each Mastercopy in the artifacts file on an Etherscan-compatible block explorer. This function ensures that the deployed contracts are properly verified and visible on public explorers.
-
-**Inputs**
-
-• **`apiUrlOrChainId`** - The API URL or Chain ID for the verification service.
-
-• **`apiKey`** - The API key used for verification.
-
-• **`mastercopyArtifactsFile`** - (Optional) The path to the mastercopy artifacts file. Defaults to `defaultMastercopyArtifactsFile()`.
-
-```ts
-import { verifyAllMastercopies } from "zodiac-core";
-
-await verifyAllMastercopies({
-  apiUrlOrChainId: "1", // or the explorer's API URL
-  apiKey: "YourEtherscanApiKey",
-});
-```

No alert changes

Improved metrics

Total package byte prevSize

264253

increased by1.27%

Lines of code

4024

increased by2.24%

Number of low supply chain risk alerts

12

decreased by-14.29%

Worsened metrics

Number of lines in readme file

222

decreased by-14.94%

No dependency changes