models.ts

import { Address, ArrayItemType, isAddressObject } from './utils';

/* Account stuff */

/**
 * @category Models
 */
export interface ContractState {
  balance: string;
  genTimings: GenTimings;
  lastTransactionId?: LastTransactionId;
  isDeployed: boolean;
  codeHash?: string;
}

/**
 * @category Models
 */
export interface FullContractState {
  boc: string;
  balance: string;
  genTimings: GenTimings;
  lastTransactionId?: LastTransactionId;
  isDeployed: boolean;
  codeHash?: string;
}

/**
 * @category Models
 */
export type GenTimings = {
  genLt: string;
  genUtime: number;
};

/**
 * @category Models
 */
export type ContractUpdatesSubscription = {
  /**
   * Whether to listen contract state updates
   */
  state: boolean;
  /**
   * Whether to listen new contract transactions
   */
  transactions: boolean;
};

/**
 * @category Models
 */
export type TransactionsBatchInfo = {
  minLt: string;
  maxLt: string;
  batchType: TransactionsBatchType;
};

/**
 * @category Models
 */
export type TransactionsBatchType = 'old' | 'new';

/**
 * @category Models
 */
export type Transaction<Addr = Address> = {
  id: TransactionId;
  prevTransactionId?: TransactionId;
  createdAt: number;
  aborted: boolean;
  exitCode?: number;
  resultCode?: number;
  origStatus: AccountStatus;
  endStatus: AccountStatus;
  totalFees: string;
  inMessage: Message<Addr>;
  outMessages: Message<Addr>[];
};

/**
 * @category Models
 */
export type TransactionWithAccount<Addr = Address> = Transaction<Addr> & { account: Addr };

/**
 * @category Models
 */
export type RawTransaction = Transaction<string>;

/**
 * @category Models
 */
export function serializeTransaction(transaction: Transaction): RawTransaction {
  // NOTE: deep copy to prevent sending objects with prototypes through the channel
  return {
    id: {
      hash: transaction.id.hash,
      lt: transaction.id.lt,
    },
    prevTransactionId:
      transaction.prevTransactionId != null
        ? {
            hash: transaction.prevTransactionId.hash,
            lt: transaction.prevTransactionId.lt,
          }
        : undefined,
    createdAt: transaction.createdAt,
    aborted: transaction.aborted,
    exitCode: transaction.exitCode,
    resultCode: transaction.resultCode,
    origStatus: transaction.origStatus,
    endStatus: transaction.endStatus,
    totalFees: transaction.totalFees,
    inMessage: serializeMessage(transaction.inMessage),
    outMessages: transaction.outMessages.map(serializeMessage),
  };
}

/**
 * @category Models
 */
export function parseTransaction(transaction: RawTransaction): Transaction {
  return {
    ...transaction,
    inMessage: parseMessage(transaction.inMessage),
    outMessages: transaction.outMessages.map(parseMessage),
  };
}

/**
 * @category Models
 */
export type Message<Addr = Address> = {
  hash: string;
  src?: Addr;
  dst?: Addr;
  value: string;
  bounce: boolean;
  bounced: boolean;
  body?: string;
  bodyHash?: string;
};

/**
 * @category Models
 */
export type RawMessage = Message<string>;

/**
 * @category Models
 */
export function serializeMessage(message: Message): RawMessage {
  // NOTE: deep copy to prevent sending objects with prototypes through the channel
  return {
    hash: message.hash,
    src: message.src ? message.src.toString() : undefined,
    dst: message.dst ? message.dst.toString() : undefined,
    value: message.value,
    bounce: message.bounce,
    bounced: message.bounced,
    body: message.body,
    bodyHash: message.bodyHash,
  };
}

/**
 * @category Models
 */
export function parseMessage(message: RawMessage): Message {
  return {
    ...message,
    src: message.src ? new Address(message.src) : undefined,
    dst: message.dst ? new Address(message.dst) : undefined,
  };
}

/**
 * @category Models
 */
export type DelayedMessage<Addr = Address> = {
  /**
   * External message hash
   */
  hash: string;
  /**
   * Destination account address (`sender` for `sendMessageDelayed`, `recipient` for `sendExternalMessageDelayed`)
   */
  account: Addr;
  /**
   * Message expiration timestamp
   */
  expireAt: number;
};

/**
 * @category Models
 */
