Skip to content

Commit b365fa2

Browse files
0xmaayan0xmaayan
authored
[TS SDK] Higher throughput reads (aptos-labs#9018)
* add http2 support * convert bigint to string in got query param, add aptos-client readme file * update changelog * use aptos-client npm package * fix lock file * move aptos-client folder into typescript folder * bump aptos-client version
1 parent 38d2005 commit b365fa2

23 files changed

+3264
-411
lines changed

‎ecosystem/typescript/aptos-client/.eslintignore‎

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

‎ecosystem/typescript/aptos-client/.eslintrc.js‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
es2021: true,
5+
node: true,
6+
},
7+
ignorePatterns: ["*.js"],
8+
extends: ["airbnb-base", "airbnb-typescript/base", "prettier"],
9+
parser: "@typescript-eslint/parser",
10+
parserOptions: {
11+
tsconfigRootDir: __dirname,
12+
project: ["tsconfig.json"],
13+
ecmaVersion: "latest",
14+
sourceType: "module",
15+
},
16+
plugins: ["@typescript-eslint"],
17+
rules: {
18+
quotes: ["error", "double"],
19+
"max-len": ["error", 120],
20+
"import/extensions": ["error", "never"],
21+
"max-classes-per-file": ["error", 10],
22+
"import/prefer-default-export": "off",
23+
"object-curly-newline": "off",
24+
"no-use-before-define": "off",
25+
"no-unused-vars": "off",
26+
"@typescript-eslint/no-use-before-define": ["error", { functions: false, classes: false }],
27+
"@typescript-eslint/no-unused-vars": ["error"],
28+
},
29+
settings: {
30+
"import/resolver": {
31+
node: {
32+
extensions: [".js", ".jsx", ".ts", ".tsx"],
33+
},
34+
},
35+
},
36+
};

‎ecosystem/typescript/aptos-client/.gitignore‎

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

‎ecosystem/typescript/aptos-client/.npmignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
tsconfig.json
3+
tsup.config.js
4+
.prettierignore
5+
.gitignore
6+
.eslintignore

‎ecosystem/typescript/aptos-client/.prettierignore‎

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

‎ecosystem/typescript/aptos-client/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎ecosystem/typescript/aptos-client/README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# @aptos-labs/aptos-client
2+
3+
This package implements a client with which you can interact with the Aptos network. It can be used standalone, and it is the client package used by the Aptos TypeScript SDK.
4+
5+
#### Implementation
6+
7+
The `@aptos-labs/aptos-client` package supports http2 protocol and implements 2 clients environment based:
8+
9+
1. [axios](https://github.com/axios/axios) - implemented in `index.browser.ts` to use in `browser` environment (in a browser env it is up to the browser and the server to negotiate http2 connection)
10+
2. [got](https://github.com/sindresorhus/got) - implemented in `index.node.ts` to use in `node` environment (to support http2 in node environment, still the server must support http2 also)
11+
12+
#### Function signature
13+
14+
```ts
15+
async function aptosClient<Res>(requestOptions: AptosClientRequest): Promise<AptosClientResponse<Res>>;
16+
```
17+
18+
#### Types
19+
20+
```ts
21+
type AptosClientResponse<Res> = {
22+
status: number;
23+
statusText: string;
24+
data: Res;
25+
config?: any;
26+
request?: any;
27+
response?: any;
28+
headers?: any;
29+
};
30+
31+
type AptosClientRequest = {
32+
url: string;
33+
method: "GET" | "POST";
34+
body?: any;
35+
params?: any;
36+
headers?: any;
37+
overrides?: any;
38+
};
39+
```
40+
41+
#### Usage
42+
43+
```ts
44+
import aptosClient from "@aptos-labs/aptos-client";
45+
46+
const response = await aptosClient<Res>({ url, method, body, params, headers, overrides });
47+
return response;
48+
```

‎ecosystem/typescript/aptos-client/package.json‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
{
2+
"name": "@aptos-labs/aptos-client",
3+
"description": "client package for accessing the Aptos network API",
4+
"packageManager": "[email protected]",
5+
"license": "Apache-2.0",
6+
"engines": {
7+
"node": ">=15.10.0"
8+
},
9+
"exports": {
10+
"browser": {
11+
"import": "./dist/browser/index.browser.mjs",
12+
"require": "./dist/browser/index.browser.js",
13+
"types": "./dist/browser/index.browser.d.ts"
14+
},
15+
"node": {
16+
"import": "./dist/node/index.node.mjs",
17+
"require": "./dist/node/index.node.js",
18+
"types": "./dist/node/index.node.d.ts"
19+
}
20+
},
21+
"browser": {
22+
"./dist/node/index.node.mjs": "./dist/browser/index.browser.mjs",
23+
"./dist/node/index.node.js": "./dist/browser/index.browser.js"
24+
},
25+
"main": "./dist/node/index.node.js",
26+
"module": "./dist/node/index.node.mjs",
27+
"types": "./dist/types/index.node.d.ts",
28+
"files": [
29+
"./dist/"
30+
],
31+
"scripts": {
32+
"build:clean": "rm -rf dist",
33+
"build": "pnpm build:clean && pnpm run _build:types && pnpm _build:node && pnpm _build:browser",
34+
"_build:browser": "tsup src/index.browser.ts --format cjs,esm --dts --out-dir dist/browser",
35+
"_build:node": "tsup src/index.node.ts --format cjs,esm --dts --out-dir dist/node",
36+
"_build:types": "tsc src/types.ts src/index.node.ts --outDir dist/types --declaration",
37+
"lint": "eslint \"**/*.ts\"",
38+
"fmt": "pnpm _fmt --write",
39+
"_fmt": "prettier 'src/**/*.ts' '.eslintrc.js'"
40+
},
41+
"repository": {
42+
"type": "git",
43+
"url": "https://github.com/aptos-labs/aptos-core.git"
44+
},
45+
"homepage": "https://github.com/aptos-labs/aptos-core",
46+
"bugs": {
47+
"url": "https://github.com/aptos-labs/aptos-core/issues"
48+
},
49+
"author": "aptoslabs.com",
50+
"keywords": [
51+
"Aptos",
52+
"Aptos Labs",
53+
"Aptos SDK"
54+
],
55+
"dependencies": {
56+
"axios": "0.27.2",
57+
"got": "^11.0.0"
58+
},
59+
"devDependencies": {
60+
"@types/node": "18.6.2",
61+
"ts-node": "10.9.1",
62+
"tsup": "6.2.3",
63+
"typescript": "4.8.2",
64+
"eslint": "8.23.0",
65+
"prettier": "2.6.2",
66+
"eslint-config-prettier": "8.5.0",
67+
"eslint-config-airbnb-base": "15.0.0",
68+
"eslint-config-airbnb-typescript": "17.0.0",
69+
"eslint-plugin-import": "2.26.0",
70+
"@typescript-eslint/eslint-plugin": "5.36.2",
71+
"@typescript-eslint/parser": "5.36.2"
72+
},
73+
"version": "0.0.2"
74+
}

0 commit comments

Comments
 (0)