created new client/rest workspace

input-output-hk · Aug 21, 2023 · fce01e0 · fce01e0
1 parent a9f0ab4
commit fce01e0
Show file tree

Hide file tree

Showing 35 changed files with 83 additions and 65 deletions.
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "packages/adapter",
     "packages/language/core/v1",
     "packages/wallet",
+    "packages/client/rest",
     "packages/runtime"
   ],
   "devDependencies": {

diff --git a/packages/client/rest/Readme.md b/packages/client/rest/Readme.md
@@ -1,2 +1,2 @@
-# @marlowe.io/runtime
+# @marlowe.io/client-rest
 TODO
diff --git a/packages/client/rest/package.json b/packages/client/rest/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@marlowe.io/client-rest",
   "version": "0.1.0-beta",
-  "description": "TODO",
+  "description": "Client of Runtime REST API",
   "repository": "https://github.com/input-output-hk/marlowe-ts-sdk",
   "publishConfig": {
     "access": "public"
@@ -15,9 +15,7 @@
   "scripts": {
     "build": "tsc --build src",
     "clean": "tsc --build --clean src",
-    "test": "echo 'The client rest doesnt have unit tests'",
-    "test:e2e": "echo 'The client rest doesnt have e2e tests'",
-    "build:e2e": "echo 'The client rest doesnt have unit tests'"
+    "test": "echo 'The client rest doesnt have unit tests'"
   },
   "type": "module",
   "module": "./dist/index.js",
@@ -31,6 +29,14 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./transaction": {
+      "import": "./dist/contract/transaction/index.js",
+      "types": "./dist/contract/transaction/index.d.ts"
+    },
+    "./withdrawal": {
+      "import": "./dist/contract/withdrawal/index.js",
+      "types": "./dist/contract/withdrawal/index.d.ts"
+    },
     "./contract/*": "./dist/contract/*.js"
   },
   "dependencies": {

diff --git a/packages/client/rest/src/contract/details.ts b/packages/client/rest/src/contract/details.ts
@@ -3,7 +3,7 @@ import * as t from "io-ts/lib/index.js";
 import { Contract } from "@marlowe.io/language-core-v1";
 import { MarloweState } from "@marlowe.io/language-core-v1/state";
 import { MarloweVersion } from "@marlowe.io/language-core-v1/version";
-import { ContractId } from "./id.js";
+import { ContractId } from "@marlowe.io/core/marlowe";
 
 import { TxStatus } from "./transaction/status.js";
 

diff --git a/packages/client/rest/src/contract/endpoints/collection.ts b/packages/client/rest/src/contract/endpoints/collection.ts
@@ -23,7 +23,7 @@ import { Tag, Tags, Metadata, TextEnvelope, unAddressBech32, unTxOutRef, Address
 import { Header } from '../header.js';
 import { RolesConfig } from '../role.js';
 
-import { ContractId } from '../id.js';
+import { ContractId } from "@marlowe.io/core/marlowe";
 
 export interface ContractsRange extends Newtype<{ readonly ContractsRange: unique symbol }, string> {}
 export const ContractsRange = fromNewtype<ContractsRange>(t.string)

diff --git a/packages/client/rest/src/contract/endpoints/singleton.ts b/packages/client/rest/src/contract/endpoints/singleton.ts
@@ -14,7 +14,7 @@ import { DecodingError } from '@marlowe.io/adapter/codec';
 import { HexTransactionWitnessSet, transactionWitnessSetTextEnvelope } from '@marlowe.io/core/cardano';
 
 import { ContractDetails } from '../details.js';
-import { ContractId, unContractId } from '../id.js';
+import { ContractId, unContractId } from "@marlowe.io/core/marlowe";
 
 export type GET = ( contractId: ContractId) => TE.TaskEither<Error | DecodingError, ContractDetails>
 

diff --git a/packages/client/rest/src/contract/header.ts b/packages/client/rest/src/contract/header.ts
@@ -7,7 +7,7 @@ import { MarloweVersion } from "@marlowe.io/language-core-v1/version";
 import { BlockHeader, Metadata, PolicyId, Tags } from "@marlowe.io/core/cardano";
 
 import { TxStatus } from "./transaction/status.js";
-import { ContractId } from "./id.js";
+import { ContractId } from "@marlowe.io/core/marlowe";
 
 
 export type Header = t.TypeOf<typeof Header>

diff --git a/packages/client/rest/src/contract/next/endpoint.ts b/packages/client/rest/src/contract/next/endpoint.ts
@@ -4,7 +4,7 @@ import * as TE from 'fp-ts/lib/TaskEither.js'
 import { pipe } from 'fp-ts/lib/function.js';
 import * as HTTP from '@marlowe.io/adapter/http';
 import {formatValidationErrors} from 'jsonbigint-io-ts-reporters'
-import { ContractId, unContractId } from '../id.js';
+import { ContractId, unContractId } from "@marlowe.io/core/marlowe";
 import { Environment } from '@marlowe.io/language-core-v1/environment';
 import { Next } from '@marlowe.io/language-core-v1/next';
 import { Party } from '@marlowe.io/language-core-v1/semantics/contract/common/payee/party.js';

diff --git a/packages/client/rest/src/contract/transaction/details.ts b/packages/client/rest/src/contract/transaction/details.ts
@@ -9,7 +9,7 @@ import { Contract } from "@marlowe.io/language-core-v1";
 
 import { Tags, Metadata, BlockHeader, TxOutRef, TxId, TextEnvelope } from "@marlowe.io/core/cardano";
 
-import { ContractId } from "../id.js";
+import { ContractId } from "@marlowe.io/core/marlowe";
 import { TransactionId } from "./id.js";
 import { TxStatus } from "./status.js";
 

diff --git a/packages/client/rest/src/contract/transaction/endpoints/collection.ts b/packages/client/rest/src/contract/transaction/endpoints/collection.ts
@@ -21,7 +21,7 @@ import { AddressesAndCollaterals, Metadata, Tags, TextEnvelope, unAddressBech32,
 
 import { Header } from "../header.js";
 import { TransactionId } from "../id.js";
-import { ContractId, unContractId } from "../../id.js";
+import { ContractId, unContractId } from "@marlowe.io/core/marlowe";
 
 
 export interface TransactionsRange extends Newtype<{ readonly TransactionsRange: unique symbol }, string> {}

diff --git a/packages/client/rest/src/contract/transaction/endpoints/singleton.ts b/packages/client/rest/src/contract/transaction/endpoints/singleton.ts
@@ -13,7 +13,7 @@ import { DecodingError } from '@marlowe.io/adapter/codec';
 import { HexTransactionWitnessSet, transactionWitnessSetTextEnvelope } from '@marlowe.io/core/cardano';
 
 import { Details } from "../details.js";
-import { ContractId, unContractId } from "../../id.js";
+import { ContractId, unContractId } from "@marlowe.io/core/marlowe";
 import { TransactionId, unTransactionId } from "../id.js";
 
 export type GET = ( contractId: ContractId, transactionId : TransactionId) => TE.TaskEither<Error | DecodingError, Details>

diff --git a/packages/client/rest/src/contract/transaction/header.ts b/packages/client/rest/src/contract/transaction/header.ts
@@ -5,7 +5,7 @@ import { BuiltinByteString } from "@marlowe.io/language-core-v1";
 import { Tags, Metadata, BlockHeader, TxOutRef } from "@marlowe.io/core/cardano";
 
 
-import { ContractId } from "../id.js";
+import { ContractId } from "@marlowe.io/core/marlowe";
 import { TransactionId } from "./id.js";
 import { TxStatus } from "./status.js";
 

diff --git a/packages/client/rest/src/contract/withdrawal/endpoints/collection.ts b/packages/client/rest/src/contract/withdrawal/endpoints/collection.ts
@@ -18,7 +18,7 @@ import { DecodingError } from '@marlowe.io/adapter/codec';
 
 import { AddressesAndCollaterals, TextEnvelope, unAddressBech32, unTxOutRef } from '@marlowe.io/core/cardano';
 
-import { ContractId } from '../../id.js';
+import { ContractId } from "@marlowe.io/core/marlowe";
 import { RoleName } from '../../role.js';
 import { WithdrawalId } from '../id.js';
 import { Header } from '../header.js';

diff --git a/packages/client/rest/src/contract/withdrawal/index.ts b/packages/client/rest/src/contract/withdrawal/index.ts
@@ -0,0 +1,3 @@
+export * from './id.js'
+export * from './header.js'
+export * from './details.js'
diff --git a/packages/client/rest/src/index.ts b/packages/client/rest/src/index.ts
@@ -1,17 +1,18 @@
 
 import axios from 'axios';
 import * as TE from 'fp-ts/lib/TaskEither.js'
+import { pipe } from 'fp-ts/lib/function.js';
+
+import { MarloweJSONCodec } from '@marlowe.io/adapter/codec';
 import * as HTTP from '@marlowe.io/adapter/http';
+
 import * as WithdrawalSingleton from './contract/withdrawal/endpoints/singleton.js';
 import * as WithdrawalCollection from './contract/withdrawal/endpoints/collection.js';
 import * as ContractSingleton from './contract/endpoints/singleton.js';
 import * as ContractCollection from './contract/endpoints/collection.js';
 import * as TransactionSingleton from './contract/transaction/endpoints/singleton.js';
 import * as TransactionCollection from './contract/transaction/endpoints/collection.js';
 import * as ContractNext from './contract/next/endpoint.js';
-import { MarloweJSONCodec } from '@marlowe.io/adapter/codec';
-import { pipe } from 'fp-ts/lib/function.js';
-
 
 export interface RestAPI {
   healthcheck : () => TE.TaskEither<Error,Boolean>

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -29,7 +29,12 @@
       "import": "./dist/cardano/index.js",
       "types": "./dist/cardano/index.d.ts"
     },
-    "./cardano/*": "./dist/cardano/*.js"
+    "./cardano/*": "./dist/cardano/*.js",
+    "./marlowe": {
+      "import": "./dist/marlowe/index.js",
+      "types": "./dist/marlowe/index.d.ts"
+    },
+    "./marlowe/*": "./dist/marlowe/*.js"
   },
   "dependencies": {
     "fp-ts": "^2.16.0",

diff --git a/packages/client/rest/src/contract/id.ts → packages/core/src/marlowe/contractId.ts b/packages/client/rest/src/contract/id.ts → packages/core/src/marlowe/contractId.ts
@@ -4,7 +4,7 @@ import { fromNewtype } from "io-ts-types";
 import { split } from "fp-ts/lib/string.js";
 import { pipe } from "fp-ts/lib/function.js";
 import { head } from "fp-ts/lib/ReadonlyNonEmptyArray.js";
-import { TxId } from "@marlowe.io/core/cardano";
+import { TxId } from "../cardano/tx/id.js";
 
 
 export type ContractId = Newtype<{ readonly ContractId: unique symbol }, string>

diff --git a/packages/core/src/marlowe/index.ts b/packages/core/src/marlowe/index.ts
@@ -0,0 +1 @@
+export * from './contractId.js'
diff --git a/packages/language/core/v1/test/tsconfig.json b/packages/language/core/v1/test/tsconfig.json
@@ -4,12 +4,13 @@
     "outDir": "../test-dist",
     "paths": {
         "@marlowe.io/adapter/*": ["../../../../adapter/src/*"],
-        "@marlowe.io/language-core-v1/*": ["../src/*"]
+        "@marlowe.io/language-core-v1/*": ["../../../../language/core/v1/src*"]
     },
     "types": ["node", "jest"]
   },
   "references": [
     {"path": "../../../../adapter/src"},
+    {"path": "../../../../language/core/v1/src"},
     {"path": "../src"}
   ]
 }
diff --git a/packages/language/core/v1/typedoc.json b/packages/language/core/v1/typedoc.json
@@ -1,5 +1,5 @@
 {
   "entryPointStrategy": "expand",
-  "entryPoints": ["./src/semantics"],
+  "entryPoints": ["./src"],
   "tsconfig": "./src/tsconfig.json"
 }
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -31,10 +31,6 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
-    "./restClient": {
-      "import": "./dist/instance/overRestAPI/restClient/index.js",
-      "types": "./dist/instance/overRestAPI/restClient/index.d.ts"
-    },
     "./overRestAPI": {
       "import": "./dist/instance/overRestAPI/runtime.js",
       "types": "./dist/instance/overRestAPI/runtime.d.ts"
@@ -59,9 +55,6 @@
     "fp-ts": "^2.13.1",
     "io-ts": "2.2.20",
     "newtype-ts": "0.3.5",
-    "monocle-ts":"2.3.13",
-    "date-fns": "2.29.3",
-    "json-bigint": "^1.0.0",
-    "jsonbigint-io-ts-reporters": "2.0.1"
+    "monocle-ts":"2.3.13"
   }
 }
