aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2026-01-09 00:24:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:breez/nodeless-payments

Browse Source
This commit is contained in:
Aljaz Ceru
2025-02-20 17:35:13 -06:00
parent cbf733c301 2b303962c5
commit 9e9ccf3bc6
1 changed files with 18 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -15,9 +15,9 @@ 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)
- 12 word BIP 39 seed
- [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 words BIP 39 seed (TBA: use Misty Breez to generate it)
## Deployment
Deployment to AWS with [cloudformation](./cloudformation.yaml).
@@ -49,45 +49,33 @@ Default output format [None]:
```
### Create SSM parameters for Breez credentials
From the command line, run the following commands:
```
aws ssm put-parameter --name "/breez-nodeless/api_key" --value "<REPLACE_WITH_BREEZ_API_KEY>" --type SecureString
```
aws ssm put-parameter \
--name "/breez-nodeless/api_key" \
--value "<REPLACE_WITH_BREEZ_API_KEY>" \
--type SecureString
aws ssm put-parameter \
--name "/breez-nodeless/seed_phrase" \
--value "<REPLACE_WITH_SEED_WORDS>" \
--type SecureString
```
aws ssm put-parameter --name "/breez-nodeless/seed_phrase" --value "<REPLACE_WITH_SEED_WORDS>" --type SecureString
```
aws ssm put-parameter \
--name "/breez-nodeless/api_secret" \
--value "<REPLACE_WITH_DESIRED_API_AUTHENTICATION_KEY>" \
--type SecureString
```
aws ssm put-parameter --name "/breez-nodeless/api_secret" --value "<REPLACE_WITH_DESIRED_API_AUTHENTICATION_KEY>" --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 will look like this:
Output should look like this:
```
root@2edec8635e65:/# aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].Outputs'
[
@@ -116,4 +104,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.
API_KEY is the secret you set at the begining.