Update README and package manifests

delvtech · Nov 19, 2024 · 1def3fd · 1def3fd
1 parent e372f73
commit 1def3fd
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 37 deletions.
diff --git a/.changeset/three-tips-invite.md b/.changeset/three-tips-invite.md
@@ -0,0 +1,7 @@
+---
+"@delvtech/drift-viem": patch
+"@delvtech/drift-web3": patch
+"@delvtech/drift": patch
+---
+
+Update package manifests, add `sinon` guidance to README
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ Building on Ethereum often means dealing with:
 
 Install Drift and an optional adapter for your preferred web3 library:
 
-```bash
+```sh
 npm install @delvtech/drift
 
 # Optional
@@ -337,6 +337,14 @@ Testing smart contract interactions can be complex and time-consuming. Drift
 simplifies this process by providing built-in mocks that allow you to stub
 responses and focus on testing your application logic.
 
+> [!IMPORTANT]
+> Drift's testing mocks have a peer dependency on `sinon`. Make sure to install
+> it before using the mocks.
+>
+> ```sh
+> npm install --save-dev sinon
+> ```
+
 #### Example: Testing Client Methods with Multiple RPC Calls
 
 Suppose you have a method `getAccountValue` in your `ReadVault` client that

diff --git a/packages/drift-viem/package.json b/packages/drift-viem/package.json
@@ -1,7 +1,8 @@
 {
   "name": "@delvtech/drift-viem",
+  "description": "Viem adapter for Drift",
   "version": "0.0.1-beta.15",
-  "license": "AGPL-3.0",
+  "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.cjs",
   "types": "dist/index.d.cts",
@@ -16,16 +17,6 @@
         "require": "./dist/index.cjs"
       }
     },
-    "./testing": {
-      "types": {
-        "import": "./dist/testing.d.ts",
-        "require": "./dist/testing.d.cts"
-      },
-      "default": {
-        "import": "./dist/testing.js",
-        "require": "./dist/testing.cjs"
-      }
-    },
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -59,7 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "files": [
-    "dist"
-  ]
+  "files": ["dist"]
 }
diff --git a/packages/drift-web3/package.json b/packages/drift-web3/package.json
@@ -2,7 +2,7 @@
   "name": "@delvtech/drift-web3",
   "description": "Web3.js adapter for Drift",
   "version": "0.0.0-beta.2",
-  "license": "AGPL-3.0",
+  "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.cjs",
   "types": "dist/index.d.cts",
@@ -17,16 +17,6 @@
         "require": "./dist/index.cjs"
       }
     },
-    "./testing": {
-      "types": {
-        "import": "./dist/testing.d.ts",
-        "require": "./dist/testing.d.cts"
-      },
-      "default": {
-        "import": "./dist/testing.js",
-        "require": "./dist/testing.cjs"
-      }
-    },
     "./package.json": "./package.json"
   },
   "scripts": {

diff --git a/packages/drift/README.md b/packages/drift/README.md
@@ -47,7 +47,7 @@ Building on Ethereum often means dealing with:
 
 Install Drift and an optional adapter for your preferred web3 library:
 
-```bash
+```sh
 npm install @delvtech/drift
 
 # Optional
@@ -337,6 +337,14 @@ Testing smart contract interactions can be complex and time-consuming. Drift
 simplifies this process by providing built-in mocks that allow you to stub
 responses and focus on testing your application logic.
 
+> [!IMPORTANT]
+> Drift's testing mocks have a peer dependency on `sinon`. Make sure to install
+> it before using the mocks.
+>
+> ```sh
+> npm install --save-dev sinon
+> ```
+
 #### Example: Testing Client Methods with Multiple RPC Calls
 
 Suppose you have a method `getAccountValue` in your `ReadVault` client that

diff --git a/packages/drift/package.json b/packages/drift/package.json
@@ -1,7 +1,8 @@
 {
   "name": "@delvtech/drift",
+  "description": "Effortless ethereum development across Web3 libraries",
   "version": "0.0.1-beta.13",
-  "license": "AGPL-3.0",
+  "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.cjs",
   "types": "dist/index.d.cts",
@@ -30,12 +31,8 @@
   },
   "typesVersions": {
     "*": {
-      ".": [
-        "./dist/index.d.ts"
-      ],
-      "testing": [
-        "./dist/testing.d.ts"
-      ]
+      ".": ["./dist/index.d.ts"],
+      "testing": ["./dist/testing.d.ts"]
     }
   },
   "scripts": {
@@ -82,7 +79,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "files": [
-    "dist"
-  ]
+  "files": ["dist"]
 }