Skip to content

Commit adf1415

Browse files
zivkovicmiloszivkovicmilos
committed
Add remaining base endpoints to the WS provider
1 parent f88ffc1 commit adf1415

11 files changed

+348
-93
lines changed

‎.eslintrc.js

-8
This file was deleted.

‎.eslintrc.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"parser": "@typescript-eslint/parser",
3+
"plugins": ["@typescript-eslint"],
4+
"extends": [
5+
"plugin:@typescript-eslint/recommended",
6+
"plugin:prettier/recommended"
7+
]
8+
}

‎jest.config.js

-6
This file was deleted.

‎jest.config.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"preset": "ts-jest",
3+
"testEnvironment": "node",
4+
"modulePathIgnorePatterns": ["bin", "node_modules"]
5+
}

‎src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './provider';

‎src/provider/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export { JSONRPCProvider } from './jsonrpc/jsonrpc';
2+
export { WSProvider } from './websocket/websocket';

‎src/provider/spec/utility.ts

+11
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,14 @@ export function parseABCI<Result>(data: string): Result {
5353

5454
return parsedData;
5555
}
56+
57+
/**
58+
* Converts a string into base64 representation
59+
* @param {string} str the raw string
60+
* @returns {string} the base64 representation of the string
61+
*/
62+
export function stringToBase64(str: string): string {
63+
const buffer = Buffer.from(str, 'utf-8');
64+
65+
return buffer.toString('base64');
66+
}

‎src/provider/test/ws.test.ts

-48
This file was deleted.

‎src/provider/test/jsonrpc.test.ts ‎src/provider/tests/jsonrpc.test.ts

+7-18
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
} from '../types';
88
import axios from 'axios';
99
import { JSONRPCProvider } from '../jsonrpc/jsonrpc';
10-
import { newResponse } from '../spec/utility';
10+
import { newResponse, stringToBase64 } from '../spec/utility';
1111
import { mock } from 'jest-mock-extended';
1212
import { ABCIResponse } from '../spec/abci';
1313
import { ABCIAccount } from '../abciTypes';
@@ -44,10 +44,10 @@ describe('JSON-RPC Provider', () => {
4444

4545
// Create the provider
4646
const provider = new JSONRPCProvider(mockURL);
47-
const info = await provider.getConsensusParams(1);
47+
const params = await provider.getConsensusParams(1);
4848

4949
expect(axios.post).toHaveBeenCalled();
50-
expect(info).toEqual(mockParams);
50+
expect(params).toEqual(mockParams);
5151
});
5252

5353
test('getStatus', async () => {
@@ -60,10 +60,10 @@ describe('JSON-RPC Provider', () => {
6060

6161
// Create the provider
6262
const provider = new JSONRPCProvider(mockURL);
63-
const info = await provider.getStatus();
63+
const status = await provider.getStatus();
6464

6565
expect(axios.post).toHaveBeenCalled();
66-
expect(info).toEqual(mockStatus);
66+
expect(status).toEqual(mockStatus);
6767
});
6868

6969
test('getBlockNumber', async () => {
@@ -77,10 +77,10 @@ describe('JSON-RPC Provider', () => {
7777

7878
// Create the provider
7979
const provider = new JSONRPCProvider(mockURL);
80-
const info = await provider.getBlockNumber();
80+
const blockNumber = await provider.getBlockNumber();
8181

8282
expect(axios.post).toHaveBeenCalled();
83-
expect(info).toEqual(expectedBlockNumber);
83+
expect(blockNumber).toEqual(expectedBlockNumber);
8484
});
8585

8686
describe('getBalance', () => {
@@ -152,14 +152,3 @@ describe('JSON-RPC Provider', () => {
152152
});
153153
});
154154
});
155-
156-
/**
157-
* Converts a string into base64 representation
158-
* @param {string} str the raw string
159-
* @returns {string} the base64 representation of the string
160-
*/
161-
const stringToBase64 = (str: string): string => {
162-
const buffer = Buffer.from(str, 'utf-8');
163-
164-
return buffer.toString('base64');
165-
};

‎src/provider/tests/ws.test.ts

+220
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
import {
2+
ConsensusParams,
3+
ConsensusState,
4+
consensusStateKey,
5+
NetworkInfo,
6+
Status,
7+
} from '../types';
8+
import { WebSocketServer } from 'ws';
9+
import { WSProvider } from '../websocket/websocket';
10+
import { newResponse, stringToBase64 } from '../spec/utility';
11+
import { ABCIAccount } from '../abciTypes';
12+
import { ABCIResponse } from '../spec/abci';
13+
14+
// TODO Resolve wss contention
15+
describe.skip('WS Provider', () => {
16+
const wsPort = 8545;
17+
const wsHost = 'localhost';
18+
const wsURL = `ws://${wsHost}:${wsPort}`;
19+
20+
let wsProvider: WSProvider;
21+
let server: WebSocketServer;
22+
23+
/**
24+
* Sets up the test response handler (single-response)
25+
* @param {WebSocketServer} wss the websocket server returning data
26+
* @param {Type} testData the test data being returned to the client
27+
*/
28+
const setHandler = <Type>(testData: Type) => {
29+
server.on('connection', (socket) => {
30+
socket.on('message', (data) => {
31+
const request = JSON.parse(data.toString());
32+
const response = newResponse<Type>(testData);
33+
response.id = request.id;
34+
35+
socket.send(JSON.stringify(response));
36+
});
37+
});
38+
};
39+
40+
const mockABCIResponse = (response: string): ABCIResponse => {
41+
return {
42+
response: {
43+
ResponseBase: {
44+
Log: '',
45+
Info: '',
46+
Data: stringToBase64(response),
47+
Error: null,
48+
Events: null,
49+
},
50+
Key: null,
51+
Value: null,
52+
Proof: null,
53+
Height: '',
54+
},
55+
};
56+
};
57+
58+
beforeEach(async () => {
59+
server = new WebSocketServer({
60+
host: wsHost,
61+
port: wsPort,
62+
});
63+
64+
wsProvider = new WSProvider(wsURL);
65+
});
66+
67+
afterEach(() => {
68+
server.removeAllListeners();
69+
server.close();
70+
wsProvider.closeConnection();
71+
});
72+
73+
test('getNetwork', async () => {
74+
const mockInfo: NetworkInfo = {
75+
listening: false,
76+
listeners: [],
77+
n_peers: '0',
78+
peers: [],
79+
};
80+
81+
// Set the response
82+
setHandler<NetworkInfo>(mockInfo);
83+
84+
const info: NetworkInfo = await wsProvider.getNetwork();
85+
expect(info).toEqual(mockInfo);
86+
});
87+
88+
test('getStatus', async () => {
89+
const mockStatus: Status = {
90+
node_info: {
91+
version_set: [],
92+
net_address: '',
93+
network: '',
94+
software: '',
95+
version: '',
96+
channels: '',
97+
monkier: '',
98+
other: {
99+
tx_index: '',
100+
rpc_address: '',
101+
},
102+
},
103+
sync_info: {
104+
latest_block_hash: '',
105+
latest_app_hash: '',
106+
latest_block_height: '',
107+
latest_block_time: '',
108+
catching_up: false,
109+
},
110+
validator_info: {
111+
address: '',
112+
pub_key: {
113+
type: '',
114+
value: '',
115+
},
116+
voting_power: '',
117+
},
118+
};
119+
120+
mockStatus.validator_info.address = 'address';
121+
122+
// Set the response
123+
setHandler<Status>(mockStatus);
124+
125+
const status: Status = await wsProvider.getStatus();
126+
expect(status).toEqual(status);
127+
});
128+
129+
test('getConsensusParams', async () => {
130+
const mockParams: ConsensusParams = {
131+
block_height: '',
132+
consensus_params: {
133+
Block: {
134+
MaxTxBytes: '',
135+
MaxDataBytes: '',
136+
MaxBlockBytes: '',
137+
MaxGas: '',
138+
TimeIotaMS: '',
139+
},
140+
Validator: {
141+
PubKeyTypeURLs: [],
142+
},
143+
},
144+
};
145+
146+
// Set the response
147+
setHandler<ConsensusParams>(mockParams);
148+
149+
const params: ConsensusParams = await wsProvider.getConsensusParams(1);
150+
expect(params).toEqual(mockParams);
151+
});
152+
153+
test('getBlockNumber', async () => {
154+
const expectedBlockNumber = 10;
155+
const mockState: ConsensusState = {
156+
round_state: {
157+
start_time: '',
158+
proposal_block_hash: '',
159+
locked_block_hash: '',
160+
valid_block_hash: '',
161+
height_vote_set: {},
162+
},
163+
};
164+
mockState.round_state[consensusStateKey] = `${expectedBlockNumber}/0/0`;
165+
166+
// Set the response
167+
setHandler<ConsensusState>(mockState);
168+
169+
const blockNumber: number = await wsProvider.getBlockNumber();
170+
expect(blockNumber).toBe(expectedBlockNumber);
171+
});
172+
173+
describe('getSequence', () => {
174+
const validAccount: ABCIAccount = {
175+
BaseAccount: {
176+
address: 'random address',
177+
coins: '',
178+
public_key: null,
179+
account_number: '0',
180+
sequence: '10',
181+
},
182+
};
183+
184+
test.each([
185+
[
186+
JSON.stringify(validAccount),
187+
parseInt(validAccount.BaseAccount.sequence, 10),
188+
], // account exists
189+
['null', 0], // account doesn't exist
190+
])('case %#', async (response, expected) => {
191+
const mockResponse: ABCIResponse = mockABCIResponse(response);
192+
193+
// Set the response
194+
setHandler<ABCIResponse>(mockResponse);
195+
196+
const sequence: number = await wsProvider.getSequence('address');
197+
expect(sequence).toBe(expected);
198+
});
199+
});
200+
201+
describe('getBalance', () => {
202+
const denomination = 'atom';
203+
test.each([
204+
['5gnot,100atom', 100], // balance found
205+
['5universe', 0], // balance not found
206+
['""', 0], // account doesn't exist
207+
])('case %#', async (existing, expected) => {
208+
const mockResponse: ABCIResponse = mockABCIResponse(existing);
209+
210+
// Set the response
211+
setHandler<ABCIResponse>(mockResponse);
212+
213+
const balance: number = await wsProvider.getBalance(
214+
'address',
215+
denomination
216+
);
217+
expect(balance).toBe(expected);
218+
});
219+
});
220+
});

0 commit comments

Comments
 (0)