export type AccountStatus = 'uninit' | 'frozen' | 'active' | 'nonexist';

/**
 * @category Models
 */
export type LastTransactionId = {
  isExact: boolean;
  lt: string;
  hash?: string;
};

/**
 * @category Models
 */
export type TransactionId = {
  lt: string;
  hash: string;
};

/* Permissions stuff */

/**
 * @category Models
 */
export type Permissions<Addr = Address> = {
  basic: true;
  accountInteraction: {
    address: Addr;
    publicKey: string;
    contractType: string;
  };
};

/**
 * @category Models
 */
export type RawPermissions = Permissions<string>;

/**
 * @category Models
 */
export function parsePermissions(permissions: Partial<RawPermissions>): Partial<Permissions> {
  return {
    ...permissions,
    accountInteraction: permissions.accountInteraction
      ? parseAccountInteraction(permissions.accountInteraction)
      : undefined,
  };
}

/**
 * @category Models
 */
export function parseAccountInteraction(
  accountInteraction: Required<RawPermissions>['accountInteraction'],
): Required<Permissions>['accountInteraction'] {
  return {
    ...accountInteraction,
    address: new Address(accountInteraction.address),
  };
}

/**
 * @category Models
 */
export type Permission = keyof Permissions;

/**
 * @category Models
 */
export type PermissionData<T extends Permission, Addr = Address> = Permissions<Addr>[T];

/* Assets stuff */

/**
 * @category Models
 */
export type AssetType = 'tip3_token';

/**
 * @category Models
 */
export type AssetTypeParams<T extends AssetType, Addr = Address> = T extends 'tip3_token'
  ? {
      rootContract: Addr;
    }
  : never;

/**
 * @category Models
 */
export type EncryptionAlgorithm = 'ChaCha20Poly1305';

/**
 * @category Models
 */
export type EncryptedData = {
  algorithm: EncryptionAlgorithm;
  /**
   * Hex encoded encryptor's public key
   */
  sourcePublicKey: string;
  /**
   * Hex encoded recipient public key
   */
  recipientPublicKey: string;
  /**
   * Base64 encoded data
   */
  data: string;
  /**
   * Base64 encoded nonce
   */
  nonce: string;
};

/* Network stuff */

/**
 * @category Models
 */
export type NetworkDescription = {
  globalId: number;
  capabilities: string;
  signatureId: number | undefined;
};

/**
 * @category Models
 */
export type NetworkConfig = {
  symbol?: string;
  explorerBaseUrl?: string;
  tokensManifestUrl?: string;
};

/**
 * @category Models
 */
export type GqlSocketParams = {
  /**
   * Path to graphql api endpoints
   */
  endpoints: string[]
  /**
   * Frequency of sync latency detection
   */
  latencyDetectionInterval: number
  /**
   * Maximum value for the endpoint's blockchain data sync latency
   */
  maxLatency: number
  /**
   * Gql node type
   */
  local: boolean
};

/**
 * @category Models
 */
export type JrpcSocketParams = {
  /**
   * Path to jrpc api endpoint
   */
  endpoint: string
};

/**
 * @category Models
 */
export type ProtoSocketParams = JrpcSocketParams & {};

export type GqlConnection = { type: 'graphql', data: GqlSocketParams };
export type JrpcConnection = { type: 'jrpc', data: JrpcSocketParams };
export type ProtoConnection = { type: 'proto', data: ProtoSocketParams };

/**
 * @category Models
 */
export type Network = {
  name: string;
  description: NetworkDescription;
  connection: GqlConnection | JrpcConnection | ProtoConnection | any;
  config: NetworkConfig;
};

/**
 * @category Models
 */
export type AddNetwork = {
  name: string;
  networkId: number;
  connection: GqlConnection | JrpcConnection | ProtoConnection | any;
  config?: NetworkConfig;
};

/* ABI stuff */

/**
 * @category Models
 */
export type AbiVersion = '1.0' | '2.0' | '2.1' | '2.2' | '2.3';

/**
 * @category Models
 */
// NOTE: `boolean` must be after `string` due to JS being itself - https://github.com/vuejs/core/issues/9253
export type TokenValue<Addr = Address> =
  | null
  | string
  | number
  | Addr
  | boolean
  | { [K in string]: TokenValue<Addr> }
  | TokenValue<Addr>[]
  | (readonly [TokenValue<Addr>, TokenValue<Addr>])[];

