@paxeer-network/paxeer-bridge 0.0.2
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/CHANGELOG.md +10 -0
- package/LICENSE +7 -0
- package/README.md +397 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +197 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +197 -0
- package/client.d.ts.map +1 -0
- package/client.js +474 -0
- package/client.js.map +1 -0
- package/client.mjs +470 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +137 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/bridge.d.mts +264 -0
- package/resources/bridge.d.mts.map +1 -0
- package/resources/bridge.d.ts +264 -0
- package/resources/bridge.d.ts.map +1 -0
- package/resources/bridge.js +93 -0
- package/resources/bridge.js.map +1 -0
- package/resources/bridge.mjs +89 -0
- package/resources/bridge.mjs.map +1 -0
- package/resources/index.d.mts +3 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +9 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -0
- package/resources/rewards/index.d.mts +4 -0
- package/resources/rewards/index.d.mts.map +1 -0
- package/resources/rewards/index.d.ts +4 -0
- package/resources/rewards/index.d.ts.map +1 -0
- package/resources/rewards/index.js +11 -0
- package/resources/rewards/index.js.map +1 -0
- package/resources/rewards/index.mjs +5 -0
- package/resources/rewards/index.mjs.map +1 -0
- package/resources/rewards/referral.d.mts +100 -0
- package/resources/rewards/referral.d.mts.map +1 -0
- package/resources/rewards/referral.d.ts +100 -0
- package/resources/rewards/referral.d.ts.map +1 -0
- package/resources/rewards/referral.js +50 -0
- package/resources/rewards/referral.js.map +1 -0
- package/resources/rewards/referral.mjs +46 -0
- package/resources/rewards/referral.mjs.map +1 -0
- package/resources/rewards/rewards.d.mts +153 -0
- package/resources/rewards/rewards.d.mts.map +1 -0
- package/resources/rewards/rewards.d.ts +153 -0
- package/resources/rewards/rewards.d.ts.map +1 -0
- package/resources/rewards/rewards.js +63 -0
- package/resources/rewards/rewards.js.map +1 -0
- package/resources/rewards/rewards.mjs +58 -0
- package/resources/rewards/rewards.mjs.map +1 -0
- package/resources/rewards/staking.d.mts +189 -0
- package/resources/rewards/staking.d.mts.map +1 -0
- package/resources/rewards/staking.d.ts +189 -0
- package/resources/rewards/staking.d.ts.map +1 -0
- package/resources/rewards/staking.js +74 -0
- package/resources/rewards/staking.js.map +1 -0
- package/resources/rewards/staking.mjs +70 -0
- package/resources/rewards/staking.mjs.map +1 -0
- package/resources/rewards.d.mts +2 -0
- package/resources/rewards.d.mts.map +1 -0
- package/resources/rewards.d.ts +2 -0
- package/resources/rewards.d.ts.map +1 -0
- package/resources/rewards.js +6 -0
- package/resources/rewards.js.map +1 -0
- package/resources/rewards.mjs +3 -0
- package/resources/rewards.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +791 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/bridge.ts +403 -0
- package/src/resources/index.ts +22 -0
- package/src/resources/rewards/index.ts +28 -0
- package/src/resources/rewards/referral.ts +150 -0
- package/src/resources/rewards/rewards.ts +262 -0
- package/src/resources/rewards/staking.ts +274 -0
- package/src/resources/rewards.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
export declare class Referral extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Apply a referral code to link new user with referrer
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.rewards.referral.applyCode({
|
|
11
|
+
* referralCode: 'PAXEER123',
|
|
12
|
+
* userAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
applyCode(body: ReferralApplyCodeParams, options?: RequestOptions): APIPromise<ReferralApplyCodeResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* Retrieve leaderboard of users with most referrals
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const response =
|
|
23
|
+
* await client.rewards.referral.retrieveLeaderboard();
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
retrieveLeaderboard(query?: ReferralRetrieveLeaderboardParams | null | undefined, options?: RequestOptions): APIPromise<ReferralRetrieveLeaderboardResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Retrieve user's referral code, stats, and earnings
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const response =
|
|
33
|
+
* await client.rewards.referral.retrieveStatistics(
|
|
34
|
+
* '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
retrieveStatistics(address: string, options?: RequestOptions): APIPromise<ReferralRetrieveStatisticsResponse>;
|
|
39
|
+
}
|
|
40
|
+
export interface ReferralApplyCodeResponse {
|
|
41
|
+
bonusRate?: string | null;
|
|
42
|
+
error?: string | null;
|
|
43
|
+
referrer?: string | null;
|
|
44
|
+
success?: boolean;
|
|
45
|
+
}
|
|
46
|
+
export interface ReferralRetrieveLeaderboardResponse {
|
|
47
|
+
data?: Array<ReferralRetrieveLeaderboardResponse.Data>;
|
|
48
|
+
success?: boolean;
|
|
49
|
+
}
|
|
50
|
+
export declare namespace ReferralRetrieveLeaderboardResponse {
|
|
51
|
+
interface Data {
|
|
52
|
+
rank?: number;
|
|
53
|
+
referrerAddress?: string;
|
|
54
|
+
totalReferrals?: number;
|
|
55
|
+
totalRewards?: string;
|
|
56
|
+
totalVolume?: string;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
export interface ReferralRetrieveStatisticsResponse {
|
|
60
|
+
data?: ReferralRetrieveStatisticsResponse.Data;
|
|
61
|
+
success?: boolean;
|
|
62
|
+
}
|
|
63
|
+
export declare namespace ReferralRetrieveStatisticsResponse {
|
|
64
|
+
interface Data {
|
|
65
|
+
activeReferrals?: number;
|
|
66
|
+
referralCode?: string;
|
|
67
|
+
referrals?: Array<Data.Referral>;
|
|
68
|
+
totalReferrals?: number;
|
|
69
|
+
totalRewards?: string;
|
|
70
|
+
totalVolume?: string;
|
|
71
|
+
}
|
|
72
|
+
namespace Data {
|
|
73
|
+
interface Referral {
|
|
74
|
+
isActive?: boolean;
|
|
75
|
+
refereeAddress?: string;
|
|
76
|
+
signupDate?: number;
|
|
77
|
+
totalVolume?: string;
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
export interface ReferralApplyCodeParams {
|
|
82
|
+
/**
|
|
83
|
+
* Referrer's code (6 uppercase letters/numbers)
|
|
84
|
+
*/
|
|
85
|
+
referralCode: string;
|
|
86
|
+
/**
|
|
87
|
+
* New user's wallet address
|
|
88
|
+
*/
|
|
89
|
+
userAddress: string;
|
|
90
|
+
}
|
|
91
|
+
export interface ReferralRetrieveLeaderboardParams {
|
|
92
|
+
/**
|
|
93
|
+
* Number of referrers to return
|
|
94
|
+
*/
|
|
95
|
+
limit?: number;
|
|
96
|
+
}
|
|
97
|
+
export declare namespace Referral {
|
|
98
|
+
export { type ReferralApplyCodeResponse as ReferralApplyCodeResponse, type ReferralRetrieveLeaderboardResponse as ReferralRetrieveLeaderboardResponse, type ReferralRetrieveStatisticsResponse as ReferralRetrieveStatisticsResponse, type ReferralApplyCodeParams as ReferralApplyCodeParams, type ReferralRetrieveLeaderboardParams as ReferralRetrieveLeaderboardParams, };
|
|
99
|
+
}
|
|
100
|
+
//# sourceMappingURL=referral.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../src/resources/rewards/referral.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIzG;;;;;;;;OAQG;IACH,mBAAmB,CACjB,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;;;OAUG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,IAAI,CAAC,CAAC;IAEvD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mCAAmC,CAAC;IACnD,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,CAAC,EAAE,kCAAkC,CAAC,IAAI,CAAC;IAE/C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,kCAAkC,CAAC;IAClD,UAAiB,IAAI;QACnB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEjC,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,QAAQ;YACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Referral = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
+
class Referral extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Apply a referral code to link new user with referrer
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const response = await client.rewards.referral.applyCode({
|
|
14
|
+
* referralCode: 'PAXEER123',
|
|
15
|
+
* userAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
applyCode(body, options) {
|
|
20
|
+
return this._client.post('/rewards/referral/apply', { body, ...options });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve leaderboard of users with most referrals
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const response =
|
|
28
|
+
* await client.rewards.referral.retrieveLeaderboard();
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
retrieveLeaderboard(query = {}, options) {
|
|
32
|
+
return this._client.get('/rewards/referral/leaderboard', { query, ...options });
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve user's referral code, stats, and earnings
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const response =
|
|
40
|
+
* await client.rewards.referral.retrieveStatistics(
|
|
41
|
+
* '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieveStatistics(address, options) {
|
|
46
|
+
return this._client.get((0, path_1.path) `/rewards/referral/${address}`, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.Referral = Referral;
|
|
50
|
+
//# sourceMappingURL=referral.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"referral.js","sourceRoot":"","sources":["../../src/resources/rewards/referral.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAA6B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB,CACjB,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAChB,OAAe,EACf,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAjDD,4BAiDC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
+
export class Referral extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Apply a referral code to link new user with referrer
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.rewards.referral.applyCode({
|
|
11
|
+
* referralCode: 'PAXEER123',
|
|
12
|
+
* userAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
applyCode(body, options) {
|
|
17
|
+
return this._client.post('/rewards/referral/apply', { body, ...options });
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Retrieve leaderboard of users with most referrals
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const response =
|
|
25
|
+
* await client.rewards.referral.retrieveLeaderboard();
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
retrieveLeaderboard(query = {}, options) {
|
|
29
|
+
return this._client.get('/rewards/referral/leaderboard', { query, ...options });
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve user's referral code, stats, and earnings
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const response =
|
|
37
|
+
* await client.rewards.referral.retrieveStatistics(
|
|
38
|
+
* '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
retrieveStatistics(address, options) {
|
|
43
|
+
return this._client.get(path `/rewards/referral/${address}`, options);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
//# sourceMappingURL=referral.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"referral.mjs","sourceRoot":"","sources":["../../src/resources/rewards/referral.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAA6B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB,CACjB,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAChB,OAAe,EACf,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as RewardsAPI from "./rewards.mjs";
|
|
3
|
+
import * as ReferralAPI from "./referral.mjs";
|
|
4
|
+
import { Referral, ReferralApplyCodeParams, ReferralApplyCodeResponse, ReferralRetrieveLeaderboardParams, ReferralRetrieveLeaderboardResponse, ReferralRetrieveStatisticsResponse } from "./referral.mjs";
|
|
5
|
+
import * as StakingAPI from "./staking.mjs";
|
|
6
|
+
import { Staking, StakingCreatePositionParams, StakingCreatePositionResponse, StakingRetrievePoolsParams, StakingRetrievePoolsResponse, StakingRetrievePositionsResponse, StakingUnstakePositionParams, StakingUnstakePositionResponse } from "./staking.mjs";
|
|
7
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
8
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
9
|
+
export declare class Rewards extends APIResource {
|
|
10
|
+
referral: ReferralAPI.Referral;
|
|
11
|
+
staking: StakingAPI.Staking;
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve current rewards system configuration including rates, tiers, and
|
|
14
|
+
* bonuses
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response = await client.rewards.retrieveConfig();
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
retrieveConfig(options?: RequestOptions): APIPromise<RewardRetrieveConfigResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve comprehensive rewards information for a user including:
|
|
24
|
+
*
|
|
25
|
+
* - Total points and current tier
|
|
26
|
+
* - Pending and distributed rewards
|
|
27
|
+
* - Bridge volume and transaction count
|
|
28
|
+
* - Tier progress and next tier requirements
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const response = await client.rewards.retrieveDashboard(
|
|
33
|
+
* '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
34
|
+
* );
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
retrieveDashboard(address: string, options?: RequestOptions): APIPromise<RewardRetrieveDashboardResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve top users by volume or points
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const response = await client.rewards.retrieveLeaderboard();
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
retrieveLeaderboard(query?: RewardRetrieveLeaderboardParams | null | undefined, options?: RequestOptions): APIPromise<RewardRetrieveLeaderboardResponse>;
|
|
47
|
+
}
|
|
48
|
+
export interface Reward {
|
|
49
|
+
id?: number;
|
|
50
|
+
amount?: string;
|
|
51
|
+
createdAt?: number;
|
|
52
|
+
distributedAt?: number | null;
|
|
53
|
+
rewardType?: 'bridge' | 'referral' | 'staking';
|
|
54
|
+
status?: 'pending' | 'queued' | 'distributed';
|
|
55
|
+
tokenSymbol?: string;
|
|
56
|
+
usdValue?: string;
|
|
57
|
+
userAddress?: string;
|
|
58
|
+
}
|
|
59
|
+
export interface RewardRetrieveConfigResponse {
|
|
60
|
+
data?: RewardRetrieveConfigResponse.Data;
|
|
61
|
+
success?: boolean;
|
|
62
|
+
}
|
|
63
|
+
export declare namespace RewardRetrieveConfigResponse {
|
|
64
|
+
interface Data {
|
|
65
|
+
/**
|
|
66
|
+
* PXR tokens rewarded per USD bridged
|
|
67
|
+
*/
|
|
68
|
+
bridgeRewardRate?: number;
|
|
69
|
+
earlyBirdEndsAt?: number;
|
|
70
|
+
earlyBirdMultiplier?: number;
|
|
71
|
+
isEarlyBird?: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* Points earned per USD bridged
|
|
74
|
+
*/
|
|
75
|
+
pointsPerUsd?: number;
|
|
76
|
+
refereeBonus?: number;
|
|
77
|
+
referralRewardRate?: number;
|
|
78
|
+
tiers?: {
|
|
79
|
+
[key: string]: Data.Tiers;
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
namespace Data {
|
|
83
|
+
interface Tiers {
|
|
84
|
+
minVolume?: number;
|
|
85
|
+
name?: string;
|
|
86
|
+
pointsMultiplier?: number;
|
|
87
|
+
rewardBonus?: number;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
export interface RewardRetrieveDashboardResponse {
|
|
92
|
+
data?: RewardRetrieveDashboardResponse.Data;
|
|
93
|
+
success?: boolean;
|
|
94
|
+
}
|
|
95
|
+
export declare namespace RewardRetrieveDashboardResponse {
|
|
96
|
+
interface Data {
|
|
97
|
+
rewards?: Data.Rewards;
|
|
98
|
+
tierProgress?: Data.TierProgress;
|
|
99
|
+
user?: Data.User;
|
|
100
|
+
}
|
|
101
|
+
namespace Data {
|
|
102
|
+
interface Rewards {
|
|
103
|
+
distributed?: Array<RewardsAPI.Reward>;
|
|
104
|
+
pending?: Array<RewardsAPI.Reward>;
|
|
105
|
+
totalDistributed?: string;
|
|
106
|
+
totalPending?: string;
|
|
107
|
+
}
|
|
108
|
+
interface TierProgress {
|
|
109
|
+
currentTier?: string;
|
|
110
|
+
nextTier?: string | null;
|
|
111
|
+
volumeProgress?: string;
|
|
112
|
+
volumeRequired?: string | null;
|
|
113
|
+
}
|
|
114
|
+
interface User {
|
|
115
|
+
address?: string;
|
|
116
|
+
referralCode?: string;
|
|
117
|
+
referredBy?: string | null;
|
|
118
|
+
tier?: 'bronze' | 'silver' | 'gold' | 'platinum' | 'diamond';
|
|
119
|
+
totalBridgeCount?: number;
|
|
120
|
+
totalBridgeVolume?: string;
|
|
121
|
+
totalPoints?: number;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
export interface RewardRetrieveLeaderboardResponse {
|
|
126
|
+
data?: Array<RewardRetrieveLeaderboardResponse.Data>;
|
|
127
|
+
success?: boolean;
|
|
128
|
+
}
|
|
129
|
+
export declare namespace RewardRetrieveLeaderboardResponse {
|
|
130
|
+
interface Data {
|
|
131
|
+
address?: string;
|
|
132
|
+
rank?: number;
|
|
133
|
+
tier?: string;
|
|
134
|
+
totalBridgeVolume?: string;
|
|
135
|
+
totalPoints?: number;
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
export interface RewardRetrieveLeaderboardParams {
|
|
139
|
+
/**
|
|
140
|
+
* Number of users to return
|
|
141
|
+
*/
|
|
142
|
+
limit?: number;
|
|
143
|
+
/**
|
|
144
|
+
* Leaderboard type
|
|
145
|
+
*/
|
|
146
|
+
type?: 'volume' | 'points';
|
|
147
|
+
}
|
|
148
|
+
export declare namespace Rewards {
|
|
149
|
+
export { type Reward as Reward, type RewardRetrieveConfigResponse as RewardRetrieveConfigResponse, type RewardRetrieveDashboardResponse as RewardRetrieveDashboardResponse, type RewardRetrieveLeaderboardResponse as RewardRetrieveLeaderboardResponse, type RewardRetrieveLeaderboardParams as RewardRetrieveLeaderboardParams, };
|
|
150
|
+
export { Referral as Referral, type ReferralApplyCodeResponse as ReferralApplyCodeResponse, type ReferralRetrieveLeaderboardResponse as ReferralRetrieveLeaderboardResponse, type ReferralRetrieveStatisticsResponse as ReferralRetrieveStatisticsResponse, type ReferralApplyCodeParams as ReferralApplyCodeParams, type ReferralRetrieveLeaderboardParams as ReferralRetrieveLeaderboardParams, };
|
|
151
|
+
export { Staking as Staking, type StakingCreatePositionResponse as StakingCreatePositionResponse, type StakingRetrievePoolsResponse as StakingRetrievePoolsResponse, type StakingRetrievePositionsResponse as StakingRetrievePositionsResponse, type StakingUnstakePositionResponse as StakingUnstakePositionResponse, type StakingCreatePositionParams as StakingCreatePositionParams, type StakingRetrievePoolsParams as StakingRetrievePoolsParams, type StakingUnstakePositionParams as StakingUnstakePositionParams, };
|
|
152
|
+
}
|
|
153
|
+
//# sourceMappingURL=rewards.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rewards.d.mts","sourceRoot":"","sources":["../../src/resources/rewards/rewards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EACL,QAAQ,EACR,uBAAuB,EACvB,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,EACnC,kCAAkC,EACnC;OACM,KAAK,UAAU;OACf,EACL,OAAO,EACP,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIlF;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAIzG;;;;;;;OAOG;IACH,mBAAmB,CACjB,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE/C,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,KAAK,CAAA;SAAE,CAAC;KACvC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,CAAC,EAAE,+BAA+B,CAAC,IAAI,CAAC;IAE5C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAEvC,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAEnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY;YAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED,UAAiB,IAAI;YACnB,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;YAE7D,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAErD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as RewardsAPI from "./rewards.js";
|
|
3
|
+
import * as ReferralAPI from "./referral.js";
|
|
4
|
+
import { Referral, ReferralApplyCodeParams, ReferralApplyCodeResponse, ReferralRetrieveLeaderboardParams, ReferralRetrieveLeaderboardResponse, ReferralRetrieveStatisticsResponse } from "./referral.js";
|
|
5
|
+
import * as StakingAPI from "./staking.js";
|
|
6
|
+
import { Staking, StakingCreatePositionParams, StakingCreatePositionResponse, StakingRetrievePoolsParams, StakingRetrievePoolsResponse, StakingRetrievePositionsResponse, StakingUnstakePositionParams, StakingUnstakePositionResponse } from "./staking.js";
|
|
7
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
8
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
9
|
+
export declare class Rewards extends APIResource {
|
|
10
|
+
referral: ReferralAPI.Referral;
|
|
11
|
+
staking: StakingAPI.Staking;
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve current rewards system configuration including rates, tiers, and
|
|
14
|
+
* bonuses
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response = await client.rewards.retrieveConfig();
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
retrieveConfig(options?: RequestOptions): APIPromise<RewardRetrieveConfigResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve comprehensive rewards information for a user including:
|
|
24
|
+
*
|
|
25
|
+
* - Total points and current tier
|
|
26
|
+
* - Pending and distributed rewards
|
|
27
|
+
* - Bridge volume and transaction count
|
|
28
|
+
* - Tier progress and next tier requirements
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const response = await client.rewards.retrieveDashboard(
|
|
33
|
+
* '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
34
|
+
* );
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
retrieveDashboard(address: string, options?: RequestOptions): APIPromise<RewardRetrieveDashboardResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve top users by volume or points
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const response = await client.rewards.retrieveLeaderboard();
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
retrieveLeaderboard(query?: RewardRetrieveLeaderboardParams | null | undefined, options?: RequestOptions): APIPromise<RewardRetrieveLeaderboardResponse>;
|
|
47
|
+
}
|
|
48
|
+
export interface Reward {
|
|
49
|
+
id?: number;
|
|
50
|
+
amount?: string;
|
|
51
|
+
createdAt?: number;
|
|
52
|
+
distributedAt?: number | null;
|
|
53
|
+
rewardType?: 'bridge' | 'referral' | 'staking';
|
|
54
|
+
status?: 'pending' | 'queued' | 'distributed';
|
|
55
|
+
tokenSymbol?: string;
|
|
56
|
+
usdValue?: string;
|
|
57
|
+
userAddress?: string;
|
|
58
|
+
}
|
|
59
|
+
export interface RewardRetrieveConfigResponse {
|
|
60
|
+
data?: RewardRetrieveConfigResponse.Data;
|
|
61
|
+
success?: boolean;
|
|
62
|
+
}
|
|
63
|
+
export declare namespace RewardRetrieveConfigResponse {
|
|
64
|
+
interface Data {
|
|
65
|
+
/**
|
|
66
|
+
* PXR tokens rewarded per USD bridged
|
|
67
|
+
*/
|
|
68
|
+
bridgeRewardRate?: number;
|
|
69
|
+
earlyBirdEndsAt?: number;
|
|
70
|
+
earlyBirdMultiplier?: number;
|
|
71
|
+
isEarlyBird?: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* Points earned per USD bridged
|
|
74
|
+
*/
|
|
75
|
+
pointsPerUsd?: number;
|
|
76
|
+
refereeBonus?: number;
|
|
77
|
+
referralRewardRate?: number;
|
|
78
|
+
tiers?: {
|
|
79
|
+
[key: string]: Data.Tiers;
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
namespace Data {
|
|
83
|
+
interface Tiers {
|
|
84
|
+
minVolume?: number;
|
|
85
|
+
name?: string;
|
|
86
|
+
pointsMultiplier?: number;
|
|
87
|
+
rewardBonus?: number;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
export interface RewardRetrieveDashboardResponse {
|
|
92
|
+
data?: RewardRetrieveDashboardResponse.Data;
|
|
93
|
+
success?: boolean;
|
|
94
|
+
}
|
|
95
|
+
export declare namespace RewardRetrieveDashboardResponse {
|
|
96
|
+
interface Data {
|
|
97
|
+
rewards?: Data.Rewards;
|
|
98
|
+
tierProgress?: Data.TierProgress;
|
|
99
|
+
user?: Data.User;
|
|
100
|
+
}
|
|
101
|
+
namespace Data {
|
|
102
|
+
interface Rewards {
|
|
103
|
+
distributed?: Array<RewardsAPI.Reward>;
|
|
104
|
+
pending?: Array<RewardsAPI.Reward>;
|
|
105
|
+
totalDistributed?: string;
|
|
106
|
+
totalPending?: string;
|
|
107
|
+
}
|
|
108
|
+
interface TierProgress {
|
|
109
|
+
currentTier?: string;
|
|
110
|
+
nextTier?: string | null;
|
|
111
|
+
volumeProgress?: string;
|
|
112
|
+
volumeRequired?: string | null;
|
|
113
|
+
}
|
|
114
|
+
interface User {
|
|
115
|
+
address?: string;
|
|
116
|
+
referralCode?: string;
|
|
117
|
+
referredBy?: string | null;
|
|
118
|
+
tier?: 'bronze' | 'silver' | 'gold' | 'platinum' | 'diamond';
|
|
119
|
+
totalBridgeCount?: number;
|
|
120
|
+
totalBridgeVolume?: string;
|
|
121
|
+
totalPoints?: number;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
export interface RewardRetrieveLeaderboardResponse {
|
|
126
|
+
data?: Array<RewardRetrieveLeaderboardResponse.Data>;
|
|
127
|
+
success?: boolean;
|
|
128
|
+
}
|
|
129
|
+
export declare namespace RewardRetrieveLeaderboardResponse {
|
|
130
|
+
interface Data {
|
|
131
|
+
address?: string;
|
|
132
|
+
rank?: number;
|
|
133
|
+
tier?: string;
|
|
134
|
+
totalBridgeVolume?: string;
|
|
135
|
+
totalPoints?: number;
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
export interface RewardRetrieveLeaderboardParams {
|
|
139
|
+
/**
|
|
140
|
+
* Number of users to return
|
|
141
|
+
*/
|
|
142
|
+
limit?: number;
|
|
143
|
+
/**
|
|
144
|
+
* Leaderboard type
|
|
145
|
+
*/
|
|
146
|
+
type?: 'volume' | 'points';
|
|
147
|
+
}
|
|
148
|
+
export declare namespace Rewards {
|
|
149
|
+
export { type Reward as Reward, type RewardRetrieveConfigResponse as RewardRetrieveConfigResponse, type RewardRetrieveDashboardResponse as RewardRetrieveDashboardResponse, type RewardRetrieveLeaderboardResponse as RewardRetrieveLeaderboardResponse, type RewardRetrieveLeaderboardParams as RewardRetrieveLeaderboardParams, };
|
|
150
|
+
export { Referral as Referral, type ReferralApplyCodeResponse as ReferralApplyCodeResponse, type ReferralRetrieveLeaderboardResponse as ReferralRetrieveLeaderboardResponse, type ReferralRetrieveStatisticsResponse as ReferralRetrieveStatisticsResponse, type ReferralApplyCodeParams as ReferralApplyCodeParams, type ReferralRetrieveLeaderboardParams as ReferralRetrieveLeaderboardParams, };
|
|
151
|
+
export { Staking as Staking, type StakingCreatePositionResponse as StakingCreatePositionResponse, type StakingRetrievePoolsResponse as StakingRetrievePoolsResponse, type StakingRetrievePositionsResponse as StakingRetrievePositionsResponse, type StakingUnstakePositionResponse as StakingUnstakePositionResponse, type StakingCreatePositionParams as StakingCreatePositionParams, type StakingRetrievePoolsParams as StakingRetrievePoolsParams, type StakingUnstakePositionParams as StakingUnstakePositionParams, };
|
|
152
|
+
}
|
|
153
|
+
//# sourceMappingURL=rewards.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rewards.d.ts","sourceRoot":"","sources":["../../src/resources/rewards/rewards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,WAAW;OAChB,EACL,QAAQ,EACR,uBAAuB,EACvB,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,EACnC,kCAAkC,EACnC;OACM,KAAK,UAAU;OACf,EACL,OAAO,EACP,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC/B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIlF;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAIzG;;;;;;;OAOG;IACH,mBAAmB,CACjB,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE/C,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,KAAK,CAAA;SAAE,CAAC;KACvC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,CAAC,EAAE,+BAA+B,CAAC,IAAI,CAAC;IAE5C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAEvC,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAEnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY;YAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED,UAAiB,IAAI;YACnB,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;YAE7D,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAErD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Rewards = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const ReferralAPI = tslib_1.__importStar(require("./referral.js"));
|
|
8
|
+
const referral_1 = require("./referral.js");
|
|
9
|
+
const StakingAPI = tslib_1.__importStar(require("./staking.js"));
|
|
10
|
+
const staking_1 = require("./staking.js");
|
|
11
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
12
|
+
class Rewards extends resource_1.APIResource {
|
|
13
|
+
constructor() {
|
|
14
|
+
super(...arguments);
|
|
15
|
+
this.referral = new ReferralAPI.Referral(this._client);
|
|
16
|
+
this.staking = new StakingAPI.Staking(this._client);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Retrieve current rewards system configuration including rates, tiers, and
|
|
20
|
+
* bonuses
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const response = await client.rewards.retrieveConfig();
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
retrieveConfig(options) {
|
|
28
|
+
return this._client.get('/rewards/config', options);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Retrieve comprehensive rewards information for a user including:
|
|
32
|
+
*
|
|
33
|
+
* - Total points and current tier
|
|
34
|
+
* - Pending and distributed rewards
|
|
35
|
+
* - Bridge volume and transaction count
|
|
36
|
+
* - Tier progress and next tier requirements
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const response = await client.rewards.retrieveDashboard(
|
|
41
|
+
* '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieveDashboard(address, options) {
|
|
46
|
+
return this._client.get((0, path_1.path) `/rewards/dashboard/${address}`, options);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Retrieve top users by volume or points
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const response = await client.rewards.retrieveLeaderboard();
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
retrieveLeaderboard(query = {}, options) {
|
|
57
|
+
return this._client.get('/rewards/leaderboard', { query, ...options });
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.Rewards = Rewards;
|
|
61
|
+
Rewards.Referral = referral_1.Referral;
|
|
62
|
+
Rewards.Staking = staking_1.Staking;
|
|
63
|
+
//# sourceMappingURL=rewards.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rewards.js","sourceRoot":"","sources":["../../src/resources/rewards/rewards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CAOoB;AACpB,iEAAwC;AACxC,0CASmB;AAGnB,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgDrE,CAAC;IA9CC;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAwB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,OAAe,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAlDD,0BAkDC;AAwJD,OAAO,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as ReferralAPI from "./referral.mjs";
|
|
4
|
+
import { Referral, } from "./referral.mjs";
|
|
5
|
+
import * as StakingAPI from "./staking.mjs";
|
|
6
|
+
import { Staking, } from "./staking.mjs";
|
|
7
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
8
|
+
export class Rewards extends APIResource {
|
|
9
|
+
constructor() {
|
|
10
|
+
super(...arguments);
|
|
11
|
+
this.referral = new ReferralAPI.Referral(this._client);
|
|
12
|
+
this.staking = new StakingAPI.Staking(this._client);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Retrieve current rewards system configuration including rates, tiers, and
|
|
16
|
+
* bonuses
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const response = await client.rewards.retrieveConfig();
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
retrieveConfig(options) {
|
|
24
|
+
return this._client.get('/rewards/config', options);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve comprehensive rewards information for a user including:
|
|
28
|
+
*
|
|
29
|
+
* - Total points and current tier
|
|
30
|
+
* - Pending and distributed rewards
|
|
31
|
+
* - Bridge volume and transaction count
|
|
32
|
+
* - Tier progress and next tier requirements
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const response = await client.rewards.retrieveDashboard(
|
|
37
|
+
* '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
retrieveDashboard(address, options) {
|
|
42
|
+
return this._client.get(path `/rewards/dashboard/${address}`, options);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Retrieve top users by volume or points
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* const response = await client.rewards.retrieveLeaderboard();
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
retrieveLeaderboard(query = {}, options) {
|
|
53
|
+
return this._client.get('/rewards/leaderboard', { query, ...options });
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
Rewards.Referral = Referral;
|
|
57
|
+
Rewards.Staking = Staking;
|
|
58
|
+
//# sourceMappingURL=rewards.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rewards.mjs","sourceRoot":"","sources":["../../src/resources/rewards/rewards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,WAAW;OAChB,EACL,QAAQ,GAMT;OACM,KAAK,UAAU;OACf,EACL,OAAO,GAQR;OAGM,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgDrE,CAAC;IA9CC;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAwB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,OAAe,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAwJD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}
|