@reyaxyz/sdk 0.16.1 → 0.17.1

package/src/services/sign.ts

@@ -0,0 +1,110 @@
+import { JsonRpcSigner, Signature, Signer, TypedDataField } from 'ethers';
+import { ContractType, getAddress } from '../utils/contractAddresses';
+
+export type EIP712Signature = {
+  v: number;
+  r: string;
+  s: string;
+  deadline: number;
+};
+
+function convertEthersSignatureToEIP712Signature(
+  signature: Signature,
+  deadline: number,
+): EIP712Signature {
+  return {
+    v: signature.v,
+    r: signature.r,
+    s: signature.s,
+    deadline: deadline,
+  };
+}
+
+export async function signCoreCommands(
+  signer: Signer | JsonRpcSigner,
+  chainId: number,
+  accountId: number,
+  nonce: number,
+  deadline: number,
+  // todo: add caller/commands/both once smart contracts are fixed
+): Promise<EIP712Signature> {
+  const signature = await signReyaTypedData(
+    signer,
+    chainId,
+    getAddress(chainId, ContractType.CORE_PROXY),
+    {
+      ExecuteBySig: [
+        { name: 'accountId', type: 'uint128' },
+        { name: 'nonce', type: 'uint256' },
+        { name: 'deadline', type: 'uint256' },
+      ],
+    },
+    {
+      accountId: accountId,
+      nonce: nonce,
+      deadline: deadline,
+    },
+  );
+
+  return convertEthersSignatureToEIP712Signature(signature, deadline);
+}
+
+export async function signPoolRemoveLiquidity(
+  signer: Signer | JsonRpcSigner,
+  chainId: number,
+  owner: string,
+  poolId: number,
+  sharesAmount: bigint,
+  minOut: bigint,
+  nonce: number,
+  deadline: number,
+  // todo: add caller once smart contracts are fixed
+): Promise<EIP712Signature> {
+  const signature = await signReyaTypedData(
+    signer,
+    chainId,
+    getAddress(chainId, ContractType.PASSIVE_POOL_PROXY),
+    {
+      RemoveLiquidityBySig: [
+        { name: 'owner', type: 'address' },
+        { name: 'poolId', type: 'uint128' },
+        { name: 'sharesAmount', type: 'uint256' },
+        { name: 'minOut', type: 'uint256' },
+        { name: 'nonce', type: 'uint256' },
+        { name: 'deadline', type: 'uint256' },
+      ],
+    },
+    {
+      owner: owner,
+      poolId: poolId,
+      sharesAmount: sharesAmount,
+      minOut: minOut,
+      nonce: nonce,
+      deadline: deadline,
+    },
+  );
+
+  return convertEthersSignatureToEIP712Signature(signature, deadline);
+}
+
+async function signReyaTypedData(
+  signer: Signer | JsonRpcSigner,
+  chainId: number,
+  verifyingContract: string,
+  types: Record<string, Array<TypedDataField>>,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  value: Record<string, any>,
+): Promise<Signature> {
+  const signatureString = await signer.signTypedData(
+    {
+      name: 'Reya',
+      version: '1',
+      chainId: chainId,
+      verifyingContract: verifyingContract,
+    },
+    types,
+    value,
+  );
+
+  return Signature.from(signatureString);
+}

package/src/services/token/approve.ts

@@ -1,6 +1,6 @@
 import { ApprovalType, ApproveTokenParams } from './types';
 import { getERC20Allowance, getERC20TokenContract } from './common';
