@monerium/sdk 2.5.2 → 2.6.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/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.6.1](https://github.com/monerium/sdk/compare/v2.6.0...v2.6.1) (2023-09-11)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * add info how to set environment ([c803cc5](https://github.com/monerium/sdk/commit/c803cc579ea11006ab845d4a4790e2a9bffae0b0))
9
+
10
+ ## [2.6.0](https://github.com/monerium/sdk/compare/v2.5.2...v2.6.0) (2023-07-19)
11
+
12
+
13
+ ### Features
14
+
15
+ * removed Chain and Network enum ([600a634](https://github.com/monerium/sdk/commit/600a6348f4f6ce0b3f2cc472c807520620bc0d60))
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * constants typed import ([600a634](https://github.com/monerium/sdk/commit/600a6348f4f6ce0b3f2cc472c807520620bc0d60))
21
+
3
22
  ## [2.5.2](https://github.com/monerium/sdk/compare/v2.5.1...v2.5.2) (2023-07-05)
4
23
 
5
24
 
package/README.md CHANGED
@@ -44,7 +44,9 @@ If you are new here, we recommend starting in the [Developer Portal](https://mon
44
44
  ```ts
45
45
  import { MoneriumClient } from '@monerium/sdk';
46
46
 
47
- const client = new MoneriumClient();
47
+ // By default, the client will use the sandbox environment.
48
+ // To change to production, pass "production" as the first argument.
49
+ const client = new MoneriumClient('sandbox');
48
50
  ```
49
51
 
50
52
  ### Authenticate using client credentials
@@ -112,10 +114,10 @@ yarn dlx @yarnpkg/sdks vscode
112
114
 
113
115
  For development, a package can be linked into another project. This is often useful to test out new features or when trying to debug an issue in a package that manifests itself in another project. run yarn link inside of the sdk project.
114
116
 
115
-
116
117
  ```sh
117
118
  YARN_IGNORE_PATH=1 yarn link
118
119
  ```
120
+
119
121
  Use `yarn link "@monerium/sdk"` to link and test into your current project.
120
122
 
121
123
  ```sh
@@ -123,7 +125,6 @@ cd ../your-project
123
125
  yarn link "@monerium/sdk"
124
126
  ```
125
127
 
126
-
127
128
  ## Publishing
128
129
 
129
130
  When changes are merged to the `main` branch that follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, [release-please](https://github.com/googleapis/release-please) workflow creates a pull request, preparing for the next release. If kept open, the following commits will also be added to the PR. Merging that PR will create a new release, a workflow will publish it on NPM and tag it on Github.
package/dist/index.d.ts CHANGED
@@ -320,6 +320,9 @@ export declare class MoneriumClient {
320
320
  placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
321
321
  uploadSupportingDocument(document: File): Promise<SupportingDoc>;
322
322
  }
323
+ export declare const constants: {
324
+ LINK_MESSAGE: string;
325
+ };
323
326
  export declare const rfc3339: (d: Date) => string;
324
327
  /**
325
328
  * The message to be signed when placing an order.