Allow encoder to lookup functions by full signature

Author: haltman-at

packages/encoder/lib/encoders.ts

@@ -892,10 +892,10 @@ export class ContractEncoder {
    * select an overload by other means.  For enums you may also specify the
    * enum type as documented in [[encodeTransaction]].
    *
-   * @param abisOrName The ABI entries for the overloads, or the name of the
-   *   function.  Note that if you are inputting ABI entries, they must be
-   *   for functions, not constructors.  The entries must be ones associated
-   *   with this contract.
+   * @param abisOrNameOrSig The ABI entries for the overloads, or the name or
+   *   full signature of the function.  Note that if you are inputting ABI
+   *   entries, they must be for functions, not constructors.  The entries must
+   *   be ones associated with this contract.
    * @param inputs An array of the inputs to the transaction.  May include a
    *   transaction options argument on the end if the `allowOptions` flag is
    *   set.
@@ -904,11 +904,11 @@ export class ContractEncoder {
    *   [[Resolution]] object.
    */
   public async resolveAndWrap(
-    abisOrName: Abi.FunctionEntry[] | string,
+    abisOrNameOrSig: Abi.FunctionEntry[] | string,
     inputs: unknown[],
     options: Types.ResolveOptions = {}
   ): Promise<Codec.Wrap.Resolution> {
-    const abis = this.getAbis(abisOrName);
+    const abis = this.getAbis(abisOrNameOrSig);
     const methods = abis.map(abi => this.getMethod(abi));
     //note we can't just write abis.map(this.getMethod)
     //because this would be undefined inside of it... I could
@@ -1251,22 +1251,22 @@ export class ContractEncoder {
    * In addition, input may also be given as a
    * [[Format.Values.OptionsValue|OptionsValue]].
    *
-   * @param abisOrName The ABI entries for the overloads, or the name of the
-   *   function.  Note that if you are inputting ABI entries, they must be
-   *   for functions, not constructors.  The entries must be ones associated
-   *   with this contract.
+   * @param abisOrNameOrSig The ABI entries for the overloads, or the name
+   *   or full signature of the function.  Note that if you are inputting ABI
+   *   entries, they must be for functions, not constructors.  The entries must
+   *   be ones associated with this contract.
    * @param input The value to be interpreted.  This can take a number of
    *   forms depending on the data type, as documented above.
    * @return An object with a `tx` field, holding the transaction options,
    *   including the encoded `data`, and an `abi` field, indicating which
    *   ABI entry was used for encoding.
    */
   public async encodeTransaction(
-    abisOrName: Abi.FunctionEntry[] | string,
+    abisOrNameOrSig: Abi.FunctionEntry[] | string,
     inputs: unknown[],
     options: Types.ResolveOptions = {}
   ): Promise<Types.TxAndAbi> {
-    const abis = this.getAbis(abisOrName);
+    const abis = this.getAbis(abisOrNameOrSig);
     const methods = abis.map(abi => this.getMethod(abi));
     //note we can't just write abis.map(this.getMethod)
     //because this would be undefined inside of it... I could
@@ -1307,21 +1307,23 @@ export class ContractEncoder {
   }
 
   private getAbis(
-    abisOrName: Abi.FunctionEntry[] | string
+    abisOrNameOrSig: Abi.FunctionEntry[] | string
   ): Abi.FunctionEntry[] {
     const abis: Abi.FunctionEntry[] =
-      typeof abisOrName === "string"
+      typeof abisOrNameOrSig === "string"
         ? this.abi.filter(
             (abi): abi is Abi.FunctionEntry =>
-              abi.type === "function" && abi.name === abisOrName
+              abi.type === "function" &&
+              (abi.name === abisOrNameOrSig ||
+                Codec.AbiData.Utils.abiSignature(abi) === abisOrNameOrSig)
           )
-        : abisOrName;
-    if (typeof abisOrName === "string" && abis.length === 0) {
+        : abisOrNameOrSig;
+    if (typeof abisOrNameOrSig === "string" && abis.length === 0) {
       //we don't throw this if the input was an empty list of ABIs
       //rather than a name... the user knew what they were doing if they
       //did that :P
       throw new NoFunctionByThatNameError(
-        abisOrName,
+        abisOrNameOrSig,
         this.contract.contractName
       );
     }
@@ -1513,12 +1515,12 @@ export class ContractInstanceEncoder {
    * transaction option, it will be recognized but ignored.
    */
   public async encodeTransaction(
-    abisOrName: Abi.FunctionEntry[] | string,
+    abisOrNameOrSig: Abi.FunctionEntry[] | string,
     inputs: unknown[],
     options: Types.ResolveOptions = {}
   ): Promise<Types.TxAndAbi> {
     const encoded = await this.contractEncoder.encodeTransaction(
-      abisOrName,
+      abisOrNameOrSig,
       inputs,
       options
     );

packages/encoder/lib/errors.ts

@@ -4,7 +4,9 @@
  */
 export class NoInternalInfoError extends Error {
   constructor() {
-    super("No compilations provided, but userDefinedTypes or allocations is missing");
+    super(
+      "No compilations provided, but userDefinedTypes or allocations is missing"
+    );
     this.name = "NoInternalInfoError";
   }
 }
@@ -25,14 +27,14 @@ export class NoCompilationsForSpawnerError extends Error {
  * @protected
  */
 export class NoFunctionByThatNameError extends Error {
-  public functionName: string;
+  public functionNameOrSig: string;
   public contractName: string | undefined;
-  constructor(functionName: string, contractName: string) {
+  constructor(functionNameOrSig: string, contractName: string) {
     const message = contractName
-      ? `Contract ${contractName} has no function named ${functionName}`
-      : `This contract has no function named ${functionName}`
+      ? `Contract ${contractName} has no function with name or signature ${functionNameOrSig}`
+      : `This contract has no function with name or signature ${functionNameOrSig}`;
     super(message);
-    this.functionName = functionName;
+    this.functionNameOrSig = functionNameOrSig;
     this.contractName = contractName;
     this.name = "NoFunctionByThatNameError";
   }
@@ -64,13 +66,8 @@ export class InvalidAddressError extends Error {
 export class UnlinkedContractError extends Error {
   public contractName: string | undefined;
   public bytecode: string | undefined;
-  constructor(
-    contractName: string | undefined,
-    bytecode: string | undefined,
-  ) {
-    const nameString = contractName !== undefined
-      ? contractName + " "
-      : "";
+  constructor(contractName: string | undefined, bytecode: string | undefined) {
+    const nameString = contractName !== undefined ? contractName + " " : "";
     super(`Contract ${nameString}has not had all its libraries linked`);
     this.contractName = contractName;
     this.bytecode = bytecode;
@@ -86,14 +83,11 @@ export class UnlinkedContractError extends Error {
 export class ContractNotDeployedError extends Error {
   public contractName: string | undefined;
   public networkId: number;
-  constructor(
-    contractName: string | undefined,
-    networkId: number
-  ) {
-    const nameString = contractName !== undefined
-      ? contractName + " "
-      : "";
-    super(`Contract ${nameString}has not been deployed to network ${networkId} with deployer; address must be given explicitly`);
+  constructor(contractName: string | undefined, networkId: number) {
+    const nameString = contractName !== undefined ? contractName + " " : "";
+    super(
+      `Contract ${nameString}has not been deployed to network ${networkId} with deployer; address must be given explicitly`
+    );
     this.contractName = contractName;
     this.name = "ContractNotDeployedError";
   }
@@ -106,12 +100,8 @@ export class ContractNotDeployedError extends Error {
  */
 export class NoBytecodeError extends Error {
   public contractName: string | undefined;
-  constructor(
-    contractName: string | undefined,
-  ) {
-    const nameString = contractName !== undefined
-      ? contractName + " "
-      : "";
+  constructor(contractName: string | undefined) {
+    const nameString = contractName !== undefined ? contractName + " " : "";
     super(`Contract ${nameString}has missing or empty constructor bytecode`);
     this.contractName = contractName;
     this.name = "NoBytecodeError";