@xyo-network/chain-wrappers 1.16.14 → 1.16.15

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.
Files changed (2) hide show
  1. package/README.md +252 -960
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -25,8 +25,6 @@ XYO Layer One SDK Wrappers
25
25
  - [BaseWrapper](#classes/BaseWrapper)
26
26
  - [FeesWrapper](#classes/FeesWrapper)
27
27
  - [SignatureWrapper](#classes/SignatureWrapper)
28
- - [~~ShiftedBigInt~~](#classes/ShiftedBigInt)
29
- - [~~XL1Amount~~](#classes/XL1Amount)
30
28
  - [ChainWrapper](#classes/ChainWrapper)
31
29
  - [HydratedTransactionWrapper](#classes/HydratedTransactionWrapper)
32
30
 
@@ -37,7 +35,6 @@ XYO Layer One SDK Wrappers
37
35
  - [HydratedBlockRangeStoreParams](#interfaces/HydratedBlockRangeStoreParams)
38
36
  - [IndexedHydratedBlockRangeStoreInstance](#interfaces/IndexedHydratedBlockRangeStoreInstance)
39
37
  - [BaseWrapperConfig](#interfaces/BaseWrapperConfig)
40
- - [~~XL1AmountInstance~~](#interfaces/XL1AmountInstance)
41
38
 
42
39
  ## Type Aliases
43
40
 
@@ -45,8 +42,6 @@ XYO Layer One SDK Wrappers
45
42
 
46
43
  ## Variables
47
44
 
48
- - [~~splitOnDecimal~~](#variables/splitOnDecimal)
49
- - [~~splitOnDecimalToString~~](#variables/splitOnDecimalToString)
50
45
  - [createSignatureWrappers](#variables/createSignatureWrappers)
51
46
 
52
47
  ### classes
@@ -116,12 +111,12 @@ protected readonly value: T;
116
111
  ### Get Signature
117
112
 
118
113
  ```ts
119
- get provider(): undefined | XyoConnection;
114
+ get provider(): XyoConnection | undefined;
120
115
  ```
121
116
 
122
117
  #### Returns
123
118
 
124
- `undefined` \| `XyoConnection`
119
+ `XyoConnection` \| `undefined`
125
120
 
126
121
  ## Methods
127
122
 
@@ -225,13 +220,11 @@ protected new ChainWrapper(value, config?): ChainWrapper;
225
220
 
226
221
  #### value
227
222
 
228
- `Brand`
223
+ `Address`
229
224
 
230
225
  #### config?
231
226
 
232
- `Partial`\<[`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
233
- \}\>, \{
234
- \}\>\>\>
227
+ `Partial`\<[`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Address`\>\>
235
228
 
236
229
  ### Returns
237
230
 
@@ -258,7 +251,7 @@ protected readonly config: Partial<C>;
258
251
  ### value
259
252
 
260
253
  ```ts
261
- protected readonly value: Brand;
254
+ protected readonly value: Address;
262
255
  ```
263
256
 
264
257
  ### Inherited from
@@ -272,12 +265,12 @@ protected readonly value: Brand;
272
265
  ### Get Signature
273
266
 
274
267
  ```ts
275
- get provider(): undefined | XyoConnection;
268
+ get provider(): XyoConnection | undefined;
276
269
  ```
277
270
 
278
271
  #### Returns
279
272
 
280
- `undefined` \| `XyoConnection`
273
+ `XyoConnection` \| `undefined`
281
274
 
282
275
  ### Inherited from
283
276
 
@@ -290,12 +283,12 @@ get provider(): undefined | XyoConnection;
290
283
  ### Get Signature
291
284
 
292
285
  ```ts
293
- get id(): Brand;
286
+ get id(): Address;
294
287
  ```
295
288
 
296
289
  #### Returns
297
290
 
298
- `Brand`
291
+ `Address`
299
292
 
300
293
  ## Methods
301
294
 
@@ -527,7 +520,7 @@ TransactionFeesInstance.validate
527
520
 
528
521
  ## Implements
529
522
 
530
- - `HydratedBlockInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>
523
+ - `HydratedBlockInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>
531
524
 
532
525
  ## Constructors
533
526
 
@@ -541,7 +534,7 @@ protected new HydratedBlockWrapper<T>(data): HydratedBlockWrapper<T>;
541
534
 
542
535
  #### data
543
536
 
544
- \[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]
537
+ \[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]
545
538
 
546
539
  ### Returns
547
540
 
@@ -552,7 +545,7 @@ protected new HydratedBlockWrapper<T>(data): HydratedBlockWrapper<T>;
552
545
  ### data
553
546
 
554
547
  ```ts
555
- data: [WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]];
548
+ data: [WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]];
556
549
  ```
557
550
 
558
551
  ### Implementation of
@@ -566,7 +559,7 @@ HydratedBlockInstance.data
566
559
  ### allPayloadsCache
567
560
 
568
561
  ```ts
569
- protected allPayloadsCache: WithHashStorageMeta<WithHashStorageMeta<T[1][number]>>[] = [];
562
+ protected allPayloadsCache: WithHashMeta<WithHashMeta<T[1][number]>>[] = [];
570
563
  ```
571
564
 
572
565
  ***
@@ -584,12 +577,12 @@ protected transactionsCache: HydratedTransactionInstance<HydratedTransactionWith
584
577
  ### Get Signature
585
578
 
586
579
  ```ts
587
- get block(): number;
580
+ get block(): number & object & object;
588
581
  ```
589
582
 
590
583
  #### Returns
591
584
 
592
- `number`
585
+ `number` & `object` & `object`
593
586
 
594
587
  ***
595
588
 
@@ -598,12 +591,12 @@ get block(): number;
598
591
  ### Get Signature
599
592
 
600
593
  ```ts
601
- get boundWitness(): WithHashStorageMeta<T[0]>;
594
+ get boundWitness(): WithHashMeta<T[0]>;
602
595
  ```
603
596
 
604
597
  #### Returns
605
598
 
606
- `WithHashStorageMeta`\<`T`\[`0`\]\>
599
+ `WithHashMeta`\<`T`\[`0`\]\>
607
600
 
608
601
  ### Implementation of
609
602
 
@@ -618,12 +611,12 @@ HydratedBlockInstance.boundWitness
618
611
  ### Get Signature
619
612
 
620
613
  ```ts
621
- get chain(): Brand;
614
+ get chain(): Hex;
622
615
  ```
623
616
 
624
617
  #### Returns
625
618
 
626
- `Brand`
619
+ `Hex`
627
620
 
628
621
  ***
629
622
 
@@ -746,16 +739,12 @@ HydratedBlockInstance.signatures
746
739
  ### Get Signature
747
740
 
748
741
  ```ts
749
- get stepHashes(): Brand<Brand<Lowercase<string>, {
750
- }>, {
751
- }>[];
742
+ get stepHashes(): Hash[];
752
743
  ```
753
744
 
754
745
  #### Returns
755
746
 
756
- `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
757
- \}\>, \{
758
- \}\>[]
747
+ `Hash`[]
759
748
 
760
749
  ***
761
750
 
@@ -830,7 +819,7 @@ static parse<T>(block, validate): Promise<HydratedBlockInstance<HydratedBlock>>;
830
819
  ### payload()
831
820
 
832
821
  ```ts
833
- payload(index): undefined | WithHashStorageMeta<T[1][number]>;
822
+ payload(index): WithHashMeta<T[1][number]> | undefined;
834
823
  ```
835
824
 
836
825
  ### Parameters
@@ -841,7 +830,7 @@ payload(index): undefined | WithHashStorageMeta<T[1][number]>;
841
830
 
842
831
  ### Returns
843
832
 
844
- `undefined` \| `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>
833
+ `WithHashMeta`\<`T`\[`1`\]\[`number`\]\> \| `undefined`
845
834
 
846
835
  ### Implementation of
847
836
 
@@ -854,7 +843,7 @@ HydratedBlockInstance.payload
854
843
  ### signature()
855
844
 
856
845
  ```ts
857
- signature(index): undefined | SignatureInstance;
846
+ signature(index): SignatureInstance | undefined;
858
847
  ```
859
848
 
860
849
  ### Parameters
@@ -865,7 +854,7 @@ signature(index): undefined | SignatureInstance;
865
854
 
866
855
  ### Returns
867
856
 
868
- `undefined` \| `SignatureInstance`
857
+ `SignatureInstance` \| `undefined`
869
858
 
870
859
  ### Implementation of
871
860
 
@@ -879,8 +868,8 @@ HydratedBlockInstance.signature
879
868
 
880
869
  ```ts
881
870
  transaction(index):
882
- | undefined
883
- | HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>;
871
+ | HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>
872
+ | undefined;
884
873
  ```
885
874
 
886
875
  ### Parameters
@@ -891,8 +880,8 @@ transaction(index):
891
880
 
892
881
  ### Returns
893
882
 
894
- \| `undefined`
895
883
  \| `HydratedTransactionInstance`\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>
884
+ \| `undefined`
896
885
 
897
886
  ### Implementation of
898
887
 
@@ -932,7 +921,7 @@ validateState(services): Promise<Error[]>;
932
921
 
933
922
  ##### accountBalance
934
923
 
935
- `AccountBalanceServiceV2`
924
+ `AccountBalanceService`
936
925
 
937
926
  ### Returns
938
927
 
@@ -943,7 +932,7 @@ validateState(services): Promise<Error[]>;
943
932
  ### parse()
944
933
 
945
934
  ```ts
946
- protected parse(validate): Promise<HydratedBlockInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]]>>;
935
+ protected parse(validate): Promise<HydratedBlockInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]]>>;
947
936
  ```
948
937
 
949
938
  ### Parameters
@@ -954,7 +943,7 @@ protected parse(validate): Promise<HydratedBlockInstance<[WithHashStorageMeta<T[
954
943
 
955
944
  ### Returns
956
945
 
957
- `Promise`\<`HydratedBlockInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>\>
946
+ `Promise`\<`HydratedBlockInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>\>
958
947
 
959
948
  ### <a id="HydratedTransactionWrapper"></a>HydratedTransactionWrapper
960
949
 
@@ -1113,20 +1102,12 @@ HydratedTransactionInstance.externalPayloads
1113
1102
  ### Get Signature
1114
1103
 
1115
1104
  ```ts
1116
- get from(): Brand<Brand<Lowercase<string>, {
1117
- __hex: true;
1118
- }>, {
1119
- __address: true;
1120
- }>;
1105
+ get from(): Address;
1121
1106
  ```
1122
1107
 
1123
1108
  #### Returns
1124
1109
 
1125
- `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
1126
- `__hex`: `true`;
1127
- \}\>, \{
1128
- `__address`: `true`;
1129
- \}\>
1110
+ `Address`
1130
1111
 
1131
1112
  ***
1132
1113
 
@@ -1155,12 +1136,12 @@ HydratedTransactionInstance.payloadCount
1155
1136
  ### Get Signature
1156
1137
 
1157
1138
  ```ts
1158
- get payloads(): WithHashStorageMeta<WithStorageMeta<T[1][number]>>[];
1139
+ get payloads(): WithHashMeta<WithStorageMeta<T[1][number]>>[];
1159
1140
  ```
1160
1141
 
1161
1142
  #### Returns
1162
1143
 
1163
- `WithHashStorageMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
1144
+ `WithHashMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
1164
1145
 
1165
1146
  ### Implementation of
1166
1147
 
@@ -1281,9 +1262,7 @@ static parse<T>(transaction, validate?): Promise<HydratedTransactionInstance<[T[
1281
1262
  ### elevatedPayload()
1282
1263
 
1283
1264
  ```ts
1284
- elevatedPayload(index):
1285
- | undefined
1286
- | WithHashStorageMeta<AllowedBlockPayload & T[1][number]>;
1265
+ elevatedPayload(index): WithHashMeta<AllowedBlockPayload & T[1][number]> | undefined;
1287
1266
  ```
1288
1267
 
1289
1268
  ### Parameters
@@ -1294,8 +1273,7 @@ elevatedPayload(index):
1294
1273
 
1295
1274
  ### Returns
1296
1275
 
1297
- \| `undefined`
1298
- \| `WithHashStorageMeta`\<AllowedBlockPayload & T\[1\]\[number\]\>
1276
+ `WithHashMeta`\<AllowedBlockPayload & T\[1\]\[number\]\> \| `undefined`
1299
1277
 
1300
1278
  ### Implementation of
1301
1279
 
@@ -1320,7 +1298,7 @@ gasRequired(): bigint;
1320
1298
  ### payload()
1321
1299
 
1322
1300
  ```ts
1323
- payload(index): undefined | WithStorageMeta<Payload>;
1301
+ payload(index): WithStorageMeta<Payload> | undefined;
1324
1302
  ```
1325
1303
 
1326
1304
  ### Parameters
@@ -1331,7 +1309,7 @@ payload(index): undefined | WithStorageMeta<Payload>;
1331
1309
 
1332
1310
  ### Returns
1333
1311
 
1334
- `undefined` \| `WithStorageMeta`\<`Payload`\>
1312
+ `WithStorageMeta`\<`Payload`\> \| `undefined`
1335
1313
 
1336
1314
  ### Implementation of
1337
1315
 
@@ -1362,7 +1340,7 @@ HydratedTransactionInstance.reward
1362
1340
  ### signature()
1363
1341
 
1364
1342
  ```ts
1365
- signature(index): undefined | SignatureInstance;
1343
+ signature(index): SignatureInstance | undefined;
1366
1344
  ```
1367
1345
 
1368
1346
  ### Parameters
@@ -1373,7 +1351,7 @@ signature(index): undefined | SignatureInstance;
1373
1351
 
1374
1352
  ### Returns
1375
1353
 
1376
- `undefined` \| `SignatureInstance`
1354
+ `SignatureInstance` \| `undefined`
1377
1355
 
1378
1356
  ### Implementation of
1379
1357
 
@@ -1404,7 +1382,7 @@ HydratedTransactionInstance.validate
1404
1382
  ### parse()
1405
1383
 
1406
1384
  ```ts
1407
- protected parse(validate?): Promise<HydratedTransactionInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]], AllowedBlockPayload>>;
1385
+ protected parse(validate?): Promise<HydratedTransactionInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]], AllowedBlockPayload>>;
1408
1386
  ```
1409
1387
 
1410
1388
  ### Parameters
@@ -1415,7 +1393,7 @@ protected parse(validate?): Promise<HydratedTransactionInstance<[WithHashStorage
1415
1393
 
1416
1394
  ### Returns
1417
1395
 
1418
- `Promise`\<`HydratedTransactionInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
1396
+ `Promise`\<`HydratedTransactionInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
1419
1397
 
1420
1398
  ### <a id="IndexedHydratedBlockRangeStore"></a>IndexedHydratedBlockRangeStore
1421
1399
 
@@ -1509,20 +1487,12 @@ get numberRange(): [number, number];
1509
1487
  ### Get Signature
1510
1488
 
1511
1489
  ```ts
1512
- get range(): [Brand<Brand<Lowercase<string>, {
1513
- }>, {
1514
- }>, Brand<Brand<Lowercase<string>, {
1515
- }>, {
1516
- }>];
1490
+ get range(): [Hash, Hash];
1517
1491
  ```
1518
1492
 
1519
1493
  #### Returns
1520
1494
 
1521
- \[`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
1522
- \}\>, \{
1523
- \}\>, `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
1524
- \}\>, \{
1525
- \}\>\]
1495
+ \[`Hash`, `Hash`\]
1526
1496
 
1527
1497
  ### Implementation of
1528
1498
 
@@ -1567,18 +1537,18 @@ first(): Promise<HydratedBlock>;
1567
1537
  ### fromHash()
1568
1538
 
1569
1539
  ```ts
1570
- fromHash(hash): Promise<undefined | HydratedBlock>;
1540
+ fromHash(hash): Promise<HydratedBlock | undefined>;
1571
1541
  ```
1572
1542
 
1573
1543
  ### Parameters
1574
1544
 
1575
1545
  #### hash
1576
1546
 
1577
- `Brand`
1547
+ `Hash`
1578
1548
 
1579
1549
  ### Returns
1580
1550
 
1581
- `Promise`\<`undefined` \| `HydratedBlock`\>
1551
+ `Promise`\<`HydratedBlock` \| `undefined`\>
1582
1552
 
1583
1553
  ### Implementation of
1584
1554
 
@@ -1589,7 +1559,7 @@ fromHash(hash): Promise<undefined | HydratedBlock>;
1589
1559
  ### fromNumber()
1590
1560
 
1591
1561
  ```ts
1592
- fromNumber(number): Promisable<undefined | HydratedBlock>;
1562
+ fromNumber(number): Promisable<HydratedBlock | undefined>;
1593
1563
  ```
1594
1564
 
1595
1565
  ### Parameters
@@ -1600,7 +1570,7 @@ fromNumber(number): Promisable<undefined | HydratedBlock>;
1600
1570
 
1601
1571
  ### Returns
1602
1572
 
1603
- `Promisable`\<`undefined` \| `HydratedBlock`\>
1573
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
1604
1574
 
1605
1575
  ### Implementation of
1606
1576
 
@@ -1629,7 +1599,7 @@ last(): Promise<HydratedBlock>;
1629
1599
  ### Call Signature
1630
1600
 
1631
1601
  ```ts
1632
- next(from): Promise<undefined | HydratedBlock>;
1602
+ next(from): Promise<HydratedBlock | undefined>;
1633
1603
  ```
1634
1604
 
1635
1605
  #### Parameters
@@ -1640,7 +1610,7 @@ next(from): Promise<undefined | HydratedBlock>;
1640
1610
 
1641
1611
  #### Returns
1642
1612
 
1643
- `Promise`\<`undefined` \| `HydratedBlock`\>
1613
+ `Promise`\<`HydratedBlock` \| `undefined`\>
1644
1614
 
1645
1615
  #### Implementation of
1646
1616
 
@@ -1677,7 +1647,7 @@ next(from, count): Promise<HydratedBlock[]>;
1677
1647
  ### Call Signature
1678
1648
 
1679
1649
  ```ts
1680
- prev(from): Promise<undefined | HydratedBlock>;
1650
+ prev(from): Promise<HydratedBlock | undefined>;
1681
1651
  ```
1682
1652
 
1683
1653
  #### Parameters
@@ -1688,7 +1658,7 @@ prev(from): Promise<undefined | HydratedBlock>;
1688
1658
 
1689
1659
  #### Returns
1690
1660
 
1691
- `Promise`\<`undefined` \| `HydratedBlock`\>
1661
+ `Promise`\<`HydratedBlock` \| `undefined`\>
1692
1662
 
1693
1663
  #### Implementation of
1694
1664
 
@@ -1718,906 +1688,406 @@ prev(from, count): Promise<HydratedBlock[]>;
1718
1688
 
1719
1689
  [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`prev`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#prev)
1720
1690
 
1721
- ### <a id="ShiftedBigInt"></a>ShiftedBigInt
1691
+ ### <a id="SignatureWrapper"></a>SignatureWrapper
1722
1692
 
1723
1693
  [**@xyo-network/chain-wrappers**](#../README)
1724
1694
 
1725
1695
  ***
1726
1696
 
1727
- ## Deprecated
1697
+ ## Implements
1728
1698
 
1729
- use from @xyo-network/xl1-protocol instead
1699
+ - `SignatureInstance`
1730
1700
 
1731
1701
  ## Constructors
1732
1702
 
1733
1703
  ### Constructor
1734
1704
 
1735
1705
  ```ts
1736
- new ShiftedBigInt(value, config?): ShiftedBigInt;
1706
+ new SignatureWrapper(
1707
+ signature,
1708
+ address,
1709
+ hash): SignatureWrapper;
1737
1710
  ```
1738
1711
 
1739
1712
  ### Parameters
1740
1713
 
1741
- #### value
1714
+ #### signature
1742
1715
 
1743
- `bigint` | `ShiftedBigInt`
1716
+ `Hex`
1744
1717
 
1745
- #### config?
1718
+ #### address
1746
1719
 
1747
- `Partial`\<`ShiftedBigIntConfig`\>
1720
+ `Address`
1721
+
1722
+ #### hash
1723
+
1724
+ `Hash`
1748
1725
 
1749
1726
  ### Returns
1750
1727
 
1751
- `ShiftedBigInt`
1728
+ `SignatureWrapper`
1752
1729
 
1753
1730
  ## Properties
1754
1731
 
1755
- ### ~~defaultConfig~~
1732
+ ### address
1733
+
1734
+ ```ts
1735
+ address: Address;
1736
+ ```
1737
+
1738
+ ### Implementation of
1756
1739
 
1757
1740
  ```ts
1758
- readonly static defaultConfig: ShiftedBigIntConfig;
1741
+ SignatureInstance.address
1759
1742
  ```
1760
1743
 
1761
1744
  ***
1762
1745
 
1763
- ### ~~config~~
1746
+ ### hash
1747
+
1748
+ ```ts
1749
+ hash: Hash;
1750
+ ```
1751
+
1752
+ ### Implementation of
1764
1753
 
1765
1754
  ```ts
1766
- config: ShiftedBigIntConfig;
1755
+ SignatureInstance.hash
1767
1756
  ```
1768
1757
 
1769
1758
  ***
1770
1759
 
1771
- ### ~~value~~
1760
+ ### signature
1772
1761
 
1773
1762
  ```ts
1774
- value: bigint;
1763
+ signature: Hex;
1775
1764
  ```
1776
1765
 
1777
- ## Accessors
1766
+ ### Implementation of
1767
+
1768
+ ```ts
1769
+ SignatureInstance.signature
1770
+ ```
1778
1771
 
1779
- ### ~~locale~~
1772
+ ## Methods
1780
1773
 
1781
- ### Get Signature
1774
+ ### validate()
1782
1775
 
1783
1776
  ```ts
1784
- get locale(): LocalesArgument;
1777
+ static validate(
1778
+ hash,
1779
+ address,
1780
+ signature): Promise<Error[]>;
1785
1781
  ```
1786
1782
 
1787
- #### Returns
1783
+ ### Parameters
1788
1784
 
1789
- `LocalesArgument`
1785
+ #### hash
1790
1786
 
1791
- ***
1787
+ `Hash`
1792
1788
 
1793
- ### ~~maxCharacters~~
1789
+ #### address
1794
1790
 
1795
- ### Get Signature
1791
+ `Address`
1796
1792
 
1797
- ```ts
1798
- get maxCharacters(): number;
1799
- ```
1793
+ #### signature
1800
1794
 
1801
- #### Returns
1795
+ `Hex`
1802
1796
 
1803
- `number`
1797
+ ### Returns
1798
+
1799
+ `Promise`\<`Error`[]\>
1804
1800
 
1805
1801
  ***
1806
1802
 
1807
- ### ~~maxDecimal~~
1803
+ ### validate()
1808
1804
 
1809
- ### Get Signature
1805
+ ```ts
1806
+ validate(): Promise<Error[]>;
1807
+ ```
1808
+
1809
+ ### Returns
1810
+
1811
+ `Promise`\<`Error`[]\>
1812
+
1813
+ ### Implementation of
1810
1814
 
1811
1815
  ```ts
1812
- get maxDecimal(): number;
1816
+ SignatureInstance.validate
1813
1817
  ```
1814
1818
 
1815
- #### Returns
1819
+ ### interfaces
1816
1820
 
1817
- `number`
1821
+ ### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
1822
+
1823
+ [**@xyo-network/chain-wrappers**](#../README)
1818
1824
 
1819
1825
  ***
1820
1826
 
1821
- ### ~~minDecimals~~
1827
+ ## Type Parameters
1822
1828
 
1823
- ### Get Signature
1829
+ ### T
1830
+
1831
+ `T`
1832
+
1833
+ ## Properties
1834
+
1835
+ ### provider
1824
1836
 
1825
1837
  ```ts
1826
- get minDecimals(): number;
1838
+ provider: XyoConnection;
1827
1839
  ```
1828
1840
 
1829
- #### Returns
1841
+ ***
1830
1842
 
1831
- `number`
1843
+ ### value
1844
+
1845
+ ```ts
1846
+ value: T;
1847
+ ```
1848
+
1849
+ ### <a id="HydratedBlockRangeStoreParams"></a>HydratedBlockRangeStoreParams
1850
+
1851
+ [**@xyo-network/chain-wrappers**](#../README)
1832
1852
 
1833
1853
  ***
1834
1854
 
1835
- ### ~~places~~
1855
+ ## Extends
1836
1856
 
1837
- ### Get Signature
1857
+ - [`HydratedBlockStoreParams`](#../type-aliases/HydratedBlockStoreParams)\<\{
1858
+ `first`: `Hash`;
1859
+ `last`: `Hash`;
1860
+ `snapshotArchivist`: `ArchivistInstance`;
1861
+ \}\>
1862
+
1863
+ ## Properties
1864
+
1865
+ ### sourceArchivist
1838
1866
 
1839
1867
  ```ts
1840
- get places(): number;
1868
+ sourceArchivist: ArchivistInstance;
1841
1869
  ```
1842
1870
 
1843
- #### Returns
1871
+ ### Inherited from
1844
1872
 
1845
- `number`
1873
+ ```ts
1874
+ HydratedBlockStoreParams.sourceArchivist
1875
+ ```
1846
1876
 
1847
- ## Methods
1877
+ ***
1848
1878
 
1849
- ### ~~toFullString()~~
1879
+ ### first
1850
1880
 
1851
1881
  ```ts
1852
- toFullString(): string;
1882
+ first: Hash;
1853
1883
  ```
1854
1884
 
1855
- ### Returns
1885
+ ### Inherited from
1856
1886
 
1857
- `string`
1887
+ ```ts
1888
+ HydratedBlockStoreParams.first
1889
+ ```
1858
1890
 
1859
1891
  ***
1860
1892
 
1861
- ### ~~toShortString()~~
1893
+ ### last
1862
1894
 
1863
1895
  ```ts
1864
- toShortString(): string;
1896
+ last: Hash;
1865
1897
  ```
1866
1898
 
1867
- ### Returns
1899
+ ### Inherited from
1868
1900
 
1869
- `string`
1901
+ ```ts
1902
+ HydratedBlockStoreParams.last
1903
+ ```
1870
1904
 
1871
1905
  ***
1872
1906
 
1873
- ### ~~toString()~~
1907
+ ### snapshotArchivist
1874
1908
 
1875
1909
  ```ts
1876
- toString(): string;
1910
+ snapshotArchivist: ArchivistInstance;
1877
1911
  ```
1878
1912
 
1879
- ### Returns
1913
+ ### Inherited from
1880
1914
 
1881
- `string`
1915
+ ```ts
1916
+ HydratedBlockStoreParams.snapshotArchivist
1917
+ ```
1882
1918
 
1883
- ### <a id="SignatureWrapper"></a>SignatureWrapper
1919
+ ### <a id="HydratedBlockStoreInstance"></a>HydratedBlockStoreInstance
1884
1920
 
1885
1921
  [**@xyo-network/chain-wrappers**](#../README)
1886
1922
 
1887
1923
  ***
1888
1924
 
1889
- ## Implements
1925
+ ## Extended by
1890
1926
 
1891
- - `SignatureInstance`
1927
+ - [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
1892
1928
 
1893
- ## Constructors
1929
+ ## Methods
1894
1930
 
1895
- ### Constructor
1931
+ ### fromHash()
1896
1932
 
1897
1933
  ```ts
1898
- new SignatureWrapper(
1899
- signature,
1900
- address,
1901
- hash): SignatureWrapper;
1934
+ fromHash(hash): Promisable<HydratedBlock | undefined>;
1902
1935
  ```
1903
1936
 
1904
1937
  ### Parameters
1905
1938
 
1906
- #### signature
1939
+ #### hash
1907
1940
 
1908
- `Brand`
1941
+ `Hash`
1909
1942
 
1910
- #### address
1943
+ ### Returns
1911
1944
 
1912
- `Brand`
1945
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
1913
1946
 
1914
- #### hash
1947
+ ### <a id="IndexedHydratedBlockRangeStoreInstance"></a>IndexedHydratedBlockRangeStoreInstance
1915
1948
 
1916
- `Brand`
1949
+ [**@xyo-network/chain-wrappers**](#../README)
1917
1950
 
1918
- ### Returns
1951
+ ***
1919
1952
 
1920
- `SignatureWrapper`
1953
+ ## Extends
1954
+
1955
+ - `BlockWindowInstance`.[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
1921
1956
 
1922
1957
  ## Properties
1923
1958
 
1924
- ### address
1959
+ ### count
1925
1960
 
1926
1961
  ```ts
1927
- address: Brand;
1962
+ count: number;
1928
1963
  ```
1929
1964
 
1930
- ### Implementation of
1965
+ ### Inherited from
1931
1966
 
1932
1967
  ```ts
1933
- SignatureInstance.address
1968
+ BlockWindowInstance.count
1934
1969
  ```
1935
1970
 
1936
1971
  ***
1937
1972
 
1938
- ### hash
1973
+ ### numberRange
1939
1974
 
1940
1975
  ```ts
1941
- hash: Brand;
1976
+ numberRange: [number, number];
1942
1977
  ```
1943
1978
 
1944
- ### Implementation of
1979
+ ### Inherited from
1945
1980
 
1946
1981
  ```ts
1947
- SignatureInstance.hash
1982
+ BlockWindowInstance.numberRange
1948
1983
  ```
1949
1984
 
1950
1985
  ***
1951
1986
 
1952
- ### signature
1987
+ ### range
1953
1988
 
1954
1989
  ```ts
1955
- signature: Brand;
1990
+ range: [Hash, Hash];
1956
1991
  ```
1957
1992
 
1958
- ### Implementation of
1993
+ ### Inherited from
1959
1994
 
1960
1995
  ```ts
1961
- SignatureInstance.signature
1996
+ BlockWindowInstance.range
1962
1997
  ```
1963
1998
 
1964
1999
  ## Methods
1965
2000
 
1966
- ### validate()
2001
+ ### fromHash()
1967
2002
 
1968
2003
  ```ts
1969
- static validate(
1970
- hash,
1971
- address,
1972
- signature): Promise<Error[]>;
2004
+ fromHash(hash): Promisable<HydratedBlock | undefined>;
1973
2005
  ```
1974
2006
 
1975
2007
  ### Parameters
1976
2008
 
1977
2009
  #### hash
1978
2010
 
1979
- `Brand`
1980
-
1981
- #### address
1982
-
1983
- `Brand`
1984
-
1985
- #### signature
1986
-
1987
- `Brand`
2011
+ `Hash`
1988
2012
 
1989
2013
  ### Returns
1990
2014
 
1991
- `Promise`\<`Error`[]\>
1992
-
1993
- ***
1994
-
1995
- ### validate()
2015
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
1996
2016
 
1997
- ```ts
1998
- validate(): Promise<Error[]>;
1999
- ```
2017
+ ### Inherited from
2000
2018
 
2001
- ### Returns
2019
+ [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromHash`](IndexedHydratedBlockStoreInstance.md#fromhash)
2002
2020
 
2003
- `Promise`\<`Error`[]\>
2021
+ ***
2004
2022
 
2005
- ### Implementation of
2023
+ ### fromNumber()
2006
2024
 
2007
2025
  ```ts
2008
- SignatureInstance.validate
2026
+ fromNumber(number): Promisable<HydratedBlock | undefined>;
2009
2027
  ```
2010
2028
 
2011
- ### <a id="XL1Amount"></a>XL1Amount
2029
+ ### Parameters
2012
2030
 
2013
- [**@xyo-network/chain-wrappers**](#../README)
2031
+ #### number
2014
2032
 
2015
- ***
2033
+ `number`
2016
2034
 
2017
- ## Deprecated
2035
+ ### Returns
2018
2036
 
2019
- use from @xyo-network/xl1-protocol instead
2037
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
2020
2038
 
2021
- ## Implements
2039
+ ### Inherited from
2022
2040
 
2023
- - [`XL1AmountInstance`](#../interfaces/XL1AmountInstance)
2041
+ [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromNumber`](IndexedHydratedBlockStoreInstance.md#fromnumber)
2024
2042
 
2025
- ## Constructors
2043
+ ***
2026
2044
 
2027
- ### Constructor
2045
+ ### first()
2028
2046
 
2029
2047
  ```ts
2030
- new XL1Amount(value, locale?): XL1Amount;
2048
+ first(): Promisable<HydratedBlock>;
2031
2049
  ```
2032
2050
 
2033
- ### Parameters
2051
+ ### Returns
2034
2052
 
2035
- #### value
2053
+ `Promisable`\<`HydratedBlock`\>
2036
2054
 
2037
- `bigint`
2055
+ ***
2038
2056
 
2039
- #### locale?
2057
+ ### last()
2040
2058
 
2041
- `LocalesArgument`
2059
+ ```ts
2060
+ last(): Promisable<HydratedBlock>;
2061
+ ```
2042
2062
 
2043
2063
  ### Returns
2044
2064
 
2045
- `XL1Amount`
2065
+ `Promisable`\<`HydratedBlock`\>
2046
2066
 
2047
- ## Properties
2067
+ ***
2068
+
2069
+ ### next()
2048
2070
 
2049
- ### ~~value~~
2071
+ ### Call Signature
2050
2072
 
2051
2073
  ```ts
2052
- value: AttoXL1;
2074
+ next(from): Promisable<HydratedBlock | undefined>;
2053
2075
  ```
2054
2076
 
2055
- ### Implementation of
2077
+ #### Parameters
2056
2078
 
2057
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`value`](../interfaces/XL1AmountInstance.md#value)
2079
+ ##### from
2058
2080
 
2059
- ## Accessors
2081
+ `HydratedBlock`
2082
+
2083
+ #### Returns
2060
2084
 
2061
- ### ~~milli~~
2085
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
2062
2086
 
2063
- ### Get Signature
2087
+ ### Call Signature
2064
2088
 
2065
2089
  ```ts
2066
- get milli(): MilliXL1;
2067
- ```
2068
-
2069
- #### Returns
2070
-
2071
- `MilliXL1`
2072
-
2073
- ### Implementation of
2074
-
2075
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`milli`](../interfaces/XL1AmountInstance.md#milli)
2076
-
2077
- ***
2078
-
2079
- ### ~~micro~~
2080
-
2081
- ### Get Signature
2082
-
2083
- ```ts
2084
- get micro(): MicroXL1;
2085
- ```
2086
-
2087
- #### Returns
2088
-
2089
- `MicroXL1`
2090
-
2091
- ### Implementation of
2092
-
2093
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`micro`](../interfaces/XL1AmountInstance.md#micro)
2094
-
2095
- ***
2096
-
2097
- ### ~~nano~~
2098
-
2099
- ### Get Signature
2100
-
2101
- ```ts
2102
- get nano(): NanoXL1;
2103
- ```
2104
-
2105
- #### Returns
2106
-
2107
- `NanoXL1`
2108
-
2109
- ### Implementation of
2110
-
2111
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`nano`](../interfaces/XL1AmountInstance.md#nano)
2112
-
2113
- ***
2114
-
2115
- ### ~~pico~~
2116
-
2117
- ### Get Signature
2118
-
2119
- ```ts
2120
- get pico(): PicoXL1;
2121
- ```
2122
-
2123
- #### Returns
2124
-
2125
- `PicoXL1`
2126
-
2127
- ### Implementation of
2128
-
2129
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`pico`](../interfaces/XL1AmountInstance.md#pico)
2130
-
2131
- ***
2132
-
2133
- ### ~~femto~~
2134
-
2135
- ### Get Signature
2136
-
2137
- ```ts
2138
- get femto(): FemtoXL1;
2139
- ```
2140
-
2141
- #### Returns
2142
-
2143
- `FemtoXL1`
2144
-
2145
- ### Implementation of
2146
-
2147
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`femto`](../interfaces/XL1AmountInstance.md#femto)
2148
-
2149
- ***
2150
-
2151
- ### ~~atto~~
2152
-
2153
- ### Get Signature
2154
-
2155
- ```ts
2156
- get atto(): AttoXL1;
2157
- ```
2158
-
2159
- #### Returns
2160
-
2161
- `AttoXL1`
2162
-
2163
- ### Implementation of
2164
-
2165
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`atto`](../interfaces/XL1AmountInstance.md#atto)
2166
-
2167
- ## Methods
2168
-
2169
- ### ~~from()~~
2170
-
2171
- ```ts
2172
- static from(value, places?): XL1Amount;
2173
- ```
2174
-
2175
- ### Parameters
2176
-
2177
- #### value
2178
-
2179
- `bigint`
2180
-
2181
- #### places?
2182
-
2183
- `bigint`
2184
-
2185
- ### Returns
2186
-
2187
- `XL1Amount`
2188
-
2189
- ***
2190
-
2191
- ### ~~fromMilli()~~
2192
-
2193
- ```ts
2194
- static fromMilli(value): XL1Amount;
2195
- ```
2196
-
2197
- ### Parameters
2198
-
2199
- #### value
2200
-
2201
- `MilliXL1`
2202
-
2203
- ### Returns
2204
-
2205
- `XL1Amount`
2206
-
2207
- ***
2208
-
2209
- ### ~~fromMicro()~~
2210
-
2211
- ```ts
2212
- static fromMicro(value): XL1Amount;
2213
- ```
2214
-
2215
- ### Parameters
2216
-
2217
- #### value
2218
-
2219
- `MicroXL1`
2220
-
2221
- ### Returns
2222
-
2223
- `XL1Amount`
2224
-
2225
- ***
2226
-
2227
- ### ~~fromNano()~~
2228
-
2229
- ```ts
2230
- static fromNano(value): XL1Amount;
2231
- ```
2232
-
2233
- ### Parameters
2234
-
2235
- #### value
2236
-
2237
- `NanoXL1`
2238
-
2239
- ### Returns
2240
-
2241
- `XL1Amount`
2242
-
2243
- ***
2244
-
2245
- ### ~~fromPico()~~
2246
-
2247
- ```ts
2248
- static fromPico(value): XL1Amount;
2249
- ```
2250
-
2251
- ### Parameters
2252
-
2253
- #### value
2254
-
2255
- `PicoXL1`
2256
-
2257
- ### Returns
2258
-
2259
- `XL1Amount`
2260
-
2261
- ***
2262
-
2263
- ### ~~fromFemto()~~
2264
-
2265
- ```ts
2266
- static fromFemto(value): XL1Amount;
2267
- ```
2268
-
2269
- ### Parameters
2270
-
2271
- #### value
2272
-
2273
- `FemtoXL1`
2274
-
2275
- ### Returns
2276
-
2277
- `XL1Amount`
2278
-
2279
- ***
2280
-
2281
- ### ~~fromAtto()~~
2282
-
2283
- ```ts
2284
- static fromAtto(value): XL1Amount;
2285
- ```
2286
-
2287
- ### Parameters
2288
-
2289
- #### value
2290
-
2291
- `AttoXL1`
2292
-
2293
- ### Returns
2294
-
2295
- `XL1Amount`
2296
-
2297
- ***
2298
-
2299
- ### ~~to()~~
2300
-
2301
- ```ts
2302
- to(places?): bigint;
2303
- ```
2304
-
2305
- ### Parameters
2306
-
2307
- #### places?
2308
-
2309
- `number` | `bigint`
2310
-
2311
- ### Returns
2312
-
2313
- `bigint`
2314
-
2315
- ### Implementation of
2316
-
2317
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`to`](../interfaces/XL1AmountInstance.md#to)
2318
-
2319
- ***
2320
-
2321
- ### ~~toString()~~
2322
-
2323
- ```ts
2324
- toString(places?, config?): string;
2325
- ```
2326
-
2327
- ### Parameters
2328
-
2329
- #### places?
2330
-
2331
- `number`
2332
-
2333
- #### config?
2334
-
2335
- `Partial`\<`ShiftedBigIntConfig`\>
2336
-
2337
- ### Returns
2338
-
2339
- `string`
2340
-
2341
- ### Implementation of
2342
-
2343
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`toString`](../interfaces/XL1AmountInstance.md#tostring)
2344
-
2345
- ### interfaces
2346
-
2347
- ### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
2348
-
2349
- [**@xyo-network/chain-wrappers**](#../README)
2350
-
2351
- ***
2352
-
2353
- ## Type Parameters
2354
-
2355
- ### T
2356
-
2357
- `T`
2358
-
2359
- ## Properties
2360
-
2361
- ### provider
2362
-
2363
- ```ts
2364
- provider: XyoConnection;
2365
- ```
2366
-
2367
- ***
2368
-
2369
- ### value
2370
-
2371
- ```ts
2372
- value: T;
2373
- ```
2374
-
2375
- ### <a id="HydratedBlockRangeStoreParams"></a>HydratedBlockRangeStoreParams
2376
-
2377
- [**@xyo-network/chain-wrappers**](#../README)
2378
-
2379
- ***
2380
-
2381
- ## Extends
2382
-
2383
- - [`HydratedBlockStoreParams`](#../type-aliases/HydratedBlockStoreParams)\<\{
2384
- `first`: `Hash`;
2385
- `last`: `Hash`;
2386
- `snapshotArchivist`: `ArchivistInstance`;
2387
- \}\>
2388
-
2389
- ## Properties
2390
-
2391
- ### sourceArchivist
2392
-
2393
- ```ts
2394
- sourceArchivist: ArchivistInstance;
2395
- ```
2396
-
2397
- ### Inherited from
2398
-
2399
- ```ts
2400
- HydratedBlockStoreParams.sourceArchivist
2401
- ```
2402
-
2403
- ***
2404
-
2405
- ### first
2406
-
2407
- ```ts
2408
- first: Brand;
2409
- ```
2410
-
2411
- ### Inherited from
2412
-
2413
- ```ts
2414
- HydratedBlockStoreParams.first
2415
- ```
2416
-
2417
- ***
2418
-
2419
- ### last
2420
-
2421
- ```ts
2422
- last: Brand;
2423
- ```
2424
-
2425
- ### Inherited from
2426
-
2427
- ```ts
2428
- HydratedBlockStoreParams.last
2429
- ```
2430
-
2431
- ***
2432
-
2433
- ### snapshotArchivist
2434
-
2435
- ```ts
2436
- snapshotArchivist: ArchivistInstance;
2437
- ```
2438
-
2439
- ### Inherited from
2440
-
2441
- ```ts
2442
- HydratedBlockStoreParams.snapshotArchivist
2443
- ```
2444
-
2445
- ### <a id="HydratedBlockStoreInstance"></a>HydratedBlockStoreInstance
2446
-
2447
- [**@xyo-network/chain-wrappers**](#../README)
2448
-
2449
- ***
2450
-
2451
- ## Extended by
2452
-
2453
- - [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
2454
-
2455
- ## Methods
2456
-
2457
- ### fromHash()
2458
-
2459
- ```ts
2460
- fromHash(hash): Promisable<undefined | HydratedBlock>;
2461
- ```
2462
-
2463
- ### Parameters
2464
-
2465
- #### hash
2466
-
2467
- `Brand`
2468
-
2469
- ### Returns
2470
-
2471
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2472
-
2473
- ### <a id="IndexedHydratedBlockRangeStoreInstance"></a>IndexedHydratedBlockRangeStoreInstance
2474
-
2475
- [**@xyo-network/chain-wrappers**](#../README)
2476
-
2477
- ***
2478
-
2479
- ## Extends
2480
-
2481
- - `BlockWindowInstance`.[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
2482
-
2483
- ## Properties
2484
-
2485
- ### count
2486
-
2487
- ```ts
2488
- count: number;
2489
- ```
2490
-
2491
- ### Inherited from
2492
-
2493
- ```ts
2494
- BlockWindowInstance.count
2495
- ```
2496
-
2497
- ***
2498
-
2499
- ### numberRange
2500
-
2501
- ```ts
2502
- numberRange: [number, number];
2503
- ```
2504
-
2505
- ### Inherited from
2506
-
2507
- ```ts
2508
- BlockWindowInstance.numberRange
2509
- ```
2510
-
2511
- ***
2512
-
2513
- ### range
2514
-
2515
- ```ts
2516
- range: [Brand<Brand<Lowercase<string>, {
2517
- }>, {
2518
- }>, Brand<Brand<Lowercase<string>, {
2519
- }>, {
2520
- }>];
2521
- ```
2522
-
2523
- ### Inherited from
2524
-
2525
- ```ts
2526
- BlockWindowInstance.range
2527
- ```
2528
-
2529
- ## Methods
2530
-
2531
- ### fromHash()
2532
-
2533
- ```ts
2534
- fromHash(hash): Promisable<undefined | HydratedBlock>;
2535
- ```
2536
-
2537
- ### Parameters
2538
-
2539
- #### hash
2540
-
2541
- `Brand`
2542
-
2543
- ### Returns
2544
-
2545
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2546
-
2547
- ### Inherited from
2548
-
2549
- [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromHash`](IndexedHydratedBlockStoreInstance.md#fromhash)
2550
-
2551
- ***
2552
-
2553
- ### fromNumber()
2554
-
2555
- ```ts
2556
- fromNumber(number): Promisable<undefined | HydratedBlock>;
2557
- ```
2558
-
2559
- ### Parameters
2560
-
2561
- #### number
2562
-
2563
- `number`
2564
-
2565
- ### Returns
2566
-
2567
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2568
-
2569
- ### Inherited from
2570
-
2571
- [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromNumber`](IndexedHydratedBlockStoreInstance.md#fromnumber)
2572
-
2573
- ***
2574
-
2575
- ### first()
2576
-
2577
- ```ts
2578
- first(): Promisable<HydratedBlock>;
2579
- ```
2580
-
2581
- ### Returns
2582
-
2583
- `Promisable`\<`HydratedBlock`\>
2584
-
2585
- ***
2586
-
2587
- ### last()
2588
-
2589
- ```ts
2590
- last(): Promisable<HydratedBlock>;
2591
- ```
2592
-
2593
- ### Returns
2594
-
2595
- `Promisable`\<`HydratedBlock`\>
2596
-
2597
- ***
2598
-
2599
- ### next()
2600
-
2601
- ### Call Signature
2602
-
2603
- ```ts
2604
- next(from): Promisable<undefined | HydratedBlock>;
2605
- ```
2606
-
2607
- #### Parameters
2608
-
2609
- ##### from
2610
-
2611
- `HydratedBlock`
2612
-
2613
- #### Returns
2614
-
2615
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2616
-
2617
- ### Call Signature
2618
-
2619
- ```ts
2620
- next(from, count): Promisable<HydratedBlock[]>;
2090
+ next(from, count): Promisable<HydratedBlock[]>;
2621
2091
  ```
2622
2092
 
2623
2093
  #### Parameters
@@ -2641,7 +2111,7 @@ next(from, count): Promisable<HydratedBlock[]>;
2641
2111
  ### Call Signature
2642
2112
 
2643
2113
  ```ts
2644
- prev(from): Promisable<undefined | HydratedBlock>;
2114
+ prev(from): Promisable<HydratedBlock | undefined>;
2645
2115
  ```
2646
2116
 
2647
2117
  #### Parameters
@@ -2652,7 +2122,7 @@ prev(from): Promisable<undefined | HydratedBlock>;
2652
2122
 
2653
2123
  #### Returns
2654
2124
 
2655
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2125
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
2656
2126
 
2657
2127
  ### Call Signature
2658
2128
 
@@ -2693,18 +2163,18 @@ prev(from, count): Promisable<HydratedBlock[]>;
2693
2163
  ### fromHash()
2694
2164
 
2695
2165
  ```ts
2696
- fromHash(hash): Promisable<undefined | HydratedBlock>;
2166
+ fromHash(hash): Promisable<HydratedBlock | undefined>;
2697
2167
  ```
2698
2168
 
2699
2169
  ### Parameters
2700
2170
 
2701
2171
  #### hash
2702
2172
 
2703
- `Brand`
2173
+ `Hash`
2704
2174
 
2705
2175
  ### Returns
2706
2176
 
2707
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2177
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
2708
2178
 
2709
2179
  ### Inherited from
2710
2180
 
@@ -2715,7 +2185,7 @@ fromHash(hash): Promisable<undefined | HydratedBlock>;
2715
2185
  ### fromNumber()
2716
2186
 
2717
2187
  ```ts
2718
- fromNumber(number): Promisable<undefined | HydratedBlock>;
2188
+ fromNumber(number): Promisable<HydratedBlock | undefined>;
2719
2189
  ```
2720
2190
 
2721
2191
  ### Parameters
@@ -2726,113 +2196,7 @@ fromNumber(number): Promisable<undefined | HydratedBlock>;
2726
2196
 
2727
2197
  ### Returns
2728
2198
 
2729
- `Promisable`\<`undefined` \| `HydratedBlock`\>
2730
-
2731
- ### <a id="XL1AmountInstance"></a>XL1AmountInstance
2732
-
2733
- [**@xyo-network/chain-wrappers**](#../README)
2734
-
2735
- ***
2736
-
2737
- ## Deprecated
2738
-
2739
- use from @xyo-network/xl1-protocol instead
2740
-
2741
- ## Properties
2742
-
2743
- ### ~~value~~
2744
-
2745
- ```ts
2746
- value: AttoXL1;
2747
- ```
2748
-
2749
- ***
2750
-
2751
- ### ~~milli~~
2752
-
2753
- ```ts
2754
- milli: MilliXL1;
2755
- ```
2756
-
2757
- ***
2758
-
2759
- ### ~~micro~~
2760
-
2761
- ```ts
2762
- micro: MicroXL1;
2763
- ```
2764
-
2765
- ***
2766
-
2767
- ### ~~nano~~
2768
-
2769
- ```ts
2770
- nano: NanoXL1;
2771
- ```
2772
-
2773
- ***
2774
-
2775
- ### ~~pico~~
2776
-
2777
- ```ts
2778
- pico: PicoXL1;
2779
- ```
2780
-
2781
- ***
2782
-
2783
- ### ~~femto~~
2784
-
2785
- ```ts
2786
- femto: FemtoXL1;
2787
- ```
2788
-
2789
- ***
2790
-
2791
- ### ~~atto~~
2792
-
2793
- ```ts
2794
- atto: AttoXL1;
2795
- ```
2796
-
2797
- ## Methods
2798
-
2799
- ### ~~to()~~
2800
-
2801
- ```ts
2802
- to(places): bigint;
2803
- ```
2804
-
2805
- ### Parameters
2806
-
2807
- #### places
2808
-
2809
- `number` | `bigint`
2810
-
2811
- ### Returns
2812
-
2813
- `bigint`
2814
-
2815
- ***
2816
-
2817
- ### ~~toString()~~
2818
-
2819
- ```ts
2820
- toString(places, config): string;
2821
- ```
2822
-
2823
- ### Parameters
2824
-
2825
- #### places
2826
-
2827
- `number`
2828
-
2829
- #### config
2830
-
2831
- `Partial`\<`ShiftedBigIntConfig`\>
2832
-
2833
- ### Returns
2834
-
2835
- `string`
2199
+ `Promisable`\<`HydratedBlock` \| `undefined`\>
2836
2200
 
2837
2201
  ### type-aliases
2838
2202
 
@@ -2874,78 +2238,6 @@ const createSignatureWrappers: (bw) => Promise<SignatureInstance[]>;
2874
2238
 
2875
2239
  `Promise`\<`SignatureInstance`[]\>
2876
2240
 
2877
- ### <a id="splitOnDecimal"></a>splitOnDecimal
2878
-
2879
- [**@xyo-network/chain-wrappers**](#../README)
2880
-
2881
- ***
2882
-
2883
- ```ts
2884
- const splitOnDecimal: (value, places?) => [bigint, bigint];
2885
- ```
2886
-
2887
- ## Parameters
2888
-
2889
- ### value
2890
-
2891
- `bigint`
2892
-
2893
- ### places?
2894
-
2895
- `number`
2896
-
2897
- ## Returns
2898
-
2899
- \[`bigint`, `bigint`\]
2900
-
2901
- ## Deprecated
2902
-
2903
- use from @xyo-network/xl1-protocol instead
2904
-
2905
- ### <a id="splitOnDecimalToString"></a>splitOnDecimalToString
2906
-
2907
- [**@xyo-network/chain-wrappers**](#../README)
2908
-
2909
- ***
2910
-
2911
- ```ts
2912
- const splitOnDecimalToString: (value, places?, maxDecimal?, maxCharacters?, minDecimals?, locale?) => string;
2913
- ```
2914
-
2915
- ## Parameters
2916
-
2917
- ### value
2918
-
2919
- `bigint`
2920
-
2921
- ### places?
2922
-
2923
- `number`
2924
-
2925
- ### maxDecimal?
2926
-
2927
- `number`
2928
-
2929
- ### maxCharacters?
2930
-
2931
- `number`
2932
-
2933
- ### minDecimals?
2934
-
2935
- `number`
2936
-
2937
- ### locale?
2938
-
2939
- `Intl.LocalesArgument`
2940
-
2941
- ## Returns
2942
-
2943
- `string`
2944
-
2945
- ## Deprecated
2946
-
2947
- use from @xyo-network/xl1-protocol instead
2948
-
2949
2241
 
2950
2242
  ## Maintainers
2951
2243