@d9-network/ink 0.1.1 → 1.0.0

package/README.md

@@ -0,0 +1,82 @@
+# @d9-network/ink
+
+Type-safe SDK for interacting with ink! smart contracts on the D9 blockchain network.
+
+## Installation
+
+```bash
+npm install @d9-network/ink
+# or
+bun add @d9-network/ink
+# or
+pnpm add @d9-network/ink
+```
+
+## Quick Start
+
+```typescript
+import { createD9InkSdk } from "@d9-network/ink";
+import { usdt } from "@d9-network/spec"; // Contract descriptor
+
+// Create SDK instance
+const sdk = await createD9InkSdk({
+  endpoint: "wss://mainnet.d9network.com:40300",
+});
+
+// Create contract instance
+const contract = sdk.createContract(usdt, "cXYZ...contractAddress");
+
+// Query contract state
+const result = await contract.query("PSP22::balance_of", {
+  origin: "cXYZ...yourAddress",
+  args: { owner: "cXYZ...targetAddress" },
+});
+
+if (result.success) {
+  console.log("Balance:", result.value);
+}
+```
+
+## Features
+
+- **Type-safe contract interactions**: Full TypeScript inference for message parameters and return types
+- **Automatic gas estimation**: Dry-run execution before submitting transactions
+- **AccountId with D9 prefix**: All addresses automatically use D9 SS58 prefix (9)
+- **Event parsing**: Type-safe decoding of contract events
+- **Comprehensive error handling**: Detailed error types for debugging
+
+## API Overview
+
+### SDK Creation
+
+| Export                | Description                |
+| --------------------- | -------------------------- |
+| `createD9InkSdk`      | Create ink SDK instance    |
+| `createD9InkContract` | Create individual contract |
+
+### Encoding/Decoding
+
+| Export                     | Description                 |
+| -------------------------- | --------------------------- |
+| `encodeCall`               | Encode contract call        |
+| `decodeContractCallResult` | Decode contract call result |
+| `InkCodecs`                | Pre-defined SCALE codecs    |
+
+### Error Types
+
+| Export          | Description           |
+| --------------- | --------------------- |
+| `ContractError` | Base contract error   |
+| `DecodeError`   | Result decoding error |
+| `LangError`     | ink! language error   |
+| `NetworkError`  | RPC/WebSocket error   |
+
+## Documentation
+
+For complete documentation, examples, and API reference, visit:
+
+- [D9 SDK Documentation](https://docs.d9network.com/docs/sdk/ink/overview)
+
+## License
+
+MIT