@nadohq/shared 0.1.0-alpha.4

package/src/abis/WithdrawPool.ts

@@ -0,0 +1,277 @@
+export const WITHDRAW_POOL_ABI = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: 'uint8',
+        name: 'version',
+        type: 'uint8',
+      },
+    ],
+    name: 'Initialized',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'previousOwner',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'newOwner',
+        type: 'address',
+      },
+    ],
+    name: 'OwnershipTransferred',
+    type: 'event',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint64[]',
+        name: 'idxs',
+        type: 'uint64[]',
+      },
+    ],
+    name: 'checkMarkedIdxs',
+    outputs: [
+      {
+        internalType: 'bool[]',
+        name: '',
+        type: 'bool[]',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint32[]',
+        name: 'productIds',
+        type: 'uint32[]',
+      },
+    ],
+    name: 'checkProductBalances',
+    outputs: [
+      {
+        internalType: 'uint256[]',
+        name: '',
+        type: 'uint256[]',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'contract IERC20Base',
+        name: 'token',
+        type: 'address',
+      },
+      {
+        internalType: 'uint32',
+        name: 'productId',
+        type: 'uint32',
+      },
+      {
+        internalType: 'uint128',
+        name: 'amount',
+        type: 'uint128',
+      },
+    ],
+    name: 'fastWithdrawalFeeAmount',
+    outputs: [
+      {
+        internalType: 'int128',
+        name: '',
+        type: 'int128',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint32',
+        name: '',
+        type: 'uint32',
+      },
+    ],
+    name: 'fees',
+    outputs: [
+      {
+        internalType: 'int128',
+        name: '',
+        type: 'int128',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_clearinghouse',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: '_verifier',
+        type: 'address',
+      },
+    ],
+    name: 'initialize',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint64',
+        name: '',
+        type: 'uint64',
+      },
+    ],
+    name: 'markedIdxs',
+    outputs: [
+      {
+        internalType: 'bool',
+        name: '',
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'minIdx',
+    outputs: [
+      {
+        internalType: 'uint64',
+        name: '',
+        type: 'uint64',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'owner',
+    outputs: [
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint32',
+        name: 'productId',
+        type: 'uint32',
+      },
+      {
+        internalType: 'uint128',
+        name: 'amount',
+        type: 'uint128',
+      },
+      {
+        internalType: 'address',
+        name: 'sendTo',
+        type: 'address',
+      },
+    ],
+    name: 'removeLiquidity',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'renounceOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint64',
+        name: 'idx',
+        type: 'uint64',
+      },
+      {
+        internalType: 'bytes',
+        name: 'transaction',
+        type: 'bytes',
+      },
+      {
+        internalType: 'bytes[]',
+        name: 'signatures',
+        type: 'bytes[]',
+      },
+    ],
+    name: 'submitFastWithdrawal',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'contract IERC20Base',
+        name: 'token',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: 'sendTo',
+        type: 'address',
+      },
+      {
+        internalType: 'uint128',
+        name: 'amount',
+        type: 'uint128',
+      },
+      {
+        internalType: 'uint64',
+        name: 'idx',
+        type: 'uint64',
+      },
+    ],
+    name: 'submitWithdrawal',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: 'newOwner',
+        type: 'address',
+      },
+    ],
+    name: 'transferOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+] as const;

package/src/abis/index.ts

@@ -0,0 +1,9 @@
+export * from './ERC20';
+export * from './MockERC20';
+export * from './WithdrawPool';
+export * from './SpotEngine';
+export * from './Querier';
+export * from './PerpEngine';
+export * from './Endpoint';
+export * from './Clearinghouse';
+export * from './nadoAbis';

package/src/abis/nadoAbis.ts

@@ -0,0 +1,19 @@
+import { CLEARINGHOUSE_ABI } from './Clearinghouse';
+import { ENDPOINT_ABI } from './Endpoint';
+import { PERP_ENGINE_ABI } from './PerpEngine';
+import { QUERIER_ABI } from './Querier';
+import { SPOT_ENGINE_ABI } from './SpotEngine';
+import { WITHDRAW_POOL_ABI } from './WithdrawPool';
+
+export const NADO_ABIS = {
+  querier: QUERIER_ABI,
+  endpoint: ENDPOINT_ABI,
+  clearinghouse: CLEARINGHOUSE_ABI,
+  spotEngine: SPOT_ENGINE_ABI,
+  perpEngine: PERP_ENGINE_ABI,
+  withdrawPool: WITHDRAW_POOL_ABI,
+} as const;
+
+export type NadoAbis = typeof NADO_ABIS;
+
+export type NadoContractName = keyof NadoAbis;

package/src/consts/chainEnvToChain.ts