diff --git a/packages/runtime/src/api.ts b/packages/runtime/src/api.ts
@@ -1,23 +1,21 @@
 
-import * as Withdrawal from '@marlowe.io/client-rest/contract/withdrawal/details.js';
 
 import * as TE from 'fp-ts/lib/TaskEither.js'
-import { WalletAPI } from '@marlowe.io/wallet/api';
-import { Next } from '@marlowe.io/language-core-v1/semantics/next/index.js';
 import { DecodingError } from '@marlowe.io/adapter/codec';
-
-
 import { ISO8601 } from '@marlowe.io/adapter/time';
 
-
-
 import { Contract } from '@marlowe.io/language-core-v1/semantics/contract/index.js';
 import { Input } from '@marlowe.io/language-core-v1/semantics/contract/when/input/index.js';
+import { Next } from '@marlowe.io/language-core-v1/semantics/next/index.js';
+
 import { Tags, Metadata } from '@marlowe.io/core/cardano';
+
+import { WalletAPI } from '@marlowe.io/wallet/api';
+
 import { RoleName, RolesConfig } from '@marlowe.io/client-rest/contract/role.js';
 import { RestAPI } from '@marlowe.io/client-rest/index.js';
-import { ContractId } from '@marlowe.io/client-rest/contract/id.js';
-
+import { ContractId } from "@marlowe.io/core/marlowe";
+import * as Withdrawal from '@marlowe.io/client-rest/contract/withdrawal/details.js';
 
 export type Runtime =
   { wallet : WalletAPI & { getLovelaces : TE.TaskEither<Error,bigint>}

diff --git a/packages/runtime/src/instance/overRestAPI/browser/runtime.ts b/packages/runtime/src/instance/overRestAPI/browser/runtime.ts
@@ -1,11 +1,12 @@
-import { mkRestClient } from '@marlowe.io/client-rest/index.js';
 import * as T from 'fp-ts/lib/Task.js'
 import { pipe } from 'fp-ts/lib/function.js';
 
 import { getExtensionInstance } from '@marlowe.io/wallet/browser';
 import { mkRuntime } from '../runtime.js';
 import { Runtime } from '../../../api.js';
 
+import { mkRestClient } from '@marlowe.io/client-rest';
+
 export const mkRuntimeBroswer
   : (runtimeURL : string)
   => (extensionName : string)

diff --git a/packages/runtime/src/instance/overRestAPI/runtime.ts b/packages/runtime/src/instance/overRestAPI/runtime.ts
@@ -1,6 +1,5 @@
 
-import { ContractId } from '@marlowe.io/client-rest/contract/id.js';
-import { RestAPI } from '@marlowe.io/client-rest/index.js';
+import { ContractId } from "@marlowe.io/core/marlowe";;
 
 import * as Command from './txCommand.js';
 import * as A from 'fp-ts/lib/Array.js'
@@ -17,6 +16,7 @@ import { CreateRequest, ProvideInput, Runtime, WithdrawRequest } from '../../api
 import { WalletAPI } from '@marlowe.io/wallet/api';
 import { PolicyId } from '@marlowe.io/core/cardano';
 
+import { RestAPI } from '@marlowe.io/client-rest';
 
 export const mkRuntime
   :  (restAPI : RestAPI)

diff --git a/packages/runtime/src/instance/overRestAPI/txCommand.ts b/packages/runtime/src/instance/overRestAPI/txCommand.ts
@@ -2,15 +2,17 @@
 import * as TE from 'fp-ts/lib/TaskEither.js'
 
 import { pipe } from 'fp-ts/lib/function.js'
-import * as Contracts from '@marlowe.io/client-rest/contract/id.js';
-import * as Tx from '@marlowe.io/client-rest/contract/transaction/id.js';
-import * as Withdrawal from '@marlowe.io/client-rest/contract/withdrawal/details.js';
+import * as Contracts from "@marlowe.io/core/marlowe";;
 import { RestAPI } from '@marlowe.io/client-rest/index.js';
 import { WalletAPI, getAddressesAndCollaterals } from '@marlowe.io/wallet/api';
 import { DecodingError } from '@marlowe.io/adapter/codec';
 import { CreateRequest, ApplyInputsRequest, WithdrawRequest } from '../../api.js';
-import { ContractId } from '@marlowe.io/client-rest/contract/id.js';
-import * as WithdrawalId from '@marlowe.io/client-rest/contract/withdrawal/id.js';
+import { ContractId } from "@marlowe.io/core/marlowe";;
+
+
+import * as Tx from '@marlowe.io/client-rest/transaction';
+import * as Withdrawal from '@marlowe.io/client-rest/withdrawal';
+
 
 
 export const create
@@ -78,5 +80,5 @@ export const withdraw
                 pipe ( wallet.signTxTheCIP30Way(withdrawalTextEnvelope.tx.cborHex)
                      , TE.chain ((hexTransactionWitnessSet) => client.withdrawals.withdrawal.put(withdrawalTextEnvelope.withdrawalId,hexTransactionWitnessSet))
                      , TE.map (() => withdrawalTextEnvelope.withdrawalId)))
