feat: add endo/base64 support

cosmology-tech · Sep 14, 2024 · a920d39 · a920d39
1 parent d7f2ced
commit a920d39
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 36 deletions.
diff --git a/packages/telescope/__tests__/misc.test.ts b/packages/telescope/__tests__/misc.test.ts
@@ -464,7 +464,7 @@ describe('misc', () => {
         prototypes: {
           typingsFormat: {
             customTypes: {
-              base64Lib: true,
+              base64Lib: '@endo/base64',
             },
           },
         },

diff --git a/packages/telescope/src/generators/create-helpers.ts b/packages/telescope/src/generators/create-helpers.ts
@@ -20,7 +20,6 @@ import {
   getTypesHelper,
   jsonSafe,
   decimal,
-  base64,
 } from '../helpers';
 
 const version = process.env.NODE_ENV === 'test' ? 'latest' : pkg.version;
@@ -100,11 +99,6 @@ export const plugin = (builder: TelescopeBuilder) => {
     write(builder, 'decimals.ts', decimal);
   }
 
-  if (builder.options.prototypes.typingsFormat.customTypes.base64Lib) {
-    builder.files.push('base64.ts');
-    write(builder, 'base64.ts', base64);
-  }
-
   if (
     !builder.options.prototypes.typingsFormat.toJsonUnknown &&
     builder.options.prototypes.methods.toJSON

diff --git a/packages/telescope/src/generators/customize-utils.ts b/packages/telescope/src/generators/customize-utils.ts
@@ -11,9 +11,22 @@ export const plugin = (builder: TelescopeBuilder) => {
     UTILS.Decimal = '@cosmjs/math';
   }
 
-  if (builder.options.prototypes.typingsFormat.customTypes.base64Lib === true) {
-    UTILS.base64FromBytes = '@endo/base64';
-    UTILS.bytesFromBase64 = '@endo/base64';
+  if (
+    builder.options.prototypes.typingsFormat.customTypes.base64Lib ===
+    '@endo/base64'
+  ) {
+    UTILS.base64FromBytes = {
+      type: 'import',
+      path: '@endo/base64',
+      name: 'decodeBase64',
+      importAs: 'base64FromBytes',
+    };
+    UTILS.bytesFromBase64 = {
+      type: 'import',
+      path: '@endo/base64',
+      name: 'encodeBase64',
+      importAs: 'bytesFromBase64',
+    };
   } else {
     UTILS.base64FromBytes = '__helpers__';
     UTILS.bytesFromBase64 = '__helpers__';

diff --git a/packages/telescope/src/helpers/base64.ts b/packages/telescope/src/helpers/base64.ts
diff --git a/packages/telescope/src/helpers/index.ts b/packages/telescope/src/helpers/index.ts
@@ -14,4 +14,3 @@ export * from './types-helper';
 export * from './registry-helper';
 export * from './json-safe';
 export * from './decimals';
-export * from './base64';
diff --git a/packages/telescope/src/types.ts b/packages/telescope/src/types.ts
@@ -1,36 +1,37 @@
 import { ImportDeclaration } from '@babel/types';
 import { ProtoServiceMethod, TelescopeOptions } from '@cosmology/types';
 export interface Bundle {
-    bundleVariables: {};
-    bundleFile: string;
-    importPaths: ImportDeclaration[];
-    base: string;
+  bundleVariables: {};
+  bundleFile: string;
+  importPaths: ImportDeclaration[];
+  base: string;
 }
 export interface BundlerFile {
-    proto?: string;
-    package?: string;
-    localname: string;
-    filename: string;
-    isMsg?: boolean;
-    instantExportedMethods?: ProtoServiceMethod[]
+  proto?: string;
+  package?: string;
+  localname: string;
+  filename: string;
+  isMsg?: boolean;
+  instantExportedMethods?: ProtoServiceMethod[];
 }
 
 export interface ImportObj {
-    type: 'import' | 'default' | 'namespace' | string;
-    name: string;
-    path: string;
-    importAs?: string;
+  type: 'import' | 'default' | 'namespace' | string;
+  name: string;
+  path: string;
+  importAs?: string;
 }
+export type UtilValue = ImportObj | string;
 
 export interface DerivedImportObj extends ImportObj {
-    orig: string;
+  orig: string;
 }
 export interface ImportHash {
-    [key: string]: string[];
+  [key: string]: string[];
 }
 
 export interface TelescopeInput {
-    protoDirs: string[];
-    outPath: string;
-    options: TelescopeOptions;
+  protoDirs: string[];
+  outPath: string;
+  options: TelescopeOptions;
 }
diff --git a/packages/telescope/src/utils/index.ts b/packages/telescope/src/utils/index.ts
@@ -1,6 +1,6 @@
 import { ProtoRoot, ProtoRef } from '@cosmology/types';
 import { relative, dirname, extname } from 'path';
-import { ImportObj } from '../types';
+import { ImportObj, UtilValue } from '../types';
 import { restoreExtension, toPosixPath } from '@cosmology/utils';
 
 export const getRoot = (ref: ProtoRef): ProtoRoot => {
@@ -12,7 +12,7 @@ export const getRoot = (ref: ProtoRef): ProtoRoot => {
 // Long: { type: 'default', path: 'long', name: 'Long ' },
 // namespaced:
 // _m0: { type: 'namespace', path: 'protobufjs/minimal', name: '_m0' },
-export const UTILS = {
+export const UTILS: { [key: string]: UtilValue } = {
   _m0: { type: 'namespace', path: 'protobufjs/minimal', name: '_m0' },
   AminoHeight: '__helpers__',
   AminoMsg: '@cosmjs/amino',

diff --git a/packages/types/src/telescope.ts b/packages/types/src/telescope.ts
@@ -88,7 +88,7 @@ interface TelescopeOpts {
       customTypes?: {
         useCosmosSDKDec?: boolean;
         usePatchedDecimal?: boolean;
-        base64Lib?: boolean;
+        base64Lib?: '@endo/base64';
       };
 
       num64?: 'long' | 'bigint';