Skip to content

Commit 988216b

Browse files
committed
Address missing optional fee review comments
1 parent 76b3e01 commit 988216b

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

mini-apps/api-reference/nimiq-provider.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Sends a basic NIM payment.
123123
- `recipient` (string, required): Nimiq user-friendly address.
124124
- `value` (number, required): amount in Luna (1 NIM = 100,000 Luna).
125125
- `fee` (number, optional): transaction fee in Luna.
126+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
126127

127128
**Returns**
128129

@@ -143,6 +144,10 @@ Sends a basic NIM payment.
143144
const txHash = await nimiq.sendBasicTransaction({
144145
recipient: 'NQ07 0000 0000 0000 0000 0000 0000 0000 0000',
145146
value: 100000,
147+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
148+
fee: 1000,
149+
// Optional.
150+
validityStartHeight: 123456,
146151
})
147152
```
148153

@@ -155,7 +160,8 @@ Sends a NIM payment with an attached text message.
155160
- `recipient` (string, required): Nimiq user-friendly address.
156161
- `value` (number, required): amount in Luna (1 NIM = 100,000 Luna).
157162
- `fee` (number, optional): transaction fee in Luna.
158-
- `data` (string, optional): text message to attach.
163+
- `data` (string, required): text message to attach.
164+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
159165

160166
**Returns**
161167

@@ -177,6 +183,10 @@ const txHash = await nimiq.sendBasicTransactionWithData({
177183
recipient: 'NQ07 0000 0000 0000 0000 0000 0000 0000 0000',
178184
value: 100000,
179185
data: 'mic check',
186+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
187+
fee: 1000,
188+
// Optional.
189+
validityStartHeight: 123456,
180190
})
181191
```
182192

@@ -188,7 +198,8 @@ Creates a new staking transaction.
188198

189199
- `delegation` (string, required): validator address or delegation target.
190200
- `value` (number, required): amount in Luna.
191-
- `fee` (number, required): transaction fee in Luna.
201+
- `fee` (number, optional): transaction fee in Luna.
202+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
192203

193204
**Returns**
194205

@@ -209,7 +220,10 @@ Creates a new staking transaction.
209220
const txHash = await nimiq.sendNewStakerTransaction({
210221
delegation: 'NQ07 0000 0000 0000 0000 0000 0000 0000 0000',
211222
value: 100000,
223+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
212224
fee: 1000,
225+
// Optional.
226+
validityStartHeight: 123456,
213227
})
214228
```
215229

@@ -255,7 +269,8 @@ Sets the active stake amount.
255269
**Parameters**
256270

257271
- `newActiveBalance` (number, required): active stake amount in Luna.
258-
- `fee` (number, required): transaction fee in Luna.
272+
- `fee` (number, optional): transaction fee in Luna.
273+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
259274

260275
**Returns**
261276

@@ -275,7 +290,10 @@ Sets the active stake amount.
275290
```ts
276291
const txHash = await nimiq.sendSetActiveStakeTransaction({
277292
newActiveBalance: 100000,
293+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
278294
fee: 1000,
295+
// Optional.
296+
validityStartHeight: 123456,
279297
})
280298
```
281299

@@ -286,8 +304,9 @@ Updates staker settings.
286304
**Parameters**
287305

288306
- `newDelegation` (string, required): new validator address or delegation target.
289-
- `reactivateAllStake` (boolean, required): whether to reactivate all stake.
290-
- `fee` (number, required): transaction fee in Luna.
307+
- `reactivateAllStake` (boolean, optional): whether to reactivate all stake.
308+
- `fee` (number, optional): transaction fee in Luna.
309+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
291310

292311
**Returns**
293312

@@ -308,7 +327,10 @@ Updates staker settings.
308327
const txHash = await nimiq.sendUpdateStakerTransaction({
309328
newDelegation: 'NQ07 0000 0000 0000 0000 0000 0000 0000 0000',
310329
reactivateAllStake: true,
330+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
311331
fee: 1000,
332+
// Optional.
333+
validityStartHeight: 123456,
312334
})
313335
```
314336

@@ -319,7 +341,8 @@ Retires stake from a staker.
319341
**Parameters**
320342

321343
- `retireStake` (number, required): amount in Luna to retire.
322-
- `fee` (number, required): transaction fee in Luna.
344+
- `fee` (number, optional): transaction fee in Luna.
345+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
323346

324347
**Returns**
325348

@@ -339,7 +362,10 @@ Retires stake from a staker.
339362
```ts
340363
const txHash = await nimiq.sendRetireStakeTransaction({
341364
retireStake: 100000,
365+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
342366
fee: 1000,
367+
// Optional.
368+
validityStartHeight: 123456,
343369
})
344370
```
345371

@@ -350,7 +376,8 @@ Removes stake from a staker.
350376
**Parameters**
351377

352378
- `value` (number, required): amount in Luna.
353-
- `fee` (number, required): transaction fee in Luna.
379+
- `fee` (number, optional): transaction fee in Luna.
380+
- `validityStartHeight` (number, optional): block height from which the transaction becomes valid.
354381

355382
**Returns**
356383

@@ -370,6 +397,9 @@ Removes stake from a staker.
370397
```ts
371398
const txHash = await nimiq.sendRemoveStakeTransaction({
372399
value: 100000,
400+
// Optional. Nimiq Pay chooses a fee automatically, using 0 if possible.
373401
fee: 1000,
402+
// Optional.
403+
validityStartHeight: 123456,
374404
})
375405
```

0 commit comments

Comments
 (0)