postchain-client 1.0.1 → 1.0.2

package/built/src/chromia/chromiaClientProvider.d.ts

@@ -1,3 +1,8 @@
-import { RestClient } from "../restclient/interfaces";
-import { ChromiaClientProvider } from "./interfaces";
-export declare function chromiaClientProvider(chain0BRID: string, rest: RestClient): ChromiaClientProvider;
+import type { RestClient } from "../restclient/interfaces";
+import type { ChromiaClient } from "./interfaces";
+/**
+ * Provides postchain clients that can be used to communicate with dapps within the chromia network
+ * @param chain0BRID brid of chain0
+ * @param rest rest client configured to node running chain0
+ */
+export declare function chromiaClientProvider(chain0BRID: string, rest: RestClient): ChromiaClient;

package/built/src/chromia/interfaces.d.ts

@@ -1,4 +1,4 @@
 import { RestClient } from "../restclient/interfaces";
-export interface ChromiaClientProvider {
+export interface ChromiaClient {
     blockchainConnection: (blockchainRid: string) => Promise<RestClient>;
 }

package/built/src/encryption/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-export declare type KeyPair = {
+export type KeyPair = {
     pubKey: Buffer;
     privKey: Buffer;
 };

package/built/src/formatter.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { GTX, RawGtx } from "./gtx/types";
 export declare function pgBytes(buffer: Buffer): string;
 /**
  * Converts hex string to Buffer
@@ -16,4 +17,7 @@ export declare class PgBytesInputException extends Error {
     constructor(buffer: Buffer);
 }
 export declare function ensureBuffer(value: string | Buffer): Buffer;
+export declare function checkGtvType(value: any): boolean;
+export declare function rawGtxToGtx(rawGtx: RawGtx): GTX;
+export declare function checkGtxType(value: any): boolean;
 export declare function removeDuplicateSigners(signers: Buffer[]): Buffer[];

package/built/src/gtv/types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-export declare type RawGtv = null | Buffer | string | number | DictPair | Array<RawGtv> | bigint;
-export declare type DictPair = {
+export type RawGtv = null | Buffer | string | number | DictPair | Array<RawGtv> | bigint;
+export type DictPair = {
     name: string;
     value: RawGtv;
 };

package/built/src/gtx/types.d.ts

@@ -1,28 +1,28 @@
 /// <reference types="node" />
 import { RawGtv } from "../gtv/types";
-export declare type RawGtxOp = [opName: string, args: RawGtv[]];
-export declare type RawGtxBody = [
+export type RawGtxOp = [opName: string, args: RawGtv[]];
+export type RawGtxBody = [
     blockchainRID: Buffer,
     operations: RawGtxOp[],
     signers: Buffer[]
 ];
-export declare type RawGtx = [transaction: RawGtxBody, signatures: Buffer[]];
-export declare type GTX = {
+export type RawGtx = [transaction: RawGtxBody, signatures: Buffer[]];
+export type GTX = {
     [x: string]: any;
     blockchainRID: Buffer;
     operations: RellOperation[];
     signers: Buffer[];
     signatures?: Buffer[];
 };
-export declare type RellOperation = {
+export type RellOperation = {
     opName: string;
     args: RawGtv[];
 };
-export declare type SignerPair = {
+export type SignerPair = {
     pubKey: string;
     signature: string;
 };
-export declare type BufferSignerPair = {
+export type BufferSignerPair = {
     pubKey: Buffer;
     signature: Buffer;
 };

package/built/src/merkle/types.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" />
-export declare type Step = {
+export type Step = {
     side: number;
     hash: Buffer;
 };
-export declare type StringStep = {
+export type StringStep = {
     side: number;
     hash: string;
 };
-export declare type Path = Step[];
-export declare type StringPath = StringStep[];
+export type Path = Step[];
+export type StringPath = StringStep[];

package/built/src/restclient/types.d.ts

@@ -2,7 +2,7 @@
 import { RawGtv } from "../gtv/types";
 import { BufferSignerPair, SignerPair } from "../gtx/types";
 import { Path, StringPath } from "../merkle/types";
-export declare type RestClientConfig = {
+export type RestClientConfig = {
     endpointPool: readonly string[];
     pool: {
         maxSockets: number;
@@ -11,7 +11,7 @@ export declare type RestClientConfig = {
     attemptsPerEndpoint: number;
     attemptInterval: number;
 };
-export declare type RequestOptions = {
+export type RequestOptions = {
     method: string;
     url: string;
     json: boolean;
@@ -20,17 +20,17 @@ export declare type RequestOptions = {
         maxSockets: number;
     };
 };
-export declare type QueryObject = {
+export type QueryObject = {
     type: string;
     [arg: string]: RawGtv;
 };
-export declare type ServerReturnProof = {
+export type ServerReturnProof = {
     hash: string;
     blockHeader: string;
     signatures: SignerPair[];
     merklePath: StringPath;
 };
-export declare type ResponseObjectProof = {
+export type ResponseObjectProof = {
     hash: Buffer;
     blockHeader: Buffer;
     signatures: BufferSignerPair[];
@@ -42,20 +42,20 @@ export declare enum ResponseStatus {
     Unknown = "unknown",
     Waiting = "waiting"
 }
-export declare type TransactionObject = {
+export type TransactionObject = {
     tx: string;
 };
-export declare type StatusObject = {
+export type StatusObject = {
     status: ResponseStatus;
     rejectReason?: string;
 };
-export declare type PostRequestObjects = TransactionObject | QueryObject;
-export declare type GetResponseObjects = StatusObject | TransactionObject | ServerReturnProof;
-export declare type FailOverConfig = {
+export type PostRequestObjects = TransactionObject | QueryObject;
+export type GetResponseObjects = StatusObject | TransactionObject | ServerReturnProof;
+export type FailOverConfig = {
     attemptsPerEndpoint?: number;
     attemptInterval?: number;
 };
-export declare type ResponseObject = {
+export type ResponseObject = {
     error: Error;
     statusCode: number;
     rspBody: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postchain-client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Client library for accessing a Postchain node through REST.",
   "repository": {
     "type": "git",