aptos-labs
@aptos-labs/aptos-client
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.
Implementation
The @aptos-labs/aptos-client package supports http2 protocol and implements 2 clients environment based:
- fetch - implemented in
index.browser.tsto use inbrowserenvironment (in a browser env it is up to the browser and the server to negotiate http2 connection) - got - implemented in
index.node.tsto use innodeenvironment (to support http2 in node environment, still the server must support http2 also)
Function signature
async function aptosClient<Res>(
requestOptions: AptosClientRequest,
): Promise<AptosClientResponse<Res>>;
Types
type AptosClientResponse<Res> = {
status: number;
statusText: string;
data: Res;
config?: any;
request?: any;
response?: any;
headers?: any;
};
type AptosClientRequest = {
url: string;
method: "GET" | "POST";
body?: any;
params?: any;
headers?: any;
overrides?: any;
};
Usage
import aptosClient from "@aptos-labs/aptos-client";
const response = await aptosClient<Res>({
url,
method,
body,
params,
headers,
overrides,
});
return response;