{"_id":"@bnb-chain/zkbnb-js-l1-sdk","_rev":"5-0ec719f2863005bdae36cbf71d5974ef","name":"@bnb-chain/zkbnb-js-l1-sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bnb-chain/zkbnb-js-l1-sdk","version":"1.0.0","license":"MIT","_id":"@bnb-chain/zkbnb-js-l1-sdk@1.0.0","maintainers":[{"name":"robot-ux","email":"robot.ux@protonmail.com"}],"dist":{"shasum":"7aeefee872928208284658d04c2150799733cfdb","tarball":"https://registry.npmjs.org/@bnb-chain/zkbnb-js-l1-sdk/-/zkbnb-js-l1-sdk-1.0.0.tgz","fileCount":31,"integrity":"sha512-l2/WDUCFG5kBOh3+uxu4nAPvTbGcze2icjLXubOouso65kIJt5hnPjUVAmvHrcb0IYEjNToX4B73Pzilk+FxaA==","signatures":[{"sig":"MEUCIEII2600LChI8TEbN5+sAY8bXEQmuW0sLOpxknN7sZbqAiEAhJfo/roxbuQzPmleQBzfTpAmf9semjCbPp/OyJVpjho=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":126488,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkLE3ZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpxsBAAlgRNke5caXnDs0S+VGXFnqel/U6CiemncN9/+wvuIsRLWuDI\r\nPbpDGNAbCwFMlWF7CdEvWpMxRBe98JJ9SfEAJ9k2gvFWO8sLkQ3H2YQogn4C\r\n4qYeSFko99j5o7cOSCzWIMYddVK4GxO6DEfxTYtuj4fWDQkUytzVHYkixyJu\r\nJFXpFZIxpDZCOrbrrk2ljD1N3bz6m/7I2Lj5KOweTn6Z9o/0+ANj6JlI2M/7\r\n3JiT3WeG0pSdYI7Cr71I/TAt+Y2KlwM8Pm+CWbYv3WzeJr12VaWYDTBwsJ3Y\r\nuDijSpSzV/L/+QX9pnI6atrL4vIxXattyOanWdh91BSNzgPHCEUpVGBg3Egv\r\nOuCRGiKIJMoG8lu8YAok+Cj5udUU2RpN9PuDoGSwrDfW6Mbl38w/oxaLncao\r\nzKGvIFNZRwUbL9Q1yqqa32lza+/iLZ3p41zpOFWGa0mYiVfXJMw9B3STkfAp\r\nvRNiiUzN7iV7ozH9NBDUw9RZcBRtdyPFyTuWRRcgVR55mnpMoZx7qnckaWQb\r\nJBMt36tYTgfPV/Yzm+DnLx9KE5pWKRmpg5XO2h/vc3ZCNQkUlEyaEcAxfCnm\r\nGsJtwNoFRH+DNauM62agf+wnBsJw8esCENWnyOSnBO+ZzJmkhH8Br+kiMoKU\r\nah6Jnp9aawGWk6P3Di7nd3jP64te/IkBV9Q=\r\n=K8Z4\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"lint-staged"}},"types":"dist/index.d.ts","gitHead":"1e62341dbbb161707c8e87b18c1dfadb4dcd2d4c","scripts":{"lint":"npm run format && eslint  --ext .js,.ts --fix","test":"mocha -r ts-node/register tests/**/*.test.ts","build":"sh build.sh","watch":"tsc --watch","format":"prettier --write './**/*.{ts,js}'","pre-commit":"npm run lint","prepublish":"npm run build && rollup -c","semantic-release":"semantic-release"},"_npmUser":{"name":"robot-ux","email":"robot.ux@protonmail.com"},"_npmVersion":"8.19.4","description":"### Install","directories":{},"lint-staged":{"**/*.{js,jsx,ts,tsx}":["npm run lint"]},"_nodeVersion":"16.19.1","dependencies":{"axios":"^0.21.2"},"publishConfig":{"tag":"latest","access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^4.3.6","husky":"^8.0.1","mocha":"^10.0.0","dotenv":"^16.0.3","eslint":"^8.21.0","rimraf":"^4.4.1","rollup":"^2.79.1","ts-node":"^10.9.1","prettier":"^2.7.1","typescript":"^4.7.4","@types/chai":"^4.3.1","@types/node":"^14.14.5","lint-staged":"^13.0.3","@types/mocha":"^9.1.1","semantic-release":"^19.0.3","rollup-plugin-copy":"^3.4.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-terser":"^0.4.0","@semantic-release/git":"^10.0.1","eslint-plugin-prettier":"^4.2.1","@rollup/plugin-commonjs":"^22.0.1","@typescript-eslint/parser":"^5.32.0","@rollup/plugin-node-resolve":"^13.3.0","@semantic-release/changelog":"^6.0.1","@typescript-eslint/eslint-plugin":"^5.32.0"},"peerDependencies":{"ethers":"^5.7.2"},"_npmOperationalInternal":{"tmp":"tmp/zkbnb-js-l1-sdk_1.0.0_1680625113087_0.4491732646832667","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@bnb-chain/zkbnb-js-l1-sdk","version":"1.0.1","license":"MIT","_id":"@bnb-chain/zkbnb-js-l1-sdk@1.0.1","maintainers":[{"name":"robot-ux","email":"robot.ux@protonmail.com"}],"dist":{"shasum":"d30308d26b50e574f2ceac68c771a39f81cb21fc","tarball":"https://registry.npmjs.org/@bnb-chain/zkbnb-js-l1-sdk/-/zkbnb-js-l1-sdk-1.0.1.tgz","fileCount":31,"integrity":"sha512-VEBLNhs52Cb0jR9lcQZ4Ax09lj9NS+KnKFfCotKx0/FsX3/6shgGg3nL4TckZvQv73VpeYqBCPt1NBwe0EE+yA==","signatures":[{"sig":"MEYCIQCDCuSVQ1pVED7PD3+g6pBiO31M7AodHYix4HDBFOV6/AIhALLZuJJ5GnQ/Yghj4t3TdWLVskPS0FsXn4FYR2T4ITuu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":126465,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkL+9pACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpNmw/+N0T7HP8H6QFf5UszTY4mIe7+K4jeMa88M5SCq0jRLwpdno8U\r\n018ZFCwGjdSQztX9iBX7QxV835Zrp+TEqJQp1PYGUVOio0z5gf8mrlCMkauV\r\nx1xOApH29gRJsnAMnAvSq5kxu8K2Gkbk4N8AXiBbjUEDKXPUN1QKP+CCUrpJ\r\nmF+JBhNtm4ADiMMWQ6AQ3GuAB5SyT3u2biKV0H+0awuzddjDxq+olEEU0Yfs\r\ni6iu1TZGnA6nVaMddDwsKw/S1vzeOTIVaSHFR/mSqdp7x8sirD+Gmg2TTbJ2\r\nr9nC0cmZpCe287bikCCHdC5f3qkZy8eOrYuh3RlR1Ff2VOO4lRhOSW8xwIu0\r\nD1I4TeHaGOBV1SJ5h8zkvw/JCaqoiQC35NVzD4MyYQHm7qDnYzWIJ6xGnf8C\r\nmDx9h4+nBxfuW0Ya4qrzhNru8IfUWS2YM2JaQki507R/8u1wzU64yasnSORB\r\nFpRIOo8DO/uXyx6dIZsqv/1T2/FObAPjU3xbnGcjSN/jfzE82/K1NYxg5y3j\r\n82EGjBgA+kU875mDT7X0t25RSCsoAPBXBYjtOzy8NZTBdWJ7zK0dXYQC24wi\r\nN95y8OBWd1kxz/lPuxt7NZ5zPrfpe/GzwjzjqcAnDLIuOiGqdCHdxEd8jSF6\r\nPWbZuwzs4uQItYppQ/k6Y0DDQ+pgjeKJGVM=\r\n=Frsw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"lint-staged"}},"types":"dist/index.d.ts","gitHead":"c5614b92e42dbeee7c6a313a63f5bd8ebb949649","scripts":{"lint":"npm run format && eslint  --ext .js,.ts --fix","test":"mocha -r ts-node/register tests/**/*.test.ts","build":"sh build.sh","watch":"tsc --watch","format":"prettier --write './**/*.{ts,js}'","pre-commit":"npm run lint","prepublish":"npm run build && rollup -c","semantic-release":"semantic-release"},"_npmUser":{"name":"robot-ux","email":"robot.ux@protonmail.com"},"_npmVersion":"8.19.4","description":"### Install","directories":{},"lint-staged":{"**/*.{js,jsx,ts,tsx}":["npm run lint"]},"_nodeVersion":"16.20.0","dependencies":{"axios":"^0.21.2","ethers":"^5.7.2"},"publishConfig":{"tag":"latest","access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^4.3.6","husky":"^8.0.1","mocha":"^10.0.0","dotenv":"^16.0.3","eslint":"^8.21.0","rimraf":"^4.4.1","rollup":"^2.79.1","ts-node":"^10.9.1","prettier":"^2.7.1","typescript":"^4.7.4","@types/chai":"^4.3.1","@types/node":"^14.14.5","lint-staged":"^13.0.3","@types/mocha":"^9.1.1","semantic-release":"^19.0.3","rollup-plugin-copy":"^3.4.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-terser":"^0.4.0","@semantic-release/git":"^10.0.1","eslint-plugin-prettier":"^4.2.1","@rollup/plugin-commonjs":"^22.0.1","@typescript-eslint/parser":"^5.32.0","@rollup/plugin-node-resolve":"^13.3.0","@semantic-release/changelog":"^6.0.1","@typescript-eslint/eslint-plugin":"^5.32.0"},"_npmOperationalInternal":{"tmp":"tmp/zkbnb-js-l1-sdk_1.0.1_1680863081609_0.4276980139050255","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-04-04T16:18:32.984Z","modified":"2026-01-07T06:47:17.612Z","1.0.0":"2023-04-04T16:18:33.227Z","1.0.1":"2023-04-07T10:24:41.788Z"},"license":"MIT","description":"### Install","maintainers":[{"email":"robot.ux@protonmail.com","name":"robotnpm"},{"email":"devin@nodereal.io","name":"devinxiang"},{"email":"aiden.c@nodereal.io","name":"aiden-cao"},{"email":"yolin@bnbchain.org","name":"robotbnb"}],"readme":"## ZkBNB L1 Client\n\n### Install\n\nUsing npm:\n\n```bash\n> npm install @bnb-chain/zkbnb-js-l1-sdk\n```\n\nUsing yarn:\n\n```bash\n> yarn add @bnb-chain/zkbnb-js-l1-sdk\n```\n\nUsing pnpm:\n\n```bash\n> pnpm add @bnb-chain/zkbnb-js-l1-sdk\n```\n\n### Usage\n\n#### Init\n```typescript\nimport { Wallet, Provider, getZkBNBDefaultProvider } from '@bnb-chain/zkbnb-js-l1-sdk';\n\nconst rpcEndpoint = 'https://data-seed-prebsc-2-s1.binance.org:8545'; // bsc testnest rpc\nconst ethWallet = new ethers.Wallet(\n  'your private key',\n  new ethers.providers.JsonRpcProvider(rpcEndpoint)\n);\nconst provider = getZkBNBDefaultProvider('bscTestnet'); // bsc or bscTestnet\n// or by this method\n// const testEndpoint = 'https://testapi.zkbnbchain.org'; // bsc testnest\n// const provider = await Provider.newHttpProvider(testEndpoint);\nconst wallet = await Wallet.fromZkBNBSigner(ethWallet, provider);\n```\n\n#### Sign message\n```typescript\n// this is used sign message by \nconst result = await provider.ethMessageSigner().getEthMessageSignature(\"message\");\n```\n\n#### Get Current User Address\n```typescript\nconst address = provider.address();\n```\n\n#### Get Asset Address By Asset Id\n```typescript\nconst assetAddress = await wallet.resolveTokenAddress('asset id');\n```\n\n#### Get Asset Id By Asset Address\n```typescript\nconst assetId = await wallet.resolveTokenId('asset address');\n```\n\n#### Add Asset\n```typescript\nconst tokenAddress = 'BEP20 token address';\n// Before adding, it is recommended to check whether the asset exists and whether it can be added.\nawait wallet.addAsset({ tokenAddress });\n```\n\n#### Whether The BEP20 Token Is Approved For Deposit\n```typescript\nconst isApproved = await wallet.isBEP20DepositsApproved('BEP20 asset address');\n```\n\n#### Approve BEP20 Token For Deposit\n```typescript\nconst result = await wallet.approveBEP20TokenDeposits('BEP20 address');\n// You can check if it is successful approved by the following method\nconst isApproved = await wallet.isBEP20DepositsApproved(\"BEP20 address\");\n```\n\n#### Deposit BNB\n```typescript\nconst tokenAddress = await wallet.resolveTokenAddress(0);\nconst result = await wallet.deposit({\n  to: wallet.address(),\n  tokenAddress: \"0x0000000000000000000000000000000000000000\",\n  amount: ethers.utils.parseEther('0.001'),\n});\n```\n\n#### Deposit BEP20\nDeposit funds from the BSC to the zkBNB.\n\nTo do the BEP20 token transfer, this token transfer should be approved. User can make BEP20 deposits approved forever using approveBEP20TokenDeposits(\"token address\"), or the user can approve the exact amount (required for a deposit) upon each deposit using approveBEP20TokenDeposits(\"token address\", \"exact amount\"), but this is not recommended.\n```typescript\nconst result = await wallet.deposit({\n  to: wallet.address(),\n  tokenAddress: 'BEP20 Address',\n  amount: ethers.utils.parseEther('0.001'),\n});\n```\n\n#### Approve NFT For Deposit\n```typescript\nconst approveTx = await this.approveForAllERC721TokenDeposits('nft address');\n// You can check if it is successful approved by the following method\nconst isApproved = await this.isERC721DepositsApprovedForAll('nft address');\n\n```\n\n#### Deposit NFT\nDeposit NFT from BSC to zkBNB, Only supports the nft created by zkBNB.\n\nTo do the NFT transfer, this transfer should be approved by approveForAllERC721TokenDeposits(\"nft address\") once.\n\n```typescript\nconst depositResult = await wallet.depositNFT({\n    to: 'wallet address', // which address to deposit to\n    tokenAddress: 'nft address',\n    tokenId: 'nft ID',\n});\n```\n\n#### FullExit\nWithdraw BNB or BEP20 from zkBNB to BSC\n```typescript\nconst result = await wallet.requestFullExit({\n    tokenAddress: 'asset address',\n    accountIndex: 'account index',\n});\n```\n\n#### FullExit Nft\nWithdraw NFT from zkBNB to BSC\n```typescript\nconst requestResult = await wallet.requestFullExitNft({\n    tokenId: 'nft ID',\n    accountIndex: 'account index',\n});\n```\n\n#### Register A Dedicated NFT Contract For A Collection\n```typescript\nconst name = 'collection name';\nconst symbol = 'collection symbol';\nconst collectionId = 'collection Id';\nawait wallet.deployAndRegisterNFTFactory({\n    collectionId,\n    name,\n    symbol,\n});\n```\n\n#### Get NFT Address By Collection's Creator Address And Collection ID\n```typescript\nconst creatorAddress = 'collection creator\\'s wallet address';\nconst collectionId = 1;\n// if zero address is returned, it means a dedicated nft address can be bound\nconst nftAddress = await wallet.getNFTAddress(creatorAddress, collectionId);\n```\n\n#### Get NFT tokenURI\n```typescript\nconst nftContentType = 0; // 0-ipfs, 1-Greenfield\nconst nftContentHash = 'nft content hash';\nconst tokenURI = await wallet.getNftTokenURI(nftContentType, nftContentHash);\n```\n\n#### Get Pending Balance\n```typescript\n// Please change the value of the parameter according to the actual situation\nconst address = 'wallet address';\nconst assetAddress = 'asset address';\n\nconst pendingBalance = await wallet.getPendingBalance(address, assetAddress);\n```\n\n#### Get Token Balance On BSC\n```typescript\nconst pendingBalance = await wallet.getTokenBalance('asset address');\n```\n","readmeFilename":"README.md"}