防腐储备
TypeScript 库和用于生成和核实保留报告证明的 CLI 工具 ember协议金库.
安装
作为CLI工具(全球)
npm install -g ember-proof-of-reserves
# or
yarn global add ember-proof-of-reserves
作为图书馆
npm install ember-proof-of-reserves
# or
yarn add ember-proof-of-reserves
使用量
CLI 使用量
- 创建一个
.env文件 :
BLOCKVISION_API_KEY=your_blockvision_key_here
DEBANK_API_KEY=your_debank_key_here
SERIALIZED_API_KEY=your_serialized_key_here
SUI_GRPC_URL=https://fullnode.mainnet.sui.io:443
SUI_GRPC_TOKEN=
LOG_LEVEL=info
- 运行 CLI :
ember-por
报告将编成 reports/ 目录.
图书馆的使用
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',
suiGrpcUrl: '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();
环境变量
| 变量 | 需求 | 默认 | 说明 |
|---|---|---|---|
BLOCKVISION_API_KEY | 对 | - 说吧 | BlockVision (苏伊链数据) 的 API 密钥 |
DEBANK_API_KEY | 对 | - 说吧 | DeBank 的 API 密钥( EVM 链数据) |
SERIALIZED_API_KEY | 对 | - 说吧 | 序列化的 API 密钥( Solana 位和余额) |
SUI_GRPC_URL | 没有 | https://fullnode.mainnet.sui.io:443 | Sui gRPC 终点 |
SUI_GRPC_TOKEN | 没有 | - 说吧 | Sui gRPC 认证令牌,作为 x-token 标题 |
LOG_LEVEL | 没有 | info | 日志级别( 跟踪、 调试、 信息、 警告、 错误、 致命) |
USE_BLUEFIN_PRICE_FEED | 没有 | false | 使用 Bluefin 价格种子 |
BLOCKVISION_RATE_LIMIT_RPS | 没有 | 1 | BlockVision API 的费率限制 |
捐款
- 叉子存储器
- 创建您的特性分支( E)
git checkout -b feature/amazing-feature(中文(简体) ) - 提交更改( E)
git commit -m 'Add some amazing feature'(中文(简体) ) - 推向分行(
git push origin feature/amazing-feature(中文(简体) ) - 打开拉请求
释放
这个包裹住在 木质摩诺 时间
typescript/library/ember-proof-of-reserves弹出 version 内 package.json,合并,
然后运行 ./scripts/release.sh ember-proof-of-reserves 从 repo 根(参见
RELEASE.md) (中文(简体) ). 它出版标签 release-ember-proof-of-reserves-<N>时 N 这是
下一个单发号; npm 版本来自 package.json。 。 。 .
.github/workflows/ember_proof_of_reserves_publish.yaml 通过 npm OIDC 可信发布
发布; npm 授权该文件的准确名称, 因此它不能被重新命名 .
许可证
这个项目根据麻省理工学院许可证颁发——见 自由主义 文件为 细节.
支助
关于议题和问题清单:
- GitHub 问题 : https://github.com/fireflyprotocol/ember-mono/ 问题
- 电子邮件 : 工程学@ bluefin.io
更改日志
见 变动情况 为更改列表.