@upbit-official/upbit-sdk 0.9.0 → 1.1.0

package/src/resources/travel-rule.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -12,6 +11,8 @@ export class TravelRule extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-travelrule-vasps
    * - docs(global): https://global-docs.upbit.com/reference/list-travelrule-vasps
    *
+   * Retrieves the list of exchanges supporting Travel Rule.
+   *
    * @example
    * ```ts
    * const response = await client.travelRule.listVasps();
@@ -30,6 +31,8 @@ export class TravelRule extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/verify-travelrule-by-txid
    *
+   * Retrieves travel rule verification using the deposit TxID.
+   *
    * @example
    * ```ts
    * const verificationResult =
@@ -57,6 +60,8 @@ export class TravelRule extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/verify-travelrule-by-uuid
    *
+   * Retrieves travel rule verification using the deposit UUID.
+   *
    * @example
    * ```ts
    * const verificationResult =

package/src/resources/wallet-status.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -11,6 +10,8 @@ export class WalletStatus extends APIResource {
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/get-service-status
    * - docs(global): https://global-docs.upbit.com/reference/get-service-status
+   *
+   * Retrieves deposit and withdrawal service status for all currencies.
    */
   list(options?: RequestOptions): APIPromise<WalletStatusListResponse> {
     return this._client.get('/v1/status/wallet', options);

package/src/resources/withdraws.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { PagePromise, UuidCursorIDPage, type UuidCursorIDPageParams } from '../core/pagination';
@@ -13,6 +12,9 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/get-withdrawal
    * - docs(global): https://global-docs.upbit.com/reference/get-withdrawal
    *
+   * Retrieves the latest single withdrawal information. To query a specific
+   * withdrawal, you can specify the withdrawal’s UUID or transaction ID (TXID).
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.retrieve();
@@ -33,6 +35,8 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-withdrawals
    * - docs(global): https://global-docs.upbit.com/reference/list-withdrawals
    *
+   * Retrieves latest withdrawal list.
+   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
@@ -56,6 +60,9 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/cancel-withdrawal
    * - docs(global): https://global-docs.upbit.com/reference/cancel-withdrawal
    *
+   * Cancel a completed digital asset withdrawal request by specifying the withdrawal
+   * UUID.
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.cancelWithdrawal({
@@ -74,7 +81,9 @@ export class Withdraws extends APIResource {
    * POST /v1/withdraws/krw
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/withdraw-krw
-   * - docs(global): https://global-docs.upbit.com/reference/withdraw-krw
+   * - Supported only in Korea.
+   *
+   * 원화(KRW) 출금을 요청합니다.
    *
    * @example
    * ```ts
@@ -98,6 +107,8 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/withdraw
    * - docs(global): https://global-docs.upbit.com/reference/withdraw
    *
