@solana/rpc-spec 2.0.0-rc.0 → 2.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -27
- package/dist/index.browser.cjs +35 -22
- package/dist/index.browser.cjs.map +1 -1
- package/dist/index.browser.mjs +34 -22
- package/dist/index.browser.mjs.map +1 -1
- package/dist/index.native.mjs +34 -22
- package/dist/index.native.mjs.map +1 -1
- package/dist/index.node.cjs +35 -22
- package/dist/index.node.cjs.map +1 -1
- package/dist/index.node.mjs +34 -22
- package/dist/index.node.mjs.map +1 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/rpc-api.d.ts +13 -7
- package/dist/types/rpc-api.d.ts.map +1 -1
- package/dist/types/rpc-transport.d.ts +10 -4
- package/dist/types/rpc-transport.d.ts.map +1 -1
- package/dist/types/rpc.d.ts +6 -1
- package/dist/types/rpc.d.ts.map +1 -1
- package/package.json +15 -3
- package/dist/types/rpc-request.d.ts +0 -12
- package/dist/types/rpc-request.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
|
|
8
8
|
[code-style-prettier-url]: https://github.com/prettier/prettier
|
|
9
|
-
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/rpc-spec/
|
|
10
|
-
[npm-image]: https://img.shields.io/npm/v/@solana/rpc-spec/
|
|
11
|
-
[npm-url]: https://www.npmjs.com/package/@solana/rpc-spec/v/
|
|
9
|
+
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/rpc-spec/rc.svg?style=flat
|
|
10
|
+
[npm-image]: https://img.shields.io/npm/v/@solana/rpc-spec/rc.svg?style=flat
|
|
11
|
+
[npm-url]: https://www.npmjs.com/package/@solana/rpc-spec/v/rc
|
|
12
12
|
[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
|
13
13
|
[semantic-release-url]: https://github.com/semantic-release/semantic-release
|
|
14
14
|
|
|
15
15
|
# @solana/rpc-spec
|
|
16
16
|
|
|
17
|
-
This package contains types that describe the implementation of the JSON RPC API, as well as methods to create one. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@
|
|
17
|
+
This package contains types that describe the implementation of the JSON RPC API, as well as methods to create one. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
|
|
18
18
|
|
|
19
19
|
This API is designed to be used as follows:
|
|
20
20
|
|
|
@@ -33,7 +33,7 @@ const response = await rpc
|
|
|
33
33
|
|
|
34
34
|
### `PendingRpcRequest<TResponse>`
|
|
35
35
|
|
|
36
|
-
Pending requests are the result of calling a supported method on
|
|
36
|
+
Pending requests are the result of calling a supported method on an `Rpc` object. They encapsulate all of the information necessary to make the request without actually making it.
|
|
37
37
|
|
|
38
38
|
Calling the `send(options)` method on a `PendingRpcRequest` will trigger the request and return a promise for `TResponse`.
|
|
39
39
|
|
|
@@ -43,19 +43,21 @@ An object that exposes all of the functions described by `TRpcMethods`, and fulf
|
|
|
43
43
|
|
|
44
44
|
### `RpcApi<TRpcMethods>`
|
|
45
45
|
|
|
46
|
-
For each of `TRpcMethods` this object exposes a method with the same name that maps between its input arguments and a `
|
|
46
|
+
For each of `TRpcMethods` this object exposes a method with the same name that maps between its input arguments and a `RpcPlan<TResponse>` that describes how to prepare a JSON RPC request to fetch `TResponse`.
|
|
47
47
|
|
|
48
48
|
### `RpcApiMethods`
|
|
49
49
|
|
|
50
50
|
This is a marker interface that all RPC method definitions must extend to be accepted for use with the `RpcApi` creator.
|
|
51
51
|
|
|
52
|
-
### `
|
|
52
|
+
### `RpcPlan`
|
|
53
53
|
|
|
54
|
-
This type
|
|
54
|
+
This type allows an `RpcApi` to describe how a particular request should be issued to the JSON RPC server. Given a function that was called on a `Rpc`, this object returns an `execute` function that dictates which request will be sent, how the underlying transport will be used and how the responses will be transformed.
|
|
55
55
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
-
|
|
56
|
+
This function accepts an `RpcTransport` and an `AbortSignal` and asynchronously returns an `RpcResponse`. This gives us the opportunity to:
|
|
57
|
+
|
|
58
|
+
- define the `payload` from the requested method name and parameters before passing it to the transport.
|
|
59
|
+
- call the underlying transport zero, one or multiple times depending on the use-case (e.g. caching or aggregating multiple responses).
|
|
60
|
+
- transform the response from the JSON RPC server, in case it does not match the `TResponse` specified by the `PendingRpcRequest<TResponse>` returned from that function.
|
|
59
61
|
|
|
60
62
|
### `RpcSendOptions`
|
|
61
63
|
|
|
@@ -83,36 +85,48 @@ A config object with the following properties:
|
|
|
83
85
|
- `api`: An instance of `RpcApi`
|
|
84
86
|
- `transport`: A function that implements the `RpcTransport` interface
|
|
85
87
|
|
|
86
|
-
### `
|
|
88
|
+
### `createJsonRpcApi(config)`
|
|
87
89
|
|
|
88
|
-
Creates a JavaScript proxy that converts _any_ function call called on it to a `
|
|
90
|
+
Creates a JavaScript proxy that converts _any_ function call called on it to a `RpcPlan` by creating an `execute` function that:
|
|
89
91
|
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
- setting `responseTransformer` to `config.responseTransformer` or the identity function if no such config exists
|
|
92
|
+
- sets the transport payload to a JSON RPC v2 payload object with the requested `methodName` and `params` properties, optionally transformed by `config.requestTransformer`.
|
|
93
|
+
- transforms the transport's response using the `config.responseTransformer` function, if provided.
|
|
93
94
|
|
|
94
95
|
```ts
|
|
95
96
|
// For example, given this `RpcApi`:
|
|
96
|
-
const rpcApi =
|
|
97
|
-
|
|
97
|
+
const rpcApi = createJsonRpcApi({
|
|
98
|
+
requestTransformer: (...rawParams) => rawParams.reverse(),
|
|
98
99
|
responseTransformer: response => response.result,
|
|
99
100
|
});
|
|
100
101
|
|
|
101
102
|
// ...the following function call:
|
|
102
103
|
rpcApi.foo('bar', { baz: 'bat' });
|
|
103
104
|
|
|
104
|
-
// ...will produce
|
|
105
|
-
//
|
|
106
|
-
//
|
|
107
|
-
// methodName: 'foo',
|
|
108
|
-
// params: [{ baz: 'bat' }, 'bar'],
|
|
109
|
-
// responseTransformer: (response) => response.result,
|
|
110
|
-
// }
|
|
105
|
+
// ...will produce an `RpcPlan` that:
|
|
106
|
+
// - Uses the following payload: { id: 1, jsonrpc: '2.0', method: 'foo', params: ['bar', { baz: 'bat' }] }.
|
|
107
|
+
// - Returns the "result" attribute of the RPC response.
|
|
111
108
|
```
|
|
112
109
|
|
|
113
110
|
#### Arguments
|
|
114
111
|
|
|
115
112
|
A config object with the following properties:
|
|
116
113
|
|
|
117
|
-
- `
|
|
118
|
-
- `responseTransformer<T>(response,
|
|
114
|
+
- `requestTransformer<T>(request: RpcRequest<T>): RpcRequest`: An optional function that transforms the `RpcRequest` before it is sent to the JSON RPC server.
|
|
115
|
+
- `responseTransformer<T>(response: RpcResponse, request: RpcRequest): RpcResponse<T>`: An optional function that transforms the `RpcResponse` before it is returned to the caller.
|
|
116
|
+
|
|
117
|
+
### `isJsonRpcPayload(payload)`
|
|
118
|
+
|
|
119
|
+
A helper function that returns `true` if the given payload is a JSON RPC v2 payload. This means, the payload is an object such that:
|
|
120
|
+
|
|
121
|
+
- It has a `jsonrpc` property with a value of `'2.0'`.
|
|
122
|
+
- It has a `method` property that is a string.
|
|
123
|
+
- It has a `params` property of any type.
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
import { isJsonRpcPayload } from '@solana/rpc-spec';
|
|
127
|
+
|
|
128
|
+
if (isJsonRpcPayload(payload)) {
|
|
129
|
+
const payloadMethod: string = payload.method;
|
|
130
|
+
const payloadParams: unknown = payload.params;
|
|
131
|
+
}
|
|
132
|
+
```
|
package/dist/index.browser.cjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
var errors = require('@solana/errors');
|
|
3
4
|
var rpcSpecTypes = require('@solana/rpc-spec-types');
|
|
4
5
|
|
|
5
6
|
// src/rpc.ts
|
|
@@ -17,29 +18,27 @@ function makeProxy(rpcConfig) {
|
|
|
17
18
|
get(target, p, receiver) {
|
|
18
19
|
return function(...rawParams) {
|
|
19
20
|
const methodName = p.toString();
|
|
20
|
-
const
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
const getApiPlan = Reflect.get(target, methodName, receiver);
|
|
22
|
+
if (!getApiPlan) {
|
|
23
|
+
throw new errors.SolanaError(errors.SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {
|
|
24
|
+
method: methodName,
|
|
25
|
+
params: rawParams
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
const apiPlan = getApiPlan(...rawParams);
|
|
29
|
+
return createPendingRpcRequest(rpcConfig, apiPlan);
|
|
23
30
|
};
|
|
24
31
|
}
|
|
25
32
|
});
|
|
26
33
|
}
|
|
27
|
-
function createPendingRpcRequest(
|
|
34
|
+
function createPendingRpcRequest({ transport }, plan) {
|
|
28
35
|
return {
|
|
29
36
|
async send(options) {
|
|
30
|
-
|
|
31
|
-
const payload = rpcSpecTypes.createRpcMessage(methodName, params);
|
|
32
|
-
const response = await rpcConfig.transport({
|
|
33
|
-
payload,
|
|
34
|
-
signal: options?.abortSignal
|
|
35
|
-
});
|
|
36
|
-
return responseTransformer ? responseTransformer(response, methodName) : response;
|
|
37
|
+
return await plan.execute({ signal: options?.abortSignal, transport });
|
|
37
38
|
}
|
|
38
39
|
};
|
|
39
40
|
}
|
|
40
|
-
|
|
41
|
-
// src/rpc-api.ts
|
|
42
|
-
function createRpcApi(config) {
|
|
41
|
+
function createJsonRpcApi(config) {
|
|
43
42
|
return new Proxy({}, {
|
|
44
43
|
defineProperty() {
|
|
45
44
|
return false;
|
|
@@ -51,19 +50,33 @@ function createRpcApi(config) {
|
|
|
51
50
|
const [_, p] = args;
|
|
52
51
|
const methodName = p.toString();
|
|
53
52
|
return function(...rawParams) {
|
|
54
|
-
const
|
|
55
|
-
const
|
|
56
|
-
return {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
53
|
+
const rawRequest = Object.freeze({ methodName, params: rawParams });
|
|
54
|
+
const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;
|
|
55
|
+
return Object.freeze({
|
|
56
|
+
execute: async ({ signal, transport }) => {
|
|
57
|
+
const payload = rpcSpecTypes.createRpcMessage(request);
|
|
58
|
+
const response = await transport({ payload, signal });
|
|
59
|
+
if (!config?.responseTransformer) {
|
|
60
|
+
return response;
|
|
61
|
+
}
|
|
62
|
+
return config.responseTransformer(response, request);
|
|
63
|
+
}
|
|
64
|
+
});
|
|
61
65
|
};
|
|
62
66
|
}
|
|
63
67
|
});
|
|
64
68
|
}
|
|
65
69
|
|
|
70
|
+
// src/rpc-transport.ts
|
|
71
|
+
function isJsonRpcPayload(payload) {
|
|
72
|
+
if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
|
|
73
|
+
return false;
|
|
74
|
+
}
|
|
75
|
+
return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
exports.createJsonRpcApi = createJsonRpcApi;
|
|
66
79
|
exports.createRpc = createRpc;
|
|
67
|
-
exports.
|
|
80
|
+
exports.isJsonRpcPayload = isJsonRpcPayload;
|
|
68
81
|
//# sourceMappingURL=index.browser.cjs.map
|
|
69
82
|
//# sourceMappingURL=index.browser.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts"],"names":["createRpcMessage"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts","../src/rpc-transport.ts"],"names":["SolanaError","SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD","createRpcMessage"],"mappings":";;;;;;AAmCO,SAAS,UACZ,SACgB,EAAA;AAChB,EAAA,OAAO,UAAU,SAAS,CAAA,CAAA;AAC9B,CAAA;AAEA,SAAS,UACL,SACgB,EAAA;AAChB,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,QAAA,MAAM,UAAa,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,YAAY,QAAQ,CAAA,CAAA;AAC3D,QAAA,IAAI,CAAC,UAAY,EAAA;AACb,UAAM,MAAA,IAAIA,mBAAYC,yDAAoD,EAAA;AAAA,YACtE,MAAQ,EAAA,UAAA;AAAA,YACR,MAAQ,EAAA,SAAA;AAAA,WACX,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,OAAA,GAAU,UAAW,CAAA,GAAG,SAAS,CAAA,CAAA;AACvC,QAAO,OAAA,uBAAA,CAAwB,WAAW,OAAO,CAAA,CAAA;AAAA,OACrD,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,uBACL,CAAA,EAAE,SAAU,EAAA,EACZ,IAC4B,EAAA;AAC5B,EAAO,OAAA;AAAA,IACH,MAAM,KAAK,OAA8C,EAAA;AACrD,MAAO,OAAA,MAAM,KAAK,OAAQ,CAAA,EAAE,QAAQ,OAAS,EAAA,WAAA,EAAa,WAAW,CAAA,CAAA;AAAA,KACzE;AAAA,GACJ,CAAA;AACJ,CAAA;ACvCO,SAAS,iBAAoD,MAA4C,EAAA;AAC5G,EAAO,OAAA,IAAI,KAAM,CAAA,EAA2B,EAAA;AAAA,IACxC,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,MAAA,OAAO,YACA,SAG0C,EAAA;AAC7C,QAAA,MAAM,aAAa,MAAO,CAAA,MAAA,CAAO,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,UAAU,MAAQ,EAAA,kBAAA,GAAqB,MAAQ,EAAA,kBAAA,CAAmB,UAAU,CAAI,GAAA,UAAA,CAAA;AACtF,QAAA,OAAO,OAAO,MAAsD,CAAA;AAAA,UAChE,OAAS,EAAA,OAAO,EAAE,MAAA,EAAQ,WAAgB,KAAA;AACtC,YAAM,MAAA,OAAA,GAAUC,8BAAiB,OAAO,CAAA,CAAA;AACxC,YAAA,MAAM,WAAW,MAAM,SAAA,CAAU,EAAE,OAAA,EAAS,QAAQ,CAAA,CAAA;AACpD,YAAI,IAAA,CAAC,QAAQ,mBAAqB,EAAA;AAC9B,cAAO,OAAA,QAAA,CAAA;AAAA,aACX;AACA,YAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,WACvD;AAAA,SACH,CAAA,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;;;AC5DO,SAAS,iBAAiB,OAI9B,EAAA;AACC,EAAI,IAAA,OAAA,IAAW,QAAQ,OAAO,OAAA,KAAY,YAAY,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAC1E,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AACA,EACI,OAAA,SAAA,IAAa,OACb,IAAA,OAAA,CAAQ,OAAY,KAAA,KAAA,IACpB,QAAY,IAAA,OAAA,IACZ,OAAO,OAAA,CAAQ,MAAW,KAAA,QAAA,IAC1B,QAAY,IAAA,OAAA,CAAA;AAEpB","file":"index.browser.cjs","sourcesContent":["import { SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\n\nimport { RpcApi, RpcPlan } from './rpc-api';\nimport { RpcTransport } from './rpc-transport';\n\nexport type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{\n api: RpcApi<TRpcMethods>;\n transport: TRpcTransport;\n}>;\n\nexport type Rpc<TRpcMethods> = {\n [TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;\n};\n\nexport type PendingRpcRequest<TResponse> = {\n send(options?: RpcSendOptions): Promise<TResponse>;\n};\n\nexport type RpcSendOptions = Readonly<{\n abortSignal?: AbortSignal;\n}>;\n\ntype PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<\n Flatten<{\n [P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;\n }>\n>;\n\ntype PendingRpcRequestReturnTypeMapper<TMethodImplementation> =\n // Check that this property of the TRpcMethods interface is, in fact, a function.\n TMethodImplementation extends Callable\n ? (...args: Parameters<TMethodImplementation>) => PendingRpcRequest<ReturnType<TMethodImplementation>>\n : never;\n\nexport function createRpc<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return new Proxy(rpcConfig.api, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get(target, p, receiver) {\n return function (...rawParams: unknown[]) {\n const methodName = p.toString();\n const getApiPlan = Reflect.get(target, methodName, receiver);\n if (!getApiPlan) {\n throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {\n method: methodName,\n params: rawParams,\n });\n }\n const apiPlan = getApiPlan(...rawParams);\n return createPendingRpcRequest(rpcConfig, apiPlan);\n };\n },\n }) as Rpc<TRpcMethods>;\n}\n\nfunction createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport, TResponse>(\n { transport }: RpcConfig<TRpcMethods, TRpcTransport>,\n plan: RpcPlan<TResponse>,\n): PendingRpcRequest<TResponse> {\n return {\n async send(options?: RpcSendOptions): Promise<TResponse> {\n return await plan.execute({ signal: options?.abortSignal, transport });\n },\n };\n}\n","import {\n Callable,\n createRpcMessage,\n RpcRequestTransformer,\n RpcResponse,\n RpcResponseTransformer,\n} from '@solana/rpc-spec-types';\n\nimport type { RpcTransport } from './rpc-transport';\n\nexport type RpcApiConfig = Readonly<{\n requestTransformer?: RpcRequestTransformer;\n responseTransformer?: RpcResponseTransformer;\n}>;\n\nexport type RpcPlan<TResponse> = {\n execute: (\n config: Readonly<{\n signal?: AbortSignal;\n transport: RpcTransport;\n }>,\n ) => Promise<RpcResponse<TResponse>>;\n};\n\nexport type RpcApi<TRpcMethods> = {\n [MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;\n};\n\ntype RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>>\n : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcApiMethod = (...args: any) => any;\ninterface RpcApiMethods {\n [methodName: string]: RpcApiMethod;\n}\n\nexport function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods> {\n return new Proxy({} as RpcApi<TRpcMethods>, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get<TMethodName extends keyof RpcApi<TRpcMethods>>(\n ...args: Parameters<NonNullable<ProxyHandler<RpcApi<TRpcMethods>>['get']>>\n ) {\n const [_, p] = args;\n const methodName = p.toString() as keyof TRpcMethods as string;\n return function (\n ...rawParams: Parameters<\n TRpcMethods[TMethodName] extends CallableFunction ? TRpcMethods[TMethodName] : never\n >\n ): RpcPlan<ReturnType<TRpcMethods[TMethodName]>> {\n const rawRequest = Object.freeze({ methodName, params: rawParams });\n const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;\n return Object.freeze(<RpcPlan<ReturnType<TRpcMethods[TMethodName]>>>{\n execute: async ({ signal, transport }) => {\n const payload = createRpcMessage(request);\n const response = await transport({ payload, signal });\n if (!config?.responseTransformer) {\n return response;\n }\n return config.responseTransformer(response, request);\n },\n });\n };\n },\n });\n}\n","import { RpcResponse } from '@solana/rpc-spec-types';\n\ntype Config = Readonly<{\n payload: unknown;\n signal?: AbortSignal;\n}>;\n\nexport type RpcTransport = {\n <TResponse>(config: Config): Promise<RpcResponse<TResponse>>;\n};\n\nexport function isJsonRpcPayload(payload: unknown): payload is Readonly<{\n jsonrpc: '2.0';\n method: string;\n params: unknown;\n}> {\n if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n return false;\n }\n return (\n 'jsonrpc' in payload &&\n payload.jsonrpc === '2.0' &&\n 'method' in payload &&\n typeof payload.method === 'string' &&\n 'params' in payload\n );\n}\n"]}
|
package/dist/index.browser.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SolanaError, SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD } from '@solana/errors';
|
|
1
2
|
import { createRpcMessage } from '@solana/rpc-spec-types';
|
|
2
3
|
|
|
3
4
|
// src/rpc.ts
|
|
@@ -15,29 +16,27 @@ function makeProxy(rpcConfig) {
|
|
|
15
16
|
get(target, p, receiver) {
|
|
16
17
|
return function(...rawParams) {
|
|
17
18
|
const methodName = p.toString();
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
const getApiPlan = Reflect.get(target, methodName, receiver);
|
|
20
|
+
if (!getApiPlan) {
|
|
21
|
+
throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {
|
|
22
|
+
method: methodName,
|
|
23
|
+
params: rawParams
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
const apiPlan = getApiPlan(...rawParams);
|
|
27
|
+
return createPendingRpcRequest(rpcConfig, apiPlan);
|
|
21
28
|
};
|
|
22
29
|
}
|
|
23
30
|
});
|
|
24
31
|
}
|
|
25
|
-
function createPendingRpcRequest(
|
|
32
|
+
function createPendingRpcRequest({ transport }, plan) {
|
|
26
33
|
return {
|
|
27
34
|
async send(options) {
|
|
28
|
-
|
|
29
|
-
const payload = createRpcMessage(methodName, params);
|
|
30
|
-
const response = await rpcConfig.transport({
|
|
31
|
-
payload,
|
|
32
|
-
signal: options?.abortSignal
|
|
33
|
-
});
|
|
34
|
-
return responseTransformer ? responseTransformer(response, methodName) : response;
|
|
35
|
+
return await plan.execute({ signal: options?.abortSignal, transport });
|
|
35
36
|
}
|
|
36
37
|
};
|
|
37
38
|
}
|
|
38
|
-
|
|
39
|
-
// src/rpc-api.ts
|
|
40
|
-
function createRpcApi(config) {
|
|
39
|
+
function createJsonRpcApi(config) {
|
|
41
40
|
return new Proxy({}, {
|
|
42
41
|
defineProperty() {
|
|
43
42
|
return false;
|
|
@@ -49,18 +48,31 @@ function createRpcApi(config) {
|
|
|
49
48
|
const [_, p] = args;
|
|
50
49
|
const methodName = p.toString();
|
|
51
50
|
return function(...rawParams) {
|
|
52
|
-
const
|
|
53
|
-
const
|
|
54
|
-
return {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
51
|
+
const rawRequest = Object.freeze({ methodName, params: rawParams });
|
|
52
|
+
const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;
|
|
53
|
+
return Object.freeze({
|
|
54
|
+
execute: async ({ signal, transport }) => {
|
|
55
|
+
const payload = createRpcMessage(request);
|
|
56
|
+
const response = await transport({ payload, signal });
|
|
57
|
+
if (!config?.responseTransformer) {
|
|
58
|
+
return response;
|
|
59
|
+
}
|
|
60
|
+
return config.responseTransformer(response, request);
|
|
61
|
+
}
|
|
62
|
+
});
|
|
59
63
|
};
|
|
60
64
|
}
|
|
61
65
|
});
|
|
62
66
|
}
|
|
63
67
|
|
|
64
|
-
|
|
68
|
+
// src/rpc-transport.ts
|
|
69
|
+
function isJsonRpcPayload(payload) {
|
|
70
|
+
if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
|
|
71
|
+
return false;
|
|
72
|
+
}
|
|
73
|
+
return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export { createJsonRpcApi, createRpc, isJsonRpcPayload };
|
|
65
77
|
//# sourceMappingURL=index.browser.mjs.map
|
|
66
78
|
//# sourceMappingURL=index.browser.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts","../src/rpc-transport.ts"],"names":[],"mappings":";;;;AAmCO,SAAS,UACZ,SACgB,EAAA;AAChB,EAAA,OAAO,UAAU,SAAS,CAAA,CAAA;AAC9B,CAAA;AAEA,SAAS,UACL,SACgB,EAAA;AAChB,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,QAAA,MAAM,UAAa,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,YAAY,QAAQ,CAAA,CAAA;AAC3D,QAAA,IAAI,CAAC,UAAY,EAAA;AACb,UAAM,MAAA,IAAI,YAAY,kDAAoD,EAAA;AAAA,YACtE,MAAQ,EAAA,UAAA;AAAA,YACR,MAAQ,EAAA,SAAA;AAAA,WACX,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,OAAA,GAAU,UAAW,CAAA,GAAG,SAAS,CAAA,CAAA;AACvC,QAAO,OAAA,uBAAA,CAAwB,WAAW,OAAO,CAAA,CAAA;AAAA,OACrD,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,uBACL,CAAA,EAAE,SAAU,EAAA,EACZ,IAC4B,EAAA;AAC5B,EAAO,OAAA;AAAA,IACH,MAAM,KAAK,OAA8C,EAAA;AACrD,MAAO,OAAA,MAAM,KAAK,OAAQ,CAAA,EAAE,QAAQ,OAAS,EAAA,WAAA,EAAa,WAAW,CAAA,CAAA;AAAA,KACzE;AAAA,GACJ,CAAA;AACJ,CAAA;ACvCO,SAAS,iBAAoD,MAA4C,EAAA;AAC5G,EAAO,OAAA,IAAI,KAAM,CAAA,EAA2B,EAAA;AAAA,IACxC,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,MAAA,OAAO,YACA,SAG0C,EAAA;AAC7C,QAAA,MAAM,aAAa,MAAO,CAAA,MAAA,CAAO,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,UAAU,MAAQ,EAAA,kBAAA,GAAqB,MAAQ,EAAA,kBAAA,CAAmB,UAAU,CAAI,GAAA,UAAA,CAAA;AACtF,QAAA,OAAO,OAAO,MAAsD,CAAA;AAAA,UAChE,OAAS,EAAA,OAAO,EAAE,MAAA,EAAQ,WAAgB,KAAA;AACtC,YAAM,MAAA,OAAA,GAAU,iBAAiB,OAAO,CAAA,CAAA;AACxC,YAAA,MAAM,WAAW,MAAM,SAAA,CAAU,EAAE,OAAA,EAAS,QAAQ,CAAA,CAAA;AACpD,YAAI,IAAA,CAAC,QAAQ,mBAAqB,EAAA;AAC9B,cAAO,OAAA,QAAA,CAAA;AAAA,aACX;AACA,YAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,WACvD;AAAA,SACH,CAAA,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;;;AC5DO,SAAS,iBAAiB,OAI9B,EAAA;AACC,EAAI,IAAA,OAAA,IAAW,QAAQ,OAAO,OAAA,KAAY,YAAY,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAC1E,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AACA,EACI,OAAA,SAAA,IAAa,OACb,IAAA,OAAA,CAAQ,OAAY,KAAA,KAAA,IACpB,QAAY,IAAA,OAAA,IACZ,OAAO,OAAA,CAAQ,MAAW,KAAA,QAAA,IAC1B,QAAY,IAAA,OAAA,CAAA;AAEpB","file":"index.browser.mjs","sourcesContent":["import { SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\n\nimport { RpcApi, RpcPlan } from './rpc-api';\nimport { RpcTransport } from './rpc-transport';\n\nexport type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{\n api: RpcApi<TRpcMethods>;\n transport: TRpcTransport;\n}>;\n\nexport type Rpc<TRpcMethods> = {\n [TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;\n};\n\nexport type PendingRpcRequest<TResponse> = {\n send(options?: RpcSendOptions): Promise<TResponse>;\n};\n\nexport type RpcSendOptions = Readonly<{\n abortSignal?: AbortSignal;\n}>;\n\ntype PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<\n Flatten<{\n [P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;\n }>\n>;\n\ntype PendingRpcRequestReturnTypeMapper<TMethodImplementation> =\n // Check that this property of the TRpcMethods interface is, in fact, a function.\n TMethodImplementation extends Callable\n ? (...args: Parameters<TMethodImplementation>) => PendingRpcRequest<ReturnType<TMethodImplementation>>\n : never;\n\nexport function createRpc<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return new Proxy(rpcConfig.api, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get(target, p, receiver) {\n return function (...rawParams: unknown[]) {\n const methodName = p.toString();\n const getApiPlan = Reflect.get(target, methodName, receiver);\n if (!getApiPlan) {\n throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {\n method: methodName,\n params: rawParams,\n });\n }\n const apiPlan = getApiPlan(...rawParams);\n return createPendingRpcRequest(rpcConfig, apiPlan);\n };\n },\n }) as Rpc<TRpcMethods>;\n}\n\nfunction createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport, TResponse>(\n { transport }: RpcConfig<TRpcMethods, TRpcTransport>,\n plan: RpcPlan<TResponse>,\n): PendingRpcRequest<TResponse> {\n return {\n async send(options?: RpcSendOptions): Promise<TResponse> {\n return await plan.execute({ signal: options?.abortSignal, transport });\n },\n };\n}\n","import {\n Callable,\n createRpcMessage,\n RpcRequestTransformer,\n RpcResponse,\n RpcResponseTransformer,\n} from '@solana/rpc-spec-types';\n\nimport type { RpcTransport } from './rpc-transport';\n\nexport type RpcApiConfig = Readonly<{\n requestTransformer?: RpcRequestTransformer;\n responseTransformer?: RpcResponseTransformer;\n}>;\n\nexport type RpcPlan<TResponse> = {\n execute: (\n config: Readonly<{\n signal?: AbortSignal;\n transport: RpcTransport;\n }>,\n ) => Promise<RpcResponse<TResponse>>;\n};\n\nexport type RpcApi<TRpcMethods> = {\n [MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;\n};\n\ntype RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>>\n : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcApiMethod = (...args: any) => any;\ninterface RpcApiMethods {\n [methodName: string]: RpcApiMethod;\n}\n\nexport function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods> {\n return new Proxy({} as RpcApi<TRpcMethods>, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get<TMethodName extends keyof RpcApi<TRpcMethods>>(\n ...args: Parameters<NonNullable<ProxyHandler<RpcApi<TRpcMethods>>['get']>>\n ) {\n const [_, p] = args;\n const methodName = p.toString() as keyof TRpcMethods as string;\n return function (\n ...rawParams: Parameters<\n TRpcMethods[TMethodName] extends CallableFunction ? TRpcMethods[TMethodName] : never\n >\n ): RpcPlan<ReturnType<TRpcMethods[TMethodName]>> {\n const rawRequest = Object.freeze({ methodName, params: rawParams });\n const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;\n return Object.freeze(<RpcPlan<ReturnType<TRpcMethods[TMethodName]>>>{\n execute: async ({ signal, transport }) => {\n const payload = createRpcMessage(request);\n const response = await transport({ payload, signal });\n if (!config?.responseTransformer) {\n return response;\n }\n return config.responseTransformer(response, request);\n },\n });\n };\n },\n });\n}\n","import { RpcResponse } from '@solana/rpc-spec-types';\n\ntype Config = Readonly<{\n payload: unknown;\n signal?: AbortSignal;\n}>;\n\nexport type RpcTransport = {\n <TResponse>(config: Config): Promise<RpcResponse<TResponse>>;\n};\n\nexport function isJsonRpcPayload(payload: unknown): payload is Readonly<{\n jsonrpc: '2.0';\n method: string;\n params: unknown;\n}> {\n if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n return false;\n }\n return (\n 'jsonrpc' in payload &&\n payload.jsonrpc === '2.0' &&\n 'method' in payload &&\n typeof payload.method === 'string' &&\n 'params' in payload\n );\n}\n"]}
|
package/dist/index.native.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SolanaError, SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD } from '@solana/errors';
|
|
1
2
|
import { createRpcMessage } from '@solana/rpc-spec-types';
|
|
2
3
|
|
|
3
4
|
// src/rpc.ts
|
|
@@ -15,29 +16,27 @@ function makeProxy(rpcConfig) {
|
|
|
15
16
|
get(target, p, receiver) {
|
|
16
17
|
return function(...rawParams) {
|
|
17
18
|
const methodName = p.toString();
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
const getApiPlan = Reflect.get(target, methodName, receiver);
|
|
20
|
+
if (!getApiPlan) {
|
|
21
|
+
throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {
|
|
22
|
+
method: methodName,
|
|
23
|
+
params: rawParams
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
const apiPlan = getApiPlan(...rawParams);
|
|
27
|
+
return createPendingRpcRequest(rpcConfig, apiPlan);
|
|
21
28
|
};
|
|
22
29
|
}
|
|
23
30
|
});
|
|
24
31
|
}
|
|
25
|
-
function createPendingRpcRequest(
|
|
32
|
+
function createPendingRpcRequest({ transport }, plan) {
|
|
26
33
|
return {
|
|
27
34
|
async send(options) {
|
|
28
|
-
|
|
29
|
-
const payload = createRpcMessage(methodName, params);
|
|
30
|
-
const response = await rpcConfig.transport({
|
|
31
|
-
payload,
|
|
32
|
-
signal: options?.abortSignal
|
|
33
|
-
});
|
|
34
|
-
return responseTransformer ? responseTransformer(response, methodName) : response;
|
|
35
|
+
return await plan.execute({ signal: options?.abortSignal, transport });
|
|
35
36
|
}
|
|
36
37
|
};
|
|
37
38
|
}
|
|
38
|
-
|
|
39
|
-
// src/rpc-api.ts
|
|
40
|
-
function createRpcApi(config) {
|
|
39
|
+
function createJsonRpcApi(config) {
|
|
41
40
|
return new Proxy({}, {
|
|
42
41
|
defineProperty() {
|
|
43
42
|
return false;
|
|
@@ -49,18 +48,31 @@ function createRpcApi(config) {
|
|
|
49
48
|
const [_, p] = args;
|
|
50
49
|
const methodName = p.toString();
|
|
51
50
|
return function(...rawParams) {
|
|
52
|
-
const
|
|
53
|
-
const
|
|
54
|
-
return {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
51
|
+
const rawRequest = Object.freeze({ methodName, params: rawParams });
|
|
52
|
+
const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;
|
|
53
|
+
return Object.freeze({
|
|
54
|
+
execute: async ({ signal, transport }) => {
|
|
55
|
+
const payload = createRpcMessage(request);
|
|
56
|
+
const response = await transport({ payload, signal });
|
|
57
|
+
if (!config?.responseTransformer) {
|
|
58
|
+
return response;
|
|
59
|
+
}
|
|
60
|
+
return config.responseTransformer(response, request);
|
|
61
|
+
}
|
|
62
|
+
});
|
|
59
63
|
};
|
|
60
64
|
}
|
|
61
65
|
});
|
|
62
66
|
}
|
|
63
67
|
|
|
64
|
-
|
|
68
|
+
// src/rpc-transport.ts
|
|
69
|
+
function isJsonRpcPayload(payload) {
|
|
70
|
+
if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
|
|
71
|
+
return false;
|
|
72
|
+
}
|
|
73
|
+
return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export { createJsonRpcApi, createRpc, isJsonRpcPayload };
|
|
65
77
|
//# sourceMappingURL=index.native.mjs.map
|
|
66
78
|
//# sourceMappingURL=index.native.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts","../src/rpc-transport.ts"],"names":[],"mappings":";;;;AAmCO,SAAS,UACZ,SACgB,EAAA;AAChB,EAAA,OAAO,UAAU,SAAS,CAAA,CAAA;AAC9B,CAAA;AAEA,SAAS,UACL,SACgB,EAAA;AAChB,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,QAAA,MAAM,UAAa,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,YAAY,QAAQ,CAAA,CAAA;AAC3D,QAAA,IAAI,CAAC,UAAY,EAAA;AACb,UAAM,MAAA,IAAI,YAAY,kDAAoD,EAAA;AAAA,YACtE,MAAQ,EAAA,UAAA;AAAA,YACR,MAAQ,EAAA,SAAA;AAAA,WACX,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,OAAA,GAAU,UAAW,CAAA,GAAG,SAAS,CAAA,CAAA;AACvC,QAAO,OAAA,uBAAA,CAAwB,WAAW,OAAO,CAAA,CAAA;AAAA,OACrD,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,uBACL,CAAA,EAAE,SAAU,EAAA,EACZ,IAC4B,EAAA;AAC5B,EAAO,OAAA;AAAA,IACH,MAAM,KAAK,OAA8C,EAAA;AACrD,MAAO,OAAA,MAAM,KAAK,OAAQ,CAAA,EAAE,QAAQ,OAAS,EAAA,WAAA,EAAa,WAAW,CAAA,CAAA;AAAA,KACzE;AAAA,GACJ,CAAA;AACJ,CAAA;ACvCO,SAAS,iBAAoD,MAA4C,EAAA;AAC5G,EAAO,OAAA,IAAI,KAAM,CAAA,EAA2B,EAAA;AAAA,IACxC,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,MAAA,OAAO,YACA,SAG0C,EAAA;AAC7C,QAAA,MAAM,aAAa,MAAO,CAAA,MAAA,CAAO,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,UAAU,MAAQ,EAAA,kBAAA,GAAqB,MAAQ,EAAA,kBAAA,CAAmB,UAAU,CAAI,GAAA,UAAA,CAAA;AACtF,QAAA,OAAO,OAAO,MAAsD,CAAA;AAAA,UAChE,OAAS,EAAA,OAAO,EAAE,MAAA,EAAQ,WAAgB,KAAA;AACtC,YAAM,MAAA,OAAA,GAAU,iBAAiB,OAAO,CAAA,CAAA;AACxC,YAAA,MAAM,WAAW,MAAM,SAAA,CAAU,EAAE,OAAA,EAAS,QAAQ,CAAA,CAAA;AACpD,YAAI,IAAA,CAAC,QAAQ,mBAAqB,EAAA;AAC9B,cAAO,OAAA,QAAA,CAAA;AAAA,aACX;AACA,YAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,WACvD;AAAA,SACH,CAAA,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;;;AC5DO,SAAS,iBAAiB,OAI9B,EAAA;AACC,EAAI,IAAA,OAAA,IAAW,QAAQ,OAAO,OAAA,KAAY,YAAY,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAC1E,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AACA,EACI,OAAA,SAAA,IAAa,OACb,IAAA,OAAA,CAAQ,OAAY,KAAA,KAAA,IACpB,QAAY,IAAA,OAAA,IACZ,OAAO,OAAA,CAAQ,MAAW,KAAA,QAAA,IAC1B,QAAY,IAAA,OAAA,CAAA;AAEpB","file":"index.native.mjs","sourcesContent":["import { SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\n\nimport { RpcApi, RpcPlan } from './rpc-api';\nimport { RpcTransport } from './rpc-transport';\n\nexport type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{\n api: RpcApi<TRpcMethods>;\n transport: TRpcTransport;\n}>;\n\nexport type Rpc<TRpcMethods> = {\n [TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;\n};\n\nexport type PendingRpcRequest<TResponse> = {\n send(options?: RpcSendOptions): Promise<TResponse>;\n};\n\nexport type RpcSendOptions = Readonly<{\n abortSignal?: AbortSignal;\n}>;\n\ntype PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<\n Flatten<{\n [P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;\n }>\n>;\n\ntype PendingRpcRequestReturnTypeMapper<TMethodImplementation> =\n // Check that this property of the TRpcMethods interface is, in fact, a function.\n TMethodImplementation extends Callable\n ? (...args: Parameters<TMethodImplementation>) => PendingRpcRequest<ReturnType<TMethodImplementation>>\n : never;\n\nexport function createRpc<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return new Proxy(rpcConfig.api, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get(target, p, receiver) {\n return function (...rawParams: unknown[]) {\n const methodName = p.toString();\n const getApiPlan = Reflect.get(target, methodName, receiver);\n if (!getApiPlan) {\n throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {\n method: methodName,\n params: rawParams,\n });\n }\n const apiPlan = getApiPlan(...rawParams);\n return createPendingRpcRequest(rpcConfig, apiPlan);\n };\n },\n }) as Rpc<TRpcMethods>;\n}\n\nfunction createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport, TResponse>(\n { transport }: RpcConfig<TRpcMethods, TRpcTransport>,\n plan: RpcPlan<TResponse>,\n): PendingRpcRequest<TResponse> {\n return {\n async send(options?: RpcSendOptions): Promise<TResponse> {\n return await plan.execute({ signal: options?.abortSignal, transport });\n },\n };\n}\n","import {\n Callable,\n createRpcMessage,\n RpcRequestTransformer,\n RpcResponse,\n RpcResponseTransformer,\n} from '@solana/rpc-spec-types';\n\nimport type { RpcTransport } from './rpc-transport';\n\nexport type RpcApiConfig = Readonly<{\n requestTransformer?: RpcRequestTransformer;\n responseTransformer?: RpcResponseTransformer;\n}>;\n\nexport type RpcPlan<TResponse> = {\n execute: (\n config: Readonly<{\n signal?: AbortSignal;\n transport: RpcTransport;\n }>,\n ) => Promise<RpcResponse<TResponse>>;\n};\n\nexport type RpcApi<TRpcMethods> = {\n [MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;\n};\n\ntype RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>>\n : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcApiMethod = (...args: any) => any;\ninterface RpcApiMethods {\n [methodName: string]: RpcApiMethod;\n}\n\nexport function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods> {\n return new Proxy({} as RpcApi<TRpcMethods>, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get<TMethodName extends keyof RpcApi<TRpcMethods>>(\n ...args: Parameters<NonNullable<ProxyHandler<RpcApi<TRpcMethods>>['get']>>\n ) {\n const [_, p] = args;\n const methodName = p.toString() as keyof TRpcMethods as string;\n return function (\n ...rawParams: Parameters<\n TRpcMethods[TMethodName] extends CallableFunction ? TRpcMethods[TMethodName] : never\n >\n ): RpcPlan<ReturnType<TRpcMethods[TMethodName]>> {\n const rawRequest = Object.freeze({ methodName, params: rawParams });\n const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;\n return Object.freeze(<RpcPlan<ReturnType<TRpcMethods[TMethodName]>>>{\n execute: async ({ signal, transport }) => {\n const payload = createRpcMessage(request);\n const response = await transport({ payload, signal });\n if (!config?.responseTransformer) {\n return response;\n }\n return config.responseTransformer(response, request);\n },\n });\n };\n },\n });\n}\n","import { RpcResponse } from '@solana/rpc-spec-types';\n\ntype Config = Readonly<{\n payload: unknown;\n signal?: AbortSignal;\n}>;\n\nexport type RpcTransport = {\n <TResponse>(config: Config): Promise<RpcResponse<TResponse>>;\n};\n\nexport function isJsonRpcPayload(payload: unknown): payload is Readonly<{\n jsonrpc: '2.0';\n method: string;\n params: unknown;\n}> {\n if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n return false;\n }\n return (\n 'jsonrpc' in payload &&\n payload.jsonrpc === '2.0' &&\n 'method' in payload &&\n typeof payload.method === 'string' &&\n 'params' in payload\n );\n}\n"]}
|
package/dist/index.node.cjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
var errors = require('@solana/errors');
|
|
3
4
|
var rpcSpecTypes = require('@solana/rpc-spec-types');
|
|
4
5
|
|
|
5
6
|
// src/rpc.ts
|
|
@@ -17,29 +18,27 @@ function makeProxy(rpcConfig) {
|
|
|
17
18
|
get(target, p, receiver) {
|
|
18
19
|
return function(...rawParams) {
|
|
19
20
|
const methodName = p.toString();
|
|
20
|
-
const
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
const getApiPlan = Reflect.get(target, methodName, receiver);
|
|
22
|
+
if (!getApiPlan) {
|
|
23
|
+
throw new errors.SolanaError(errors.SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {
|
|
24
|
+
method: methodName,
|
|
25
|
+
params: rawParams
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
const apiPlan = getApiPlan(...rawParams);
|
|
29
|
+
return createPendingRpcRequest(rpcConfig, apiPlan);
|
|
23
30
|
};
|
|
24
31
|
}
|
|
25
32
|
});
|
|
26
33
|
}
|
|
27
|
-
function createPendingRpcRequest(
|
|
34
|
+
function createPendingRpcRequest({ transport }, plan) {
|
|
28
35
|
return {
|
|
29
36
|
async send(options) {
|
|
30
|
-
|
|
31
|
-
const payload = rpcSpecTypes.createRpcMessage(methodName, params);
|
|
32
|
-
const response = await rpcConfig.transport({
|
|
33
|
-
payload,
|
|
34
|
-
signal: options?.abortSignal
|
|
35
|
-
});
|
|
36
|
-
return responseTransformer ? responseTransformer(response, methodName) : response;
|
|
37
|
+
return await plan.execute({ signal: options?.abortSignal, transport });
|
|
37
38
|
}
|
|
38
39
|
};
|
|
39
40
|
}
|
|
40
|
-
|
|
41
|
-
// src/rpc-api.ts
|
|
42
|
-
function createRpcApi(config) {
|
|
41
|
+
function createJsonRpcApi(config) {
|
|
43
42
|
return new Proxy({}, {
|
|
44
43
|
defineProperty() {
|
|
45
44
|
return false;
|
|
@@ -51,19 +50,33 @@ function createRpcApi(config) {
|
|
|
51
50
|
const [_, p] = args;
|
|
52
51
|
const methodName = p.toString();
|
|
53
52
|
return function(...rawParams) {
|
|
54
|
-
const
|
|
55
|
-
const
|
|
56
|
-
return {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
53
|
+
const rawRequest = Object.freeze({ methodName, params: rawParams });
|
|
54
|
+
const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;
|
|
55
|
+
return Object.freeze({
|
|
56
|
+
execute: async ({ signal, transport }) => {
|
|
57
|
+
const payload = rpcSpecTypes.createRpcMessage(request);
|
|
58
|
+
const response = await transport({ payload, signal });
|
|
59
|
+
if (!config?.responseTransformer) {
|
|
60
|
+
return response;
|
|
61
|
+
}
|
|
62
|
+
return config.responseTransformer(response, request);
|
|
63
|
+
}
|
|
64
|
+
});
|
|
61
65
|
};
|
|
62
66
|
}
|
|
63
67
|
});
|
|
64
68
|
}
|
|
65
69
|
|
|
70
|
+
// src/rpc-transport.ts
|
|
71
|
+
function isJsonRpcPayload(payload) {
|
|
72
|
+
if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
|
|
73
|
+
return false;
|
|
74
|
+
}
|
|
75
|
+
return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
exports.createJsonRpcApi = createJsonRpcApi;
|
|
66
79
|
exports.createRpc = createRpc;
|
|
67
|
-
exports.
|
|
80
|
+
exports.isJsonRpcPayload = isJsonRpcPayload;
|
|
68
81
|
//# sourceMappingURL=index.node.cjs.map
|
|
69
82
|
//# sourceMappingURL=index.node.cjs.map
|
package/dist/index.node.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts"],"names":["createRpcMessage"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts","../src/rpc-transport.ts"],"names":["SolanaError","SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD","createRpcMessage"],"mappings":";;;;;;AAmCO,SAAS,UACZ,SACgB,EAAA;AAChB,EAAA,OAAO,UAAU,SAAS,CAAA,CAAA;AAC9B,CAAA;AAEA,SAAS,UACL,SACgB,EAAA;AAChB,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,QAAA,MAAM,UAAa,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,YAAY,QAAQ,CAAA,CAAA;AAC3D,QAAA,IAAI,CAAC,UAAY,EAAA;AACb,UAAM,MAAA,IAAIA,mBAAYC,yDAAoD,EAAA;AAAA,YACtE,MAAQ,EAAA,UAAA;AAAA,YACR,MAAQ,EAAA,SAAA;AAAA,WACX,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,OAAA,GAAU,UAAW,CAAA,GAAG,SAAS,CAAA,CAAA;AACvC,QAAO,OAAA,uBAAA,CAAwB,WAAW,OAAO,CAAA,CAAA;AAAA,OACrD,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,uBACL,CAAA,EAAE,SAAU,EAAA,EACZ,IAC4B,EAAA;AAC5B,EAAO,OAAA;AAAA,IACH,MAAM,KAAK,OAA8C,EAAA;AACrD,MAAO,OAAA,MAAM,KAAK,OAAQ,CAAA,EAAE,QAAQ,OAAS,EAAA,WAAA,EAAa,WAAW,CAAA,CAAA;AAAA,KACzE;AAAA,GACJ,CAAA;AACJ,CAAA;ACvCO,SAAS,iBAAoD,MAA4C,EAAA;AAC5G,EAAO,OAAA,IAAI,KAAM,CAAA,EAA2B,EAAA;AAAA,IACxC,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,MAAA,OAAO,YACA,SAG0C,EAAA;AAC7C,QAAA,MAAM,aAAa,MAAO,CAAA,MAAA,CAAO,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,UAAU,MAAQ,EAAA,kBAAA,GAAqB,MAAQ,EAAA,kBAAA,CAAmB,UAAU,CAAI,GAAA,UAAA,CAAA;AACtF,QAAA,OAAO,OAAO,MAAsD,CAAA;AAAA,UAChE,OAAS,EAAA,OAAO,EAAE,MAAA,EAAQ,WAAgB,KAAA;AACtC,YAAM,MAAA,OAAA,GAAUC,8BAAiB,OAAO,CAAA,CAAA;AACxC,YAAA,MAAM,WAAW,MAAM,SAAA,CAAU,EAAE,OAAA,EAAS,QAAQ,CAAA,CAAA;AACpD,YAAI,IAAA,CAAC,QAAQ,mBAAqB,EAAA;AAC9B,cAAO,OAAA,QAAA,CAAA;AAAA,aACX;AACA,YAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,WACvD;AAAA,SACH,CAAA,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;;;AC5DO,SAAS,iBAAiB,OAI9B,EAAA;AACC,EAAI,IAAA,OAAA,IAAW,QAAQ,OAAO,OAAA,KAAY,YAAY,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAC1E,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AACA,EACI,OAAA,SAAA,IAAa,OACb,IAAA,OAAA,CAAQ,OAAY,KAAA,KAAA,IACpB,QAAY,IAAA,OAAA,IACZ,OAAO,OAAA,CAAQ,MAAW,KAAA,QAAA,IAC1B,QAAY,IAAA,OAAA,CAAA;AAEpB","file":"index.node.cjs","sourcesContent":["import { SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\n\nimport { RpcApi, RpcPlan } from './rpc-api';\nimport { RpcTransport } from './rpc-transport';\n\nexport type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{\n api: RpcApi<TRpcMethods>;\n transport: TRpcTransport;\n}>;\n\nexport type Rpc<TRpcMethods> = {\n [TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;\n};\n\nexport type PendingRpcRequest<TResponse> = {\n send(options?: RpcSendOptions): Promise<TResponse>;\n};\n\nexport type RpcSendOptions = Readonly<{\n abortSignal?: AbortSignal;\n}>;\n\ntype PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<\n Flatten<{\n [P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;\n }>\n>;\n\ntype PendingRpcRequestReturnTypeMapper<TMethodImplementation> =\n // Check that this property of the TRpcMethods interface is, in fact, a function.\n TMethodImplementation extends Callable\n ? (...args: Parameters<TMethodImplementation>) => PendingRpcRequest<ReturnType<TMethodImplementation>>\n : never;\n\nexport function createRpc<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return new Proxy(rpcConfig.api, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get(target, p, receiver) {\n return function (...rawParams: unknown[]) {\n const methodName = p.toString();\n const getApiPlan = Reflect.get(target, methodName, receiver);\n if (!getApiPlan) {\n throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {\n method: methodName,\n params: rawParams,\n });\n }\n const apiPlan = getApiPlan(...rawParams);\n return createPendingRpcRequest(rpcConfig, apiPlan);\n };\n },\n }) as Rpc<TRpcMethods>;\n}\n\nfunction createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport, TResponse>(\n { transport }: RpcConfig<TRpcMethods, TRpcTransport>,\n plan: RpcPlan<TResponse>,\n): PendingRpcRequest<TResponse> {\n return {\n async send(options?: RpcSendOptions): Promise<TResponse> {\n return await plan.execute({ signal: options?.abortSignal, transport });\n },\n };\n}\n","import {\n Callable,\n createRpcMessage,\n RpcRequestTransformer,\n RpcResponse,\n RpcResponseTransformer,\n} from '@solana/rpc-spec-types';\n\nimport type { RpcTransport } from './rpc-transport';\n\nexport type RpcApiConfig = Readonly<{\n requestTransformer?: RpcRequestTransformer;\n responseTransformer?: RpcResponseTransformer;\n}>;\n\nexport type RpcPlan<TResponse> = {\n execute: (\n config: Readonly<{\n signal?: AbortSignal;\n transport: RpcTransport;\n }>,\n ) => Promise<RpcResponse<TResponse>>;\n};\n\nexport type RpcApi<TRpcMethods> = {\n [MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;\n};\n\ntype RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>>\n : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcApiMethod = (...args: any) => any;\ninterface RpcApiMethods {\n [methodName: string]: RpcApiMethod;\n}\n\nexport function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods> {\n return new Proxy({} as RpcApi<TRpcMethods>, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get<TMethodName extends keyof RpcApi<TRpcMethods>>(\n ...args: Parameters<NonNullable<ProxyHandler<RpcApi<TRpcMethods>>['get']>>\n ) {\n const [_, p] = args;\n const methodName = p.toString() as keyof TRpcMethods as string;\n return function (\n ...rawParams: Parameters<\n TRpcMethods[TMethodName] extends CallableFunction ? TRpcMethods[TMethodName] : never\n >\n ): RpcPlan<ReturnType<TRpcMethods[TMethodName]>> {\n const rawRequest = Object.freeze({ methodName, params: rawParams });\n const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;\n return Object.freeze(<RpcPlan<ReturnType<TRpcMethods[TMethodName]>>>{\n execute: async ({ signal, transport }) => {\n const payload = createRpcMessage(request);\n const response = await transport({ payload, signal });\n if (!config?.responseTransformer) {\n return response;\n }\n return config.responseTransformer(response, request);\n },\n });\n };\n },\n });\n}\n","import { RpcResponse } from '@solana/rpc-spec-types';\n\ntype Config = Readonly<{\n payload: unknown;\n signal?: AbortSignal;\n}>;\n\nexport type RpcTransport = {\n <TResponse>(config: Config): Promise<RpcResponse<TResponse>>;\n};\n\nexport function isJsonRpcPayload(payload: unknown): payload is Readonly<{\n jsonrpc: '2.0';\n method: string;\n params: unknown;\n}> {\n if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n return false;\n }\n return (\n 'jsonrpc' in payload &&\n payload.jsonrpc === '2.0' &&\n 'method' in payload &&\n typeof payload.method === 'string' &&\n 'params' in payload\n );\n}\n"]}
|
package/dist/index.node.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SolanaError, SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD } from '@solana/errors';
|
|
1
2
|
import { createRpcMessage } from '@solana/rpc-spec-types';
|
|
2
3
|
|
|
3
4
|
// src/rpc.ts
|
|
@@ -15,29 +16,27 @@ function makeProxy(rpcConfig) {
|
|
|
15
16
|
get(target, p, receiver) {
|
|
16
17
|
return function(...rawParams) {
|
|
17
18
|
const methodName = p.toString();
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
const getApiPlan = Reflect.get(target, methodName, receiver);
|
|
20
|
+
if (!getApiPlan) {
|
|
21
|
+
throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {
|
|
22
|
+
method: methodName,
|
|
23
|
+
params: rawParams
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
const apiPlan = getApiPlan(...rawParams);
|
|
27
|
+
return createPendingRpcRequest(rpcConfig, apiPlan);
|
|
21
28
|
};
|
|
22
29
|
}
|
|
23
30
|
});
|
|
24
31
|
}
|
|
25
|
-
function createPendingRpcRequest(
|
|
32
|
+
function createPendingRpcRequest({ transport }, plan) {
|
|
26
33
|
return {
|
|
27
34
|
async send(options) {
|
|
28
|
-
|
|
29
|
-
const payload = createRpcMessage(methodName, params);
|
|
30
|
-
const response = await rpcConfig.transport({
|
|
31
|
-
payload,
|
|
32
|
-
signal: options?.abortSignal
|
|
33
|
-
});
|
|
34
|
-
return responseTransformer ? responseTransformer(response, methodName) : response;
|
|
35
|
+
return await plan.execute({ signal: options?.abortSignal, transport });
|
|
35
36
|
}
|
|
36
37
|
};
|
|
37
38
|
}
|
|
38
|
-
|
|
39
|
-
// src/rpc-api.ts
|
|
40
|
-
function createRpcApi(config) {
|
|
39
|
+
function createJsonRpcApi(config) {
|
|
41
40
|
return new Proxy({}, {
|
|
42
41
|
defineProperty() {
|
|
43
42
|
return false;
|
|
@@ -49,18 +48,31 @@ function createRpcApi(config) {
|
|
|
49
48
|
const [_, p] = args;
|
|
50
49
|
const methodName = p.toString();
|
|
51
50
|
return function(...rawParams) {
|
|
52
|
-
const
|
|
53
|
-
const
|
|
54
|
-
return {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
51
|
+
const rawRequest = Object.freeze({ methodName, params: rawParams });
|
|
52
|
+
const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;
|
|
53
|
+
return Object.freeze({
|
|
54
|
+
execute: async ({ signal, transport }) => {
|
|
55
|
+
const payload = createRpcMessage(request);
|
|
56
|
+
const response = await transport({ payload, signal });
|
|
57
|
+
if (!config?.responseTransformer) {
|
|
58
|
+
return response;
|
|
59
|
+
}
|
|
60
|
+
return config.responseTransformer(response, request);
|
|
61
|
+
}
|
|
62
|
+
});
|
|
59
63
|
};
|
|
60
64
|
}
|
|
61
65
|
});
|
|
62
66
|
}
|
|
63
67
|
|
|
64
|
-
|
|
68
|
+
// src/rpc-transport.ts
|
|
69
|
+
function isJsonRpcPayload(payload) {
|
|
70
|
+
if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
|
|
71
|
+
return false;
|
|
72
|
+
}
|
|
73
|
+
return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export { createJsonRpcApi, createRpc, isJsonRpcPayload };
|
|
65
77
|
//# sourceMappingURL=index.node.mjs.map
|
|
66
78
|
//# sourceMappingURL=index.node.mjs.map
|
package/dist/index.node.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../src/rpc.ts","../src/rpc-api.ts","../src/rpc-transport.ts"],"names":[],"mappings":";;;;AAmCO,SAAS,UACZ,SACgB,EAAA;AAChB,EAAA,OAAO,UAAU,SAAS,CAAA,CAAA;AAC9B,CAAA;AAEA,SAAS,UACL,SACgB,EAAA;AAChB,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,QAAA,MAAM,UAAa,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,YAAY,QAAQ,CAAA,CAAA;AAC3D,QAAA,IAAI,CAAC,UAAY,EAAA;AACb,UAAM,MAAA,IAAI,YAAY,kDAAoD,EAAA;AAAA,YACtE,MAAQ,EAAA,UAAA;AAAA,YACR,MAAQ,EAAA,SAAA;AAAA,WACX,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,OAAA,GAAU,UAAW,CAAA,GAAG,SAAS,CAAA,CAAA;AACvC,QAAO,OAAA,uBAAA,CAAwB,WAAW,OAAO,CAAA,CAAA;AAAA,OACrD,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,uBACL,CAAA,EAAE,SAAU,EAAA,EACZ,IAC4B,EAAA;AAC5B,EAAO,OAAA;AAAA,IACH,MAAM,KAAK,OAA8C,EAAA;AACrD,MAAO,OAAA,MAAM,KAAK,OAAQ,CAAA,EAAE,QAAQ,OAAS,EAAA,WAAA,EAAa,WAAW,CAAA,CAAA;AAAA,KACzE;AAAA,GACJ,CAAA;AACJ,CAAA;ACvCO,SAAS,iBAAoD,MAA4C,EAAA;AAC5G,EAAO,OAAA,IAAI,KAAM,CAAA,EAA2B,EAAA;AAAA,IACxC,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,UAAA,GAAa,EAAE,QAAS,EAAA,CAAA;AAC9B,MAAA,OAAO,YACA,SAG0C,EAAA;AAC7C,QAAA,MAAM,aAAa,MAAO,CAAA,MAAA,CAAO,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,UAAU,MAAQ,EAAA,kBAAA,GAAqB,MAAQ,EAAA,kBAAA,CAAmB,UAAU,CAAI,GAAA,UAAA,CAAA;AACtF,QAAA,OAAO,OAAO,MAAsD,CAAA;AAAA,UAChE,OAAS,EAAA,OAAO,EAAE,MAAA,EAAQ,WAAgB,KAAA;AACtC,YAAM,MAAA,OAAA,GAAU,iBAAiB,OAAO,CAAA,CAAA;AACxC,YAAA,MAAM,WAAW,MAAM,SAAA,CAAU,EAAE,OAAA,EAAS,QAAQ,CAAA,CAAA;AACpD,YAAI,IAAA,CAAC,QAAQ,mBAAqB,EAAA;AAC9B,cAAO,OAAA,QAAA,CAAA;AAAA,aACX;AACA,YAAO,OAAA,MAAA,CAAO,mBAAoB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,WACvD;AAAA,SACH,CAAA,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;;;AC5DO,SAAS,iBAAiB,OAI9B,EAAA;AACC,EAAI,IAAA,OAAA,IAAW,QAAQ,OAAO,OAAA,KAAY,YAAY,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAC1E,IAAO,OAAA,KAAA,CAAA;AAAA,GACX;AACA,EACI,OAAA,SAAA,IAAa,OACb,IAAA,OAAA,CAAQ,OAAY,KAAA,KAAA,IACpB,QAAY,IAAA,OAAA,IACZ,OAAO,OAAA,CAAQ,MAAW,KAAA,QAAA,IAC1B,QAAY,IAAA,OAAA,CAAA;AAEpB","file":"index.node.mjs","sourcesContent":["import { SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\n\nimport { RpcApi, RpcPlan } from './rpc-api';\nimport { RpcTransport } from './rpc-transport';\n\nexport type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{\n api: RpcApi<TRpcMethods>;\n transport: TRpcTransport;\n}>;\n\nexport type Rpc<TRpcMethods> = {\n [TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;\n};\n\nexport type PendingRpcRequest<TResponse> = {\n send(options?: RpcSendOptions): Promise<TResponse>;\n};\n\nexport type RpcSendOptions = Readonly<{\n abortSignal?: AbortSignal;\n}>;\n\ntype PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<\n Flatten<{\n [P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;\n }>\n>;\n\ntype PendingRpcRequestReturnTypeMapper<TMethodImplementation> =\n // Check that this property of the TRpcMethods interface is, in fact, a function.\n TMethodImplementation extends Callable\n ? (...args: Parameters<TMethodImplementation>) => PendingRpcRequest<ReturnType<TMethodImplementation>>\n : never;\n\nexport function createRpc<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcMethods, TRpcTransport extends RpcTransport>(\n rpcConfig: RpcConfig<TRpcMethods, TRpcTransport>,\n): Rpc<TRpcMethods> {\n return new Proxy(rpcConfig.api, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get(target, p, receiver) {\n return function (...rawParams: unknown[]) {\n const methodName = p.toString();\n const getApiPlan = Reflect.get(target, methodName, receiver);\n if (!getApiPlan) {\n throw new SolanaError(SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD, {\n method: methodName,\n params: rawParams,\n });\n }\n const apiPlan = getApiPlan(...rawParams);\n return createPendingRpcRequest(rpcConfig, apiPlan);\n };\n },\n }) as Rpc<TRpcMethods>;\n}\n\nfunction createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport, TResponse>(\n { transport }: RpcConfig<TRpcMethods, TRpcTransport>,\n plan: RpcPlan<TResponse>,\n): PendingRpcRequest<TResponse> {\n return {\n async send(options?: RpcSendOptions): Promise<TResponse> {\n return await plan.execute({ signal: options?.abortSignal, transport });\n },\n };\n}\n","import {\n Callable,\n createRpcMessage,\n RpcRequestTransformer,\n RpcResponse,\n RpcResponseTransformer,\n} from '@solana/rpc-spec-types';\n\nimport type { RpcTransport } from './rpc-transport';\n\nexport type RpcApiConfig = Readonly<{\n requestTransformer?: RpcRequestTransformer;\n responseTransformer?: RpcResponseTransformer;\n}>;\n\nexport type RpcPlan<TResponse> = {\n execute: (\n config: Readonly<{\n signal?: AbortSignal;\n transport: RpcTransport;\n }>,\n ) => Promise<RpcResponse<TResponse>>;\n};\n\nexport type RpcApi<TRpcMethods> = {\n [MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;\n};\n\ntype RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>>\n : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcApiMethod = (...args: any) => any;\ninterface RpcApiMethods {\n [methodName: string]: RpcApiMethod;\n}\n\nexport function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods> {\n return new Proxy({} as RpcApi<TRpcMethods>, {\n defineProperty() {\n return false;\n },\n deleteProperty() {\n return false;\n },\n get<TMethodName extends keyof RpcApi<TRpcMethods>>(\n ...args: Parameters<NonNullable<ProxyHandler<RpcApi<TRpcMethods>>['get']>>\n ) {\n const [_, p] = args;\n const methodName = p.toString() as keyof TRpcMethods as string;\n return function (\n ...rawParams: Parameters<\n TRpcMethods[TMethodName] extends CallableFunction ? TRpcMethods[TMethodName] : never\n >\n ): RpcPlan<ReturnType<TRpcMethods[TMethodName]>> {\n const rawRequest = Object.freeze({ methodName, params: rawParams });\n const request = config?.requestTransformer ? config?.requestTransformer(rawRequest) : rawRequest;\n return Object.freeze(<RpcPlan<ReturnType<TRpcMethods[TMethodName]>>>{\n execute: async ({ signal, transport }) => {\n const payload = createRpcMessage(request);\n const response = await transport({ payload, signal });\n if (!config?.responseTransformer) {\n return response;\n }\n return config.responseTransformer(response, request);\n },\n });\n };\n },\n });\n}\n","import { RpcResponse } from '@solana/rpc-spec-types';\n\ntype Config = Readonly<{\n payload: unknown;\n signal?: AbortSignal;\n}>;\n\nexport type RpcTransport = {\n <TResponse>(config: Config): Promise<RpcResponse<TResponse>>;\n};\n\nexport function isJsonRpcPayload(payload: unknown): payload is Readonly<{\n jsonrpc: '2.0';\n method: string;\n params: unknown;\n}> {\n if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n return false;\n }\n return (\n 'jsonrpc' in payload &&\n payload.jsonrpc === '2.0' &&\n 'method' in payload &&\n typeof payload.method === 'string' &&\n 'params' in payload\n );\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC"}
|
package/dist/types/rpc-api.d.ts
CHANGED
|
@@ -1,17 +1,23 @@
|
|
|
1
|
-
import { Callable } from '@solana/rpc-spec-types';
|
|
2
|
-
import {
|
|
1
|
+
import { Callable, RpcRequestTransformer, RpcResponse, RpcResponseTransformer } from '@solana/rpc-spec-types';
|
|
2
|
+
import type { RpcTransport } from './rpc-transport';
|
|
3
3
|
export type RpcApiConfig = Readonly<{
|
|
4
|
-
|
|
5
|
-
responseTransformer?:
|
|
4
|
+
requestTransformer?: RpcRequestTransformer;
|
|
5
|
+
responseTransformer?: RpcResponseTransformer;
|
|
6
6
|
}>;
|
|
7
|
+
export type RpcPlan<TResponse> = {
|
|
8
|
+
execute: (config: Readonly<{
|
|
9
|
+
signal?: AbortSignal;
|
|
10
|
+
transport: RpcTransport;
|
|
11
|
+
}>) => Promise<RpcResponse<TResponse>>;
|
|
12
|
+
};
|
|
7
13
|
export type RpcApi<TRpcMethods> = {
|
|
8
14
|
[MethodName in keyof TRpcMethods]: RpcReturnTypeMapper<TRpcMethods[MethodName]>;
|
|
9
15
|
};
|
|
10
|
-
type RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable ? (...rawParams: unknown[]) =>
|
|
16
|
+
type RpcReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable ? (...rawParams: unknown[]) => RpcPlan<ReturnType<TRpcMethod>> : never;
|
|
11
17
|
type RpcApiMethod = (...args: any) => any;
|
|
12
|
-
|
|
18
|
+
interface RpcApiMethods {
|
|
13
19
|
[methodName: string]: RpcApiMethod;
|
|
14
20
|
}
|
|
15
|
-
export declare function
|
|
21
|
+
export declare function createJsonRpcApi<TRpcMethods extends RpcApiMethods>(config?: RpcApiConfig): RpcApi<TRpcMethods>;
|
|
16
22
|
export {};
|
|
17
23
|
//# sourceMappingURL=rpc-api.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rpc-api.d.ts","sourceRoot":"","sources":["../../src/rpc-api.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"rpc-api.d.ts","sourceRoot":"","sources":["../../src/rpc-api.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EAER,qBAAqB,EACrB,WAAW,EACX,sBAAsB,EACzB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC;IAChC,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;CAChD,CAAC,CAAC;AAEH,MAAM,MAAM,OAAO,CAAC,SAAS,IAAI;IAC7B,OAAO,EAAE,CACL,MAAM,EAAE,QAAQ,CAAC;QACb,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,SAAS,EAAE,YAAY,CAAC;KAC3B,CAAC,KACD,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,WAAW,IAAI;KAC7B,UAAU,IAAI,MAAM,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;CAClF,CAAC;AAEF,KAAK,mBAAmB,CAAC,UAAU,IAAI,UAAU,SAAS,QAAQ,GAC5D,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAC5D,KAAK,CAAC;AAGZ,KAAK,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;AAC1C,UAAU,aAAa;IACnB,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,CAAC;CACtC;AAED,wBAAgB,gBAAgB,CAAC,WAAW,SAAS,aAAa,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAiC9G"}
|
|
@@ -1,9 +1,15 @@
|
|
|
1
|
-
|
|
1
|
+
import { RpcResponse } from '@solana/rpc-spec-types';
|
|
2
|
+
type Config = Readonly<{
|
|
2
3
|
payload: unknown;
|
|
3
4
|
signal?: AbortSignal;
|
|
4
5
|
}>;
|
|
5
|
-
export
|
|
6
|
-
<TResponse>(config:
|
|
7
|
-
}
|
|
6
|
+
export type RpcTransport = {
|
|
7
|
+
<TResponse>(config: Config): Promise<RpcResponse<TResponse>>;
|
|
8
|
+
};
|
|
9
|
+
export declare function isJsonRpcPayload(payload: unknown): payload is Readonly<{
|
|
10
|
+
jsonrpc: '2.0';
|
|
11
|
+
method: string;
|
|
12
|
+
params: unknown;
|
|
13
|
+
}>;
|
|
8
14
|
export {};
|
|
9
15
|
//# sourceMappingURL=rpc-transport.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rpc-transport.d.ts","sourceRoot":"","sources":["../../src/rpc-transport.ts"],"names":[],"mappings":"AAAA,KAAK,
|
|
1
|
+
{"version":3,"file":"rpc-transport.d.ts","sourceRoot":"","sources":["../../src/rpc-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,KAAK,MAAM,GAAG,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG;IACvB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,QAAQ,CAAC;IACpE,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC,CAWD"}
|
package/dist/types/rpc.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';
|
|
2
2
|
import { RpcApi } from './rpc-api';
|
|
3
|
-
import { PendingRpcRequest } from './rpc-request';
|
|
4
3
|
import { RpcTransport } from './rpc-transport';
|
|
5
4
|
export type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonly<{
|
|
6
5
|
api: RpcApi<TRpcMethods>;
|
|
@@ -9,6 +8,12 @@ export type RpcConfig<TRpcMethods, TRpcTransport extends RpcTransport> = Readonl
|
|
|
9
8
|
export type Rpc<TRpcMethods> = {
|
|
10
9
|
[TMethodName in keyof TRpcMethods]: PendingRpcRequestBuilder<OverloadImplementations<TRpcMethods, TMethodName>>;
|
|
11
10
|
};
|
|
11
|
+
export type PendingRpcRequest<TResponse> = {
|
|
12
|
+
send(options?: RpcSendOptions): Promise<TResponse>;
|
|
13
|
+
};
|
|
14
|
+
export type RpcSendOptions = Readonly<{
|
|
15
|
+
abortSignal?: AbortSignal;
|
|
16
|
+
}>;
|
|
12
17
|
type PendingRpcRequestBuilder<TMethodImplementations> = UnionToIntersection<Flatten<{
|
|
13
18
|
[P in keyof TMethodImplementations]: PendingRpcRequestReturnTypeMapper<TMethodImplementations[P]>;
|
|
14
19
|
}>>;
|
package/dist/types/rpc.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../src/rpc.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../src/rpc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAEzG,OAAO,EAAE,MAAM,EAAW,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,MAAM,SAAS,CAAC,WAAW,EAAE,aAAa,SAAS,YAAY,IAAI,QAAQ,CAAC;IAC9E,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IACzB,SAAS,EAAE,aAAa,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,CAAC,WAAW,IAAI;KAC1B,WAAW,IAAI,MAAM,WAAW,GAAG,wBAAwB,CAAC,uBAAuB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;CAClH,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,SAAS,IAAI;IACvC,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IAClC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B,CAAC,CAAC;AAEH,KAAK,wBAAwB,CAAC,sBAAsB,IAAI,mBAAmB,CACvE,OAAO,CAAC;KACH,CAAC,IAAI,MAAM,sBAAsB,GAAG,iCAAiC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;CACpG,CAAC,CACL,CAAC;AAEF,KAAK,iCAAiC,CAAC,qBAAqB,IAExD,qBAAqB,SAAS,QAAQ,GAChC,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,qBAAqB,CAAC,KAAK,iBAAiB,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,GACpG,KAAK,CAAC;AAEhB,wBAAgB,SAAS,CAAC,WAAW,EAAE,aAAa,SAAS,YAAY,EACrE,SAAS,EAAE,SAAS,CAAC,WAAW,EAAE,aAAa,CAAC,GACjD,GAAG,CAAC,WAAW,CAAC,CAElB"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@solana/rpc-spec",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.2",
|
|
4
4
|
"description": "A generic implementation of JSON RPCs using proxies",
|
|
5
5
|
"exports": {
|
|
6
|
+
"edge-light": {
|
|
7
|
+
"import": "./dist/index.node.mjs",
|
|
8
|
+
"require": "./dist/index.node.cjs"
|
|
9
|
+
},
|
|
10
|
+
"workerd": {
|
|
11
|
+
"import": "./dist/index.node.mjs",
|
|
12
|
+
"require": "./dist/index.node.cjs"
|
|
13
|
+
},
|
|
6
14
|
"browser": {
|
|
7
15
|
"import": "./dist/index.browser.mjs",
|
|
8
16
|
"require": "./dist/index.browser.cjs"
|
|
@@ -46,7 +54,8 @@
|
|
|
46
54
|
"maintained node versions"
|
|
47
55
|
],
|
|
48
56
|
"dependencies": {
|
|
49
|
-
"@solana/
|
|
57
|
+
"@solana/errors": "2.0.0-rc.2",
|
|
58
|
+
"@solana/rpc-spec-types": "2.0.0-rc.2"
|
|
50
59
|
},
|
|
51
60
|
"peerDependencies": {
|
|
52
61
|
"typescript": ">=5"
|
|
@@ -59,13 +68,16 @@
|
|
|
59
68
|
}
|
|
60
69
|
]
|
|
61
70
|
},
|
|
71
|
+
"engines": {
|
|
72
|
+
"node": ">=20.18.0"
|
|
73
|
+
},
|
|
62
74
|
"scripts": {
|
|
63
75
|
"compile:js": "tsup --config build-scripts/tsup.config.package.ts",
|
|
64
76
|
"compile:typedefs": "tsc -p ./tsconfig.declarations.json",
|
|
65
77
|
"dev": "jest -c ../../node_modules/@solana/test-config/jest-dev.config.ts --rootDir . --watch",
|
|
66
78
|
"publish-impl": "npm view $npm_package_name@$npm_package_version > /dev/null 2>&1 || pnpm publish --tag ${PUBLISH_TAG:-canary} --access public --no-git-checks",
|
|
67
79
|
"publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
|
|
68
|
-
"style:fix": "pnpm eslint --fix src
|
|
80
|
+
"style:fix": "pnpm eslint --fix src && pnpm prettier --log-level warn --ignore-unknown --write ./*",
|
|
69
81
|
"test:lint": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-lint.config.ts --rootDir . --silent",
|
|
70
82
|
"test:prettier": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-prettier.config.ts --rootDir . --silent",
|
|
71
83
|
"test:treeshakability:browser": "agadoo dist/index.browser.mjs",
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
export type RpcRequest<TResponse> = {
|
|
2
|
-
methodName: string;
|
|
3
|
-
params: unknown;
|
|
4
|
-
responseTransformer?: (response: unknown, methodName: string) => TResponse;
|
|
5
|
-
};
|
|
6
|
-
export type PendingRpcRequest<TResponse> = {
|
|
7
|
-
send(options?: RpcSendOptions): Promise<TResponse>;
|
|
8
|
-
};
|
|
9
|
-
export type RpcSendOptions = Readonly<{
|
|
10
|
-
abortSignal?: AbortSignal;
|
|
11
|
-
}>;
|
|
12
|
-
//# sourceMappingURL=rpc-request.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"rpc-request.d.ts","sourceRoot":"","sources":["../../src/rpc-request.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,CAAC,SAAS,IAAI;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,KAAK,SAAS,CAAC;CAC9E,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,SAAS,IAAI;IACvC,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IAClC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B,CAAC,CAAC"}
|