@xpla/xplajs 1.7.0-beta.0

package/src/helper-func-types.ts

@@ -0,0 +1,191 @@
+/**
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.3
+* DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+* and run the transpile command or npm scripts command that is used to regenerate this bundle.
+*/
+
+
+import { HttpEndpoint } from "@interchainjs/types";
+import { BinaryReader, BinaryWriter } from "./binary";
+import { getRpcClient } from "./extern";
+import { isRpc, Rpc } from "./helpers";
+
+export interface QueryBuilderOptions<TReq, TRes> {
+  encode: (request: TReq, writer?: BinaryWriter) => BinaryWriter
+  decode: (input: BinaryReader | Uint8Array, length?: number) => TRes
+  service: string,
+  method: string,
+  clientResolver?: RpcResolver
+}
+
+export function buildQuery<TReq, TRes>(opts: QueryBuilderOptions<TReq, TRes>) {
+    return async (request: TReq) => {
+      let rpc: Rpc | undefined;
+
+      if(isRpc(opts.clientResolver)) {
+        rpc = opts.clientResolver;
+      } else {
+        rpc = opts.clientResolver ? await getRpcClient(opts.clientResolver) : undefined;
+      }
+
+      if (!rpc) throw new Error("Query Rpc is not initialized");
+
+      const data = opts.encode(request).finish();
+      const response = await rpc.request(opts.service, opts.method, data);
+      return opts.decode(response);
+    };
+}
+
+export interface ITxArgs<TMsg> {
+  signerAddress: string;
+  message: TMsg;
+  fee: StdFee | 'auto';
+  memo: string;
+}
+
+export function isISigningClient(client: unknown): client is ISigningClient {
+  return client !== null && client !== undefined
+    && typeof (client as ISigningClient).signAndBroadcast === 'function'
+    && typeof (client as ISigningClient).addConverters === 'function'
+    && typeof (client as ISigningClient).addEncoders === 'function';
+}
+
+export interface ISigningClient {
+  /**
+   * register converters
+   */
+  addConverters: (converters: AminoConverter[]) => void;
+  /**
+   * register encoders
+   */
+  addEncoders: (encoders: Encoder[]) => void;
+
+  signAndBroadcast: (
+    signerAddress: string,
+    message: Message[],
+    fee: StdFee | 'auto',
+    memo: string
+  ) => Promise<DeliverTxResponse>;
+}
+
+export interface TxBuilderOptions {
+  clientResolver?: SigningClientResolver,
+  typeUrl: string,
+  encoders?: Encoder[],
+  converters?: AminoConverter[],
+}
+
+export function buildTx<TMsg>(opts: TxBuilderOptions) {
+  return async (
+    signerAddress: string,
+    message: TMsg,
+    fee: StdFee | 'auto',
+    memo: string
+  ): Promise<DeliverTxResponse> => {
+    let client: ISigningClient | undefined;
+
+    // if opts.getSigningClient is a function, call it to get the SigningClient instance
+    if(isISigningClient(opts.clientResolver)) {
+      client = opts.clientResolver;
+    }
+
+    if (!client) throw new Error("SigningClient is not initialized");
+
+    //register all related encoders and converters
+    client.addEncoders(opts.encoders ?? []);
+    client.addConverters(opts.converters ?? []);
+
+    const data = [
+      {
+        typeUrl: opts.typeUrl,
+        value: message,
+      },
+    ];
+    return client.signAndBroadcast!(signerAddress, data, fee, memo);
+  };
+}
+
+export interface Coin {
+  denom: string;
+  amount: string;
+}
+
+export interface StdFee {
+  amount: Coin[];
+  gas: string;
+  /** The granter address that is used for paying with feegrants */
+  granter?: string;
+  /** The fee payer address. The payer must have signed the transaction. */
+  payer?: string;
+}
+
+/**
+ * The response after successfully broadcasting a transaction.
+ * Success or failure refer to the execution result.
+ */
+export interface DeliverTxResponse {
+  height: number;
+  /** The position of the transaction within the block. This is a 0-based index. */
+  txIndex: number;
+  /** Error code. The transaction suceeded if and only if code is 0. */
+  code: number;
+  transactionHash: string;
+  events: Event[];
+  /**
+   * A string-based log document.
+   *
+   * This currently seems to merge attributes of multiple events into one event per type
+   * (https://github.com/tendermint/tendermint/issues/9595). You might want to use the `events`
+   * field instead.
+   */
+  rawLog?: string;
+  /** @deprecated Use `msgResponses` instead. */
+  data?: MsgData[];
+  /**
+   * The message responses of the [TxMsgData](https://github.com/cosmos/cosmos-sdk/blob/v0.46.3/proto/cosmos/base/abci/v1beta1/abci.proto#L128-L140)
+   * as `Any`s.
+   * This field is an empty list for chains running Cosmos SDK < 0.46.
+   */
+  msgResponses: Array<{
+    typeUrl: string;
+    value: Uint8Array;
+  }>;
+  gasUsed: bigint;
+  gasWanted: bigint;
+}
+
+export interface MsgData {
+  msgType: string;
+  data: Uint8Array;
+}
+
+export interface Attribute {
+  key: string;
+  value: string;
+  index: boolean;
+}
+export interface Event {
+  type: string;
+  attributes: Attribute[];
+}
+
+export interface Message<T = any> {
+  typeUrl: string;
+  value: T;
+}
+
+export interface Encoder {
+  typeUrl: string;
+  fromPartial: (data: any) => any;
+  encode: (data: any) => Uint8Array;
+}
+
+export interface AminoConverter {
+  typeUrl: string;
+  aminoType: string;
+  fromAmino: (data: any) => any;
+  toAmino: (data: any) => any;
+}
+
+export type SigningClientResolver = string | HttpEndpoint | ISigningClient;
+export type RpcResolver = string | HttpEndpoint | Rpc ;

