From 68080b61b3859c9cd77c0c19a5174c0cb54c1f73 Mon Sep 17 00:00:00 2001 From: Shreerang Kale Date: Fri, 25 Jul 2025 18:04:45 +0530 Subject: [PATCH] Add more prose to readme for publishing records --- deploy/README.md | 11 +++++----- deploy/publish-pricing.md | 20 +++++++++---------- deploy/{ => records}/alnt-pricing.yml | 0 .../webapp-deployment-pricing.yml | 0 4 files changed, 15 insertions(+), 16 deletions(-) rename deploy/{ => records}/alnt-pricing.yml (100%) rename deploy/{ => records}/webapp-deployment-pricing.yml (100%) diff --git a/deploy/README.md b/deploy/README.md index 6b8f8e5..5ac2ef3 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -21,7 +21,9 @@ - Configure `userKey` and `bondId` in the [registry CLI config](./config.yml): - NOTE: The bond id should be set as authority bond of `laconic-deploy` and user key should be of the account that owns the `laconic-deploy` authority (owner account address: `laconic1kwx2jm6vscz38qlyujvq6msujmk8l3zangqahs`) + - User key should be of the account that owns the `laconic-deploy` authority (owner account address: `laconic1kwx2jm6vscz38qlyujvq6msujmk8l3zangqahs`) + - The bond should also be owned by same user (owned bond's ID: `230cfedda15e78edc8986dfcb870e1b618f65c56e38d2735476d2a8cb3f25e38`) + - If the authority is not available, follow [these steps to reserve a new authority](./publish-pricing.md#reserve-a-new-authority-optional) ```bash nano config.yml @@ -29,11 +31,6 @@ - This project requires pricing records for cost of deployment and cost of alnt to be published - - Cost of deployment: `lrn://laconic/pricing/webapp-deployment` - - Cost of alnt: `lrn://laconic/pricing/alnt` - - If these records are not available, [follow these steps to publish them](./publish-pricing.md) - - Check if these records are available by running following commands: ```bash @@ -44,6 +41,8 @@ ./laconic-cli.sh name resolve lrn://laconic/pricing/alnt ``` + - If these records are not available, [follow these steps to publish them](./publish-pricing.md) + - Add configuration for registry operations: ```bash diff --git a/deploy/publish-pricing.md b/deploy/publish-pricing.md index d246425..c943dae 100644 --- a/deploy/publish-pricing.md +++ b/deploy/publish-pricing.md @@ -19,7 +19,7 @@ - Configure `userKey` in the [registry CLI config](./config.yml): - NOTE: User key should be of the account that owns the `laconic` authority (owner account address: `laconic13maulvmjxnyx3g855vk0lsv5aptf3rpxskynef`). If you don't have an authority check [steps to reserve a new authority](#reserve-a-new-authority-optional) + NOTE: The `laconic` authority is required to set the published record names so the user key should be of the account that owns the `laconic` authority (owner account address: `laconic13maulvmjxnyx3g855vk0lsv5aptf3rpxskynef`). If you don't have an authority check [steps to reserve a new authority](#reserve-a-new-authority-optional) ```bash nano config.yml @@ -27,9 +27,9 @@ ## Publish Record and Set Record Name -Publishing record requires a bond with enough funds (min. 10000000alnt ), if you don't have a bond check [steps to create bond](#create-bond-optional) +Publishing record requires a bond with enough funds as rent is taken for each record from the bond every year -To set record name an authority is required, if you don't have an authority check [steps to reserve a new authority](#reserve-a-new-authority-optional) +The rent amount taken is `1000000alnt` so maintaining a bond with about 10x the rent amount i.e `10000000alnt` is recommended Make sure, the record names are under `laconic` authority @@ -42,7 +42,7 @@ Make sure, the record names are under `laconic` authority - Publish the record: ```bash - ./laconic-cli.sh record publish --filename alnt-pricing.yml --bond-id + ./laconic-cli.sh record publish --filename records/alnt-pricing.yml --bond-id ``` - Get record info: @@ -51,9 +51,7 @@ Make sure, the record names are under `laconic` authority ./laconic-cli.sh record get --id ``` -### Set Record Name - -- Set record name for cost of alnt record +- Set record name for cost of alnt record: ```bash ./laconic-cli.sh name set lrn://laconic/pricing/alnt @@ -64,7 +62,7 @@ Make sure, the record names are under `laconic` authority - Publish the record: ```bash - ./laconic-cli.sh record publish --filename webapp-deployment-pricing.yml --bond-id + ./laconic-cli.sh record publish --filename records/webapp-deployment-pricing.yml --bond-id ``` - Get record info: @@ -73,8 +71,6 @@ Make sure, the record names are under `laconic` authority ./laconic-cli.sh record get --id ``` -### Set Record Name - - Set record name for cost of deployment record ```bash @@ -83,6 +79,8 @@ Make sure, the record names are under `laconic` authority - Now you should be able to use these records in the app +- You can now continue with [steps to deploy the app](./README.md) + ## Create Bond (optional) - Create bond: @@ -126,6 +124,8 @@ Below steps are used to reserve `laconic` authority - Commit an auction bid: ```bash + # 5000000 alnt is the minimum bid amount for authority auction + ./laconic-cli.sh auction bid commit 5000000 alnt # Example file path inside container diff --git a/deploy/alnt-pricing.yml b/deploy/records/alnt-pricing.yml similarity index 100% rename from deploy/alnt-pricing.yml rename to deploy/records/alnt-pricing.yml diff --git a/deploy/webapp-deployment-pricing.yml b/deploy/records/webapp-deployment-pricing.yml similarity index 100% rename from deploy/webapp-deployment-pricing.yml rename to deploy/records/webapp-deployment-pricing.yml