index.d.ts

import { Interface } from 'mocha';

declare module 'hychain-crypto-js' {
  import { InterfaceAbi, Wallet } from 'ethers';

  type Nullable = null | undefined;

  export type Ciphertext = string;
  export type PBKDF2Key = string;
  export type CallRequestData = string;
  export type CallRequest = [
    string, // target
    string, // value
    string, // nonce
    string, // data
  ];
  export type CreateRequest = [
    string, // salt
    string, // nonce
    string, // bytecode
    string, // initCode
  ];
  export type SessionRequest = {
    nativeAllowance?: string;
    contractFunctionSelectors?: {
      address: string,
      functionSelectors: string[]
    }[];
    erc20Allowances?: {
      address: string,
      allowance: string,
    }[];
    erc721Allowances?: {
      address: string,
      approveAll: boolean,
      tokenIds?: string[],
    }[];
    erc1155Allowances?: {
      address: string,
      approveAll: boolean,
      tokenIds?: string[],
      allowances?: string[],
    }[];
  };
  export type SessionRequestTuple = [
    string, // nativeAllowance
    [ string, string[] ][], // contractFunctionSelectors ( address, functionSelectors: bytes4[] )
    [ string, string ][], // erc20Allowances ( address, allowance: uint256 )
    [ string, boolean, string[] ][], // erc721Allowances ( address, approveAll: boolean, tokenIds: uint256[])
    [ string, boolean, string[], string[] ][], // erc1155Allowances ( address, approveAll: boolean, tokenIds: uint256[], allowances: uint256[] )
  ];
  export type WalletCredentials = {
    address: string;
    privateKey: string;
    mnemonic: string;
  }

  export const CHAIN_IDS: {
      HYCHAIN: number;
      HYCHAINTESTNET: number;
      LOCAL: number;
  };

  export function aesEncrypt(
    plaintext: string, 
    key: PBKDF2Key
  ): Promise<Ciphertext>;
  
  export function aesDecrypt(
    ciphertext: Ciphertext, 
    key: PBKDF2Key
  ): Promise<string>;

  export function aesEncryptWalletWithPasswordOrKeyMaterial(
    wallet: Wallet, 
    passwordOrKeyMaterial: string, 
    salt: string
  ): Promise<Ciphertext>;
  
  export function aesDecryptWalletWithPasswordOrKeyMaterial(
    ciphertext: Ciphertext,
    passwordOrKeyMaterial: string, 
    salt: string
  ): Promise<Wallet>;
  
  export function aesEncryptWalletWithBackupCode(
    wallet: Wallet, 
    code: string, 
    salt: string
  ): Promise<Ciphertext>;

  export function aesDecryptWalletWithBackupCode(
    ciphertext: Ciphertext, 
    code: string, 
    salt: string
  ): Promise<Wallet>;

  export function aesEncryptWalletWithBackupQuestionAnswers(
    wallet: Wallet, 
    answers: string[], 
    salt: string
  ): Promise<Ciphertext>;

  export function aesDecryptWalletWithBackupQuestionAnswers(
    ciphertext: Ciphertext, 
    answers: string[], 
    salt: string
  ): Promise<Wallet>;

  export function pbkdf2(
    passwordOrKeyMaterial: string, 
    salt: string
  ): Promise<PBKDF2Key>;

  export function generateRandomNonce(): string;

  export function generateRandomSalt(): string;
  
  export function generateRandomWallet(): Wallet;

  export function generateFunctionSelectorAndTypesFromFunctionSignature(
    functionSignature: string
  ): { selector: string, types: string[] };
  
  export function generateCallRequestDataFromAbi(
    abi: InterfaceAbi, 
    functionName: string, 
    args?: any[]
  ): CallRequestData;

  export function generateCallRequestDataFromFunctionSignature(
    functionSignature: string, 
    args?: any[]
  ): CallRequestData;

  export function generateCallRequest(
    target: string, 
    value: string, 
    nonce?: string, 
    data?: CallRequestData
  ): CallRequest;

  export function generateCreateRequest(
    salt?: string,
    nonce?: string,
    bytecode?: string,
    initCode?: string,
  ): CreateRequest;

  export function generateCreateRequestSignature(
    wallet: Wallet,
    createRequest: CreateRequest,
    deadline: number,
    chainId: number
  ): Promise<string>;

  export function generateCalldataEncoding(
    abi: InterfaceAbi,
    values: any[]
  ): string;

  export function generateCallRequestSignature(
    wallet: Wallet,
    callRequest: CallRequest,
    deadline: number,
    chainId: number
  ): Promise<string>;

  export function generateCallRequirements(
    wallet: Wallet,
    target: string,
    abi: InterfaceAbi | Nullable,
    functionName: string | Nullable, 
    args: any[] | Nullable, 
    value: string, 
    nonce: string,
    deadline: number, 
    chainId: number
  ): Promise<{
    callRequest: CallRequest;
    signature: string;
    deadline: number;
    chainId: number;
  }>;

  export function generateMulticallSignature(
    wallet: Wallet,
    callRequest: CallRequest[],
    deadline: number,
    chainId: number
  ): Promise<string>;

  export function generateMulticallRequirements(
    wallet: Wallet, 
    targets: string[], 
    abis: (InterfaceAbi | Nullable)[], 
    functionNames: string[], 
    args: (any[] | Nullable)[], 
    values: string[], 
    nonces: string[],
    deadline: number, 
    chainId: number
  ): Promise<{
    callRequests: CallRequest[];
    signature: string;
    deadline: number;
    chainId: number;
  }>;

  export function generateScaCreationProofSignature(
    wallet: Wallet
  ): Promise<string>;

  export function generateNonceSignature(
    wallet: Wallet,
    nonceBytes?: string
  ): Promise<{
      nonce: string;
      signature: string;
  }>;

  export function generateUpgradeSignature(
    wallet: Wallet,
    newImplementation: string,
    data: string,
    deadline: number,
    chainId: number
  ): Promise<string>;    

  export function generateSessionRequestTuple(
    sessionRequest: SessionRequest
  ): SessionRequestTuple;

  export function generateSessionSignature(
    wallet: Wallet,
    callerAddress: string,
    sessionRequest: SessionRequest,
    expiresAt: number,
    nonce: string,
    deadline: number,
    chainId: number
  ): Promise<string>;

  export function generateAuthority(
    passwordOrKeyMaterial: string
  ): Promise<{
    salt: string;
    authorityAddress: string;
    authorityCiphertext: Ciphertext;
    authorityProofSignature: string;
  }>;

  export function generateBackupCode(): string;

  export function generateBackupQuestions(): string[];

  export function generateUser(
    username: string,
    passwordOrKeyMaterial: string,
    email?: string
  ): Promise<{
    username: string;
    email: string;
    salt: string;
    authorityAddress: string;
    authorityCiphertext: Ciphertext;
    authorityProofSignature: string;
  }>;

  export function getWallet(
    walletCredentials: WalletCredentials
  ): Wallet;

  export function getWalletCredentials(
    wallet: Wallet
  ): WalletCredentials;

  export function toWei(
    etherString: string
  ): string;

  export function toEther(
    weiString: string
  ): string;

  export function toSha256(
    string: string
  ): Promise<string>;
}