@d8x/perpetuals-sdk 2.0.8-alpha → 2.0.10-alpha

package/src/referralCodeSigner.ts

@@ -1,5 +1,22 @@
-import { AbiCoder, JsonRpcProvider, keccak256, Provider, Signer, verifyMessage, Wallet } from "ethers";
-import type { APIReferPayload, APIReferralCodePayload, APIReferralCodeSelectionPayload } from "./nodeSDKTypes";
+import {
+  AbiCoder,
+  JsonRpcProvider,
+  keccak256,
+  Provider,
+  Signer,
+  TypedDataDomain,
+  TypedDataField,
+  verifyMessage,
+  verifyTypedData,
+  Wallet,
+} from "ethers";
+import {
+  APIReferPayload,
+  APIReferralCodePayload,
+  APIReferralCodeSelectionPayload,
+  referralDomain,
+  referralTypes,
+} from "./nodeSDKTypes";
 
 /**
  * This is a 'standalone' class that deals with signatures
@@ -14,11 +31,26 @@ import type { APIReferPayload, APIReferralCodePayload, APIReferralCodeSelectionP
 export default class ReferralCodeSigner {
   private provider: Provider | undefined;
   private rpcURL: string;
-  private signingFun: (x: string | Uint8Array) => Promise<string>;
+  private signingFun: ((x: string | Uint8Array) => Promise<string>) | undefined;
+  private signingTypedDataFun:
+    | ((
+        domain: TypedDataDomain,
+        types: Record<string, TypedDataField[]>,
+        value: Record<string, any>
+      ) => Promise<string>)
+    | undefined;
   private address: string;
 
   constructor(
-    signer: Signer | string | ((x: string | Uint8Array) => Promise<string>),
+    signer:
+      | Signer
+      | string
+      | ((x: string | Uint8Array) => Promise<string>)
+      | ((
+          domain: TypedDataDomain,
+          types: Record<string, TypedDataField[]>,
+          value: Record<string, any>
+        ) => Promise<string>),
     address: string,
     _rpcURL: string
   ) {
@@ -27,38 +59,88 @@ export default class ReferralCodeSigner {
     if (typeof signer == "string") {
       const wallet = this.createSignerInstance(signer);
       this.signingFun = (x: string | Uint8Array) => wallet.signMessage(x);
+      this.signingTypedDataFun = (
+        domain: TypedDataDomain,
+        types: Record<string, TypedDataField[]>,
+        value: Record<string, any>
+      ) => wallet.signTypedData(domain, types, value);
     } else if ("signMessage" in signer) {
       this.signingFun = (x: string | Uint8Array) => signer.signMessage(x);
+      this.signingTypedDataFun = (
+        domain: TypedDataDomain,
+        types: Record<string, TypedDataField[]>,
+        value: Record<string, any>
+      ) => signer.signTypedData(domain, types, value);
+    } else if (signer.length === 1) {
+      this.signingFun = signer as (x: string | Uint8Array) => Promise<string>;
     } else {
-      this.signingFun = signer;
+      this.signingTypedDataFun = signer as (
+        domain: TypedDataDomain,
+        types: Record<string, TypedDataField[]>,
+        value: Record<string, any>
+      ) => Promise<string>;
     }
   }
 
   public createSignerInstance(_privateKey: string): Signer {
     this.provider = new JsonRpcProvider(this.rpcURL);
     const wallet = new Wallet(_privateKey);
-    return wallet.connect(this.provider);
+    wallet.connect(this.provider);
+    this.signingFun = (x: string | Uint8Array) => wallet.signMessage(x);
+    this.signingTypedDataFun = (
+      domain: TypedDataDomain,
+      types: Record<string, TypedDataField[]>,
+      value: Record<string, any>
+    ) => wallet.signTypedData(domain, types, value);
+    return wallet;
   }
 
   public async getSignatureForNewReferral(rp: APIReferPayload): Promise<string> {
-    if (this.signingFun == undefined) {
+    if (this.signingTypedDataFun != undefined) {
+      return await this.signingTypedDataFun(
+        referralDomain,
+        {
+          NewReferral: referralTypes.NewReferral,
+        },
+        ReferralCodeSigner.newReferralPayloadToTypedData(rp)
+      );
+    } else if (this.signingFun != undefined) {
+      return await ReferralCodeSigner.getSignatureForNewReferral(rp, this.signingFun);
+    } else {
       throw Error("no signer defined, call createSignerInstance()");
     }
-    return await ReferralCodeSigner.getSignatureForNewReferral(rp, this.signingFun);
   }
 
   public async getSignatureForNewCode(rc: APIReferralCodePayload): Promise<string> {
-    if (this.signingFun == undefined) {
+    if (this.signingTypedDataFun != undefined) {
+      return await this.signingTypedDataFun(
+        referralDomain,
+        {
+          NewCode: referralTypes.NewCode,
+        },
+        ReferralCodeSigner.referralCodeNewCodePayloadToTypedData(rc)
+      );
+    } else if (this.signingFun != undefined) {
+      return await ReferralCodeSigner.getSignatureForNewCode(rc, this.signingFun);
+    } else {
       throw Error("no signer defined, call createSignerInstance()");
     }
-    return await ReferralCodeSigner.getSignatureForNewCode(rc, this.signingFun);
   }
 
   public async getSignatureForCodeSelection(rc: APIReferralCodeSelectionPayload): Promise<string> {
-    if (this.signingFun == undefined) {
+    if (this.signingTypedDataFun != undefined) {
+      return await this.signingTypedDataFun(
+        referralDomain,
+        {
+          CodeSelection: referralTypes.CodeSelection,
+        },
+        ReferralCodeSigner.codeSelectionPayloadToTypedData(rc)
+      );
+    } else if (this.signingFun != undefined) {
+      return await ReferralCodeSigner.getSignatureForCodeSelection(rc, this.signingFun);
+    } else {
       throw Error("no signer defined, call createSignerInstance()");
     }
-    return await ReferralCodeSigner.getSignatureForCodeSelection(rc, this.signingFun);
   }
 
   public async getAddress(): Promise<string> {
@@ -127,6 +209,20 @@ export default class ReferralCodeSigner {
     return digest;
   }
 
+  /**
+   * Convert payload to data struct to sign
+   * @param rc payload
+   * @returns typed data
+   */
+  public static newReferralPayloadToTypedData(rc: APIReferPayload) {
+    return {
+      ParentAddr: rc.parentAddr as `0x${string}`,
+      ReferToAddr: rc.referToAddr as `0x${string}`,
+      PassOnPercTDF: Math.round(rc.passOnPercTDF),
+      CreatedOn: BigInt(Math.round(rc.createdOn)),
+    };
+  }
+
   /**
    * Create digest for referralCodePayload that is to be signed
    * @param rc payload
@@ -144,6 +240,20 @@ export default class ReferralCodeSigner {
     return digest;
   }
 
+  /**
+   * Convert payload to data struct to sign
+   * @param rc payload
+   * @returns typed data
+   */
+  public static referralCodeNewCodePayloadToTypedData(rc: APIReferralCodePayload) {
+    return {
+      Code: rc.code,
+      ReferrerAddr: rc.referrerAddr as `0x${string}`,
+      PassOnPercTDF: Math.round(rc.passOnPercTDF),
+      CreatedOn: BigInt(Math.round(rc.createdOn)),
+    };
+  }
+
   /**
    * Create digest for APIReferralCodeSelectionPayload that is to be signed
    * @param rc payload
@@ -157,6 +267,19 @@ export default class ReferralCodeSigner {
     return digest;
   }
 
+  /**
+   * Convert payload to data struct to sign
+   * @param rc payload
+   * @returns typed data
+   */
+  public static codeSelectionPayloadToTypedData(rc: APIReferralCodeSelectionPayload) {
+    return {
+      Code: rc.code,
+      TraderAddr: rc.traderAddr as `0x${string}`,
+      CreatedOn: BigInt(Math.round(rc.createdOn)),
+    };
+  }
+
   /**
    * Check whether signature is correct on payload:
    * - the referrer always signs
@@ -164,31 +287,60 @@ export default class ReferralCodeSigner {
    * @param rc referralcode payload with a signature
    * @returns true if correctly signed, false otherwise
    */
