Skip to content

Commit

Permalink
[package.json] applied new prettier config
Browse files Browse the repository at this point in the history
  • Loading branch information
nhenin committed Mar 17, 2024
1 parent 5bb7d6a commit 888a070
Show file tree
Hide file tree
Showing 170 changed files with 1,462 additions and 3,833 deletions.
7 changes: 3 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

# 0.3.0-beta - 18 Jan 2024

The Marlowe team is happy to announce the 0.3.0 release with the following Milestones completed:

- Add Node.js/Deno support
- Completed 1-1 feature parity between the TS-SDK and Runtime 0.0.6
- Added an open role example
Expand All @@ -24,7 +25,6 @@ A more detailed description of the changes can be found next

- Fix (PLT-9008): Fix documentation warnings and add a CI check to avoid them in the future. ([PR-139](https://github.com/input-output-hk/marlowe-ts-sdk/pull/139))


## Examples

- Feat: Added a new interactive NodeJs example to make delayed payments with staking and merkleization. ([PR-136](https://github.com/input-output-hk/marlowe-ts-sdk/pull/136))
Expand Down Expand Up @@ -62,7 +62,7 @@ A more detailed description of the changes can be found next
- or `json {withdrawals: {..}, page : {..} }`
- **BREAKING CHANGE** Refactor: Create contract sources now uses a single parameter ContractBundle, instead of two separate bundle and main entrypoint parameters. ([PR-136](https://github.com/input-output-hk/marlowe-ts-sdk/pull/136))
- **BREAKING CHANGE** Feat: Modified the endpoint `healthcheck` to return `RuntimeStatus`(version deployed, Network Id of the Node and tips) instead of a `boolean`. ([PR-158](https://github.com/input-output-hk/marlowe-ts-sdk/pull/158))
- **BREAKING CHANGE** Fix: Pagination responses not always return a current header. ([PR-136](https://github.com/input-output-hk/marlowe-ts-sdk/pull/136))
- **BREAKING CHANGE** Fix: Pagination responses not always return a current header. ([PR-136](https://github.com/input-output-hk/marlowe-ts-sdk/pull/136))

- Feat (PLT-7704): Extend the rest client with procedure `getPayouts`. ([PR-124](https://github.com/input-output-hk/marlowe-ts-sdk/pull/124))
- Feat (PLT-7705): Extend the rest client with procedure `getPayoutById`. ([PR-124](https://github.com/input-output-hk/marlowe-ts-sdk/pull/124))
Expand All @@ -73,7 +73,6 @@ A more detailed description of the changes can be found next
- Feat: Added `@marlowe.io/runtime-rest-client/guards` in a similar way as `@marlowe.io/labguage-core-v1/guards` ([PR-142](https://github.com/input-output-hk/marlowe-ts-sdk/pull/142))
- Fix: Revived integration tests ([PR-142](https://github.com/input-output-hk/marlowe-ts-sdk/pull/142))


## @marlowe.io/runtime-core

- **BREAKING CHANGE** Refactor: `AddressBech32` is a branded type instead of newtype (`unAddressBech32` has been removed and is not necessary anymore) : [PR-127](https://github.com/input-output-hk/marlowe-ts-sdk/pull/127)
Expand Down
10 changes: 4 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,10 @@ It is composed of several npm packages documented in the [API reference](https:/

In order to interact with Marlowe contracts, the **TS-SDK** needs a Runtime instance. The following table shows the compatibility between the SDK and the Runtime versions:


| | runtime v0.0.5 | runtime v0.0.6 |
| ------- | :--------: | :------------: |
| [SDK 0.2.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.2.0-beta) || x |
| [SDK 0.3.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.3.0-beta) |||

| | runtime v0.0.5 | runtime v0.0.6 |
| ------------------------------------------------------------------------------------------- | :------------: | :------------: |
| [SDK 0.2.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.2.0-beta) || x |
| [SDK 0.3.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.3.0-beta) |||

To get a running instance of the Runtime, it is recommended to check out the instructions on the [Marlowe Starter Kit](https://github.com/input-output-hk/marlowe-starter-kit)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

### @marlowe.io/runtime-lifecycle

- Feat (PLT-9089): Added support for contract bundles in the `lifecycle.contracts.createContract` function. ([PR-167](https://github.com/input-output-hk/marlowe-ts-sdk/pull/167))

1 change: 0 additions & 1 deletion changelog.d/20240122_133315_hrajchert_cip45.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

### @marlowe.io/wallet

- Feat: Added a `@marlowe.io/wallet/peer-connect` module to enable mobile support by adapting to the [cardano-peer-connect](https://github.com/fabianbormann/cardano-peer-connect) library. ([PR-179](https://github.com/input-output-hk/marlowe-ts-sdk/pull/179))
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### @marlowe.io/runtime-rest-client

- `mkRestClient` provides optional `strict` parameter for performing dynamic type checking in `RestClient` methods. ([PR-180](https://github.com/input-output-hk/marlowe-ts-sdk/pull/180))
- **BREAKING CHANGE** The following `RestClient` methods uses keyword argument object instead of positional arguments. ([PR-180](https://github.com/input-output-hk/marlowe-ts-sdk/pull/180))
- **BREAKING CHANGE** The following `RestClient` methods uses keyword argument object instead of positional arguments. ([PR-180](https://github.com/input-output-hk/marlowe-ts-sdk/pull/180))
- `createContractSources`
- `getContractById`
- `submitContract`
Expand Down
6 changes: 1 addition & 5 deletions changelog.d/20240214_142506_hrajchert_marlowe_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@


### General

- Feat: Created a new experimental package `@marlowe.io/marlowe-template` that helps to share the parameters used in the creation of a Marlowe contract. ([PR-184](https://github.com/input-output-hk/marlowe-ts-sdk/pull/184))


### @marlowe.io/runtime-core

- Feat: Added AddressBech32 validation using the lucid library ([PR-184](https://github.com/input-output-hk/marlowe-ts-sdk/pull/184))
- Feat: Added AddressBech32 validation using the lucid library ([PR-184](https://github.com/input-output-hk/marlowe-ts-sdk/pull/184))
- Fix: Added proper type guards to Metadata ([PR-184](https://github.com/input-output-hk/marlowe-ts-sdk/pull/184))

2 changes: 0 additions & 2 deletions changelog.d/20240222_130945_hrajchert_fix_branded_output.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
### @marlowe.io/runtime-core

- Fix: Branding of ContractId and TxId ([PR-185](https://github.com/input-output-hk/marlowe-ts-sdk/pull/185))


2 changes: 2 additions & 0 deletions doc/howToDevelop.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,11 @@ $ npm test
#### How to Generate a new Seed Phrase for a Bank Wallet ?

1. At the root of the project :

```bash
npm run -w @marlowe.io/testing-kit genSeedPhrase
```

2. Copy/paste the words within quotes in the env file.
3. Go to one of your favorite Wallet Extension and restore a wallet with this seedphrase
4. Get a Payment Address from these Browser extensions to provision your Bank with the faucet.
Expand Down
23 changes: 8 additions & 15 deletions doc/theme/assets/marlowe-theme.css
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
/* https://github.com/elad2412/the-new-css-reset */
*:where(
:not(html, iframe, canvas, img, svg, video, audio):not(svg *, symbol *)
) {
*:where(:not(html, iframe, canvas, img, svg, video, audio):not(svg *, symbol *)) {
all: unset;
display: revert;
}
Expand Down Expand Up @@ -79,8 +77,7 @@ meter {
--light-button-color-hover: rgb(36, 41, 47);
--light-button-background-hover: rgb(239, 241, 243);
--light-button-border-color-hover: rgba(31, 35, 40, 0.15);
--light-button-box-shadow: rgba(31, 35, 40, 0.04) 0 1px 0,
rgba(255, 255, 255, 0.25) 0 1px 0 inset;
--light-button-box-shadow: rgba(31, 35, 40, 0.04) 0 1px 0, rgba(255, 255, 255, 0.25) 0 1px 0 inset;
--light-input-border-color: rgb(208, 215, 222);
--light-input-border-color-focus: rgb(9, 105, 218);

Expand All @@ -104,10 +101,9 @@ meter {
--pre-color-background: var(--color-background-secondary);
--code-color-background: var(--color-background-secondary);

--font-family-body: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
--font-family-mono: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas,
Liberation Mono, monospace;
--font-family-body: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", Helvetica, Arial, sans-serif,
"Apple Color Emoji", "Segoe UI Emoji";
--font-family-mono: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;

--font-size-h1: 2.1rem;
--font-size-h2: 1.8rem;
Expand Down Expand Up @@ -508,8 +504,7 @@ ul.tsd-parameter-list > li > h5:last-child {

/* Show parameter signature as a cut-in block */
.tsd-parameter-signature {
margin: calc(var(--paragraph-spacing) / -2)
calc(var(--paragraph-spacing) * -1) calc(var(--paragraph-spacing) / 2);
margin: calc(var(--paragraph-spacing) / -2) calc(var(--paragraph-spacing) * -1) calc(var(--paragraph-spacing) / 2);
padding: var(--paragraph-spacing);
padding-bottom: 0.05px;
background: var(--color-background-secondary);
Expand Down Expand Up @@ -951,13 +946,11 @@ a.tsd-index-link {
}

.page-menu {
padding: var(--paragraph-spacing) var(--content-spacing)
var(--paragraph-spacing) 0;
padding: var(--paragraph-spacing) var(--content-spacing) var(--paragraph-spacing) 0;
}

.site-menu {
padding: var(--paragraph-spacing) 0 var(--paragraph-spacing)
var(--content-spacing);
padding: var(--paragraph-spacing) 0 var(--paragraph-spacing) var(--content-spacing);
}
}

Expand Down
15 changes: 2 additions & 13 deletions doc/theme/src/ThemeContext.tsx
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
import {
DefaultTheme,
DefaultThemeRenderContext,
JSX,
Options,
PageEvent,
Reflection,
} from "typedoc";
import { DefaultTheme, DefaultThemeRenderContext, JSX, Options, PageEvent, Reflection } from "typedoc";
import * as templates from "./templates";

function bind<F, L extends any[], R>(fn: (f: F, ...a: L) => R, first: F) {
return (...r: L) => fn(first, ...r);
}

export class ThemeContext extends DefaultThemeRenderContext {
constructor(
theme: DefaultTheme,
page: PageEvent<Reflection>,
options: Options
) {
constructor(theme: DefaultTheme, page: PageEvent<Reflection>, options: Options) {
super(theme, page, options);
this.init();
}
Expand Down
9 changes: 2 additions & 7 deletions doc/theme/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@ export function load(app: Application) {
app.renderer.hooks.on("head.end", (event) => (
<>
<link rel="icon" href={event.relativeURL("assets/marlowe/favicon.ico")} />
<link
rel="stylesheet"
href={event.relativeURL("assets/marlowe/marlowe-theme.css")}
/>
<link rel="stylesheet" href={event.relativeURL("assets/marlowe/marlowe-theme.css")} />
</>
));
}
Expand All @@ -40,9 +37,7 @@ export function copySync(src: string, dest: string): void {

if (stat.isDirectory()) {
const contained = fs.readdirSync(src);
contained.forEach((file) =>
copySync(path.join(src, file), path.join(dest, file))
);
contained.forEach((file) => copySync(path.join(src, file), path.join(dest, file)));
} else if (stat.isFile()) {
fs.mkdirSync(path.dirname(dest), { recursive: true });
fs.copyFileSync(src, dest);
Expand Down
67 changes: 48 additions & 19 deletions doc/theme/src/templates/footer.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
import { DefaultThemeRenderContext, JSX, PageEvent, Reflection } from "typedoc";

export const footer = (
context: DefaultThemeRenderContext,
props: PageEvent<Reflection>
) => (
export const footer = (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => (
<div class="tsd-generator">
<div class="footer-links">
<table>
Expand All @@ -15,31 +12,63 @@ export const footer = (
<th>Legal</th>
</tr>
<tr>
<td><a href="https://payouts-preprod.prod.scdev.aws.iohkdev.io/">Payouts</a></td>
<td><a href="https://play.marlowe.iohk.io/">Playground</a></td>
<td><a href="https://github.com/input-output-hk/marlowe-ts-sdk">Marlowe ts-sdk</a></td>
<td><a href="https://iohk.zendesk.com/hc/en-us/requests/new">IOG Tech Support</a></td>
<td><a href="https://docs.google.com/document/d/13zJ5jdaKjXgAytvDn0kln8UFDhyFr3AS/view">Cookie Policy</a></td>
<td>
<a href="https://payouts-preprod.prod.scdev.aws.iohkdev.io/">Payouts</a>
</td>
<td>
<a href="https://play.marlowe.iohk.io/">Playground</a>
</td>
<td>
<a href="https://github.com/input-output-hk/marlowe-ts-sdk">Marlowe ts-sdk</a>
</td>
<td>
<a href="https://iohk.zendesk.com/hc/en-us/requests/new">IOG Tech Support</a>
</td>
<td>
<a href="https://docs.google.com/document/d/13zJ5jdaKjXgAytvDn0kln8UFDhyFr3AS/view">Cookie Policy</a>
</td>
</tr>
<tr>
<td><a href="https://token-plans-preprod.prod.scdev.aws.iohkdev.io/">Token Plan</a></td>
<td><a href="https://preprod.runner.marlowe.iohk.io/">Preprod Runner</a></td>
<td><a href="https://github.com/input-output-hk/marlowe-payouts">Payout Prototype</a></td>
<td><a href="https://docs.marlowe.iohk.io/">Documentation</a></td>
<td><a href="https://static.iohk.io/terms/iog-privacy-policy.pdf">Privacy Policy</a></td>
<td>
<a href="https://token-plans-preprod.prod.scdev.aws.iohkdev.io/">Token Plan</a>
</td>
<td>
<a href="https://preprod.runner.marlowe.iohk.io/">Preprod Runner</a>
</td>
<td>
<a href="https://github.com/input-output-hk/marlowe-payouts">Payout Prototype</a>
</td>
<td>
<a href="https://docs.marlowe.iohk.io/">Documentation</a>
</td>
<td>
<a href="https://static.iohk.io/terms/iog-privacy-policy.pdf">Privacy Policy</a>
</td>
</tr>
<tr>
<td></td>
<td><a href="https://marlowescan.com/">Marlowe Scan</a></td>
<td><a href="https://github.com/input-output-hk/marlowe-token-plans">Token Plan Prototype</a></td>
<td><a href="https://marlowe.iohk.io/blog">Blog</a></td>
<td><a href="https://plutus-static.s3.eu-central-1.amazonaws.com/IOHK+Website+Terms+%26+Conditions+(Final).pdf">Terms of Use</a></td>
<td>
<a href="https://marlowescan.com/">Marlowe Scan</a>
</td>
<td>
<a href="https://github.com/input-output-hk/marlowe-token-plans">Token Plan Prototype</a>
</td>
<td>
<a href="https://marlowe.iohk.io/blog">Blog</a>
</td>
<td>
<a href="https://plutus-static.s3.eu-central-1.amazonaws.com/IOHK+Website+Terms+%26+Conditions+(Final).pdf">
Terms of Use
</a>
</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td><a href="https://marlowe.iohk.io/">Official Website</a></td>
<td>
<a href="https://marlowe.iohk.io/">Official Website</a>
</td>
<td></td>
</tr>
</table>
Expand Down
51 changes: 9 additions & 42 deletions doc/theme/src/templates/layout.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
import {
ContainerReflection,
DefaultThemeRenderContext,
JSX,
PageEvent,
Reflection,
RenderTemplate,
} from "typedoc";
import { ContainerReflection, DefaultThemeRenderContext, JSX, PageEvent, Reflection, RenderTemplate } from "typedoc";
import { classNames } from "./utils";

export const layout = (
Expand All @@ -19,44 +12,18 @@ export const layout = (
<meta charSet="utf-8" />
{context.hook("head.begin")}
<meta http-equiv="x-ua-compatible" content="IE=edge" />
<meta
name="description"
content={"Documentation for " + props.project.name}
/>
<meta name="description" content={"Documentation for " + props.project.name} />
<meta name="viewport" content="width=device-width, initial-scale=1" />

<link
rel="stylesheet"
href={context.relativeURL("assets/style.css", true)}
/>
<link
rel="stylesheet"
href={context.relativeURL("assets/highlight.css", true)}
/>
<link
rel="stylesheet"
href={context.relativeURL("assets/marlowe/style.css")}
/>
<link rel="stylesheet" href={context.relativeURL("assets/style.css", true)} />
<link rel="stylesheet" href={context.relativeURL("assets/highlight.css", true)} />
<link rel="stylesheet" href={context.relativeURL("assets/marlowe/style.css")} />
{context.options.getValue("customCss") && (
<link
rel="stylesheet"
href={context.relativeURL("assets/custom.css", true)}
/>
<link rel="stylesheet" href={context.relativeURL("assets/custom.css", true)} />
)}
<script
defer
src={context.relativeURL("assets/main.js", true)}
></script>
<script
async
src={context.relativeURL("assets/search.js", true)}
id="search-script"
></script>
<script
async
src={context.relativeURL("assets/navigation.js", true)}
id="tsd-nav-script"
></script>
<script defer src={context.relativeURL("assets/main.js", true)}></script>
<script async src={context.relativeURL("assets/search.js", true)} id="search-script"></script>
<script async src={context.relativeURL("assets/navigation.js", true)} id="tsd-nav-script"></script>
{context.hook("head.end")}
</head>
<body>
Expand Down
Loading

0 comments on commit 888a070

Please sign in to comment.