Skip to content

Commit

Permalink
Bump to version 0.3.0-rc2
Browse files Browse the repository at this point in the history
  • Loading branch information
@hrajchert
hrajchert committed Jan 10, 2024
1 parent 81ca519 commit 8678060
Show file tree
Hide file tree
Showing 23 changed files with 141 additions and 137 deletions.
1 change: 1 addition & 0 deletions Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ In order to interact with Marlowe contracts, the **TS-SDK** needs a Runtime inst
| | runtime v0.0.5 | runtimev 0.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-rc2](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.3.0-beta-rc2) | ✓ | ✓ |


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
42 changes: 21 additions & 21 deletions doc/howToDevelop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In order to clean the build artifacts you can use the `clean` command.
$ npm run clean
```

# Tests
# Tests

N.B : It is recommended to clean and build the packages before you run the tests to be sure you are playing with the most up to date version of the codebase.

Expand All @@ -37,7 +37,7 @@ $ npm run clean && npm run build

## Unit Tests

To run the unit tests for all the packages, from the root folder you can execute the `test` command :
To run the unit tests for all the packages, from the root folder you can execute the `test` command :

```bash
$ npm test
Expand All @@ -48,7 +48,7 @@ If you want to run tests for a single package you can use the `-w` flag or execu
```bash
# From the root folder
$ npm run clean && npm run build && npm test -w @marlowe.io/language-core-v1
# Or you can enter the package folder and test. You will have to clean and build properly the local package
# Or you can enter the package folder and test. You will have to clean and build properly the local package
# dependencies of this current package if you modify one of them
# e.g : `packages/language/core/v1` depends on `packages/adapter`. Be sure you have build correctly this package before runnning your test that way.
$ cd packages/language/core/v1
Expand All @@ -60,29 +60,29 @@ $ npm test
### Setting up the env Configuration File

1. Create a `./env/.env.test` at the root of the project
2. Copy/Paste the following, and provide the necessary parameter
2. Copy/Paste the following, and provide the necessary parameter

```bash
####################################################
## Provide a Runtime Instance URL (>= v0.0.5) #
####################################################
## to create an instance of a local Marlowe runtime, follow the instructions in
## to create an instance of a local Marlowe runtime, follow the instructions in
## the Marlowe starter kit : https://github.com/input-output-hk/ marlowe-starter-kit/blob/main/docs/preliminaries.md
MARLOWE_WEB_SERVER_URL="http://<path-to-a-runtime-instance>:<a-port>"
####################################################

