Skip to content

Commit 7080cdc

Browse files
mkaczanowskimkaczanowski
committed
regenerate gitbook
1 parent 2ff1099 commit 7080cdc

5 files changed

+106
-20
lines changed

‎book/docs/classes/ton_src.TonNominatorPoolStaker.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,20 @@ ___
9898

9999
## getMnemonicToSeedFn
100100

101-
▸ **getMnemonicToSeedFn**(): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
101+
▸ **getMnemonicToSeedFn**(`params?`): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
102102

103103
This **static** method is used to convert BIP39 mnemonic to seed. In TON
104104
network the seed is used as a private key.
105105

106106
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
107107

108+
### Parameters
109+
110+
| Name | Type | Description |
111+
| :------ | :------ | :------ |
112+
| `params?` | `Object` | - |
113+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
114+
108115
### Returns
109116

110117
`fn`
@@ -132,13 +139,20 @@ ___
132139

133140
## getSeedToKeypairFn
134141

135-
▸ **getSeedToKeypairFn**(): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
142+
▸ **getSeedToKeypairFn**(`params?`): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
136143

137144
This **static** method is used to convert a seed to a keypair. Note that
138145
TON network doesn't use BIP44 HD Path for address derivation.
139146

140147
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
141148

149+
### Parameters
150+
151+
| Name | Type | Description |
152+
| :------ | :------ | :------ |
153+
| `params?` | `Object` | - |
154+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
155+
142156
### Returns
143157

144158
`fn`

‎book/docs/classes/ton_src.TonPoolStaker.md

