@grumble-studios/rug-or-rumble 1.0.0

package/README.md

@@ -0,0 +1,69 @@
+# Rug or Rumble Contract ABIs
+
+This package contains the ABIs and TypeScript types for the Rug or Rumble smart contracts.
+
+## Installation
+
+```bash
+npm install @rug-or-rumble/contracts
+# or
+yarn add @rug-or-rumble/contracts
+# or
+pnpm add @rug-or-rumble/contracts
+```
+
+## Usage
+
+### Import all ABIs
+
+```typescript
+import { ABIs } from '@rug-or-rumble/contracts';
+
+console.log(ABIs.RugOrRumble); // Access the RugOrRumble ABI
+```
+
+### Import specific contract ABI
+
+```typescript
+import { RugOrRumbleABI } from '@rug-or-rumble/contracts';
+// or
+import RugOrRumble from '@rug-or-rumble/contracts/RugOrRumble';
+```
+
+### Use with ethers.js
+
+```typescript
+import { ethers } from 'ethers';
+import { RugOrRumbleABI } from '@rug-or-rumble/contracts';
+
+const contract = new ethers.Contract(
+  contractAddress,
+  RugOrRumbleABI,
+  signerOrProvider
+);
+```
+
+### Use with viem
+
+```typescript
+import { getContract } from 'viem';
+import { RugOrRumbleABI } from '@rug-or-rumble/contracts';
+
+const contract = getContract({
+  address: contractAddress,
+  abi: RugOrRumbleABI,
+  client: publicClient,
+});
+```
+
+## Available Contracts
+
+- RugOrRumble
+
+## TypeScript Support
+
+This package includes TypeScript type definitions for all ABIs.
+
+## License
+
+ISC

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@grumble-studios/rug-or-rumble",
+  "version": "1.0.0",
+  "description": "Smart contract ABIs and TypeScript types for Rug or Rumble game",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.js"
+    },
+    "./RugOrRumble": {
+      "types": "./src/RugOrRumble.d.ts",
+      "import": "./src/RugOrRumble.js",
+      "require": "./src/RugOrRumble.js"
+    }
+  },
+  "files": [
+    "src/**/*",
+    "README.md"
+  ],
+  "keywords": [
+    "grumble-studios",
+    "rug-or-rumble",
+    "smart-contract",
+    "abi",
+    "monad",
+    "blockchain",
+    "solidity"
+  ]
+}