[TS SDK] Initialize sdk_v2 folder structure and basic usage #9448

0xmaayan · 2023-08-03T00:52:50Z

Description

This PR is the first step for the sdk_v2 development process. It includes only the basic structure, client files, Aptos class in aptos.ts and AptosConfig in aptos_config.ts

src/
 api
  aptos.ts // main class to initialize
  aptosConfig.ts // global configuration type
 bcs // bcs related operations
 client // core client files
 crypto // holds all crypto related functions (ED25519, multi ED25519, etc) 
 internal // holds internal operations like api calls
 types // sdk types 
 utils // util functions
 index.ts // main file to export all modules

Test Plan

gregnazario

I now realize this is mostly just copy pasta, so I'm going to stop commenting on it, but keep in mind anything that's been copied over, and had a bug that was fixed in it, will now diverge.

May just be better to write it from scratch with empty files, and just have all the license, and setup files etc.

ecosystem/typescript/sdk_v2/tsconfig.json

ecosystem/typescript/sdk_v2/src/utils/pagination_helpers.ts

ecosystem/typescript/sdk_v2/src/types/index.ts

ecosystem/typescript/sdk_v2/src/internal/account.ts

add aptos config add aptos config support new client implement new client support and use post request create types folder add gitignore add utils folder add openapi generated types add types folder add transactions folder add crypto folder add bcs folder add api folder add account folder move files location export aptos api error class export files modify tests install openapi and modify build commands

ecosystem/typescript/sdk_v2/src/client/types.ts

gregnazario · 2023-08-04T15:42:54Z

ecosystem/typescript/sdk_v2/src/version.ts

@@ -0,0 +1,2 @@
+// hardcoded for now, we would want to have it injected dynamically
+export const VERSION = "2.0.0";


I wonder are alpha versions supported in npm?

ohh yea, we were thinking on publishing the new SDK under @aptos-labs namespace to comply with all other packages aptos labs holds https://www.npmjs.com/settings/aptos-labs/packages , so something like @aptos-labs/sdk
we can think about it later down the road

0xmigo

Is the plan to create a new sdk_v2 folder, then slowly migrating everything over to sdk_v2, and eventually deprecating/replacing the existing one?

0xmaayan · 2023-08-04T17:52:59Z

Is the plan to create a new sdk_v2 folder, then slowly migrating everything over to sdk_v2, and eventually deprecating/replacing the existing one?

the plan is to create a sdk_v2 that holds sdk v2 files. some would be ported over from v1 and new ones. eventually we would have 2 folders, sdk and sdk_v2 and just publish sdk_v2 under a new name. we keep the sdk folder b/c we need to keep maintaining it for some time

github-actions · 2023-08-04T18:22:21Z

✅ Forge suite `compat` success on `aptos-node-v1.5.1` ==> `d1ad9c95729818b7b68276c5387de70c9f43597f`

Compatibility test results for aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f (PR)
1. Check liveness of validators at old version: aptos-node-v1.5.1
compatibility::simple-validator-upgrade::liveness-check : committed: 4410 txn/s, latency: 7292 ms, (p50: 6900 ms, p90: 10900 ms, p99: 16000 ms), latency samples: 167580
2. Upgrading first Validator to new version: d1ad9c95729818b7b68276c5387de70c9f43597f
compatibility::simple-validator-upgrade::single-validator-upgrade : committed: 1832 txn/s, latency: 16106 ms, (p50: 18700 ms, p90: 22200 ms, p99: 22300 ms), latency samples: 93440
3. Upgrading rest of first batch to new version: d1ad9c95729818b7b68276c5387de70c9f43597f
compatibility::simple-validator-upgrade::half-validator-upgrade : committed: 1773 txn/s, latency: 15643 ms, (p50: 18800 ms, p90: 21900 ms, p99: 22600 ms), latency samples: 92220
4. upgrading second batch to new version: d1ad9c95729818b7b68276c5387de70c9f43597f
compatibility::simple-validator-upgrade::rest-validator-upgrade : committed: 3450 txn/s, latency: 9328 ms, (p50: 9900 ms, p90: 12900 ms, p99: 13300 ms), latency samples: 144900
5. check swarm health
Compatibility test for aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f passed
Test Ok

Grafana dashboard
Humio Logs
Test runner output
Test run is land-blocking

github-actions · 2023-08-04T18:24:56Z

✅ Forge suite `realistic_env_max_load` success on `d1ad9c95729818b7b68276c5387de70c9f43597f`

two traffics test: inner traffic : committed: 6003 txn/s, latency: 6529 ms, (p50: 6300 ms, p90: 8400 ms, p99: 12300 ms), latency samples: 2599300
two traffics test : committed: 100 txn/s, latency: 2989 ms, (p50: 2900 ms, p90: 3400 ms, p99: 7300 ms), latency samples: 1820
Max round gap was 1 [limit 4] at version 1172955. Max no progress secs was 3.602432 [limit 10] at version 1172955.
Test Ok

Grafana dashboard
Humio Logs
Test runner output
Test run is land-blocking

github-actions · 2023-08-04T18:36:43Z

✅ Forge suite `framework_upgrade` success on `aptos-node-v1.5.1` ==> `d1ad9c95729818b7b68276c5387de70c9f43597f`

Compatibility test results for aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f (PR)
Upgrade the nodes to version: d1ad9c95729818b7b68276c5387de70c9f43597f
framework_upgrade::framework-upgrade::full-framework-upgrade : committed: 2868 txn/s, latency: 7733 ms, (p50: 7500 ms, p90: 11100 ms, p99: 17700 ms), latency samples: 157760
5. check swarm health
Compatibility test for aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f passed
Test Ok

