README.md

vault-transaction-indexer

Transacting indexing and processing pipeline for Castle Labs vaults. Built with AWS CDK + TypeScript.

Pre-requisites

• Install AWS CLI

• Install CDK CLI

Getting Started

Run the following commands to install dependencies, build the CDK stack, and deploy the CDK Stack to AWS.

yarn install
yarn --cwd ./src/heartbeat install
yarn build
cdk bootstrap --profile=castle // or whatever AWS profile you're using
cdk deploy --profile=castle // or whatever AWS profile you're using

Environment Variables

We need to define a few environment variables for the cdk-deploy GitHub Action to work:

• AWS_ACCESS_KEY_ID - The access key ID for the heartbeat-deploy IAM user
• AWS_SECRET_ACCESS_KEY - The secret access key for the heartbeat-deploy IAM user
• AWS_REGION - The AWS region to which the resulting Cloudformation stack is deployed. We currently only deploy to us-east-1
• DATADOG_API_KEY - Datadog API key for Lambda logging + monitoring

Scripts

• yarn install - installs dependencies
• yarn build - builds the production-ready CDK Stack
• yarn test - runs Jest
• cdk bootstrap - bootstraps AWS Cloudformation for your CDK deploy
• cdk deploy - deploys the CDK stack to AWS

Built with

• TypeScript
• Jest
• AWS CDK
• AWS Lambda

Additional Resources

• CDK API Reference
• CDK TypeScript Reference
• CDK Assertion Package
• CDK Datadog Constructs
• awesome-cdk repo

License

Closed source.

Built with ❤️ by Castle Labs