checkers-on-stacks 1.0.0

package/README.md

@@ -0,0 +1,37 @@
+# @stack-draft/checkers-sdk
+
+JavaScript/TypeScript SDK for interacting with the [Checkers on Stacks](https://github.com/devJaja/Stacks-Draft) smart contract on Stacks mainnet.
+
+## Install
+
+```bash
+npm install @stack-draft/checkers-sdk
+```
+
+## Usage
+
+```typescript
+import { CheckersSDK } from '@stack-draft/checkers-sdk';
+
+const sdk = new CheckersSDK();
+
+// Get game state
+const game = await sdk.getGame(0);
+console.log(game);
+// { isActive: true, player1: 'SP...', player2: 'SP...', currentTurn: 'SP...', winner: null }
+
+// Get full board (64-element array)
+const board = await sdk.getBoard(0);
+
+// Get piece at a specific position
+const piece = await sdk.getPiece(0, 17);
+// 0 = empty, 1 = p1, 2 = p1 king, 3 = p2, 4 = p2 king
+```
+
+## Contract
+
+Deployed on Stacks mainnet: `SP2DWWDVSSKZ5X37BBV3RV0GY0A0FFZZESYHEVQZ9.checkers`
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { StacksNetwork } from '@stacks/network';
+export declare const CONTRACT_ADDRESS = "SP2DWWDVSSKZ5X37BBV3RV0GY0A0FFZZESYHEVQZ9";
+export declare const CONTRACT_NAME = "checkers";
+export type PieceType = 0 | 1 | 2 | 3 | 4;
+export interface GameState {
+    isActive: boolean;
+    player1: string;
+    player2: string | null;
+    currentTurn: string;
+    winner: string | null;
+}
+export interface CheckersSDKOptions {
+    network?: StacksNetwork;
+    contractAddress?: string;
+    contractName?: string;
+}
+export declare class CheckersSDK {
+    private network;
+    private contractAddress;
+    private contractName;
+    constructor(options?: CheckersSDKOptions);
+    private readOnly;
+    /** Get game state by ID. Returns null if game does not exist. */
+    getGame(gameId: number): Promise<GameState | null>;
+    /** Get the piece type at a board position (0–63). */
+    getPiece(gameId: number, position: number): Promise<PieceType>;
+    /** Get the full 64-square board as an array of PieceType. */
+    getBoard(gameId: number): Promise<PieceType[]>;
+}
+export default CheckersSDK;

package/dist/index.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckersSDK = exports.CONTRACT_NAME = exports.CONTRACT_ADDRESS = void 0;
+const transactions_1 = require("@stacks/transactions");
+const network_1 = require("@stacks/network");
+exports.CONTRACT_ADDRESS = 'SP2DWWDVSSKZ5X37BBV3RV0GY0A0FFZZESYHEVQZ9';
+exports.CONTRACT_NAME = 'checkers';
+class CheckersSDK {
+    constructor(options = {}) {
+        var _a, _b, _c;
+        this.network = (_a = options.network) !== null && _a !== void 0 ? _a : new network_1.StacksMainnet();
+        this.contractAddress = (_b = options.contractAddress) !== null && _b !== void 0 ? _b : exports.CONTRACT_ADDRESS;
+        this.contractName = (_c = options.contractName) !== null && _c !== void 0 ? _c : exports.CONTRACT_NAME;
+    }
+    async readOnly(fn, args) {
+        return (0, transactions_1.callReadOnlyFunction)({
+            network: this.network,
+            contractAddress: this.contractAddress,
+            contractName: this.contractName,
+            functionName: fn,
+            functionArgs: args,
+            senderAddress: this.contractAddress,
+        });
+    }
+    /** Get game state by ID. Returns null if game does not exist. */
+    async getGame(gameId) {
+        var _a, _b, _c, _d;
+        const result = (0, transactions_1.cvToJSON)(await this.readOnly('get-game', [(0, transactions_1.uintCV)(gameId)]));
+        if (!result.value)
+            return null;
+        const v = result.value;
+        return {
+            isActive: v['is-active'].value,
+            player1: v['player1'].value,
+            player2: (_b = (_a = v['player2'].value) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null,
+            currentTurn: v['current-turn'].value,
+            winner: (_d = (_c = v['winner'].value) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : null,
+        };
+    }
+    /** Get the piece type at a board position (0–63). */
+    async getPiece(gameId, position) {
+        const result = (0, transactions_1.cvToJSON)(await this.readOnly('get-piece', [(0, transactions_1.uintCV)(gameId), (0, transactions_1.uintCV)(position)]));
+        return result.value;
+    }
+    /** Get the full 64-square board as an array of PieceType. */
+    async getBoard(gameId) {
+        const result = (0, transactions_1.cvToJSON)(await this.readOnly('get-board', [(0, transactions_1.uintCV)(gameId)]));
+        const board = Array(64).fill(0);
+        if (result.success && result.value) {
+            Object.keys(result.value).forEach((key) => {
+                const pos = parseInt(key.replace('p', ''));
+                const val = result.value[key];
+                board[pos] = (typeof val === 'object' ? val.value : val);
+            });
+        }
+        return board;
+    }
+}
+exports.CheckersSDK = CheckersSDK;
+exports.default = CheckersSDK;

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "checkers-on-stacks",
+  "version": "1.0.0",
+  "description": "JavaScript/TypeScript SDK for interacting with the Checkers on Stacks smart contract",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "stacks",
+    "blockchain",
+    "checkers",
+    "draughts",
+    "clarity",
+    "web3",
+    "bitcoin"
+  ],
+  "author": "devJaja",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devJaja/Stacks-Draft.git"
+  },
+  "homepage": "https://github.com/devJaja/Stacks-Draft#readme",
+  "peerDependencies": {
+    "@stacks/network": ">=6.0.0",
+    "@stacks/transactions": ">=6.0.0"
+  },
+  "devDependencies": {
+    "@stacks/network": "6.13.0",
+    "@stacks/transactions": "6.13.0",
+    "typescript": "5.4.5"
+  }
+}