diff --git a/CHANGELOG.md b/CHANGELOG.md index 837ba1b3..6ca122f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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)) @@ -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)) @@ -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) diff --git a/Readme.md b/Readme.md index 6c74c308..7f222a80 100644 --- a/Readme.md +++ b/Readme.md @@ -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) diff --git a/changelog.d/20240112_130130_hrajchert_plt_9089_createContract_bundle_support.md b/changelog.d/20240112_130130_hrajchert_plt_9089_createContract_bundle_support.md index 20252d9c..af017edc 100644 --- a/changelog.d/20240112_130130_hrajchert_plt_9089_createContract_bundle_support.md +++ b/changelog.d/20240112_130130_hrajchert_plt_9089_createContract_bundle_support.md @@ -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)) - diff --git a/changelog.d/20240122_133315_hrajchert_cip45.md b/changelog.d/20240122_133315_hrajchert_cip45.md index 8d2ceae8..daf38c0b 100644 --- a/changelog.d/20240122_133315_hrajchert_cip45.md +++ b/changelog.d/20240122_133315_hrajchert_cip45.md @@ -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)) diff --git a/changelog.d/20240126_162752_bjorn.wilhelm.kihlberg_PLT_9368.md b/changelog.d/20240126_162752_bjorn.wilhelm.kihlberg_PLT_9368.md index 77af8e27..d8bd5614 100644 --- a/changelog.d/20240126_162752_bjorn.wilhelm.kihlberg_PLT_9368.md +++ b/changelog.d/20240126_162752_bjorn.wilhelm.kihlberg_PLT_9368.md @@ -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` diff --git a/changelog.d/20240214_142506_hrajchert_marlowe_template.md b/changelog.d/20240214_142506_hrajchert_marlowe_template.md index 0a0279e2..319d9643 100644 --- a/changelog.d/20240214_142506_hrajchert_marlowe_template.md +++ b/changelog.d/20240214_142506_hrajchert_marlowe_template.md @@ -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)) - diff --git a/changelog.d/20240222_130945_hrajchert_fix_branded_output.md b/changelog.d/20240222_130945_hrajchert_fix_branded_output.md index 7f0a2738..f01c6c58 100644 --- a/changelog.d/20240222_130945_hrajchert_fix_branded_output.md +++ b/changelog.d/20240222_130945_hrajchert_fix_branded_output.md @@ -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)) - - diff --git a/doc/howToDevelop.md b/doc/howToDevelop.md index 64122bc0..3b246161 100644 --- a/doc/howToDevelop.md +++ b/doc/howToDevelop.md @@ -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. diff --git a/doc/theme/assets/marlowe-theme.css b/doc/theme/assets/marlowe-theme.css index 64249469..612f1fc8 100644 --- a/doc/theme/assets/marlowe-theme.css +++ b/doc/theme/assets/marlowe-theme.css @@ -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; } @@ -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); @@ -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; @@ -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); @@ -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); } } diff --git a/doc/theme/src/ThemeContext.tsx b/doc/theme/src/ThemeContext.tsx index b3314cd7..23cffb64 100644 --- a/doc/theme/src/ThemeContext.tsx +++ b/doc/theme/src/ThemeContext.tsx @@ -1,11 +1,4 @@ -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(fn: (f: F, ...a: L) => R, first: F) { @@ -13,11 +6,7 @@ function bind(fn: (f: F, ...a: L) => R, first: F) { } export class ThemeContext extends DefaultThemeRenderContext { - constructor( - theme: DefaultTheme, - page: PageEvent, - options: Options - ) { + constructor(theme: DefaultTheme, page: PageEvent, options: Options) { super(theme, page, options); this.init(); } diff --git a/doc/theme/src/index.tsx b/doc/theme/src/index.tsx index a7916ebf..b96ac3e6 100644 --- a/doc/theme/src/index.tsx +++ b/doc/theme/src/index.tsx @@ -27,10 +27,7 @@ export function load(app: Application) { app.renderer.hooks.on("head.end", (event) => ( <> - + )); } @@ -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); diff --git a/doc/theme/src/templates/footer.tsx b/doc/theme/src/templates/footer.tsx index c372c769..8d716d82 100644 --- a/doc/theme/src/templates/footer.tsx +++ b/doc/theme/src/templates/footer.tsx @@ -1,9 +1,6 @@ import { DefaultThemeRenderContext, JSX, PageEvent, Reflection } from "typedoc"; -export const footer = ( - context: DefaultThemeRenderContext, - props: PageEvent -) => ( +export const footer = (context: DefaultThemeRenderContext, props: PageEvent) => (
@@ -15,31 +12,63 @@ export const footer = ( - - - - - + + + + + - - - - - + + + + + - - - - + + + + - +
Legal
PayoutsPlaygroundMarlowe ts-sdkIOG Tech SupportCookie Policy + Payouts + + Playground + + Marlowe ts-sdk + + IOG Tech Support + + Cookie Policy +
Token PlanPreprod RunnerPayout PrototypeDocumentationPrivacy Policy + Token Plan + + Preprod Runner + + Payout Prototype + + Documentation + + Privacy Policy +
Marlowe ScanToken Plan PrototypeBlogTerms of Use + Marlowe Scan + + Token Plan Prototype + + Blog + + + Terms of Use + +
Official Website + Official Website +
diff --git a/doc/theme/src/templates/layout.tsx b/doc/theme/src/templates/layout.tsx index babf3d5a..e0977860 100644 --- a/doc/theme/src/templates/layout.tsx +++ b/doc/theme/src/templates/layout.tsx @@ -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 = ( @@ -19,44 +12,18 @@ export const layout = ( {context.hook("head.begin")} - + - - - + + + {context.options.getValue("customCss") && ( - + )} - - - + + + {context.hook("head.end")} diff --git a/doc/theme/src/templates/toolbar.tsx b/doc/theme/src/templates/toolbar.tsx index 54001f78..a74a4530 100644 --- a/doc/theme/src/templates/toolbar.tsx +++ b/doc/theme/src/templates/toolbar.tsx @@ -1,21 +1,11 @@ import { DefaultThemeRenderContext, JSX, PageEvent, Reflection } from "typedoc"; -export const toolbar = ( - context: DefaultThemeRenderContext, - props: PageEvent -) => ( +export const toolbar = (context: DefaultThemeRenderContext, props: PageEvent) => (
-