#####################################################
## Provide Wallet Dependencies (Necessary for Lucid Library)
#####################################################
## Blockfrost Account : If you haven't done it before, go to https://blockfrost.io/ and create a free-tier account.
## Blockfrost Account : If you haven't done it before, go to https://blockfrost.io/ and create a free-tier account.
## Then, create a project and copy the project ID
BLOCKFROST_PROJECT_ID="<your-blockfrost-project-id>"
BLOCKFROST_URL="<your-blockfrost-id>"
## Network used by Blockfrost : private | preview | preprod | mainnet
NETWORK_NAME=preprod
## Bank Seed Phrase : The bank is a wallet where you provision enough tAda (>= 100 tAda) to run all
## Bank Seed Phrase : The bank is a wallet where you provision enough tAda (>= 100 tAda) to run all
## the e2e tests without running out of money. This is your responsability to create this wallet and
## add tAda using a Faucet.
## add tAda using a Faucet.
BANK_SEED_PHRASE='[
"deal",
"place",
Expand Down Expand Up @@ -115,27 +115,27 @@ BANK_SEED_PHRASE='[
## Logging
#####################################################
## set to true or false if you want to log Debug Info
LOG_DEBUG_LEVEL=false
LOG_DEBUG_LEVEL=false
```
#### How to Generate a new Seed Phrase for a Bank Wallet ?

1. At the root of the project :
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.

#### How to add tAda to the Bank Wallet via a faucet ?
#### How to add tAda to the Bank Wallet via a faucet ?

1. Retrieve your Bank Wallet payment address
2. Go to https://docs.cardano.org/cardano-testnet/tools/faucet ask for test Ada on this address.
3. Wait a moment till the transaction is confirmed and you should be able to run the tests.

### Running the E2E Tests
### Running the E2E Tests

To run the e2e tests for all the packages, from the root folder you can execute the `test:e2e` command :
To run the e2e tests for all the packages, from the root folder you can execute the `test:e2e` command :

```bash
$ npm run test:e2e
Expand All @@ -146,7 +146,7 @@ If you want to run tests for a single package you can use the `-w` flag or execu
```bash
# From the root folder
$ npm run clean && npm run build && npm run test:e2e -w @marlowe.io/runtime-lifecycle
# Or you can enter the package folder and test. You will have to clean and build properly the local package
# Or you can enter the package folder and test. You will have to clean and build properly the local package
# dependencies of this current package if you modify one of them
$ cd packages/runtime/client/rest
$ npm run test:e2e
Expand Down Expand Up @@ -229,13 +229,13 @@ And in a separate project you can install the tarballs using a file url when dec
```json
{
"dependencies": {
"@marlowe.io/runtime-lifecycle": "file:<path-to-dist>/marlowe.io-runtime-lifecycle-0.2.0-beta.tgz",
"@marlowe.io/runtime-rest-client": "file:<path-to-dist>/marlowe.io-runtime-rest-client-0.2.0-beta.tgz",
"@marlowe.io/adapter": "file:<path-to-dist>/marlowe.io-adapter-0.2.0-beta.tgz",
"@marlowe.io/runtime-core": "file:<path-to-dist>/marlowe.io-runtime-core-0.2.0-beta.tgz",
"@marlowe.io/language-core-v1": "file:<path-to-dist>/marlowe.io-language-core-v1-0.2.0-beta.tgz",
"@marlowe.io/language-examples": "file:<path-to-dist>/marlowe.io-language-examples-0.2.0-beta.tgz",
"@marlowe.io/wallet": "file:<path-to-dist>/marlowe.io-wallet-0.2.0-beta.tgz"
"@marlowe.io/runtime-lifecycle": "file:<path-to-dist>/marlowe.io-runtime-lifecycle-0.3.0-beta-rc2.tgz",
"@marlowe.io/runtime-rest-client": "file:<path-to-dist>/marlowe.io-runtime-rest-client-0.3.0-beta-rc2.tgz",
"@marlowe.io/adapter": "file:<path-to-dist>/marlowe.io-adapter-0.3.0-beta-rc2.tgz",
"@marlowe.io/runtime-core": "file:<path-to-dist>/marlowe.io-runtime-core-0.3.0-beta-rc2.tgz",
"@marlowe.io/language-core-v1": "file:<path-to-dist>/marlowe.io-language-core-v1-0.3.0-beta-rc2.tgz",
"@marlowe.io/language-examples": "file:<path-to-dist>/marlowe.io-language-examples-0.3.0-beta-rc2.tgz",
"@marlowe.io/wallet": "file:<path-to-dist>/marlowe.io-wallet-0.3.0-beta-rc2.tgz"
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion doc/modules-system.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Marlowe SDK is built using ESM modules but one of its dependencies (fp-ts) d
In most packages documentation you'll find something like:

```html
<script src="https://cdn.jsdelivr.net/gh/input-output-hk/marlowe-ts-sdk@0.2.0-beta/jsdelivr-npm-importmap.js"></script>
<script src="https://cdn.jsdelivr.net/gh/input-output-hk/marlowe-ts-sdk@0.3.0-beta-rc2/jsdelivr-npm-importmap.js"></script>
<script type="module">
import * as wallet from "@marlowe.io/wallet";
// ...
Expand Down
6 changes: 3 additions & 3 deletions doc/versioning-and-releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The TS-SDK follows a versioning system where, after version 1, it aligns with se

Before version 1, the TS-SDK adheres to beta rules:

- **Beta Versions:** While in the 0.x.x versions, if a breaking change is introduced, the Major version is not incremented; instead, the Minor version is increased. Additionally, these versions will end with the `-beta` suffix, for example `0.2.0-beta`.
- **Beta Versions:** While in the 0.x.x versions, if a breaking change is introduced, the Major version is not incremented; instead, the Minor version is increased. Additionally, these versions will end with the `-beta` suffix, for example `0.3.0-beta`.

## Release Checklist

Expand All @@ -29,7 +29,7 @@ Before version 1, the TS-SDK adheres to beta rules:
- Update version numbers in project metadata.

4. **QA Approval:**

- Obtain approval from the Quality Assurance (QA) team.

### Release Checklist:
Expand Down Expand Up @@ -59,7 +59,7 @@ Before version 1, the TS-SDK adheres to beta rules:
- Manually trigger the `deploy docs` github action

6. **Announcement:**

- Contact the marketing and devrel team to announce the release.

## Note:
Expand Down
76 changes: 39 additions & 37 deletions jsdelivr-npm-importmap.js
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,81 @@
const importMap = {
imports: {
"@marlowe.io/adapter":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/adapter.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/adapter.js",
"@marlowe.io/adapter/assoc-map":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/assoc-map.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/assoc-map.js",
"@marlowe.io/adapter/bigint":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/bigint.js",
"@marlowe.io/adapter/codec":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/codec.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/codec.js",
"@marlowe.io/adapter/deep-equal":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/deep-equal.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/deep-equal.js",
"@marlowe.io/adapter/file":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/file.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/file.js",
"@marlowe.io/adapter/fp-ts":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/fp-ts.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/fp-ts.js",
"@marlowe.io/adapter/http":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/http.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/http.js",
"@marlowe.io/adapter/io-ts":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/io-ts.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/io-ts.js",
"@marlowe.io/adapter/lucid":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/lucid.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/lucid.js",
"@marlowe.io/adapter/time":
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc1/dist/bundled/esm/time.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/adapter@0.3.0-beta-rc2/dist/bundled/esm/time.js",
"@marlowe.io/language-core-v1":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/language-core-v1.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/language-core-v1.js",
"@marlowe.io/language-core-v1/guards":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/guards.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/guards.js",
"@marlowe.io/language-core-v1/next":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/next.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/next.js",
"@marlowe.io/language-core-v1/playground-v1":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/playground-v1.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/playground-v1.js",
"@marlowe.io/language-core-v1/semantics":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/semantics.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/semantics.js",
"@marlowe.io/language-core-v1/version":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc1/dist/bundled/esm/version.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-core-v1@0.3.0-beta-rc2/dist/bundled/esm/version.js",
"@marlowe.io/language-examples":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-examples@0.3.0-beta-rc1/dist/bundled/esm/language-examples.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-examples@0.3.0-beta-rc2/dist/bundled/esm/language-examples.js",
"@marlowe.io/language-specification-client":
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-specification-client@0.3.0-beta-rc1/dist/bundled/esm/language-specification-client.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/language-specification-client@0.3.0-beta-rc2/dist/bundled/esm/language-specification-client.js",
"@marlowe.io/token-metadata-client":
"https://cdn.jsdelivr.net/npm/@marlowe.io/token-metadata-client@0.3.0-beta-rc1/dist/bundled/esm/token-metadata-client.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/token-metadata-client@0.3.0-beta-rc2/dist/bundled/esm/token-metadata-client.js",
"@marlowe.io/wallet":
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc1/dist/bundled/esm/wallet.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc2/dist/bundled/esm/wallet.js",
"@marlowe.io/wallet/api":
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc1/dist/bundled/esm/api.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc2/dist/bundled/esm/api.js",
"@marlowe.io/wallet/browser":
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc1/dist/bundled/esm/browser.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc2/dist/bundled/esm/browser.js",
"@marlowe.io/wallet/lucid":
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc1/dist/bundled/esm/lucid.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/wallet@0.3.0-beta-rc2/dist/bundled/esm/lucid.js",
"@marlowe.io/runtime-rest-client":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/runtime-rest-client.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/runtime-rest-client.js",
"@marlowe.io/runtime-rest-client/contract":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/contract.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/contract.js",
"@marlowe.io/runtime-rest-client/guards":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/guards.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/guards.js",
"@marlowe.io/runtime-rest-client/payout":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/payout.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/payout.js",
"@marlowe.io/runtime-rest-client/transaction":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/transaction.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/transaction.js",
"@marlowe.io/runtime-rest-client/withdrawal":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc1/dist/bundled/esm/withdrawal.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-rest-client@0.3.0-beta-rc2/dist/bundled/esm/withdrawal.js",
"@marlowe.io/runtime-core":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-core@0.3.0-beta-rc1/dist/bundled/esm/runtime-core.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-core@0.3.0-beta-rc2/dist/bundled/esm/runtime-core.js",
"@marlowe.io/runtime-lifecycle":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc1/dist/bundled/esm/runtime-lifecycle.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc2/dist/bundled/esm/runtime-lifecycle.js",
"@marlowe.io/runtime-lifecycle/api":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc1/dist/bundled/esm/api.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc2/dist/bundled/esm/api.js",
"@marlowe.io/runtime-lifecycle/browser":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc1/dist/bundled/esm/browser.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc2/dist/bundled/esm/browser.js",
"@marlowe.io/runtime-lifecycle/generic":
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc1/dist/bundled/esm/generic.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/runtime-lifecycle@0.3.0-beta-rc2/dist/bundled/esm/generic.js",
"@marlowe.io/marlowe-object":
"https://cdn.jsdelivr.net/npm/@marlowe.io/marlowe-object@0.3.0-beta-rc1/dist/bundled/esm/marlowe-object.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/marlowe-object@0.3.0-beta-rc2/dist/bundled/esm/marlowe-object.js",
"@marlowe.io/marlowe-object/guards":
"https://cdn.jsdelivr.net/npm/@marlowe.io/marlowe-object@0.3.0-beta-rc1/dist/bundled/esm/guards.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/marlowe-object@0.3.0-beta-rc2/dist/bundled/esm/guards.js",
"@marlowe.io/testing-kit":
"https://cdn.jsdelivr.net/npm/@marlowe.io/testing-kit@0.3.0-beta-rc1/dist/bundled/esm/testing-kit.js",
"https://cdn.jsdelivr.net/npm/@marlowe.io/testing-kit@0.3.0-beta-rc2/dist/bundled/esm/testing-kit.js",
"lucid-cardano": "https://unpkg.com/lucid-cardano@0.10.7/web/mod.js",
},
};
Expand Down
Loading

0 comments on commit 8678060

Please sign in to comment.