You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: aws/owen-infra/README.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ The OWEN infrastructure stack was designed to scale easily. In file `aws/owen-in
32
32
33
33
### Account Abstraction
34
34
35
-
By default, the OWEN infrastructure is configured so that all DDEX messages are batched and sent from one address. Set this address in `aws/owen-infra/template-config-prod.json` => `SeoaAddress`. This should be the address of your EOA delegated to our smart account implementation. Instructions on how to perform this delegation can be found here: <TODO>.
35
+
By default, the OWEN infrastructure is configured so that all DDEX messages are batched and sent from one address. Set this address in `aws/owen-infra/template-config-prod.json` => `SeoaAddress`. This should be the address of your EOA delegated to our smart account implementation. Instructions on how to perform this delegation can be found here: TOADD
36
36
37
37
### KMS integration
38
38
@@ -44,7 +44,7 @@ Several private keys are required for this infrastructure to operate:
44
44
By default, all of these keys are created during deployment as dedicated KMS key pairs. This maintains a clear separation of responsibilities but requires additional configuration before use.
45
45
46
46
**_Use without KMS_** <br>
47
-
If you prefer not to use separate KMS keys for each instance and for the batch sender, change `USE_KMS` to false in:
47
+
If you prefer not to use separate KMS keys for each instance and for the batch sender, change `USE_KMS` to `false` in:
48
48
49
49
-`aws/owen-infra/resources/owen.yml`
50
50
-`aws/owen-infra/resources/owen-blobs-queue.yml`
@@ -54,14 +54,14 @@ Then store a single private key in Secrets Manager (see `Setting Secrets`).
54
54
However:
55
55
56
56
- you must still register the associated public key in the Protocol’s whitelist
57
-
- you must still grant it the BLOB_SENDER_ROLE. See here: <TODO>
57
+
- you must still grant it the `BLOB_SENDER_ROLE`. See here: TOADD
58
58
59
59
**_Use with KMS_** <br>
60
60
If you choose to use KMS, complete the following additional steps:
61
61
Because OWEN instances sign requests to the Protocol's IPFS bridge using unique KMS private keys, each corresponding public address must be registered on the Protocol’s whitelist.
62
62
63
63
1. In your [AWS Console](https://console.aws.amazon.com/) go to: `KMS → Customer managed keys`. Locate the keys associated with your OWEN Lambdas (visible in resource descriptions) and with `BlobsBatchSender`. Alternatively, inspect the Lambdas’ `SIGNER_KMS_ID` environment variable.
64
-
2. Resolve each key locally to obtain its public key: `[INSTRUCTIONS](https://luhenning.medium.com/the-dark-side-of-the-elliptic-curve-signing-ethereum-transactions-with-aws-kms-in-javascript-83610d9a6f81)`
64
+
2. Resolve each key locally to obtain its public key: [INSTRUCTIONS](https://luhenning.medium.com/the-dark-side-of-the-elliptic-curve-signing-ethereum-transactions-with-aws-kms-in-javascript-83610d9a6f81)
65
65
3. Send all public addresses of OWEN to The Protocol so we can register them
66
66
4. If not done already during sEOA delegation, grant `BLOB_SENDER_ROLE` to the public address of `BlobsBatchSender`.
67
67
@@ -76,10 +76,6 @@ Set:
76
76
77
77
## Trigger file
78
78
79
-
You enqueue messages for processing by upload them to your newly created S3 bucket: `ddex-messages-prod`.
80
-
Each message should be in separate message folder with optional resources like images in the subfolders.
81
-
By default, to trigger the flow of digesting and processing the message you should also include a special file in the message folder. The filenanme should start with `BatchComplete_` and can be 0 bytes and should be uploaded as the last item in the folder to avoid triggering the flow before the whole folder is uploaded. You can define the pattern of the trigger file name here: `aws/owen-infra/template-config-prod.json` => `TriggerFilePattern`
82
-
83
79
To enqueue a message for processing, upload it to the S3 bucket: `ddex-messages-prod`.
84
80
Each message should be placed in a separate folder; optional assets such as images can go in subfolders.
85
81
@@ -101,7 +97,7 @@ Depending on which option you choose, it will be either:
101
97
102
98
# 3. HOW TO USE IT TO SEND DDEX MESSAGES
103
99
104
-
After deploying and configuring your stack, and after assigning the correct roles to your sEOA, you can begin sending DDEX messages. Upload each message (in its own folder) to the `ddex-messages-prod bucket`.
105
-
Make sure each folder includes a trigger file as described earlier in `Trigger file`.
100
+
After deploying and configuring your stack, and after assigning the correct roles to your sEOA, you can begin sending DDEX messages. Upload each message (in its own folder) to the `ddex-messages-prod` bucket.
101
+
Make sure each folder includes a trigger file as described earlier in `Trigger file` section.
106
102
107
103
You can monitor processing progress in the DynamoDB table (default name: `DdexMessageStatusProd`).
0 commit comments