Skip to content

Commit a1f6e9a

Browse files
kiln-botEllzer
kiln-bot
and
Ellzer
authored
Update OpenAPI schema (#210)
* Update OpenAPI schema * bump version --------- Co-authored-by: Kiln Bot <[email protected]> Co-authored-by: Elliott Denis <[email protected]>
1 parent b373f8e commit a1f6e9a

File tree

2 files changed

+188
-8
lines changed

2 files changed

+188
-8
lines changed

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@kilnfi/sdk",
3-
"version": "4.1.16",
3+
"version": "4.1.17",
44
"autor": "Kiln <[email protected]> (https://kiln.fi)",
55
"license": "BUSL-1.1",
66
"description": "JavaScript sdk for Kiln API",

‎src/openapi/schema.ts‎

Lines changed: 187 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7132,6 +7132,26 @@ export interface paths {
71327132
patch?: never;
71337133
trace?: never;
71347134
};
7135+
"/ton/transaction/decode": {
7136+
parameters: {
7137+
query?: never;
7138+
header?: never;
7139+
path?: never;
7140+
cookie?: never;
7141+
};
7142+
/**
7143+
* Transaction Decoding
7144+
* @description Decode a serialized transaction
7145+
*/
7146+
get: operations["getTonTxDecoding"];
7147+
put?: never;
7148+
post?: never;
7149+
delete?: never;
7150+
options?: never;
7151+
head?: never;
7152+
patch?: never;
7153+
trace?: never;
7154+
};
71357155
"/ton/transaction/stake-single-nomination-pool": {
71367156
parameters: {
71377157
query?: never;
@@ -7412,6 +7432,26 @@ export interface paths {
74127432
patch?: never;
74137433
trace?: never;
74147434
};
7435+
"/trx/rewards": {
7436+
parameters: {
7437+
query?: never;
7438+
header?: never;
7439+
path?: never;
7440+
cookie?: never;
7441+
};
7442+
/**
7443+
* Rewards
7444+
* @description Get historical rewards of TRX stakes
7445+
*/
7446+
get: operations["getTrxRewards"];
7447+
put?: never;
7448+
post?: never;
7449+
delete?: never;
7450+
options?: never;
7451+
head?: never;
7452+
patch?: never;
7453+
trace?: never;
7454+
};
74157455
"/trx/transaction/stake": {
74167456
parameters: {
74177457
query?: never;
@@ -7737,7 +7777,7 @@ export interface components {
77377777
* @example NEAR
77387778
* @enum {string}
77397779
*/
7740-
token: "NEAR" | "ATOM" | "POL" | "ADA" | "OSMO" | "XTZ" | "DOT" | "KSM" | "SOL" | "TIA" | "EGLD" | "ZETA" | "INJ" | "FET" | "TON" | "KAVA" | "BTC" | "OM" | "CRO" | "TRX";
7780+
token: "NEAR" | "ATOM" | "POL" | "ADA" | "OSMO" | "DOT" | "KSM" | "SOL" | "TIA" | "EGLD" | "ZETA" | "INJ" | "FET" | "TON" | "KAVA" | "BTC" | "OM" | "CRO" | "TRX";
77417781
};
77427782
XTZPortfolio: components["schemas"]["BasePortfolio"] & {
77437783
/**
@@ -7924,7 +7964,7 @@ export interface components {
79247964
*/
79257965
total_active_stakes: number;
79267966
/** @description List of protocols staked within the account */
7927-
protocols: (components["schemas"]["DefaultPortfolio"] | components["schemas"]["DYDXPortfolio"] | components["schemas"]["ETHPortfolio"] | components["schemas"]["XTZPortfolio"])[];
7967+
protocols: (components["schemas"]["DefaultPortfolio"] | components["schemas"]["XTZPortfolio"] | components["schemas"]["DYDXPortfolio"] | components["schemas"]["ETHPortfolio"])[];
79287968
/**
79297969
* @description Error message if some protocol data could not be retrieved
79307970
* @example We could not fetch data for the following protocols: TON
@@ -9836,10 +9876,10 @@ export interface components {
98369876
*/
98379877
nonce: number;
98389878
/**
9839-
* @description Gas limit of the transaction in gas units. We provide a default value of two times the estimated gas limit
9879+
* @description Gas limit of the transaction in gas units. We provide a default value of two times the estimated gas limit. The value will be null if the parameter `skip_gas_estimation` is set to true.
98409880
* @example 140244
98419881
*/
9842-
gas_limit: number;
9882+
gas_limit: number | null;
98439883
/**
98449884
* @description Chain ID of the network
98459885
* @example 1
@@ -9877,7 +9917,7 @@ export interface components {
98779917
* @default false
98789918
* @example false
98799919
*/
9880-
ignore_checks: boolean;
9920+
skip_gas_estimation: boolean;
98819921
};
98829922
DefiCraftDepositTxPayload: {
98839923
/**
@@ -9910,7 +9950,7 @@ export interface components {
99109950
* @default false
99119951
* @example false
99129952
*/
9913-
ignore_checks: boolean;
9953+
skip_gas_estimation: boolean;
99149954
};
99159955
DefiCraftWithdrawTxPayload: {
99169956
/**
@@ -9941,7 +9981,7 @@ export interface components {
99419981
* @default false
99429982
* @example false
99439983
*/
9944-
ignore_checks: boolean;
9984+
skip_gas_estimation: boolean;
99459985
};
99469986
ETHOnchainV2Stake: {
99479987
/**
@@ -10392,6 +10432,18 @@ export interface components {
1039210432
* @example 2023-01-14T01:13:59Z
1039310433
*/
1039410434
updated_at: string;
10435+
/** @description Available balance for withdrawal in mutez */
10436+
available_balance: string;
10437+
/** @description Unstaked balance in mutez */
10438+
unstaked_balance: string;
10439+
/** @description Balance that can be finalized in mutez */
10440+
finalizable_balance: string;
10441+
/**
10442+
* Format: date-time
10443+
* @description Date at which the stake was staked
10444+
* @example 2023-01-14T01:13:59Z
10445+
*/
10446+
staked_at?: string;
1039510447
};
1039610448
XTZRewardByDay: {
1039710449
/**
@@ -36068,6 +36120,39 @@ export interface components {
3606836120
*/
3606936121
updated_at: string;
3607036122
};
36123+
TRXReward: {
36124+
/**
36125+
* @description Wallet address
36126+
* @example TAERHY5gyzDRmAaeqqa6C4Fuyc9HLnnHx7
36127+
*/
36128+
wallet: string;
36129+
/**
36130+
* Format: date-time
36131+
* @description Date of the reward
36132+
* @example 2025-03-21 18:10:27.816999375 +0000 UTC
36133+
*/
36134+
date: string;
36135+
/**
36136+
* @description Rewards in TRX
36137+
* @example 0.0024145
36138+
*/
36139+
rewards: string;
36140+
/**
36141+
* @description Net annual percentage yield
36142+
* @example 4.5
36143+
*/
36144+
net_apy: number;
36145+
/**
36146+
* @description Total wallet votes
36147+
* @example 4
36148+
*/
36149+
wallet_votes: number;
36150+
/**
36151+
* @description Total validator votes
36152+
* @example 100
36153+
*/
36154+
validator_votes: number;
36155+
};
3607136156
};
3607236157
responses: never;
3607336158
parameters: {
@@ -54920,6 +55005,50 @@ export interface operations {
5492055005
};
5492155006
};
5492255007
};
55008+
getTonTxDecoding: {
55009+
parameters: {
55010+
query: {
55011+
/** @description Raw transaction to decode */
55012+
tx_serialized: string;
55013+
};
55014+
header?: never;
55015+
path?: never;
55016+
cookie?: never;
55017+
};
55018+
requestBody?: never;
55019+
responses: {
55020+
/** @description Successful operation */
55021+
200: {
55022+
headers: {
55023+
[name: string]: unknown;
55024+
};
55025+
content: {
55026+
"application/json; charset=utf-8": Record<string, never>;
55027+
};
55028+
};
55029+
/** @description Invalid parameters */
55030+
400: {
55031+
headers: {
55032+
[name: string]: unknown;
55033+
};
55034+
content?: never;
55035+
};
55036+
/** @description Unauthorized */
55037+
401: {
55038+
headers: {
55039+
[name: string]: unknown;
55040+
};
55041+
content?: never;
55042+
};
55043+
/** @description Internal server error */
55044+
500: {
55045+
headers: {
55046+
[name: string]: unknown;
55047+
};
55048+
content?: never;
55049+
};
55050+
};
55051+
};
5492355052
postTonStakeSingleNominationPoolTx: {
5492455053
parameters: {
5492555054
query?: never;
@@ -55584,6 +55713,57 @@ export interface operations {
5558455713
};
5558555714
};
5558655715
};
55716+
getTrxRewards: {
55717+
parameters: {
55718+
query?: {
55719+
wallets?: components["parameters"]["TRXWalletsParam"];
55720+
/** @description Comma-separated list of Kiln accounts identifiers */
55721+
accounts?: components["parameters"]["AccountsParam"];
55722+
/** @description Get data from this date (YYYY-MM-DD) */
55723+
start_date?: components["parameters"]["StartDateParam"];
55724+
/** @description Get data to this date (YYYY-MM-DD) */
55725+
end_date?: components["parameters"]["EndDateParam"];
55726+
};
55727+
header?: never;
55728+
path?: never;
55729+
cookie?: never;
55730+
};
55731+
requestBody?: never;
55732+
responses: {
55733+
/** @description Successful operation */
55734+
200: {
55735+
headers: {
55736+
[name: string]: unknown;
55737+
};
55738+
content: {
55739+
"application/json; charset=utf-8": {
55740+
data: components["schemas"]["TRXReward"][];
55741+
};
55742+
};
55743+
};
55744+
/** @description Invalid parameters */
55745+
400: {
55746+
headers: {
55747+
[name: string]: unknown;
55748+
};
55749+
content?: never;
55750+
};
55751+
/** @description Unauthorized */
55752+
401: {
55753+
headers: {
55754+
[name: string]: unknown;
55755+
};
55756+
content?: never;
55757+
};
55758+
/** @description Internal server error */
55759+
500: {
55760+
headers: {
55761+
[name: string]: unknown;
55762+
};
55763+
content?: never;
55764+
};
55765+
};
55766+
};
5558755767
postTrxStakeTx: {
5558855768
parameters: {
5558955769
query?: never;

0 commit comments

Comments
 (0)