+   * Requests a withdrawal of digital asset.
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.createWithdrawal({
@@ -121,6 +132,8 @@ export class Withdraws extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/list-withdrawal-addresses
    *
+   * Retrieves the list of withdrawal whitelist addresses registered to the account.
+   *
    * @example
    * ```ts
    * const response = await client.withdraws.listCoinAddresses();
@@ -139,6 +152,9 @@ export class Withdraws extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/available-withdrawal-information
    *
+   * Retrieves withdrawal availability information for the specified currency,
+   * including its withdrawal policy and user balance.
+   *
    * @example
    * ```ts
    * const response = await client.withdraws.retrieveChance({

package/src/resources/ws-info/index.ts

@@ -0,0 +1,44 @@
+export {
+  WsInfo,
+  type BollingerBandsIndicator,
+  type BollingerBandsIndicatorSignal,
+  type Indicator,
+  type IndicatorSignal,
+  type IndicatorTimeframe,
+  type IndicatorType,
+  type MaCrossoverIndicator,
+  type MaCrossoverIndicatorSignal,
+  type MacdIndicator,
+  type MacdIndicatorSignal,
+  type MovingAverageIndicator,
+  type MovingAverageIndicatorSignal,
+  type RsiIndicator,
+  type RsiIndicatorSignal,
+  type RsiOverboughtIndicatorSignal,
+  type RsiOverboughtIndicatorSignalRequest,
+  type RsiOversoldIndicatorSignal,
+  type RsiOversoldIndicatorSignalRequest,
+  type VolumeIndicator,
+  type VolumeIndicatorSignal,
+  type ConnectInfoClientEvent,
+  type ConnectInfoServerEvent,
+} from './ws-info';
+export { type WsInfoWSClientOptions } from './ws';
+export { type WsInfoWSReconnectOptions } from './ws';
+
+export type { SimpleInfoServerEvent } from '../../internal/ws-simple-types';
+export type {
+  SimpleVolumeIndicator,
+  SimpleRsiIndicator,
+  SimpleMovingAverageIndicator,
+  SimpleMaCrossoverIndicator,
+  SimpleBollingerBandsIndicator,
+  SimpleMacdIndicator,
+  SimpleVolumeIndicatorSignal,
+  SimpleRsiOverboughtIndicatorSignal,
+  SimpleRsiOversoldIndicatorSignal,
+  SimpleMovingAverageIndicatorSignal,
+  SimpleMaCrossoverIndicatorSignal,
+  SimpleBollingerBandsIndicatorSignal,
+  SimpleMacdIndicatorSignal,
+} from '../../internal/ws-simple-types';

package/src/resources/ws-info/internal-base.ts

@@ -0,0 +1,96 @@
+import * as WsInfoAPI from './ws-info';
+import { Upbit } from '../../client';
+import { EventEmitter } from '../../core/EventEmitter';
+import { UpbitError } from '../../core/error';
+import type { ReconnectingEvent } from '../../internal/ws';
+
+export type WsInfoServerMessage = WsInfoAPI.ConnectInfoServerEvent;
+
+export type WsInfoStreamMessage =
+  | { type: 'connecting' | 'open' | 'closing' }
+  | { type: 'close'; code: number; reason: string }
+  | { type: 'reconnecting'; reconnect: ReconnectingEvent }
+  | { type: 'reconnected' }
+  | { type: 'message'; message: WsInfoServerMessage }
+  | { type: 'error'; error: WebSocketError };
+
+export class WebSocketError extends UpbitError {
+  /**
+   * The error data that the API sent back in an error event.
+   */
+  error?: unknown | undefined;
+
+  constructor(message: string, event: unknown | null) {
+    super(message);
+
+    this.error = event ?? undefined;
+  }
+}
+
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
+
+type WebSocketEvents = Simplify<
+  {
+    event: (event: WsInfoServerMessage) => void;
+    error: (error: WebSocketError) => void;
+    close: (code: number, reason: string) => void;
+    reconnecting: (event: ReconnectingEvent) => void;
+    reconnected: () => void;
+  } & {
+    [EventType in WsInfoAPI.ConnectInfoServerEvent['type']]: (
+      event: Extract<WsInfoAPI.ConnectInfoServerEvent, { type?: EventType }>,
+    ) => unknown;
+  }
+>;
+
+export abstract class WsInfoEmitter extends EventEmitter<WebSocketEvents> {
+  /**
+   * Send an event to the API.
+   */
+  abstract send(event: WsInfoAPI.ConnectInfoClientEvent): void;
+
+  /**
+   * Close the WebSocket connection.
+   */
+  abstract close(props?: { code: number; reason: string }): void;
+
+  protected _onError(event: null, message: string, cause: any): void;
+  protected _onError(event: unknown, message?: string | undefined): void;
+  protected _onError(event: unknown | null, message?: string | undefined, cause?: any): void {
+    message = message ?? safeJSONStringify(event) ?? 'unknown error';
+
+    if (!this._hasListener('error')) {
+      const error = new WebSocketError(
+        message +
+          `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`ws.on('error', (error) => ...)\` `,
+        event,
+      );
+      // @ts-ignore
+      error.cause = cause;
+      Promise.reject(error);
+      return;
+    }
+
+    const error = new WebSocketError(message, event);
+    // @ts-ignore
+    error.cause = cause;
+
+    this._emit('error', error);
+  }
+}
+
+export function buildURL(client: Upbit, parameters?: Record<string, unknown> | null): URL {
+  const { ...query } = parameters ?? {};
+  const endpoint = '/websocket/v1/info';
+  const url = new URL(client.buildURL(endpoint, query, undefined));
+  url.protocol = url.protocol === 'http:' || url.protocol === 'ws:' ? 'ws:' : 'wss:';
+  return url;
+}
+
+function safeJSONStringify(value: unknown): string | null {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return null;
+  }
+}