package/src/helpers.d.ts

@@ -0,0 +1,82 @@
+/**
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.10.11
+* DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+* and run the transpile command or npm scripts command that is used to regenerate this bundle.
+*/
+export declare function bytesFromBase64(b64: string): Uint8Array;
+export declare function base64FromBytes(arr: Uint8Array): string;
+export interface AminoHeight {
+    readonly revision_number?: string;
+    readonly revision_height?: string;
+}
+export declare function omitDefault<T extends string | number | bigint | boolean>(input: T): T | undefined;
+interface Duration {
+    /**
+     * Signed seconds of the span of time. Must be from -315,576,000,000
+     * to +315,576,000,000 inclusive. Note: these bounds are computed from:
+     * 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+     */
+    seconds: bigint;
+    /**
+     * Signed fractions of a second at nanosecond resolution of the span
+     * of time. Durations less than one second are represented with a 0
+     * `seconds` field and a positive or negative `nanos` field. For durations
+     * of one second or more, a non-zero value for the `nanos` field must be
+     * of the same sign as the `seconds` field. Must be from -999,999,999
+     * to +999,999,999 inclusive.
+     */
+    nanos: number;
+}
+export declare function toDuration(duration: string): Duration;
+export declare function fromDuration(duration: Duration): string;
+export declare function isSet(value: any): boolean;
+export declare function isObject(value: any): boolean;
+export interface PageRequest {
+    key: Uint8Array;
+    offset: bigint;
+    limit: bigint;
+    countTotal: boolean;
+    reverse: boolean;
+}
+export interface PageRequestParams {
+    'pagination.key'?: string;
+    'pagination.offset'?: string;
+    'pagination.limit'?: string;
+    'pagination.count_total'?: boolean;
+    'pagination.reverse'?: boolean;
+}
+export interface Params {
+    params: PageRequestParams;
+}
+export declare const setPaginationParams: (options: Params, pagination?: PageRequest) => Params;
+type Builtin = Date | Function | Uint8Array | string | number | bigint | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
+export interface Rpc {
+    request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
+}
+export declare function isRpc(rpc: unknown): rpc is Rpc;
+interface Timestamp {
+    /**
+     * Represents seconds of UTC time since Unix epoch
+     * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+     * 9999-12-31T23:59:59Z inclusive.
+     */
+    seconds: bigint;
+    /**
+     * Non-negative fractions of a second at nanosecond resolution. Negative
+     * second values with fractions must still have non-negative nanos values
+     * that count forward in time. Must be from 0 to 999,999,999
+     * inclusive.
+     */
+    nanos: number;
+}
+export declare function toTimestamp(date: Date): Timestamp;
+export declare function fromTimestamp(t: Timestamp): Date;
+export declare function fromJsonTimestamp(o: any): Timestamp;
+export {};

