@gardenfi/core 0.1.0 → 0.1.1
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.
- package/README.md +6 -6
- package/package.json +2 -2
- package/CHANGELOG.md +0 -7
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @gardenfi/core
|
|
2
2
|
|
|
3
|
-
The `@
|
|
3
|
+
The `@gardenfi/core` package serves as an abstraction layer over the `@catalogfi/wallets` and `@gardenfi/orderbook` packages. It provides a simple interface to perform atomic swaps.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```
|
|
8
|
-
npm install `@
|
|
8
|
+
npm install `@gardenfi/core`
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
For more information regarding using the library in different environments see [setup](https://github.com/catalogfi/
|
|
11
|
+
For more information regarding using the library in different environments see [setup](https://github.com/catalogfi/garden.js/tree/main/packages/core#setup).
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
|
-
1. Creating an atomic swap: ([should create an order with valid parameters](https://github.com/catalogfi/
|
|
16
|
-
2. Interacting with created orders: ([should initiate and redeem](https://github.com/catalogfi/
|
|
15
|
+
1. Creating an atomic swap: ([should create an order with valid parameters](https://github.com/catalogfi/garden.js/blob/4623a0679d1948755500c7179113112a025e33f8/packages/core/src/lib/garden.spec.ts#L91))
|
|
16
|
+
2. Interacting with created orders: ([should initiate and redeem](https://github.com/catalogfi/garden.js/blob/4623a0679d1948755500c7179113112a025e33f8/packages/core/src/lib/garden.spec.ts#L107))
|
|
17
17
|
|
|
18
18
|
## Setup
|
|
19
19
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gardenfi/core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"dependencies": {
|
|
6
6
|
"@catalogfi/utils": "^0.1.0",
|
|
7
7
|
"@catalogfi/wallets": "^0.2.0",
|
|
8
|
-
"@gardenfi/orderbook": "^0.1.
|
|
8
|
+
"@gardenfi/orderbook": "^0.1.1",
|
|
9
9
|
"ethers": "6.8.0"
|
|
10
10
|
},
|
|
11
11
|
"files": [
|