types.ts

/*
Copyright 2018 - 2022 The Alephium Authors
This file is part of the alephium project.

The library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

The library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with the library. If not, see <http://www.gnu.org/licenses/>.
*/
import {
  Account,
  SignTransferTxParams,
  SignTransferTxResult,
  SignDeployContractTxParams,
  SignDeployContractTxResult,
  SignExecuteScriptTxParams,
  SignExecuteScriptTxResult,
  SignUnsignedTxParams,
  SignUnsignedTxResult,
  SignMessageParams,
  SignMessageResult,
  ApiRequestArguments,
  assertType,
  Eq,
  NetworkId,
  SignChainedTxParams,
  SignChainedTxResult
} from '@alephium/web3'
import { SignClientTypes } from '@walletconnect/types'
import { RELAY_METHODS } from './constants'

type RelayMethodsTuple = typeof RELAY_METHODS
export type RelayMethod = RelayMethodsTuple[number]

type RelayMethodsTable = {
  alph_signAndSubmitTransferTx: {
    params: SignTransferTxParams
    result: SignTransferTxResult
  }
  alph_signAndSubmitDeployContractTx: {
    params: SignDeployContractTxParams
    result: SignDeployContractTxResult
  }
  alph_signAndSubmitExecuteScriptTx: {
    params: SignExecuteScriptTxParams
    result: SignExecuteScriptTxResult
  }
  alph_signAndSubmitUnsignedTx: {
    params: SignUnsignedTxParams
    result: SignUnsignedTxResult
  }
  alph_signAndSubmitChainedTx: {
    params: SignChainedTxParams[]
    result: SignChainedTxResult[]
  }
  alph_signUnsignedTx: {
    params: SignUnsignedTxParams
    result: SignUnsignedTxResult
  }
  alph_signMessage: {
    params: SignMessageParams
    result: SignMessageResult
  }
  alph_requestNodeApi: {
    params: ApiRequestArguments
    result: any
  }
  alph_requestExplorerApi: {
    params: ApiRequestArguments
    result: any
  }
}
assertType<Eq<RelayMethod, keyof RelayMethodsTable>>()
export type RelayMethodParams<T extends RelayMethod> = RelayMethodsTable[T]['params']
export type RelayMethodResult<T extends RelayMethod> = RelayMethodsTable[T]['result']

type ProviderEventArguments = {
  displayUri: string
  accountChanged: Account

  session_ping: SignClientTypes.EventArguments['session_ping']
  session_update: SignClientTypes.EventArguments['session_update']
  session_delete: SignClientTypes.EventArguments['session_delete']
  session_event: SignClientTypes.EventArguments['session_event']
}
export type ProviderEvent =
  | 'displayUri'
  | 'accountChanged'
  | 'session_ping'
  | 'session_update'
  | 'session_delete'
  | 'session_event'
assertType<Eq<ProviderEvent, keyof ProviderEventArguments>>()
export type ProviderEventArgument<T extends ProviderEvent> = ProviderEventArguments[T]

export type AddressGroup = number | undefined // number: a specific address group; undefined: all address groups
export interface ChainInfo {
  networkId: NetworkId
  addressGroup: AddressGroup
}

export type ProjectMetaData = SignClientTypes.Metadata
export type SignClientOptions = SignClientTypes.Options