-import { getAddress } from '../../utils/contractAddresses';
+import { ContractType, getAddress } from '../../utils/contractAddresses';
 
 export const approveTokenSpending = async (
   params: ApproveTokenParams,
@@ -17,8 +17,8 @@ export const approveTokenSpending = async (
 
   const contractProxyAddress =
     params.type === ApprovalType.DEPOSIT
-      ? getAddress(chainId, 'core_proxy')
-      : getAddress(chainId, 'passive_pool_proxy');
+      ? getAddress(chainId, ContractType.CORE_PROXY)
+      : getAddress(chainId, ContractType.PASSIVE_POOL_PROXY);
 
   // @todo validate if maxAllowance should be passed from UI
   const maxUint256Bn = BigInt(

package/src/services/token/getAllowance.ts

@@ -1,6 +1,6 @@
 import { ApprovalType, GetAllowanceParams } from './types';
 import { getERC20Allowance } from './common';
-import { getAddress } from '../../utils/contractAddresses';
+import { ContractType, getAddress } from '../../utils/contractAddresses';
 
 export const getAllowance = async (
   params: GetAllowanceParams,
@@ -12,8 +12,8 @@ export const getAllowance = async (
 
   const contractProxyAddress =
     params.type === ApprovalType.DEPOSIT
-      ? getAddress(chainId, 'core_proxy')
-      : getAddress(chainId, 'passive_pool_proxy');
+      ? getAddress(chainId, ContractType.CORE_PROXY)
+      : getAddress(chainId, ContractType.PASSIVE_POOL_PROXY);
   const walletAddress: string = await params.signer.getAddress();
 
   const allowance = await getERC20Allowance({

package/src/utils/contractAddresses.ts

@@ -2,21 +2,31 @@ export type Address = Lowercase<string>;
 // @todo update with proper chainId for mainnet
 import { ReyaChainId } from '@reyaxyz/common';
 
-export type ContractType = 'core_proxy' | 'passive_pool_proxy';
+export enum ContractType {
+  CORE_PROXY = 'core_proxy',
+  PASSIVE_POOL_PROXY = 'passive_pool_proxy',
+  PERIPHERY_PROXY = 'periphery_proxy',
+}
 
 const addresses: Record<ReyaChainId, Record<ContractType, Address>> = {
   [ReyaChainId.polygonMumbai]: {
-    core_proxy: '0xc2f1b4a1275b7338e0eb03967fea3858af4bc900',
-    passive_pool_proxy: '0x1b9d499f3ac864b8d4da415846d1d1916e00a6ff',
+    [ContractType.CORE_PROXY]: '0xc2f1b4a1275b7338e0eb03967fea3858af4bc900',
+    [ContractType.PASSIVE_POOL_PROXY]:
+      '0x1b9d499f3ac864b8d4da415846d1d1916e00a6ff',
+    [ContractType.PERIPHERY_PROXY]: 'todo',
   },
   [ReyaChainId.reyaCronos]: {
-    core_proxy: '0x141a7e35a22688c8e8f429da47e246f3896c5af8',
-    passive_pool_proxy: '0x730ea458b8b2d2fdf15406829c4106a12775bae0',
+    [ContractType.CORE_PROXY]: '0x141a7e35a22688c8e8f429da47e246f3896c5af8',
+    [ContractType.PASSIVE_POOL_PROXY]:
+      '0x730ea458b8b2d2fdf15406829c4106a12775bae0',
+    [ContractType.PERIPHERY_PROXY]: 'todo',
   },
   // TODO: add proper config
   [ReyaChainId.reyaNetwork]: {
-    core_proxy: '0x2cb06a22ee9b823a307d22f131380dbe151ece5f',
-    passive_pool_proxy: '0x63df38878c5b8e84d7dcb347b934072add64bdc5',
+    [ContractType.CORE_PROXY]: '0x2cb06a22ee9b823a307d22f131380dbe151ece5f',
+    [ContractType.PASSIVE_POOL_PROXY]:
+      '0x63df38878c5b8e84d7dcb347b934072add64bdc5',
+    [ContractType.PERIPHERY_PROXY]: 'todo',
   },
 };
 export const getAddress = (

package/src/utils/routerCommands.ts

@@ -12,6 +12,7 @@ export enum CommandType {
   DUTCH_LIQUIDATION,
   MATCH_ORDER,
   PROPAGATE_CACHE_FLOW,
+  TRANSFER_MARGIN_ACCOUNT,
 }
 
 const ABI_DEFINITION: { [key in CommandType]: string[] } = {
@@ -20,6 +21,7 @@ const ABI_DEFINITION: { [key in CommandType]: string[] } = {
   [CommandType.MATCH_ORDER]: ['uint128[]', 'bytes'],
   [CommandType.PROPAGATE_CACHE_FLOW]: [], // @todo Check if correct
   [CommandType.DUTCH_LIQUIDATION]: [], // @todo update once needed
+  [CommandType.TRANSFER_MARGIN_ACCOUNT]: [], // @todo update once needed
 };
 
 export type RouterCommand = {

package/dist/types/utils/consts.d.ts

@@ -1,8 +0,0 @@
-export declare enum TransactionType {
-    CREATE_ACCOUNT = 0,
-    DEPOSIT = 1,
-    WITHDRAW = 2,
-    LP = 3,
-    TRADE = 4
-}
-//# sourceMappingURL=consts.d.ts.map

package/dist/types/utils/consts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"consts.d.ts","sourceRoot":"/","sources":["utils/consts.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,cAAc,IAAA;IACd,OAAO,IAAA;IACP,QAAQ,IAAA;IACR,EAAE,IAAA;IACF,KAAK,IAAA;CACN"}

package/dist/utils/consts.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionType = void 0;
-var TransactionType;
-(function (TransactionType) {
-    TransactionType[TransactionType["CREATE_ACCOUNT"] = 0] = "CREATE_ACCOUNT";
-    TransactionType[TransactionType["DEPOSIT"] = 1] = "DEPOSIT";
-    TransactionType[TransactionType["WITHDRAW"] = 2] = "WITHDRAW";
-    TransactionType[TransactionType["LP"] = 3] = "LP";
-    TransactionType[TransactionType["TRADE"] = 4] = "TRADE";
-})(TransactionType || (exports.TransactionType = TransactionType = {}));
-//# sourceMappingURL=consts.js.map

package/dist/utils/consts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consts.js","sourceRoot":"/","sources":["utils/consts.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,yEAAc,CAAA;IACd,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,iDAAE,CAAA;IACF,uDAAK,CAAA;AACP,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B","sourcesContent":["export enum TransactionType {\n  CREATE_ACCOUNT,\n  DEPOSIT,\n  WITHDRAW,\n  LP,\n  TRADE,\n}\n"]}

package/src/utils/consts.ts

@@ -1,7 +0,0 @@
-export enum TransactionType {
-  CREATE_ACCOUNT,
-  DEPOSIT,
-  WITHDRAW,
-  LP,
-  TRADE,
-}