quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Usage comments around rpc and call interfaces (#5327)

Browse Source 
* Usage comments around rpc and call interfaces

* Optional pubsub

* s/method/subname/
This commit is contained in:
Jaco
2022-11-11 09:14:00 +02:00
committed by GitHub
parent 3525070d92
commit 8dd13e181a
2 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/api-base/src/types/calls.ts
+4 -2
View File
@@ -11,8 +11,10 @@ export type DecoratedCallBase<ApiType extends ApiTypes, F extends AnyFunction =
: <T extends Codec | any = ReturnCodec<F>> (...args: Parameters<F>) => Promise<T>;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
export type AugmentedCall<ApiType extends ApiTypes, F extends AnyFunction = (...args: any[]) => Observable<Codec>> =
DecoratedCallBase<ApiType, F> & { meta: DefinitionCallNamed };
export type AugmentedCall<ApiType extends ApiTypes, F extends AnyFunction = (...args: any[]) => Observable<Codec>> = DecoratedCallBase<ApiType, F> & {
/** The metadata/description/definition for this method */
meta: DefinitionCallNamed
};
// augmented interfaces
packages/types/src/types/definitions.ts
+33 -2
View File
@@ -19,61 +19,92 @@ export type DefinitionTypeStruct = Record<string, DefinitionTypeType> | Definiti
export type DefinitionType = string | DefinitionTypeEnum | DefinitionTypeSet | DefinitionTypeStruct;
export interface DefinitionRpcParam {
/** true if the parameter is a blockhash that is to be used in historic queries */
isHistoric?: boolean;
/** true if this is an optional parameter (we forgo the use of Option<T> types) */
isOptional?: boolean;
/** The name of the parameter */
name: string;
/** The type of the parameter */
type: DefinitionTypeType;
}
export interface DefinitionRpc {
/** Alias to a specific method (this allows replacements and renames) */
alias?: string[];
/** Alias to a section */
aliasSection?: string;
/** A string describing a deprecated interface, along with to-use information */
deprecated?: string;
/** The description for this RPC call */
description: string;
/** The (optional) endpoint override. If not specified the section_method is used */
endpoint?: string;
/** true if this needs a signed submission, e.g. when submitting extrinsics */
isSigned?: boolean;
/** Don't log any errors if they occur (should be used sparingly for exceptions only) */
noErrorLog?: boolean;
/** The applicable parameters for the call */
params: DefinitionRpcParam[];
/** The return type for the RPC call */
type: DefinitionTypeType;
}
export interface DefinitionRpcExt extends DefinitionRpc {
/** true if this is a method yielding a subscription */
isSubscription: boolean;
/** The jsonrpc name for this method, typically section_method */
jsonrpc: string;
/** The method name for this RPC */
method: string;
pubsub?: [string, string, string];
/** Optional subscription information in the form [subscription name, subscribe method, unsubscribe method] */
pubsub?: [subname: string, subscribe: string, unsubscribe: string];
/** The section name for this RPC */
section: string;
}
export interface DefinitionCallParam {
/** The name for this parameter */
name: string;
/** The return type for this parameter */
type: DefinitionTypeType;
}
export interface DefinitionCall {
/** The description of this runtime call (generally extracted from the Rust code as-is) */
description: string;
/** The applicable call parameters */
params: DefinitionCallParam[];
/** The return type for this call */
type: DefinitionTypeType;
}
export interface DefinitionRpcSub extends DefinitionRpc {
pubsub: [string, string, string];
/** Subscription information in the form [subscription name, subscribe method, unsubscribe method] */
pubsub: [subname: string, subscribe: string, unsubscribe: string];
}
export type DefinitionsRpc = Record<string, DefinitionRpc | DefinitionRpcSub>;
export interface DefinitionsCallEntry {
/** The method that are available on this interface */
methods: Record<string, DefinitionCall>;
/** The version of the runtime api that this definition applies to */
version: number;
}
export type DefinitionsCall = Record<string, DefinitionsCallEntry[]>;
export interface DefinitionCallNamed extends DefinitionCall {
/** The method for this call (combined with section to form name) */
method: string;
/** The actual name of the runtime call as exposed by the runtime itself */
name: string;
/** The section for this call (combined with method to form name) */
section: string;
/** The hash of this section (these map to what is available in state_getRuntimeVersion) */
sectionHash: HexString;
/** The version of the runtime interface */
version: number;
}