1484 net v2 #1586

lucanicoladebiasi · 2024-12-17T15:06:26Z

Description

This code provides in packages/net a new paradigm to interact with Thor.
The modules aims to substitute the functionalities in packages/net.

The code is purely experimental and will be discussed in the SDK workshop of 14th-15th January in Dublin.

This is a very active development, receiving multiple pushes per day.

** DO NOT MERGE ANYWHERE**

The prototype follows a strict principle I believe an open source SDK connecting with web-services should adhere: all what published as web-service documentation should have its class or method in the SDK. As SDK user persona I want to see the REST or WS documentation and I want to see those elements are represented in the SDK. Then, the SDK can offer me a lot more things, but I should be free to build additional things on the base of elements allowing me to have in the code using the SDK the elements published by Thor documentation.

The prototype has some known defects and limitations. The most important are the following ones.

There is a lot of confusion among what block, blockref, thor and tx id should be.
An undetected problem in the exporting from core module obliged to import few classes through relative paths, that is rubbish. Together, we can fix such problem.
The code is not documented.
The tests are just examples, those are not complete.
The author of the prototype is a well known Object Oriented bigot: sometime he adds classes in an hierarchy when not strictly needed for sake of ontologic UML clarity and extendibility. How much severe is his disease, let's discuss in the workshop.

claytonneal · 2025-01-08T10:29:44Z

packages/core/src/vcdm/BlockId.ts

+/**
+ * This class is an alias of {@link TxId} for back compatibility.
+ */
+class TxId extends BlockId {


theoretically why does a TxId extend a BlockId
to me should be independant - even though they have the same hex number of digits etc

Also the doc comment on the class links to itself.

I'm confused between the concepts of ThorId and TxId and BlockId. From the regex point of view those are the same thing: 64 hexadecimal digits. Are they conceptually different? Or should just have a ThorId class to express block and tx identifier? Let's discuss together.

claytonneal · 2025-01-08T10:31:18Z

packages/core/src/vcdm/BlockId.ts

+     *
+     * @param {TxId} blockId - The unique identifier for the block.
+     */
+    protected constructor(blockId: BlockId) {


variable name doesnt match doc comment , why would i create a TxId from a BlockId?

I didn't pay attention to doc and have many second and third thoughts about block, thor and tx ids.
See above comment.

claytonneal · 2025-01-08T10:31:50Z

packages/core/src/vcdm/BlockId.ts

+    }
+}
+
+export { BlockId, ThorId, TxId };


what is thorId ?

See above, let's discuss.

claytonneal · 2025-01-08T10:32:37Z

packages/core/src/vcdm/Int.ts

