sui-easy-sdk 0.0.1 → 0.0.5

package/README.md

@@ -5,49 +5,50 @@ Designed to solve common developer pain points: pagination, name resolution, arg
 
 ## Installation
 
-\`\`\`bash
+```bash
 npm install sui-easy-sdk @mysten/sui @mysten/bcs
-\`\`\`
-
+```
+<!-- 
+<!-- 
 ## Publishing to NPM
 
 1.  Build the project:
-    \`\`\`bash
+    ```bash
     npm run build
-    \`\`\`
+    ```
 2.  Login to NPM:
-    \`\`\`bash
+    ```bash
     npm login
-    \`\`\`
+    ```
 3.  Publish:
     -   **If you have 2FA enabled (likely):**
-        \`\`\`bash
+        ```bash
         npm publish --access public --otp=YOUR_OTP_CODE
-        \`\`\`
+        ```
     -   Otherwise:
-        \`\`\`bash
+        ```bash
         npm publish --access public
-        \`\`\`
+        ``` --> -->
 
 ## Core Features
 
 ### 1. Universal Naming
 **Every method** that accepts an address also accepts a `.sui` name.
-\`\`\`typescript
+```typescript
 const objects = await client.getAllOwnedObjects('demo.sui');
-\`\`\`
+```
 
 ### 2. Auto-Pagination
 Never write a `while(hasNextPage)` loop again.
-\`\`\`typescript
+```typescript
 const allCoins = await CoinUtils.selectCoins(client, 'demo.sui', 500n, '0x...::type', 'all');
-\`\`\`
+```
 
 ### 3. Fluent Transaction Builder
 Auto-wraps `number` -> `u64`, `string` -> `Pure` or `Object`, performs async name resolution.
-\`\`\`typescript
+```typescript
 await builder.moveCallWithResolving(client, 'pkg::mod::fn', ['friend.sui', 100]);
-\`\`\`
+```
 
 ---
 
@@ -104,6 +105,8 @@ Wraps `Transaction`.
 -   `vectorU8ToString(bytes)`: Decodes bytes.
 -   `toHex(bytes)`, `fromHex(str)`: Hex utils.
 -   `normalizeAddress(addr)`: 0x-padding.
+-   `formatAddress(addr)`: Truncates for display (e.g. `0x12...34`).
+-   `isValidStructTag(str)`: Validates struct format.
 
 ---
 
@@ -112,9 +115,9 @@ Wraps `Transaction`.
 ### Buying an NFT with Kiosk and Names
 See `examples/showcase.ts` for the full code.
 
-\`\`\`typescript
+```typescript
 const { selectedCoins } = await CoinUtils.selectCoins(client, 'buyer.sui', price);
 const [payment] = CoinUtils.createCoinInput(builder.tx, selectedCoins, price, SUI_TYPE);
 
 await builder.moveCallWithResolving(client, 'mkt::buy', ['kiosk.sui', payment]);
-\`\`\`
+```

package/dist/coin-utils.js

@@ -23,7 +23,7 @@ class CoinUtils {
         }
         let hasNextPage = true;
         let nextCursor = null;
-        let allCoins = [];
+        const allCoins = [];
         // 1. Fetch ALL coins (or until safe limit)
         // In production, might want to limit this loop if user has 10k coins
         while (hasNextPage) {

package/dist/display.js

@@ -47,7 +47,7 @@ class ObjectDisplayUtils {
     static resolveImageUrl(display) {
         if (!display)
             return null;
-        let url = display.image_url || display.img_url || display.url;
+        const url = display.image_url || display.img_url || display.url;
         if (!url)
             return null;
         if (url.startsWith('ipfs://')) {

package/dist/utils.d.ts

@@ -32,4 +32,15 @@ export declare class DataUtils {
      * Converts Base64 to bytes.
      */
     static fromBase64(b64: string): Uint8Array;
+    /**
+     * Formats an address for display (e.g. 0x1234...5678).
+     * @param addr The address to format
+     * @param startChars Number of characters to keep at start (default 6)
+     * @param endChars Number of characters to keep at end (default 4)
+     */
+    static formatAddress(addr: string, startChars?: number, endChars?: number): string;
+    /**
+     * Checks if a string looks like a valid Struct Tag (pkg::mod::type).
+     */
+    static isValidStructTag(tag: string): boolean;
 }

package/dist/utils.js

@@ -54,5 +54,23 @@ class DataUtils {
     static fromBase64(b64) {
         return (0, bcs_1.fromB64)(b64);
     }
+    /**
+     * Formats an address for display (e.g. 0x1234...5678).
+     * @param addr The address to format
+     * @param startChars Number of characters to keep at start (default 6)
+     * @param endChars Number of characters to keep at end (default 4)
+     */
+    static formatAddress(addr, startChars = 6, endChars = 4) {
+        if (!addr || addr.length <= startChars + endChars)
+            return addr;
+        return `${addr.slice(0, startChars)}...${addr.slice(-endChars)}`;
+    }
+    /**
+     * Checks if a string looks like a valid Struct Tag (pkg::mod::type).
+     */
+    static isValidStructTag(tag) {
+        // Basic regex for 0x...::module::Type
+        return /^0x[a-fA-F0-9]+::\w+::\w+/.test(tag);
+    }
 }
 exports.DataUtils = DataUtils;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sui-easy-sdk",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "A developer-friendly SDK for SUI blockchain interactions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,13 +24,17 @@
   "author": "dotandev",
   "license": "MIT",
   "dependencies": {
-    "@mysten/sui": "^1.21.1",
-    "@mysten/bcs": "^1.1.0"
+    "@mysten/bcs": "^1.1.0",
+    "@mysten/sui": "^1.21.1"
   },
   "devDependencies": {
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.4",
+    "@eslint/js": "^9.39.2",
     "@types/node": "^22.10.7",
-    "ts-node": "^10.9.2"
+    "eslint": "^9.39.2",
+    "globals": "^17.1.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.53.1",
+    "vitest": "^3.0.4"
   }
-}
+}