@ember-finance/proof-of-reserves 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Ember Protocol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,105 @@
+# ember-proof-of-reserves
+
+A TypeScript library and CLI tool for generating and verifying proof of reserves reports
+for Ember Protocol vaults.
+
+## Installation
+
+### As a CLI tool (global)
+
+```bash
+npm install -g ember-proof-of-reserves
+# or
+yarn global add ember-proof-of-reserves
+```
+
+### As a library
+
+```bash
+npm install ember-proof-of-reserves
+# or
+yarn add ember-proof-of-reserves
+```
+
+## Usage
+
+### CLI Usage
+
+1. Create a `.env` file:
+
+```bash
+BLOCKVISION_API_KEY=your_blockvision_key_here
+DEBANK_API_KEY=your_debank_key_here
+ZERION_API_KEY=your_zerion_key_here
+SUI_RPC_URL=https://fullnode.mainnet.sui.io:443
+LOG_LEVEL=info
+```
+
+2. Run the CLI:
+
+```bash
+ember-por
+```
+
+Reports will be generated in the `reports/` directory.
+
+### Library Usage
+
+```typescript
+import { generateProofOfReservesReport, type VaultReport } from 'ember-proof-of-reserves';
+
+async function main() {
+  // Generate reports programmatically
+  const reports = await generateProofOfReservesReport({
+    basePath: 'https://vaults.api.sui-prod.bluefin.io',
+    suiRpcUrl: 'https://fullnode.mainnet.sui.io:443',
+    outputDir: './my-reports'
+  });
+
+  console.log(`Generated ${reports.length} vault reports`);
+
+  reports.forEach((report: VaultReport) => {
+    console.log(`Vault: ${report.vaultName}`);
+    console.log(`Health Ratio: ${report.vaultHealthRatio}`);
+    console.log(`Total NAV: $${report.systemNavUsd}`);
+  });
+}
+
+main();
+```
+
+## Environment Variables
+
+| Variable                     | Required | Default                               | Description                                            |
+| ---------------------------- | -------- | ------------------------------------- | ------------------------------------------------------ |
+| `BLOCKVISION_API_KEY`        | Yes      | -                                     | API key for BlockVision (Sui chain data)               |
+| `DEBANK_API_KEY`             | Yes      | -                                     | API key for DeBank (EVM chain data)                    |
+| `ZERION_API_KEY`             | Yes      | -                                     | API key for Zerion (Solana chain data)                 |
+| `SUI_RPC_URL`                | No       | `https://fullnode.mainnet.sui.io:443` | Sui RPC endpoint                                       |
+| `LOG_LEVEL`                  | No       | `info`                                | Logging level (trace, debug, info, warn, error, fatal) |
+| `USE_BLUEFIN_PRICE_FEED`     | No       | `false`                               | Use Bluefin price feed                                 |
+| `BLOCKVISION_RATE_LIMIT_RPS` | No       | `1`                                   | Rate limit for BlockVision API                         |
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for
+details.
+
+## Support
+
+For issues and questions:
+
+- GitHub Issues: https://github.com/fireflyprotocol/ember-por/issues
+- Email: engineering@bluefin.io
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const generate_report_1 = require("./generate-report");
+const logger_1 = require("./utils/logger");
+const program = new commander_1.Command();
+program
+    .name("ember-por")
+    .command("generate-report")
+    .description("Generate proof of capital reports for Ember Protocol vaults")
+    .version("0.0.1")
+    .option("--vault-service-base-path <url>", "Ember Vaults API base path", "https://vaults.api.sui-prod.bluefin.io")
+    .option("--sui-rpc-url <url>", "Sui RPC endpoint URL", "https://fullnode.mainnet.sui.io:443")
+    .option("--output-dir <path>", "Directory where reports will be saved", "./reports")
+    .option("--excluded-vaults <ids>", "Comma-separated list of vault IDs to exclude", value => value.split(",").map(s => s.trim()))
+    .option("--only-process-vault-id <id>", "Process only this specific vault ID")
+    .option("--no-write-to-file", "Do not write reports to file system")
+    .option("--blockvision-api-key <key>", "API key for Blockvision (or set BLOCKVISION_API_KEY env var)")
+    .option("--debank-api-key <key>", "API key for DeBank (or set DEBANK_API_KEY env var)")
+    .option("--zerion-api-key <key>", "API key for Zerion (or set ZERION_API_KEY env var)")
+    .option("--use-bluefin-price-feed", "Use Bluefin price feed", false)
+    .option("--log-level <level>", "Log level: trace, debug, info, warn, error, fatal", "info")
+    .option("--blockvision-rate-limit <rps>", "Rate limit for Blockvision API", value => parseInt(value, 10), 1)
+    .action(async (options) => {
+    try {
+        await (0, generate_report_1.generateProofOfCapitalReport)({
+            vaultServiceBasePath: options.vaultServiceBasePath,
+            suiRpcUrl: options.suiRpcUrl,
+            outputDir: options.outputDir,
+            excludedVaults: options.excludedVaults,
+            onlyProcessVaultId: options.onlyProcessVaultId,
+            writeToFile: options.writeToFile,
+            blockvisionApiKey: options.blockvisionApiKey || process.env.BLOCKVISION_API_KEY,
+            debankApiKey: options.debankApiKey || process.env.DEBANK_API_KEY,
+            zerionApiKey: options.zerionApiKey || process.env.ZERION_API_KEY,
+            useBluefinPriceFeed: options.useBluefinPriceFeed,
+            logLevel: options.logLevel,
+            blockvisionRateLimitRps: options.blockvisionRateLimit
+        });
+    }
+    catch (error) {
+        logger_1.log.fatal({ error }, "Application failed to complete");
+        process.exit(1);
+    }
+});
+program.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AACA,yCAAoC;AACpC,uDAAiE;AACjE,2CAAqC;AAErC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,WAAW,CAAC;KACjB,OAAO,CAAC,iBAAiB,CAAC;KAC1B,WAAW,CAAC,6DAA6D,CAAC;KAC1E,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CACH,iCAAiC,EACjC,4BAA4B,EAC5B,wCAAwC,CAC3C;KACA,MAAM,CACH,qBAAqB,EACrB,sBAAsB,EACtB,qCAAqC,CACxC;KACA,MAAM,CAAC,qBAAqB,EAAE,uCAAuC,EAAE,WAAW,CAAC;KACnF,MAAM,CACH,yBAAyB,EACzB,8CAA8C,EAC9C,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAC/C;KACA,MAAM,CAAC,8BAA8B,EAAE,qCAAqC,CAAC;KAC7E,MAAM,CAAC,oBAAoB,EAAE,qCAAqC,CAAC;KACnE,MAAM,CACH,6BAA6B,EAC7B,8DAA8D,CACjE;KACA,MAAM,CACH,wBAAwB,EACxB,oDAAoD,CACvD;KACA,MAAM,CACH,wBAAwB,EACxB,oDAAoD,CACvD;KACA,MAAM,CAAC,0BAA0B,EAAE,wBAAwB,EAAE,KAAK,CAAC;KACnE,MAAM,CACH,qBAAqB,EACrB,mDAAmD,EACnD,MAAM,CACT;KACA,MAAM,CACH,gCAAgC,EAChC,gCAAgC,EAChC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,EAC5B,CAAC,CACJ;KACA,MAAM,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;IACpB,IAAI,CAAC;QACD,MAAM,IAAA,8CAA4B,EAAC;YAC/B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,iBAAiB,EACb,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB;YAChE,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc;YAChE,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc;YAChE,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;YAChD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,uBAAuB,EAAE,OAAO,CAAC,oBAAoB;SACxD,CAAC,CAAC;IACP,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,YAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC,CAAC;AAEP,OAAO,CAAC,KAAK,EAAE,CAAC"}