{"_id":"@circle-fin/provider-fee-v1","_rev":"7-341c9ed209ff1d4b856d61d27d55c22f","name":"@circle-fin/provider-fee-v1","dist-tags":{"latest":"0.3.2"},"versions":{"0.1.0":{"name":"@circle-fin/provider-fee-v1","version":"0.1.0","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.1.0","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"41bd7a05aae25ad801ac01e13eb633a40eeef701","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.1.0.tgz","fileCount":11,"integrity":"sha512-i7OTsd9wMZ1ZiYHGyXRiaXNDEtKdhXXjRkot3pVlndiwJukih7lpBwUwPLm6HGaglj+H35Roew0Xr+sIa2IrAw==","signatures":[{"sig":"MEUCIAiNqqPOh1QfXvzDxLAbi7UwP2QWNvp88lUagWqLQ1RXAiEAumztOho6Q/g3wA5eqsQRPB6LqhnFrAjHIVckP0Sql0Y=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":522089},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"903f729eda4c4daaa041a973d74e885cd5f28d30","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.1","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.1.0_1784139164574_0.384872764160044","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@circle-fin/provider-fee-v1","version":"0.1.1","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.1.1","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"7c8f5ab34ea965deeebb55f2f2c8339ff2f059a0","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.1.1.tgz","fileCount":11,"integrity":"sha512-LUgG/PykH30jgJ8rmiZT7xisJAciQq15mOR9TqJYvpMOm+QdDvgxVEYj9mMqqtdysmhF9YGB1Jt+l+9lat/JhA==","signatures":[{"sig":"MEUCIQCotXz35UCAQOapR0+OIKPW07eCRrsF2PcIJsyFRtNr2AIgOebHuh8VHp40mF897kPPrNarhdR706z9QYMySyEIU1A=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":524245},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"191745f9068376056e144e612e74cdd68747fb32","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.1","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.1.1_1785274089182_0.31854687972684825","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@circle-fin/provider-fee-v1","version":"0.1.2","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.1.2","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"69cdb2cb207c2db3833fd83b41f62e582dbd0788","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.1.2.tgz","fileCount":11,"integrity":"sha512-O0Mq+gBfvhWxkCorA2sFeXKcFszjO8dsL8SbPUu7PYL846PcR+FAcLm46iUkkX3YvyZgDRA14uKfh/PKitZTpg==","signatures":[{"sig":"MEYCIQDY2v+n+9QI8rKARTEc0/WHVZ9yjDjJKtE3YtO3Upi6UAIhAM8F7munKJ4aogHNWq7Bn4vdSQXNz/AeCcM4YkcMRXyd","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":531224},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"789a49161025a99df1950726437b252becea64bc","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.2","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.1.2_1786132761040_0.5335632320234702","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@circle-fin/provider-fee-v1","version":"0.2.0","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.2.0","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"d8bacbc925955a4edc78e9e6874ecc5cf1d83ad2","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.2.0.tgz","fileCount":11,"integrity":"sha512-Fm4jk6kKrYnuoRF7/7Q/KtucbkfvlJT+73tPtJqe8k0fgdHSccP3IMVtqNq5rGFNrWQDgJLMBi1t6rG3E+qFpA==","signatures":[{"sig":"MEQCIGM+C9I8yw70p9YSZE5eHzYRoMuWgDx5gswmM6ZOYsftAiBWf9esEA0LTmNbqvoBJqEZS1U3CjummGDfv6mYHyLtNQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":577335},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"d9855bd5f7195ee1b91920206108a9995ff6fa80","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.2","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.2.0_1787932909427_0.13930848198040602","host":"s3://npm-registry-packages-npm-production"}},"0.3.0":{"name":"@circle-fin/provider-fee-v1","version":"0.3.0","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.3.0","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"d71b04ad753d27bc574190d33b0a63d4533f6ce1","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.3.0.tgz","fileCount":11,"integrity":"sha512-lbUv4skOcshZQUcsEvi2KsBYQdGZGiT09nrbVQK7hFvvMqCldiZzfkGinClYj/0CV4Mu9416C2+zughKI/eQDg==","signatures":[{"sig":"MEUCIQCcoTBueJ1lufxO2E5yizPU38lYfHPFAX0Z8R8v0OHUAgIgZTaLu3w2sakYJ1gKLK8Or/5AGyNetiU8z2LHjWo84RU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":609324},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"c2a7a00c58dbca7a65867370c7626c5394e59e5b","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.2","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.3.0_1788393441192_0.1872370122674305","host":"s3://npm-registry-packages-npm-production"}},"0.3.1":{"name":"@circle-fin/provider-fee-v1","version":"0.3.1","keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_id":"@circle-fin/provider-fee-v1@0.3.1","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"dist":{"shasum":"0e5016db5f7e6b9dfdec1a2c83a5fc05eda547a4","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.3.1.tgz","fileCount":11,"integrity":"sha512-KHWU3pj7RLIw1QQ7EJE4SWaJbmEtuz0Vs9RjANWBkC+sI/PjxnzCTEOraFdNAK3QpxftZoDX21dqT6v/a0c4YA==","signatures":[{"sig":"MEUCIQCpfnOBseG+j6MaCG4ZcqfBq/J3Nl2xrmSPrL6prRnLFwIgL5XYlp3c7K1kBg/cYo6F54Ug20S8F54SG4W1R5qymIc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIAWPBDHqTC31w8sUYXTbJQp+SqwJuEAK35/KWeI5sTm4AiBIIQX1ImIInuvNptsza86aV0MFLtONn6cMPStx7bHmyA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":618702},"main":"./index.cjs","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"5aa7ba5ea62678adf92458d83ef5afe1c61f4a41","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"sideEffects":false,"_nodeVersion":"22.23.2","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/provider-fee-v1_0.3.1_1789519108618_0.34122941758501235","host":"s3://npm-registry-packages-npm-production"}},"0.3.2":{"_id":"@circle-fin/provider-fee-v1@0.3.2","dist":{"shasum":"6c58987f5b06157451818e295441ff4dfc157ca2","tarball":"https://registry.npmjs.org/@circle-fin/provider-fee-v1/-/provider-fee-v1-0.3.2.tgz","fileCount":11,"integrity":"sha512-X0WVKb0JC2dthkD+EZyAsF6MY7qZoMs6tWDfNuZ2VtavdQsM1kfrd5KMIlTGhmtDmxAF/wputfkTI1ILeT6Lmg==","signatures":[{"sig":"MEUCIQCOagCce5UU+wEaIxK1R6yrb/zclX3JLK/jfBx1HQlH3AIgCDkVViR5y6DyDoNIdqyN69qTHwj/AKqZuzJYJnikKrQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIH8b5gzF7D6KRRN92mb0I0Ojwrxh5MiFpxWW9CKmbpEPAiEAgykABorLN5X+PWQV3wUjUHZ3nzRG+YQjHtjPLyQGGWE="}],"unpackedSize":632466},"main":"./index.cjs","name":"@circle-fin/provider-fee-v1","type":"module","types":"./index.d.cts","module":"./index.mjs","engines":{"node":">=20.0.0"},"exports":{".":{"types":{"import":"./index.d.mts","require":"./index.d.cts"},"import":"./index.mjs","default":"./index.cjs","require":"./index.cjs"},"./package.json":"./package.json"},"gitHead":"a3c239ff67725474d4c37138fcf07a15cf51fd44","version":"0.3.2","_npmUser":{"name":"circle-npm-ci","email":"devops@circle.com"},"keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"_npmVersion":"10.9.8","description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","directories":{},"maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"sideEffects":false,"_nodeVersion":"22.23.2","dependencies":{"zod":"3.25.67","bs58":"6.0.0","@ethersproject/abi":"^5.8.0","@ethersproject/bytes":"^5.8.0","@ethersproject/units":"^5.8.0","@ethersproject/address":"^5.8.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/provider-fee-v1_0.3.2_1790775609953_0.7113526767933958"}}},"time":{"created":"2026-07-15T18:12:44.338Z","modified":"2026-09-30T13:40:10.234Z","0.1.0":"2026-07-15T18:12:44.714Z","0.1.1":"2026-07-28T21:28:09.348Z","0.1.2":"2026-08-07T19:59:21.203Z","0.2.0":"2026-08-28T16:01:49.565Z","0.3.0":"2026-09-02T23:57:21.362Z","0.3.1":"2026-09-16T00:38:28.729Z","0.3.2":"2026-09-30T13:40:10.046Z"},"keywords":["circle","circle-fin","usdc","cctp","fee","quote","provider","typescript"],"description":"Client for Circle's Quote API that fetches signed fee quotes for the prepaid FORWARD fast-deposit path of a CCTP v2 USDC burn.","maintainers":[{"name":"tomleicircle","email":"mengda.lei@circle.com"},{"name":"igaskin-circle","email":"isaac.gaskin@circle.com"},{"name":"circle-npm-ci","email":"devops@circle.com"}],"readme":"# @circle-fin/provider-fee-v1\n\n> [!IMPORTANT]\n> This package is published for use within Circle's SDK packages. Its exports\n> are marked `@internal` and are not currently a supported public API. They may\n> change between releases without compatibility guarantees.\n>\n> Applications should not import this package directly.\n\nThe package contains Circle Quote API integration used by Unified Balance Kit\nfor FAST cross-chain deposits, including signed fee-quote retrieval and\nvalidation. The client wraps\n`POST /v2/quote/burn/usdc/{sourceDomain}/{destinationDomain}`. The endpoint is\npermissionless (no auth) and edge rate-limited, and is feature-flagged per\nsource chain (a disabled chain returns `503 SERVICE_NOT_ENABLED`, surfaced as a\nfatal, non-retryable error).\n\nUse `@circle-fin/unified-balance-kit` to estimate and execute deposits:\n\n```typescript\nconst estimate = await kit.estimateDeposit({\n  from,\n  amount: '10',\n  token: 'USDC',\n  to: { chain: 'Arc_Testnet' },\n  config: { transferSpeed: 'FAST' },\n})\n\nconst result = await kit.deposit({\n  ...estimate,\n  from,\n})\n```\n\n## Validating a signed quote\n\nA signed quote is short-lived and bound to the exact on-chain call it will be\nsubmitted with. Before you burn, re-check it against the complete contract call\nvia `POST /v2/quote/validate/usdc/{sourceDomain}`. `validateQuote` returns\nwhether the quote is still `claimable`, the `failedChecks` blocking it (see\n`QUOTE_REJECTION_REASONS`), and the authoritative expiry status at the current\nsource-chain tip.\n\n```typescript\nimport { validateQuote } from '@circle-fin/provider-fee-v1'\n\nconst result = await validateQuote({\n  sourceDomain: 3, // Arbitrum CCTP domain\n  // The exact function and arguments you will submit on-chain.\n  abiSignature:\n    'depositForBurnWithHookAndFees(uint256,uint32,bytes32,address,bytes32,bytes,(bytes,address))',\n  args: [\n    '1000000',\n    '26',\n    '0x0000000000000000000000001111111111111111111111111111111111111111',\n    '0x2222222222222222222222222222222222222222',\n    '0x0000000000000000000000000000000000000000000000000000000000000000',\n    '0x636374702d666f72776172640000000000000000000000000000000000000000',\n    ['0x01abcd', '0x3333333333333333333333333333333333333333'],\n  ],\n  isTestnet: false,\n})\n\nif (result.claimable) {\n  console.log('safe to submit', result.expiry.secondsRemaining)\n} else {\n  console.warn('do not submit', result.failedChecks)\n}\n```\n\n## Notes\n\n- `amount` is a decimal string in token minor units.\n- `feeToken` defaults to the zero address (native); pass a USDC address to pay\n  fees in USDC.\n- The quote is short-lived (`expiry.expiresAt` or `expiry.expiresAtBlock`);\n  fetch a fresh quote immediately before submitting on-chain rather than\n  caching it.\n- `signedQuote` is opaque bytes returned verbatim; do not decode it.\n- The client makes a single attempt (no transport retry/backoff). The endpoint\n  is edge rate-limited, so on a `429` the caller should back off and re-request\n  rather than expecting the client to retry.\n","readmeFilename":"README.md"}