-  public static async checkNewCodeSignature(rc: APIReferralCodePayload): Promise<boolean> {
+  public static checkNewCodeSignature(rc: APIReferralCodePayload) {
     if (rc.signature == undefined || rc.signature == "") {
       return false;
     }
     try {
-      let digest = ReferralCodeSigner._referralCodeNewCodePayloadToMessage(rc);
-      let digestBuffer = Buffer.from(digest.substring(2, digest.length), "hex");
-      const signerAddress = await verifyMessage(digestBuffer, rc.signature);
+      // typed-data (^2.x.x)
+      const typedData = ReferralCodeSigner.referralCodeNewCodePayloadToTypedData(rc);
+      const signerAddress = verifyTypedData(
+        referralDomain,
+        { NewCode: referralTypes.NewCode },
+        typedData,
+        rc.signature
+      );
       return rc.referrerAddr.toLowerCase() == signerAddress.toLowerCase();
     } catch (err) {
-      return false;
+      console.log(err);
+      // digest (1.x.x)
+      try {
+        let digest = ReferralCodeSigner._referralCodeNewCodePayloadToMessage(rc);
+        let digestBuffer = Buffer.from(digest.substring(2, digest.length), "hex");
+        const signerAddress = verifyMessage(digestBuffer, rc.signature);
+        return rc.referrerAddr.toLowerCase() == signerAddress.toLowerCase();
+      } catch (err) {
+        console.log(err);
+        return false;
+      }
     }
   }
 
-  public static async checkCodeSelectionSignature(rc: APIReferralCodeSelectionPayload): Promise<boolean> {
+  public static checkCodeSelectionSignature(rc: APIReferralCodeSelectionPayload) {
     if (rc.signature == undefined || rc.signature == "") {
       return false;
     }
     try {
-      let digest = ReferralCodeSigner._codeSelectionPayloadToMessage(rc);
-      let digestBuffer = Buffer.from(digest.substring(2, digest.length), "hex");
-      const signerAddress = await verifyMessage(digestBuffer, rc.signature);
+      // typed-data (^2.x.x)
+      const typedData = ReferralCodeSigner.codeSelectionPayloadToTypedData(rc);
+      const signerAddress = verifyTypedData(
+        referralDomain,
+        { CodeSelection: referralTypes.CodeSelection },
+        typedData,
+        rc.signature
+      );
       return rc.traderAddr.toLowerCase() == signerAddress.toLowerCase();
     } catch (err) {
-      return false;
+      console.log(err);
+      // digest (1.x.x)
+      try {
+        let digest = ReferralCodeSigner._codeSelectionPayloadToMessage(rc);
+        let digestBuffer = Buffer.from(digest.substring(2, digest.length), "hex");
+        const signerAddress = verifyMessage(digestBuffer, rc.signature);
+        return rc.traderAddr.toLowerCase() == signerAddress.toLowerCase();
+      } catch (err) {
+        return false;
+      }
     }
   }
 }

package/src/version.ts

@@ -1 +1 @@
-export const D8X_SDK_VERSION = "2.0.8-alpha";
+export const D8X_SDK_VERSION = "2.0.10-alpha";

package/dist/esm/contracts/factories/PerpStorage__factory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PerpStorage__factory.js","sourceRoot":"","sources":["../../../../src/contracts/factories/PerpStorage__factory.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,oBAAoB;AACpB,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAU,KAAK,EAAE,MAAM,QAAQ,CAAC;AAEjD,0EAA0E;AAE1E,MAAM,IAAI,GAAG;IACX;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,OAAO;KACd;IACD;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,OAAO;KACd;IACD;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,OAAO;KACd;IACD;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,OAAO;KACd;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,OAAO;aACd;YACD;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,sBAAsB;gBAC5B,IAAI,EAAE,QAAQ;aACf;YACD;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,sBAAsB;QAC5B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,uBAAuB;QAC7B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,OAAO;aACd;SACF;QACD,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,MAAM;aACb;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,MAAM;aACb;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,OAAO;aACd;YACD;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,sBAAsB;gBAC5B,IAAI,EAAE,QAAQ;aACf;YACD;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,sBAAsB;QAC5B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;CACO,CAAC;AAEX,MAAM,OAAO,oBAAoB;IAE/B,MAAM,CAAC,eAAe;QACpB,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,CAAyB,CAAC;IAC3D,CAAC;IACD,MAAM,CAAC,OAAO,CAAC,OAAe,EAAE,gBAAmC;QACjE,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAgB,CAAC;IACtE,CAAC;;AANe,wBAAG,GAAG,IAAI,CAAC"}