-            , TE.chainFirstW((withdrawalId) => wallet.waitConfirmation(pipe(withdrawalId, WithdrawalId.idToTxId)))
+            , TE.chainFirstW((withdrawalId) => wallet.waitConfirmation(pipe(withdrawalId, Withdrawal.idToTxId)))
             , TE.chainW ((withdrawalId) => client.withdrawals.withdrawal.get(withdrawalId)) )
diff --git a/packages/runtime/src/tsconfig.json b/packages/runtime/src/tsconfig.json
@@ -6,15 +6,15 @@
       "@marlowe.io/adapter/*": ["../../adapter/src/*"],
       "@marlowe.io/core/*": ["../../core/src/*"],
       "@marlowe.io/wallet/*": ["../../wallet/src/*"],
-      "@marlowe.io/client-rest/*": ["../../client/rest/src/*"],
-      "@marlowe.io/language-core-v1/*": ["../../language/core/v1/src/*"]
+      "@marlowe.io/language-core-v1/*": ["../../language/core/v1/src/*"],
+      "@marlowe.io/client-rest/*": ["../../client/rest/src/*"]
     }
   },
   "references": [
     { "path": "../../core/src" },
     { "path": "../../adapter/src" },
     { "path": "../../wallet/src" },
-    { "path": "../../client/rest/src" },
     { "path": "../../language/core/v1/src" },
+    { "path": "../../client/rest/src" }
   ]
 }