@@ -0,0 +1,16 @@
+import { Chain } from 'viem';
+import { arbitrum, inkSepolia, localhost } from 'viem/chains';
+import { ChainEnv } from '../types';
+
+export const CHAIN_ENV_TO_CHAIN = {
+  local: localhost,
+  arbitrum: arbitrum,
+  inkTestnet: inkSepolia,
+} as const satisfies Record<ChainEnv, Chain>;
+
+export const CHAIN_ID_TO_CHAIN_ENV = Object.fromEntries(
+  Object.entries(CHAIN_ENV_TO_CHAIN).map(([chainEnv, chain]) => [
+    chain.id,
+    chainEnv,
+  ]),
+) as Record<number, ChainEnv>;

package/src/consts/index.ts

@@ -0,0 +1,2 @@
+export * from './chainEnvToChain';
+export * from './productIds';

package/src/consts/productIds.ts

@@ -0,0 +1,3 @@
+export const QUOTE_PRODUCT_ID = 0;
+
+export const NLP_PRODUCT_ID = 153;

package/src/deployments/core/deployment.InkSepolia.json

@@ -0,0 +1,13 @@
+{
+  "nodeUrl": "https://rpc-gel-sepolia.inkonchain.com",
+  "explorerUrl": "https://explorer-sepolia.inkonchain.com",
+  "startBlock": 27233833,
+  "deployer": "0x8177A1b5bFaAa10A4b1178c6D42aDaa4b75c8146",
+  "quote": "0x5F65358d61A9a281ea3BB930d05889ACa21E3f4f",
+  "querier": "0x5A62e748b2630560Ffe9E928780cF9Fe0e086A21",
+  "clearinghouse": "0x5E9b4336104069467E57E843033e62c79C667F8F",
+  "endpoint": "0xf8963f7860aF7DE9b94893EDb9A3b5c155e1Fc0c",
+  "spotEngine": "0x61AA7A636df5e72eBe34c70a340eB76ABB3A15bE",
+  "perpEngine": "0x3D6Ac7105cA399884739a8CC19cAdB4178844466",
+  "withdrawPool": "0xa59613a3e4ce46E20d83b0632E3D857e3f116F66"
+}

package/src/deployments/core/deployment.arbitrumOne.json

@@ -0,0 +1,18 @@
+{
+  "nodeUrl": "https://arb1.arbitrum.io/rpc",
+  "explorerUrl": "https://explorer.arbitrum.io",
+  "subgraphCoreUrl": "https://api.thegraph.com/subgraphs/name/nado-protocol/nado-prod-core",
+  "subgraphMarketsUrl": "https://api.thegraph.com/subgraphs/name/nado-protocol/nado-prod-markets",
+  "subgraphCandleSticksUrl": "https://api.thegraph.com/subgraphs/name/nado-protocol/nado-prod-candlesticks",
+  "startBlock": 67108377,
+  "deployer": "0xB746472C10f9F128FF9F5029f424cC91bb1D8C3a",
+  "quote": "0xff970a61a04b1ca14834a43f5de4533ebddb5cc8",
+  "querier": "0x1693273B443699bee277eCbc60e2C8027E91995d",
+  "feeCalculator": "0x2259440579447D0625a5E28dfF3E743d207e8890",
+  "clearinghouse": "0xAE1ec28d6225dCE2ff787dcb8CE11cF6D3AE064f",
+  "clearinghouseLiq": "0xca007C51Fc14eEA88252Cc4FD71e91E44026F020",
+  "endpoint": "0xbbEE07B3e8121227AfCFe1E2B82772246226128e",
+  "spotEngine": "0x32d91Af2B17054D575A7bF1ACfa7615f41CCEfaB",
+  "perpEngine": "0xb74C78cca0FADAFBeE52B2f48A67eE8c834b5fd1",
+  "withdrawPool": "0x3567a1f8d79046A7e93Fd76d71104A978cDC6d05"
+}

package/src/deployments/core/deployment.localhost.json

@@ -0,0 +1,18 @@
+{
+  "nodeUrl": "http://0.0.0.0:8545",
+  "explorerUrl": "",
+  "subgraphCoreUrl": "http://localhost:8000/subgraphs/name/nado-subgraphs-core",
+  "subgraphMarketsUrl": "http://localhost:8000/subgraphs/name/nado-subgraphs-markets",
+  "subgraphCandleSticksUrl": "http://localhost:8000/subgraphs/name/nado-subgraphs-candlesticks",
+  "startBlock": 0,
+  "deployer": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+  "quote": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+  "querier": "0x4ed7c70F96B99c776995fB64377f0d4aB3B0e1C1",
+  "feeCalculator": "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e",
+  "clearinghouse": "0xa513E6E4b8f2a923D98304ec87F64353C4D5C853",
+  "clearinghouseLiq": "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9",
+  "endpoint": "0x8A791620dd6260079BF849Dc5567aDC3F2FdC318",
+  "spotEngine": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82",
+  "perpEngine": "0x0B306BF915C4d645ff596e518fAf3F9669b97016",
+  "withdrawPool": "0x3Aa5ebB10DC797CAC828524e59A333d0A371443c"
+}

