Merge pull request #194 from input-output-hk/nhenin/fixDoc

fixed Roles Configuration Documentation
input-output-hk · May 20, 2024 · 1242de8 · 1242de8
2 parents 32b736a + 84238aa
commit 1242de8
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/packages/runtime/lifecycle/src/generic/contracts.ts b/packages/runtime/lifecycle/src/generic/contracts.ts
@@ -140,11 +140,11 @@ export interface CreateContractRequestBase {
    *   { "closed_Role_A_NFT" : mintRole(anAddressBech32)
    *   , "closed_Role_B_FT" :
    *        mintRole(
-   *          anAddressBech32,
+   *          anAddressBech32, // Closed Role Token
    *          5, // Quantities
    *          { "name": "closed_Role_B_FT Marlowe Role Token",
    *            "description": "These are metadata for closedRoleB",
-   *            image": "ipfs://QmaQMH7ybS9KmdYQpa4FMtAhwJH5cNaacpg4fTwhfPvcwj",
+   *            "image": "ipfs://QmaQMH7ybS9KmdYQpa4FMtAhwJH5cNaacpg4fTwhfPvcwj",
    *            "mediaType": "image/png",
    *            "files": [
    *                {
@@ -154,12 +154,13 @@ export interface CreateContractRequestBase {
    *                }
    *              ]
    *          })
-   *   , "open_Role_C" : mkMintOpenRoleToken()
-   *   , "open_Role_D" : mkMintOpenRoleToken(
+   *   , "open_Role_C" : mintRole("OpenRole")
+   *   , "open_Role_D" : mintRole(
+   *          "OpenRole", // Open Role Token
    *          2, // Quantities
    *          { "name": "open_Role_D Marlowe Role Token",
    *            "description": "These are metadata for closedRoleB",
-   *            image": "ipfs://QmaQMH7ybS9KmdYQpa4FMtAhwJH5cNaacpg4fTwhfPvcwj",
+   *            "image": "ipfs://QmaQMH7ybS9KmdYQpa4FMtAhwJH5cNaacpg4fTwhfPvcwj",
    *            "mediaType": "image/png",
    *            "files": [
    *                {