diff --git a/packages/runtime/test/endpoints/contracts.spec.e2e.ts b/packages/runtime/test/endpoints/contracts.spec.e2e.ts
@@ -4,8 +4,8 @@ import * as TE from 'fp-ts/lib/TaskEither.js';
 import * as O from 'fp-ts/lib/Option.js';
 
 import { close } from '@marlowe.io/language-core-v1'
-import { mkRestClient } from '@marlowe.io/runtime/restClient';
 import { create } from '@marlowe.io/runtime/txCommand';
+import { mkRestClient } from '@marlowe.io/client-rest/index.js';
 
 import { initialiseBankAndverifyProvisionning } from '../provisionning.js';
 import { getBankPrivateKey, getBlockfrostContext, getMarloweRuntimeUrl } from '../context.js';

diff --git a/packages/runtime/test/endpoints/transactions.spec.e2e.ts b/packages/runtime/test/endpoints/transactions.spec.e2e.ts
@@ -8,7 +8,7 @@ import { addMinutes, subMinutes } from 'date-fns'
 import { datetoTimeout, inputNotify } from '@marlowe.io/language-core-v1';
 import { oneNotifyTrue } from '@marlowe.io/language-core-v1/examples'
 import { datetoIso8601Bis } from '@marlowe.io/adapter/time'