/**
 * @category Models
 */
export type RawTokenValue = TokenValue<string>;

/**
 * @category Models
 */
export type TokensObject<Addr = Address> = { [K in string]: TokenValue<Addr> };

/**
 * @category Models
 */
export type RawTokensObject = TokensObject<string>;

/**
 * @category Models
 */
export type FunctionCall<Addr = Address> = {
  /**
   * Contract ABI
   */
  abi: string;
  /**
   * Specific method from specified contract ABI
   */
  method: string;
  /**
   * Method arguments
   */
  params: TokensObject<Addr>;
};

type AbiParamKindUint = 'uint8' | 'uint16' | 'uint24' | 'uint32' | 'uint64' | 'uint128' | 'uint160' | 'uint256';
type AbiParamKindInt = 'int8' | 'int16' | 'int24' | 'int32' | 'int64' | 'int128' | 'int160' | 'int256';
type AbiParamKindVarUint = 'varuint16' | 'varuint32';
type AbiParamKindVarInt = 'varint16' | 'varint32';
type AbiParamKindTuple = 'tuple';
type AbiParamKindBool = 'bool';
type AbiParamKindCell = 'cell';
type AbiParamKindAddress = 'address';
type AbiParamKindBytes = 'bytes';
type AbiParamKindFixedBytes = `fixedbytes${NonZeroDigit | `${'1' | '2'}${Digit}` | '30' | '31' | '32'}`;
type AbiParamKindString = 'string';
type AbiParamKindGram = 'gram';
type AbiParamKindTime = 'time';
type AbiParamKindExpire = 'expire';
type AbiParamKindPublicKey = 'pubkey';
type AbiParamKindArray = `${AbiParamKind}[]`;

type AbiParamKindMapKey = AbiParamKindInt | AbiParamKindUint | AbiParamKindAddress;
type AbiParamKindMap = `map(${AbiParamKindMapKey},${AbiParamKind | `${AbiParamKind}[]`})`;

type AbiParamOptional = `optional(${AbiParamKind})`;
type AbiParamRef = `ref(${AbiParamKind})`;
type AbiParamOptionalRef = `optional(ref(${AbiParamKind}))`;
type AbiParamRefOptional = `ref(optional(${AbiParamKind}))`;

type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
type NonZeroDigit = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';

/**
 * @category Models
 */
export type AbiParamKind =
  | AbiParamKindUint
  | AbiParamKindInt
  | AbiParamKindVarUint
  | AbiParamKindVarInt
  | AbiParamKindTuple
  | AbiParamKindBool
  | AbiParamKindCell
  | AbiParamKindAddress
  | AbiParamKindBytes
  | AbiParamKindFixedBytes
  | AbiParamKindString
  | AbiParamKindGram
  | AbiParamKindTime
  | AbiParamKindExpire
  | AbiParamKindPublicKey;

/**
 * @category Models
 */
export type AbiParam = {
  name: string;
  type:
    | AbiParamKind
    | AbiParamKindMap
    | AbiParamKindArray
    | AbiParamOptional
    | AbiParamRef
    | AbiParamOptionalRef
    | AbiParamRefOptional;
  components?: AbiParam[];
};

/**
 * @category Models
 */
export type ReadonlyAbiParam = {
  name: string;
  type:
    | AbiParamKind
    | AbiParamKindMap
    | AbiParamKindArray
    | AbiParamOptional
    | AbiParamRef
    | AbiParamOptionalRef
    | AbiParamRefOptional;
  components?: readonly ReadonlyAbiParam[];
};

/**
 * @category Models
 */
export function serializeTokensObject(object: TokensObject): RawTokensObject {
  return serializeTokenValue(object as TokenValue) as RawTokensObject;
}

function serializeTokenValue(token: TokenValue): RawTokenValue {
  if (typeof token === 'object' && isAddressObject(token)) {
    return token!.toString();
  }

  if (Array.isArray(token)) {
    const result: RawTokenValue[] = [];
    for (const item of token as TokenValue[]) {
      result.push(serializeTokenValue(item));
    }
    return result;
  } else if (token != null && typeof token === 'object') {
    const result: { [name: string]: RawTokenValue } = {};
    for (const [key, value] of Object.entries(token)) {
      result[key] = serializeTokenValue(value);
    }
    return result;
  } else {
    return token;
  }
}

