@hawksightco/hawk-sdk 0.0.4

package/README.md

@@ -0,0 +1,3 @@
+# Hawksight SDK
+
+Still under development. Early release.

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@hawksightco/hawk-sdk",
+  "version": "0.0.4",
+  "description": "Hawksight v2 SDK",
+  "main": "dist/index.js",
+  "repository": "https://github.com/ghabxph/hawk-api-client.git",
+  "homepage": "https://hawksight.co/",
+  "author": "Hawksight",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/bn.js": "^5.1.5",
+    "@types/jest": "^29.5.11",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^20.11.5",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.3",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.89.1",
+    "@hawksightco/swagger-client": "0.0.3",
+    "axios": "^1.6.5",
+    "bn.js": "^5.2.1",
+    "bs58": "^5.0.0",
+    "fp-ts": "^2.16.5",
+    "io-ts": "^2.2.21",
+    "io-ts-types": "^0.5.19",
+    "lodash": "^4.17.21",
+    "zod": "^3.22.4"
+  },
+  "scripts": {
+    "start": "npx ts-node src/index.ts",
+    "test": "npx jest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,382 @@
+import * as web3 from "@solana/web3.js";
+import * as client from "@hawksightco/swagger-client";
+import { HealthResponse, MeteoraDlmmActiveBin, ResponseWithStatus, TransactionMetadata, TransactionMetadataResponse, UserPortfolioOut } from "./types";
+
+class Client {
+  public readonly config: client.Configuration;
+  public readonly healthCheck: client.HealthCheckApi;
+  public readonly generalEndpoints: client.GeneralEndpointsApi;
+  public readonly meteoraDLMMUtilityFunctionsApi: client.MeteoraDLMMUtilityFunctionsApi;
+  public readonly meteoraDLMMInstructionsApi: client.MeteoraDLMMInstructionsApi;
+  public readonly meteoraDLMMAutomationInstructionsApi: client.MeteoraDLMMAutomationInstructionsApi;
+  public readonly orcaUtilityFunctionsApi: client.OrcaUtilityFunctionsApi;
+  public readonly orcaCLMMInstructionsApi: client.OrcaCLMMInstructionsApi;
+  constructor(
+    public readonly url: string = "https://api2.hawksight.co",
+  ) {
+    this.config = new client.Configuration({
+      basePath: url
+    });
+    this.healthCheck = new client.HealthCheckApi(this.config);
+    this.generalEndpoints = new client.GeneralEndpointsApi(this.config);
+    this.meteoraDLMMUtilityFunctionsApi = new client.MeteoraDLMMUtilityFunctionsApi(this.config);
+    this.meteoraDLMMInstructionsApi = new client.MeteoraDLMMInstructionsApi(this.config);
+    this.meteoraDLMMAutomationInstructionsApi = new client.MeteoraDLMMAutomationInstructionsApi(this.config);
+    this.orcaUtilityFunctionsApi = new client.OrcaUtilityFunctionsApi(this.config);
+    this.orcaCLMMInstructionsApi = new client.OrcaCLMMInstructionsApi(this.config);
+  }
+}
+
+class Health {
+  constructor(
+    private readonly client: Client,
+  ) {}
+  async health(): Promise<ResponseWithStatus<HealthResponse>> {
+    const result = await this.client.healthCheck.healthGet().catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+}
+
+class General {
+  constructor(
+    private readonly client: Client,
+  ) {}
+
+  async portfolio(
+    params: {
+      wallet: string,
+      pool?: string,
+    }
+  ): Promise<ResponseWithStatus<UserPortfolioOut>> {
+    const result = await this.client.generalEndpoints.portfolioGet(params.wallet, params.pool).catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    }
+  }
+  async pools(): Promise<ResponseWithStatus<client.InlineResponse2002[]>> {
+    const result = await this.client.generalEndpoints.poolsGet().catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async tokens(): Promise<ResponseWithStatus<client.InlineResponse2003[]>> {
+    const result = await this.client.generalEndpoints.tokensGet().catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async register(connection: web3.Connection, payer: string, params: client.RegisterBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.generalEndpoints.registerPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+}
+
+class Util {
+  constructor(
+    private readonly client: Client,
+  ) {}
+
+  async meteoraDlmmPools(): Promise<ResponseWithStatus<client.InlineResponse2005[]>> {
+    const result = await this.client.meteoraDLMMUtilityFunctionsApi.meteoraDlmmUtilPoolsGet().catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async meteoraDlmmPositions(
+    params: {
+      wallet: string,
+      pool?: string,
+    }
+  ): Promise<ResponseWithStatus<any>> {
+    const result = await this.client.meteoraDLMMUtilityFunctionsApi.meteoraDlmmUtilPositionsGet(params.wallet, params.pool).catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async meteoraDlmmActiveBin(params: client.UtilActiveBinBody): Promise<ResponseWithStatus<MeteoraDlmmActiveBin>> {
+    const result = await this.client.meteoraDLMMUtilityFunctionsApi.meteoraDlmmUtilActiveBinPost(params).catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async orcaClmmPools(): Promise<ResponseWithStatus<any>> {
+    const result = await this.client.orcaUtilityFunctionsApi.orcaUtilPoolsGet().catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async orcaPositions(
+    params: {
+      wallet: string,
+      pool?: string,
+    }
+  ): Promise<ResponseWithStatus<any>> {
+    const result = await this.client.orcaUtilityFunctionsApi.orcaUtilPositionsGet(params.wallet, params.pool).catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+
+  async orcaGetPositionMint(
+    params: {
+      position: string,
+    }
+  ): Promise<ResponseWithStatus<any>> {
+    const result = await this.client.orcaUtilityFunctionsApi.orcaUtilGetPositionMintGet(params.position).catch(e => e.response);
+    return {
+      status: result.status,
+      data: result.data,
+    };
+  }
+}
+
+class TxGenerator {
+  constructor(
+    private readonly client: Client,
+  ) {}
+
+  async meteoraCreatePositionAndDeposit(connection: web3.Connection, payer: string, params: client.TxCreatePositionAndDepositBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMInstructionsApi.meteoraDlmmTxCreatePositionAndDepositPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data)
+    );
+  }
+
+  async meteoraDeposit(connection: web3.Connection, payer: string, params: client.TxDepositBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMInstructionsApi.meteoraDlmmTxDepositPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async meteoraWithdraw(connection: web3.Connection, payer: string, params: client.TxWithdrawBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMInstructionsApi.meteoraDlmmTxWithdrawPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async meteoraClaim(connection: web3.Connection, payer: string, params: client.TxClaimBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMInstructionsApi.meteoraDlmmTxClaimPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async meteoraClosePosition(connection: web3.Connection, payer: string, params: client.TxClosePositionBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMInstructionsApi.meteoraDlmmTxClosePositionPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async orcaOpenPosition(connection: web3.Connection, payer: string, params: client.TxOpenPositionBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.orcaCLMMInstructionsApi.orcaTxOpenPositionPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async orcaClosePosition(connection: web3.Connection, payer: string, params: client.TxClosePositionBody1): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.orcaCLMMInstructionsApi.orcaTxClosePositionPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async orcaDeposit(connection: web3.Connection, payer: string, params: client.TxDepositBody1): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.orcaCLMMInstructionsApi.orcaTxDepositPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async orcaWithdraw(connection: web3.Connection, payer: string, params: client.TxWithdrawBody1): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.orcaCLMMInstructionsApi.orcaTxWithdrawPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async orcaClaimRewards(connection: web3.Connection, payer: string, params: client.TxClaimRewardsBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.orcaCLMMInstructionsApi.orcaTxClaimRewardsPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+}
+
+class TxGeneratorAutomations {
+  constructor(
+    private readonly client: Client,
+  ) {}
+
+  async meteoraClaimFeeAndRewards(connection: web3.Connection, payer: string, params: client.AutomationClaimFeeAndRewardsAutomationIxBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMAutomationInstructionsApi.meteoraDlmmAutomationClaimFeeAndRewardsAutomationIxPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async meteoraFullWithdrawalAndClosePosition(connection: web3.Connection, payer: string, params: client.AutomationFullWithdrawAndClosePositionAutomationIxBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMAutomationInstructionsApi.meteoraDlmmAutomationFullWithdrawAndClosePositionAutomationIxPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+
+  async meteoraCreatePositionAndDeposit(connection: web3.Connection, payer: string, params: client.AutomationCreatePositionAndDepositAutomationIxBody): Promise<ResponseWithStatus<TransactionMetadataResponse> | ResponseWithStatus<TransactionMetadata>> {
+    const result = await this.client.meteoraDLMMAutomationInstructionsApi.meteoraDlmmAutomationCreatePositionAndDepositAutomationIxPost(params).catch(e => e.response);
+    return resultOrError<TransactionMetadataResponse, TransactionMetadata>(
+      {
+        status: result.status,
+        data: result.data,
+      },
+      async (data) => await createTxMetadata(connection, payer, data),
+    );
+  }
+}
+
+class HawkAPI {
+  public readonly health: Health;
+  public readonly general: General;
+  public readonly util: Util;
+  public readonly txGenerator: TxGenerator;
+  public readonly txGeneratorAutomation: TxGeneratorAutomations;
+  constructor(
+    protected readonly url: string = "https://api2.hawksight.co",
+  ) {
+    const client = new Client(url);
+    this.health = new Health(client);
+    this.general = new General(client);
+    this.util = new Util(client);
+    this.txGenerator = new TxGenerator(client);
+    this.txGeneratorAutomation = new TxGeneratorAutomations(client);
+  }
+}
+
+export default HawkAPI;
+
+async function createTxMetadata(connection: web3.Connection, payer: string, data: TransactionMetadataResponse): Promise<TransactionMetadata> {
+  const alts: web3.AddressLookupTableAccount[] = [];
+  for (const alt of data.addressLookupTableAddresses) {
+    alts.push(
+      (await connection.getAddressLookupTable(new web3.PublicKey(alt))).value as web3.AddressLookupTableAccount
+    );
+  }
+  const computeIxs = data.computeBudgetInstructions.map(ix => {
+    return new web3.TransactionInstruction({
+      keys: ix.accounts.map(meta => {
+        return { pubkey: new web3.PublicKey(meta.pubkey), isSigner: meta.isSigner, isWritable: meta.isWritable };
+      }),
+      programId: new web3.PublicKey(ix.programId),
+      data: Buffer.from(ix.data, 'base64'),
+    });
+  });
+  const mainIxs = data.computeBudgetInstructions.map(ix => {
+    return new web3.TransactionInstruction({
+      keys: ix.accounts.map(meta => {
+        return { pubkey: new web3.PublicKey(meta.pubkey), isSigner: meta.isSigner, isWritable: meta.isWritable };
+      }),
+      programId: new web3.PublicKey(ix.programId),
+      data: Buffer.from(ix.data, 'base64'),
+    });
+  });
+  const { blockhash: recentBlockhash } = await connection.getLatestBlockhash();
+  const txMessage = new web3.TransactionMessage({
+    payerKey: new web3.PublicKey(payer),
+    instructions: [...computeIxs, ...mainIxs],
+    recentBlockhash,
+  });
+  const tx = new web3.VersionedTransaction(txMessage.compileToV0Message(alts));
+  return {
+    description: data.description,
+    estimatedFeeInSOL: data.estimatedFeeInSOL,
+    transaction: tx.serialize(),
+  }
+}
+
+async function resultOrError<Response, Out>(result: { status: number, data: Response }, successFn: (data: Response) => Promise<Out>): Promise<ResponseWithStatus<Out> | ResponseWithStatus<Response>> {
+  if (result.status === 200) {
+    return {
+      status: result.status,
+      data: await successFn(result.data),
+    };
+  } else {
+    return {
+      status: result.status,
+      data: result.data,
+    }
+  }
+}

package/src/types.ts

@@ -0,0 +1,248 @@
+import * as web3 from "@solana/web3.js";
+import BN from "bn.js";
+
+export type AccountMeta = {
+  isSigner: boolean,
+  isWritable: boolean,
+  pubkey: string,
+}
+
+export type TransactionInstruction = {
+  programId: string,
+  keys: AccountMeta[],
+  data: string
+};
+
+export type Transaction = TransactionInstruction[];
+
+export type Web3Transaction = web3.TransactionInstruction[];
+
+export type BinRange = {
+  lowerRange: number,
+  upperRange: number,
+}
+
+export type Distribution = "SPOT" | "CURVE" | "BID-ASK";
+
+export type MeteoraCreatePositionAndDeposit = {
+  position: web3.PublicKey,
+  pool: string,
+  userWallet: web3.PublicKey,
+  totalXAmount: BN,
+  totalYAmount: BN,
+  binRange: BinRange,
+  distribution: Distribution,
+};
+
+export type MeteoraDeposit = {
+  position: web3.PublicKey,
+  pool: string,
+  userWallet: web3.PublicKey,
+  totalXAmount: BN,
+  totalYAmount: BN,
+  distribution: Distribution,
+};
+
+export type MeteoraPoolInfo = {
+  address: string,
+  name: string,
+  mint_x: string,
+  mint_y: string,
+  reserve_x: string,
+  reserve_y: string,
+  reserve_x_amount: number,
+  reserve_y_amount: number,
+  bin_step: number,
+  base_fee_percentage: string,
+  max_fee_percentage: string,
+  protocol_fee_percentage: string,
+  liquidity: string,
+  reward_mint_x: string,
+  reward_mint_y: string,
+  fees_24h: number,
+  today_fees: number,
+  trade_volume_24h: number,
+  cumulative_trade_volume: string,
+  cumulative_fee_volume: string,
+  current_price: number,
+  apr: number,
+  apy: number,
+  hide: boolean
+}
+
+export enum Tags {
+  Stable = "stable",
+  Volatile = "volatile",
+  LiquidStaking = "liquid_staking",
+  Stablecoin = "stablecoins",
+  Deprecated = "deprecated",
+}
+
+export enum Protocol {
+  Saber = "saber",
+  Orca = "orca",
+  Meteora = "meteora",
+}
+
+interface BasePool {
+  id: string;
+  name: string;
+  url: string;
+  tags: Tags[];
+  hidden: boolean;
+}
+
+export type Pool =
+  | (BasePool & {
+      protocol: Protocol.Saber;
+      config: SaberPoolConfig; // contains all the related accounts to this strategy
+    })
+  | (BasePool & {
+      protocol: Protocol.Orca;
+      config: OrcaPoolConfig; // contains all the related accounts to this strategy
+    })
+  | (BasePool & {
+      protocol: Protocol.Meteora;
+      config: MeteoraPoolConfig; // contains all the related accounts to this strategy
+    });
+
+export type SaberPoolConfig = {};
+export type OrcaPoolConfig = OrcaPoolInfo;
+export type MeteoraPoolConfig = {
+  address: string,
+  name: string,
+  mint_x: string,
+  mint_y: string,
+  reserve_x: string,
+  reserve_y: string,
+  reward_mint_x: string,
+  reward_mint_y: string,
+  bin_step: number,
+};
+
+export type Token = {
+  address: string;
+  name: string;
+  symbol: string;
+  decimals: number;
+  logo: string;
+};
+
+// This should be serializable to web3.TransactionInstruction
+export type Instruction = {
+  accounts: {
+    isSigner: boolean;
+    isWritable: boolean;
+    pubkey: string;
+  }[];
+  data: string;
+  programId: string;
+};
+
+export type TransactionPriority = "Default" | "Low" | "Medium" | "High" | "VeryHigh" | "UnsafeMax" | "None";
+
+export type Balance = {
+  amount: string;
+  mint: string;
+};
+
+export type UserPositionBalances = {
+  balances: Balance[],
+  fees: Balance[],
+  rewards: Balance[],
+};
+
+export type PoolOut = UserPositionBalances & {
+  positionAddress: string,
+}
+
+export type UserPortfolioOut = {
+  wallet: string,
+  userPda: string,
+  pools: Record<string, PoolOut[]>,
+}
+
+export type OrcaPoolInfo = {
+  address: string,
+  feeApr: {
+    day: number,
+    month: number,
+    week: number,
+  }
+  lpFeeRate: number,
+  modifiedTimeMs: number,
+  price: number,
+  priceRange: {
+    day: { min: number, max: number },
+    month: { min: number, max: number },
+    week: { min: number, max: number },
+  },
+  protocolFeeRate: number,
+  reward0Apr: { day: number, week: number, month: number },
+  reward1Apr: { day: number, week: number, month: number },
+  reward2Apr: { day: number, week: number, month: number },
+  tickSpacing: number,
+  tokenA: {
+    coingeckoId: string,
+    decimals: number,
+    logoURI: string,
+    mint: string,
+    name: string,
+    poolToken: boolean,
+    symbol: string,
+    whitelisted: boolean,
+  }
+  tokenB: {
+    coingeckoId: string,
+    decimals: number,
+    logoURI: string,
+    mint: string,
+    name: string,
+    poolToken: boolean,
+    symbol: string,
+    whitelisted: boolean,
+  },
+  totalApr: { day: number, week: number, month: number },
+  tvl: number,
+  volume: { day: number, week: number, month: number },
+  volumeDenominatedA: { day: number, week: number, month: number },
+  volumeDemonimatedB: { day: number, week: number, month: number },
+  whirlpoolsConfig: string,
+  whitelisted: boolean,
+}
+
+export type OrcaPoolResponse = {
+  whirlpools: OrcaPoolInfo[],
+};
+
+export type OrcaPoolInfoIndexed = Record<string, OrcaPoolInfo>;
+
+export type TokenAccountInfo = {
+  address: web3.PublicKey,
+  owner: web3.PublicKey,
+  mint: web3.PublicKey,
+  amount: BN,
+}
+
+export type ResponseWithStatus<T> = {
+  status: number,
+  data: T
+}
+
+export type HealthResponse = Record<string, "OK" | "NOT OK">;
+
+export type MeteoraDlmmActiveBin = Record<string, number>;
+
+export type TransactionMetadataResponse = {
+  description: string;
+  estimatedFeeInSOL: string,
+  addressLookupTableAddresses: string[]; // "alts" is confusing, copied jup's naming
+  computeBudgetInstructions: Instruction[]; // this enables for ease of access while also making them optional
+  mainInstructions: Instruction[];
+}
+
+export type TransactionMetadata = {
+  description: string,
+  estimatedFeeInSOL: string,
+  transaction: Uint8Array,
+}

package/test/index.spec.ts

@@ -0,0 +1,213 @@
+import * as web3 from "@solana/web3.js";
+import BN from "bn.js";
+import HawkAPI from "../src";
+import { ResponseWithStatus } from "../src/types";
+
+const client = new HawkAPI('http://localhost:5001');
+const TIMEOUT = 30_000;
+const testWallet = 'Ga5jNBh26JHh9zyJcdm7vpyVWRgtKS2cLpNgEc5zBv8G';
+const hawkWallet = 'dche7M2764e8AxNihBdn7uffVzZvTBNeL8x4LZg5E2c';
+const connection = new web3.Connection('https://mainnet-beta.solana.com'); // change this to private rpc
+const testPool = 'ARwi1S4DaiTG5DX7S4M4ZsrXqpMD1MrTmbu9ue2tpmEq';
+const testPosition = '7kbNjgL5SUtcwqpTRbjxkmSDHeYTnPUgEGUQwm1ETdDp';
+let activeBin: number;
+
+describe('Health Endpoints', () => {
+  it ('GET /health', async () => {
+    const result: any = await client.health.health();
+    expect(result.status).toBe(200);
+    for (const key in result.services) {
+      expect(result.services[key]).toBe('OK');
+    }
+  });
+});
+
+describe('General Endpoints', () => {
+  it ('GET /portfolio', async () => {
+    const result = await client.general.portfolio({ wallet: 'Ga5jNBh26JHh9zyJcdm7vpyVWRgtKS2cLpNgEc5zBv8G' });
+    expect(result.status).toBe(200);
+    for (const poolId in result.data.pools) {
+      if (result.data.pools[poolId] !== undefined) {
+        for (const position of result.data.pools[poolId]) {
+          expect(isPublicKey(position.positionAddress)).toBe(true); // Must be a valid public key
+          expect(position.balances.length >= 0).toBe(true); // Must be a valid array
+          expect(position.fees.length >= 0).toBe(true); // Must be a valid array
+          expect(position.rewards.length >= 0).toBe(true); // Must be a valid array
+          for (const balance of position.balances) {
+            expect(isInteger(balance.amount)).toBe(true);
+            expect(isPublicKey(balance.mint)).toBe(true);
+          }
+          for (const balance of position.fees) {
+            expect(isInteger(balance.amount)).toBe(true);
+            expect(isPublicKey(balance.mint)).toBe(true);
+          }
+          for (const balance of position.rewards) {
+            expect(isInteger(balance.amount)).toBe(true);
+            expect(isPublicKey(balance.mint)).toBe(true);
+          }
+        }
+      }
+    }
+  }, TIMEOUT);
+
+  it ('GET /pools', async () => {
+    const result = await client.general.pools();
+    expect(result.status).toBe(200);
+    expect(result.data.length >= 0).toBe(true);
+  }, TIMEOUT);
+
+  it ('POST /register', async () => {
+    const result = await client.general.register(connection, hawkWallet, { userWallet: hawkWallet });
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+});
+
+describe('Meteora Endpoints', () => {
+  it ('POST /meteora/dlmm/util/activeBin', async () => {
+    const result = await client.util.meteoraDlmmActiveBin(
+      {
+        pools: [testPool],
+        commitment: 'confirmed',
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+    activeBin = result.data[testPool];
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/tx/createPositionAndDeposit', async () => {
+    const result = await client.txGenerator.meteoraCreatePositionAndDeposit(
+      connection,
+      hawkWallet,
+      {
+        position: web3.Keypair.generate().publicKey.toString(),
+        pool: testPool,
+        userWallet: testWallet,
+        totalXAmount: 10_000,
+        totalYAmount: 10_000,
+        lowerBinRange: activeBin - 20,
+        upperBinRange: activeBin + 20,
+        distribution: 'CURVE',
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/tx/deposit', async () => {
+    const result = await client.txGenerator.meteoraDeposit(
+      connection,
+      hawkWallet,
+      {
+        position: testPosition,
+        userWallet: testWallet,
+        totalXAmount: 10_000,
+        totalYAmount: 10_000,
+        distribution: 'CURVE',
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/tx/claim', async () => {
+    const result = await client.txGenerator.meteoraClaim(
+      connection,
+      hawkWallet,
+      {
+        position: testPosition,
+        userWallet: testWallet,
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/tx/withdraw', async () => {
+    const result = await client.txGenerator.meteoraWithdraw(
+      connection,
+      hawkWallet,
+      {
+        position: testPosition,
+        userWallet: testWallet,
+        amountBps: 10_000,
+        shouldClaimAndClose: true,
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/tx/closePosition', async () => { // will not work because position is not empty.
+    const result = await client.txGenerator.meteoraClosePosition(
+      connection,
+      hawkWallet,
+      {
+        position: testPosition,
+        userWallet: testWallet,
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+});
+
+describe('Meteora Automation Endpoints', () => {
+  it ('POST /meteora/dlmm/automation/claimFeeAndRewardsAutomationIx', async () => {
+    const result = await client.txGeneratorAutomation.meteoraClaimFeeAndRewards(
+      connection,
+      hawkWallet,
+      {
+        userWallet: testWallet,
+        position: testPosition,
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/automation/fullWithdrawAndClosePositionAutomationIx', async () => {
+    const result = await client.txGeneratorAutomation.meteoraFullWithdrawalAndClosePosition(
+      connection,
+      hawkWallet,
+      {
+        userWallet: testWallet,
+        position: testPosition,
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+  it ('POST /meteora/dlmm/automation/createPositionAndDepositAutomationIx', async () => { // can't test...
+    const result = await client.txGeneratorAutomation.meteoraCreatePositionAndDeposit(
+      connection,
+      hawkWallet,
+      {
+        position: web3.Keypair.generate().publicKey.toString(),
+        pool: testPool,
+        userWallet: testWallet,
+        lowerBinRange: activeBin - 20,
+        upperBinRange: activeBin + 20,
+        distribution: 'CURVE',
+      }
+    );
+    logIfNot200(result);
+    expect(result.status).toBe(200);
+  }, TIMEOUT);
+});
+
+describe('Orca Endpoints', () => {});
+
+function isPublicKey(address: string): boolean {
+  try {
+    new web3.PublicKey(address);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function isInteger(value: string): boolean {
+  return String(parseInt(value)) === value;
+}
+
+function logIfNot200(result: ResponseWithStatus<any>) {
+  if (result.status !== 200) {
+    console.log(result.data);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}