Merge pull request #128 from input-output-hk/PLT-7701

PLT-7701, PLT-7702, PLT-7703, PLT-8427: Implement remaining 1-1 endpoints

changelog.d/20231213_145052_bjorn.wilhelm.kihlberg_PLT_7701.md

@@ -0,0 +1,6 @@
+### @marlowe.io/runtime-rest-client
+
+- PLT-7701: Extend the rest client with procedure `getContractSourceById`. (Implemented in [PR-128](https://github.com/input-output-hk/marlowe-ts-sdk/pull/128))
+- PLT-7702: Extend the rest client with procedure `getContractSourceAdjacency`. (Implemented in [PR-128](https://github.com/input-output-hk/marlowe-ts-sdk/pull/128))
+- PLT-7703: Extend the rest client with procedure `getContractSourceClosure`. (Implemented in [PR-128](https://github.com/input-output-hk/marlowe-ts-sdk/pull/128))
+- PLT-8427: Extend the rest client with procedure `getNextStepsForContract`. (Implemented in [PR-128](https://github.com/input-output-hk/marlowe-ts-sdk/pull/128))

examples/js/poc-helpers.js

@@ -39,7 +39,7 @@ export function logJSON(message, json) {
 export function getRuntimeUrl() {
   const runtimeUrlInput = document.getElementById("runtimeUrl");
   return (
-    runtimeUrlInput.value ||
+    (runtimeUrlInput && runtimeUrlInput.value) ||
     "https://marlowe-runtime-preprod-web.demo.scdev.aws.iohkdev.io/"
   );
 }

examples/rest-client-flow/index.html

@@ -135,6 +135,43 @@ <h2>Request</h2>
         >/contracts/:contractId/transactions/:transactionId</a
       >
       <br />
+      <input
+        id="getContractSourceById"
+        type="button"
+        value="Get contract source by contract Source id"
+        class="endpoint"
+      />
+      GETs contract source by contract Source ID
+      <a
+        href="https://input-output-hk.github.io/marlowe-ts-sdk/interfaces/_marlowe_io_runtime_rest_client.index.RestClient.html#getContractSourceById"
+        >/contracts/sources/:contractSourceId</a
+      >
+      <br />
+      <input
+        id="getContractSourceAdjacency"
+        type="button"
+        value="Get adjacent contract Source IDs"
+        class="endpoint"
+      />
+      GETs the contract Source IDs which are adjacent to a contract
+      <a
+        href="https://input-output-hk.github.io/marlowe-ts-sdk/interfaces/_marlowe_io_runtime_rest_client.index.RestClient.html#getContractSourceAdjacency"
+        >/contracts/sources/:contractSourceId/adjacency</a
+      >
+      <br />
+      <input
+        id="getContractSourceClosure"
+        type="button"
+        value="Get contract Source IDs in contract"
+        class="endpoint"
+      />
+      GETs the contract Source IDs which appear in the full hierarchy of a
+      contract source
+      <a
+        href="https://input-output-hk.github.io/marlowe-ts-sdk/interfaces/_marlowe_io_runtime_rest_client.index.RestClient.html#getContractSourceClosure"
+        >/contracts/sources/:contractSourceId/closure</a
+      >
+      <br />
     </div>
 
     <h2>Console</h2>

packages/marlowe-object/src/index.ts

@@ -1,6 +1,11 @@
 export { Action, Deposit, Notify, Choice } from "./actions.js";
 export { ChoiceName, ChoiceId, Bound, ChosenNum } from "./choices.js";
-export { Reference, Label } from "./reference.js";
+export {
+  Reference,
+  Label,
+  ContractSourceId,
+  ContractSourceIdGuard,
+} from "./reference.js";
 export { Address, Role, Party } from "./participants.js";
 export { Payee, PayeeAccount, PayeeParty, AccountId } from "./payee.js";
 

packages/marlowe-object/src/reference.ts

@@ -8,6 +8,14 @@ export type Label = string;
 
 export const LabelGuard: t.Type<Label> = t.string;
 
+/**
+ * A label for one of the {@link ObjectType}
+ * @category Object
+ */
+export type ContractSourceId = string;
+
+export const ContractSourceIdGuard: t.Type<ContractSourceId> = t.string;
+
 /**
  * A reference to an {@link ObjectType}.
  * @category Object
@@ -20,4 +28,6 @@ export interface Reference {
  * {@link !io-ts-usage | Dynamic type guard} for the {@link Reference | reference type}.
  * @category Object
  */
-export const ReferenceGuard: t.Type<Reference> = t.type({ ref: t.string });
+export const ReferenceGuard: t.Type<Reference> = t.type({
+  ref: ContractSourceIdGuard,
+});

packages/runtime/client/rest/src/contract/endpoints/sources.ts

@@ -4,21 +4,26 @@ import * as E from "fp-ts/lib/Either.js";
 import { pipe } from "fp-ts/lib/function.js";
 import { formatValidationErrors } from "jsonbigint-io-ts-reporters";
 
-import { BuiltinByteString } from "@marlowe.io/language-core-v1";
-import { Bundle, Label } from "@marlowe.io/marlowe-object";
+import { Contract } from "@marlowe.io/language-core-v1";
+import {
+  Bundle,
+  Label,
+  ContractSourceId,
+  ContractSourceIdGuard,
+} from "@marlowe.io/marlowe-object";
 import { AxiosInstance } from "axios";
 
 export interface CreateContractSourcesResponse {
-  contractSourceId: BuiltinByteString;
+  contractSourceId: ContractSourceId;
   intermediateIds: {
-    [key: Label]: BuiltinByteString;
+    [key: Label]: ContractSourceId;
   };
 }
 
 const CreateContractSourcesResponseGuard: t.Type<CreateContractSourcesResponse> =
   t.type({
-    contractSourceId: G.BuiltinByteString,
-    intermediateIds: t.record(t.string, G.BuiltinByteString),
+    contractSourceId: ContractSourceIdGuard,
+    intermediateIds: t.record(t.string, ContractSourceIdGuard),
   });
 
 export const createContractSources = (axiosInstance: AxiosInstance) => {
@@ -40,3 +45,94 @@ export const createContractSources = (axiosInstance: AxiosInstance) => {
     );
   };
 };
+
+export interface GetContractBySourceIdRequest {
+  contractSourceId: ContractSourceId;
+  expand?: boolean;
+}
+
+export type GetContractBySourceIdResponse = Contract;
+
+const GetContractBySourceIdResponseGuard: t.Type<GetContractBySourceIdResponse> =
+  G.Contract;
+
+export const getContractSourceById =
+  (axiosInstance: AxiosInstance) =>
+  async ({
+    contractSourceId,
+    expand,
+  }: GetContractBySourceIdRequest): Promise<GetContractBySourceIdResponse> => {
+    const response = await axiosInstance.get(
+      `/contracts/sources/${encodeURIComponent(contractSourceId)}`,
+      { params: { expand } }
+    );
+    return pipe(
+      GetContractBySourceIdResponseGuard.decode(response.data),
+      E.match(
+        (e) => {
+          throw formatValidationErrors(e);
+        },
+        (e) => e
+      )
+    );
+  };
+
+export interface GetContractSourceAdjacencyRequest {
+  contractSourceId: ContractSourceId;
+}
+
+export interface GetContractSourceAdjacencyResponse {
+  results: ContractSourceId[];
+}
+
+const GetContractSourceAdjacencyResponseGuard: t.Type<GetContractSourceAdjacencyResponse> =
+  t.type({ results: t.array(ContractSourceIdGuard) });
+
+export const getContractSourceAdjacency =
+  (axiosInstance: AxiosInstance) =>
+  async ({
+    contractSourceId,
+  }: GetContractSourceAdjacencyRequest): Promise<GetContractSourceAdjacencyResponse> => {
+    const response = await axiosInstance.get(
+      `/contracts/sources/${encodeURIComponent(contractSourceId)}/adjacency`
+    );
+    return pipe(
+      GetContractSourceAdjacencyResponseGuard.decode(response.data),
+      E.match(
+        (e) => {
+          throw formatValidationErrors(e);
+        },
+        (e) => e
+      )
+    );
+  };
+
+export interface GetContractSourceClosureRequest {
+  contractSourceId: ContractSourceId;
+}
+
+export interface GetContractSourceClosureResponse {
+  results: ContractSourceId[];
+}
+
+const GetContractSourceClosureResponseGuard: t.Type<GetContractSourceClosureResponse> =
+  t.type({ results: t.array(ContractSourceIdGuard) });
+
+export const getContractSourceClosure =
+  (axiosInstance: AxiosInstance) =>
+  async ({
+    contractSourceId,
+  }: GetContractSourceClosureRequest): Promise<GetContractSourceClosureResponse> => {
+    const response = await axiosInstance.get(
+      `/contracts/sources/${encodeURIComponent(contractSourceId)}/closure`
+    );
+    return pipe(
+      GetContractSourceClosureResponseGuard.decode(response.data),
+      E.match(
+        (e) => {
+          throw formatValidationErrors(e);
+        },
+        (e) => e
+      )
+    );
+  };

packages/runtime/client/rest/src/contract/next/endpoint.ts

@@ -40,3 +40,48 @@ export const getViaAxios: (axiosInstance: AxiosInstance) => GET =
 
 const contractNextEndpoint = (contractId: ContractId): string =>
   `/contracts/${encodeURIComponent(unContractId(contractId))}/next`;
+
+export interface GetNextStepsForContractRequest {
+  contractId: ContractId;
+  validityStart: bigint;
+  validityEnd: bigint;
+  parties?: Party[];
+}
+
+export type GetNextStepsForContractResponse = Next;
+
+const GetNextStepsForContractResponseGuard = Next;
+
+export const getNextStepsForContract =
+  (axiosInstance: AxiosInstance) =>
+  async ({
+    contractId,
+    validityStart,
+    validityEnd,
+    parties,
+  }: GetNextStepsForContractRequest): Promise<GetNextStepsForContractResponse> => {
+    const response = await axiosInstance.get(
+      `/contracts/${encodeURIComponent(
+        unContractId(contractId)
+      )}/next?${stringify({
+        validityStart: posixTimeToIso8601(validityStart),
+        validityEnd: posixTimeToIso8601(validityEnd),
+        party: parties,
+      })}`,
+      {
+        headers: {
+          Accept: "application/json",
+          "Content-Type": "application/json",
+        },
+      }
+    );
+    return pipe(
+      GetNextStepsForContractResponseGuard.decode(response.data),
+      E.match(
+        (e) => {
+          throw formatValidationErrors(e);
+        },
+        (e) => e
+      )
+    );
+  };