@@ -0,0 +1,18 @@
+import { InvalidDataType } from '@vechain/sdk-errors';
+
+class Int extends Number {


Needs a doc comment

claytonneal · 2025-01-08T10:40:27Z

packages/core/src/vcdm/Nonce.ts

+    }
+
+    public static isValid0x(exp: string): boolean {
+        return HexUInt.REGEX_HEXUINT_PREFIX.test(exp) && Nonce.isValid(exp);


whats the purpose of this? as HexUInt.REGEX_HEXUINT_PREFIX.test(exp) is applied twice

worth to verify if it is a bug

claytonneal · 2025-01-08T17:22:49Z

packages/net/src/thor/transactions/RetrieveTransactionReceipt.ts

+import { type ThorRequest } from '../ThorRequest';
+import { type ThorResponse } from '../ThorResponse';
+
+import { type TxId } from '../../../../core/src/vcdm/BlockId';


to improve import

Some classes were not exported correctly from core, I don't understand why. This is just a workaround.

claytonneal · 2025-01-08T17:23:34Z

packages/net/src/thor/transactions/RetrieveTransactionReceipt.ts

+    }
+
+    get query(): string {
+        return this.head === undefined ? '' : `${this.head}&`;


perhaps HttpQuery class can generate this

claytonneal · 2025-01-08T17:27:20Z

packages/net/src/thor/transactions/TXID.ts

@@ -0,0 +1,21 @@
+import { ThorId } from '@vechain/sdk-core';
+
+class TXID {


dont we have TxId type elsewhere? in VCDM package

This class is different and mimic https://mainnet.vechain.org/doc/stoplight-ui/#/schemas/TXID, we shold change one of the two names. See my comment about Tx, Thor, Block id.

yes, but the two classes are different and this name reflects https://mainnet.vechain.org/doc/stoplight-ui/#/. One of the two names should change and we should think wisely if TxId is just ThotID or BlockId.

claytonneal · 2025-01-08T17:31:24Z

packages/net/src/ws/MozillaWebSocketClient.ts

+import { type WebSocketListener } from './WebSocketListener';
+import { type HttpPath } from '../http';
+
+class MozillaWebSocketClient implements WebSocketClient {


Why name Mozilla? When should this be used

Becase I used te standard Mozilla JS API and I suffered lack of fantasy in a better name. Let's decide a better name.

claytonneal · 2025-01-08T17:32:58Z

packages/net/src/ws/index.ts

@@ -0,0 +1,3 @@
+export * from './MozillaWebSocketClient';


perhaps named exports for bundle optimisation

blah, yes, workaround...

leszek-vechain · 2025-01-08T18:27:33Z

packages/core/src/vcdm/Nonce.ts

+import { Hex } from './Hex';
+import { InvalidDataType } from '@vechain/sdk-errors';
+
+class Nonce extends HexUInt {


Needs a doc comment

I postponed any doc writing.

leszek-vechain · 2025-01-08T18:35:56Z

packages/net/src/thor/accounts/ContractBytecode.ts

+    code: string;
+}
+
+class ContractBytecode {


maybe we can add docs here too

No doc yet, had no time.

leszek-vechain · 2025-01-08T20:10:24Z

packages/net/src/thor/node/RetrieveConnectedPeers.ts

+        httpClient: HttpClient
+    ): Promise<ThorResponse<RetrieveConnectedPeers, GetPeersResponse>> {
+        const response = await httpClient.get(RetrieveConnectedPeers.PATH, {
+            query: ''


not sure if we need query here

workaround because prototype, we can do it better

leszek-vechain · 2025-01-08T20:13:10Z

packages/net/src/thor/node/PeerStat.ts

@@ -0,0 +1,47 @@
+import { BlockId } from '@vechain/sdk-core';
+
+import { UInt } from '../../../../core/src/vcdm/UInt';


relative imports

...are horrible, but something in the imported core package prevents me to import correctly. half of the comment are about this

leszek-vechain · 2025-01-08T21:29:13Z

packages/net/src/thor/transactions/TxMeta.ts

@@ -0,0 +1,31 @@
+import { BlockId } from '@vechain/sdk-core';
+
+import { UInt } from '../../../../core/src/vcdm/UInt';


... it's rubbish!

lucanicoladebiasi

The prototype follows a strict principle I believe an open source SDK connecting with web-services should adhere: all what published as web-service documentation should have its class or method in the SDK. As SDK user I want to see the REST or WS documentation and I want to see those elements are represented in the SDK. Then, the SDK can offer me a lot more things, but i can be free to build additional things on the base of elements allowing me to have in the code using the SDK the elements published by Thor documentation.

The prototype has some known defects and limitations. The most important are

There is a lot of confusion among what block, blockref, thor and tx id should be.
An undetected problem in the exporting from core module obliged me to import few classes through relative paths, that is rubbish, but i hadn't any quicker solution.
The code is not documented.
The tests are just examples, those are not complete.
I'm an Object Oriented bigot: sometime I add classes in an hierarchy when not strictly needed for sake of ontology UML clarity and extendibility. I do believe abstraction is a virtue, not a defect because I was educated in a grammar school and I was poisoned by logic and philosophy courses.

lucanicoladebiasi · 2024-12-30T15:51:51Z

packages/net/src/thor/accounts/InspectClauses.ts

+            request: this,
+            response: new ExecuteCodesResponse(responseBody)
+        };
+    }


lucanicoladebiasi · 2025-01-10T14:50:29Z

packages/core/src/vcdm/BlockId.ts

+/**
+ * This class is an alias of {@link TxId} for back compatibility.
+ */
+class TxId extends BlockId {


I'm confused between the concepts of ThorId and TxId and BlockId. From the regex point of view those are the same thing: 64 hexadecimal digits. Are they conceptually different? Or should just have a ThorId class to express block and tx identifier? Let's discuss together.

lucanicoladebiasi · 2025-01-10T14:51:40Z

packages/core/src/vcdm/BlockId.ts

+     *
+     * @param {TxId} blockId - The unique identifier for the block.
+     */
+    protected constructor(blockId: BlockId) {


I didn't pay attention to doc and have many second and third thoughts about block, thor and tx ids.
See above comment.

lucanicoladebiasi · 2025-01-10T14:51:57Z

packages/core/src/vcdm/BlockId.ts

+    }
+}
+
+export { BlockId, ThorId, TxId };


See above, let's discuss.

lucanicoladebiasi · 2025-01-10T14:53:22Z

packages/net/src/thor/transactions/RetrieveTransactionReceipt.ts

+import { type ThorRequest } from '../ThorRequest';
+import { type ThorResponse } from '../ThorResponse';
+
+import { type TxId } from '../../../../core/src/vcdm/BlockId';


Some classes were not exported correctly from core, I don't understand why. This is just a workaround.

lucanicoladebiasi · 2025-01-10T17:42:09Z

packages/net/src/thor/transactions/Receipt.ts

+import { ReceiptOutput, type ReceiptOutputJSON } from './ReceiptOutput';
+import { Address, Hex, HexUInt, Units, VTHO } from '@vechain/sdk-core';
+
+class Receipt {


The prototype follows a close parallelism with what published at https://mainnet.vechain.org/doc/stoplight-ui/#/.

I strongly do believe the SDK must present the same data model the REST documentation publishes, at least at some level. As SDK user I want to see an SDK I can match with the REST end-point at first.
Then, It's absolute appropriate the SDK provides additional level of composition and abstraction using the lower level objects the REST points document.

lucanicoladebiasi · 2025-01-10T17:43:26Z

packages/net/src/thor/transactions/ReceiptMeta.ts

+
+import { TxId } from '../../../../core/src/vcdm/BlockId';
+
+class ReceiptMeta extends TxMeta {


As Object oriented bigot, it extends and extension is not a matter of convenience. Let's see the UML gospel about.

lucanicoladebiasi · 2025-01-10T17:44:09Z

packages/net/src/thor/transactions/RetrieveRawTransactionByID.ts

+import { type ThorRequest } from '../ThorRequest';
+import { type ThorResponse } from '../ThorResponse';
+
+import { type TxId } from '../../../../core/src/vcdm/BlockId';


... when yarn allows me to import correctly or you tell me what I did wrong exporting types.

lucanicoladebiasi · 2025-01-10T17:44:21Z

packages/net/src/thor/transactions/RetrieveTransactionByID.ts

+import { type ThorRequest } from '../ThorRequest';
+import { type ThorResponse } from '../ThorResponse';
+
+import { type TxId } from '../../../../core/src/vcdm/BlockId';


see above...

lucanicoladebiasi · 2025-01-10T17:45:44Z

packages/net/src/thor/transactions/TXID.ts

@@ -0,0 +1,21 @@
+import { ThorId } from '@vechain/sdk-core';
+
+class TXID {


yes, but the two classes are different and this name reflects https://mainnet.vechain.org/doc/stoplight-ui/#/. One of the two names should change and we should think wisely if TxId is just ThotID or BlockId.

lucanicoladebiasi added 30 commits November 27, 2024 08:24

docs: account-module.md

f383915

docs: transaction-module.md

41c5438

docs: blocks-module.md

5909d12

docs: blocks-module.md

0315e90

docs: logs-module.md

24ed557

docs: logs-module.md

e31b8bc

docs: node-module.md

bfbba27

Merge branch 'refs/heads/main' into v2

3760d1b

docs: node-module.md

aaf95ba

Merge branch 'main' into v2

def5905

docs: subscriptions-module.md

36a0d13

docs: debug-module.md

288e905

feat: v2 network dev...

b25891b

feat: v2 http dev...

4a1e775

feat: v2 http dev...

5f8a6df

feat: v2 http dev...

58606c7

feat: v2 thor node dev...

5cdd9a2

feat: v2 thor node dev...

af56fe6

feat: v2 thor node dev...

8f7d167

feat: v2 thor node dev...

9b231f0

feat: v2 thor account dev...

73f1d54

feat: v2 thor account dev...

d9eafd3

feat: v2 thor account dev...

96eb3b1

feat: v2 thor account dev...

cc9e728

feat: v2 thor account dev...

f99f3f5

feat: v2 thor account dev...

81610c6

feat: v2 thor account dev...

c0c2b73

feat: v2 thor transactions dev...

6bcd7e3

feat: v2 thor transactions dev...

236a784

feat: v2 thor transactions dev...

b6e518f

fabiorigam and others added 22 commits December 30, 2024 16:21

Merge branch 'main' into 1484-net

1759bb8

feat: 1484 logs documented

5264651

Merge remote-tracking branch 'origin/1484-net' into 1484-net

18ed3c3

feat: 1484 logs documented

fa93b40

feat: 1484 node documented

19bd10e

feat: 1484 node documented

066f0c4

feat: 1484 node documented

c7f4f97

feat: 1484 node documented

37bfe66

feat: 1484 node documented

f619998

feat: 1484 node documented

320173d

feat: 1484 node documented

4e22ce0

feat: 1484 node documented

7f8d35f

Merge branch 'main' into 1484-net

e115940

Merge branch 'main' into 1484-net

24645b8

Merge branch 'refs/heads/main' into 1484-net

70469df

feat: 1484 transaction id flowchart

602153e

feat: 1484 transaction id flowchart

0d0f3e1

feat: 1484 transaction id flowchart

fa68478

feat: 1484 transaction id flowchart

9bccf8d

Merge branch 'main' into 1484-net

7dd2907

feat: 1484 transaction id flowchart

8e167d9

feat: 1484 transaction id flowchart

b5d7050

claytonneal requested changes Jan 8, 2025

View reviewed changes

leszek-vechain reviewed Jan 8, 2025

View reviewed changes

Merge branch 'refs/heads/main' into 1484-net

168786c

lucanicoladebiasi commented Jan 10, 2025

View reviewed changes

		@@ -0,0 +1,18 @@
		import { InvalidDataType } from '@vechain/sdk-errors';

		class Int extends Number {

		@@ -0,0 +1,21 @@
		import { ThorId } from '@vechain/sdk-core';

		class TXID {

		@@ -0,0 +1,47 @@
		import { BlockId } from '@vechain/sdk-core';

		import { UInt } from '../../../../core/src/vcdm/UInt';

		@@ -0,0 +1,31 @@
		import { BlockId } from '@vechain/sdk-core';

		import { UInt } from '../../../../core/src/vcdm/UInt';


		import { TxId } from '../../../../core/src/vcdm/BlockId';

		class ReceiptMeta extends TxMeta {

1484 net v2 #1586

Are you sure you want to change the base?

1484 net v2 #1586

Conversation

lucanicoladebiasi commented Dec 17, 2024 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucanicoladebiasi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucanicoladebiasi commented Dec 17, 2024 •

edited

Loading