/**
 * @category Models
 */
export function parseTokensObject(params: AbiParam[], object: RawTokensObject): TokensObject {
  const result: TokensObject = {};
  for (const param of params) {
    result[param.name] = parseTokenValue(param, object[param.name]);
  }
  return result;
}

/**
 * @category Models
 */
export function parsePartialTokensObject(params: AbiParam[], object: Partial<RawTokensObject>): TokensObject {
  const result: TokensObject = {};
  for (const param of params) {
    if (Object.prototype.hasOwnProperty.call(object, param.name)) {
      result[param.name] = parseTokenValue(param, !object[param.name]);
    }
  }
  return result;
}

function parseTokenValue(param: AbiParam, token: RawTokenValue): TokenValue {
  if (!param.type.startsWith('map')) {
    const isArray = param.type.endsWith('[]');
    const isOptional = !isArray && param.type.startsWith('optional');

    const rawType = (
      isArray ? param.type.slice(0, -2) : isOptional ? param.type.slice(9, -1) : param.type
    ) as AbiParamKind;

    if (isArray) {
      const rawParam = { name: param.name, type: rawType, components: param.components } as AbiParam;

      const result: TokenValue[] = [];
      for (const item of token as TokenValue<string>[]) {
        result.push(parseTokenValue(rawParam, item));
      }
      return result;
    } else if (isOptional) {
      if (token == null) {
        return null;
      } else {
        const rawParam = { name: param.name, type: rawType, components: param.components } as AbiParam;
        return parseTokenValue(rawParam, token);
      }
    } else if (rawType === 'tuple') {
      type TokenValueTuple<Addr> = { [K in string]: TokenValue<Addr> };

      const result: TokenValueTuple<Address> = {};
      if (param.components != null) {
        for (const component of param.components) {
          result[component.name] = parseTokenValue(component, (token as TokenValueTuple<string>)[component.name]);
        }
      }
      return result;
    } else if (rawType === 'address') {
      return new Address(token as string) as TokenValue;
    } else {
      return token;
    }
  } else {
    type TokenValueMap<Addr> = (readonly [TokenValue<Addr>, TokenValue<Addr>])[];

    const valueTypeIndex = param.type.indexOf(',');
    const keyType = param.type.slice(4, valueTypeIndex);
    const valueType = param.type.slice(valueTypeIndex + 1, -1);

    const result: TokenValueMap<Address> = [];
    for (const [key, value] of token as unknown as TokenValueMap<string>) {
      result.push([
        parseTokenValue(
          {
            name: '',
            type: keyType as AbiParamKind,
          },
          key,
        ),
        parseTokenValue(
          {
            name: '',
            type: valueType as AbiParamKind,
            components: param.components,
          },
          value,
        ),
      ]);
    }
    return result;
  }
}

// prettier-ignore
type InputTokenValue<T, C> =
  T extends AbiParamKindUint | AbiParamKindInt | AbiParamKindVarUint | AbiParamKindVarInt | AbiParamKindGram | AbiParamKindTime | AbiParamKindExpire ? string | number
    : T extends AbiParamKindBool ? boolean
      : T extends AbiParamKindCell | AbiParamKindBytes | AbiParamKindFixedBytes | AbiParamKindString | AbiParamKindPublicKey ? string
        : T extends AbiParamKindAddress ? Address
          : T extends AbiParamKindTuple ? MergeInputObjectsArray<C>
            : T extends `${infer K}[]` ? InputTokenValue<K, C>[]
              : T extends `map(${infer K},${infer V})` ? (readonly [InputTokenValue<K, undefined>, InputTokenValue<V, C>])[]
                : T extends `optional(${infer V})` | `ref(optional(${infer V}))` | `optional(ref(${infer V}))` ? (InputTokenValue<V, C> | null)
                  : T extends `ref(${infer V})` ? InputTokenValue<V, C>
                    : never;

