{"_id":"@chakrachain/btc-settlement-sdk","_rev":"2-746ab4697ab4f3fdee0c17822dbab4ff","name":"@chakrachain/btc-settlement-sdk","dist-tags":{"latest":"1.0.0-beta.3","beta":"1.0.0-beta.2"},"versions":{"1.0.0-beta.1":{"name":"@chakrachain/btc-settlement-sdk","version":"1.0.0-beta.1","author":{"name":"zhaowei"},"license":"MIT","_id":"@chakrachain/btc-settlement-sdk@1.0.0-beta.1","maintainers":[{"name":"zhaowei_sc","email":"zw204801@163.com"}],"homepage":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk#readme","bugs":{"url":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk/issues"},"dist":{"shasum":"50cd0c2390fdf939170f5a11878db53971c16469","tarball":"https://registry.npmjs.org/@chakrachain/btc-settlement-sdk/-/btc-settlement-sdk-1.0.0-beta.1.tgz","fileCount":10,"integrity":"sha512-ViRqVvlVB9EnXPy+dXcPaY3UZwxLjqrwo6LtmDEF0dv3AkNt3OTMrwFDoDG3E7uLf++Ltxhc1lYjWKKXip1Xkw==","signatures":[{"sig":"MEUCIQD9eICt3t9TCfTD+taCyRbgqYCIzRHFqNcHXWFX7D1w7wIgWCRnDLZCVsu+2e6zi5hE6RTEEhIBFOKEG+gWC8f2D5A=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":211469},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"lint-staged"}},"types":"dist/index.d.ts","gitHead":"3cc1883437bc9eda722fcaafcb7a88b786262801","scripts":{"dev":"set NODE_ENV=developemnt&& rollup -c rollup.config.js -w","test":"jest","build":"rm -fr dist && set NODE_ENV=production&& rollup -c rollup.config.js"},"_npmUser":{"name":"zhaowei_sc","email":"zw204801@163.com"},"repository":{"url":"git+ssh://git@github.com/Generative-Labs/ChakraBTCSettlement-sdk.git","type":"git"},"_npmVersion":"10.2.4","description":"> A JavaScript sdk for chakra btc settlement script builder","directories":{},"lint-staged":{"*.{js,jsx}":["eslint --fix","git add"],"*.{ts,tsx}":["eslint --fix","git add"]},"_nodeVersion":"18.19.1","dependencies":{"bitcoinjs-lib":"^7.0.0-rc.0","@bitcoinerlab/secp256k1":"^1.1.1"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","husky":"3.0.9","eslint":"^8.30.0","rollup":"^2.67.2","ts-jest":"^29.2.5","typescript":"^5.6.3","@babel/core":"^7.18.9","@types/jest":"^29.5.14","@types/node":"20","lint-staged":"^11.2.6","@babel/preset-env":"^7.18.9","@rollup/plugin-babel":"^5.3.1","rollup-plugin-eslint":"^7.0.0","rollup-plugin-terser":"^7.0.2","rollup-plugin-commonjs":"^10.1.0","@typescript-eslint/parser":"^5.12.0","rollup-plugin-typescript2":"^0.31.2","@rollup/plugin-node-resolve":"^13.3.0","@typescript-eslint/eslint-plugin":"^5.13.0"},"_npmOperationalInternal":{"tmp":"tmp/btc-settlement-sdk_1.0.0-beta.1_1730272170280_0.27343095384873717","host":"s3://npm-registry-packages"}},"1.0.0-beta.2":{"name":"@chakrachain/btc-settlement-sdk","version":"1.0.0-beta.2","keywords":["btc","settlement"],"author":{"name":"zhaowei"},"license":"MIT","_id":"@chakrachain/btc-settlement-sdk@1.0.0-beta.2","maintainers":[{"name":"zhaowei_sc","email":"zw204801@163.com"}],"homepage":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk#readme","bugs":{"url":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk/issues"},"dist":{"shasum":"de723ef5144e2b65fcc75d109089567746129a2b","tarball":"https://registry.npmjs.org/@chakrachain/btc-settlement-sdk/-/btc-settlement-sdk-1.0.0-beta.2.tgz","fileCount":10,"integrity":"sha512-4I9cbboH4AmIB3XdgfqwAn4LGWlxv7ZRMR8Nguks6K0HT4szhyc6tEyDi9tbsCxVzSRlXSwlvmLLfpc/gtUKjg==","signatures":[{"sig":"MEYCIQCJc5eGj8E+9aONfoM05avv+GUQ6owc79qUvWp+1ommswIhAL6Avp2rdYFtgAJHX0tsKIgGAsnLqhZdGfnqr6T5HR2j","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":211518},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"lint-staged"}},"types":"dist/index.d.ts","gitHead":"3cc1883437bc9eda722fcaafcb7a88b786262801","scripts":{"dev":"set NODE_ENV=developemnt&& rollup -c rollup.config.js -w","test":"jest","build":"rm -fr dist && set NODE_ENV=production&& rollup -c rollup.config.js"},"_npmUser":{"name":"zhaowei_sc","email":"zw204801@163.com"},"repository":{"url":"git+ssh://git@github.com/Generative-Labs/ChakraBTCSettlement-sdk.git","type":"git"},"_npmVersion":"10.2.4","description":"> A JavaScript sdk for chakra btc settlement script builder","directories":{},"lint-staged":{"*.{js,jsx}":["eslint --fix","git add"],"*.{ts,tsx}":["eslint --fix","git add"]},"_nodeVersion":"18.19.1","dependencies":{"bitcoinjs-lib":"^7.0.0-rc.0","@bitcoinerlab/secp256k1":"^1.1.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^29.7.0","husky":"3.0.9","eslint":"^8.30.0","rollup":"^2.67.2","ts-jest":"^29.2.5","typescript":"^5.6.3","@babel/core":"^7.18.9","@types/jest":"^29.5.14","@types/node":"20","lint-staged":"^11.2.6","@babel/preset-env":"^7.18.9","@rollup/plugin-babel":"^5.3.1","rollup-plugin-eslint":"^7.0.0","rollup-plugin-terser":"^7.0.2","rollup-plugin-commonjs":"^10.1.0","@typescript-eslint/parser":"^5.12.0","rollup-plugin-typescript2":"^0.31.2","@rollup/plugin-node-resolve":"^13.3.0","@typescript-eslint/eslint-plugin":"^5.13.0"},"_npmOperationalInternal":{"tmp":"tmp/btc-settlement-sdk_1.0.0-beta.2_1730272878987_0.22234222127347358","host":"s3://npm-registry-packages"}},"1.0.0-beta.3":{"name":"@chakrachain/btc-settlement-sdk","version":"1.0.0-beta.3","main":"dist/index.js","repository":{"type":"git","url":"git+ssh://git@github.com/Generative-Labs/ChakraBTCSettlement-sdk.git"},"author":{"name":"zhaowei"},"keywords":["btc","settlement"],"scripts":{"test":"jest","dev":"set NODE_ENV=developemnt&& rollup -c rollup.config.js -w","build":"rm -fr dist && set NODE_ENV=production&& rollup -c rollup.config.js"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{ts,tsx}":["eslint --fix","git add"],"*.{js,jsx}":["eslint --fix","git add"]},"types":"dist/index.d.ts","license":"MIT","devDependencies":{"@babel/core":"^7.18.9","@babel/preset-env":"^7.18.9","@rollup/plugin-babel":"^5.3.1","@rollup/plugin-node-resolve":"^13.3.0","@types/jest":"^29.5.14","@types/node":"20","@typescript-eslint/eslint-plugin":"^5.13.0","@typescript-eslint/parser":"^5.12.0","eslint":"^8.30.0","husky":"3.0.9","jest":"^29.7.0","lint-staged":"^11.2.6","rollup":"^2.67.2","rollup-plugin-commonjs":"^10.1.0","rollup-plugin-eslint":"^7.0.0","rollup-plugin-terser":"^7.0.2","rollup-plugin-typescript2":"^0.31.2","ts-jest":"^29.2.5","typescript":"^5.6.3"},"dependencies":{"@bitcoinerlab/secp256k1":"^1.1.1","bitcoinjs-lib":"^7.0.0-rc.0"},"_id":"@chakrachain/btc-settlement-sdk@1.0.0-beta.3","gitHead":"3cc1883437bc9eda722fcaafcb7a88b786262801","description":"> A JavaScript sdk for chakra btc settlement script builder","bugs":{"url":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk/issues"},"homepage":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-J0mf+YrQm/4UfQpp+fqCQfqc/BCbfvft/WhpRDCRGRMqtxjR650Rctko8RcOzkbjgq4Mhl/YT6IaJ1u1pA70wg==","shasum":"ccb0c1264a1817fb59bf07515570fc13559bede6","tarball":"https://registry.npmjs.org/@chakrachain/btc-settlement-sdk/-/btc-settlement-sdk-1.0.0-beta.3.tgz","fileCount":10,"unpackedSize":211518,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD+2u/+XZXQXrURC3Tka92IAsj27Sdqv8Wor+nTinBOagIgCzmbe/tgIfKpcIW/e4S/hRbuKH4vhNCf8khjaAVfvlQ="}]},"_npmUser":{"name":"zhaowei_sc","email":"zw204801@163.com"},"directories":{},"maintainers":[{"name":"zhaowei_sc","email":"zw204801@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/btc-settlement-sdk_1.0.0-beta.3_1730272986793_0.2563055548321831"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-30T07:09:30.186Z","modified":"2024-10-30T07:23:07.228Z","1.0.0-beta.1":"2024-10-30T07:09:30.468Z","1.0.0-beta.2":"2024-10-30T07:21:19.134Z","1.0.0-beta.3":"2024-10-30T07:23:07.017Z"},"bugs":{"url":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk/issues"},"author":{"name":"zhaowei"},"license":"MIT","homepage":"https://github.com/Generative-Labs/ChakraBTCSettlement-sdk#readme","repository":{"type":"git","url":"git+ssh://git@github.com/Generative-Labs/ChakraBTCSettlement-sdk.git"},"description":"> A JavaScript sdk for chakra btc settlement script builder","maintainers":[{"name":"zhaowei_sc","email":"zw204801@163.com"}],"readme":"# Intro\n\n> A JavaScript sdk for chakra btc settlement script builder\n\n## Usage\n\n\n### Install\n\n```bash\nnpm install @chakrachain/btc-settlement-sdk\n```\n\nor\n\n```bash\nyarn add @chakrachain/btc-settlement-sdk\n```\n\n### Prerequisites\n\n:::tip\n\nBefore using the sdk, configure the supported projects and chains to [ChakraBTCSettlement-ProjectsConfig](https://github.com/Generative-Labs/ChakraBTCSettlement-ProjectsConfig)\n\n:::\n\n### buildTransferPsbt() :  build Psbt for chakra btc settlement\n\n#### Params :\n1. amount:`number`, Required field,  Amount to be settled.\n1. network: `string` Required field, sMainnet or signet.\n1. address:  `string` Required field, BTC wallet address,\n1. pubkey:  `string` Required field,  BTC wallet public key.\n1. targetChainReceiverAddress:  `string` Required field, Target address for settlement.\n1. targetChainId:  `string` Required field,   Target chainId for settlement, Please make sure the chainid is configured in the [chains.json](https://github.com/Generative-Labs/ChakraBTCSettlement-ProjectsConfig/blob/main/chains.json) first.\n1. projectName:  `string` Required field,  Settlement project name,  Please make sure the project is configured in the [projects.json](https://github.com/Generative-Labs/ChakraBTCSettlement-ProjectsConfig/blob/main/projects.json) first.\n1. feeRate:  `number` Required field,  Network fee rate.\n1. skipVault:  `boolean` Optional field,  Skip Vault Contract transfer to Stake Contracts\n\n#### Response : Promise: Psbt\n\n#### Usage Examples\n\n```tsx\nimport { useEffect } from \"react\";\n\n\nconst psbt = await buildTransferPsbt(\n    100000,\n    'mainnet', \n    'tb1*****', // YOUR BTC WALLET ADDRESS\n    '*****', // YOUR BTC WALLET PUBLIC KEY\n    \"0x1234567889\", // RECEIVER ADDRESS\n    '67', // RECEIVER CHAIN ID \n    \"Pendle\", // or  Lombard\n    300\n)\n```","readmeFilename":"README.md","keywords":["btc","settlement"]}