Skip to content

Commit 3fd5c0f

Browse files
Merge pull request #337 from originalworks/owen-infra-readme-spelling-mistakes
OWEN infra README file - spelling
2 parents ae7ceca + 3ccc0fd commit 3fd5c0f

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

aws/owen-infra/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The OWEN infrastructure stack was designed to scale easily. In file `aws/owen-in
3232

3333
### Account Abstraction
3434

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
3636

3737
### KMS integration
3838

@@ -44,7 +44,7 @@ Several private keys are required for this infrastructure to operate:
4444
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.
4545

4646
**_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:
4848

4949
- `aws/owen-infra/resources/owen.yml`
5050
- `aws/owen-infra/resources/owen-blobs-queue.yml`
@@ -54,14 +54,14 @@ Then store a single private key in Secrets Manager (see `Setting Secrets`).
5454
However:
5555

5656
- 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
5858

5959
**_Use with KMS_** <br>
6060
If you choose to use KMS, complete the following additional steps:
6161
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.
6262

6363
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)
6565
3. Send all public addresses of OWEN to The Protocol so we can register them
6666
4. If not done already during sEOA delegation, grant `BLOB_SENDER_ROLE` to the public address of `BlobsBatchSender`.
6767

@@ -76,10 +76,6 @@ Set:
7676

7777
## Trigger file
7878

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-
8379
To enqueue a message for processing, upload it to the S3 bucket: `ddex-messages-prod`.
8480
Each message should be placed in a separate folder; optional assets such as images can go in subfolders.
8581

@@ -101,7 +97,7 @@ Depending on which option you choose, it will be either:
10197

10298
# 3. HOW TO USE IT TO SEND DDEX MESSAGES
10399

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.
106102

107103
You can monitor processing progress in the DynamoDB table (default name: `DdexMessageStatusProd`).

0 commit comments

Comments
 (0)