package/src/deployments/index.ts

@@ -0,0 +1,40 @@
+import { Address } from 'viem';
+import { NadoContractName } from '../abis/nadoAbis';
+
+import { ChainEnv } from '../types';
+import { getValidatedAddress } from '../utils/getValidatedAddress';
+import ArbitrumOneCoreDeployment from './core/deployment.arbitrumOne.json' with { type: 'json' };
+import InkSepoliaCoreDeployment from './core/deployment.InkSepolia.json' with { type: 'json' };
+import LocalCoreDeployment from './core/deployment.localhost.json' with { type: 'json' };
+
+export type NadoDeploymentAddresses = {
+  [name in NadoContractName]: Address;
+};
+
+/**
+ * Known deployment addresses for the Nado contracts
+ */
+export const NADO_DEPLOYMENTS: Record<ChainEnv, NadoDeploymentAddresses> = {
+  arbitrum: validateDeployment({
+    ...ArbitrumOneCoreDeployment,
+  }),
+  inkTestnet: validateDeployment({
+    ...InkSepoliaCoreDeployment,
+  }),
+  local: validateDeployment({
+    ...LocalCoreDeployment,
+  }),
+};
+
+function validateDeployment(
+  deployment: Record<NadoContractName, string>,
+): Record<NadoContractName, Address> {
+  return {
+    clearinghouse: getValidatedAddress(deployment.clearinghouse),
+    endpoint: getValidatedAddress(deployment.endpoint),
+    perpEngine: getValidatedAddress(deployment.perpEngine),
+    querier: getValidatedAddress(deployment.querier),
+    spotEngine: getValidatedAddress(deployment.spotEngine),
+    withdrawPool: getValidatedAddress(deployment.withdrawPool),
+  };
+}

package/src/eip712/eip712ValueTypes.ts

@@ -0,0 +1,83 @@
+import { Hex } from 'viem';
+import { BigDecimalish } from '../utils/math';
+import {
+  EIP712BurnNlpParams,
+  EIP712CancelOrdersParams,
+  EIP712CancelProductOrdersParams,
+  EIP712LeaderboardAuthenticationParams,
+  EIP712LinkSignerParams,
+  EIP712LiquidateSubaccountParams,
+  EIP712ListTriggerOrdersParams,
+  EIP712MintNlpParams,
+  EIP712OrderParams,
+  EIP712TransferQuoteParams,
+  EIP712WithdrawCollateralParams,
+} from './signatureParamTypes';
+
+type WithEIP712Sender<
+  T extends { subaccountOwner: string; subaccountName: string },
+> = Omit<T, 'subaccountOwner' | 'subaccountName'> & {
+  // Hex encoded bytes32
+  sender: Hex;
+};
+
+export type EIP712WithdrawCollateralValues =
+  WithEIP712Sender<EIP712WithdrawCollateralParams>;
+
+export type EIP712LiquidateSubaccountValues = Omit<
+  WithEIP712Sender<EIP712LiquidateSubaccountParams>,
+  'liquidateeOwner' | 'liquidateeName'
+> & {
+  // Hex encoded bytes32
+  liquidatee: string;
+};
+
+export type EIP712OrderValues = Omit<
+  WithEIP712Sender<EIP712OrderParams>,
+  'price'
+> & {
+  priceX18: BigDecimalish;
+};
+
+export type EIP712ListTriggerOrdersValues =
+  WithEIP712Sender<EIP712ListTriggerOrdersParams>;
+
+export type EIP712OrderCancellationValues =
+  WithEIP712Sender<EIP712CancelOrdersParams>;
+
+export type EIP712ProductOrdersCancellationValues =
+  WithEIP712Sender<EIP712CancelProductOrdersParams>;
+
+export type EIP712LinkSignerValues = WithEIP712Sender<EIP712LinkSignerParams>;
+
+export type EIP712TransferQuoteValues = Omit<
+  WithEIP712Sender<EIP712TransferQuoteParams>,
+  'recipientSubaccountName'
+> & {
+  // Hex encoded bytes32
+  recipient: string;
+};
+
+export type EIP712LeaderboardAuthenticationValues =
+  WithEIP712Sender<EIP712LeaderboardAuthenticationParams>;
+
+export type EIP712MintNlpValues = WithEIP712Sender<EIP712MintNlpParams>;
+
+export type EIP712BurnNlpValues = WithEIP712Sender<EIP712BurnNlpParams>;
+
+/**
+ * All possible requests to be signed, to the EIP712 value interface
+ */
+export interface SignableRequestTypeToEIP712Values {
+  burn_nlp: EIP712BurnNlpValues;
+  cancel_orders: EIP712OrderCancellationValues;
+  cancel_product_orders: EIP712ProductOrdersCancellationValues;
+  leaderboard_authentication: EIP712LeaderboardAuthenticationValues;
+  link_signer: EIP712LinkSignerValues;
+  liquidate_subaccount: EIP712LiquidateSubaccountValues;
+  list_trigger_orders: EIP712ListTriggerOrdersValues;
+  mint_nlp: EIP712MintNlpValues;
+  place_order: EIP712OrderValues;
+  transfer_quote: EIP712TransferQuoteValues;
+  withdraw_collateral: EIP712WithdrawCollateralValues;
+}

