@1stdex/first-sdk 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/calls/approval/order.js +2 -10
- package/dist/cjs/calls/approval/order.js.map +1 -1
- package/dist/cjs/calls/approval/token.js +3 -17
- package/dist/cjs/calls/approval/token.js.map +1 -1
- package/dist/cjs/views/index.js +6 -1
- package/dist/cjs/views/index.js.map +1 -1
- package/dist/cjs/views/setup.js +160 -0
- package/dist/cjs/views/setup.js.map +1 -0
- package/dist/cjs/views/vault.js +5 -3
- package/dist/cjs/views/vault.js.map +1 -1
- package/dist/esm/calls/approval/order.js +2 -10
- package/dist/esm/calls/approval/order.js.map +1 -1
- package/dist/esm/calls/approval/token.js +3 -17
- package/dist/esm/calls/approval/token.js.map +1 -1
- package/dist/esm/views/index.js +1 -0
- package/dist/esm/views/index.js.map +1 -1
- package/dist/esm/views/setup.js +235 -0
- package/dist/esm/views/setup.js.map +1 -0
- package/dist/esm/views/vault.js +6 -4
- package/dist/esm/views/vault.js.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/types/calls/approval/order.d.ts.map +1 -1
- package/dist/types/calls/approval/token.d.ts.map +1 -1
- package/dist/types/views/index.d.ts +1 -0
- package/dist/types/views/index.d.ts.map +1 -1
- package/dist/types/views/setup.d.ts +133 -0
- package/dist/types/views/setup.d.ts.map +1 -0
- package/dist/types/views/vault.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAIvE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB,2DAMlC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,
|
|
1
|
+
{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAIvE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB,2DAMlC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,CA6BtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,gCAAgC,uCAI1C;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,CAQtB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/token.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAOvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,kBAAkB,qDAK5B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/token.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAOvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,kBAAkB,qDAK5B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,EAAE,CA+GxB,CAAC"}
|
|
@@ -7,4 +7,5 @@ export { getCurrencies, getStableCurrencies, getLatestPriceMap, getDailyClosePri
|
|
|
7
7
|
export { getProtocolAnalytics, getUserDailyVolumes, getTopUsersByNativeVolume, getUserNativeVolume, getReferralSummary, } from './analytics';
|
|
8
8
|
export { getVault } from './vault';
|
|
9
9
|
export { getTradingBalance } from './balance';
|
|
10
|
+
export { isOrderOperatorApproved, checkTokenAllowances, needsVaultDeposit, getOrderSetupStatus, } from './setup';
|
|
10
11
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/views/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,4BAA4B,GAC7B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/views/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,4BAA4B,GAC7B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,SAAS,CAAC"}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import { CHAIN_IDS } from '../constants/chain-configs/chain';
|
|
2
|
+
import { CurrencyAmount } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* Check if an operator is approved for a user.
|
|
5
|
+
*
|
|
6
|
+
* @param chainId The chain ID.
|
|
7
|
+
* @param userAddress The user address.
|
|
8
|
+
* @param operator The operator address (defaults to Controller).
|
|
9
|
+
* @param options Optional RPC URL.
|
|
10
|
+
* @returns Promise resolving to true if operator is approved.
|
|
11
|
+
* @example
|
|
12
|
+
* import { isOrderOperatorApproved } from '@clober/v2-sdk'
|
|
13
|
+
*
|
|
14
|
+
* const isApproved = await isOrderOperatorApproved({
|
|
15
|
+
* chainId: 421614,
|
|
16
|
+
* userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69'
|
|
17
|
+
* })
|
|
18
|
+
*/
|
|
19
|
+
export declare const isOrderOperatorApproved: ({ chainId, userAddress, operator, options, }: {
|
|
20
|
+
chainId: CHAIN_IDS;
|
|
21
|
+
userAddress: `0x${string}`;
|
|
22
|
+
operator?: `0x${string}`;
|
|
23
|
+
options?: {
|
|
24
|
+
rpcUrl?: string;
|
|
25
|
+
};
|
|
26
|
+
}) => Promise<boolean>;
|
|
27
|
+
/**
|
|
28
|
+
* Check token allowances for trading.
|
|
29
|
+
* Returns which allowances are sufficient (above threshold).
|
|
30
|
+
*
|
|
31
|
+
* @param chainId The chain ID.
|
|
32
|
+
* @param userAddress The user address.
|
|
33
|
+
* @param tokenAddress The token address.
|
|
34
|
+
* @param options Optional RPC URL.
|
|
35
|
+
* @returns Promise resolving to allowance status object.
|
|
36
|
+
* @example
|
|
37
|
+
* import { checkTokenAllowances } from '@clober/v2-sdk'
|
|
38
|
+
*
|
|
39
|
+
* const status = await checkTokenAllowances({
|
|
40
|
+
* chainId: 421614,
|
|
41
|
+
* userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
|
|
42
|
+
* tokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'
|
|
43
|
+
* })
|
|
44
|
+
* if (!status.tokenToController) {
|
|
45
|
+
* // Need to set token allowances
|
|
46
|
+
* }
|
|
47
|
+
*/
|
|
48
|
+
export declare const checkTokenAllowances: ({ chainId, userAddress, tokenAddress, options, }: {
|
|
49
|
+
chainId: CHAIN_IDS;
|
|
50
|
+
userAddress: `0x${string}`;
|
|
51
|
+
tokenAddress: `0x${string}`;
|
|
52
|
+
options?: {
|
|
53
|
+
rpcUrl?: string;
|
|
54
|
+
};
|
|
55
|
+
}) => Promise<{
|
|
56
|
+
tokenToController: boolean;
|
|
57
|
+
vaultToController: boolean;
|
|
58
|
+
vaultToBookManager: boolean;
|
|
59
|
+
}>;
|
|
60
|
+
/**
|
|
61
|
+
* Check if vault deposit is needed for an order.
|
|
62
|
+
* Compares vault available balance against required amount.
|
|
63
|
+
*
|
|
64
|
+
* @param chainId The chain ID.
|
|
65
|
+
* @param userAddress The user address.
|
|
66
|
+
* @param tokenAddress The token address.
|
|
67
|
+
* @param requiredAmount The amount needed (decimal-adjusted string, e.g., "100.5").
|
|
68
|
+
* @param options Optional RPC URL.
|
|
69
|
+
* @returns Promise resolving to true if deposit is needed.
|
|
70
|
+
* @example
|
|
71
|
+
* import { needsVaultDeposit } from '@clober/v2-sdk'
|
|
72
|
+
*
|
|
73
|
+
* const needsDeposit = await needsVaultDeposit({
|
|
74
|
+
* chainId: 421614,
|
|
75
|
+
* userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
|
|
76
|
+
* tokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
|
|
77
|
+
* requiredAmount: "100"
|
|
78
|
+
* })
|
|
79
|
+
*/
|
|
80
|
+
export declare const needsVaultDeposit: ({ chainId, userAddress, tokenAddress, requiredAmount, options, }: {
|
|
81
|
+
chainId: CHAIN_IDS;
|
|
82
|
+
userAddress: `0x${string}`;
|
|
83
|
+
tokenAddress: `0x${string}`;
|
|
84
|
+
requiredAmount: string;
|
|
85
|
+
options?: {
|
|
86
|
+
rpcUrl?: string;
|
|
87
|
+
};
|
|
88
|
+
}) => Promise<boolean>;
|
|
89
|
+
/**
|
|
90
|
+
* Get complete order setup status in a single call.
|
|
91
|
+
* Checks operator approval, token allowances, and vault balance.
|
|
92
|
+
*
|
|
93
|
+
* @param chainId The chain ID.
|
|
94
|
+
* @param userAddress The user address.
|
|
95
|
+
* @param tokenAddress The token address.
|
|
96
|
+
* @param requiredAmount The amount needed for the order (decimal-adjusted string).
|
|
97
|
+
* @param options Optional RPC URL and operator address.
|
|
98
|
+
* @returns Promise resolving to complete setup status.
|
|
99
|
+
* @example
|
|
100
|
+
* import { getOrderSetupStatus } from '@clober/v2-sdk'
|
|
101
|
+
*
|
|
102
|
+
* const status = await getOrderSetupStatus({
|
|
103
|
+
* chainId: 421614,
|
|
104
|
+
* userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
|
|
105
|
+
* tokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
|
|
106
|
+
* requiredAmount: "100"
|
|
107
|
+
* })
|
|
108
|
+
*
|
|
109
|
+
* if (!status.operatorApproved) await setOrderOperatorApproval(...)
|
|
110
|
+
* if (!status.allAllowancesSet) await setTokenAllowances(...)
|
|
111
|
+
* if (status.needsDeposit) await depositToVault(...)
|
|
112
|
+
*/
|
|
113
|
+
export declare const getOrderSetupStatus: ({ chainId, userAddress, tokenAddress, requiredAmount, options, }: {
|
|
114
|
+
chainId: CHAIN_IDS;
|
|
115
|
+
userAddress: `0x${string}`;
|
|
116
|
+
tokenAddress: `0x${string}`;
|
|
117
|
+
requiredAmount: string;
|
|
118
|
+
options?: {
|
|
119
|
+
rpcUrl?: string;
|
|
120
|
+
operator?: `0x${string}`;
|
|
121
|
+
};
|
|
122
|
+
}) => Promise<{
|
|
123
|
+
operatorApproved: boolean;
|
|
124
|
+
tokenAllowances: {
|
|
125
|
+
tokenToController: boolean;
|
|
126
|
+
vaultToController: boolean;
|
|
127
|
+
vaultToBookManager: boolean;
|
|
128
|
+
allSet: boolean;
|
|
129
|
+
};
|
|
130
|
+
vaultBalance: CurrencyAmount;
|
|
131
|
+
needsDeposit: boolean;
|
|
132
|
+
}>;
|
|
133
|
+
//# sourceMappingURL=setup.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../../src/views/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AAMxE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,uBAAuB,iDAKjC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B,KAAG,QAAQ,OAAO,CAclB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,oBAAoB,qDAK9B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B,KAAG,QAAQ;IACV,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAiDA,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iBAAiB,qEAM3B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B,KAAG,QAAQ,OAAO,CAoBlB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,mBAAmB,qEAM7B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;KAAE,CAAC;CACzD,KAAG,QAAQ;IACV,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE;QACf,iBAAiB,EAAE,OAAO,CAAC;QAC3B,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,OAAO,CAAC;QAC5B,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,YAAY,EAAE,cAAc,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC;CACvB,CA+EA,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/views/vault.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AAGxE,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,wCAIlB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;
|
|
1
|
+
{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/views/vault.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AAGxE,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,wCAIlB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B,KAAG,QAAQ,KAAK,CAqBhB,CAAC"}
|