@meshsdk/core 1.7.31 → 1.7.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +39 -17
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -8,14 +8,14 @@
8
8
 
9
9
  <h1 style="border-bottom: none"><a href='https://meshjs.dev/'>Mesh</a> TypeScript SDK</h1>
10
10
 
11
- [![Licence](https://img.shields.io/github/license/meshjs/mesh)](https://github.com/meshjs/mesh/blob/master/LICENSE)
12
- [![Build](https://github.com/meshjs/mesh/actions/workflows/build.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/build.yml)
13
- [![Package](https://github.com/meshjs/mesh/actions/workflows/publish.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/publish.yml)
11
+ [![Licence](https://img.shields.io/github/license/meshjs/mesh)](https://github.com/meshjs/mesh/blob/master/LICENSE)
12
+ [![Build](https://github.com/meshjs/mesh/actions/workflows/build.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/build.yml)
13
+ [![Package](https://github.com/meshjs/mesh/actions/workflows/publish.yml/badge.svg)](https://github.com/meshjs/mesh/actions/workflows/publish.yml)
14
14
 
15
- [![Twitter/X](https://img.shields.io/badge/Follow%20us-@MeshJS-blue?logo=x&style=for-the-badge)](https://x.com/meshsdk)
16
- [![NPM](https://img.shields.io/npm/v/%40meshsdk%2Fcore?style=for-the-badge)](https://www.npmjs.com/package/@meshsdk/core)
15
+ [![Twitter/X](https://img.shields.io/badge/Follow%20us-@MeshJS-blue?logo=x&style=for-the-badge)](https://x.com/meshsdk)
16
+ [![NPM](https://img.shields.io/npm/v/%40meshsdk%2Fcore?style=for-the-badge)](https://www.npmjs.com/package/@meshsdk/core)
17
17
 
18
- <strong>All-in-one web3 SDK for Cardano apps</strong>
18
+ <strong>All-in-one TypeScript SDK for Cardano apps</strong>
19
19
 
20
20
  </div>
21
21
 
@@ -25,12 +25,18 @@ Mesh is an open-source library designed to make building dApps accessible. Wheth
25
25
 
26
26
  Explore the features on [Mesh Playground](https://meshjs.dev/).
27
27
 
28
- ## What's inside?
28
+ Instant setup a new project with a single command using Mesh CLI and start building:
29
29
 
30
- This repo includes the following packages/apps:
30
+ ```
31
+ npx meshjs your-app-name
32
+ ```
33
+
34
+ ## What's inside?
31
35
 
32
36
  ### Packages
33
37
 
38
+ A collection of packages that provide different functionalities to interact with the Cardano blockchain.
39
+
34
40
  | | Description | Docs | Playground |
35
41
  | --- | --- | --- | --- |
36
42
  | [@meshsdk/common](https://github.com/MeshJS/mesh/tree/main/packages/mesh-common) | Contains constants, types and interfaces used across the SDK and different serialization libraries | [:page_facing_up:](https://docs.meshjs.dev/common) | |
@@ -45,20 +51,30 @@ This repo includes the following packages/apps:
45
51
 
46
52
  ### Apps
47
53
 
54
+ Frontend documentation and live demos for Mesh SDK.
55
+
48
56
  | | Description | Website |
49
57
  | --- | --- | --- |
50
58
  | [apps/docs](https://github.com/MeshJS/mesh/tree/main/apps/docs) | Mesh technical docs | [:shipit:](https://docs.meshjs.dev/) |
51
59
  | [apps/playground](https://github.com/MeshJS/mesh/tree/main/apps/playground) | Mesh homepage and live demos | [:shipit:](https://meshjs.dev/) |
52
60
 
53
- ## Getting Started
61
+ ### Mesh Smart Contracts Library
54
62
 
55
- ### Usage
63
+ Here's a list of open-source smart contracts, complete with documentation, live demos, and end-to-end source code.
56
64
 
57
- To use Mesh in your project, run the following command to install the core package:
58
-
59
- ```
60
- npm install @meshsdk/core
61
- ```
65
+ | Contract | Description | Links |
66
+ | --- | --- | --- |
67
+ | Content Ownership | Create a content registry and users can create content that is stored in the registry | [[demo](https://meshjs.dev/smart-contracts/content-ownership)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/content-ownership)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshContentOwnershipContract)] |
68
+ | Escrow | Facilitates the secure exchange of assets between two parties by acting as a trusted intermediary that holds the assets until the conditions of the agreement are met | [[demo](https://meshjs.dev/smart-contracts/escrow)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/escrow)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshEscrowContract)] |
69
+ | Giftcard | Allows users to create a transactions to lock assets into the smart contract, which can be redeemed by any user | [[demo](https://meshjs.dev/smart-contracts/giftcard)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/giftcard)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshGiftcardContract)] |
70
+ | Hello World | A simple lock-and-unlock assets contract, providing a hands-on introduction to end-to-end smart contract validation and transaction building | [[demo](https://meshjs.dev/smart-contracts/hello-world)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/hello-world)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshHelloWorldContract)] |
71
+ | Marketplace | Allows anyone to buy and sell native assets such as NFTs | [[demo](https://meshjs.dev/smart-contracts/marketplace)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/marketplace)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshMarketplaceContract)] |
72
+ | NFT Minting Machine | Mint NFTs with an automatically incremented index, which increases by one for each newly minted NFT | [[demo](https://meshjs.dev/smart-contracts/plutus-nft)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/plutus-nft)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshPlutusNFTContract)] |
73
+ | Payment Splitter | Allows users to split incoming payments among a group of accounts | [[demo](https://meshjs.dev/smart-contracts/payment-splitter)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/payment-splitter)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshPaymentSplitterContract)] |
74
+ | Swap | Facilitates the exchange of assets between two parties | [[demo](https://meshjs.dev/smart-contracts/swap)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/swap)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshSwapContract)] |
75
+ | Vesting | Allows users to lock tokens for a period of time and withdraw the funds after the lockup period | [[demo](https://meshjs.dev/smart-contracts/vesting)] [[source](https://github.com/MeshJS/mesh/tree/main/packages/mesh-contract/src/vesting)] [[docs](https://docs.meshjs.dev/contracts/classes/MeshVestingContract)] |
76
+
77
+ ## Usage
62
78
 
63
79
  ### Install
64
80
 
@@ -76,12 +92,18 @@ To build all apps and packages, run the following command:
76
92
  npm run build
77
93
  ```
78
94
 
79
- ### Develop
95
+ ### Run
80
96
 
81
- To develop all apps and packages, run the following command:
97
+ To run all apps and packages, run the following command:
82
98
 
83
99
  ```
84
100
  npm run dev
85
101
  ```
86
102
 
103
+ ## Contributing
104
+
105
+ Mesh SDK project welcomes all constructive contributions. Contributions take many forms, from code for bug fixes and enhancements, to additions and fixes to documentation, additional tests, triaging incoming pull requests and issues, and more!
106
+
107
+ Check out the [contributing guide](https://github.com/MeshJS/mesh/blob/main/CONTRIBUTING.md).
108
+
87
109
  ![Alt](https://repobeats.axiom.co/api/embed/a55b792080ada8db32fb84c10addc7b4afab7679.svg "Repobeats analytics image")
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meshsdk/core",
3
- "version": "1.7.31",
3
+ "version": "1.7.33",
4
4
  "description": "Mesh SDK Core - https://meshjs.dev/",
5
5
  "main": "./dist/index.cjs",
6
6
  "browser": "./dist/index.js",
@@ -33,13 +33,13 @@
33
33
  "typescript": "^5.3.3"
34
34
  },
35
35
  "dependencies": {
36
- "@meshsdk/common": "1.7.31",
37
- "@meshsdk/core-csl": "1.7.31",
38
- "@meshsdk/core-cst": "1.7.31",
39
- "@meshsdk/provider": "1.7.31",
40
- "@meshsdk/react": "1.7.31",
41
- "@meshsdk/transaction": "1.7.31",
42
- "@meshsdk/wallet": "1.7.31"
36
+ "@meshsdk/common": "1.7.33",
37
+ "@meshsdk/core-csl": "1.7.33",
38
+ "@meshsdk/core-cst": "1.7.33",
39
+ "@meshsdk/provider": "1.7.33",
40
+ "@meshsdk/react": "1.7.33",
41
+ "@meshsdk/transaction": "1.7.33",
42
+ "@meshsdk/wallet": "1.7.33"
43
43
  },
44
44
  "prettier": "@meshsdk/configs/prettier",
45
45
  "publishConfig": {