Class TradeAdapterWebsocket

Implements

TradeAdapter

Constructors

`Private` constructor

new TradeAdapterWebsocket(provider, network, config): TradeAdapterWebsocket
Parameters
- provider: Provider
- network: "base" | "arbitrum" | "arbitrum-sepolia"
- config: AdapterConfig
Returns TradeAdapterWebsocket
- Defined in src/components/trade/adapter.ts:330

Properties

`Private` activeSubscriptions

activeSubscriptions: Set<string> = ...

`Private` config

config: AdapterConfig = DEFAULT_CONFIG

`Private` connectionPromise

connectionPromise: Promise<void>

`Private` listeners

listeners: WebsocketListener[] = []

`Private` localNonces

localNonces: NonceMap = {}

`Private` network

network: "base" | "arbitrum" | "arbitrum-sepolia"

provider

provider: Provider

`Protected` resubscriptionResults

resubscriptionResults: string[] = []

`Private` socket

socket: w3cwebsocket

`Private` subscriptionRequests

subscriptionRequests: SubscriptionRequest<any>[] = []

Methods

cancelOrder

cancelOrder(orderId, accountId, accountUser, nonce, signature): Promise<void>
Parameters
- orderId: string
- accountId: number
- accountUser: string
- nonce: string
- signature: string
Returns Promise<void>
Implementation of TradeAdapter.cancelOrder
- Defined in src/components/trade/adapter.ts:630

cancelSubscription

cancelSubscription(subscriptionId): void
Parameters
- subscriptionId: string
Returns void
Implementation of TradeAdapter.cancelSubscription
- Defined in src/components/trade/adapter.ts:845

clearSystemParam

clearSystemParam(args): Promise<void>
Parameters
- args: ClearSystemParamArgs
Returns Promise<void>
Implementation of TradeAdapter.clearSystemParam
- Defined in src/components/trade/adapter.ts:747

close

close(): void
Returns void
- Defined in src/components/trade/adapter.ts:818

deposit

deposit(amount, accountId, tokenAddress, depositorAddress, signature, useGasless?, psmToken?): Promise<DepositResponse>
Parameters
- amount: string
- accountId: number
- tokenAddress: string
- depositorAddress: string
- signature: string
- Optional useGasless: boolean
- Optional psmToken: string
Returns Promise<DepositResponse>
Implementation of TradeAdapter.deposit
- Defined in src/components/trade/adapter.ts:541

getAdminMessage

getAdminMessage(signerAddress, accountId): Promise<Bytes>
Parameters
- signerAddress: string
- accountId: number
Returns Promise<Bytes>
- Defined in src/components/trade/adapter.ts:481

getDepositMessage

getDepositMessage(signerAddress, accountId): Promise<Bytes>
Parameters
- signerAddress: string
- accountId: number
Returns Promise<Bytes>
Implementation of TradeAdapter.getDepositMessage
- Defined in src/components/trade/adapter.ts:445

getLpConfig

getLpConfig(): Promise<LpConfigUpdateResponse>
Returns Promise<LpConfigUpdateResponse>
Implementation of TradeAdapter.getLpConfig
- Defined in src/components/trade/adapter.ts:770

getOpenAccountMessage

getOpenAccountMessage(signerAddress): Promise<Bytes>
Parameters
- signerAddress: string
Returns Promise<Bytes>
Implementation of TradeAdapter.getOpenAccountMessage
- Defined in src/components/trade/adapter.ts:436

getOwnerMessage

getOwnerMessage(signerAddress, accountId): Promise<Bytes>
Parameters
- signerAddress: string
- accountId: number
Returns Promise<Bytes>
Implementation of TradeAdapter.getOwnerMessage
- Defined in src/components/trade/adapter.ts:493

getTradeMessage

getTradeMessage(signerAddress, accountId): Promise<Bytes>
Parameters
- signerAddress: string
- accountId: number
Returns Promise<Bytes>
Implementation of TradeAdapter.getTradeMessage
- Defined in src/components/trade/adapter.ts:469

`Private` getUserNonce

getUserNonce(signerAddress): Promise<BigNumber>
Parameters
- signerAddress: string
Returns Promise<BigNumber>
- Defined in src/components/trade/adapter.ts:420

`Private` getUserRoleMessage

getUserRoleMessage(nonce, accountId, role): Bytes
Parameters
- nonce: BigNumber
- accountId: number
- role: number
Returns Bytes
- Defined in src/components/trade/adapter.ts:505

