@0xbow/privacy-pools-core-sdk 0.1.5

package/README.md

@@ -0,0 +1,73 @@
+# Privacy Pool Core SDK
+
+A TypeScript SDK for interacting with the Privacy Pool protocol. This SDK provides a comprehensive set of tools and utilities for integrating with Privacy Pool, enabling deposits, withdrawals, and other core functionality.
+
+## Installation
+
+
+```bash
+npm install @0xbow/privacy-pool-core-sdk
+# or
+yarn add @0xbow/privacy-pool-core-sdk
+# or
+pnpm add @0xbow/privacy-pool-core-sdk
+```
+
+## Setup
+
+1. Install dependencies by running `pnpm install`
+2. Build the SDK by running `pnpm build`
+
+## Available Scripts
+
+| Script        | Description                                             |
+| ------------- | ------------------------------------------------------- |
+| `build`       | Build the SDK using Rollup                              |
+| `build:bundle`| Build the SDK and set up circuits                       |
+| `check-types` | Check for TypeScript type issues                        |
+| `clean`       | Remove build artifacts                                  |
+| `lint`        | Run ESLint to check code quality                        |
+| `lint:fix`    | Fix linting issues automatically                        |
+| `format`      | Check code formatting using Prettier                    |
+| `format:fix`  | Fix formatting issues automatically                     |
+| `test`        | Run tests using Vitest                                  |
+| `test:cov`    | Generate test coverage report                           |
+
+## Usage
+
+```typescript
+import { PrivacyPoolSDK } from '@0xbow/privacy-pool-core-sdk';
+
+// Initialize the SDK
+const sdk = new PrivacyPoolSDK({
+  // Configuration options
+});
+
+// Example: Create a deposit
+const deposit = await sdk.deposit({
+  // Deposit parameters
+});
+
+// Example: Create a withdrawal
+const withdrawal = await sdk.withdraw({
+  // Withdrawal parameters
+});
+```
+
+For detailed usage examples and API documentation, please refer to our [documentation](https://github.com/defi-wonderland/privacy-pool-core/tree/main/docs).
+
+## Features
+
+- Deposit and withdrawal functionality
+- Zero-knowledge proof generation
+- Commitment management
+- Contract interactions
+- Type-safe API
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+Apache-2.0 License - see the [LICENSE](LICENSE) file for details.

package/dist/esm/ccip-nJye9Itm.js

@@ -0,0 +1,166 @@
+import { B as BaseError, g as getUrl, s as stringify, d as decodeErrorResult, i as isAddressEqual, c as call, a as concat, e as encodeAbiParameters, H as HttpRequestError, b as isHex } from './index-DAWUECi8.js';
+import 'buffer';
+import 'assert';
+
+class OffchainLookupError extends BaseError {
+    constructor({ callbackSelector, cause, data, extraData, sender, urls, }) {
+        super(cause.shortMessage ||
+            'An error occurred while fetching for an offchain result.', {
+            cause,
+            metaMessages: [
+                ...(cause.metaMessages || []),
+                cause.metaMessages?.length ? '' : [],
+                'Offchain Gateway Call:',
+                urls && [
+                    '  Gateway URL(s):',
+                    ...urls.map((url) => `    ${getUrl(url)}`),
+                ],
+                `  Sender: ${sender}`,
+                `  Data: ${data}`,
+                `  Callback selector: ${callbackSelector}`,
+                `  Extra data: ${extraData}`,
+            ].flat(),
+            name: 'OffchainLookupError',
+        });
+    }
+}
+class OffchainLookupResponseMalformedError extends BaseError {
+    constructor({ result, url }) {
+        super('Offchain gateway response is malformed. Response data must be a hex value.', {
+            metaMessages: [
+                `Gateway URL: ${getUrl(url)}`,
+                `Response: ${stringify(result)}`,
+            ],
+            name: 'OffchainLookupResponseMalformedError',
+        });
+    }
+}
+class OffchainLookupSenderMismatchError extends BaseError {
+    constructor({ sender, to }) {
+        super('Reverted sender address does not match target contract address (`to`).', {
+            metaMessages: [
+                `Contract address: ${to}`,
+                `OffchainLookup sender address: ${sender}`,
+            ],
+            name: 'OffchainLookupSenderMismatchError',
+        });
+    }
+}
+
+const offchainLookupSignature = '0x556f1830';
+const offchainLookupAbiItem = {
+    name: 'OffchainLookup',
+    type: 'error',
+    inputs: [
+        {
+            name: 'sender',
+            type: 'address',
+        },
+        {
+            name: 'urls',
+            type: 'string[]',
+        },
+        {
+            name: 'callData',
+            type: 'bytes',
+        },
+        {
+            name: 'callbackFunction',
+            type: 'bytes4',
+        },
+        {
+            name: 'extraData',
+            type: 'bytes',
+        },
+    ],
+};
+async function offchainLookup(client, { blockNumber, blockTag, data, to, }) {
+    const { args } = decodeErrorResult({
+        data,
+        abi: [offchainLookupAbiItem],
+    });
+    const [sender, urls, callData, callbackSelector, extraData] = args;
+    const { ccipRead } = client;
+    const ccipRequest_ = ccipRead && typeof ccipRead?.request === 'function'
+        ? ccipRead.request
+        : ccipRequest;
+    try {
+        if (!isAddressEqual(to, sender))
+            throw new OffchainLookupSenderMismatchError({ sender, to });
+        const result = await ccipRequest_({ data: callData, sender, urls });
+        const { data: data_ } = await call(client, {
+            blockNumber,
+            blockTag,
+            data: concat([
+                callbackSelector,
+                encodeAbiParameters([{ type: 'bytes' }, { type: 'bytes' }], [result, extraData]),
+            ]),
+            to,
+        });
+        return data_;
+    }
+    catch (err) {
+        throw new OffchainLookupError({
+            callbackSelector,
+            cause: err,
+            data,
+            extraData,
+            sender,
+            urls,
+        });
+    }
+}
+async function ccipRequest({ data, sender, urls, }) {
+    let error = new Error('An unknown error occurred.');
+    for (let i = 0; i < urls.length; i++) {
+        const url = urls[i];
+        const method = url.includes('{data}') ? 'GET' : 'POST';
+        const body = method === 'POST' ? { data, sender } : undefined;
+        const headers = method === 'POST' ? { 'Content-Type': 'application/json' } : {};
+        try {
+            const response = await fetch(url.replace('{sender}', sender).replace('{data}', data), {
+                body: JSON.stringify(body),
+                headers,
+                method,
+            });
+            let result;
+            if (response.headers.get('Content-Type')?.startsWith('application/json')) {
+                result = (await response.json()).data;
+            }
+            else {
+                result = (await response.text());
+            }
+            if (!response.ok) {
+                error = new HttpRequestError({
+                    body,
+                    details: result?.error
+                        ? stringify(result.error)
+                        : response.statusText,
+                    headers: response.headers,
+                    status: response.status,
+                    url,
+                });
+                continue;
+            }
+            if (!isHex(result)) {
+                error = new OffchainLookupResponseMalformedError({
+                    result,
+                    url,
+                });
+                continue;
+            }
+            return result;
+        }
+        catch (err) {
+            error = new HttpRequestError({
+                body,
+                details: err.message,
+                url,
+            });
+        }
+    }
+    throw error;
+}
+
+export { ccipRequest, offchainLookup, offchainLookupAbiItem, offchainLookupSignature };
+//# sourceMappingURL=ccip-nJye9Itm.js.map

package/dist/esm/ccip-nJye9Itm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ccip-nJye9Itm.js","sources":["../../node_modules/.pnpm/viem@2.22.14_typescript@5.7.3/node_modules/viem/_esm/errors/ccip.js","../../node_modules/.pnpm/viem@2.22.14_typescript@5.7.3/node_modules/viem/_esm/utils/ccip.js"],"sourcesContent":["import { stringify } from '../utils/stringify.js';\nimport { BaseError } from './base.js';\nimport { getUrl } from './utils.js';\nexport class OffchainLookupError extends BaseError {\n    constructor({ callbackSelector, cause, data, extraData, sender, urls, }) {\n        super(cause.shortMessage ||\n            'An error occurred while fetching for an offchain result.', {\n            cause,\n            metaMessages: [\n                ...(cause.metaMessages || []),\n                cause.metaMessages?.length ? '' : [],\n                'Offchain Gateway Call:',\n                urls && [\n                    '  Gateway URL(s):',\n                    ...urls.map((url) => `    ${getUrl(url)}`),\n                ],\n                `  Sender: ${sender}`,\n                `  Data: ${data}`,\n                `  Callback selector: ${callbackSelector}`,\n                `  Extra data: ${extraData}`,\n            ].flat(),\n            name: 'OffchainLookupError',\n        });\n    }\n}\nexport class OffchainLookupResponseMalformedError extends BaseError {\n    constructor({ result, url }) {\n        super('Offchain gateway response is malformed. Response data must be a hex value.', {\n            metaMessages: [\n                `Gateway URL: ${getUrl(url)}`,\n                `Response: ${stringify(result)}`,\n            ],\n            name: 'OffchainLookupResponseMalformedError',\n        });\n    }\n}\nexport class OffchainLookupSenderMismatchError extends BaseError {\n    constructor({ sender, to }) {\n        super('Reverted sender address does not match target contract address (`to`).', {\n            metaMessages: [\n                `Contract address: ${to}`,\n                `OffchainLookup sender address: ${sender}`,\n            ],\n            name: 'OffchainLookupSenderMismatchError',\n        });\n    }\n}\n//# sourceMappingURL=ccip.js.map","import { call } from '../actions/public/call.js';\nimport { OffchainLookupError, OffchainLookupResponseMalformedError, OffchainLookupSenderMismatchError, } from '../errors/ccip.js';\nimport { HttpRequestError, } from '../errors/request.js';\nimport { decodeErrorResult } from './abi/decodeErrorResult.js';\nimport { encodeAbiParameters } from './abi/encodeAbiParameters.js';\nimport { isAddressEqual } from './address/isAddressEqual.js';\nimport { concat } from './data/concat.js';\nimport { isHex } from './data/isHex.js';\nimport { stringify } from './stringify.js';\nexport const offchainLookupSignature = '0x556f1830';\nexport const offchainLookupAbiItem = {\n    name: 'OffchainLookup',\n    type: 'error',\n    inputs: [\n        {\n            name: 'sender',\n            type: 'address',\n        },\n        {\n            name: 'urls',\n            type: 'string[]',\n        },\n        {\n            name: 'callData',\n            type: 'bytes',\n        },\n        {\n            name: 'callbackFunction',\n            type: 'bytes4',\n        },\n        {\n            name: 'extraData',\n            type: 'bytes',\n        },\n    ],\n};\nexport async function offchainLookup(client, { blockNumber, blockTag, data, to, }) {\n    const { args } = decodeErrorResult({\n        data,\n        abi: [offchainLookupAbiItem],\n    });\n    const [sender, urls, callData, callbackSelector, extraData] = args;\n    const { ccipRead } = client;\n    const ccipRequest_ = ccipRead && typeof ccipRead?.request === 'function'\n        ? ccipRead.request\n        : ccipRequest;\n    try {\n        if (!isAddressEqual(to, sender))\n            throw new OffchainLookupSenderMismatchError({ sender, to });\n        const result = await ccipRequest_({ data: callData, sender, urls });\n        const { data: data_ } = await call(client, {\n            blockNumber,\n            blockTag,\n            data: concat([\n                callbackSelector,\n                encodeAbiParameters([{ type: 'bytes' }, { type: 'bytes' }], [result, extraData]),\n            ]),\n            to,\n        });\n        return data_;\n    }\n    catch (err) {\n        throw new OffchainLookupError({\n            callbackSelector,\n            cause: err,\n            data,\n            extraData,\n            sender,\n            urls,\n        });\n    }\n}\nexport async function ccipRequest({ data, sender, urls, }) {\n    let error = new Error('An unknown error occurred.');\n    for (let i = 0; i < urls.length; i++) {\n        const url = urls[i];\n        const method = url.includes('{data}') ? 'GET' : 'POST';\n        const body = method === 'POST' ? { data, sender } : undefined;\n        const headers = method === 'POST' ? { 'Content-Type': 'application/json' } : {};\n        try {\n            const response = await fetch(url.replace('{sender}', sender).replace('{data}', data), {\n                body: JSON.stringify(body),\n                headers,\n                method,\n            });\n            let result;\n            if (response.headers.get('Content-Type')?.startsWith('application/json')) {\n                result = (await response.json()).data;\n            }\n            else {\n                result = (await response.text());\n            }\n            if (!response.ok) {\n                error = new HttpRequestError({\n                    body,\n                    details: result?.error\n                        ? stringify(result.error)\n                        : response.statusText,\n                    headers: response.headers,\n                    status: response.status,\n                    url,\n                });\n                continue;\n            }\n            if (!isHex(result)) {\n                error = new OffchainLookupResponseMalformedError({\n                    result,\n                    url,\n                });\n                continue;\n            }\n            return result;\n        }\n        catch (err) {\n            error = new HttpRequestError({\n                body,\n                details: err.message,\n                url,\n            });\n        }\n    }\n    throw error;\n}\n//# sourceMappingURL=ccip.js.map"],"names":[],"mappings":";;;;AAGO,MAAM,mBAAmB,SAAS,SAAS,CAAC;AACnD,IAAI,WAAW,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE;AAC7E,QAAQ,KAAK,CAAC,KAAK,CAAC,YAAY;AAChC,YAAY,0DAA0D,EAAE;AACxE,YAAY,KAAK;AACjB,YAAY,YAAY,EAAE;AAC1B,gBAAgB,IAAI,KAAK,CAAC,YAAY,IAAI,EAAE,CAAC;AAC7C,gBAAgB,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,EAAE,GAAG,EAAE;AACpD,gBAAgB,wBAAwB;AACxC,gBAAgB,IAAI,IAAI;AACxB,oBAAoB,mBAAmB;AACvC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC9D,iBAAiB;AACjB,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AACrC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACjC,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;AAC1D,gBAAgB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;AAC5C,aAAa,CAAC,IAAI,EAAE;AACpB,YAAY,IAAI,EAAE,qBAAqB;AACvC,SAAS,CAAC;AACV;AACA;AACO,MAAM,oCAAoC,SAAS,SAAS,CAAC;AACpE,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE;AACjC,QAAQ,KAAK,CAAC,4EAA4E,EAAE;AAC5F,YAAY,YAAY,EAAE;AAC1B,gBAAgB,CAAC,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7C,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;AAChD,aAAa;AACb,YAAY,IAAI,EAAE,sCAAsC;AACxD,SAAS,CAAC;AACV;AACA;AACO,MAAM,iCAAiC,SAAS,SAAS,CAAC;AACjE,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;AAChC,QAAQ,KAAK,CAAC,wEAAwE,EAAE;AACxF,YAAY,YAAY,EAAE;AAC1B,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;AACzC,gBAAgB,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;AAC1D,aAAa;AACb,YAAY,IAAI,EAAE,mCAAmC;AACrD,SAAS,CAAC;AACV;AACA;;ACrCY,MAAC,uBAAuB,GAAG;AAC3B,MAAC,qBAAqB,GAAG;AACrC,IAAI,IAAI,EAAE,gBAAgB;AAC1B,IAAI,IAAI,EAAE,OAAO;AACjB,IAAI,MAAM,EAAE;AACZ,QAAQ;AACR,YAAY,IAAI,EAAE,QAAQ;AAC1B,YAAY,IAAI,EAAE,SAAS;AAC3B,SAAS;AACT,QAAQ;AACR,YAAY,IAAI,EAAE,MAAM;AACxB,YAAY,IAAI,EAAE,UAAU;AAC5B,SAAS;AACT,QAAQ;AACR,YAAY,IAAI,EAAE,UAAU;AAC5B,YAAY,IAAI,EAAE,OAAO;AACzB,SAAS;AACT,QAAQ;AACR,YAAY,IAAI,EAAE,kBAAkB;AACpC,YAAY,IAAI,EAAE,QAAQ;AAC1B,SAAS;AACT,QAAQ;AACR,YAAY,IAAI,EAAE,WAAW;AAC7B,YAAY,IAAI,EAAE,OAAO;AACzB,SAAS;AACT,KAAK;AACL;AACO,eAAe,cAAc,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE;AACnF,IAAI,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,CAAC;AACvC,QAAQ,IAAI;AACZ,QAAQ,GAAG,EAAE,CAAC,qBAAqB,CAAC;AACpC,KAAK,CAAC;AACN,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,SAAS,CAAC,GAAG,IAAI;AACtE,IAAI,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM;AAC/B,IAAI,MAAM,YAAY,GAAG,QAAQ,IAAI,OAAO,QAAQ,EAAE,OAAO,KAAK;AAClE,UAAU,QAAQ,CAAC;AACnB,UAAU,WAAW;AACrB,IAAI,IAAI;AACR,QAAQ,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC;AACvC,YAAY,MAAM,IAAI,iCAAiC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;AACvE,QAAQ,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC3E,QAAQ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE;AACnD,YAAY,WAAW;AACvB,YAAY,QAAQ;AACpB,YAAY,IAAI,EAAE,MAAM,CAAC;AACzB,gBAAgB,gBAAgB;AAChC,gBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAChG,aAAa,CAAC;AACd,YAAY,EAAE;AACd,SAAS,CAAC;AACV,QAAQ,OAAO,KAAK;AACpB;AACA,IAAI,OAAO,GAAG,EAAE;AAChB,QAAQ,MAAM,IAAI,mBAAmB,CAAC;AACtC,YAAY,gBAAgB;AAC5B,YAAY,KAAK,EAAE,GAAG;AACtB,YAAY,IAAI;AAChB,YAAY,SAAS;AACrB,YAAY,MAAM;AAClB,YAAY,IAAI;AAChB,SAAS,CAAC;AACV;AACA;AACO,eAAe,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE;AAC3D,IAAI,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,4BAA4B,CAAC;AACvD,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AAC1C,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC;AAC3B,QAAQ,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,MAAM;AAC9D,QAAQ,MAAM,IAAI,GAAG,MAAM,KAAK,MAAM,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS;AACrE,QAAQ,MAAM,OAAO,GAAG,MAAM,KAAK,MAAM,GAAG,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,EAAE;AACvF,QAAQ,IAAI;AACZ,YAAY,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE;AAClG,gBAAgB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;AAC1C,gBAAgB,OAAO;AACvB,gBAAgB,MAAM;AACtB,aAAa,CAAC;AACd,YAAY,IAAI,MAAM;AACtB,YAAY,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,EAAE;AACtF,gBAAgB,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI;AACrD;AACA,iBAAiB;AACjB,gBAAgB,MAAM,IAAI,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChD;AACA,YAAY,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;AAC9B,gBAAgB,KAAK,GAAG,IAAI,gBAAgB,CAAC;AAC7C,oBAAoB,IAAI;AACxB,oBAAoB,OAAO,EAAE,MAAM,EAAE;AACrC,0BAA0B,SAAS,CAAC,MAAM,CAAC,KAAK;AAChD,0BAA0B,QAAQ,CAAC,UAAU;AAC7C,oBAAoB,OAAO,EAAE,QAAQ,CAAC,OAAO;AAC7C,oBAAoB,MAAM,EAAE,QAAQ,CAAC,MAAM;AAC3C,oBAAoB,GAAG;AACvB,iBAAiB,CAAC;AAClB,gBAAgB;AAChB;AACA,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AAChC,gBAAgB,KAAK,GAAG,IAAI,oCAAoC,CAAC;AACjE,oBAAoB,MAAM;AAC1B,oBAAoB,GAAG;AACvB,iBAAiB,CAAC;AAClB,gBAAgB;AAChB;AACA,YAAY,OAAO,MAAM;AACzB;AACA,QAAQ,OAAO,GAAG,EAAE;AACpB,YAAY,KAAK,GAAG,IAAI,gBAAgB,CAAC;AACzC,gBAAgB,IAAI;AACpB,gBAAgB,OAAO,EAAE,GAAG,CAAC,OAAO;AACpC,gBAAgB,GAAG;AACnB,aAAa,CAAC;AACd;AACA;AACA,IAAI,MAAM,KAAK;AACf;;;;","x_google_ignoreList":[0,1]}