Grafana dashboard
Humio Logs
Test runner output
Test run is land-blocking

initialize sdk_v2

0xmaayan requested review from gregnazario, banool, 0xmigo and saharct as code owners August 3, 2023 00:52

0xmaayan force-pushed the sdk_v2 branch from 5599ac0 to ca9e761 Compare August 3, 2023 00:55

gregnazario approved these changes Aug 4, 2023

View reviewed changes

0xmaayan added 2 commits August 4, 2023 00:14

clean up, leave only structure

8313d32

0xmaayan force-pushed the sdk_v2 branch from ca9e761 to 8313d32 Compare August 4, 2023 04:32

gregnazario approved these changes Aug 4, 2023

View reviewed changes

use AnyNumber type

d1ad9c9

0xmigo approved these changes Aug 4, 2023

View reviewed changes

0xmaayan enabled auto-merge (squash) August 4, 2023 17:53

This comment has been minimized.

Sign in to view

0xmaayan merged commit d1610e1 into main Aug 4, 2023

0xmaayan deleted the sdk_v2 branch August 4, 2023 18:36

xbtmatt pushed a commit that referenced this pull request Aug 13, 2023

[TS SDK] Initialize sdk_v2 folder structure and basic usage (#9448)

34f1766

initialize sdk_v2

St0nersdash mentioned this pull request Oct 31, 2023

[Snyk] Fix for 1 vulnerabilities St0nersdash/aptos-core#40

Merged

MuMianliu mentioned this pull request Nov 1, 2023

[Snyk] Fix for 1 vulnerabilities MuMianliu/aptos-core#10

Open

Abuchtela mentioned this pull request Nov 1, 2023

[Snyk] Fix for 1 vulnerabilities Abuchtela/aptos-core#13

Merged

MuMianliu mentioned this pull request Nov 15, 2023

[Snyk] Fix for 1 vulnerabilities MuMianliu/aptos-core#11

Open

St0nersdash mentioned this pull request Nov 15, 2023

[Snyk] Fix for 1 vulnerabilities St0nersdash/aptos-core#41

Merged

Abuchtela mentioned this pull request Nov 16, 2023

[Snyk] Fix for 1 vulnerabilities Abuchtela/aptos-core#20

Closed

St0nersdash mentioned this pull request Nov 28, 2023

[Snyk] Security upgrade @docusaurus/plugin-google-gtag from 2.3.1 to 3.0.0 St0nersdash/aptos-core#42

Open

Abuchtela mentioned this pull request Nov 29, 2023

[Snyk] Fix for 1 vulnerabilities Abuchtela/aptos-core#22

Closed

MuMianliu mentioned this pull request Dec 14, 2023

[Snyk] Fix for 1 vulnerabilities MuMianliu/aptos-core#13

Open

MuMianliu mentioned this pull request Jan 5, 2024

[Snyk] Fix for 1 vulnerabilities MuMianliu/aptos-core#16

Open

St0nersdash mentioned this pull request Jan 5, 2024

[Snyk] Security upgrade @docusaurus/plugin-google-gtag from 2.3.1 to 3.0.0 St0nersdash/aptos-core#47

Merged

Abuchtela mentioned this pull request Jan 6, 2024

[Snyk] Fix for 1 vulnerabilities Abuchtela/aptos-core#28

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS SDK] Initialize sdk_v2 folder structure and basic usage #9448

[TS SDK] Initialize sdk_v2 folder structure and basic usage #9448

0xmaayan commented Aug 3, 2023 •

edited

Loading

gregnazario left a comment

gregnazario Aug 4, 2023

0xmaayan Aug 4, 2023

0xmigo left a comment

0xmaayan commented Aug 4, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Aug 4, 2023

github-actions bot commented Aug 4, 2023

github-actions bot commented Aug 4, 2023

		@@ -0,0 +1,2 @@
		// hardcoded for now, we would want to have it injected dynamically
		export const VERSION = "2.0.0";

[TS SDK] Initialize sdk_v2 folder structure and basic usage #9448

[TS SDK] Initialize sdk_v2 folder structure and basic usage #9448

Conversation

0xmaayan commented Aug 3, 2023 • edited Loading

Description

Test Plan

gregnazario left a comment

Choose a reason for hiding this comment

gregnazario Aug 4, 2023

Choose a reason for hiding this comment

0xmaayan Aug 4, 2023

Choose a reason for hiding this comment

0xmigo left a comment

Choose a reason for hiding this comment

0xmaayan commented Aug 4, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Aug 4, 2023

✅ Forge suite compat success on aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f

github-actions bot commented Aug 4, 2023

✅ Forge suite realistic_env_max_load success on d1ad9c95729818b7b68276c5387de70c9f43597f

github-actions bot commented Aug 4, 2023

✅ Forge suite framework_upgrade success on aptos-node-v1.5.1 ==> d1ad9c95729818b7b68276c5387de70c9f43597f

0xmaayan commented Aug 3, 2023 •

edited

Loading

✅ Forge suite `compat` success on `aptos-node-v1.5.1` ==> `d1ad9c95729818b7b68276c5387de70c9f43597f`

✅ Forge suite `realistic_env_max_load` success on `d1ad9c95729818b7b68276c5387de70c9f43597f`

✅ Forge suite `framework_upgrade` success on `aptos-node-v1.5.1` ==> `d1ad9c95729818b7b68276c5387de70c9f43597f`