Src folder formatting (#1222)

* chore: add setup/postinstall scripts for blame ignore and remove parser option in prettier config for ts fmting

* chore: add formatting to src folder via prettier config

* chore: add commit hash for mass prettier fmting

* chore: fmt

Author: Ryang-21

.git-blame-ignore-revs

@@ -0,0 +1 @@
+030c448da30ff159419dcc92e2921ef578cca426

.gitignore

@@ -12,7 +12,7 @@ js-stellar-base/
 
 test/unit/out/
 .vscode/launch.json
-
+.vscode
 target
 .soroban
 

config/prettier.config.js

@@ -5,9 +5,8 @@ module.exports = {
   printWidth: 80,
   proseWrap: 'always',
   semi: true,
-  singleQuote: true,
+  singleQuote: false,
   tabWidth: 2,
-  parser: 'babel',
-  trailingComma: 'none',
+  trailingComma: 'all',
   useTabs: false
 };

package.json

@@ -78,6 +78,8 @@
     }
   },
   "scripts": {
+    "setup": "git config blame.ignoreRevsFile .git-blame-ignore-revs",
+    "postinstall": "yarn setup || true",
     "build": "cross-env NODE_ENV=development yarn _build",
     "build:prod": "cross-env NODE_ENV=production yarn _build",
     "build:node": "yarn _babel && yarn build:ts",
@@ -109,7 +111,7 @@
     "_build": "yarn build:node:all && yarn build:test && yarn build:browser:all",
     "_babel": "babel --extensions '.ts' --out-dir ${OUTPUT_DIR:-lib} src/",
     "_nyc": "node node_modules/.bin/nyc --nycrc-path config/.nycrc",
-    "_prettier": "prettier --ignore-path config/.prettierignore --write './test/**/*.js'"
+    "_prettier": "prettier --config config/prettier.config.js --ignore-path config/.prettierignore --write './src/**/*.ts' './test/**/*.js'"
   },
   "husky": {
     "hooks": {

src/config.ts

@@ -19,7 +19,7 @@ const defaultConfig: Configuration = {
   timeout: 0,
 };
 
-let config = { ...defaultConfig};
+let config = { ...defaultConfig };
 
 /**
  * Global config class.
@@ -80,7 +80,7 @@ class Config {
    * @static
    */
   public static setDefault(): void {
-    config = { ...defaultConfig};
+    config = { ...defaultConfig };
   }
 }
 

src/contract/basic_node_signer.ts

@@ -23,7 +23,10 @@ export const basicNodeSigner = (
 } => ({
   // eslint-disable-next-line require-await
   signTransaction: async (xdr, opts) => {
-    const t = TransactionBuilder.fromXDR(xdr, opts?.networkPassphrase || networkPassphrase);
+    const t = TransactionBuilder.fromXDR(
+      xdr,
+      opts?.networkPassphrase || networkPassphrase,
+    );
     t.sign(keypair);
     return {
       signedTxXdr: t.toXDR(),
@@ -32,10 +35,12 @@ export const basicNodeSigner = (
   },
   // eslint-disable-next-line require-await
   signAuthEntry: async (authEntry) => {
-    const signedAuthEntry = keypair.sign(hash(Buffer.from(authEntry, "base64"))).toString("base64");
+    const signedAuthEntry = keypair
+      .sign(hash(Buffer.from(authEntry, "base64")))
+      .toString("base64");
     return {
       signedAuthEntry,
       signerAddress: keypair.publicKey(),
     };
   },
-});
+});

src/contract/client.ts

@@ -1,10 +1,6 @@
-import {
-  Operation,
-  xdr,
-  Address,
-} from "@stellar/stellar-base";
+import { Operation, xdr, Address } from "@stellar/stellar-base";
 import { Spec } from "./spec";
-import { Server } from '../rpc';
+import { Server } from "../rpc";
 import { AssembledTransaction } from "./assembled_transaction";
 import type { ClientOptions, MethodOptions } from "./types";
 
@@ -13,7 +9,7 @@ const CONSTRUCTOR_FUNC = "__constructor";
 async function specFromWasmHash(
   wasmHash: Buffer | string,
   options: Server.Options & { rpcUrl: string },
-  format: "hex" | "base64" = "hex"
+  format: "hex" | "base64" = "hex",
 ): Promise<Spec> {
   if (!options || !options.rpcUrl) {
     throw new TypeError("options must contain rpcUrl");
@@ -54,20 +50,29 @@ export class Client {
         format?: "hex" | "base64";
         /** The address to use to deploy the custom contract */
         address?: string;
-      }
+      },
   ): Promise<AssembledTransaction<T>> {
-    const { wasmHash, salt, format, fee, timeoutInSeconds, simulate, ...clientOptions } = options;
+    const {
+      wasmHash,
+      salt,
+      format,
+      fee,
+      timeoutInSeconds,
+      simulate,
+      ...clientOptions
+    } = options;
     const spec = await specFromWasmHash(wasmHash, clientOptions, format);
 
     const operation = Operation.createCustomContract({
       address: new Address(options.address || options.publicKey!),
-      wasmHash: typeof wasmHash === "string"
-        ? Buffer.from(wasmHash, format ?? "hex")
-        : (wasmHash as Buffer),
+      wasmHash:
+        typeof wasmHash === "string"
+          ? Buffer.from(wasmHash, format ?? "hex")
+          : (wasmHash as Buffer),
       salt,
       constructorArgs: args
         ? spec.funcArgsToScVals(CONSTRUCTOR_FUNC, args)
-        : []
+        : [],
     });
 
     return AssembledTransaction.buildWithOp(operation, {
@@ -78,13 +83,16 @@ export class Client {
       contractId: "ignored",
       method: CONSTRUCTOR_FUNC,
       parseResultXdr: (result) =>
-        new Client(spec, { ...clientOptions, contractId: Address.fromScVal(result).toString() })
+        new Client(spec, {
+          ...clientOptions,
+          contractId: Address.fromScVal(result).toString(),
+        }),
     }) as unknown as AssembledTransaction<T>;
   }
 
   constructor(
     public readonly spec: Spec,
-    public readonly options: ClientOptions
+    public readonly options: ClientOptions,
   ) {
     this.spec.funcs().forEach((xdrFn) => {
       const method = xdrFn.name().toString();
@@ -93,7 +101,7 @@ export class Client {
       }
       const assembleTransaction = (
         args?: Record<string, any>,
-        methodOptions?: MethodOptions
+        methodOptions?: MethodOptions,
       ) =>
         AssembledTransaction.build({
           method,
@@ -129,12 +137,13 @@ export class Client {
    * @returns {Promise<module:contract.Client>} A Promise that resolves to a Client instance.
    * @throws {TypeError} If the provided options object does not contain an rpcUrl.
    */
-  static async fromWasmHash(wasmHash: Buffer | string,
+  static async fromWasmHash(
+    wasmHash: Buffer | string,
     options: ClientOptions,
-    format: "hex" | "base64" = "hex"
+    format: "hex" | "base64" = "hex",
   ): Promise<Client> {
     if (!options || !options.rpcUrl) {
-      throw new TypeError('options must contain rpcUrl');
+      throw new TypeError("options must contain rpcUrl");
     }
     const { rpcUrl, allowHttp } = options;
     const serverOpts: Server.Options = { allowHttp };
@@ -165,7 +174,7 @@ export class Client {
    */
   static async from(options: ClientOptions): Promise<Client> {
     if (!options || !options.rpcUrl || !options.contractId) {
-      throw new TypeError('options must contain rpcUrl and contractId');
+      throw new TypeError("options must contain rpcUrl and contractId");
     }
     const { rpcUrl, contractId, allowHttp } = options;
     const serverOpts: Server.Options = { allowHttp };
@@ -187,5 +196,6 @@ export class Client {
     );
   };
 
-  txFromXDR = <T>(xdrBase64: string): AssembledTransaction<T> => AssembledTransaction.fromXDR(this.options, xdrBase64, this.spec);
+  txFromXDR = <T>(xdrBase64: string): AssembledTransaction<T> =>
+    AssembledTransaction.fromXDR(this.options, xdrBase64, this.spec);
 }

src/contract/index.ts

@@ -4,4 +4,4 @@ export * from "./client";
 export * from "./rust_result";
 export * from "./sent_transaction";
 export * from "./spec";
-export * from "./types";
+export * from "./types";

src/contract/spec.ts

@@ -6,9 +6,9 @@ import {
   Address,
   Contract,
   scValToBigInt,
-} from "@stellar/stellar-base"
-import { Ok } from "./rust_result"
-import { specFromWasm, processSpecEntryStream } from './utils';
+} from "@stellar/stellar-base";
+import { Ok } from "./rust_result";
+import { specFromWasm, processSpecEntryStream } from "./utils";
 
 export interface Union<T> {
   tag: string;
@@ -434,7 +434,6 @@ function unionToJsonSchema(udt: xdr.ScSpecUdtUnionV0): any {
 }
 /* eslint-enable default-case */
 
-
 /**
  * Provides a ContractSpec class which can contains the XDR types defined by the contract.
  * This allows the class to be used to convert between native and raw `xdr.ScVal`s.
@@ -623,7 +622,6 @@ export class Spec {
     return entry;
   }
 
-
   /**
    * Converts a native JS value to an ScVal based on the given type.
    *
@@ -765,7 +763,8 @@ export class Spec {
 
         if ((val.constructor?.name ?? "") !== "Object") {
           throw new TypeError(
-            `cannot interpret ${val.constructor?.name
+            `cannot interpret ${
+              val.constructor?.name
             } value as ScVal (${JSON.stringify(val)})`,
           );
         }
@@ -968,7 +967,8 @@ export class Spec {
           return (scv.vec() ?? []).map((elm) =>
             this.scValToNative(elm, vec.elementType()),
           ) as T;
-        } if (value === xdr.ScSpecType.scSpecTypeTuple().value) {
+        }
+        if (value === xdr.ScSpecType.scSpecTypeTuple().value) {
           const tuple = typeDef.tuple();
           const valTypes = tuple.valueTypes();
           return (scv.vec() ?? []).map((elm, i) =>
@@ -1016,7 +1016,8 @@ export class Spec {
           value !== xdr.ScSpecType.scSpecTypeSymbol().value
         ) {
           throw new Error(
-            `ScSpecType ${t.name
+            `ScSpecType ${
+              t.name
             } was not string or symbol, but ${JSON.stringify(scv, null, 2)} is`,
           );
         }
@@ -1146,7 +1147,7 @@ export class Spec {
   jsonSchema(funcName?: string): JSONSchema7 {
     const definitions: { [key: string]: JSONSchema7Definition } = {};
     /* eslint-disable default-case */
-    this.entries.forEach(entry => {
+    this.entries.forEach((entry) => {
       switch (entry.switch().value) {
         case xdr.ScSpecEntryKind.scSpecEntryUdtEnumV0().value: {
           const udt = entry.udtEnumV0();

src/contract/types.ts

@@ -1,6 +1,12 @@
 /* disable PascalCase naming convention, to avoid breaking change */
 /* eslint-disable @typescript-eslint/naming-convention */
-import { Memo, MemoType, Operation, Transaction, xdr } from "@stellar/stellar-base";
+import {
+  Memo,
+  MemoType,
+  Operation,
+  Transaction,
+  xdr,
+} from "@stellar/stellar-base";
 import type { Client } from "./client";
 
 export type XDR_BASE64 = string;
@@ -63,9 +69,9 @@ export interface WalletError {
 
 /**
  * A function to request a wallet to sign a built transaction
- * 
+ *
  * This function takes an XDR provided by the requester and applies a signature to it.
- * It returns a base64-encoded string XDR-encoded Transaction Envelope with Decorated Signatures 
+ * It returns a base64-encoded string XDR-encoded Transaction Envelope with Decorated Signatures
  * and the signer address back to the requester.
  *
  * @param xdr - The XDR string representing the transaction to be signed.
@@ -77,20 +83,25 @@ export interface WalletError {
  *
  * @returns A promise resolving to an object with the signed transaction XDR and optional signer address and error.
  */
-export type SignTransaction = (xdr: string, opts?: {
-  networkPassphrase?: string;
-  address?: string;
-  submit?: boolean;
-  submitUrl?: string;
-}) => Promise<{
-  signedTxXdr: string;
-  signerAddress?: string;
-} & { error?: WalletError }>;
+export type SignTransaction = (
+  xdr: string,
+  opts?: {
+    networkPassphrase?: string;
+    address?: string;
+    submit?: boolean;
+    submitUrl?: string;
+  },
+) => Promise<
+  {
+    signedTxXdr: string;
+    signerAddress?: string;
+  } & { error?: WalletError }
+>;
 
 /**
  * A function to request a wallet to sign an authorization entry preimage.
  *
- * Similar to signing a transaction, this function takes an authorization entry preimage provided by the 
+ * Similar to signing a transaction, this function takes an authorization entry preimage provided by the
  * requester and applies a signature to it.
  * It returns a signed hash of the same authorization entry and the signer address back to the requester.
  *
@@ -101,13 +112,18 @@ export type SignTransaction = (xdr: string, opts?: {
  *
  * @returns A promise resolving to an object with the signed authorization entry and optional signer address and error.
  */
-export type SignAuthEntry = (authEntry: string, opts?: {
-  networkPassphrase?: string;
-  address?: string;
-}) => Promise<{
-  signedAuthEntry: string;
-  signerAddress?: string;
-} & { error?: WalletError }>; 
+export type SignAuthEntry = (
+  authEntry: string,
+  opts?: {
+    networkPassphrase?: string;
+    address?: string;
+  },
+) => Promise<
+  {
+    signedAuthEntry: string;
+    signerAddress?: string;
+  } & { error?: WalletError }
+>;
 
 /**
  * Options for a smart contract client.
@@ -255,4 +271,5 @@ export const DEFAULT_TIMEOUT = 5 * 60;
  * @default GAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAWHF
  * @memberof module:contract
  */
-export const NULL_ACCOUNT = "GAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAWHF";
+export const NULL_ACCOUNT =
+  "GAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAWHF";