@orderly.network/core 0.1.27-alpha.26 → 0.1.27-alpha.28

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import EventEmitter from 'eventemitter3';
 export { default as EventEmitter } from 'eventemitter3';
-import { API, AccountStatusEnum } from '@orderly.network/types';
+import { definedTypes, API, AccountStatusEnum } from '@orderly.network/types';
 import { parseUnits, TransactionResponse, ethers } from 'ethers';
 
 interface OrderlyKeyPair {
@@ -179,6 +179,236 @@ declare namespace utils {
 
 declare const getMockSigner: (secretKey?: string) => BaseSigner;
 declare const getDefaultSigner: () => BaseSigner;
+/**
+ * generate `registerAccount` data and to be signed message structure
+ */
+declare function generateRegisterAccountMessage(inputs: {
+    chainId: number;
+    registrationNonce: number;
+    brokerId: string;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    registrationNonce: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        registrationNonce: number;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        Registration: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }];
+    };
+}];
+/**
+ * generate `addOrderlyKey` data and to be signed message structure
+ */
+declare function generateAddOrderlyKeyMessage(inputs: {
+    publicKey: string;
+    chainId: number;
+    brokerId: string;
+    primaryType: keyof typeof definedTypes;
+    expiration: number;
+}): readonly [{
+    brokerId: string;
+    orderlyKey: string;
+    scope: string;
+    chainId: number;
+    timestamp: number;
+    expiration: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        orderlyKey: string;
+        scope: string;
+        chainId: number;
+        timestamp: number;
+        expiration: number;
+    };
+    primaryType: "Registration" | "EIP712Domain" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
+    types: {
+        [x: string]: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "withdrawNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "orderlyKey";
+            readonly type: "string";
+        }, {
+            readonly name: "scope";
+            readonly type: "string";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "expiration";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+    };
+}];
+/**
+ * generate `settle` data and to be signed message structure
+ */
+declare function generateSettleMessage(inputs: {
+    chainId: number;
+    brokerId: string;
+    settlePnlNonce: string;
+    domain: SignatureDomain;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    settleNonce: string;
+}, {
+    domain: SignatureDomain;
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        settleNonce: string;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        SettlePnl: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+    };
+}];
 
 /**
  * Orderly contracts information
@@ -395,7 +625,7 @@ declare class Assets {
     withdraw(inputs: {
         chainId: number;
         token: string;
-        amount: number;
+        amount: string | number;
         allowCrossChainWithdraw: boolean;
     }): Promise<any>;
     private _generateWithdrawMessage;
@@ -553,4 +783,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };
+export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import EventEmitter from 'eventemitter3';
 export { default as EventEmitter } from 'eventemitter3';
-import { API, AccountStatusEnum } from '@orderly.network/types';
+import { definedTypes, API, AccountStatusEnum } from '@orderly.network/types';
 import { parseUnits, TransactionResponse, ethers } from 'ethers';
 
 interface OrderlyKeyPair {
@@ -179,6 +179,236 @@ declare namespace utils {
 
 declare const getMockSigner: (secretKey?: string) => BaseSigner;
 declare const getDefaultSigner: () => BaseSigner;
+/**
+ * generate `registerAccount` data and to be signed message structure
+ */
+declare function generateRegisterAccountMessage(inputs: {
+    chainId: number;
+    registrationNonce: number;
+    brokerId: string;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    registrationNonce: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        registrationNonce: number;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        Registration: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }];
+    };
+}];
+/**
+ * generate `addOrderlyKey` data and to be signed message structure
+ */
+declare function generateAddOrderlyKeyMessage(inputs: {
+    publicKey: string;
+    chainId: number;
+    brokerId: string;
+    primaryType: keyof typeof definedTypes;
+    expiration: number;
+}): readonly [{
+    brokerId: string;
+    orderlyKey: string;
+    scope: string;
+    chainId: number;
+    timestamp: number;
+    expiration: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        orderlyKey: string;
+        scope: string;
+        chainId: number;
+        timestamp: number;
+        expiration: number;
+    };
+    primaryType: "Registration" | "EIP712Domain" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
+    types: {
+        [x: string]: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "withdrawNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "orderlyKey";
+            readonly type: "string";
+        }, {
+            readonly name: "scope";
+            readonly type: "string";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "expiration";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+    };
+}];
+/**
+ * generate `settle` data and to be signed message structure
+ */
+declare function generateSettleMessage(inputs: {
+    chainId: number;
+    brokerId: string;
+    settlePnlNonce: string;
+    domain: SignatureDomain;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    settleNonce: string;
+}, {
+    domain: SignatureDomain;
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        settleNonce: string;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        SettlePnl: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+    };
+}];
 
 /**
  * Orderly contracts information
@@ -395,7 +625,7 @@ declare class Assets {
     withdraw(inputs: {
         chainId: number;
         token: string;
-        amount: number;
+        amount: string | number;
         allowCrossChainWithdraw: boolean;
     }): Promise<any>;
     private _generateWithdrawMessage;
@@ -553,4 +783,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };
+export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };