Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasochem committed Feb 10, 2024
1 parent 051a9bf commit 1733a1a
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ In Beta - use at own risk.

A suite of Serverless apps to sign Tezos Operations on AWS.

These Serverless Apps are available in Amazon's Serverless Application Repository.

Install from the AWS Web console with just a few clicks. No instances, no command-line interface.

## Useful Links
Expand All @@ -17,9 +19,13 @@ Install from the AWS Web console with just a few clicks. No instances, no comman
| - | - | - |
| Purpose | Sign any operation, for example Tezos Baker Payout Operations | Sign Consensus Messages Only |
| Security | Medium 🟠 | High 🟢 |
| Key stored in | Amazon Secrets Manager | Amazon KMS |
| Key import/export | Yes | No |
| High Watermark Protection | No | Yes |
| Lines of code (including dependencies) | 402,070 🟠 | 18,685 🟢 |
| Tezos Supported Key Types | `tz1`, `tz2`, `tz3`, `tz4` | `tz2` only |
| Go To Serverless App | [Tezos In-Memory Signer](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-in-memory-signer) ↗️ | [Tezos Consensus KMS Signer](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-consensus-kms-signer) ↗️ |


<!-- Line of code calculation:
nochem@peck ~/workspace/tezos-serverless-signer-apps () $ (find in-memory-signer/taquito-signer in-memory-signer/taquito-signer/node_modules -type f \( -name "*.js" -o -name "*.mjs" \) | xargs cat) | wc -l
Expand All @@ -46,12 +52,6 @@ See Guide: [How to switch your Tezos Baker to a Cloud KMS Setup](https://midl-de

Read more on the [Medium article introducing the project](https://midl-dev.medium.com/tezos-consensus-signing-with-aws-lambda-dynamodb-and-kms-d6e1da85dc62).

### Ease of deployment

These Serverless Apps are available in Amazon's Serverless Application Repository:

* [Tezos In-Memory Signer](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-in-memory-signer)
* [Tezos Consensus KMS Signer](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-consensus-kms-signer)

# Brought to you by MIDL.dev

Expand Down
4 changes: 3 additions & 1 deletion consensus-kms-signer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Read more on the [Medium article introducing the project](https://midl-dev.mediu

Deploy from [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-consensus-kms-signer).

# Brought to you by MIDL.dev
For detailed instructions, see: [how to switch your Tezos Baker to a Cloud KMS Setup](https://midl-dev.github.io/tezos-serverless-signer-apps/).

# Brought to you by [MIDL.dev](https://midl.dev)

We can help you deploy and manage a complete Tezos baking operation. [Hire us](https://midl.dev/tezos).
2 changes: 1 addition & 1 deletion in-memory-signer/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 MIDLDEV OU
Copyright (c) 2023-2024 MIDLDEV OU

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion in-memory-signer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ It is pretty rudimentary and does not offer any filtering. However, for consensu

Deploy from the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/us-east-2/030073751340/tezos-in-memory-signer).

# Brought to you by MIDL.dev
# Brought to you by [MIDL.dev](https://midl.dev)

We can help you deploy and manage a complete Tezos baking operation. [Hire us](https://midl.dev/tezos).
14 changes: 13 additions & 1 deletion in-memory-signer/packaged.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Metadata:
LastUpdated: '2024-01-28'
Description: An app to sign Tezos Operations.
SpdxLicenseId: MIT
ReadmeUrl: s3://tezos-serverless-signer-apps/0cf4c01115177da06fea2d1b367488a9
ReadmeUrl: s3://tezos-serverless-signer-apps/9857cd37f901f3f30a1f16fc5839a3ba
LicenseUrl: s3://tezos-serverless-signer-apps/b9f7ccd279c5f1881715bae350dff0b5
Labels:
- cryptocurrency
Expand Down Expand Up @@ -288,6 +288,18 @@ Resources:
Metadata:
SamResourceId: ApiGatewayStage
Outputs:
PublicKey:
Description: Signer Public Key
Value:
Fn::GetAtt:
- SignerLambdaEnv
- publicKey
PublicKeyHash:
Description: Signer Public Key Hash
Value:
Fn::GetAtt:
- SignerLambdaEnv
- publicKeyHash
SignerURL:
Description: Secret Signer URL
Value:
Expand Down
8 changes: 8 additions & 0 deletions in-memory-signer/template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,14 @@ Resources:
DeploymentId: !Ref ApiGatewayDeployment

Outputs:
PublicKey:
Description: "Signer Public Key"
Value: !GetAtt SignerLambdaEnv.publicKey

PublicKeyHash:
Description: "Signer Public Key Hash"
Value: !GetAtt SignerLambdaEnv.publicKeyHash

SignerURL:
Description: "Secret Signer URL"
Value:
Expand Down

0 comments on commit 1733a1a

Please sign in to comment.