// prettier-ignore
type OutputTokenValue<T, C> =
  T extends AbiParamKindUint | AbiParamKindInt | AbiParamKindVarUint | AbiParamKindVarInt | AbiParamKindGram | AbiParamKindTime | AbiParamKindCell | AbiParamKindBytes | AbiParamKindFixedBytes | AbiParamKindString | AbiParamKindPublicKey ? string
    : T extends AbiParamKindExpire ? number
      : T extends AbiParamKindBool ? boolean
        : T extends AbiParamKindAddress ? Address
          : T extends AbiParamKindTuple ? MergeOutputObjectsArray<C>
            : T extends `${infer K}[]` ? OutputTokenValue<K, C>[]
              : T extends `map(${infer K},${infer V})` ? (readonly [OutputTokenValue<K, undefined>, OutputTokenValue<V, C>])[]
                : T extends `optional(${infer V})` | `ref(optional(${infer V}))` | `optional(ref(${infer V}))` ? (OutputTokenValue<V, C> | null)
                  : T extends `ref(${infer V})` ? OutputTokenValue<V, C>
                    : never;

/**
 * @category Models
 */
export type InputTokenObject<O> = O extends { name: infer K; type: infer T; components?: infer C }
  ? K extends string
    ? { [P in K]: InputTokenValue<T, C> }
    : never
  : never;

/**
 * @category Models
 */
export type OutputTokenObject<O> = O extends { name: infer K; type: infer T; components?: infer C }
  ? K extends string
    ? { [P in K]: OutputTokenValue<T, C> }
    : never
  : never;

/**
 * @category Models
 */
export type MergeInputObjectsArray<A> = A extends readonly [infer T, ...infer Ts]
  ? InputTokenObject<T> & MergeInputObjectsArray<[...Ts]>
  : A extends readonly [infer T]
  ? InputTokenObject<T>
  : A extends readonly []
  ? {}
  : never;

/**
 * @category Models
 */
export type MergeOutputObjectsArray<A> = A extends readonly [infer T, ...infer Ts]
  ? OutputTokenObject<T> & MergeOutputObjectsArray<[...Ts]>
  : A extends readonly [infer T]
  ? OutputTokenObject<T>
  : A extends readonly []
  ? {}
  : never;

/**
 * @category Models
 */
export type AbiFunctions<C> = C extends { functions: infer F }
  ? F extends readonly unknown[]
    ? ArrayItemType<F>
    : never
  : never;

/**
 * @category Models
 */
export type AbiEvents<C> = C extends { events: infer E }
  ? E extends readonly unknown[]
    ? ArrayItemType<E>
    : never
  : never;

/**
 * @category Models
 */
export type AbiFields<C> = C extends { fields: infer F } ? F : never;

/**
 * @category Models
 */
export type AbiFunction<C, T extends AbiFunctionName<C>> = Extract<AbiFunctions<C>, { name: T }>;
/**
 * @category Models
 */
export type AbiEvent<C, T extends AbiEventName<C>> = Extract<AbiEvents<C>, { name: T }>;

/**
 * @category Models
 */
export type AbiFunctionName<C> = AbiFunctions<C>['name'];
/**
 * @category Models
 */
export type AbiEventName<C> = AbiEvents<C>['name'];
/**
 * @category Models
 */
export type AbiFieldName<C> = keyof DecodedAbiFields<C>;

/**
 * @category Models
 */
export type AbiFunctionInputs<C, T extends AbiFunctionName<C>> = MergeInputObjectsArray<AbiFunction<C, T>['inputs']>;

/**
 * @category Models
 */
export type AbiFunctionInputsWithDefault<C, T extends AbiFunctionName<C>> = AbiFunction<
  C,
  T
>['inputs'] extends readonly []
  ? void | Record<string, never>
  : AbiFunctionInputs<C, T>;

/**
 * @category Models
 */
export type DecodedAbiFunctionInputs<C, T extends AbiFunctionName<C>> = MergeOutputObjectsArray<
  AbiFunction<C, T>['inputs']
>;
/**
 * @category Models
 */
export type DecodedAbiFunctionOutputs<C, T extends AbiFunctionName<C>> = MergeOutputObjectsArray<
  AbiFunction<C, T>['outputs']
>;
/**
 * @category Models
 */
export type DecodedAbiEventData<C, T extends AbiEventName<C>> = MergeOutputObjectsArray<AbiEvent<C, T>['inputs']>;

/**
 * @category Models
 */
export type DecodedAbiInitData<C> = C extends { data: infer D } ? Partial<MergeOutputObjectsArray<D>> : never;

/**
 * @category Models
 */
export type DecodedAbiFields<C> = C extends { fields: infer F } ? MergeOutputObjectsArray<F> : never;