From 869ad2be56befe5c96afd9dd81848d1c5df3813d Mon Sep 17 00:00:00 2001 From: Roy Sheinfeld <31890660+kingonly@users.noreply.github.com> Date: Thu, 20 Feb 2025 15:05:51 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6167a88..d28e354 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ Currently implemented endpoints: ## Requirements for deployment - [AWS cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) -- Access to AWS account -- [Breez nodeless api key](https://breez.technology/request-api-key/#contact-us-form-sdk) +- [Access to AWS account](https://signin.aws.amazon.com/signup?request_type=register) +- [Breez SDK - Nodeless implementation API key](https://breez.technology/request-api-key/#contact-us-form-sdk) - 12 word BIP 39 seed ## Deployment @@ -92,4 +92,4 @@ root@2edec8635e65:/# aws cloudformation describe-stacks --stack-name breez-i ``` ### Example usage You can use example-client.py to test the functionality. Take Base URL from the above output and put it in API_URL in example-client.py -API_KEY is the secret you set at the begining. \ No newline at end of file +API_KEY is the secret you set at the begining. From b89535068007d10c21422eb5091fbd0087ecf64a Mon Sep 17 00:00:00 2001 From: Roy Sheinfeld <31890660+kingonly@users.noreply.github.com> Date: Thu, 20 Feb 2025 15:30:09 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d28e354..d136c7b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Currently implemented endpoints: - [AWS cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) - [Access to AWS account](https://signin.aws.amazon.com/signup?request_type=register) - [Breez SDK - Nodeless implementation API key](https://breez.technology/request-api-key/#contact-us-form-sdk) -- 12 word BIP 39 seed +- 12 words BIP 39 seed (TBA: use Misty Breez to generate it) ## Deployment Deployment to AWS with [cloudformation](./cloudformation.yaml). @@ -25,17 +25,22 @@ Deployment to AWS with [cloudformation](./cloudformation.yaml). Follow [AWS guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) to install and configure cli. ### Create SSM parameters for Breez credentials +From the command line, run the following commands: ``` aws ssm put-parameter \ --name "/breez-nodeless/api_key" \ --value "" \ --type SecureString +``` +``` aws ssm put-parameter \ --name "/breez-nodeless/seed_phrase" \ --value "" \ --type SecureString +``` +``` aws ssm put-parameter \ --name "/breez-nodeless/api_secret" \ --value "" \ @@ -47,13 +52,13 @@ aws cloudformation create-stack \ --stack-name breez-integration \ --template-body file://cloudformation.yaml \ --capabilities CAPABILITY_IAM +``` +``` # Monitor the stack creation. At the begining it will return "CREATE_IN_PROGRESS", you have to wait until it changes to "CREATE_COMPLETE" aws cloudformation describe-stacks \ --stack-name breez-integration \ --query 'Stacks[0].StackStatus' - - ``` ### Retrieve the API endpoints after successful deployment @@ -61,9 +66,8 @@ aws cloudformation describe-stacks \ aws cloudformation describe-stacks \ --stack-name breez-integration \ --query 'Stacks[0].Outputs' - ``` -Output will look like this: +Output should look like this: ``` root@2edec8635e65:/# aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].Outputs' [ From 2b303962c57512f922a0b168ebea72810b7f3da4 Mon Sep 17 00:00:00 2001 From: Roy Sheinfeld <31890660+kingonly@users.noreply.github.com> Date: Thu, 20 Feb 2025 15:32:56 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 28 ++++++---------------------- 1 file changed, 6 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d136c7b..4051496 100644 --- a/README.md +++ b/README.md @@ -27,45 +27,29 @@ Follow [AWS guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-star ### Create SSM parameters for Breez credentials From the command line, run the following commands: ``` -aws ssm put-parameter \ - --name "/breez-nodeless/api_key" \ - --value "" \ - --type SecureString +aws ssm put-parameter --name "/breez-nodeless/api_key" --value "" --type SecureString ``` ``` -aws ssm put-parameter \ - --name "/breez-nodeless/seed_phrase" \ - --value "" \ - --type SecureString +aws ssm put-parameter --name "/breez-nodeless/seed_phrase" --value "" --type SecureString ``` ``` -aws ssm put-parameter \ - --name "/breez-nodeless/api_secret" \ - --value "" \ - --type SecureString +aws ssm put-parameter --name "/breez-nodeless/api_secret" --value "" --type SecureString ``` ### Deploy Cloudformation stack ``` -aws cloudformation create-stack \ - --stack-name breez-integration \ - --template-body file://cloudformation.yaml \ - --capabilities CAPABILITY_IAM +aws cloudformation create-stack --stack-name breez-integration --template-body file://cloudformation.yaml --capabilities CAPABILITY_IAM ``` ``` # Monitor the stack creation. At the begining it will return "CREATE_IN_PROGRESS", you have to wait until it changes to "CREATE_COMPLETE" -aws cloudformation describe-stacks \ - --stack-name breez-integration \ - --query 'Stacks[0].StackStatus' +aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].StackStatus' ``` ### Retrieve the API endpoints after successful deployment ``` -aws cloudformation describe-stacks \ - --stack-name breez-integration \ - --query 'Stacks[0].Outputs' +aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].Outputs' ``` Output should look like this: ```