Skip to content

Commit 139778b

Browse files
authored
v2.0.0
2 parents 1c19cd6 + f869d60 commit 139778b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+10244
-2875
lines changed

.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

.eslintrc.js

Lines changed: 0 additions & 29 deletions
This file was deleted.

.eslintrc.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"extends": "./node_modules/gts/",
3+
"overrides": [
4+
{
5+
"files": ["*.test.ts"],
6+
"rules": {
7+
"@typescript-eslint/no-explicit-any": 0
8+
}
9+
}
10+
]
11+
}

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
dist
12
node_modules/
23
logs/
4+
.idea/
35
.vscode/
46
test.js
5-
package-lock.json
67
.editorconfig
8+
.DS_Store

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/sh
22
. "$(dirname "$0")/_/husky.sh"
33

4-
npm run lint
4+
npm run test

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

.prettierrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
...require('gts/.prettierrc.json')
3+
}

CHANGELOG.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Changelog
2+
3+
## [2.0.0] - 2023-10-12
4+
5+
### Added
6+
7+
- **TypeScript support**
8+
9+
The project was fully rewritten in TypeScript, which means it supports typings now.
10+
11+
_See [examples](./examples/) directory._
12+
13+
- **More API methods**
14+
15+
Added more API methods:
16+
17+
```js
18+
// before
19+
const block = await api.get('blocks/get', { id });
20+
21+
// after
22+
const block = await api.getBlock(id);
23+
```
24+
25+
and `post()` method:
26+
27+
```js
28+
await api.post('transactions/process', { transaction });
29+
```
30+
31+
### Fixed
32+
33+
- **Creating multiple instances**
34+
35+
Previously, it was not possible to create multiple instances due to the storage of Logger and "Node Manager" data in the modules.
36+
37+
- **Importing module several times**
38+
39+
Fixed a bug where importing adamant-api-jsclient caused issues when it was also imported as a dependency.
40+
41+
### Changed
42+
43+
- **API Initialization**
44+
45+
Now you will create new instances of `adamant-api` using keyword `new`:
46+
47+
```js
48+
import { AdamantApi } from 'adamant-api';
49+
50+
const api = new AdamantApi({ nodes: [/* ... */] });
51+
```
52+
53+
- **Socket Initialization**
54+
55+
Replace `api.socket.initSocket()` with `api.initSocket()`.
56+
57+
Use `api.socket.on()` instead of `.initSocket({ onNewMessage() {} })`.
58+
59+
```ts
60+
// before
61+
api.socket.initSocket({
62+
admAddress: 'U1234..',
63+
onNewMessage(transaction) {
64+
// ...
65+
},
66+
});
67+
68+
// after
69+
api.initSocket({ admAddress: 'U1234..' });
70+
71+
api.socket.on((transaction: AnyTransaction) => {
72+
// ...
73+
});
74+
```
75+
76+
or specify `socket` option when initializing API:
77+
78+
```ts
79+
// socket.ts
80+
import { WebSocketClient, TransactionType } from 'adamant-api';
81+
82+
const socket = new WebSocketClient({ admAddress: 'U1234..' });
83+
84+
socket.on([TransactionType.CHAT_MESSAGE, TransactionType.SEND], (transaction) => {
85+
// handle chat messages and transfer tokens transactions
86+
});
87+
88+
socket.on(TransactionType.VOTE, (transaction) => {
89+
// handle vote for delegate transaction
90+
});
91+
92+
export { socket };
93+
```
94+
95+
```ts
96+
// api.ts
97+
import { AdamantApi } from 'adamant-api';
98+
import { socket } from './socket';
99+
100+
export const api = new AdamantApi({
101+
socket,
102+
nodes: [/* ... */],
103+
});
104+
```
105+
106+
### Removeed
107+
108+
- `createTransaction()`
109+
110+
Use `createSendTransaction`, `createStateTransaction`, `createChatTransaction`, `createDelegateTransaction`, `createVoteTransaction` methods instead.

CODE_OF_CONDUCT.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

0 commit comments

Comments
 (0)