@bluefin-exchange/pro-sdk 0.1.61 → 0.2.0-pre-release.1

package/src/docs/UpdateAccountPreferenceRequest.md

@@ -1,24 +0,0 @@
-# UpdateAccountPreferenceRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**language** | **string** | User preferred language. | [optional] [default to undefined]
-**theme** | **string** | User preferred theme. | [optional] [default to undefined]
-**market** | [**Array<AccountMarketPreference>**](AccountMarketPreference.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateAccountPreferenceRequest } from '@bluefin/api-client';
-
-const instance: UpdateAccountPreferenceRequest = {
-    language,
-    theme,
-    market,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/UpdateAffiliateFeeConfigRequest.md

@@ -1,20 +0,0 @@
-# UpdateAffiliateFeeConfigRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cashback** | **number** | Cashback amount to give to the referees | [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateAffiliateFeeConfigRequest } from '@bluefin/api-client';
-
-const instance: UpdateAffiliateFeeConfigRequest = {
-    cashback,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/UserCampaignRewards.md

@@ -1,48 +0,0 @@
-# UserCampaignRewards
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | User address for the rewards earned data. | [default to undefined]
-**campaignName** | **string** | Name of the campaign. | [default to undefined]
-**epochNumber** | **number** | Epoch number for the rewards earned data. | [default to undefined]
-**intervalNumber** | **number** | Interval number for the rewards earned data. | [default to undefined]
-**symbol** | **string** | Market Symbol. | [default to undefined]
-**status** | **string** |  | [default to undefined]
-**blueRewardsE9** | **string** | Total blue-perp token rewards earned in the epoch (e9 format). | [default to undefined]
-**suiRewardsE9** | **string** | Total sui-perp token rewards earned in the epoch (e9 format). | [default to undefined]
-**walRewardsE9** | **string** | Total wal-perp rewards earned in the epoch (e9 format). | [default to undefined]
-**cashRewardsE9** | **string** | Total cash rewards earned in the epoch (e9 format). | [default to undefined]
-**userFeePaidE9** | **string** | Total user fee paid in the epoch (e9 format). | [default to undefined]
-**intervalStartDate** | **number** | Time in seconds for interval start date. | [default to undefined]
-**intervalEndDate** | **number** | Time in seconds for interval end date. | [default to undefined]
-**isDisbursed** | **boolean** | Indicates if the rewards have been disbursed. | [default to undefined]
-**txnDigest** | **string** | Transaction digest of the disbursement. | [default to undefined]
-
-## Example
-
-```typescript
-import { UserCampaignRewards } from '@bluefin/api-client';
-
-const instance: UserCampaignRewards = {
-    userAddress,
-    campaignName,
-    epochNumber,
-    intervalNumber,
-    symbol,
-    status,
-    blueRewardsE9,
-    suiRewardsE9,
-    walRewardsE9,
-    cashRewardsE9,
-    userFeePaidE9,
-    intervalStartDate,
-    intervalEndDate,
-    isDisbursed,
-    txnDigest,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/WithdrawRequest.md

@@ -1,22 +0,0 @@
-# WithdrawRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signedFields** | [**WithdrawRequestSignedFields**](WithdrawRequestSignedFields.md) |  | [default to undefined]
-**signature** | **string** | The signature of the request, encoded from the signedFields | [default to undefined]
-
-## Example
-
-```typescript
-import { WithdrawRequest } from '@bluefin/api-client';
-
-const instance: WithdrawRequest = {
-    signedFields,
-    signature,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/WithdrawRequestSignedFields.md

@@ -1,30 +0,0 @@
-# WithdrawRequestSignedFields
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**assetSymbol** | **string** | Asset symbol of the withdrawn asset | [default to undefined]
-**accountAddress** | **string** | The Account Address from which to withdraw assets | [default to undefined]
-**amountE9** | **string** | The amount in e9 of the asset that the User will withdraw from their account | [default to undefined]
-**salt** | **string** | A uniqueness modifier for the request. This is added to guarantee uniqueness of the request. Usually a mix of timestamp and a random number | [default to undefined]
-**edsId** | **string** | the ID of the external datastore for the target network | [default to undefined]
-**signedAtMillis** | **number** | The timestamp in milliseconds when the HTTP Request payload has been signed | [default to undefined]
-
-## Example
-
-```typescript
-import { WithdrawRequestSignedFields } from '@bluefin/api-client';
-
-const instance: WithdrawRequestSignedFields = {
-    assetSymbol,
-    accountAddress,
-    amountE9,
-    salt,
-    edsId,
-    signedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/src/index.ts

@@ -1,6 +0,0 @@
-export * from "./api";
-export * from "./configuration";
-export * from "./sdk";
-export * from "./request-signer";
-export * from "./utils";
-export * from "./websocket";

package/src/request-signer.ts

@@ -1,405 +0,0 @@
-import {
-  Keypair,
-  Signer,
-  parseSerializedSignature,
-} from "@mysten/sui/cryptography";
-import {
-  LoginRequest,
-  AccountPositionLeverageUpdateRequestSignedFields,
-  CreateOrderRequestSignedFields,
-  WithdrawRequestSignedFields,
-  AccountAuthorizationRequestSignedFields,
-  AdjustMarginOperation,
-  AdjustIsolatedMarginRequestSignedFields,
-} from "./api";
-import {
-  DryRunTransactionBlockResponse,
-  SuiBlocks,
-  SuiClient,
-  SuiTransactionBlockResponse,
-  TransactionBlock,
-} from "@firefly-exchange/library-sui";
-
-export interface IBluefinSigner {
-  getAddress(): string;
-  signLeverageUpdateRequest: (
-    fields: AccountPositionLeverageUpdateRequestSignedFields
-  ) => Promise<string>;
-  signOrderRequest: (fields: CreateOrderRequestSignedFields) => Promise<string>;
-  signWithdrawRequest: (fields: WithdrawRequestSignedFields) => Promise<string>;
-  signAccountAuthorizationRequest: (fields: AccountAuthorizationRequestSignedFields, isAuthorize: boolean) => Promise<string>;
-  signAdjustIsolatedMarginRequest: (fields: AdjustIsolatedMarginRequestSignedFields) => Promise<string>;
-  signLoginRequest: (request: LoginRequest) => Promise<string>;
-  executeTx: (
-    txb: TransactionBlock,
-    suiClient: SuiClient
-  ) => Promise<DryRunTransactionBlockResponse | SuiTransactionBlockResponse>;
-}
-
-export interface ISigner {
-  toSuiAddress(): string;
-  isUIWallet(): boolean;
-}
-
-
-export function makeSigner<T extends Keypair>(
-  keyPair: T,
-  isUIWallet: boolean,
-): T & ISigner {
-  return Object.assign(keyPair, {
-    toSuiAddress: () => keyPair.getPublicKey().toSuiAddress(),
-    isUIWallet: () => isUIWallet
-  });
-}
-
-// ------- ISerializables ---------
-
-// Enums
-enum ClientPayloadType {
-  WithdrawRequest = "Bluefin Pro Withdrawal",
-  OrderRequest = "Bluefin Pro Order",
-  LeverageAdjustment = "Bluefin Pro Leverage Adjustment",
-  AuthorizeAccount = "Bluefin Pro Authorize Account",
-  AdjustIsolatedMargin = "Bluefin Pro Margin Adjustment",
-}
-
-enum PositionType {
-  Isolated = "ISOLATED",
-  Cross = "CROSS",
-}
-
-// Interfaces
-interface UIWithdrawRequest {
-  type: string;
-  eds: string;
-  assetSymbol: string;
-  account: string;
-  amount: string;
-  salt: string;
-  signedAt: string;
-}
-
-interface UICreateOrderRequest {
-  type: string;
-  ids: string;
-  account: string;
-  market: string;
-  price: string;
-  quantity: string;
-  leverage: string;
-  side: string;
-  positionType: string;
-  expiration: string;
-  salt: string;
-  signedAt: string;
-}
-
-interface UIUpdateAccountPositionLeverageRequest {
-  type: string;
-  ids: string;
-  account: string;
-  market: string;
-  leverage: string;
-  salt: string;
-  signedAt: string;
-}
-
-interface UIAuthorizeAccountRequest {
-  type: string;
-  ids: string;
-  account: string;
-  user: string;
-  status: boolean;
-  salt: string;
-  signedAt: string;
-}
-
-interface UIDeAuthorizeAccountRequest {
-  type: string;
-  ids: string;
-  account: string;
-  user: string;
-  status: boolean;
-  salt: string;
-  signedAt: string;
-}
-
-interface UIAdjustIsolatedMarginRequest {
-  type: string;
-  ids: string;
-  account: string;
-  market: string;
-  add: boolean;
-  amount: string;
-  salt: string;
-  signedAt: string;
-}
-
-// Conversion functions
-function toUIWithdrawRequest(
-  val: WithdrawRequestSignedFields
-): UIWithdrawRequest {
-  return {
-    type: ClientPayloadType.WithdrawRequest,
-    eds: val.edsId,
-    assetSymbol: val.assetSymbol,
-    account: val.accountAddress,
-    amount: val.amountE9,
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-function toUICreateOrderRequest(
-  val: CreateOrderRequestSignedFields
-): UICreateOrderRequest {
-  return {
-    type: ClientPayloadType.OrderRequest,
-    ids: val.idsId,
-    account: val.accountAddress,
-    market: val.symbol,
-    price: val.priceE9,
-    quantity: val.quantityE9,
-    leverage: val.leverageE9,
-    side: val.side.toString(),
-    positionType: val.isIsolated ? PositionType.Isolated : PositionType.Cross,
-    expiration: val.expiresAtMillis.toString(),
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-function toUIUpdateAccountPositionLeverageRequest(
-  val: AccountPositionLeverageUpdateRequestSignedFields
-): UIUpdateAccountPositionLeverageRequest {
-  return {
-    type: ClientPayloadType.LeverageAdjustment,
-    ids: val.idsId,
-    account: val.accountAddress,
-    market: val.symbol,
-    leverage: val.leverageE9,
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-function toUIAuthorizeAccountRequest(
-  val: AccountAuthorizationRequestSignedFields
-): UIAuthorizeAccountRequest {
-  return {
-    type: ClientPayloadType.AuthorizeAccount,
-    ids: val.idsId,
-    account: val.accountAddress,
-    user: val.authorizedAccountAddress,
-    status: true,
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-function toUIDeAuthorizeAccountRequest(
-  val: AccountAuthorizationRequestSignedFields
-): UIDeAuthorizeAccountRequest {
-  return {
-    type: ClientPayloadType.AuthorizeAccount,
-    ids: val.idsId,
-    account: val.accountAddress,
-    user: val.authorizedAccountAddress,
-    status: false,
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-function toUIAdjustIsolatedMarginRequest(
-  val: AdjustIsolatedMarginRequestSignedFields
-): UIAdjustIsolatedMarginRequest {
-  return {
-    type: ClientPayloadType.AdjustIsolatedMargin,
-    ids: val.idsId,
-    account: val.accountAddress,
-    market: val.symbol,
-    add: val.operation === AdjustMarginOperation.Add,
-    amount: val.quantityE9,
-    salt: val.salt,
-    signedAt: val.signedAtMillis.toString(),
-  };
-}
-
-// ---------- Utils ----------
-
-function toJson(
-  val:
-    | UICreateOrderRequest
-    | UIUpdateAccountPositionLeverageRequest
-    | UIWithdrawRequest
-    | UIAuthorizeAccountRequest
-    | UIDeAuthorizeAccountRequest
-    | UIAdjustIsolatedMarginRequest
-): string {
-  return JSON.stringify(val, null, 2);
-}
-
-// --------------------------------
-
-export class BluefinRequestSigner implements IBluefinSigner {
-  constructor(
-    private readonly wallet: Pick<Signer, "signPersonalMessage"> & ISigner
-  ) {}
-
-  /**
-   * Sign the login request
-   */
-  async signLoginRequest(loginRequest: LoginRequest): Promise<string> {
-    const loginRequestJson = JSON.stringify(loginRequest);
-
-    const signedMessage = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(loginRequestJson)
-    );
-    return signedMessage.signature;
-  }
-
-  /**
-   * Sign an order request
-   */
-  async signOrderRequest(
-    signedFields: CreateOrderRequestSignedFields
-  ): Promise<string> {
-    const orderJson = toJson(toUICreateOrderRequest(signedFields));
-
-    const signedMessageSerialized = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(orderJson)
-    );
-
-    const parsedSignature = parseSerializedSignature(
-      signedMessageSerialized.signature
-    );
-
-    if (parsedSignature.signatureScheme == "MultiSig") {
-      throw new Error("MultiSig not supported");
-    }
-
-    return signedMessageSerialized.signature;
-  }
-
-  /**
-   * Sign a withdraw request
-   */
-  async signWithdrawRequest(
-    withdrawRequestSignedFields: WithdrawRequestSignedFields
-  ): Promise<string> {
-    const requestJson = toJson(
-      toUIWithdrawRequest(withdrawRequestSignedFields)
-    );
-
-    const signedMessageSerialized = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(requestJson)
-    );
-
-    const parsedSignature = parseSerializedSignature(
-      signedMessageSerialized.signature
-    );
-
-    if (parsedSignature.signatureScheme == "MultiSig") {
-      throw new Error("MultiSig not supported");
-    }
-
-    return signedMessageSerialized.signature;
-  }
-
-  /**
-   * Sign a leverage update request
-   */
-  async signLeverageUpdateRequest(
-    signedFields: AccountPositionLeverageUpdateRequestSignedFields
-  ): Promise<string> {
-    const requestJson = toJson(
-      toUIUpdateAccountPositionLeverageRequest(signedFields)
-    );
-
-    const signedMessageSerialized = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(requestJson)
-    );
-
-    const parsedSignature = parseSerializedSignature(
-      signedMessageSerialized.signature
-    );
-
-    if (parsedSignature.signatureScheme == "MultiSig") {
-      throw new Error("MultiSig not supported");
-    }
-
-    return signedMessageSerialized.signature;
-  }
-
-  /**
-   * Sign an account authorization request
-   */
-  async signAccountAuthorizationRequest(
-    signedFields: AccountAuthorizationRequestSignedFields,
-    is_authorize: boolean
-  ): Promise<string> {
-    const requestJson = toJson(
-      is_authorize
-        ? toUIAuthorizeAccountRequest(signedFields)
-        : toUIDeAuthorizeAccountRequest(signedFields)
-    );
-
-    const signedMessageSerialized = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(requestJson)
-    );
-
-    const parsedSignature = parseSerializedSignature(
-      signedMessageSerialized.signature
-    );
-
-    if (parsedSignature.signatureScheme == "MultiSig") {
-      throw new Error("MultiSig not supported");
-    }
-
-    return signedMessageSerialized.signature;
-  }
-
-  /**
-   * Sign an isolated margin adjustment request
-   */
-  async signAdjustIsolatedMarginRequest(
-    signedFields: AdjustIsolatedMarginRequestSignedFields
-  ): Promise<string> {
-    const requestJson = toJson(
-      toUIAdjustIsolatedMarginRequest(signedFields)
-    );
-
-    const signedMessageSerialized = await this.wallet.signPersonalMessage(
-      new TextEncoder().encode(requestJson)
-    );
-
-    const parsedSignature = parseSerializedSignature(
-      signedMessageSerialized.signature
-    );
-
-    if (parsedSignature.signatureScheme == "MultiSig") {
-      throw new Error("MultiSig not supported");
-    }
-
-    return signedMessageSerialized.signature;
-  }
-
-  async executeTx(txb: TransactionBlock, suiClient: SuiClient) {
-    return SuiBlocks.execCall(txb, suiClient, this.wallet, false, this.wallet.isUIWallet());
-  }
-
-  /**
-   * Get the wallet's address
-   */
-  getAddress(): string {
-    return this.wallet.toSuiAddress();
-  }
-
-  /**
-   * Get the wallet type (ui wallet or backend)
-   */
-  isUIWallet(): boolean {
-      return this.wallet.isUIWallet();
-  }
-}