getWithdrawMessage

getWithdrawMessage(signerAddress, accountId): Promise<Bytes>
Parameters
- signerAddress: string
- accountId: number
Returns Promise<Bytes>
Implementation of TradeAdapter.getWithdrawMessage
- Defined in src/components/trade/adapter.ts:457

grantAccountUserRole

grantAccountUserRole(accountId, user, role, accountOwner, ownerSignature): Promise<GrantAccountUserRoleResponse>
Parameters
- accountId: number
- user: string
- role: TradeAccountRole
- accountOwner: string
- ownerSignature: string
Returns Promise<GrantAccountUserRoleResponse>
Implementation of TradeAdapter.grantAccountUserRole
- Defined in src/components/trade/adapter.ts:683

`Private` increaseLocalUserNonce

increaseLocalUserNonce(address): void
Parameters
- address: string
Returns void
- Defined in src/components/trade/adapter.ts:973

openAccount

openAccount(amount, tokenAddress, ownerAddress, signature, referralCode?, useGasless?, psmToken?): Promise<OpenAccountResponse>
Parameters
- amount: string
- tokenAddress: string
- ownerAddress: string
- signature: string
- Optional referralCode: string
- Optional useGasless: boolean
- Optional psmToken: string
Returns Promise<OpenAccountResponse>
Implementation of TradeAdapter.openAccount
- Defined in src/components/trade/adapter.ts:518

placeOrder

placeOrder(order): Promise<PlaceOrderResponse>
Parameters
- order: {
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }
  - accountId: number
  - accountUser: string
  - createdTimestampUnixMillis: number
  - expiryTimestampUnixMillis: number
  - id: string
  - kind: {
        kind: "market";
    } | {
        args: {
            limitPrice: BigNumber;
        };
        kind: "limit";
    } | {
        args: {
            stopLoss?: null | {
                kind: "position";
            } | {
                id: string;
                kind: "order";
            };
            triggerPrice: BigNumber;
        };
        kind: "stopMarket";
    } | {
        args: {
            limitPrice: BigNumber;
            triggerPrice: BigNumber;
        };
        kind: "stopLimit";
    } | {
        args: {
            takeProfit?: null | {
                kind: "position";
            } | {
                id: string;
                kind: "order";
            };
            triggerPrice: BigNumber;
        };
        kind: "limitTrigger";
    } | {
        kind: string;
    }
  - lpId: string
  - nonce: string
  - pair: Pair
  - signature: string
  - size: {
    amount: BigNumber;
    unit: "lpc" | "lot";
    }
    - amount: BigNumber
    - unit: "lpc" | "lot"
  - status: {
        content: {
            status: "placed";
        } | {
            content: {
                timestampUnixMillis: number;
                triggerPrice: BigNumber;
            };
            status: "triggered";
        };
        status: "open";
    } | {
        content: {
            price: BigNumber;
            settlementStatus: {
                status: "queued";
            } | {
                status: "beforeTx";
            } | {
                status: "indexing";
            } | {
                content: {
                    txHash: string;
                };
                status: "settled";
            };
            timestampUnixMillis: number;
        };
        status: "filled";
    } | {
        content: {
            reason: string;
            timestampUnixMillis: number;
            userCancellation?: null | {
                address: string;
                nonce: string;
                signature: {
                    r: string;
                    s: string;
                    v: number;
                };
            };
        };
        status: "cancelled";
    }
Returns Promise<PlaceOrderResponse>
Implementation of TradeAdapter.placeOrder
- Defined in src/components/trade/adapter.ts:610

`Private` pushUniqueSubscriptionRequest

pushUniqueSubscriptionRequest<C>(request): void
Type Parameters
- C
Parameters
- request: SubscriptionRequest<C>
Returns void
- Defined in src/components/trade/adapter.ts:882

reconnect

reconnect(newWsUrl?): Promise<void>
Parameters
- Optional newWsUrl: string
Returns Promise<void>
- Defined in src/components/trade/adapter.ts:385

replaceOrder

replaceOrder(cancelOrderId, cancelSignature, nonce, accountId, accountUser, newOrder): Promise<ReplaceOrderResponse>
Parameters
- cancelOrderId: string
- cancelSignature: string
- nonce: string
- accountId: number
- accountUser: string
- newOrder: {
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }
  - accountId: number
  - accountUser: string
  - createdTimestampUnixMillis: number
  - expiryTimestampUnixMillis: number
  - id: string
  - kind: {
        kind: "market";
    } | {
        args: {
            limitPrice: BigNumber;
        };
        kind: "limit";
    } | {
        args: {
            stopLoss?: null | {
                kind: "position";
            } | {
                id: string;
                kind: "order";
            };
            triggerPrice: BigNumber;
        };
        kind: "stopMarket";
    } | {
        args: {
            limitPrice: BigNumber;
            triggerPrice: BigNumber;
        };
        kind: "stopLimit";
    } | {
        args: {
            takeProfit?: null | {
                kind: "position";
            } | {
                id: string;
                kind: "order";
            };
            triggerPrice: BigNumber;
        };
        kind: "limitTrigger";
    } | {
        kind: string;
    }
  - lpId: string
  - nonce: string
  - pair: Pair
  - signature: string
  - size: {
    amount: BigNumber;
    unit: "lpc" | "lot";
    }
    - amount: BigNumber
    - unit: "lpc" | "lot"
  - status: {
        content: {
            status: "placed";
        } | {
            content: {
                timestampUnixMillis: number;
                triggerPrice: BigNumber;
            };
            status: "triggered";
        };
        status: "open";
    } | {
        content: {
            price: BigNumber;
            settlementStatus: {
                status: "queued";
            } | {
                status: "beforeTx";
            } | {
                status: "indexing";
            } | {
                content: {
                    txHash: string;
                };
                status: "settled";
            };
            timestampUnixMillis: number;
        };
        status: "filled";
    } | {
        content: {
            reason: string;
            timestampUnixMillis: number;
            userCancellation?: null | {
                address: string;
                nonce: string;
                signature: {
                    r: string;
                    s: string;
                    v: number;
                };
            };
        };
        status: "cancelled";
    }
Returns Promise<ReplaceOrderResponse>
Implementation of TradeAdapter.replaceOrder
- Defined in src/components/trade/adapter.ts:649

`Private` resubscribe

resubscribe(): Promise<string[]>
Returns Promise<string[]>
- Defined in src/components/trade/adapter.ts:892

revokeAccountUserRole

revokeAccountUserRole(accountId, user, role, accountOwner, ownerSignature): Promise<RevokeAccountUserRoleResponse>
Parameters
- accountId: number
- user: string
- role: TradeAccountRole
- accountOwner: string
- ownerSignature: string
Returns Promise<RevokeAccountUserRoleResponse>
Implementation of TradeAdapter.revokeAccountUserRole
- Defined in src/components/trade/adapter.ts:703

`Private` sendRequest

sendRequest<C>(request): Promise<Response<C>>
Type Parameters
- C
Parameters
- request: Request
Returns Promise<Response<C>>
- Defined in src/components/trade/adapter.ts:920

`Private` sendRequestRetry

sendRequestRetry(stringifiedRequest): Promise<void>
Parameters
- stringifiedRequest: string
Returns Promise<void>
- Defined in src/components/trade/adapter.ts:902

setSystemParam

setSystemParam(args): Promise<void>
Parameters
- args: SetSystemParamArgs
Returns Promise<void>
Implementation of TradeAdapter.setSystemParam
- Defined in src/components/trade/adapter.ts:723

`Private` setupSubscriptionListener

setupSubscriptionListener<C>(subscriptionId, listener): Promise<void>
Private
Sets up a listener for the subscription. The listener will loop through sever updates for as long as the client keeps the subscription active. When called, this function should not be awaited as it is meant to be executed as a background task.
Type Parameters
- C
Parameters
- subscriptionId: string
- listener: SubscriptionListener<C>
Returns Promise<void>
- Defined in src/components/trade/adapter.ts:938

`Private` subscribe

subscribe<C>(request): Promise<string>
Type Parameters
- C
Parameters
- request: SubscriptionRequest<C>
Returns Promise<string>
- Defined in src/components/trade/adapter.ts:849

subscribeToAccount

subscribeToAccount(accountId, listener): Promise<string>
Parameters
- accountId: number
- listener: AccountListener
Returns Promise<string>
Implementation of TradeAdapter.subscribeToAccount
- Defined in src/components/trade/adapter.ts:822

subscribeToLp