-import { mkRestClient } from '@marlowe.io/runtime/restClient';
+import { mkRestClient } from '@marlowe.io/client-rest/index.js';
 
 import { getBankPrivateKey, getBlockfrostContext, getMarloweRuntimeUrl } from '../context.js';
 import { initialiseBankAndverifyProvisionning } from '../provisionning.js'

diff --git a/packages/runtime/test/endpoints/withdrawals.spec.e2e.ts b/packages/runtime/test/endpoints/withdrawals.spec.e2e.ts
@@ -6,7 +6,7 @@ import { addDays } from 'date-fns/fp';
 import * as Examples from '@marlowe.io/language-core-v1/examples';
 import { datetoTimeout, adaValue } from '@marlowe.io/language-core-v1';
 import { toInput } from '@marlowe.io/language-core-v1/next';
-import { mkRestClient } from '@marlowe.io/runtime/restClient';
+import { mkRestClient } from '@marlowe.io/client-rest/index.js';
 
 import { getBankPrivateKey, getBlockfrostContext, getMarloweRuntimeUrl } from '../context.js';
 import { provisionAnAdaAndTokenProvider } from '../provisionning.js';

diff --git a/packages/runtime/test/examples/swap.ada.token.spec.e2e.ts b/packages/runtime/test/examples/swap.ada.token.spec.e2e.ts
@@ -7,7 +7,7 @@ import { addDays } from 'date-fns/fp'
 import { toInput } from '@marlowe.io/language-core-v1/next';
 import * as Examples from '@marlowe.io/language-core-v1/examples'
 import { datetoTimeout, adaValue } from '@marlowe.io/language-core-v1'
-import { mkRestClient } from '@marlowe.io/runtime/restClient';
+import { mkRestClient } from '@marlowe.io/client-rest/index.js';
 
 import { getBankPrivateKey, getBlockfrostContext, getMarloweRuntimeUrl } from '../context.js';
 import { provisionAnAdaAndTokenProvider } from '../provisionning.js'