Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PLT-7420 Add nixago and treefmt configuration #23

Merged
merged 3 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,8 @@ dist
test-dist

package-lock.json
yarn.lock
yarn.lock
# nixago: ignore-linked-files
/lefthook.yml
/.editorconfig
/treefmt.toml
76 changes: 42 additions & 34 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,71 +3,79 @@
</div>

Official Links
- Website : <a href="https://marlowe.iohk.io" > marlowe.iohk.io </a>
- Documentation :<a href="https://docs.marlowe.iohk.io" > docs.marlowe.iohk.io </a>
- Playground : <a href="https://play.marlowe.iohk.io" > play.marlowe.iohk.io </a>
- Blog : <a href="https://marlowe.iohk.io/blog" > marlowe.iohk.io/blog </a>
- Support : <a href="https://iohk.zendesk.com/hc/en-us/requests/new" > iohk.zendesk.com </a>

**Repository Status** : *Beta* (Warning : Work still under progress)
- Website : <a href="https://marlowe.iohk.io" > marlowe.iohk.io </a>
- Documentation :<a href="https://docs.marlowe.iohk.io" > docs.marlowe.iohk.io </a>
- Playground : <a href="https://play.marlowe.iohk.io" > play.marlowe.iohk.io </a>
- Blog : <a href="https://marlowe.iohk.io/blog" > marlowe.iohk.io/blog </a>
- Support : <a href="https://iohk.zendesk.com/hc/en-us/requests/new" > iohk.zendesk.com </a>

**Repository Status** : _Beta_ (Warning : Work still under progress)

# Overview

`marlowe-ts-sdk` is a suite of **TypeScript/JavaScript** libraries for Web Cardano Dapp Development using Marlowe Technologies.
`marlowe-ts-sdk` is a suite of **TypeScript/JavaScript** libraries for Web Cardano Dapp Development using Marlowe Technologies.

It is composed of the following [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces) :

- Language
- Language
- [@marlowe.io/language-core-v1](./packages/language/core/v1/)
- Marlowe Core V1 constructs
- JSON Codec
- Cardano Wallet
- JSON Codec
- Cardano Wallet
- [@marlowe.io/wallet](./packages/runtime/core/)
- Wallet Extension Capabalities (Browser / CIP-30)
- Single Wallet Address Capabalities(NodeJS / Version used for e2e tests only)
- Runtime
- [@marlowe.io/runtime-lifecycle](./packages/runtime/lifecycle/) : Entry Point for Running remotely Marlowe Contracts over a backend instance of the runtime using a connected wallet.
- Marlowe Tx Commands
- Create
- Applying Inputs
- Withdraws
- Query capabilities for supporting these commands
- Wallet Extension Capabalities (Browser / CIP-30)
- Single Wallet Address Capabalities(NodeJS / Version used for e2e tests only)
- Runtime
- [@marlowe.io/runtime-lifecycle](./packages/runtime/lifecycle/) : Entry Point for Running remotely Marlowe Contracts over a backend instance of the runtime using a connected wallet.
- Marlowe Tx Commands
- Create
- Applying Inputs
- Withdraws
- Query capabilities for supporting these commands
- [@marlowe.io/runtime-core](./packages/runtime/core/) : core concepts used throughout the runtime libraries.
- [@marlowe.io/runtime-rest-client](./packages/runtime/client/rest/) : client of the runtime rest api.
- Infrastruture Supporting SubDomains
- Infrastruture Supporting SubDomains
- [@marlowe.io/adapter](./packages/adapter) : supporting set of libraries for Marlowe and Runtime Core Domains.


# Get Started

## Prerequesites

- Runtime instance available : How to ? (TODO)
- Runtime instance available : How to ? (TODO)
- Wallet Extension installed : (TODO)

## Wallet Extensions
### Compatible
- Nami
- Eternl
## Wallet Extensions

### Compatible

- Nami
- Eternl

### Non Compatiible
- Lace

- Lace

### Non Tested
- TODO

## NPM
- TODO

## NPM

```bash
npm install @marlowe.io/adapter @marlowe.io/wallet @marlowe.io/language-core-v1 @marlowe.io/runtime @marlowe.io/runtime-core @marlowe.io/runtime-rest-client
```

## Examples
- TODO
## Examples

- TODO

## Basic usage

## Basic usage
```
TODO
```

# Development
# Development

see documentation [here](./doc/howToDevelop.md).
see documentation [here](./doc/howToDevelop.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Changed

- Reformat code with [prettier](https://prettier.io/) and [alejandra](https://github.com/kamadorueda/alejandra) using the [treefmt](https://github.com/numtide/treefmt-nix) tool
1 change: 0 additions & 1 deletion doc/howToDevelop.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Development

## Build
Expand Down
219 changes: 214 additions & 5 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading