@autonomys/auto-consensus 1.6.0 → 1.6.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/README.md +49 -0
- package/dist/types/staking.d.ts +20 -2
- package/dist/types/staking.d.ts.map +1 -1
- package/dist/utils/parse.d.ts.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -324,6 +324,55 @@ import { activate, activateWallet, signAndSendTx } from '@autonomys/auto-utils'
|
|
|
324
324
|
|
|
325
325
|
- A SubmittableExtrinsic transaction object.
|
|
326
326
|
|
|
327
|
+
#### **Unlock a Nominator**
|
|
328
|
+
|
|
329
|
+
Release a nominator's stake and storage-fee deposit after an operator has been deregistered and the withdrawal locking period has elapsed.
|
|
330
|
+
|
|
331
|
+
> **Important:** `unlockNominator` only succeeds when:
|
|
332
|
+
>
|
|
333
|
+
> 1. The operator status is `Deregistered` (call `deregisterOperator` and wait for at least one epoch transition so the status updates).
|
|
334
|
+
> 2. The domain head block number is greater than or equal to the withdrawal’s `unlock_at_confirmed_domain_block_number` (you can read it via `nominatorPosition` and compare it with `apis.domain.rpc.chain.getHeader()` or `latestConfirmedDomainBlock`).
|
|
335
|
+
|
|
336
|
+
```typescript
|
|
337
|
+
import { unlockNominator } from '@autonomys/auto-consensus'
|
|
338
|
+
import { activate, activateWallet, signAndSendTx } from '@autonomys/auto-utils'
|
|
339
|
+
;(async () => {
|
|
340
|
+
const api = await activate({ networkId: 'your_network_id' })
|
|
341
|
+
const { accounts } = await activateWallet({
|
|
342
|
+
networkId: 'your_network_id',
|
|
343
|
+
mnemonic: 'nominator_mnemonic',
|
|
344
|
+
})
|
|
345
|
+
const nominator = accounts[0]
|
|
346
|
+
|
|
347
|
+
const operatorId = '1'
|
|
348
|
+
const tx = unlockNominator({ api, operatorId })
|
|
349
|
+
|
|
350
|
+
await signAndSendTx(nominator, tx)
|
|
351
|
+
})()
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
#### **Unlock Withdrawn Funds**
|
|
355
|
+
|
|
356
|
+
For normal withdrawals (when a nominator calls one of the `withdrawStake*` helpers), use `unlockFunds` after the withdrawal’s lock period expires.
|
|
357
|
+
|
|
358
|
+
```typescript
|
|
359
|
+
import { unlockFunds } from '@autonomys/auto-consensus'
|
|
360
|
+
import { activate, activateWallet, signAndSendTx } from '@autonomys/auto-utils'
|
|
361
|
+
;(async () => {
|
|
362
|
+
const api = await activate({ networkId: 'your_network_id' })
|
|
363
|
+
const { accounts } = await activateWallet({
|
|
364
|
+
networkId: 'your_network_id',
|
|
365
|
+
mnemonic: 'nominator_mnemonic',
|
|
366
|
+
})
|
|
367
|
+
const nominator = accounts[0]
|
|
368
|
+
|
|
369
|
+
const operatorId = '1'
|
|
370
|
+
const tx = unlockFunds({ api, operatorId })
|
|
371
|
+
|
|
372
|
+
await signAndSendTx(nominator, tx)
|
|
373
|
+
})()
|
|
374
|
+
```
|
|
375
|
+
|
|
327
376
|
### 5. Blockchain Information
|
|
328
377
|
|
|
329
378
|
#### **Get Block and Network Information**
|
package/dist/types/staking.d.ts
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
import type { ApiPromise } from '@autonomys/auto-utils';
|
|
2
2
|
export type RawOperatorId = string[];
|
|
3
|
+
export type DomainEpoch = [number, number];
|
|
4
|
+
export type DeregisteredStatus = {
|
|
5
|
+
domainEpoch: DomainEpoch;
|
|
6
|
+
unlockAtConfirmedDomainBlockNumber: number;
|
|
7
|
+
};
|
|
8
|
+
export type RegisteredStatus = {
|
|
9
|
+
domainEpoch: DomainEpoch;
|
|
10
|
+
};
|
|
11
|
+
export type OperatorPartialStatus = {
|
|
12
|
+
Registered?: RegisteredStatus;
|
|
13
|
+
Deregistered?: DeregisteredStatus;
|
|
14
|
+
PendingOperator?: RegisteredStatus;
|
|
15
|
+
PendingNominator?: RegisteredStatus;
|
|
16
|
+
Slashed?: {
|
|
17
|
+
slashPercentage: number;
|
|
18
|
+
};
|
|
19
|
+
[key: string]: unknown;
|
|
20
|
+
};
|
|
3
21
|
export type RawOperatorDetails = {
|
|
4
22
|
signingKey: string;
|
|
5
23
|
currentDomainId: number;
|
|
@@ -8,7 +26,7 @@ export type RawOperatorDetails = {
|
|
|
8
26
|
nominationTax: number;
|
|
9
27
|
currentTotalStake: number;
|
|
10
28
|
currentTotalShares: number;
|
|
11
|
-
partialStatus:
|
|
29
|
+
partialStatus: OperatorPartialStatus;
|
|
12
30
|
depositsInEpoch: string;
|
|
13
31
|
withdrawalsInEpoch: number;
|
|
14
32
|
totalStorageFeeDeposit: string;
|
|
@@ -29,7 +47,7 @@ export type OperatorDetails = {
|
|
|
29
47
|
nominationTax: number;
|
|
30
48
|
currentTotalStake: bigint;
|
|
31
49
|
currentTotalShares: bigint;
|
|
32
|
-
partialStatus:
|
|
50
|
+
partialStatus: OperatorPartialStatus;
|
|
33
51
|
depositsInEpoch: bigint;
|
|
34
52
|
withdrawalsInEpoch: bigint;
|
|
35
53
|
totalStorageFeeDeposit: bigint;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../../src/types/staking.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD,MAAM,MAAM,aAAa,GAAG,MAAM,EAAE,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,aAAa,EAAE,MAAM,CAAA;IACrB,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,
|
|
1
|
+
{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../../src/types/staking.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD,MAAM,MAAM,aAAa,GAAG,MAAM,EAAE,CAAA;AAEpC,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAE1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,WAAW,CAAA;IACxB,kCAAkC,EAAE,MAAM,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,WAAW,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC,OAAO,CAAC,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,CAAA;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,aAAa,EAAE,MAAM,CAAA;IACrB,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,qBAAqB,CAAA;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,aAAa,EAAE,MAAM,CAAA;IACrB,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,qBAAqB,CAAA;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,eAAe,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAE/C,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACtC,MAAM,EAAE,MAAM,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC1B,GAAG,IAAI,CAAA;CACT,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,MAAM,CAAA;IACzB,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,iBAAiB,EAAE,MAAM,CAAA;QACzB,oBAAoB,EAAE,MAAM,CAAA;QAC5B,MAAM,EAAE,MAAM,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC1B,GAAG,IAAI,CAAA;CACT,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAElD,MAAM,MAAM,aAAa,GAAG;IAC1B,qBAAqB,EAAE,MAAM,CAAA;IAC7B,WAAW,EACP;QACE,QAAQ,EAAE,MAAM,CAAA;QAChB,kCAAkC,EAAE,MAAM,CAAA;QAC1C,cAAc,EAAE,MAAM,CAAA;QACtB,gBAAgB,EAAE,MAAM,CAAA;KACzB,EAAE,GACH,IAAI,CAAA;IACR,kBAAkB,EAAE;QAClB,WAAW,EAAE,MAAM,EAAE,CAAA;QACrB,kCAAkC,EAAE,MAAM,CAAA;QAC1C,MAAM,EAAE,MAAM,CAAA;QACd,gBAAgB,EAAE,MAAM,CAAA;KACzB,GAAG,IAAI,CAAA;CACT,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,kCAAkC,EAAE,MAAM,CAAA;IAC1C,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,kCAAkC,EAAE,MAAM,CAAA;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,qBAAqB,EAAE,MAAM,CAAA;IAC7B,WAAW,EAAE,gBAAgB,EAAE,CAAA;IAC/B,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;AAE3D,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,EAAE,UAAU,CAAA;IACf,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,aAAa,EAAE,oBAAoB,CAAA;IACnC,qBAAqB,EAAE,oBAAoB,CAAA;IAC3C,aAAa,EAAE,oBAAoB,CAAA;IACnC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,UAAU,CAAA;IACf,UAAU,EAAE,oBAAoB,CAAA;CACjC,CAAA;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,MAAM,EAAE,oBAAoB,CAAA;CAC7B;AAED,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,aAAa,EAAE,oBAAoB,CAAA;CACpC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/utils/parse.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACzF,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EACL,OAAO,EACP,QAAQ,EACR,eAAe,
|
|
1
|
+
{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/utils/parse.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACzF,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EACL,OAAO,EACP,QAAQ,EACR,eAAe,EAMf,aAAa,EAEb,oBAAoB,EACpB,UAAU,EACV,kBAAkB,EACnB,MAAM,kBAAkB,CAAA;AAEzB,eAAO,MAAM,OAAO,GAAI,OAAO,EAAE,KAAG,MAAkC,CAAA;AAEtE,eAAO,MAAM,YAAY,GAAI,MAAM,cAAc,KAAG,WAYnD,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,WAAW,KAAK,KAAG,SAuBjD,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAI,OAAO,WAAW,KAAG,SAAS,EAGlE,CAAA;AAED,eAAO,MAAM,mBAAmB,GAAI,OAAO,WAAW,KAAG,SAAS,EAWjE,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,KAAG,cAMnE,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAI,iBAAiB,KAAK,KAAG,eAe7D,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,KAAG,QAKvE,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,KAAG,OAuBrE,CAAA;AAED,eAAO,MAAM,uBAAuB,GAClC,oBAAoB,WAAW,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,KACnE,kBAKD,CAAA;AAEF,eAAO,MAAM,eAAe,GAAI,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,KAAG,UAsB3E,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,YAAY,oBAAoB,KAAG,MACM,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@autonomys/auto-consensus",
|
|
3
|
-
"version": "1.6.
|
|
3
|
+
"version": "1.6.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"repository": {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"README.md"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@autonomys/auto-utils": "^1.6.
|
|
28
|
+
"@autonomys/auto-utils": "^1.6.2",
|
|
29
29
|
"zod": "^3.24.2"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
@@ -36,5 +36,5 @@
|
|
|
36
36
|
"ts-jest": "^29.3.1",
|
|
37
37
|
"typescript": "^5.8.3"
|
|
38
38
|
},
|
|
39
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "910aff6c92f736b87f7986780d667035b9c72217"
|
|
40
40
|
}
|