+64-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
- [buildUnstakeTx](ton_src.TonPoolStaker.md#buildunstaketx)
2020
- [getStake](ton_src.TonPoolStaker.md#getstake)
2121
- [getPoolParams](ton_src.TonPoolStaker.md#getpoolparams)
22+
- [getMinStake](ton_src.TonPoolStaker.md#getminstake)
23+
- [getPoolStatus](ton_src.TonPoolStaker.md#getpoolstatus)
24+
- [getPastElections](ton_src.TonPoolStaker.md#getpastelections)
2225
- [init](ton_src.TonPoolStaker.md#init)
2326
- [buildDeployWalletTx](ton_src.TonPoolStaker.md#builddeploywallettx)
2427
- [sign](ton_src.TonPoolStaker.md#sign)
@@ -98,13 +101,20 @@ ___
98101

99102
## getMnemonicToSeedFn
100103

101-
▸ **getMnemonicToSeedFn**(): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
104+
▸ **getMnemonicToSeedFn**(`params?`): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
102105

103106
This **static** method is used to convert BIP39 mnemonic to seed. In TON
104107
network the seed is used as a private key.
105108

106109
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
107110

111+
### Parameters
112+
113+
| Name | Type | Description |
114+
| :------ | :------ | :------ |
115+
| `params?` | `Object` | - |
116+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
117+
108118
### Returns
109119

110120
`fn`
@@ -132,13 +142,20 @@ ___
132142

133143
## getSeedToKeypairFn
134144

135-
▸ **getSeedToKeypairFn**(): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
145+
▸ **getSeedToKeypairFn**(`params?`): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
136146

137147
This **static** method is used to convert a seed to a keypair. Note that
138148
TON network doesn't use BIP44 HD Path for address derivation.
139149

140150
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
141151

152+
### Parameters
153+
154+
| Name | Type | Description |
155+
| :------ | :------ | :------ |
156+
| `params?` | `Object` | - |
157+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
158+
142159
### Returns
143160

144161
`fn`
@@ -200,8 +217,10 @@ Builds an unstaking transaction for TON Pool contract.
200217
| Name | Type | Description |
201218
| :------ | :------ | :------ |
202219
| `params` | `Object` | Parameters for building the transaction |
203-
| `params.validatorAddress` | `string` | The validator address to unstake from |
220+
| `params.delegatorAddress` | `string` | - |
221+
| `params.validatorAddressPair` | [`string`, `string`] | The validator address pair to unstake from |
204222
| `params.amount` | `string` | The amount to stake, specified in `TON` |
223+
| `params.disableStatefulCalculation?` | `boolean` | (Optional) Disables stateful calculation where validator and user stake is taken into account |
205224
| `params.validUntil?` | `number` | (Optional) The Unix timestamp when the transaction expires |
206225

207226
### Returns
@@ -255,6 +274,48 @@ Returns a promise that resolves to the staking information for the specified poo
255274

256275
___
257276

277+
## getMinStake
278+
279+
▸ **getMinStake**(): `Promise`\<`bigint`\>
280+
281+
### Returns
282+
283+
`Promise`\<`bigint`\>
284+
285+
___
286+
287+
## getPoolStatus
288+
289+
▸ **getPoolStatus**(`validatorAddress`): `Promise`\<`PoolStatus`\>
290+
291+
### Parameters
292+
293+
| Name | Type |
294+
| :------ | :------ |
295+
| `validatorAddress` | `string` |
296+
297+
### Returns
298+
299+
`Promise`\<`PoolStatus`\>
300+
301+
___
302+
303+
## getPastElections
304+
305+
▸ **getPastElections**(`electorContractAddress`): `Promise`\<`Election`[]\>
306+
307+
### Parameters
308+
309+
| Name | Type |
310+
| :------ | :------ |
311+
| `electorContractAddress` | `string` |
312+
313+
### Returns
314+
315+
`Promise`\<`Election`[]\>
316+
317+
___
318+
258319
## init
259320

260321
▸ **init**(): `Promise`\<`void`\>

‎book/docs/classes/ton_src.TonSingleNominatorPoolStaker.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,20 @@ ___
9898

9999
## getMnemonicToSeedFn
100100

101-
▸ **getMnemonicToSeedFn**(): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
101+
▸ **getMnemonicToSeedFn**(`params?`): (`mnemonic`: `string`, `password?`: `string`) => `Promise`\<`Uint8Array`\>
102102

103103
This **static** method is used to convert BIP39 mnemonic to seed. In TON
104104
network the seed is used as a private key.
105105

106106
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
107107

108+
### Parameters
109+
110+
| Name | Type | Description |
111+
| :------ | :------ | :------ |
112+
| `params?` | `Object` | - |
113+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
114+
108115
### Returns
109116

110117
`fn`
@@ -132,13 +139,20 @@ ___
132139

133140
## getSeedToKeypairFn
134141

135-
▸ **getSeedToKeypairFn**(): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
142+
▸ **getSeedToKeypairFn**(`params?`): (`seed`: `Uint8Array`, `hdPath?`: `string`) => `Promise`\<\{ `publicKey`: `Uint8Array` ; `privateKey`: `Uint8Array` }\>
136143

137144
This **static** method is used to convert a seed to a keypair. Note that
138145
TON network doesn't use BIP44 HD Path for address derivation.
139146

140147
It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.
141148

149+
### Parameters
150+
151+
| Name | Type | Description |
152+
| :------ | :------ | :------ |
153+
| `params?` | `Object` | - |
154+
| `params.addressDerivationConfig` | [`AddressDerivationConfig`](../interfaces/ton_src.AddressDerivationConfig.md) | TON address derivation configuration |
155+
142156
### Returns
143157

144158
`fn`

‎book/docs/interfaces/ton_src.AddressDerivationConfig.md

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [bounceable](ton_src.AddressDerivationConfig.md#bounceable)
88
- [testOnly](ton_src.AddressDerivationConfig.md#testonly)
99
- [urlSafe](ton_src.AddressDerivationConfig.md#urlsafe)
10+
- [isBIP39](ton_src.AddressDerivationConfig.md#isbip39)
1011

1112
## Properties
1213

@@ -37,3 +38,9 @@ ___
3738
### urlSafe
3839

3940
• **urlSafe**: `boolean`
41+
42+
___
43+
44+
### isBIP39
45+
46+
• **isBIP39**: `boolean`

‎book/docs/interfaces/ton_src.UnsignedTx.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,14 @@
22

33
### Properties
44

5-
- [message](ton_src.UnsignedTx.md#message)
5+
- [messages](ton_src.UnsignedTx.md#messages)
66
- [validUntil](ton_src.UnsignedTx.md#validuntil)
77

88
## Properties
99

10-
### message
10+
### messages
1111

12-
• `Optional` **message**: `Object`
13-
14-
#### Type declaration
15-
16-
| Name | Type |
17-
| :------ | :------ |
18-
| `address` | `string` |
19-
| `amount` | `bigint` |
20-
| `bounceable` | `boolean` |
21-
| `stateInit?` | `StateInit` |
22-
| `payload?` | `string` \| `Cell` |
12+
• `Optional` **messages**: `Message`[]
2313

2414
___
2515

0 commit comments

Comments
 (0)