@monerium/sdk 2.6.1 → 2.6.4
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 +24 -0
- package/README.md +16 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.6.4](https://github.com/monerium/sdk/compare/v2.6.3...v2.6.4) (2023-10-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **docs:** add links and fix sidebar not expading ([c8eab4a](https://github.com/monerium/sdk/commit/c8eab4a2006ea7068c442828c7e2e65eaedf8b71))
|
|
9
|
+
|
|
10
|
+
## [2.6.3](https://github.com/monerium/sdk/compare/v2.6.2...v2.6.3) (2023-10-18)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* tests ([6be0014](https://github.com/monerium/sdk/commit/6be00148724942bdca74bbeea961b8b33bcd80f7))
|
|
16
|
+
|
|
17
|
+
## [2.6.2](https://github.com/monerium/sdk/compare/v2.6.1...v2.6.2) (2023-10-18)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* add missing info from README [no-ci] ([600bda5](https://github.com/monerium/sdk/commit/600bda52f9d8b61aa47222ace5308d3087e674e5))
|
|
23
|
+
* **docs:** add source code link to README ([c2a9294](https://github.com/monerium/sdk/commit/c2a9294f49e60ba9fd9373d94ec6069b6b559fb0))
|
|
24
|
+
* revert changes to action ([36eada9](https://github.com/monerium/sdk/commit/36eada92b89b9bf1de0659f74479d27b58697975))
|
|
25
|
+
* update docs on every push to main ([e0f57e6](https://github.com/monerium/sdk/commit/e0f57e61312a5fce0d02608eed6fc7c5aaba5b09))
|
|
26
|
+
|
|
3
27
|
## [2.6.1](https://github.com/monerium/sdk/compare/v2.6.0...v2.6.1) (2023-09-11)
|
|
4
28
|
|
|
5
29
|
|
package/README.md
CHANGED
|
@@ -3,10 +3,16 @@
|
|
|
3
3
|
Everything you need to interact with the [Monerium API](https://monerium.dev/api-docs) - an electronic money issuer.
|
|
4
4
|
|
|
5
5
|
_This package is in development. Please make sure to check if any future updates contain commits
|
|
6
|
-
that may change the behavior of your application before you upgrade._
|
|
6
|
+
that may change the behavior of your application before you upgrade. If you find any issues please report them [here](https://github.com/monerium/sdk/issues)._
|
|
7
|
+
|
|
8
|
+
[NPM package](https://www.npmjs.com/package/@monerium/sdk)
|
|
9
|
+
|
|
10
|
+
[Source code](https://github.com/monerium/sdk)
|
|
7
11
|
|
|
8
12
|
[SDK Documentation](https://monerium.github.io/sdk/)
|
|
9
13
|
|
|
14
|
+
[SDK JS-Docs](https://monerium.github.io/sdk/)
|
|
15
|
+
|
|
10
16
|
[Code coverage](https://monerium.github.io/sdk/coverage)
|
|
11
17
|
|
|
12
18
|
## Installing
|
|
@@ -37,7 +43,7 @@ networks: `mainnet`, `mainnet`, `mainnet`.
|
|
|
37
43
|
|
|
38
44
|
## Getting started
|
|
39
45
|
|
|
40
|
-
|
|
46
|
+
We recommend starting in the [Developer Portal](https://monerium.dev/docs/welcome). There you will learn more about `client_id`'s and ways of authenticating.
|
|
41
47
|
|
|
42
48
|
### Import the SDK and initialize a client
|
|
43
49
|
|
|
@@ -59,6 +65,9 @@ await client.auth({
|
|
|
59
65
|
|
|
60
66
|
// User is now authenticated, get authentication data
|
|
61
67
|
await client.getAuthContext()
|
|
68
|
+
|
|
69
|
+
// You can now find your access and refresh token here:
|
|
70
|
+
const { access_token, refresh_token } = client.bearerProfile;
|
|
62
71
|
```
|
|
63
72
|
|
|
64
73
|
### Authenticate using auth flow
|
|
@@ -66,7 +75,8 @@ await client.getAuthContext()
|
|
|
66
75
|
```ts
|
|
67
76
|
// Construct the authFlowUrl for your application and redirect your customer.
|
|
68
77
|
let authFlowUrl = client.getAuthFlowURI({
|
|
69
|
-
client_id: "your_client_authflow_uuid"
|
|
78
|
+
client_id: "your_client_authflow_uuid",
|
|
79
|
+
redirect_uri: "http://your-webpage.com/monerium-integration"
|
|
70
80
|
// optional automatic wallet selection:
|
|
71
81
|
network: "mumbai",
|
|
72
82
|
chain: "polygon",
|
|
@@ -93,6 +103,9 @@ await client.auth({
|
|
|
93
103
|
|
|
94
104
|
// User is now authenticated, get authentication data
|
|
95
105
|
await client.getAuthContext();
|
|
106
|
+
|
|
107
|
+
// You can now find your access and refresh token here:
|
|
108
|
+
const { access_token, refresh_token } = client.bearerProfile;
|
|
96
109
|
```
|
|
97
110
|
|
|
98
111
|
## Contributing
|