This is a proof of concept implementation for deploying the Breez SDK (Nodeless implementation) as a lambda function to AWS. It provides a REST api with close to zero cost of hosting.

Currently implemented endpoints:

/send_payment (bolt11)
/receive_payment (bolt11)
/list_payments

API Key Security

X-API-KEY header serves as authorization method for accessing the API. Anyone that knows the API url and API_SECRET can access your funds, so make sure to protect this secret and to generate a unique and long string. You can use generators like this or this.
Encrypted secrets are stored in AWS Parameter Store and are accessed each time any endpoint is called (in the background docker container is started for each REST API call).

Requirements for deployment

AWS cli
Access to AWS account
Breez SDK - Nodeless implementation API key
12 words BIP 39 seed (TBA: use Misty Breez to generate it)

Deployment

Deployment to AWS with cloudformation.

Install CLI

Follow AWS guide to install it on your computer.

Create credentials

There are several ways of creating credentials to deploy in AWS. Ideally, you want to generate temporary credentials that are gonna be revoked after this deployment. You can create create credentials that have the same permissions as your root account. This will enable you to run all the CLI commands. Follow these steps to create an access key:

Select Security Credentials from your account's menu:
Follow the steps to create an access key:

Configure CLI

Now that you have aws cli installed and credentials ready its time for the last step of the requirements -> configuring the aws cli to work with your account.

You will also have to chose a default region where you want to deploy your api. You can see the list of all regions here. You should pick the region that is closest to your business. For quick reference US (us-east-1,us-west-1), Europe (eu-central-1,eu-west-1), Latam (sa-east-1), Asia (ap-southeast-1).

Once you have api key, api secret and you've chosen the region you want to deploy to you're ready to configure the cli.

Open terminal in your OS and type aws configure and press enter. Now copy/paste the api key, press enter, and copy/paste the secret and press enter do the same for region. You can leave the default output format blank..

# aws configure
AWS Access Key ID [None]: AKIA44HIGHQYZHRTZ7WP
AWS Secret Access Key [None]: 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
Default region name [None]: us-east-1
Default output format [None]:

Get cloudformation.yaml

Either clone this repository with git

git clone https://github.com/breez/nodeless-payments.git

or download just cloudformation.yaml.

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/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

Deploy Cloudformation stack

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

aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].Outputs'

Output should look like this:

root@2edec8635e65:/# aws cloudformation describe-stacks     --stack-name breez-integration     --query 'Stacks[0].Outputs'
[
    {
        "OutputKey": "ApiGatewayBaseURL",
        "OutputValue": "https://yxzjorems5.execute-api.us-east-1.amazonaws.com/prod",
        "Description": "Base URL for API Gateway"
    },
    {
        "OutputKey": "SendEndpoint",
        "OutputValue": "https://yxzjorems5.execute-api.us-east-1.amazonaws.com/prod/send_payment",
        "Description": "Send endpoint URL"
    },
    {
        "OutputKey": "PaymentsEndpoint",
        "OutputValue": "https://yxzjorems5.execute-api.us-east-1.amazonaws.com/prod/list_payments",
        "Description": "Payments endpoint URL"
    },
    {
        "OutputKey": "ReceiveEndpoint",
        "OutputValue": "https://yxzjorems5.execute-api.us-east-1.amazonaws.com/prod/receive_payment",
        "Description": "Receive endpoint URL"
    }
]

If the deploy was successful you should deactivate your api key now.

Example usage

Python

You can use example-client.pyfile from this to test the functionality. Take Base URL from the output of last command (example above) and API_SECRET and edit the example-client.py with correct values

API_URL = "YOUR-URL-HERE"
API_KEY = "YOUR-SECRET-HERE"

For example-client to work you need to have python installed together with requests library

pip install requests

curl

If you don't have python installed you can also just run a curl command (should work on macos/linux).

example for list_payments endpoint:

curl -X POST "<YOUR-URL-HERE>/list_payments" \
     -H "Content-Type: application/json" \
     -H "x-api-key: YOUR_API_SECRET" \
     -d '{}'