subscribeToLp(lpId, listener): Promise<string>
Parameters
- lpId: string
- listener: LpListener
Returns Promise<string>
Implementation of TradeAdapter.subscribeToLp
- Defined in src/components/trade/adapter.ts:834

trade

trade(accountId, liquidityPoolId, size, pair, accountUser, signature): Promise<TradeResponse>
Parameters
- accountId: number
- liquidityPoolId: string
- size: {
  amount: BigNumber;
  unit: "lpc" | "lot";
  }
  - amount: BigNumber
  - unit: "lpc" | "lot"
- pair: Pair
- accountUser: string
- signature: string
Returns Promise<TradeResponse>
Implementation of TradeAdapter.trade
- Defined in src/components/trade/adapter.ts:587

waitForConnect

waitForConnect(): Promise<void>
Returns Promise<void>
Implementation of TradeAdapter.waitForConnect
- Defined in src/components/trade/adapter.ts:359

`Private` waitForRequestId

waitForRequestId<T>(requestId, timeout?): {
cancel: (() => void);
result: Promise<T>;
}
This function has no validation that the returned type is T
Type Parameters
- T
Parameters
- requestId: string
- timeout: number = ...
Returns {
cancel: (() => void);
result: Promise<T>;
}
- cancel: (() => void)
  - - (): void
    - Returns void
- result: Promise<T>
- Defined in src/components/trade/adapter.ts:777

withdraw

withdraw(amount, accountId, accountUser, tokenAddress, recipientAddress, signature, psmToken?): Promise<WithdrawResponse>
Parameters
- amount: string
- accountId: number
- accountUser: string
- tokenAddress: string
- recipientAddress: string
- signature: string
- Optional psmToken: string
Returns Promise<WithdrawResponse>
Implementation of TradeAdapter.withdraw
- Defined in src/components/trade/adapter.ts:564

`Static` create

create(wsUrl, provider, config?): Promise<TradeAdapterWebsocket>
Parameters
- wsUrl: string
- provider: Provider
- config: AdapterConfig = DEFAULT_CONFIG
Returns Promise<TradeAdapterWebsocket>
- Defined in src/components/trade/adapter.ts:340

Class TradeAdapterWebsocket

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

Returns TradeAdapterWebsocket

Properties

Private activeSubscriptions

Private config

Private connectionPromise

Private listeners

Private localNonces

Private network

provider

Protected resubscriptionResults

Private socket

Private subscriptionRequests

Methods

cancelOrder

Parameters

Returns Promise<void>

cancelSubscription

Parameters

Returns void

clearSystemParam

Parameters

Returns Promise<void>

close

Returns void

deposit

Parameters

Returns Promise<DepositResponse>

getAdminMessage

Parameters

Returns Promise<Bytes>

getDepositMessage

Parameters

Returns Promise<Bytes>

getLpConfig

Returns Promise<LpConfigUpdateResponse>

getOpenAccountMessage

Parameters

Returns Promise<Bytes>

getOwnerMessage

Parameters

Returns Promise<Bytes>

getTradeMessage

Parameters

Returns Promise<Bytes>

Private getUserNonce

Parameters

Returns Promise<BigNumber>

Private getUserRoleMessage

Parameters

Returns Bytes

getWithdrawMessage

Parameters

Returns Promise<Bytes>

grantAccountUserRole

Parameters

Returns Promise<GrantAccountUserRoleResponse>

Private increaseLocalUserNonce

Parameters

Returns void

openAccount

Parameters

Returns Promise<OpenAccountResponse>

placeOrder

Parameters

accountId: number

accountUser: string

createdTimestampUnixMillis: number

expiryTimestampUnixMillis: number

id: string

lpId: string

nonce: string

`Private` constructor

`Private` activeSubscriptions

`Private` config

`Private` connectionPromise

`Private` listeners

`Private` localNonces

`Private` network

`Protected` resubscriptionResults

`Private` socket

`Private` subscriptionRequests

`Private` getUserNonce

`Private` getUserRoleMessage

`Private` increaseLocalUserNonce

size: {
amount: BigNumber;
unit: "lpc" | "lot";
}

`Private` pushUniqueSubscriptionRequest

size: {
amount: BigNumber;
unit: "lpc" | "lot";
}

`Private` resubscribe

`Private` sendRequest

`Private` sendRequestRetry

`Private` setupSubscriptionListener

`Private` subscribe

`Private` waitForRequestId