package/src/eip712/getNadoEIP712Domain.ts

@@ -0,0 +1,20 @@
+import { getValidatedAddress } from '../utils/getValidatedAddress';
+import { TypedDataDomain } from 'abitype';
+
+/**
+ * Gives the EIP712 data domain for order signing
+ *
+ * @param contractAddress usually the address of the orderbook (for orders) or sequencer (for other operations)
+ * @param chainId
+ */
+export function getNadoEIP712Domain(
+  contractAddress: string,
+  chainId: number,
+): TypedDataDomain {
+  return {
+    name: 'Nado',
+    version: '0.0.1',
+    chainId,
+    verifyingContract: getValidatedAddress(contractAddress),
+  };
+}

package/src/eip712/getNadoEIP712PrimaryType.ts

@@ -0,0 +1,13 @@
+import { getNadoEIP712Types } from './getNadoEIP712Types';
+import { SignableRequestType } from './signableRequestType';
+
+/**
+ * Return the primary EIP712 type for a given request
+ *
+ * @param requestType
+ */
+export function getNadoEIP712PrimaryType(requestType: SignableRequestType) {
+  const types = getNadoEIP712Types(requestType);
+  // We assume the first key is the primary type. Currently, all Nado EIP712 messages only have one type
+  return Object.keys(types)[0];
+}

package/src/eip712/getNadoEIP712Types.ts

@@ -0,0 +1,113 @@
+import { SignableRequestType } from './signableRequestType';
+
+interface TypedDataField {
+  name: string;
+  type: string;
+}
+
+/**
+ * Return the EIP712 types for a given request
+ *
+ * @param requestType
+ */
+export function getNadoEIP712Types(
+  requestType: SignableRequestType,
+): Record<string, Array<TypedDataField>> {
+  switch (requestType) {
+    case 'withdraw_collateral':
+      return {
+        WithdrawCollateral: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'productId', type: 'uint32' },
+          { name: 'amount', type: 'uint128' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'place_order':
+      return {
+        Order: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'priceX18', type: 'int128' },
+          { name: 'amount', type: 'int128' },
+          { name: 'expiration', type: 'uint64' },
+          { name: 'nonce', type: 'uint64' },
+          { name: 'appendix', type: 'uint128' },
+        ],
+      };
+    case 'list_trigger_orders':
+      return {
+        ListTriggerOrders: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'recvTime', type: 'uint64' },
+        ],
+      };
+    case 'cancel_orders':
+      return {
+        Cancellation: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'productIds', type: 'uint32[]' },
+          { name: 'digests', type: 'bytes32[]' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'cancel_product_orders':
+      return {
+        CancellationProducts: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'productIds', type: 'uint32[]' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'liquidate_subaccount':
+      return {
+        LiquidateSubaccount: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'liquidatee', type: 'bytes32' },
+          { name: 'mode', type: 'uint8' },
+          { name: 'healthGroup', type: 'uint32' },
+          { name: 'amount', type: 'int128' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'link_signer':
+      return {
+        LinkSigner: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'signer', type: 'bytes32' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'transfer_quote':
+      return {
+        TransferQuote: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'recipient', type: 'bytes32' },
+          { name: 'amount', type: 'uint128' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'leaderboard_authentication':
+      return {
+        LeaderboardAuthentication: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'expiration', type: 'uint64' },
+        ],
+      };
+    case 'mint_nlp':
+      return {
+        MintNlp: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'quoteAmount', type: 'uint128' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+    case 'burn_nlp':
+      return {
+        BurnNlp: [
+          { name: 'sender', type: 'bytes32' },
+          { name: 'nlpAmount', type: 'uint128' },
+          { name: 'nonce', type: 'uint64' },
+        ],
+      };
+  }
+}