// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

export class Address extends APIResource {
  /**
   * Gets an address and returns a full security assessment indicating whether or not
   * this address is malicious as well as textual reasons of why the address was
   * flagged that way.
   *
   * @example
   * ```ts
   * const response = await client.sui.address.scan({
   *   address: '0x2',
   *   chain: 'mainnet',
   * });
   * ```
   */
  scan(body: AddressScanParams, options?: RequestOptions): APIPromise<AddressScanResponse> {
    return this._client.post('/v0/sui/address/scan', { body, ...options });
  }
}

export interface AddressScanResponse {
  /**
   * Verdict of the validation
   */
  result_type: 'Benign' | 'Spam' | 'Warning' | 'Malicious' | 'Error';

  /**
   * A list of textual features about this transaction that can be presented to the
   * user.
   */
  features?: Array<AddressScanResponse.Feature>;
}

export namespace AddressScanResponse {
  export interface Feature {
    description: string;

    feature_id: string;

    type: 'Benign' | 'Warning' | 'Malicious' | 'Info';
  }
}

export interface AddressScanParams {
  address: string;

  chain: 'mainnet';
}

export declare namespace Address {
  export { type AddressScanResponse as AddressScanResponse, type AddressScanParams as AddressScanParams };
}