package/src/helpers.js

@@ -0,0 +1,143 @@
+"use strict";
+/**
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.10.11
+* DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+* and run the transpile command or npm scripts command that is used to regenerate this bundle.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setPaginationParams = void 0;
+exports.bytesFromBase64 = bytesFromBase64;
+exports.base64FromBytes = base64FromBytes;
+exports.omitDefault = omitDefault;
+exports.toDuration = toDuration;
+exports.fromDuration = fromDuration;
+exports.isSet = isSet;
+exports.isObject = isObject;
+exports.isRpc = isRpc;
+exports.toTimestamp = toTimestamp;
+exports.fromTimestamp = fromTimestamp;
+exports.fromJsonTimestamp = fromJsonTimestamp;
+var globalThis = (() => {
+    if (typeof globalThis !== 'undefined')
+        return globalThis;
+    if (typeof self !== 'undefined')
+        return self;
+    if (typeof window !== 'undefined')
+        return window;
+    if (typeof global !== 'undefined')
+        return global;
+    throw 'Unable to locate global object';
+})();
+const atob = globalThis.atob ||
+    ((b64) => globalThis.Buffer.from(b64, 'base64').toString('binary'));
+function bytesFromBase64(b64) {
+    const bin = atob(b64);
+    const arr = new Uint8Array(bin.length);
+    for (let i = 0; i < bin.length; ++i) {
+        arr[i] = bin.charCodeAt(i);
+    }
+    return arr;
+}
+const btoa = globalThis.btoa ||
+    ((bin) => globalThis.Buffer.from(bin, 'binary').toString('base64'));
+function base64FromBytes(arr) {
+    const bin = [];
+    arr.forEach((byte) => {
+        bin.push(String.fromCharCode(byte));
+    });
+    return btoa(bin.join(''));
+}
+function omitDefault(input) {
+    if (typeof input === 'string') {
+        return input === '' ? undefined : input;
+    }
+    if (typeof input === 'number') {
+        return input === 0 ? undefined : input;
+    }
+    if (typeof input === "boolean") {
+        return input === false ? undefined : input;
+    }
+    if (typeof input === 'bigint') {
+        return input === BigInt(0) ? undefined : input;
+    }
+    throw new Error(`Got unsupported type ${typeof input}`);
+}
+function toDuration(duration) {
+    return {
+        seconds: BigInt(Math.floor(parseInt(duration) / 1000000000)),
+        nanos: parseInt(duration) % 1000000000
+    };
+}
+function fromDuration(duration) {
+    return (parseInt(duration.seconds.toString()) * 1000000000 +
+        duration.nanos).toString();
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}
+function isObject(value) {
+    return typeof value === 'object' && value !== null;
+}
+const setPaginationParams = (options, pagination) => {
+    if (!pagination) {
+        return options;
+    }
+    if (typeof pagination?.countTotal !== 'undefined') {
+        options.params['pagination.count_total'] = pagination.countTotal;
+    }
+    if (typeof pagination?.key !== 'undefined') {
+        // String to Uint8Array
+        // let uint8arr = new Uint8Array(Buffer.from(data,'base64'));
+        // Uint8Array to String
+        options.params['pagination.key'] = Buffer.from(pagination.key).toString('base64');
+    }
+    if (typeof pagination?.limit !== 'undefined') {
+        options.params['pagination.limit'] = pagination.limit.toString();
+    }
+    if (typeof pagination?.offset !== 'undefined') {
+        options.params['pagination.offset'] = pagination.offset.toString();
+    }
+    if (typeof pagination?.reverse !== 'undefined') {
+        options.params['pagination.reverse'] = pagination.reverse;
+    }
+    return options;
+};
+exports.setPaginationParams = setPaginationParams;
+function isRpc(rpc) {
+    return rpc !== null && rpc !== undefined && typeof rpc.request === 'function';
+}
+function toTimestamp(date) {
+    const seconds = numberToLong(date.getTime() / 1_000);
+    const nanos = (date.getTime() % 1000) * 1000000;
+    return {
+        seconds,
+        nanos
+    };
+}
+function fromTimestamp(t) {
+    let millis = Number(t.seconds) * 1000;
+    millis += t.nanos / 1000000;
+    return new Date(millis);
+}
+const timestampFromJSON = (object) => {
+    return {
+        seconds: isSet(object.seconds)
+            ? BigInt(object.seconds.toString())
+            : BigInt(0),
+        nanos: isSet(object.nanos) ? Number(object.nanos) : 0
+    };
+};
+function fromJsonTimestamp(o) {
+    if (o instanceof Date) {
+        return toTimestamp(o);
+    }
+    else if (typeof o === 'string') {
+        return toTimestamp(new Date(o));
+    }
+    else {
+        return timestampFromJSON(o);
+    }
+}
+function numberToLong(number) {
+    return BigInt(Math.trunc(number));
+}

package/src/helpers.ts

@@ -0,0 +1,259 @@
+/**
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.3
+* DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+* and run the transpile command or npm scripts command that is used to regenerate this bundle.
+*/
+
+
+declare var self: any | undefined;
+declare var window: any | undefined;
+declare var global: any | undefined;
+var globalThis: any = (() => {
+  if (typeof globalThis !== 'undefined') return globalThis;
+  if (typeof self !== 'undefined') return self;
+  if (typeof window !== 'undefined') return window;
+  if (typeof global !== 'undefined') return global;
+  throw 'Unable to locate global object';
+})();
+
+const atob: (b64: string) => string =
+  globalThis.atob ||
+  ((b64) => globalThis.Buffer.from(b64, 'base64').toString('binary'));
+
+export function bytesFromBase64(b64: string): Uint8Array {
+  const bin = atob(b64);
+  const arr = new Uint8Array(bin.length);
+  for (let i = 0; i < bin.length; ++i) {
+    arr[i] = bin.charCodeAt(i);
+  }
+  return arr;
+}
+
+const btoa: (bin: string) => string =
+  globalThis.btoa ||
+  ((bin) => globalThis.Buffer.from(bin, 'binary').toString('base64'));
+
+export function base64FromBytes(arr: Uint8Array): string {
+  const bin: string[] = [];
+  arr.forEach((byte) => {
+    bin.push(String.fromCharCode(byte));
+  });
+  return btoa(bin.join(''));
+}
+
+export interface AminoHeight {
+  readonly revision_number?: string;
+  readonly revision_height?: string;
+}
+
+export function omitDefault<T extends string | number | bigint | boolean>(
+  input: T
+): T | undefined {
+  if (typeof input === 'string') {
+    return input === '' ? undefined : input;
+  }
+
+  if (typeof input === 'number') {
+    return input === 0 ? undefined : input;
+  }
+
+  if (typeof input === "boolean"){
+      return input === false ? undefined : input;
+  }
+
+  if (typeof input === 'bigint') {
+    return input === BigInt(0) ? undefined : input;
+  }
+
+  throw new Error(`Got unsupported type ${typeof input}`);
+}
+
+interface Duration {
+  /**
+   * Signed seconds of the span of time. Must be from -315,576,000,000
+   * to +315,576,000,000 inclusive. Note: these bounds are computed from:
+   * 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+   */
+  seconds: bigint;
+  /**
+   * Signed fractions of a second at nanosecond resolution of the span
+   * of time. Durations less than one second are represented with a 0
+   * `seconds` field and a positive or negative `nanos` field. For durations
+   * of one second or more, a non-zero value for the `nanos` field must be
+   * of the same sign as the `seconds` field. Must be from -999,999,999
+   * to +999,999,999 inclusive.
+   */
+
+  nanos: number;
+}
+
+export function toDuration(duration: string): Duration {
+  return {
+    seconds: BigInt(Math.floor(parseInt(duration) / 1000000000)),
+    nanos: parseInt(duration) % 1000000000
+  };
+}
+
+export function fromDuration(duration: Duration): string {
+  return (
+    parseInt(duration.seconds.toString()) * 1000000000 +
+    duration.nanos
+  ).toString();
+}
+
+export function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+export function isObject(value: any): boolean {
+  return typeof value === 'object' && value !== null;
+}
+
+export interface PageRequest {
+  key: Uint8Array;
+  offset: bigint;
+  limit: bigint;
+  countTotal: boolean;
+  reverse: boolean;
+}
+
+export interface PageRequestParams {
+  'pagination.key'?: string;
+  'pagination.offset'?: string;
+  'pagination.limit'?: string;
+  'pagination.count_total'?: boolean;
+  'pagination.reverse'?: boolean;
+}
+
+export interface Params {
+  params: PageRequestParams;
+}
+
+export const setPaginationParams = (
+  options: Params,
+  pagination?: PageRequest
+) => {
+  if (!pagination) {
+    return options;
+  }
+
+  if (typeof pagination?.countTotal !== 'undefined') {
+    options.params['pagination.count_total'] = pagination.countTotal;
+  }
+  if (typeof pagination?.key !== 'undefined') {
+    // String to Uint8Array
+    // let uint8arr = new Uint8Array(Buffer.from(data,'base64'));
+
+    // Uint8Array to String
+    options.params['pagination.key'] = Buffer.from(pagination.key).toString(
+      'base64'
+    );
+  }
+  if (typeof pagination?.limit !== 'undefined') {
+    options.params['pagination.limit'] = pagination.limit.toString();
+  }
+  if (typeof pagination?.offset !== 'undefined') {
+    options.params['pagination.offset'] = pagination.offset.toString();
+  }
+  if (typeof pagination?.reverse !== 'undefined') {
+    options.params['pagination.reverse'] = pagination.reverse;
+  }
+
+  return options;
+};
+
+type Builtin =
+  | Date
+  | Function
+  | Uint8Array
+  | string
+  | number
+  | bigint
+  | boolean
+  | undefined;
+
+export type DeepPartial<T> = T extends Builtin
+  ? T
+  : T extends Array<infer U>
+  ? Array<DeepPartial<U>>
+  : T extends ReadonlyArray<infer U>
+  ? ReadonlyArray<DeepPartial<U>>
+  : T extends {}
+  ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin
+  ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<
+        Exclude<keyof I, KeysOfUnion<P>>,
+        never
+      >;
+
+export interface Rpc {
+  request(
+    service: string,
+    method: string,
+    data: Uint8Array
+  ): Promise<Uint8Array>;
+}
+
+export function isRpc(rpc: unknown): rpc is Rpc {
+  return rpc !== null && rpc !== undefined && typeof (rpc as Rpc).request === 'function';
+}
+
+interface Timestamp {
+  /**
+   * Represents seconds of UTC time since Unix epoch
+   * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+   * 9999-12-31T23:59:59Z inclusive.
+   */
+  seconds: bigint;
+  /**
+   * Non-negative fractions of a second at nanosecond resolution. Negative
+   * second values with fractions must still have non-negative nanos values
+   * that count forward in time. Must be from 0 to 999,999,999
+   * inclusive.
+   */
+
+  nanos: number;
+}
+
+export function toTimestamp(date: Date): Timestamp {
+  const seconds = numberToLong(date.getTime() / 1_000);
+  const nanos = (date.getTime() % 1000) * 1000000;
+  return {
+    seconds,
+    nanos
+  };
+}
+
+export function fromTimestamp(t: Timestamp): Date {
+  let millis = Number(t.seconds) * 1000;
+  millis += t.nanos / 1000000;
+  return new Date(millis);
+}
+
+const timestampFromJSON = (object: any): Timestamp => {
+  return {
+    seconds: isSet(object.seconds)
+      ? BigInt(object.seconds.toString())
+      : BigInt(0),
+    nanos: isSet(object.nanos) ? Number(object.nanos) : 0
+  };
+};
+
+export function fromJsonTimestamp(o: any): Timestamp {
+  if (o instanceof Date) {
+    return toTimestamp(o);
+  } else if (typeof o === 'string') {
+    return toTimestamp(new Date(o));
+  } else {
+    return timestampFromJSON(o);
+  }
+}
+
+function numberToLong(number: number) {
+  return BigInt(Math.trunc(number));
+}
+