{"_id":"@cuonghx.ngen/cat-battle-evm-sdk","_rev":"1-d109d5f7989643f79597cc0514039b18","name":"@cuonghx.ngen/cat-battle-evm-sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@cuonghx.ngen/cat-battle-evm-sdk","version":"1.0.0","keywords":[],"author":{"name":"0xcuonghx"},"license":"ISC","_id":"@cuonghx.ngen/cat-battle-evm-sdk@1.0.0","maintainers":[{"name":"cuonghx.ngen","email":"cuonghx.ngen@gmail.com"}],"dist":{"shasum":"5e50dbc8ab9fc718224520c353535fed4c471168","tarball":"https://registry.npmjs.org/@cuonghx.ngen/cat-battle-evm-sdk/-/cat-battle-evm-sdk-1.0.0.tgz","fileCount":5,"integrity":"sha512-UFdPEoevzEjsck0GxQPtTQ+7pufRQQKTmvqwLfBeNgKc08RbqcbKVPNU7Y+yQM9DiWjK2Wrwb4U2fjBvhpQO8Q==","signatures":[{"sig":"MEUCIQD7OuqHnvWmv+e0IIX/cSpjD4EmiYFpiWPvU7WGLBK1WQIgZsAGO9IVM6MZ3i3eAmgM1fOdGBKGfFnibUHqq+et9gg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":231729},"main":"dist/index.js","gitHead":"a303017fc2e155929bb4eef9f8123b37b2c6083d","scripts":{"build":"webpack"},"_npmUser":{"name":"cuonghx.ngen","email":"cuonghx.ngen@gmail.com"},"_npmVersion":"10.7.0","directories":{},"_nodeVersion":"18.20.3","_hasShrinkwrap":false,"devDependencies":{"zod":"^3.23.8","viem":"^2.20.0","@wagmi/core":"^2.13.4"},"_npmOperationalInternal":{"tmp":"tmp/cat-battle-evm-sdk_1.0.0_1724383937661_0.25558561175130534","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@cuonghx.ngen/cat-battle-evm-sdk","version":"1.0.1","main":"dist/index.js","scripts":{"build":"webpack"},"keywords":[],"author":{"name":"0xcuonghx"},"license":"ISC","description":"## Features","devDependencies":{"@wagmi/core":"^2.13.4","viem":"^2.20.0","zod":"^3.23.8"},"dependencies":{"@wagmi/connectors":"^5.1.7"},"_id":"@cuonghx.ngen/cat-battle-evm-sdk@1.0.1","gitHead":"98edf32e5ee36ea481115c89427d501006a49f6b","_nodeVersion":"18.20.3","_npmVersion":"10.7.0","dist":{"integrity":"sha512-OtxrfzxokMKcY4NMlm+X4lk5Z8RJgoVxX26kQOBJULDS4+KuU5h/3TDWHDvlySs+nP3OsOCbbh+zxj330dgqkw==","shasum":"baec9a4c5a9e6ede3c483d8e2338bc4a4f10b39f","tarball":"https://registry.npmjs.org/@cuonghx.ngen/cat-battle-evm-sdk/-/cat-battle-evm-sdk-1.0.1.tgz","fileCount":8,"unpackedSize":1772983,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGalRrwwcG8/WJ366iDt9s5qbPDCAHltShYdT9/FlRtxAiA9bfN5wFhUqSf4hMPEhji5frfKd51zgu8+U1el9NCoCw=="}]},"_npmUser":{"name":"cuonghx.ngen","email":"cuonghx.ngen@gmail.com"},"directories":{},"maintainers":[{"name":"cuonghx.ngen","email":"cuonghx.ngen@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cat-battle-evm-sdk_1.0.1_1724658153726_0.49698842882963135"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-23T03:32:17.552Z","modified":"2024-08-26T07:42:34.153Z","1.0.0":"2024-08-23T03:32:17.841Z","1.0.1":"2024-08-26T07:42:33.963Z"},"author":{"name":"0xcuonghx"},"license":"ISC","keywords":[],"maintainers":[{"name":"cuonghx.ngen","email":"cuonghx.ngen@gmail.com"}],"readme":"# Cat Battle Ton SDK\n\n## Features\n\n- Support connect your app to injected wallet (e.g Metamask)\n- Support purchase item on cat-battle shop\n\n## Technique\n\n- @wagmi/core: VanillaJS library for Ethereum.\n\n# Getting Started\n\n## Install with CDN\n\n- Add the script to your HTML file:\n\n```html\n<script src=\"https://unpkg.com/@cuonghx.ngen/cat-battle-evm-sdk@latest\"></script>\n```\n\n- ℹ️ If you don't want auto-update the library, pass concrete version instead of latest, e.g.\n\n<script src=\"https://unpkg.com/@cuonghx.ngen/cat-battle-evm-sdk@1.0.0\"></script>\n\n- Add `load-sdk.js` scripts\n\n```html\n<script src=\"./load-sdk.js\"></script>\n```\n\n- Prepare `load-sdk.js` file\n\n```js\nconst plugin = new CatBattleEvmSdk.default({\n  shopAddress: \"CAT_BATTLE_SHOP_ADDRESS\", // should support same address all chains (create2)\n});\n```\n\n## Install with npm\n\n```shell\nnpm i @cuonghx.ngen/cat-battle-evm-sdk\n```\n\n# Usage\n\n- Using with Unity throw `jslib` plugin\n\n```jslib\nmergeInto(LibraryManager.library, {\n  Connect: function () {\n    plugin.connect();\n  },\n  Disconnect: function () {\n    plugin.disconnect();\n  },\n  IsConnected: function () {\n    return plugin.isConnected();\n  },\n  GetAccount: function () {\n    var returnStr = plugin.getAccount();\n    var bufferSize = lengthBytesUTF8(returnStr) + 1;\n    var buffer = _malloc(bufferSize);\n    stringToUTF8(returnStr, buffer, bufferSize);\n    return buffer;\n  },\n  PurchaseItem: async function (args) {\n    var returnStr = await plugin.purchaseItem(UTF8ToString(args));\n    var bufferSize = lengthBytesUTF8(returnStr) + 1;\n    var buffer = _malloc(bufferSize);\n    stringToUTF8(returnStr, buffer, bufferSize);\n    return buffer;\n  },\n});\n```\n\n| Function              | Description                           |\n| --------------------- | ------------------------------------- |\n| plugin.connect()      | Connect your app to web3 wallets      |\n| plugin.disconnect()   | Disconnect your app from web3 wallets |\n| plugin.isConnected()  | Return connected status               |\n| plugin.getAccount()   | Return account connected address      |\n| plugin.switchChain()  | Switch to supported chain             |\n| plugin.purchaseItem() | Purchase item on cat-battle shop      |\n| plugin.getBalance()   | Get balance of connected address      |\n\n## Examples\n\n- GetAccount\n\n```js\nplugin.getAccount();\n{\n  account: \"UQAbB+ykyJKBtL17EUxDOyL2H55aakn05uDVW06aH0wJNLJB\";\n  chain: \"BSC-TESTNET\"; // bsc-testnet or unknown\n}\n```\n\n- GetBalance\n\n```js\nplugin.getBalance();\n{\n  balance:\"240402714075310000\",\n  formatter:\"0.24040271407531\"\n}\n```\n\n- Purchase Item\n  - ℹ️ Switch correct chain before purchasing\n\n```js\nplugin.switchChain();\n```\n\n```js\nplugin.purchaseItem(\n  JSON.stringify({\n    id: <CAT_BATTLE_ITEM_ID>,\n    buyerId: <CAT_BATTLE_BUYER_ID>,\n    value: <CAT_BATTLE_ITEM_PRICE>,\n  })\n);\n```\n\n- Complete example via [Examples](./examples/)\n\n## Authors and acknowledgment\n\nCat Battle Team\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Project status\n\nWe are still developing this project following the roadmap in here: https://catb.io/\n","readmeFilename":"README.md","description":"## Features"}