{"_id":"@across-protocol/boba-sdk","_rev":"5-8c9eecc2c05827b15deb1ea8bdac29cf","name":"@across-protocol/boba-sdk","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.1":{"name":"@across-protocol/boba-sdk","version":"1.0.1","keywords":["optimism","ethereum","sdk"],"author":{"name":"Optimism PBC"},"license":"MIT","_id":"@across-protocol/boba-sdk@1.0.1","maintainers":[{"name":"nicholaspai","email":"npai.nyc@gmail.com"},{"name":"daywiss","email":"daywiss@gmail.com"},{"name":"evaldofelipe","email":"contact@evaldofelipe.com"},{"name":"chrismaree","email":"christopher.maree@gmail.com"},{"name":"mrice32","email":"matthewcrice32@gmail.com"}],"homepage":"https://github.com/across-protocol/boba/tree/develop/packages/sdk#readme","bugs":{"url":"https://github.com/across-protocol/boba/issues"},"dist":{"shasum":"e52230ce1d1cddb2cb23db5b83f16b15da315dc8","tarball":"https://registry.npmjs.org/@across-protocol/boba-sdk/-/boba-sdk-1.0.1.tgz","fileCount":63,"integrity":"sha512-nhbRui44KyRA/WFPDXVselAJsmOSwftFtK0wdc6z7h/Woe1I/NQ91YnC06MXggJt54ReD6bOiyIoqDNSQ0yRQQ==","signatures":[{"sig":"MEYCIQD2WnCAa/SGz4LDJRKPnFVQfeHwyAwy+gy3lFozPMrgpAIhAMhAEat4PIjj9LeZauIzxN3+AcGq/6e/YHC0qpj/q/4E","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178433,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj8VITACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr88Q//XV1c/vEEeOHlNMH5rhNA0dPfCzrUryDf2AWrlAySia5ILaet\r\nWbDgZR0ZtUvmr2hTzkLKXQu9BbIlnxTvD53SMxJRq5096FaAVnwqEAqWDhbF\r\nSWTMBCRB0GtvYv5PVg/Kt32CwjrDxI3nPw7PAowVRF9icRDNKoNq5JFaq5Y+\r\ncVqRCYCGBrNjtDVDapKQPZX8wmigVtrQH4KQdDQH7hGpvN7fURqvjMB7x6Hg\r\nFuD+qDtpQNAc0NN5a9xjiXJkL7GqaMJq+qMNDk6Mnx8Lp8XwTxW0dmpzCbUM\r\n98oHe6Kt98gH67d/6xBtfsZBrgcQcihdqcU+Zr+1eNu+TBKUBZGuWh7LUmOx\r\nE5a59pTXEjEWIeq8Gk0cWUMdGpgVim/6HjMoY//SYnbyJQzSQ3rhDtbLupoP\r\nfJ219C2AORVTfD+zBW4n1s9+3kaVhkEy2AVqKIGuGhHqw58FR3qPRnYeGoWp\r\nO09QIKuHwbYBlanh+ZLGoWNDmiSfopho3M5QPvsm7/bL217U7WALW4Ogo2m6\r\nudUq23uwxczUq2vUeKKYtkoNVQgRTUKS6Xwe/XzG7/mAJ8prrzQ6aJnfpfqJ\r\npSASY5DY40b809ihooaouNimYR4MK3wUnaHNZ8SMhmuMjyZTTBZS35CEImbc\r\nLY4muN6zagwqRfBUjtT5KqF/0iCZNhnDYNk=\r\n=4ogi\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index","types":"dist/index","gitHead":"42c2a5993d21129b6f2a8c5941b2f3d70b424209","scripts":{"all":"yarn clean && yarn build && yarn test && yarn lint:fix && yarn lint","lint":"yarn lint:fix && yarn lint:check","test":"hardhat test","build":"tsc -p tsconfig.json","clean":"rimraf dist/ ./tsconfig.tsbuildinfo","lint:fix":"yarn lint:check --fix","lint:check":"eslint . --max-warnings=0","pre-commit":"lint-staged","autogen:docs":"typedoc --out docs src/index.ts","test:coverage":"nyc hardhat test && nyc merge .nyc_output coverage.json"},"_npmUser":{"name":"nicholaspai","email":"npai.nyc@gmail.com"},"repository":{"url":"git+https://github.com/across-protocol/boba.git","type":"git"},"_npmVersion":"8.11.0","description":"[Optimism-Fork] Tools for working with Optimism","directories":{},"_nodeVersion":"16.15.1","dependencies":{"rlp":"^2.2.7","lodash":"^4.17.21","merkletreejs":"^0.2.27","@eth-optimism/contracts":"0.5.11","@eth-optimism/core-utils":"0.8.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.com/"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","chai":"^4.3.4","mocha":"^10.0.0","ethers":"^5.7.0","hardhat":"^2.12.5","typedoc":"^0.22.13","ethereum-waffle":"^3.4.0","chai-as-promised":"^7.1.1","eslint-plugin-jsdoc":"^35.1.2","eslint-plugin-react":"^7.24.0","@babel/eslint-parser":"^7.18.2","eslint-plugin-import":"^2.26.0","eslint-plugin-unicorn":"^32.0.1","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-waffle":"^2.0.1","@typescript-eslint/parser":"^5.45.1","eslint-plugin-prefer-arrow":"^1.2.3","@ethersproject/transactions":"^5.7.0","@ethersproject/abstract-signer":"^5.7.0","@ethersproject/abstract-provider":"^5.7.0","@typescript-eslint/eslint-plugin":"^5.45.1"},"peerDependencies":{"ethers":"^5"},"_npmOperationalInternal":{"tmp":"tmp/boba-sdk_1.0.1_1676759571483_0.09042729221626988","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@across-protocol/boba-sdk","version":"1.0.2","keywords":["optimism","ethereum","sdk"],"author":{"name":"Optimism PBC"},"license":"MIT","_id":"@across-protocol/boba-sdk@1.0.2","maintainers":[{"name":"nicholaspai","email":"npai.nyc@gmail.com"},{"name":"daywiss","email":"daywiss@gmail.com"},{"name":"evaldofelipe","email":"contact@evaldofelipe.com"},{"name":"chrismaree","email":"christopher.maree@gmail.com"},{"name":"mrice32","email":"matthewcrice32@gmail.com"}],"homepage":"https://github.com/across-protocol/boba/tree/develop/packages/sdk#readme","bugs":{"url":"https://github.com/across-protocol/boba/issues"},"dist":{"shasum":"e20bf733467bf4a15f8f8572ec95054a20c816a4","tarball":"https://registry.npmjs.org/@across-protocol/boba-sdk/-/boba-sdk-1.0.2.tgz","fileCount":63,"integrity":"sha512-kWEsCkTT4HJnEWlqaVxBpkGzd1VTZCOxA9SYvT+ye9+ihTaNhAJ3cR9JcREfvRj5FXpFLAHo0UXKcHalMMqlaQ==","signatures":[{"sig":"MEUCIQCClPEvNAGtEhpL2r5beseRKV0VRs+YAyHCzTt/lwh8WAIgAx7hSehqVWXIrZYe9SS6OQY/MlBkWouWHfIbaBvREmY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178442,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj8WloACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpDxg//aG4l3AVEG2yeoO6RxfdSmt6UgWVvpb/EhQ7C2C2CGEVXwjk5\r\njqpKLVHdsneoz/5al4DR5ZPX1K9XPCj6eqfRUPV8Dz61Xzv+Pff4ckMAAgMJ\r\n+uYJrE+F6bnPfkrJ3caqxKIBUnvTiuHLvafRM954SxwjcQl4KnxoMFaVyuaQ\r\nOIm8n6wT8p6oZ4MXOk3KDPNJfWGDAmdYll1I3rupohNn+CQpn4nA5IibIHH6\r\n0HenIUPLu70uf9wzq/kXqwlQnmAIcKuInTyN1CIgA3GomOYpSKJ1Zf0SJQvn\r\n/uQoYt7xawUWzyHKwyaZIs5+tAyj+NkLK9zkWFJfOkZMVxviFl8/qjNaXuYp\r\nH11RYwaLwa0hSg86Q3FM+Jp/JL6HX7z+BlVGa6t8LE26eHKN0xl/z1VqVeLw\r\nVaXQWZuJersy2Ad6cGukRH/NQH3uVKs4ulSyjjIMmU9UeUbPPBxnIs0tm5f3\r\nMrEEqY6+MbzuZmfveDpYI8HRnR/gZmfWdVjtK7ZqUPGBqgLjseJIQxjcbF2Q\r\nBoJUFXzxOnzXHmimCC9n/I2/ZMI4D+9TzrJ+w+8talxloeCx3gZIcxBSx8PL\r\nmDbjEPyKkWrgFUTz7c2npX8e8diMI+P40l9UP3UMYIgNu66j+5IwtDEf0i0K\r\njlVJfykmZ2+Y/D9FJSkC7yeM6oIjnN9oUdk=\r\n=2N2K\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index","types":"dist/index","gitHead":"7bfa9e90aca243b65cb20f09f927cd375dc4801a","scripts":{"all":"yarn clean && yarn build && yarn test && yarn lint:fix && yarn lint","lint":"yarn lint:fix && yarn lint:check","test":"hardhat test","build":"tsc -p tsconfig.json","clean":"rimraf dist/ ./tsconfig.tsbuildinfo","lint:fix":"yarn lint:check --fix","lint:check":"eslint . --max-warnings=0","pre-commit":"lint-staged","autogen:docs":"typedoc --out docs src/index.ts","test:coverage":"nyc hardhat test && nyc merge .nyc_output coverage.json"},"_npmUser":{"name":"nicholaspai","email":"npai.nyc@gmail.com"},"repository":{"url":"git+https://github.com/across-protocol/boba.git","type":"git"},"_npmVersion":"8.11.0","description":"[Optimism] Tools for working with Boba, fork of Optimism","directories":{},"_nodeVersion":"16.15.1","dependencies":{"rlp":"^2.2.7","lodash":"^4.17.21","merkletreejs":"^0.2.27","@eth-optimism/contracts":"0.5.11","@eth-optimism/core-utils":"0.8.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.com/"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","chai":"^4.3.4","mocha":"^10.0.0","ethers":"^5.7.0","hardhat":"^2.12.5","typedoc":"^0.22.13","ethereum-waffle":"^3.4.0","chai-as-promised":"^7.1.1","eslint-plugin-jsdoc":"^35.1.2","eslint-plugin-react":"^7.24.0","@babel/eslint-parser":"^7.18.2","eslint-plugin-import":"^2.26.0","eslint-plugin-unicorn":"^32.0.1","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-waffle":"^2.0.1","@typescript-eslint/parser":"^5.45.1","eslint-plugin-prefer-arrow":"^1.2.3","@ethersproject/transactions":"^5.7.0","@ethersproject/abstract-signer":"^5.7.0","@ethersproject/abstract-provider":"^5.7.0","@typescript-eslint/eslint-plugin":"^5.45.1"},"peerDependencies":{"ethers":"^5"},"_npmOperationalInternal":{"tmp":"tmp/boba-sdk_1.0.2_1676765544683_0.7982407949302535","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@across-protocol/boba-sdk","version":"1.0.4","keywords":["optimism","ethereum","sdk"],"author":{"name":"Optimism PBC"},"license":"MIT","_id":"@across-protocol/boba-sdk@1.0.4","maintainers":[{"name":"nicholaspai","email":"npai.nyc@gmail.com"},{"name":"daywiss","email":"daywiss@gmail.com"},{"name":"evaldofelipe","email":"contact@evaldofelipe.com"},{"name":"chrismaree","email":"christopher.maree@gmail.com"},{"name":"mrice32","email":"matthewcrice32@gmail.com"}],"homepage":"https://github.com/across-protocol/boba/tree/develop/packages/sdk#readme","bugs":{"url":"https://github.com/across-protocol/boba/issues"},"dist":{"shasum":"7f88b04b66598b097da169375908a8b368d87bc6","tarball":"https://registry.npmjs.org/@across-protocol/boba-sdk/-/boba-sdk-1.0.4.tgz","fileCount":63,"integrity":"sha512-T/vZFqZNnFSdsmPGmUN90BsxjcDk+b1LnfBzwk/v1WmfUCuvYHNFU7Tp7iQBvQqv2wFL1U1H/lqWPhPoQgtJTA==","signatures":[{"sig":"MEYCIQDgcgkF+S5WusfWWvRanMdK9QByVrJfoZRfmac7W7AX9gIhAOn4FrsdRW85fUHqcMIfYK9R4u7/wnHEQJYyCpV9Ktcr","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178670,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj8ZW9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoX/w//cJc1FnsqM2djWLyjrYyN5/9c7Ic9FaG3Kmn6FosSX4AduKjE\r\nyOT7hhtVq4RdaktFU1V+GbR3kzVxKImetQMOBSIiwU/cvz7tDpeizvGIXl5y\r\n3rZBdz2pXLUs9RbVPHdfCbTm7ZuQ88adNTGiZbKUvzGFRtj2RtfEw4BbOPi/\r\nccQe2TRi/8oudAq6sOz5ZYC2bEbF9RQmd1a+oWndzT2bc/Br6Qw7EDf24Qgt\r\nI23I0EXvivWu+k0uCyGl+tYBrKEsnkctRI3Gp7Jg3U57x+AwfLb52Ov5F4JP\r\nRqKBJdMDfI4LO8tJJAIq1sz08olh8JEDYre/cLJ48RZKfRGJhRlS6WMrmfkR\r\n2dNWoz1vIPwO10bjFIQ4sfEe5WA8o8gtjqHAmlLs1ORFvlLNoW2ZoeN92vVA\r\nSPwIjsRAsroku84lzQF5XHFZxYZAhJukA2/UDrcyFvHa16mirUZNapUSipxx\r\nTKkyqdkrywZXbCFfbrcE5Rz26i/fW8UlCGCG8OoSAwwKn4l43RvY/VK+FN8V\r\neHgMTe2JhJzzF2flPamKjKAY6pYEGP301WRoUn89/2GkmQsa0jwtMYFgie6b\r\nHy3lVekozkVYcczFtBP5xKMJzD8pvu6GzJ+sd+rL35CP63UK3D8md6A8ldLJ\r\nMWiCZBL+dFV1Uxob0WJOeo9Mf2KVSd2TsFM=\r\n=l5qq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index","types":"dist/index","gitHead":"7bfa9e90aca243b65cb20f09f927cd375dc4801a","scripts":{"all":"yarn clean && yarn build && yarn test && yarn lint:fix && yarn lint","lint":"yarn lint:fix && yarn lint:check","test":"hardhat test","build":"tsc -p tsconfig.json","clean":"rimraf dist/ ./tsconfig.tsbuildinfo","lint:fix":"yarn lint:check --fix","lint:check":"eslint . --max-warnings=0","pre-commit":"lint-staged","autogen:docs":"typedoc --out docs src/index.ts","test:coverage":"nyc hardhat test && nyc merge .nyc_output coverage.json"},"_npmUser":{"name":"nicholaspai","email":"npai.nyc@gmail.com"},"repository":{"url":"git+https://github.com/across-protocol/boba.git","type":"git"},"_npmVersion":"8.11.0","description":"[Optimism] Tools for working with Boba, fork of Optimism","directories":{},"_nodeVersion":"16.15.1","dependencies":{"rlp":"^2.2.7","lodash":"^4.17.21","merkletreejs":"^0.2.27","@eth-optimism/contracts":"0.5.11","@eth-optimism/core-utils":"0.8.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.com/"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","chai":"^4.3.4","mocha":"^10.0.0","ethers":"^5.7.0","hardhat":"^2.12.5","typedoc":"^0.22.13","ethereum-waffle":"^3.4.0","chai-as-promised":"^7.1.1","eslint-plugin-jsdoc":"^35.1.2","eslint-plugin-react":"^7.24.0","@babel/eslint-parser":"^7.18.2","eslint-plugin-import":"^2.26.0","eslint-plugin-unicorn":"^32.0.1","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.4.0","@nomiclabs/hardhat-ethers":"^2.0.2","@nomiclabs/hardhat-waffle":"^2.0.1","@typescript-eslint/parser":"^5.45.1","eslint-plugin-prefer-arrow":"^1.2.3","@ethersproject/transactions":"^5.7.0","@ethersproject/abstract-signer":"^5.7.0","@ethersproject/abstract-provider":"^5.7.0","@typescript-eslint/eslint-plugin":"^5.45.1"},"peerDependencies":{"ethers":"^5"},"_npmOperationalInternal":{"tmp":"tmp/boba-sdk_1.0.4_1676776892827_0.1753056173771672","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-02-18T22:32:51.409Z","modified":"2026-09-22T04:50:17.476Z","1.0.1":"2023-02-18T22:32:51.658Z","1.0.2":"2023-02-19T00:12:24.869Z","1.0.4":"2023-02-19T03:21:33.006Z"},"bugs":{"url":"https://github.com/across-protocol/boba/issues"},"author":{"name":"Optimism PBC"},"license":"MIT","homepage":"https://github.com/across-protocol/boba/tree/develop/packages/sdk#readme","keywords":["optimism","ethereum","sdk"],"repository":{"url":"git+https://github.com/across-protocol/boba.git","type":"git"},"description":"[Optimism] Tools for working with Boba, fork of Optimism","maintainers":[{"email":"christopher.maree@gmail.com","name":"chrismaree"},{"email":"matthewcrice32@gmail.com","name":"mrice32"},{"email":"npai.nyc@gmail.com","name":"nicholaspai"}],"readme":"# @eth-optimism/sdk\n\nThe `@eth-optimism/sdk` package provides a set of tools for interacting with Optimism.\n\n## Installation\n\n```\nnpm install @eth-optimism/sdk\n```\n\n## Docs\n\nYou can find auto-generated API documentation over at [sdk.optimism.io](https://sdk.optimism.io).\n\n## Using the SDK\n\n### CrossChainMessenger\n\nThe [`CrossChainMessenger`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/sdk/src/cross-chain-messenger.ts) class simplifies the process of moving assets and data between Ethereum and Optimism.\nYou can use this class to, for example, initiate a withdrawal of ERC20 tokens from Optimism back to Ethereum, accurately track when the withdrawal is ready to be finalized on Ethereum, and execute the finalization transaction after the challenge period has elapsed.\nThe `CrossChainMessenger` can handle deposits and withdrawals of ETH and any ERC20-compatible token.\nDetailed API descriptions can be found at [sdk.optimism.io](https://sdk.optimism.io/classes/crosschainmessenger).\nThe `CrossChainMessenger` automatically connects to all relevant contracts so complex configuration is not necessary.\n\n### L2Provider and related utilities\n\nThe Optimism SDK includes [various utilities](https://github.com/ethereum-optimism/optimism/blob/develop/packages/sdk/src/l2-provider.ts) for handling Optimism's [transaction fee model](https://community.optimism.io/docs/developers/build/transaction-fees/).\nFor instance, [`estimateTotalGasCost`](https://sdk.optimism.io/modules.html#estimateTotalGasCost) will estimate the total cost (in wei) to send at transaction on Optimism including both the L2 execution cost and the L1 data cost.\nYou can also use the [`asL2Provider`](https://sdk.optimism.io/modules.html#asL2Provider) function to wrap an ethers Provider object into an `L2Provider` which will have all of these helper functions attached.\n\n### Other utilities\n\nThe SDK contains other useful helper functions and constants.\nFor a complete list, refer to the auto-generated [SDK documentation](https://sdk.optimism.io/)\n","readmeFilename":"README.md"}