@xyo-network/xl1-protocol-sdk 1.15.2 → 1.15.4
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 +1507 -388
- package/dist/neutral/block/hydrate/hydrateBlock.d.ts +5 -2
- package/dist/neutral/block/hydrate/hydrateBlock.d.ts.map +1 -1
- package/dist/neutral/block/primitives/balances/balancesStepSummaryFromRange.d.ts.map +1 -1
- package/dist/neutral/block/primitives/balances/balancesSummary.d.ts.map +1 -1
- package/dist/neutral/block/primitives/blockFromBlockNumber.d.ts +2 -2
- package/dist/neutral/block/primitives/blockFromBlockNumber.d.ts.map +1 -1
- package/dist/neutral/block/primitives/hashFromBlockNumber.d.ts +2 -2
- package/dist/neutral/block/primitives/hashFromBlockNumber.d.ts.map +1 -1
- package/dist/neutral/block/primitives/model.d.ts +10 -8
- package/dist/neutral/block/primitives/model.d.ts.map +1 -1
- package/dist/neutral/block/primitives/payloads/StepSummary.d.ts.map +1 -1
- package/dist/neutral/block/primitives/payloads/TransfersSummary.d.ts +1 -2
- package/dist/neutral/block/primitives/payloads/TransfersSummary.d.ts.map +1 -1
- package/dist/neutral/block/primitives/transfers/transfersStepSummaryFromRange.d.ts.map +1 -1
- package/dist/neutral/block/primitives/transfers/transfersSummary.d.ts +1 -1
- package/dist/neutral/block/primitives/transfers/transfersSummary.d.ts.map +1 -1
- package/dist/neutral/config/Bridge.d.ts +8 -0
- package/dist/neutral/config/Bridge.d.ts.map +1 -0
- package/dist/neutral/config/Config.d.ts +5 -0
- package/dist/neutral/config/Config.d.ts.map +1 -1
- package/dist/neutral/index.d.ts +2 -0
- package/dist/neutral/index.d.ts.map +1 -1
- package/dist/neutral/index.mjs +335 -327
- package/dist/neutral/index.mjs.map +1 -1
- package/dist/neutral/instances/ShiftedBigIntConfig.d.ts +1 -1
- package/dist/neutral/instances/ShiftedBigIntConfig.d.ts.map +1 -1
- package/dist/neutral/instances/XL1Amount.d.ts +1 -1
- package/dist/neutral/instances/XL1Amount.d.ts.map +1 -1
- package/dist/neutral/map/AsynchronousMap.d.ts +14 -0
- package/dist/neutral/map/AsynchronousMap.d.ts.map +1 -0
- package/dist/neutral/map/MapType.d.ts +6 -0
- package/dist/neutral/map/MapType.d.ts.map +1 -0
- package/dist/neutral/map/SynchronousMap.d.ts +13 -0
- package/dist/neutral/map/SynchronousMap.d.ts.map +1 -0
- package/dist/neutral/map/index.d.ts +4 -0
- package/dist/neutral/map/index.d.ts.map +1 -0
- package/dist/neutral/model/ChainContext/ChainContext.d.ts +15 -0
- package/dist/neutral/model/ChainContext/ChainContext.d.ts.map +1 -0
- package/dist/neutral/model/ChainContext/ChainStakeContext.d.ts +10 -0
- package/dist/neutral/model/ChainContext/ChainStakeContext.d.ts.map +1 -0
- package/dist/neutral/model/ChainContext/ChainStateContext.d.ts +9 -0
- package/dist/neutral/model/ChainContext/ChainStateContext.d.ts.map +1 -0
- package/dist/neutral/model/ChainContext/ChainStoreContext.d.ts +10 -0
- package/dist/neutral/model/ChainContext/ChainStoreContext.d.ts.map +1 -0
- package/dist/neutral/model/ChainContext/index.d.ts +5 -0
- package/dist/neutral/model/ChainContext/index.d.ts.map +1 -0
- package/dist/neutral/model/ChainFork/ChainForkStatic.d.ts +8 -0
- package/dist/neutral/model/ChainFork/ChainForkStatic.d.ts.map +1 -0
- package/dist/neutral/model/ChainFork/index.d.ts +2 -0
- package/dist/neutral/model/ChainFork/index.d.ts.map +1 -0
- package/dist/neutral/model/ChainIdentity.d.ts +5 -0
- package/dist/neutral/model/ChainIdentity.d.ts.map +1 -0
- package/dist/neutral/model/ChainStake/ChainStakeRead.d.ts +17 -0
- package/dist/neutral/model/ChainStake/ChainStakeRead.d.ts.map +1 -0
- package/dist/neutral/model/ChainStake/ChainStakeStatic.d.ts +7 -0
- package/dist/neutral/model/ChainStake/ChainStakeStatic.d.ts.map +1 -0
- package/dist/neutral/model/ChainStake/ChainStakeWrite.d.ts +6 -0
- package/dist/neutral/model/ChainStake/ChainStakeWrite.d.ts.map +1 -0
- package/dist/neutral/model/ChainStake/index.d.ts +4 -0
- package/dist/neutral/model/ChainStake/index.d.ts.map +1 -0
- package/dist/neutral/model/ChainStore.d.ts +10 -0
- package/dist/neutral/model/ChainStore.d.ts.map +1 -0
- package/dist/neutral/model/PayloadMap.d.ts +7 -0
- package/dist/neutral/model/PayloadMap.d.ts.map +1 -0
- package/dist/neutral/model/StakeEvents.d.ts +31 -0
- package/dist/neutral/model/StakeEvents.d.ts.map +1 -0
- package/dist/neutral/model/index.d.ts +8 -0
- package/dist/neutral/model/index.d.ts.map +1 -0
- package/dist/neutral/payload/netTransfersForPayloads.d.ts +1 -1
- package/dist/neutral/payload/netTransfersForPayloads.d.ts.map +1 -1
- package/dist/neutral/steps/primitives/index.d.ts +0 -10
- package/dist/neutral/steps/primitives/index.d.ts.map +1 -1
- package/dist/neutral/time/primitives/xl1BlockNumberToEthBlockNumber.d.ts +2 -2
- package/dist/neutral/time/primitives/xl1BlockNumberToEthBlockNumber.d.ts.map +1 -1
- package/dist/neutral/transaction/buildTransaction.d.ts +2 -2
- package/dist/neutral/transaction/buildTransaction.d.ts.map +1 -1
- package/dist/neutral/transaction/buildUnsignedTransaction.d.ts +2 -2
- package/dist/neutral/transaction/buildUnsignedTransaction.d.ts.map +1 -1
- package/dist/neutral/transaction/hydrateTransaction.d.ts +5 -5
- package/dist/neutral/transaction/hydrateTransaction.d.ts.map +1 -1
- package/package.json +30 -29
- package/src/block/hydrate/hydrateBlock.ts +32 -10
- package/src/block/primitives/balances/balancesStepSummaryFromRange.ts +30 -23
- package/src/block/primitives/balances/balancesSummary.ts +3 -2
- package/src/block/primitives/blockFromBlockNumber.ts +8 -6
- package/src/block/primitives/hashFromBlockNumber.ts +2 -2
- package/src/block/primitives/model.ts +15 -11
- package/src/block/primitives/payloads/StepSummary.ts +1 -1
- package/src/block/primitives/payloads/TransfersSummary.ts +1 -2
- package/src/block/primitives/transfers/transfersStepSummaryFromRange.ts +43 -28
- package/src/block/primitives/transfers/transfersSummary.ts +12 -7
- package/src/config/Bridge.ts +26 -0
- package/src/config/Config.ts +2 -0
- package/src/index.ts +2 -0
- package/src/instances/ShiftedBigIntConfig.ts +1 -1
- package/src/instances/XL1Amount.ts +1 -1
- package/src/map/AsynchronousMap.ts +15 -0
- package/src/map/MapType.ts +8 -0
- package/src/map/SynchronousMap.ts +13 -0
- package/src/map/index.ts +3 -0
- package/src/model/ChainContext/ChainContext.ts +20 -0
- package/src/model/ChainContext/ChainStakeContext.ts +12 -0
- package/src/model/ChainContext/ChainStateContext.ts +10 -0
- package/src/model/ChainContext/ChainStoreContext.ts +12 -0
- package/src/model/ChainContext/index.ts +4 -0
- package/src/model/ChainFork/ChainForkStatic.ts +8 -0
- package/src/model/ChainFork/index.ts +1 -0
- package/src/model/ChainIdentity.ts +5 -0
- package/src/model/ChainStake/ChainStakeRead.ts +17 -0
- package/src/model/ChainStake/ChainStakeStatic.ts +7 -0
- package/src/model/ChainStake/ChainStakeWrite.ts +5 -0
- package/src/model/ChainStake/index.ts +3 -0
- package/src/model/ChainStore.ts +13 -0
- package/src/model/PayloadMap.ts +10 -0
- package/src/model/StakeEvents.ts +38 -0
- package/src/model/index.ts +7 -0
- package/src/payload/netTransfersForPayloads.ts +7 -12
- package/src/steps/primitives/index.ts +0 -10
- package/src/time/primitives/xl1BlockNumberToEthBlockNumber.ts +4 -5
- package/src/transaction/buildTransaction.ts +2 -2
- package/src/transaction/buildUnsignedTransaction.ts +2 -2
- package/src/transaction/hydrateTransaction.ts +24 -9
- package/dist/neutral/steps/primitives/networkStakeStepAddressReward.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepAddressReward.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepPoolRewardShares.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepPoolRewardShares.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepPoolRewards.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepPoolRewards.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardAddressHistory.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepRewardAddressHistory.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardAddressShare.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepRewardAddressShare.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardForStep.d.ts +0 -3
- package/dist/neutral/steps/primitives/networkStakeStepRewardForStep.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardPositionWeight.d.ts +0 -3
- package/dist/neutral/steps/primitives/networkStakeStepRewardPositionWeight.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardPotentialPositionLoss.d.ts +0 -3
- package/dist/neutral/steps/primitives/networkStakeStepRewardPotentialPositionLoss.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardRandomizer.d.ts +0 -3
- package/dist/neutral/steps/primitives/networkStakeStepRewardRandomizer.d.ts.map +0 -1
- package/dist/neutral/steps/primitives/networkStakeStepRewardWeightForAddress.d.ts +0 -4
- package/dist/neutral/steps/primitives/networkStakeStepRewardWeightForAddress.d.ts.map +0 -1
- package/src/steps/primitives/networkStakeStepAddressReward.ts +0 -6
- package/src/steps/primitives/networkStakeStepPoolRewardShares.ts +0 -6
- package/src/steps/primitives/networkStakeStepPoolRewards.ts +0 -6
- package/src/steps/primitives/networkStakeStepRewardAddressHistory.ts +0 -6
- package/src/steps/primitives/networkStakeStepRewardAddressShare.ts +0 -6
- package/src/steps/primitives/networkStakeStepRewardForStep.ts +0 -5
- package/src/steps/primitives/networkStakeStepRewardPositionWeight.ts +0 -5
- package/src/steps/primitives/networkStakeStepRewardPotentialPositionLoss.ts +0 -5
- package/src/steps/primitives/networkStakeStepRewardRandomizer.ts +0 -5
- package/src/steps/primitives/networkStakeStepRewardWeightForAddress.ts +0 -6
package/README.md
CHANGED
|
@@ -27,8 +27,9 @@ XYO Layer One SDK Protocol
|
|
|
27
27
|
- [ChainContext](#interfaces/ChainContext)
|
|
28
28
|
- [ChainSummaryContext](#interfaces/ChainSummaryContext)
|
|
29
29
|
- [BalanceStepSummaryContext](#interfaces/BalanceStepSummaryContext)
|
|
30
|
-
- [
|
|
30
|
+
- [TransfersStepSummaryContext](#interfaces/TransfersStepSummaryContext)
|
|
31
31
|
- [ChainWindow](#interfaces/ChainWindow)
|
|
32
|
+
- [StepSummaryFields](#interfaces/StepSummaryFields)
|
|
32
33
|
- [AddressInstance](#interfaces/AddressInstance)
|
|
33
34
|
- [AddressStateInstance](#interfaces/AddressStateInstance)
|
|
34
35
|
- [BoundWitnessInstance](#interfaces/BoundWitnessInstance)
|
|
@@ -36,9 +37,9 @@ XYO Layer One SDK Protocol
|
|
|
36
37
|
- [TransactionFeesInstance](#interfaces/TransactionFeesInstance)
|
|
37
38
|
- [ObjectInstance](#interfaces/ObjectInstance)
|
|
38
39
|
- [PayloadInstance](#interfaces/PayloadInstance)
|
|
39
|
-
- [ShiftedBigIntConfig](#interfaces/ShiftedBigIntConfig)
|
|
40
|
+
- [~~ShiftedBigIntConfig~~](#interfaces/ShiftedBigIntConfig)
|
|
40
41
|
- [SignatureInstance](#interfaces/SignatureInstance)
|
|
41
|
-
- [XL1AmountInstance](#interfaces/XL1AmountInstance)
|
|
42
|
+
- [~~XL1AmountInstance~~](#interfaces/XL1AmountInstance)
|
|
42
43
|
- [HydratedBlockInstance](#interfaces/HydratedBlockInstance)
|
|
43
44
|
- [BlockWindowInstance](#interfaces/BlockWindowInstance)
|
|
44
45
|
- [BlockWindowStateInstance](#interfaces/BlockWindowStateInstance)
|
|
@@ -50,24 +51,41 @@ XYO Layer One SDK Protocol
|
|
|
50
51
|
|
|
51
52
|
- [SignedBigInt](#type-aliases/SignedBigInt)
|
|
52
53
|
- [BlockNumberRange](#type-aliases/BlockNumberRange)
|
|
53
|
-
- [StepSummarySchema](#type-aliases/StepSummarySchema)
|
|
54
|
-
- [StepSummary](#type-aliases/StepSummary)
|
|
55
54
|
- [BalancesStepSummarySchema](#type-aliases/BalancesStepSummarySchema)
|
|
56
55
|
- [BalancesStepSummary](#type-aliases/BalancesStepSummary)
|
|
56
|
+
- [StepSummarySchema](#type-aliases/StepSummarySchema)
|
|
57
|
+
- [StepSummary](#type-aliases/StepSummary)
|
|
58
|
+
- [TransfersStepSummarySchema](#type-aliases/TransfersStepSummarySchema)
|
|
59
|
+
- [TransfersStepSummary](#type-aliases/TransfersStepSummary)
|
|
57
60
|
- [Config](#type-aliases/Config)
|
|
61
|
+
- [UsageMeta](#type-aliases/UsageMeta)
|
|
62
|
+
- [ConfirmSubmittedTransactionOptions](#type-aliases/ConfirmSubmittedTransactionOptions)
|
|
58
63
|
- [MnemonicString](#type-aliases/MnemonicString)
|
|
59
64
|
|
|
60
65
|
## Variables
|
|
61
66
|
|
|
62
|
-
- [StepSummarySchema](#variables/StepSummarySchema)
|
|
63
67
|
- [BalancesStepSummarySchema](#variables/BalancesStepSummarySchema)
|
|
64
68
|
- [isBalancesStepSummary](#variables/isBalancesStepSummary)
|
|
65
69
|
- [asBalancesStepSummary](#variables/asBalancesStepSummary)
|
|
66
70
|
- [asBalancesStepSummaryWithStorageMeta](#variables/asBalancesStepSummaryWithStorageMeta)
|
|
71
|
+
- [StepSummarySchema](#variables/StepSummarySchema)
|
|
72
|
+
- [TransfersStepSummarySchema](#variables/TransfersStepSummarySchema)
|
|
73
|
+
- [isTransfersStepSummary](#variables/isTransfersStepSummary)
|
|
74
|
+
- [asTransfersStepSummary](#variables/asTransfersStepSummary)
|
|
75
|
+
- [asTransfersStepSummaryWithStorageMeta](#variables/asTransfersStepSummaryWithStorageMeta)
|
|
67
76
|
- [Xl1CommonConfigSchema](#variables/Xl1CommonConfigSchema)
|
|
68
|
-
- [
|
|
77
|
+
- [ConfigZod](#variables/ConfigZod)
|
|
78
|
+
- [JSONSchemaMetaSchema](#variables/JSONSchemaMetaSchema)
|
|
79
|
+
- [GlobalMetaSchema](#variables/GlobalMetaSchema)
|
|
80
|
+
- [UsageMetaSchema](#variables/UsageMetaSchema)
|
|
69
81
|
- [TODO](#variables/TODO)
|
|
70
|
-
- [
|
|
82
|
+
- [MnemonicStringZod](#variables/MnemonicStringZod)
|
|
83
|
+
- [WALLET\_COMPLIANCE](#variables/WALLET_COMPLIANCE)
|
|
84
|
+
- [COIN\_TYPES](#variables/COIN_TYPES)
|
|
85
|
+
- [ACCOUNT\_TYPE](#variables/ACCOUNT_TYPE)
|
|
86
|
+
- [CHANGE\_ADDRESS](#variables/CHANGE_ADDRESS)
|
|
87
|
+
- [ADDRESS\_INDEX](#variables/ADDRESS_INDEX)
|
|
88
|
+
- [DEFAULT\_WALLET\_PATH](#variables/DEFAULT_WALLET_PATH)
|
|
71
89
|
|
|
72
90
|
## Functions
|
|
73
91
|
|
|
@@ -77,22 +95,47 @@ XYO Layer One SDK Protocol
|
|
|
77
95
|
- [toSignedBigInt](#functions/toSignedBigInt)
|
|
78
96
|
- [toPositiveBigInt](#functions/toPositiveBigInt)
|
|
79
97
|
- [allHashesPresent](#functions/allHashesPresent)
|
|
80
|
-
- [
|
|
81
|
-
- [hydrateBlock](#functions/hydrateBlock)
|
|
98
|
+
- [blockPayloadsFromHydratedBlock](#functions/blockPayloadsFromHydratedBlock)
|
|
82
99
|
- [flattenHydratedBlock](#functions/flattenHydratedBlock)
|
|
83
100
|
- [flattenHydratedBlocks](#functions/flattenHydratedBlocks)
|
|
101
|
+
- [hydrateBlock](#functions/hydrateBlock)
|
|
84
102
|
- [transactionsFromHydratedBlock](#functions/transactionsFromHydratedBlock)
|
|
85
|
-
- [
|
|
86
|
-
- [
|
|
87
|
-
- [
|
|
103
|
+
- [tryHydrateBlock](#functions/tryHydrateBlock)
|
|
104
|
+
- [balancesStepSummaryFromRange](#functions/balancesStepSummaryFromRange)
|
|
105
|
+
- [balancesSummary](#functions/balancesSummary)
|
|
106
|
+
- [blockFromBlockNumber](#functions/blockFromBlockNumber)
|
|
88
107
|
- [calculateFramesFromRange](#functions/calculateFramesFromRange)
|
|
89
108
|
- [deepCalculateFramesFromRange](#functions/deepCalculateFramesFromRange)
|
|
90
109
|
- [hashFromBlockNumber](#functions/hashFromBlockNumber)
|
|
91
110
|
- [isBalancesStepSummaryWithStorageMeta](#functions/isBalancesStepSummaryWithStorageMeta)
|
|
111
|
+
- [isTransfersStepSummaryWithStorageMeta](#functions/isTransfersStepSummaryWithStorageMeta)
|
|
112
|
+
- [transfersStepSummaryFromRange](#functions/transfersStepSummaryFromRange)
|
|
113
|
+
- [transfersSummary](#functions/transfersSummary)
|
|
92
114
|
- [getDefaultConfig](#functions/getDefaultConfig)
|
|
115
|
+
- [isUsageMeta](#functions/isUsageMeta)
|
|
93
116
|
- [hasMongoConfig](#functions/hasMongoConfig)
|
|
94
117
|
- [netBalancesForPayloads](#functions/netBalancesForPayloads)
|
|
118
|
+
- [netTransfersForPayloads](#functions/netTransfersForPayloads)
|
|
119
|
+
- [addressStakeWeight](#functions/addressStakeWeight)
|
|
120
|
+
- [claimedRewards](#functions/claimedRewards)
|
|
121
|
+
- [networkStakeStepAddressReward](#functions/networkStakeStepAddressReward)
|
|
122
|
+
- [networkStakeStepPoolRewardShares](#functions/networkStakeStepPoolRewardShares)
|
|
123
|
+
- [networkStakeStepPoolRewards](#functions/networkStakeStepPoolRewards)
|
|
124
|
+
- [networkStakeStepRewardAddressHistory](#functions/networkStakeStepRewardAddressHistory)
|
|
125
|
+
- [networkStakeStepRewardAddressShare](#functions/networkStakeStepRewardAddressShare)
|
|
126
|
+
- [networkStakeStepRewardForStep](#functions/networkStakeStepRewardForStep)
|
|
127
|
+
- [networkStakeStepRewardPositionWeight](#functions/networkStakeStepRewardPositionWeight)
|
|
128
|
+
- [networkStakeStepRewardPotentialPositionLoss](#functions/networkStakeStepRewardPotentialPositionLoss)
|
|
129
|
+
- [networkStakeStepRewardRandomizer](#functions/networkStakeStepRewardRandomizer)
|
|
130
|
+
- [networkStakeStepRewardWeightForAddress](#functions/networkStakeStepRewardWeightForAddress)
|
|
131
|
+
- [stakersAsOfBlock](#functions/stakersAsOfBlock)
|
|
132
|
+
- [startingStakes](#functions/startingStakes)
|
|
133
|
+
- [totalStakeWeight](#functions/totalStakeWeight)
|
|
134
|
+
- [unclaimedRewards](#functions/unclaimedRewards)
|
|
135
|
+
- [xl1BlockNumberToEthBlockNumber](#functions/xl1BlockNumberToEthBlockNumber)
|
|
95
136
|
- [buildTransaction](#functions/buildTransaction)
|
|
137
|
+
- [buildUnsignedTransaction](#functions/buildUnsignedTransaction)
|
|
138
|
+
- [confirmSubmittedTransaction](#functions/confirmSubmittedTransaction)
|
|
96
139
|
- [tryHydrateTransaction](#functions/tryHydrateTransaction)
|
|
97
140
|
- [hydrateTransaction](#functions/hydrateTransaction)
|
|
98
141
|
- [flattenHydratedTransaction](#functions/flattenHydratedTransaction)
|
|
@@ -106,11 +149,58 @@ XYO Layer One SDK Protocol
|
|
|
106
149
|
- [crackOperations](#functions/crackOperations)
|
|
107
150
|
- [transactionBytesRequiredGas](#functions/transactionBytesRequiredGas)
|
|
108
151
|
- [transactionRequiredGas](#functions/transactionRequiredGas)
|
|
152
|
+
- [tryExtractElevatedHashesFromScript](#functions/tryExtractElevatedHashesFromScript)
|
|
153
|
+
- [extractElevatedHashesFromScript](#functions/extractElevatedHashesFromScript)
|
|
154
|
+
- [tryExtractElevatedHashes](#functions/tryExtractElevatedHashes)
|
|
155
|
+
- [extractElevatedHashes](#functions/extractElevatedHashes)
|
|
156
|
+
- [signTransaction](#functions/signTransaction)
|
|
109
157
|
- [getUrl](#functions/getUrl)
|
|
110
158
|
- [isLocalhost](#functions/isLocalhost)
|
|
159
|
+
- [generateXyoBaseWalletFromPhrase](#functions/generateXyoBaseWalletFromPhrase)
|
|
111
160
|
|
|
112
161
|
### functions
|
|
113
162
|
|
|
163
|
+
### <a id="addressStakeWeight"></a>addressStakeWeight
|
|
164
|
+
|
|
165
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
166
|
+
|
|
167
|
+
***
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
function addressStakeWeight(
|
|
171
|
+
stakeContract,
|
|
172
|
+
staked,
|
|
173
|
+
by,
|
|
174
|
+
startEthBlock,
|
|
175
|
+
endEthBlock): Promise<bigint>;
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## Parameters
|
|
179
|
+
|
|
180
|
+
### stakeContract
|
|
181
|
+
|
|
182
|
+
`AddressStakingV2`
|
|
183
|
+
|
|
184
|
+
### staked
|
|
185
|
+
|
|
186
|
+
`Brand`
|
|
187
|
+
|
|
188
|
+
### by
|
|
189
|
+
|
|
190
|
+
`Brand`
|
|
191
|
+
|
|
192
|
+
### startEthBlock
|
|
193
|
+
|
|
194
|
+
`number`
|
|
195
|
+
|
|
196
|
+
### endEthBlock
|
|
197
|
+
|
|
198
|
+
`number`
|
|
199
|
+
|
|
200
|
+
## Returns
|
|
201
|
+
|
|
202
|
+
`Promise`\<`bigint`\>
|
|
203
|
+
|
|
114
204
|
### <a id="allHashesPresent"></a>allHashesPresent
|
|
115
205
|
|
|
116
206
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -125,7 +215,9 @@ function allHashesPresent(hashes, payloads): boolean;
|
|
|
125
215
|
|
|
126
216
|
### hashes
|
|
127
217
|
|
|
128
|
-
`Lowercase`\<`string
|
|
218
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
219
|
+
\}\>, \{
|
|
220
|
+
\}\>[]
|
|
129
221
|
|
|
130
222
|
### payloads
|
|
131
223
|
|
|
@@ -135,14 +227,14 @@ function allHashesPresent(hashes, payloads): boolean;
|
|
|
135
227
|
|
|
136
228
|
`boolean`
|
|
137
229
|
|
|
138
|
-
### <a id="
|
|
230
|
+
### <a id="balancesStepSummaryFromRange"></a>balancesStepSummaryFromRange
|
|
139
231
|
|
|
140
232
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
141
233
|
|
|
142
234
|
***
|
|
143
235
|
|
|
144
236
|
```ts
|
|
145
|
-
function
|
|
237
|
+
function balancesStepSummaryFromRange(context, range): Promise<WithStorageMeta<BalancesStepSummary>>;
|
|
146
238
|
```
|
|
147
239
|
|
|
148
240
|
## Parameters
|
|
@@ -159,14 +251,16 @@ function balanceStepSummaryFromRange(context, range): Promise<WithStorageMeta<Ba
|
|
|
159
251
|
|
|
160
252
|
`Promise`\<`WithStorageMeta`\<[`BalancesStepSummary`](#../type-aliases/BalancesStepSummary)\>\>
|
|
161
253
|
|
|
162
|
-
### <a id="
|
|
254
|
+
### <a id="balancesSummary"></a>balancesSummary
|
|
163
255
|
|
|
164
256
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
165
257
|
|
|
166
258
|
***
|
|
167
259
|
|
|
168
260
|
```ts
|
|
169
|
-
function
|
|
261
|
+
function balancesSummary(context): Promise<Partial<Record<Brand<Brand<Lowercase<string>, {
|
|
262
|
+
}>, {
|
|
263
|
+
}>, bigint>>>;
|
|
170
264
|
```
|
|
171
265
|
|
|
172
266
|
## Parameters
|
|
@@ -177,7 +271,33 @@ function balanceSummary(context): Promise<Partial<Record<Lowercase<string>, bigi
|
|
|
177
271
|
|
|
178
272
|
## Returns
|
|
179
273
|
|
|
180
|
-
`Promise`\<`Partial`\<`Record`\<`Lowercase`\<`string`\>,
|
|
274
|
+
`Promise`\<`Partial`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
275
|
+
\}\>, \{
|
|
276
|
+
\}\>, `bigint`\>\>\>
|
|
277
|
+
|
|
278
|
+
### <a id="blockFromBlockNumber"></a>blockFromBlockNumber
|
|
279
|
+
|
|
280
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
281
|
+
|
|
282
|
+
***
|
|
283
|
+
|
|
284
|
+
```ts
|
|
285
|
+
function blockFromBlockNumber(context, blockNumber): Promise<WithStorageMeta<BlockBoundWitness>>;
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
## Parameters
|
|
289
|
+
|
|
290
|
+
### context
|
|
291
|
+
|
|
292
|
+
[`ChainContext`](#../interfaces/ChainContext)
|
|
293
|
+
|
|
294
|
+
### blockNumber
|
|
295
|
+
|
|
296
|
+
`number`
|
|
297
|
+
|
|
298
|
+
## Returns
|
|
299
|
+
|
|
300
|
+
`Promise`\<`WithStorageMeta`\<`BlockBoundWitness`\>\>
|
|
181
301
|
|
|
182
302
|
### <a id="blockPayloadsFromHydratedBlock"></a>blockPayloadsFromHydratedBlock
|
|
183
303
|
|
|
@@ -208,26 +328,26 @@ function blockPayloadsFromHydratedBlock(block): WithStorageMeta<Payload>[];
|
|
|
208
328
|
```ts
|
|
209
329
|
function buildTransaction(
|
|
210
330
|
chain,
|
|
211
|
-
|
|
212
|
-
|
|
331
|
+
onChainPayloads,
|
|
332
|
+
offChainPayloads,
|
|
213
333
|
signer,
|
|
214
334
|
nbf,
|
|
215
335
|
exp,
|
|
216
336
|
from?,
|
|
217
|
-
fees?): Promise<
|
|
337
|
+
fees?): Promise<SignedHydratedTransactionWithStorageMeta>;
|
|
218
338
|
```
|
|
219
339
|
|
|
220
340
|
## Parameters
|
|
221
341
|
|
|
222
342
|
### chain
|
|
223
343
|
|
|
224
|
-
`
|
|
344
|
+
`Chain`
|
|
225
345
|
|
|
226
|
-
###
|
|
346
|
+
### onChainPayloads
|
|
227
347
|
|
|
228
348
|
`AllowedBlockPayload`[]
|
|
229
349
|
|
|
230
|
-
###
|
|
350
|
+
### offChainPayloads
|
|
231
351
|
|
|
232
352
|
`Payload`[]
|
|
233
353
|
|
|
@@ -245,7 +365,9 @@ fees?): Promise<HydratedTransaction>;
|
|
|
245
365
|
|
|
246
366
|
### from?
|
|
247
367
|
|
|
248
|
-
`Lowercase`\<`string
|
|
368
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
369
|
+
\}\>, \{
|
|
370
|
+
\}\>
|
|
249
371
|
|
|
250
372
|
### fees?
|
|
251
373
|
|
|
@@ -253,7 +375,58 @@ fees?): Promise<HydratedTransaction>;
|
|
|
253
375
|
|
|
254
376
|
## Returns
|
|
255
377
|
|
|
256
|
-
`Promise`\<`
|
|
378
|
+
`Promise`\<`SignedHydratedTransactionWithStorageMeta`\>
|
|
379
|
+
|
|
380
|
+
### <a id="buildUnsignedTransaction"></a>buildUnsignedTransaction
|
|
381
|
+
|
|
382
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
383
|
+
|
|
384
|
+
***
|
|
385
|
+
|
|
386
|
+
```ts
|
|
387
|
+
function buildUnsignedTransaction(
|
|
388
|
+
chain,
|
|
389
|
+
onChainPayloads,
|
|
390
|
+
offChainPayloads,
|
|
391
|
+
nbf,
|
|
392
|
+
exp,
|
|
393
|
+
from,
|
|
394
|
+
fees): Promise<SignedHydratedTransactionWithStorageMeta>;
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
## Parameters
|
|
398
|
+
|
|
399
|
+
### chain
|
|
400
|
+
|
|
401
|
+
`Chain`
|
|
402
|
+
|
|
403
|
+
### onChainPayloads
|
|
404
|
+
|
|
405
|
+
`AllowedBlockPayload`[]
|
|
406
|
+
|
|
407
|
+
### offChainPayloads
|
|
408
|
+
|
|
409
|
+
`Payload`[]
|
|
410
|
+
|
|
411
|
+
### nbf
|
|
412
|
+
|
|
413
|
+
`number`
|
|
414
|
+
|
|
415
|
+
### exp
|
|
416
|
+
|
|
417
|
+
`number`
|
|
418
|
+
|
|
419
|
+
### from
|
|
420
|
+
|
|
421
|
+
`Brand`
|
|
422
|
+
|
|
423
|
+
### fees
|
|
424
|
+
|
|
425
|
+
`TransactionFeesBigInt` = `defaultTransactionFees`
|
|
426
|
+
|
|
427
|
+
## Returns
|
|
428
|
+
|
|
429
|
+
`Promise`\<`SignedHydratedTransactionWithStorageMeta`\>
|
|
257
430
|
|
|
258
431
|
### <a id="calculateFramesFromRange"></a>calculateFramesFromRange
|
|
259
432
|
|
|
@@ -279,6 +452,67 @@ function calculateFramesFromRange(range, step): [BlockNumberRange[], BlockNumber
|
|
|
279
452
|
|
|
280
453
|
\[[`BlockNumberRange`](#../type-aliases/BlockNumberRange)[], [`BlockNumberRange`](#../type-aliases/BlockNumberRange)[]\]
|
|
281
454
|
|
|
455
|
+
### <a id="claimedRewards"></a>claimedRewards
|
|
456
|
+
|
|
457
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
458
|
+
|
|
459
|
+
***
|
|
460
|
+
|
|
461
|
+
```ts
|
|
462
|
+
function claimedRewards(_address): bigint;
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
## Parameters
|
|
466
|
+
|
|
467
|
+
### \_address
|
|
468
|
+
|
|
469
|
+
`Brand`
|
|
470
|
+
|
|
471
|
+
## Returns
|
|
472
|
+
|
|
473
|
+
`bigint`
|
|
474
|
+
|
|
475
|
+
### <a id="confirmSubmittedTransaction"></a>confirmSubmittedTransaction
|
|
476
|
+
|
|
477
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
478
|
+
|
|
479
|
+
***
|
|
480
|
+
|
|
481
|
+
```ts
|
|
482
|
+
function confirmSubmittedTransaction(
|
|
483
|
+
viewer,
|
|
484
|
+
transaction,
|
|
485
|
+
options?): Promise<SignedHydratedTransaction>;
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
Confirms a submitted transaction by checking if it has been included in the blockchain.
|
|
489
|
+
|
|
490
|
+
## Parameters
|
|
491
|
+
|
|
492
|
+
### viewer
|
|
493
|
+
|
|
494
|
+
`XyoViewer`
|
|
495
|
+
|
|
496
|
+
The viewer
|
|
497
|
+
|
|
498
|
+
### transaction
|
|
499
|
+
|
|
500
|
+
`Signed`\<`TransactionBoundWitness`\>
|
|
501
|
+
|
|
502
|
+
The transaction to confirm
|
|
503
|
+
|
|
504
|
+
### options?
|
|
505
|
+
|
|
506
|
+
[`ConfirmSubmittedTransactionOptions`](#../type-aliases/ConfirmSubmittedTransactionOptions)
|
|
507
|
+
|
|
508
|
+
Options for confirmation
|
|
509
|
+
|
|
510
|
+
## Returns
|
|
511
|
+
|
|
512
|
+
`Promise`\<`SignedHydratedTransaction`\>
|
|
513
|
+
|
|
514
|
+
The confirmed transaction or throws an error if not confirmed
|
|
515
|
+
|
|
282
516
|
### <a id="crackOperation"></a>crackOperation
|
|
283
517
|
|
|
284
518
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -343,6 +577,50 @@ function deepCalculateFramesFromRange(range, startingStep): BlockNumberRange[];
|
|
|
343
577
|
|
|
344
578
|
[`BlockNumberRange`](#../type-aliases/BlockNumberRange)[]
|
|
345
579
|
|
|
580
|
+
### <a id="extractElevatedHashes"></a>extractElevatedHashes
|
|
581
|
+
|
|
582
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
583
|
+
|
|
584
|
+
***
|
|
585
|
+
|
|
586
|
+
```ts
|
|
587
|
+
function extractElevatedHashes(tx): WithStorageMeta<AllowedBlockPayload>[];
|
|
588
|
+
```
|
|
589
|
+
|
|
590
|
+
## Parameters
|
|
591
|
+
|
|
592
|
+
### tx
|
|
593
|
+
|
|
594
|
+
`HydratedTransactionWithStorageMeta`
|
|
595
|
+
|
|
596
|
+
## Returns
|
|
597
|
+
|
|
598
|
+
`WithStorageMeta`\<`AllowedBlockPayload`\>[]
|
|
599
|
+
|
|
600
|
+
### <a id="extractElevatedHashesFromScript"></a>extractElevatedHashesFromScript
|
|
601
|
+
|
|
602
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
603
|
+
|
|
604
|
+
***
|
|
605
|
+
|
|
606
|
+
```ts
|
|
607
|
+
function extractElevatedHashesFromScript(strings): Brand<Brand<Lowercase<string>, {
|
|
608
|
+
}>, {
|
|
609
|
+
}>[];
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
## Parameters
|
|
613
|
+
|
|
614
|
+
### strings
|
|
615
|
+
|
|
616
|
+
`string`[]
|
|
617
|
+
|
|
618
|
+
## Returns
|
|
619
|
+
|
|
620
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
621
|
+
\}\>, \{
|
|
622
|
+
\}\>[]
|
|
623
|
+
|
|
346
624
|
### <a id="flattenHydratedBlock"></a>flattenHydratedBlock
|
|
347
625
|
|
|
348
626
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -397,7 +675,7 @@ function flattenHydratedTransaction(hydratedTransaction): Payload[];
|
|
|
397
675
|
|
|
398
676
|
### hydratedTransaction
|
|
399
677
|
|
|
400
|
-
`
|
|
678
|
+
`SignedHydratedTransaction`
|
|
401
679
|
|
|
402
680
|
## Returns
|
|
403
681
|
|
|
@@ -417,54 +695,68 @@ function flattenHydratedTransactions(hydratedTransactions): Payload[];
|
|
|
417
695
|
|
|
418
696
|
### hydratedTransactions
|
|
419
697
|
|
|
420
|
-
`
|
|
698
|
+
`SignedHydratedTransaction`[]
|
|
421
699
|
|
|
422
700
|
## Returns
|
|
423
701
|
|
|
424
702
|
`Payload`[]
|
|
425
703
|
|
|
426
|
-
### <a id="
|
|
704
|
+
### <a id="generateXyoBaseWalletFromPhrase"></a>generateXyoBaseWalletFromPhrase
|
|
427
705
|
|
|
428
706
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
429
707
|
|
|
430
708
|
***
|
|
431
709
|
|
|
432
710
|
```ts
|
|
433
|
-
function
|
|
711
|
+
function generateXyoBaseWalletFromPhrase(walletPhrase): Promise<WalletInstance>;
|
|
434
712
|
```
|
|
435
713
|
|
|
714
|
+
Initializes a wallet to the default XYO path from a mnemonic phrase
|
|
715
|
+
|
|
716
|
+
## Parameters
|
|
717
|
+
|
|
718
|
+
### walletPhrase
|
|
719
|
+
|
|
720
|
+
`string`
|
|
721
|
+
|
|
722
|
+
The mnemonic phrase for the wallet
|
|
723
|
+
|
|
436
724
|
## Returns
|
|
437
725
|
|
|
438
|
-
`
|
|
726
|
+
`Promise`\<`WalletInstance`\>
|
|
439
727
|
|
|
440
|
-
|
|
728
|
+
A wallet initialized to the default XYO path using the provided phrase
|
|
441
729
|
|
|
442
|
-
|
|
443
|
-
silent: boolean;
|
|
444
|
-
```
|
|
730
|
+
### <a id="getDefaultConfig"></a>getDefaultConfig
|
|
445
731
|
|
|
446
|
-
|
|
732
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
733
|
+
|
|
734
|
+
***
|
|
447
735
|
|
|
448
736
|
```ts
|
|
449
|
-
|
|
737
|
+
function getDefaultConfig(): object;
|
|
450
738
|
```
|
|
451
739
|
|
|
740
|
+
## Returns
|
|
741
|
+
|
|
742
|
+
`object`
|
|
743
|
+
|
|
452
744
|
### api
|
|
453
745
|
|
|
454
746
|
```ts
|
|
455
747
|
api: object;
|
|
456
748
|
```
|
|
457
749
|
|
|
458
|
-
### api.
|
|
750
|
+
### api.host
|
|
459
751
|
|
|
460
752
|
```ts
|
|
461
|
-
|
|
753
|
+
host: string;
|
|
462
754
|
```
|
|
463
755
|
|
|
464
|
-
### api.
|
|
756
|
+
### api.mnemonic?
|
|
465
757
|
|
|
466
758
|
```ts
|
|
467
|
-
|
|
759
|
+
optional mnemonic: string;
|
|
468
760
|
```
|
|
469
761
|
|
|
470
762
|
### api.port
|
|
@@ -545,12 +837,32 @@ optional url: string;
|
|
|
545
837
|
producer: object;
|
|
546
838
|
```
|
|
547
839
|
|
|
840
|
+
### producer.allowlist?
|
|
841
|
+
|
|
842
|
+
```ts
|
|
843
|
+
optional allowlist: Brand<Brand<Lowercase<string>, {
|
|
844
|
+
}>, {
|
|
845
|
+
}>[];
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
### producer.disableIntentRedeclaration?
|
|
849
|
+
|
|
850
|
+
```ts
|
|
851
|
+
optional disableIntentRedeclaration: boolean;
|
|
852
|
+
```
|
|
853
|
+
|
|
548
854
|
### producer.healthCheckPort?
|
|
549
855
|
|
|
550
856
|
```ts
|
|
551
857
|
optional healthCheckPort: number;
|
|
552
858
|
```
|
|
553
859
|
|
|
860
|
+
### producer.heartbeatInterval
|
|
861
|
+
|
|
862
|
+
```ts
|
|
863
|
+
heartbeatInterval: number;
|
|
864
|
+
```
|
|
865
|
+
|
|
554
866
|
### producer.minStake
|
|
555
867
|
|
|
556
868
|
```ts
|
|
@@ -569,12 +881,6 @@ optional mnemonic: string;
|
|
|
569
881
|
port: number;
|
|
570
882
|
```
|
|
571
883
|
|
|
572
|
-
### producer.disableIntentRedeclaration?
|
|
573
|
-
|
|
574
|
-
```ts
|
|
575
|
-
optional disableIntentRedeclaration: boolean;
|
|
576
|
-
```
|
|
577
|
-
|
|
578
884
|
### producer.rewardAddress?
|
|
579
885
|
|
|
580
886
|
```ts
|
|
@@ -645,6 +951,18 @@ optional otel: object;
|
|
|
645
951
|
|
|
646
952
|
```ts
|
|
647
953
|
optional otlpEndpoint: string;
|
|
954
|
+
```
|
|
955
|
+
|
|
956
|
+
### logLevel
|
|
957
|
+
|
|
958
|
+
```ts
|
|
959
|
+
logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
|
|
960
|
+
```
|
|
961
|
+
|
|
962
|
+
### silent
|
|
963
|
+
|
|
964
|
+
```ts
|
|
965
|
+
silent: boolean;
|
|
648
966
|
```
|
|
649
967
|
|
|
650
968
|
### <a id="getUrl"></a>getUrl
|
|
@@ -724,7 +1042,9 @@ establishing a connection
|
|
|
724
1042
|
***
|
|
725
1043
|
|
|
726
1044
|
```ts
|
|
727
|
-
function hashFromBlockNumber(context, blockNumber): Promise<Lowercase<string
|
|
1045
|
+
function hashFromBlockNumber(context, blockNumber): Promise<Brand<Brand<Lowercase<string>, {
|
|
1046
|
+
}>, {
|
|
1047
|
+
}>>;
|
|
728
1048
|
```
|
|
729
1049
|
|
|
730
1050
|
## Parameters
|
|
@@ -739,7 +1059,9 @@ function hashFromBlockNumber(context, blockNumber): Promise<Lowercase<string>>;
|
|
|
739
1059
|
|
|
740
1060
|
## Returns
|
|
741
1061
|
|
|
742
|
-
`Promise`\<`Lowercase`\<`string
|
|
1062
|
+
`Promise`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1063
|
+
\}\>, \{
|
|
1064
|
+
\}\>\>
|
|
743
1065
|
|
|
744
1066
|
### <a id="hydrateBlock"></a>hydrateBlock
|
|
745
1067
|
|
|
@@ -763,7 +1085,7 @@ minDepth): Promise<HydratedBlock>;
|
|
|
763
1085
|
|
|
764
1086
|
### hash
|
|
765
1087
|
|
|
766
|
-
`
|
|
1088
|
+
`Brand`
|
|
767
1089
|
|
|
768
1090
|
### maxDepth
|
|
769
1091
|
|
|
@@ -784,7 +1106,7 @@ minDepth): Promise<HydratedBlock>;
|
|
|
784
1106
|
***
|
|
785
1107
|
|
|
786
1108
|
```ts
|
|
787
|
-
function hydrateElevatedTransaction(archivist, hash): Promise<
|
|
1109
|
+
function hydrateElevatedTransaction(archivist, hash): Promise<SignedHydratedTransaction>;
|
|
788
1110
|
```
|
|
789
1111
|
|
|
790
1112
|
## Parameters
|
|
@@ -795,11 +1117,11 @@ function hydrateElevatedTransaction(archivist, hash): Promise<HydratedTransactio
|
|
|
795
1117
|
|
|
796
1118
|
### hash
|
|
797
1119
|
|
|
798
|
-
`
|
|
1120
|
+
`Brand`
|
|
799
1121
|
|
|
800
1122
|
## Returns
|
|
801
1123
|
|
|
802
|
-
`Promise`\<`
|
|
1124
|
+
`Promise`\<`SignedHydratedTransaction`\>
|
|
803
1125
|
|
|
804
1126
|
### <a id="hydrateTransaction"></a>hydrateTransaction
|
|
805
1127
|
|
|
@@ -808,7 +1130,7 @@ function hydrateElevatedTransaction(archivist, hash): Promise<HydratedTransactio
|
|
|
808
1130
|
***
|
|
809
1131
|
|
|
810
1132
|
```ts
|
|
811
|
-
function hydrateTransaction(archivist, hash): Promise<
|
|
1133
|
+
function hydrateTransaction(archivist, hash): Promise<SignedHydratedTransaction>;
|
|
812
1134
|
```
|
|
813
1135
|
|
|
814
1136
|
## Parameters
|
|
@@ -819,11 +1141,11 @@ function hydrateTransaction(archivist, hash): Promise<HydratedTransaction>;
|
|
|
819
1141
|
|
|
820
1142
|
### hash
|
|
821
1143
|
|
|
822
|
-
`
|
|
1144
|
+
`Brand`
|
|
823
1145
|
|
|
824
1146
|
## Returns
|
|
825
1147
|
|
|
826
|
-
`Promise`\<`
|
|
1148
|
+
`Promise`\<`SignedHydratedTransaction`\>
|
|
827
1149
|
|
|
828
1150
|
### <a id="isBalancesStepSummaryWithStorageMeta"></a>isBalancesStepSummaryWithStorageMeta
|
|
829
1151
|
|
|
@@ -907,61 +1229,495 @@ function isPositiveBigInt(value): value is PositiveBigInt;
|
|
|
907
1229
|
|
|
908
1230
|
`value is PositiveBigInt`
|
|
909
1231
|
|
|
910
|
-
### <a id="
|
|
1232
|
+
### <a id="isTransfersStepSummaryWithStorageMeta"></a>isTransfersStepSummaryWithStorageMeta
|
|
911
1233
|
|
|
912
1234
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
913
1235
|
|
|
914
1236
|
***
|
|
915
1237
|
|
|
916
1238
|
```ts
|
|
917
|
-
function
|
|
1239
|
+
function isTransfersStepSummaryWithStorageMeta(value): value is WithStorageMeta<TransfersStepSummary>;
|
|
918
1240
|
```
|
|
919
1241
|
|
|
1242
|
+
Identity function for determining if an object is an TransfersStepSummary with Storage Meta
|
|
1243
|
+
|
|
920
1244
|
## Parameters
|
|
921
1245
|
|
|
922
|
-
###
|
|
1246
|
+
### value
|
|
923
1247
|
|
|
924
|
-
`
|
|
1248
|
+
`unknown`
|
|
925
1249
|
|
|
926
1250
|
## Returns
|
|
927
1251
|
|
|
928
|
-
`
|
|
1252
|
+
`value is WithStorageMeta<TransfersStepSummary>`
|
|
929
1253
|
|
|
930
|
-
### <a id="
|
|
1254
|
+
### <a id="isUsageMeta"></a>isUsageMeta
|
|
931
1255
|
|
|
932
1256
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
933
1257
|
|
|
934
1258
|
***
|
|
935
1259
|
|
|
936
1260
|
```ts
|
|
937
|
-
function
|
|
1261
|
+
function isUsageMeta(v): v is { id?: string; deprecated?: boolean; choices?: readonly (undefined | string | number | true)[]; default?: unknown; description: string; group?: string; hidden?: boolean; title: string; type: "string" | "number" | "boolean" | "array" | "count"; [key: string]: unknown };
|
|
938
1262
|
```
|
|
939
1263
|
|
|
940
1264
|
## Parameters
|
|
941
1265
|
|
|
942
|
-
###
|
|
1266
|
+
### v
|
|
943
1267
|
|
|
944
|
-
|
|
1268
|
+
`unknown`
|
|
945
1269
|
|
|
946
1270
|
## Returns
|
|
947
1271
|
|
|
948
|
-
|
|
1272
|
+
v is \{ id?: string; deprecated?: boolean; choices?: readonly (undefined \| string \| number \| true)\[\]; default?: unknown; description: string; group?: string; hidden?: boolean; title: string; type: "string" \| "number" \| "boolean" \| "array" \| "count"; \[key: string\]: unknown \}
|
|
949
1273
|
|
|
950
|
-
### <a id="
|
|
1274
|
+
### <a id="netBalancesForPayloads"></a>netBalancesForPayloads
|
|
951
1275
|
|
|
952
1276
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
953
1277
|
|
|
954
1278
|
***
|
|
955
1279
|
|
|
956
1280
|
```ts
|
|
957
|
-
function
|
|
1281
|
+
function netBalancesForPayloads(payloads): Record<Brand<Brand<Lowercase<string>, {
|
|
1282
|
+
}>, {
|
|
1283
|
+
}>, bigint>;
|
|
958
1284
|
```
|
|
959
1285
|
|
|
960
1286
|
## Parameters
|
|
961
1287
|
|
|
962
|
-
###
|
|
1288
|
+
### payloads
|
|
963
1289
|
|
|
964
|
-
`
|
|
1290
|
+
`Payload`[]
|
|
1291
|
+
|
|
1292
|
+
## Returns
|
|
1293
|
+
|
|
1294
|
+
`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1295
|
+
\}\>, \{
|
|
1296
|
+
\}\>, `bigint`\>
|
|
1297
|
+
|
|
1298
|
+
### <a id="netTransfersForPayloads"></a>netTransfersForPayloads
|
|
1299
|
+
|
|
1300
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1301
|
+
|
|
1302
|
+
***
|
|
1303
|
+
|
|
1304
|
+
```ts
|
|
1305
|
+
function netTransfersForPayloads(payloads, account): Record<Address, bigint>;
|
|
1306
|
+
```
|
|
1307
|
+
|
|
1308
|
+
## Parameters
|
|
1309
|
+
|
|
1310
|
+
### payloads
|
|
1311
|
+
|
|
1312
|
+
`Payload`[]
|
|
1313
|
+
|
|
1314
|
+
### account
|
|
1315
|
+
|
|
1316
|
+
`Brand`
|
|
1317
|
+
|
|
1318
|
+
## Returns
|
|
1319
|
+
|
|
1320
|
+
`Record`\<`Address`, `bigint`\>
|
|
1321
|
+
|
|
1322
|
+
### <a id="networkStakeStepAddressReward"></a>networkStakeStepAddressReward
|
|
1323
|
+
|
|
1324
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1325
|
+
|
|
1326
|
+
***
|
|
1327
|
+
|
|
1328
|
+
```ts
|
|
1329
|
+
function networkStakeStepAddressReward(
|
|
1330
|
+
address,
|
|
1331
|
+
_step,
|
|
1332
|
+
_block): Promisable<Record<Brand<Brand<Lowercase<string>, {
|
|
1333
|
+
}>, {
|
|
1334
|
+
}>, bigint>>;
|
|
1335
|
+
```
|
|
1336
|
+
|
|
1337
|
+
## Parameters
|
|
1338
|
+
|
|
1339
|
+
### address
|
|
1340
|
+
|
|
1341
|
+
`Brand`
|
|
1342
|
+
|
|
1343
|
+
### \_step
|
|
1344
|
+
|
|
1345
|
+
`number`
|
|
1346
|
+
|
|
1347
|
+
### \_block
|
|
1348
|
+
|
|
1349
|
+
`number`
|
|
1350
|
+
|
|
1351
|
+
## Returns
|
|
1352
|
+
|
|
1353
|
+
`Promisable`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1354
|
+
\}\>, \{
|
|
1355
|
+
\}\>, `bigint`\>\>
|
|
1356
|
+
|
|
1357
|
+
### <a id="networkStakeStepPoolRewardShares"></a>networkStakeStepPoolRewardShares
|
|
1358
|
+
|
|
1359
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1360
|
+
|
|
1361
|
+
***
|
|
1362
|
+
|
|
1363
|
+
```ts
|
|
1364
|
+
function networkStakeStepPoolRewardShares(_step, _block): Promisable<Record<Brand<Brand<Lowercase<string>, {
|
|
1365
|
+
}>, {
|
|
1366
|
+
}>, bigint>>;
|
|
1367
|
+
```
|
|
1368
|
+
|
|
1369
|
+
## Parameters
|
|
1370
|
+
|
|
1371
|
+
### \_step
|
|
1372
|
+
|
|
1373
|
+
`number`
|
|
1374
|
+
|
|
1375
|
+
### \_block
|
|
1376
|
+
|
|
1377
|
+
`number`
|
|
1378
|
+
|
|
1379
|
+
## Returns
|
|
1380
|
+
|
|
1381
|
+
`Promisable`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1382
|
+
\}\>, \{
|
|
1383
|
+
\}\>, `bigint`\>\>
|
|
1384
|
+
|
|
1385
|
+
### <a id="networkStakeStepPoolRewards"></a>networkStakeStepPoolRewards
|
|
1386
|
+
|
|
1387
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1388
|
+
|
|
1389
|
+
***
|
|
1390
|
+
|
|
1391
|
+
```ts
|
|
1392
|
+
function networkStakeStepPoolRewards(_step, _block): Promisable<Record<Brand<Brand<Lowercase<string>, {
|
|
1393
|
+
}>, {
|
|
1394
|
+
}>, bigint>>;
|
|
1395
|
+
```
|
|
1396
|
+
|
|
1397
|
+
## Parameters
|
|
1398
|
+
|
|
1399
|
+
### \_step
|
|
1400
|
+
|
|
1401
|
+
`number`
|
|
1402
|
+
|
|
1403
|
+
### \_block
|
|
1404
|
+
|
|
1405
|
+
`number`
|
|
1406
|
+
|
|
1407
|
+
## Returns
|
|
1408
|
+
|
|
1409
|
+
`Promisable`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1410
|
+
\}\>, \{
|
|
1411
|
+
\}\>, `bigint`\>\>
|
|
1412
|
+
|
|
1413
|
+
### <a id="networkStakeStepRewardAddressHistory"></a>networkStakeStepRewardAddressHistory
|
|
1414
|
+
|
|
1415
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1416
|
+
|
|
1417
|
+
***
|
|
1418
|
+
|
|
1419
|
+
```ts
|
|
1420
|
+
function networkStakeStepRewardAddressHistory(address): Promisable<Record<Brand<Brand<Lowercase<string>, {
|
|
1421
|
+
}>, {
|
|
1422
|
+
}>, bigint>>;
|
|
1423
|
+
```
|
|
1424
|
+
|
|
1425
|
+
## Parameters
|
|
1426
|
+
|
|
1427
|
+
### address
|
|
1428
|
+
|
|
1429
|
+
`Brand`
|
|
1430
|
+
|
|
1431
|
+
## Returns
|
|
1432
|
+
|
|
1433
|
+
`Promisable`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1434
|
+
\}\>, \{
|
|
1435
|
+
\}\>, `bigint`\>\>
|
|
1436
|
+
|
|
1437
|
+
### <a id="networkStakeStepRewardAddressShare"></a>networkStakeStepRewardAddressShare
|
|
1438
|
+
|
|
1439
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1440
|
+
|
|
1441
|
+
***
|
|
1442
|
+
|
|
1443
|
+
```ts
|
|
1444
|
+
function networkStakeStepRewardAddressShare(
|
|
1445
|
+
_address,
|
|
1446
|
+
_step,
|
|
1447
|
+
_block): Promisable<[bigint, bigint]>;
|
|
1448
|
+
```
|
|
1449
|
+
|
|
1450
|
+
## Parameters
|
|
1451
|
+
|
|
1452
|
+
### \_address
|
|
1453
|
+
|
|
1454
|
+
`Brand`
|
|
1455
|
+
|
|
1456
|
+
### \_step
|
|
1457
|
+
|
|
1458
|
+
`number`
|
|
1459
|
+
|
|
1460
|
+
### \_block
|
|
1461
|
+
|
|
1462
|
+
`number`
|
|
1463
|
+
|
|
1464
|
+
## Returns
|
|
1465
|
+
|
|
1466
|
+
`Promisable`\<\[`bigint`, `bigint`\]\>
|
|
1467
|
+
|
|
1468
|
+
### <a id="networkStakeStepRewardForStep"></a>networkStakeStepRewardForStep
|
|
1469
|
+
|
|
1470
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1471
|
+
|
|
1472
|
+
***
|
|
1473
|
+
|
|
1474
|
+
```ts
|
|
1475
|
+
function networkStakeStepRewardForStep(_step): Promisable<bigint>;
|
|
1476
|
+
```
|
|
1477
|
+
|
|
1478
|
+
## Parameters
|
|
1479
|
+
|
|
1480
|
+
### \_step
|
|
1481
|
+
|
|
1482
|
+
`number`
|
|
1483
|
+
|
|
1484
|
+
## Returns
|
|
1485
|
+
|
|
1486
|
+
`Promisable`\<`bigint`\>
|
|
1487
|
+
|
|
1488
|
+
### <a id="networkStakeStepRewardPositionWeight"></a>networkStakeStepRewardPositionWeight
|
|
1489
|
+
|
|
1490
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1491
|
+
|
|
1492
|
+
***
|
|
1493
|
+
|
|
1494
|
+
```ts
|
|
1495
|
+
function networkStakeStepRewardPositionWeight(_position, _step): Promisable<number>;
|
|
1496
|
+
```
|
|
1497
|
+
|
|
1498
|
+
## Parameters
|
|
1499
|
+
|
|
1500
|
+
### \_position
|
|
1501
|
+
|
|
1502
|
+
`bigint`
|
|
1503
|
+
|
|
1504
|
+
### \_step
|
|
1505
|
+
|
|
1506
|
+
`number`
|
|
1507
|
+
|
|
1508
|
+
## Returns
|
|
1509
|
+
|
|
1510
|
+
`Promisable`\<`number`\>
|
|
1511
|
+
|
|
1512
|
+
### <a id="networkStakeStepRewardPotentialPositionLoss"></a>networkStakeStepRewardPotentialPositionLoss
|
|
1513
|
+
|
|
1514
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1515
|
+
|
|
1516
|
+
***
|
|
1517
|
+
|
|
1518
|
+
```ts
|
|
1519
|
+
function networkStakeStepRewardPotentialPositionLoss(_position, _step): Promisable<bigint>;
|
|
1520
|
+
```
|
|
1521
|
+
|
|
1522
|
+
## Parameters
|
|
1523
|
+
|
|
1524
|
+
### \_position
|
|
1525
|
+
|
|
1526
|
+
`bigint`
|
|
1527
|
+
|
|
1528
|
+
### \_step
|
|
1529
|
+
|
|
1530
|
+
`number`
|
|
1531
|
+
|
|
1532
|
+
## Returns
|
|
1533
|
+
|
|
1534
|
+
`Promisable`\<`bigint`\>
|
|
1535
|
+
|
|
1536
|
+
### <a id="networkStakeStepRewardRandomizer"></a>networkStakeStepRewardRandomizer
|
|
1537
|
+
|
|
1538
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1539
|
+
|
|
1540
|
+
***
|
|
1541
|
+
|
|
1542
|
+
```ts
|
|
1543
|
+
function networkStakeStepRewardRandomizer(_step, _block): Promisable<bigint>;
|
|
1544
|
+
```
|
|
1545
|
+
|
|
1546
|
+
## Parameters
|
|
1547
|
+
|
|
1548
|
+
### \_step
|
|
1549
|
+
|
|
1550
|
+
`number`
|
|
1551
|
+
|
|
1552
|
+
### \_block
|
|
1553
|
+
|
|
1554
|
+
`number`
|
|
1555
|
+
|
|
1556
|
+
## Returns
|
|
1557
|
+
|
|
1558
|
+
`Promisable`\<`bigint`\>
|
|
1559
|
+
|
|
1560
|
+
### <a id="networkStakeStepRewardWeightForAddress"></a>networkStakeStepRewardWeightForAddress
|
|
1561
|
+
|
|
1562
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1563
|
+
|
|
1564
|
+
***
|
|
1565
|
+
|
|
1566
|
+
```ts
|
|
1567
|
+
function networkStakeStepRewardWeightForAddress(_address, _step): Promisable<bigint>;
|
|
1568
|
+
```
|
|
1569
|
+
|
|
1570
|
+
## Parameters
|
|
1571
|
+
|
|
1572
|
+
### \_address
|
|
1573
|
+
|
|
1574
|
+
`Brand`
|
|
1575
|
+
|
|
1576
|
+
### \_step
|
|
1577
|
+
|
|
1578
|
+
`number`
|
|
1579
|
+
|
|
1580
|
+
## Returns
|
|
1581
|
+
|
|
1582
|
+
`Promisable`\<`bigint`\>
|
|
1583
|
+
|
|
1584
|
+
### <a id="parseSignedBigInt"></a>parseSignedBigInt
|
|
1585
|
+
|
|
1586
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1587
|
+
|
|
1588
|
+
***
|
|
1589
|
+
|
|
1590
|
+
```ts
|
|
1591
|
+
function parseSignedBigInt(value): bigint;
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
## Parameters
|
|
1595
|
+
|
|
1596
|
+
### value
|
|
1597
|
+
|
|
1598
|
+
[`SignedBigInt`](#../type-aliases/SignedBigInt)
|
|
1599
|
+
|
|
1600
|
+
## Returns
|
|
1601
|
+
|
|
1602
|
+
`bigint`
|
|
1603
|
+
|
|
1604
|
+
### <a id="signTransaction"></a>signTransaction
|
|
1605
|
+
|
|
1606
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1607
|
+
|
|
1608
|
+
***
|
|
1609
|
+
|
|
1610
|
+
```ts
|
|
1611
|
+
function signTransaction(tx, account): Promise<Unsigned<TransactionBoundWitness>>;
|
|
1612
|
+
```
|
|
1613
|
+
|
|
1614
|
+
Signs an unsigned transaction with the provided account.
|
|
1615
|
+
|
|
1616
|
+
## Parameters
|
|
1617
|
+
|
|
1618
|
+
### tx
|
|
1619
|
+
|
|
1620
|
+
`Unsigned`\<`TransactionBoundWitness`\>
|
|
1621
|
+
|
|
1622
|
+
The transaction to sign
|
|
1623
|
+
|
|
1624
|
+
### account
|
|
1625
|
+
|
|
1626
|
+
`AccountInstance`
|
|
1627
|
+
|
|
1628
|
+
The account to sign the transaction with
|
|
1629
|
+
|
|
1630
|
+
## Returns
|
|
1631
|
+
|
|
1632
|
+
`Promise`\<`Unsigned`\<`TransactionBoundWitness`\>\>
|
|
1633
|
+
|
|
1634
|
+
The signed transaction
|
|
1635
|
+
|
|
1636
|
+
### <a id="stakersAsOfBlock"></a>stakersAsOfBlock
|
|
1637
|
+
|
|
1638
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1639
|
+
|
|
1640
|
+
***
|
|
1641
|
+
|
|
1642
|
+
```ts
|
|
1643
|
+
function stakersAsOfBlock(
|
|
1644
|
+
stakeContract,
|
|
1645
|
+
staked,
|
|
1646
|
+
ethBlock): Promise<Brand<Brand<Lowercase<string>, {
|
|
1647
|
+
}>, {
|
|
1648
|
+
}>[]>;
|
|
1649
|
+
```
|
|
1650
|
+
|
|
1651
|
+
## Parameters
|
|
1652
|
+
|
|
1653
|
+
### stakeContract
|
|
1654
|
+
|
|
1655
|
+
`AddressStakingV2`
|
|
1656
|
+
|
|
1657
|
+
### staked
|
|
1658
|
+
|
|
1659
|
+
`Brand`
|
|
1660
|
+
|
|
1661
|
+
### ethBlock
|
|
1662
|
+
|
|
1663
|
+
`number`
|
|
1664
|
+
|
|
1665
|
+
## Returns
|
|
1666
|
+
|
|
1667
|
+
`Promise`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1668
|
+
\}\>, \{
|
|
1669
|
+
\}\>[]\>
|
|
1670
|
+
|
|
1671
|
+
### <a id="startingStakes"></a>startingStakes
|
|
1672
|
+
|
|
1673
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1674
|
+
|
|
1675
|
+
***
|
|
1676
|
+
|
|
1677
|
+
```ts
|
|
1678
|
+
function startingStakes(
|
|
1679
|
+
stakeContract,
|
|
1680
|
+
staked,
|
|
1681
|
+
ethBlock): Promise<Record<Brand<Brand<Lowercase<string>, {
|
|
1682
|
+
}>, {
|
|
1683
|
+
}>, bigint>>;
|
|
1684
|
+
```
|
|
1685
|
+
|
|
1686
|
+
## Parameters
|
|
1687
|
+
|
|
1688
|
+
### stakeContract
|
|
1689
|
+
|
|
1690
|
+
`AddressStakingV2`
|
|
1691
|
+
|
|
1692
|
+
### staked
|
|
1693
|
+
|
|
1694
|
+
`Brand`
|
|
1695
|
+
|
|
1696
|
+
### ethBlock
|
|
1697
|
+
|
|
1698
|
+
`number`
|
|
1699
|
+
|
|
1700
|
+
## Returns
|
|
1701
|
+
|
|
1702
|
+
`Promise`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1703
|
+
\}\>, \{
|
|
1704
|
+
\}\>, `bigint`\>\>
|
|
1705
|
+
|
|
1706
|
+
### <a id="toPositiveBigInt"></a>toPositiveBigInt
|
|
1707
|
+
|
|
1708
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1709
|
+
|
|
1710
|
+
***
|
|
1711
|
+
|
|
1712
|
+
```ts
|
|
1713
|
+
function toPositiveBigInt(value): PositiveBigInt;
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
## Parameters
|
|
1717
|
+
|
|
1718
|
+
### value
|
|
1719
|
+
|
|
1720
|
+
`unknown`
|
|
965
1721
|
|
|
966
1722
|
## Returns
|
|
967
1723
|
|
|
@@ -987,6 +1743,42 @@ function toSignedBigInt(value): SignedBigInt;
|
|
|
987
1743
|
|
|
988
1744
|
[`SignedBigInt`](#../type-aliases/SignedBigInt)
|
|
989
1745
|
|
|
1746
|
+
### <a id="totalStakeWeight"></a>totalStakeWeight
|
|
1747
|
+
|
|
1748
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1749
|
+
|
|
1750
|
+
***
|
|
1751
|
+
|
|
1752
|
+
```ts
|
|
1753
|
+
function totalStakeWeight(
|
|
1754
|
+
stakeContract,
|
|
1755
|
+
staked,
|
|
1756
|
+
startEthBlock,
|
|
1757
|
+
endEthBlock): Promise<bigint>;
|
|
1758
|
+
```
|
|
1759
|
+
|
|
1760
|
+
## Parameters
|
|
1761
|
+
|
|
1762
|
+
### stakeContract
|
|
1763
|
+
|
|
1764
|
+
`AddressStakingV2`
|
|
1765
|
+
|
|
1766
|
+
### staked
|
|
1767
|
+
|
|
1768
|
+
`Brand`
|
|
1769
|
+
|
|
1770
|
+
### startEthBlock
|
|
1771
|
+
|
|
1772
|
+
`number`
|
|
1773
|
+
|
|
1774
|
+
### endEthBlock
|
|
1775
|
+
|
|
1776
|
+
`number`
|
|
1777
|
+
|
|
1778
|
+
## Returns
|
|
1779
|
+
|
|
1780
|
+
`Promise`\<`bigint`\>
|
|
1781
|
+
|
|
990
1782
|
### <a id="transactionBlockByteCount"></a>transactionBlockByteCount
|
|
991
1783
|
|
|
992
1784
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -1003,7 +1795,7 @@ The number of bytes that a transaction and its payloads will take up in a block
|
|
|
1003
1795
|
|
|
1004
1796
|
### \_\_namedParameters
|
|
1005
1797
|
|
|
1006
|
-
`
|
|
1798
|
+
`SignedHydratedTransaction`
|
|
1007
1799
|
|
|
1008
1800
|
## Returns
|
|
1009
1801
|
|
|
@@ -1025,7 +1817,7 @@ The required gas for the byte storage on the block chain for a transaction
|
|
|
1025
1817
|
|
|
1026
1818
|
### \_\_namedParameters
|
|
1027
1819
|
|
|
1028
|
-
`
|
|
1820
|
+
`SignedHydratedTransactionWithStorageMeta`
|
|
1029
1821
|
|
|
1030
1822
|
## Returns
|
|
1031
1823
|
|
|
@@ -1038,7 +1830,9 @@ The required gas for the byte storage on the block chain for a transaction
|
|
|
1038
1830
|
***
|
|
1039
1831
|
|
|
1040
1832
|
```ts
|
|
1041
|
-
function transactionElevatedPayloadHashes(transaction): Lowercase<string
|
|
1833
|
+
function transactionElevatedPayloadHashes(transaction): Brand<Brand<Lowercase<string>, {
|
|
1834
|
+
}>, {
|
|
1835
|
+
}>[];
|
|
1042
1836
|
```
|
|
1043
1837
|
|
|
1044
1838
|
## Parameters
|
|
@@ -1049,7 +1843,9 @@ function transactionElevatedPayloadHashes(transaction): Lowercase<string>[];
|
|
|
1049
1843
|
|
|
1050
1844
|
## Returns
|
|
1051
1845
|
|
|
1052
|
-
`Lowercase`\<`string
|
|
1846
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1847
|
+
\}\>, \{
|
|
1848
|
+
\}\>[]
|
|
1053
1849
|
|
|
1054
1850
|
### <a id="transactionElevatedPayloads"></a>transactionElevatedPayloads
|
|
1055
1851
|
|
|
@@ -1065,7 +1861,7 @@ function transactionElevatedPayloads(__namedParameters): WithHashStorageMeta<Pay
|
|
|
1065
1861
|
|
|
1066
1862
|
### \_\_namedParameters
|
|
1067
1863
|
|
|
1068
|
-
`
|
|
1864
|
+
`SignedHydratedTransactionWithStorageMeta`
|
|
1069
1865
|
|
|
1070
1866
|
## Returns
|
|
1071
1867
|
|
|
@@ -1085,7 +1881,7 @@ function transactionRequiredGas(hydratedTransaction): AttoXL1;
|
|
|
1085
1881
|
|
|
1086
1882
|
### hydratedTransaction
|
|
1087
1883
|
|
|
1088
|
-
`
|
|
1884
|
+
`SignedHydratedTransactionWithStorageMeta`
|
|
1089
1885
|
|
|
1090
1886
|
## Returns
|
|
1091
1887
|
|
|
@@ -1111,6 +1907,98 @@ function transactionsFromHydratedBlock(block): WithStorageMeta<TransactionBoundW
|
|
|
1111
1907
|
|
|
1112
1908
|
`WithStorageMeta`\<`TransactionBoundWitness`\>[]
|
|
1113
1909
|
|
|
1910
|
+
### <a id="transfersStepSummaryFromRange"></a>transfersStepSummaryFromRange
|
|
1911
|
+
|
|
1912
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1913
|
+
|
|
1914
|
+
***
|
|
1915
|
+
|
|
1916
|
+
```ts
|
|
1917
|
+
function transfersStepSummaryFromRange(context, range): Promise<WithStorageMeta<TransfersStepSummary>>;
|
|
1918
|
+
```
|
|
1919
|
+
|
|
1920
|
+
## Parameters
|
|
1921
|
+
|
|
1922
|
+
### context
|
|
1923
|
+
|
|
1924
|
+
[`TransfersStepSummaryContext`](#../interfaces/TransfersStepSummaryContext)
|
|
1925
|
+
|
|
1926
|
+
### range
|
|
1927
|
+
|
|
1928
|
+
[`BlockNumberRange`](#../type-aliases/BlockNumberRange)
|
|
1929
|
+
|
|
1930
|
+
## Returns
|
|
1931
|
+
|
|
1932
|
+
`Promise`\<`WithStorageMeta`\<[`TransfersStepSummary`](#../type-aliases/TransfersStepSummary)\>\>
|
|
1933
|
+
|
|
1934
|
+
### <a id="transfersSummary"></a>transfersSummary
|
|
1935
|
+
|
|
1936
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1937
|
+
|
|
1938
|
+
***
|
|
1939
|
+
|
|
1940
|
+
```ts
|
|
1941
|
+
function transfersSummary(context): Promise<Partial<Record<Brand<Brand<Lowercase<string>, {
|
|
1942
|
+
}>, {
|
|
1943
|
+
}>, bigint>>>;
|
|
1944
|
+
```
|
|
1945
|
+
|
|
1946
|
+
## Parameters
|
|
1947
|
+
|
|
1948
|
+
### context
|
|
1949
|
+
|
|
1950
|
+
[`TransfersStepSummaryContext`](#../interfaces/TransfersStepSummaryContext)
|
|
1951
|
+
|
|
1952
|
+
## Returns
|
|
1953
|
+
|
|
1954
|
+
`Promise`\<`Partial`\<`Record`\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1955
|
+
\}\>, \{
|
|
1956
|
+
\}\>, `bigint`\>\>\>
|
|
1957
|
+
|
|
1958
|
+
### <a id="tryExtractElevatedHashes"></a>tryExtractElevatedHashes
|
|
1959
|
+
|
|
1960
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1961
|
+
|
|
1962
|
+
***
|
|
1963
|
+
|
|
1964
|
+
```ts
|
|
1965
|
+
function tryExtractElevatedHashes(tx): WithStorageMeta<AllowedBlockPayload>[];
|
|
1966
|
+
```
|
|
1967
|
+
|
|
1968
|
+
## Parameters
|
|
1969
|
+
|
|
1970
|
+
### tx
|
|
1971
|
+
|
|
1972
|
+
`HydratedTransactionWithStorageMeta`
|
|
1973
|
+
|
|
1974
|
+
## Returns
|
|
1975
|
+
|
|
1976
|
+
`WithStorageMeta`\<`AllowedBlockPayload`\>[]
|
|
1977
|
+
|
|
1978
|
+
### <a id="tryExtractElevatedHashesFromScript"></a>tryExtractElevatedHashesFromScript
|
|
1979
|
+
|
|
1980
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
1981
|
+
|
|
1982
|
+
***
|
|
1983
|
+
|
|
1984
|
+
```ts
|
|
1985
|
+
function tryExtractElevatedHashesFromScript(strings): Brand<Brand<Lowercase<string>, {
|
|
1986
|
+
}>, {
|
|
1987
|
+
}>[];
|
|
1988
|
+
```
|
|
1989
|
+
|
|
1990
|
+
## Parameters
|
|
1991
|
+
|
|
1992
|
+
### strings
|
|
1993
|
+
|
|
1994
|
+
`string`[]
|
|
1995
|
+
|
|
1996
|
+
## Returns
|
|
1997
|
+
|
|
1998
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1999
|
+
\}\>, \{
|
|
2000
|
+
\}\>[]
|
|
2001
|
+
|
|
1114
2002
|
### <a id="tryHydrateBlock"></a>tryHydrateBlock
|
|
1115
2003
|
|
|
1116
2004
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -1132,7 +2020,7 @@ maxDepth): Promise<undefined | HydratedBlock>;
|
|
|
1132
2020
|
|
|
1133
2021
|
### hash
|
|
1134
2022
|
|
|
1135
|
-
`
|
|
2023
|
+
`Brand`
|
|
1136
2024
|
|
|
1137
2025
|
### maxDepth
|
|
1138
2026
|
|
|
@@ -1149,7 +2037,7 @@ maxDepth): Promise<undefined | HydratedBlock>;
|
|
|
1149
2037
|
***
|
|
1150
2038
|
|
|
1151
2039
|
```ts
|
|
1152
|
-
function tryHydrateElevatedTransaction(archivist, hash): Promise<undefined |
|
|
2040
|
+
function tryHydrateElevatedTransaction(archivist, hash): Promise<undefined | SignedHydratedTransactionWithStorageMeta>;
|
|
1153
2041
|
```
|
|
1154
2042
|
|
|
1155
2043
|
## Parameters
|
|
@@ -1160,11 +2048,11 @@ function tryHydrateElevatedTransaction(archivist, hash): Promise<undefined | Hyd
|
|
|
1160
2048
|
|
|
1161
2049
|
### hash
|
|
1162
2050
|
|
|
1163
|
-
`
|
|
2051
|
+
`Brand`
|
|
1164
2052
|
|
|
1165
2053
|
## Returns
|
|
1166
2054
|
|
|
1167
|
-
`Promise`\<`undefined` \| `
|
|
2055
|
+
`Promise`\<`undefined` \| `SignedHydratedTransactionWithStorageMeta`\>
|
|
1168
2056
|
|
|
1169
2057
|
### <a id="tryHydrateTransaction"></a>tryHydrateTransaction
|
|
1170
2058
|
|
|
@@ -1173,7 +2061,7 @@ function tryHydrateElevatedTransaction(archivist, hash): Promise<undefined | Hyd
|
|
|
1173
2061
|
***
|
|
1174
2062
|
|
|
1175
2063
|
```ts
|
|
1176
|
-
function tryHydrateTransaction(archivist, hash): Promise<undefined |
|
|
2064
|
+
function tryHydrateTransaction(archivist, hash): Promise<undefined | SignedHydratedTransactionWithStorageMeta>;
|
|
1177
2065
|
```
|
|
1178
2066
|
|
|
1179
2067
|
## Parameters
|
|
@@ -1184,11 +2072,55 @@ function tryHydrateTransaction(archivist, hash): Promise<undefined | HydratedTra
|
|
|
1184
2072
|
|
|
1185
2073
|
### hash
|
|
1186
2074
|
|
|
1187
|
-
`
|
|
2075
|
+
`Brand`
|
|
1188
2076
|
|
|
1189
2077
|
## Returns
|
|
1190
2078
|
|
|
1191
|
-
`Promise`\<`undefined` \| `
|
|
2079
|
+
`Promise`\<`undefined` \| `SignedHydratedTransactionWithStorageMeta`\>
|
|
2080
|
+
|
|
2081
|
+
### <a id="unclaimedRewards"></a>unclaimedRewards
|
|
2082
|
+
|
|
2083
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
2084
|
+
|
|
2085
|
+
***
|
|
2086
|
+
|
|
2087
|
+
```ts
|
|
2088
|
+
function unclaimedRewards(_address): Promisable<bigint>;
|
|
2089
|
+
```
|
|
2090
|
+
|
|
2091
|
+
## Parameters
|
|
2092
|
+
|
|
2093
|
+
### \_address
|
|
2094
|
+
|
|
2095
|
+
`Brand`
|
|
2096
|
+
|
|
2097
|
+
## Returns
|
|
2098
|
+
|
|
2099
|
+
`Promisable`\<`bigint`\>
|
|
2100
|
+
|
|
2101
|
+
### <a id="xl1BlockNumberToEthBlockNumber"></a>xl1BlockNumberToEthBlockNumber
|
|
2102
|
+
|
|
2103
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
2104
|
+
|
|
2105
|
+
***
|
|
2106
|
+
|
|
2107
|
+
```ts
|
|
2108
|
+
function xl1BlockNumberToEthBlockNumber(context, xl1BlockNumber): Promise<number>;
|
|
2109
|
+
```
|
|
2110
|
+
|
|
2111
|
+
## Parameters
|
|
2112
|
+
|
|
2113
|
+
### context
|
|
2114
|
+
|
|
2115
|
+
[`ChainContext`](#../interfaces/ChainContext)
|
|
2116
|
+
|
|
2117
|
+
### xl1BlockNumber
|
|
2118
|
+
|
|
2119
|
+
`number`
|
|
2120
|
+
|
|
2121
|
+
## Returns
|
|
2122
|
+
|
|
2123
|
+
`Promise`\<`number`\>
|
|
1192
2124
|
|
|
1193
2125
|
### interfaces
|
|
1194
2126
|
|
|
@@ -1211,7 +2143,7 @@ function tryHydrateTransaction(archivist, hash): Promise<undefined | HydratedTra
|
|
|
1211
2143
|
### address
|
|
1212
2144
|
|
|
1213
2145
|
```ts
|
|
1214
|
-
address:
|
|
2146
|
+
address: Brand;
|
|
1215
2147
|
```
|
|
1216
2148
|
|
|
1217
2149
|
## Methods
|
|
@@ -1245,7 +2177,7 @@ validate(): Promisable<Error[]>;
|
|
|
1245
2177
|
### address
|
|
1246
2178
|
|
|
1247
2179
|
```ts
|
|
1248
|
-
address:
|
|
2180
|
+
address: Brand;
|
|
1249
2181
|
```
|
|
1250
2182
|
|
|
1251
2183
|
### Inherited from
|
|
@@ -1274,7 +2206,7 @@ balance(): Promisable<[XL1AmountInstance, BlockWindowInstance]>;
|
|
|
1274
2206
|
|
|
1275
2207
|
### Returns
|
|
1276
2208
|
|
|
1277
|
-
`Promisable`\<\[
|
|
2209
|
+
`Promisable`\<\[`XL1AmountInstance`, [`BlockWindowInstance`](#BlockWindowInstance)\]\>
|
|
1278
2210
|
|
|
1279
2211
|
***
|
|
1280
2212
|
|
|
@@ -1319,7 +2251,7 @@ chainArchivist: ReadArchivist;
|
|
|
1319
2251
|
### head
|
|
1320
2252
|
|
|
1321
2253
|
```ts
|
|
1322
|
-
head:
|
|
2254
|
+
head: Brand;
|
|
1323
2255
|
```
|
|
1324
2256
|
|
|
1325
2257
|
### Inherited from
|
|
@@ -1343,7 +2275,9 @@ optional windowSize: number;
|
|
|
1343
2275
|
### summaryRepository
|
|
1344
2276
|
|
|
1345
2277
|
```ts
|
|
1346
|
-
summaryRepository: PayloadRepository<Lowercase<string>,
|
|
2278
|
+
summaryRepository: PayloadRepository<Brand<Brand<Lowercase<string>, {
|
|
2279
|
+
}>, {
|
|
2280
|
+
}>, BalancesStepSummary>;
|
|
1347
2281
|
```
|
|
1348
2282
|
|
|
1349
2283
|
### Inherited from
|
|
@@ -1377,7 +2311,11 @@ numberRange: [number, number];
|
|
|
1377
2311
|
### range
|
|
1378
2312
|
|
|
1379
2313
|
```ts
|
|
1380
|
-
range: [Lowercase<string>,
|
|
2314
|
+
range: [Brand<Brand<Lowercase<string>, {
|
|
2315
|
+
}>, {
|
|
2316
|
+
}>, Brand<Brand<Lowercase<string>, {
|
|
2317
|
+
}>, {
|
|
2318
|
+
}>];
|
|
1381
2319
|
```
|
|
1382
2320
|
|
|
1383
2321
|
### <a id="BlockWindowStateInstance"></a>BlockWindowStateInstance
|
|
@@ -1503,7 +2441,7 @@ chainArchivist: ReadArchivist;
|
|
|
1503
2441
|
### head
|
|
1504
2442
|
|
|
1505
2443
|
```ts
|
|
1506
|
-
head:
|
|
2444
|
+
head: Brand;
|
|
1507
2445
|
```
|
|
1508
2446
|
|
|
1509
2447
|
***
|
|
@@ -1570,7 +2508,7 @@ from a contract
|
|
|
1570
2508
|
### ~~chainIterator?~~
|
|
1571
2509
|
|
|
1572
2510
|
```ts
|
|
1573
|
-
optional chainIterator:
|
|
2511
|
+
optional chainIterator: EventingChainBlockNumberIteratorService;
|
|
1574
2512
|
```
|
|
1575
2513
|
|
|
1576
2514
|
The chain iterator
|
|
@@ -1674,10 +2612,10 @@ The account which is used to sign transactions
|
|
|
1674
2612
|
|
|
1675
2613
|
***
|
|
1676
2614
|
|
|
1677
|
-
###
|
|
2615
|
+
### balance
|
|
1678
2616
|
|
|
1679
2617
|
```ts
|
|
1680
|
-
|
|
2618
|
+
balance: AccountBalanceServiceV2;
|
|
1681
2619
|
```
|
|
1682
2620
|
|
|
1683
2621
|
Services for working with account balances
|
|
@@ -1708,7 +2646,7 @@ from a contract
|
|
|
1708
2646
|
### chainIterator?
|
|
1709
2647
|
|
|
1710
2648
|
```ts
|
|
1711
|
-
optional chainIterator:
|
|
2649
|
+
optional chainIterator: EventingChainBlockNumberIteratorService;
|
|
1712
2650
|
```
|
|
1713
2651
|
|
|
1714
2652
|
The chain iterator
|
|
@@ -1745,10 +2683,10 @@ The archivist which the chain submissions are stored in
|
|
|
1745
2683
|
|
|
1746
2684
|
***
|
|
1747
2685
|
|
|
1748
|
-
###
|
|
2686
|
+
### election
|
|
1749
2687
|
|
|
1750
2688
|
```ts
|
|
1751
|
-
|
|
2689
|
+
election: ElectionService;
|
|
1752
2690
|
```
|
|
1753
2691
|
|
|
1754
2692
|
Service for determining leader election
|
|
@@ -1766,10 +2704,10 @@ as bundled transactions
|
|
|
1766
2704
|
|
|
1767
2705
|
***
|
|
1768
2706
|
|
|
1769
|
-
###
|
|
2707
|
+
### pendingTransactions
|
|
1770
2708
|
|
|
1771
2709
|
```ts
|
|
1772
|
-
|
|
2710
|
+
pendingTransactions: PendingTransactionsService;
|
|
1773
2711
|
```
|
|
1774
2712
|
|
|
1775
2713
|
Service for managing pending transactions
|
|
@@ -1786,20 +2724,20 @@ The block producer service
|
|
|
1786
2724
|
|
|
1787
2725
|
***
|
|
1788
2726
|
|
|
1789
|
-
###
|
|
2727
|
+
### reward
|
|
1790
2728
|
|
|
1791
2729
|
```ts
|
|
1792
|
-
|
|
2730
|
+
reward: BlockRewardService;
|
|
1793
2731
|
```
|
|
1794
2732
|
|
|
1795
2733
|
Service response for calculating block rewards
|
|
1796
2734
|
|
|
1797
2735
|
***
|
|
1798
2736
|
|
|
1799
|
-
###
|
|
2737
|
+
### stakeIntent
|
|
1800
2738
|
|
|
1801
2739
|
```ts
|
|
1802
|
-
|
|
2740
|
+
stakeIntent: StakeIntentService;
|
|
1803
2741
|
```
|
|
1804
2742
|
|
|
1805
2743
|
Services for working with staked intents
|
|
@@ -1817,6 +2755,7 @@ Services for working with staked intents
|
|
|
1817
2755
|
## Extended by
|
|
1818
2756
|
|
|
1819
2757
|
- [`BalanceStepSummaryContext`](#BalanceStepSummaryContext)
|
|
2758
|
+
- [`TransfersStepSummaryContext`](#TransfersStepSummaryContext)
|
|
1820
2759
|
|
|
1821
2760
|
## Type Parameters
|
|
1822
2761
|
|
|
@@ -1841,7 +2780,7 @@ chainArchivist: ReadArchivist;
|
|
|
1841
2780
|
### head
|
|
1842
2781
|
|
|
1843
2782
|
```ts
|
|
1844
|
-
head:
|
|
2783
|
+
head: Brand;
|
|
1845
2784
|
```
|
|
1846
2785
|
|
|
1847
2786
|
### Inherited from
|
|
@@ -1865,7 +2804,9 @@ optional windowSize: number;
|
|
|
1865
2804
|
### summaryRepository
|
|
1866
2805
|
|
|
1867
2806
|
```ts
|
|
1868
|
-
summaryRepository: PayloadRepository<Lowercase<string>,
|
|
2807
|
+
summaryRepository: PayloadRepository<Brand<Brand<Lowercase<string>, {
|
|
2808
|
+
}>, {
|
|
2809
|
+
}>, T>;
|
|
1869
2810
|
```
|
|
1870
2811
|
|
|
1871
2812
|
### <a id="ChainWindow"></a>ChainWindow
|
|
@@ -1887,7 +2828,7 @@ depth: number;
|
|
|
1887
2828
|
### head
|
|
1888
2829
|
|
|
1889
2830
|
```ts
|
|
1890
|
-
head:
|
|
2831
|
+
head: Brand;
|
|
1891
2832
|
```
|
|
1892
2833
|
|
|
1893
2834
|
### <a id="DataInstance"></a>DataInstance
|
|
@@ -1968,9 +2909,7 @@ payloadCount: number;
|
|
|
1968
2909
|
|
|
1969
2910
|
### Inherited from
|
|
1970
2911
|
|
|
1971
|
-
|
|
1972
|
-
HydratedBoundWitnessInstance.payloadCount
|
|
1973
|
-
```
|
|
2912
|
+
[`HydratedTransactionInstance`](#HydratedTransactionInstance).[`payloadCount`](HydratedTransactionInstance.md#payloadcount)
|
|
1974
2913
|
|
|
1975
2914
|
***
|
|
1976
2915
|
|
|
@@ -2043,7 +2982,7 @@ BlockFieldsInstance.transactionCount
|
|
|
2043
2982
|
### transactions
|
|
2044
2983
|
|
|
2045
2984
|
```ts
|
|
2046
|
-
transactions: HydratedTransactionInstance<
|
|
2985
|
+
transactions: HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[];
|
|
2047
2986
|
```
|
|
2048
2987
|
|
|
2049
2988
|
### Inherited from
|
|
@@ -2105,7 +3044,7 @@ signature(index): undefined | SignatureInstance;
|
|
|
2105
3044
|
```ts
|
|
2106
3045
|
transaction(index):
|
|
2107
3046
|
| undefined
|
|
2108
|
-
| HydratedTransactionInstance<
|
|
3047
|
+
| HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>;
|
|
2109
3048
|
```
|
|
2110
3049
|
|
|
2111
3050
|
### Parameters
|
|
@@ -2117,7 +3056,7 @@ transaction(index):
|
|
|
2117
3056
|
### Returns
|
|
2118
3057
|
|
|
2119
3058
|
\| `undefined`
|
|
2120
|
-
\| [`HydratedTransactionInstance`](#HydratedTransactionInstance)\<`
|
|
3059
|
+
\| [`HydratedTransactionInstance`](#HydratedTransactionInstance)\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>
|
|
2121
3060
|
|
|
2122
3061
|
### Inherited from
|
|
2123
3062
|
|
|
@@ -2157,7 +3096,7 @@ HydratedBoundWitnessInstance.validate
|
|
|
2157
3096
|
|
|
2158
3097
|
### T
|
|
2159
3098
|
|
|
2160
|
-
`T` *extends* `
|
|
3099
|
+
`T` *extends* `HydratedTransactionWithStorageMeta` = `HydratedTransactionWithStorageMeta`
|
|
2161
3100
|
|
|
2162
3101
|
### TElevatedPayload
|
|
2163
3102
|
|
|
@@ -2444,7 +3383,7 @@ TransactionFieldsInstance.reward
|
|
|
2444
3383
|
### negative
|
|
2445
3384
|
|
|
2446
3385
|
```ts
|
|
2447
|
-
negative:
|
|
3386
|
+
negative: Brand;
|
|
2448
3387
|
```
|
|
2449
3388
|
|
|
2450
3389
|
### <a id="ObjectInstance"></a>ObjectInstance
|
|
@@ -2538,7 +3477,7 @@ validate(): Promisable<Error[]>;
|
|
|
2538
3477
|
### positive
|
|
2539
3478
|
|
|
2540
3479
|
```ts
|
|
2541
|
-
positive:
|
|
3480
|
+
positive: Brand;
|
|
2542
3481
|
```
|
|
2543
3482
|
|
|
2544
3483
|
### <a id="ShiftedBigIntConfig"></a>ShiftedBigIntConfig
|
|
@@ -2547,9 +3486,13 @@ positive: Lowercase<string>;
|
|
|
2547
3486
|
|
|
2548
3487
|
***
|
|
2549
3488
|
|
|
3489
|
+
## Deprecated
|
|
3490
|
+
|
|
3491
|
+
use from @xyo-network/xl1-protocol instead
|
|
3492
|
+
|
|
2550
3493
|
## Properties
|
|
2551
3494
|
|
|
2552
|
-
### locale
|
|
3495
|
+
### ~~locale~~
|
|
2553
3496
|
|
|
2554
3497
|
```ts
|
|
2555
3498
|
locale: LocalesArgument;
|
|
@@ -2557,7 +3500,7 @@ locale: LocalesArgument;
|
|
|
2557
3500
|
|
|
2558
3501
|
***
|
|
2559
3502
|
|
|
2560
|
-
### maxCharacters
|
|
3503
|
+
### ~~maxCharacters~~
|
|
2561
3504
|
|
|
2562
3505
|
```ts
|
|
2563
3506
|
maxCharacters: number;
|
|
@@ -2565,7 +3508,7 @@ maxCharacters: number;
|
|
|
2565
3508
|
|
|
2566
3509
|
***
|
|
2567
3510
|
|
|
2568
|
-
### maxDecimal
|
|
3511
|
+
### ~~maxDecimal~~
|
|
2569
3512
|
|
|
2570
3513
|
```ts
|
|
2571
3514
|
maxDecimal: number;
|
|
@@ -2573,7 +3516,7 @@ maxDecimal: number;
|
|
|
2573
3516
|
|
|
2574
3517
|
***
|
|
2575
3518
|
|
|
2576
|
-
### minDecimals
|
|
3519
|
+
### ~~minDecimals~~
|
|
2577
3520
|
|
|
2578
3521
|
```ts
|
|
2579
3522
|
minDecimals: number;
|
|
@@ -2581,7 +3524,7 @@ minDecimals: number;
|
|
|
2581
3524
|
|
|
2582
3525
|
***
|
|
2583
3526
|
|
|
2584
|
-
### places
|
|
3527
|
+
### ~~places~~
|
|
2585
3528
|
|
|
2586
3529
|
```ts
|
|
2587
3530
|
places: number;
|
|
@@ -2602,7 +3545,7 @@ places: number;
|
|
|
2602
3545
|
### address
|
|
2603
3546
|
|
|
2604
3547
|
```ts
|
|
2605
|
-
address:
|
|
3548
|
+
address: Brand;
|
|
2606
3549
|
```
|
|
2607
3550
|
|
|
2608
3551
|
***
|
|
@@ -2610,7 +3553,7 @@ address: Lowercase<string>;
|
|
|
2610
3553
|
### hash
|
|
2611
3554
|
|
|
2612
3555
|
```ts
|
|
2613
|
-
hash:
|
|
3556
|
+
hash: Brand;
|
|
2614
3557
|
```
|
|
2615
3558
|
|
|
2616
3559
|
***
|
|
@@ -2618,7 +3561,7 @@ hash: Lowercase<string>;
|
|
|
2618
3561
|
### signature
|
|
2619
3562
|
|
|
2620
3563
|
```ts
|
|
2621
|
-
signature:
|
|
3564
|
+
signature: Brand;
|
|
2622
3565
|
```
|
|
2623
3566
|
|
|
2624
3567
|
## Methods
|
|
@@ -2693,7 +3636,7 @@ signature(index): undefined | SignatureInstance;
|
|
|
2693
3636
|
### hash
|
|
2694
3637
|
|
|
2695
3638
|
```ts
|
|
2696
|
-
hash:
|
|
3639
|
+
hash: Brand;
|
|
2697
3640
|
```
|
|
2698
3641
|
|
|
2699
3642
|
***
|
|
@@ -2724,43 +3667,111 @@ base: bigint;
|
|
|
2724
3667
|
|
|
2725
3668
|
***
|
|
2726
3669
|
|
|
2727
|
-
### gasLimit
|
|
3670
|
+
### gasLimit
|
|
3671
|
+
|
|
3672
|
+
```ts
|
|
3673
|
+
gasLimit: bigint;
|
|
3674
|
+
```
|
|
3675
|
+
|
|
3676
|
+
***
|
|
3677
|
+
|
|
3678
|
+
### gasPrice
|
|
3679
|
+
|
|
3680
|
+
```ts
|
|
3681
|
+
gasPrice: bigint;
|
|
3682
|
+
```
|
|
3683
|
+
|
|
3684
|
+
***
|
|
3685
|
+
|
|
3686
|
+
### priority
|
|
3687
|
+
|
|
3688
|
+
```ts
|
|
3689
|
+
priority: bigint;
|
|
3690
|
+
```
|
|
3691
|
+
|
|
3692
|
+
## Methods
|
|
3693
|
+
|
|
3694
|
+
### validate()
|
|
3695
|
+
|
|
3696
|
+
```ts
|
|
3697
|
+
validate(): Promisable<Error[]>;
|
|
3698
|
+
```
|
|
3699
|
+
|
|
3700
|
+
### Returns
|
|
3701
|
+
|
|
3702
|
+
`Promisable`\<`Error`[]\>
|
|
3703
|
+
|
|
3704
|
+
### Inherited from
|
|
3705
|
+
|
|
3706
|
+
[`ValidatableInstance`](#ValidatableInstance).[`validate`](ValidatableInstance.md#validate)
|
|
3707
|
+
|
|
3708
|
+
### <a id="TransfersStepSummaryContext"></a>TransfersStepSummaryContext
|
|
3709
|
+
|
|
3710
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
3711
|
+
|
|
3712
|
+
***
|
|
3713
|
+
|
|
3714
|
+
## Extends
|
|
3715
|
+
|
|
3716
|
+
- [`ChainSummaryContext`](#ChainSummaryContext)\<[`TransfersStepSummary`](#../type-aliases/TransfersStepSummary)\>
|
|
3717
|
+
|
|
3718
|
+
## Properties
|
|
3719
|
+
|
|
3720
|
+
### chainArchivist
|
|
3721
|
+
|
|
3722
|
+
```ts
|
|
3723
|
+
chainArchivist: ReadArchivist;
|
|
3724
|
+
```
|
|
3725
|
+
|
|
3726
|
+
### Inherited from
|
|
3727
|
+
|
|
3728
|
+
[`ChainSummaryContext`](#ChainSummaryContext).[`chainArchivist`](ChainSummaryContext.md#chainarchivist)
|
|
3729
|
+
|
|
3730
|
+
***
|
|
3731
|
+
|
|
3732
|
+
### head
|
|
2728
3733
|
|
|
2729
3734
|
```ts
|
|
2730
|
-
|
|
3735
|
+
head: Brand;
|
|
2731
3736
|
```
|
|
2732
3737
|
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
### gasPrice
|
|
3738
|
+
### Inherited from
|
|
2736
3739
|
|
|
2737
|
-
|
|
2738
|
-
gasPrice: bigint;
|
|
2739
|
-
```
|
|
3740
|
+
[`ChainSummaryContext`](#ChainSummaryContext).[`head`](ChainSummaryContext.md#head)
|
|
2740
3741
|
|
|
2741
3742
|
***
|
|
2742
3743
|
|
|
2743
|
-
###
|
|
3744
|
+
### windowSize?
|
|
2744
3745
|
|
|
2745
3746
|
```ts
|
|
2746
|
-
|
|
3747
|
+
optional windowSize: number;
|
|
2747
3748
|
```
|
|
2748
3749
|
|
|
2749
|
-
|
|
3750
|
+
### Inherited from
|
|
2750
3751
|
|
|
2751
|
-
|
|
3752
|
+
[`ChainSummaryContext`](#ChainSummaryContext).[`windowSize`](ChainSummaryContext.md#windowsize)
|
|
3753
|
+
|
|
3754
|
+
***
|
|
3755
|
+
|
|
3756
|
+
### summaryRepository
|
|
2752
3757
|
|
|
2753
3758
|
```ts
|
|
2754
|
-
|
|
3759
|
+
summaryRepository: PayloadRepository<Brand<Brand<Lowercase<string>, {
|
|
3760
|
+
}>, {
|
|
3761
|
+
}>, TransfersStepSummary>;
|
|
2755
3762
|
```
|
|
2756
3763
|
|
|
2757
|
-
###
|
|
3764
|
+
### Inherited from
|
|
2758
3765
|
|
|
2759
|
-
`
|
|
3766
|
+
[`ChainSummaryContext`](#ChainSummaryContext).[`summaryRepository`](ChainSummaryContext.md#summaryrepository)
|
|
2760
3767
|
|
|
2761
|
-
|
|
3768
|
+
***
|
|
2762
3769
|
|
|
2763
|
-
|
|
3770
|
+
### account
|
|
3771
|
+
|
|
3772
|
+
```ts
|
|
3773
|
+
account: Brand;
|
|
3774
|
+
```
|
|
2764
3775
|
|
|
2765
3776
|
### <a id="ValidatableInstance"></a>ValidatableInstance
|
|
2766
3777
|
|
|
@@ -2793,9 +3804,13 @@ validate(): Promisable<Error[]>;
|
|
|
2793
3804
|
|
|
2794
3805
|
***
|
|
2795
3806
|
|
|
3807
|
+
## Deprecated
|
|
3808
|
+
|
|
3809
|
+
use from @xyo-network/xl1-protocol instead
|
|
3810
|
+
|
|
2796
3811
|
## Properties
|
|
2797
3812
|
|
|
2798
|
-
### value
|
|
3813
|
+
### ~~value~~
|
|
2799
3814
|
|
|
2800
3815
|
```ts
|
|
2801
3816
|
value: AttoXL1;
|
|
@@ -2803,7 +3818,7 @@ value: AttoXL1;
|
|
|
2803
3818
|
|
|
2804
3819
|
***
|
|
2805
3820
|
|
|
2806
|
-
### milli
|
|
3821
|
+
### ~~milli~~
|
|
2807
3822
|
|
|
2808
3823
|
```ts
|
|
2809
3824
|
milli: MilliXL1;
|
|
@@ -2811,7 +3826,7 @@ milli: MilliXL1;
|
|
|
2811
3826
|
|
|
2812
3827
|
***
|
|
2813
3828
|
|
|
2814
|
-
### micro
|
|
3829
|
+
### ~~micro~~
|
|
2815
3830
|
|
|
2816
3831
|
```ts
|
|
2817
3832
|
micro: MicroXL1;
|
|
@@ -2819,7 +3834,7 @@ micro: MicroXL1;
|
|
|
2819
3834
|
|
|
2820
3835
|
***
|
|
2821
3836
|
|
|
2822
|
-
### nano
|
|
3837
|
+
### ~~nano~~
|
|
2823
3838
|
|
|
2824
3839
|
```ts
|
|
2825
3840
|
nano: NanoXL1;
|
|
@@ -2827,7 +3842,7 @@ nano: NanoXL1;
|
|
|
2827
3842
|
|
|
2828
3843
|
***
|
|
2829
3844
|
|
|
2830
|
-
### pico
|
|
3845
|
+
### ~~pico~~
|
|
2831
3846
|
|
|
2832
3847
|
```ts
|
|
2833
3848
|
pico: PicoXL1;
|
|
@@ -2835,7 +3850,7 @@ pico: PicoXL1;
|
|
|
2835
3850
|
|
|
2836
3851
|
***
|
|
2837
3852
|
|
|
2838
|
-
### femto
|
|
3853
|
+
### ~~femto~~
|
|
2839
3854
|
|
|
2840
3855
|
```ts
|
|
2841
3856
|
femto: FemtoXL1;
|
|
@@ -2843,7 +3858,7 @@ femto: FemtoXL1;
|
|
|
2843
3858
|
|
|
2844
3859
|
***
|
|
2845
3860
|
|
|
2846
|
-
### atto
|
|
3861
|
+
### ~~atto~~
|
|
2847
3862
|
|
|
2848
3863
|
```ts
|
|
2849
3864
|
atto: AttoXL1;
|
|
@@ -2851,7 +3866,7 @@ atto: AttoXL1;
|
|
|
2851
3866
|
|
|
2852
3867
|
## Methods
|
|
2853
3868
|
|
|
2854
|
-
### to()
|
|
3869
|
+
### ~~to()~~
|
|
2855
3870
|
|
|
2856
3871
|
```ts
|
|
2857
3872
|
to(places): bigint;
|
|
@@ -2869,7 +3884,7 @@ to(places): bigint;
|
|
|
2869
3884
|
|
|
2870
3885
|
***
|
|
2871
3886
|
|
|
2872
|
-
### toString()
|
|
3887
|
+
### ~~toString()~~
|
|
2873
3888
|
|
|
2874
3889
|
```ts
|
|
2875
3890
|
toString(places, config): string;
|
|
@@ -2930,9 +3945,51 @@ type BlockNumberRange = [number, number];
|
|
|
2930
3945
|
***
|
|
2931
3946
|
|
|
2932
3947
|
```ts
|
|
2933
|
-
type Config = z.infer<typeof
|
|
3948
|
+
type Config = z.infer<typeof ConfigZod>;
|
|
3949
|
+
```
|
|
3950
|
+
|
|
3951
|
+
### <a id="ConfirmSubmittedTransactionOptions"></a>ConfirmSubmittedTransactionOptions
|
|
3952
|
+
|
|
3953
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
3954
|
+
|
|
3955
|
+
***
|
|
3956
|
+
|
|
3957
|
+
```ts
|
|
3958
|
+
type ConfirmSubmittedTransactionOptions = object;
|
|
3959
|
+
```
|
|
3960
|
+
|
|
3961
|
+
## Properties
|
|
3962
|
+
|
|
3963
|
+
### attempts?
|
|
3964
|
+
|
|
3965
|
+
```ts
|
|
3966
|
+
optional attempts: number;
|
|
3967
|
+
```
|
|
3968
|
+
|
|
3969
|
+
Number of attempts to confirm the transaction.
|
|
3970
|
+
Defaults to 20.
|
|
3971
|
+
|
|
3972
|
+
***
|
|
3973
|
+
|
|
3974
|
+
### delay?
|
|
3975
|
+
|
|
3976
|
+
```ts
|
|
3977
|
+
optional delay: number;
|
|
3978
|
+
```
|
|
3979
|
+
|
|
3980
|
+
Delay in milliseconds between confirmation attempts.
|
|
3981
|
+
Defaults to 1000 (1 second).
|
|
3982
|
+
|
|
3983
|
+
***
|
|
3984
|
+
|
|
3985
|
+
### logger?
|
|
3986
|
+
|
|
3987
|
+
```ts
|
|
3988
|
+
optional logger: Logger;
|
|
2934
3989
|
```
|
|
2935
3990
|
|
|
3991
|
+
Optional logger instance for logging progress.
|
|
3992
|
+
|
|
2936
3993
|
### <a id="MnemonicString"></a>MnemonicString
|
|
2937
3994
|
|
|
2938
3995
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -2940,7 +3997,7 @@ type Config = z.infer<typeof ConfigSchema>;
|
|
|
2940
3997
|
***
|
|
2941
3998
|
|
|
2942
3999
|
```ts
|
|
2943
|
-
type MnemonicString = z.infer<typeof
|
|
4000
|
+
type MnemonicString = z.infer<typeof MnemonicStringZod>;
|
|
2944
4001
|
```
|
|
2945
4002
|
|
|
2946
4003
|
### <a id="SignedBigInt"></a>SignedBigInt
|
|
@@ -2983,10 +4040,91 @@ type StepSummary<TAdditionalFields, TSchema> = Payload<TAdditionalFields extends
|
|
|
2983
4040
|
|
|
2984
4041
|
```ts
|
|
2985
4042
|
type StepSummarySchema = typeof StepSummarySchema;
|
|
4043
|
+
```
|
|
4044
|
+
|
|
4045
|
+
### <a id="TransfersStepSummary"></a>TransfersStepSummary
|
|
4046
|
+
|
|
4047
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4048
|
+
|
|
4049
|
+
***
|
|
4050
|
+
|
|
4051
|
+
```ts
|
|
4052
|
+
type TransfersStepSummary = StepSummary<{
|
|
4053
|
+
account: Address;
|
|
4054
|
+
transfers: Record<Address, SignedBigInt>;
|
|
4055
|
+
}, TransfersStepSummarySchema>;
|
|
4056
|
+
```
|
|
4057
|
+
|
|
4058
|
+
### <a id="TransfersStepSummarySchema"></a>TransfersStepSummarySchema
|
|
4059
|
+
|
|
4060
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4061
|
+
|
|
4062
|
+
***
|
|
4063
|
+
|
|
4064
|
+
```ts
|
|
4065
|
+
type TransfersStepSummarySchema = typeof TransfersStepSummarySchema;
|
|
4066
|
+
```
|
|
4067
|
+
|
|
4068
|
+
### <a id="UsageMeta"></a>UsageMeta
|
|
4069
|
+
|
|
4070
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4071
|
+
|
|
4072
|
+
***
|
|
4073
|
+
|
|
4074
|
+
```ts
|
|
4075
|
+
type UsageMeta = z.infer<typeof UsageMetaSchema>;
|
|
2986
4076
|
```
|
|
2987
4077
|
|
|
2988
4078
|
### variables
|
|
2989
4079
|
|
|
4080
|
+
### <a id="ACCOUNT_TYPE"></a>ACCOUNT_TYPE
|
|
4081
|
+
|
|
4082
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4083
|
+
|
|
4084
|
+
***
|
|
4085
|
+
|
|
4086
|
+
```ts
|
|
4087
|
+
const ACCOUNT_TYPE: object;
|
|
4088
|
+
```
|
|
4089
|
+
|
|
4090
|
+
## Type Declaration
|
|
4091
|
+
|
|
4092
|
+
### GANACHE
|
|
4093
|
+
|
|
4094
|
+
```ts
|
|
4095
|
+
readonly GANACHE: "0'" = '0\'';
|
|
4096
|
+
```
|
|
4097
|
+
|
|
4098
|
+
### XYO
|
|
4099
|
+
|
|
4100
|
+
```ts
|
|
4101
|
+
readonly XYO: "0'" = '0\'';
|
|
4102
|
+
```
|
|
4103
|
+
|
|
4104
|
+
### <a id="ADDRESS_INDEX"></a>ADDRESS_INDEX
|
|
4105
|
+
|
|
4106
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4107
|
+
|
|
4108
|
+
***
|
|
4109
|
+
|
|
4110
|
+
```ts
|
|
4111
|
+
const ADDRESS_INDEX: object;
|
|
4112
|
+
```
|
|
4113
|
+
|
|
4114
|
+
## Type Declaration
|
|
4115
|
+
|
|
4116
|
+
### META\_MASK
|
|
4117
|
+
|
|
4118
|
+
```ts
|
|
4119
|
+
readonly META_MASK: "0" = '0';
|
|
4120
|
+
```
|
|
4121
|
+
|
|
4122
|
+
### XYO
|
|
4123
|
+
|
|
4124
|
+
```ts
|
|
4125
|
+
readonly XYO: "0" = '0';
|
|
4126
|
+
```
|
|
4127
|
+
|
|
2990
4128
|
### <a id="BalancesStepSummarySchema"></a>BalancesStepSummarySchema
|
|
2991
4129
|
|
|
2992
4130
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
@@ -2997,103 +4135,88 @@ type StepSummarySchema = typeof StepSummarySchema;
|
|
|
2997
4135
|
const BalancesStepSummarySchema: Schema = 'network.xyo.step.summary.balances';
|
|
2998
4136
|
```
|
|
2999
4137
|
|
|
3000
|
-
### <a id="
|
|
4138
|
+
### <a id="CHANGE_ADDRESS"></a>CHANGE_ADDRESS
|
|
3001
4139
|
|
|
3002
4140
|
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
3003
4141
|
|
|
3004
4142
|
***
|
|
3005
4143
|
|
|
3006
4144
|
```ts
|
|
3007
|
-
const
|
|
3008
|
-
|
|
3009
|
-
|
|
4145
|
+
const CHANGE_ADDRESS: object;
|
|
4146
|
+
```
|
|
4147
|
+
|
|
4148
|
+
## Type Declaration
|
|
4149
|
+
|
|
4150
|
+
### META\_MASK
|
|
4151
|
+
|
|
4152
|
+
```ts
|
|
4153
|
+
readonly META_MASK: "0" = '0';
|
|
4154
|
+
```
|
|
4155
|
+
|
|
4156
|
+
### XYO
|
|
4157
|
+
|
|
4158
|
+
```ts
|
|
4159
|
+
readonly XYO: "0" = '0';
|
|
4160
|
+
```
|
|
4161
|
+
|
|
4162
|
+
### <a id="COIN_TYPES"></a>COIN_TYPES
|
|
4163
|
+
|
|
4164
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4165
|
+
|
|
4166
|
+
***
|
|
4167
|
+
|
|
4168
|
+
```ts
|
|
4169
|
+
const COIN_TYPES: object;
|
|
4170
|
+
```
|
|
4171
|
+
|
|
4172
|
+
## Type Declaration
|
|
4173
|
+
|
|
4174
|
+
### Ethereum
|
|
4175
|
+
|
|
4176
|
+
```ts
|
|
4177
|
+
readonly Ethereum: "60'" = '60\'';
|
|
4178
|
+
```
|
|
4179
|
+
|
|
4180
|
+
### <a id="ConfigZod"></a>ConfigZod
|
|
4181
|
+
|
|
4182
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4183
|
+
|
|
4184
|
+
***
|
|
4185
|
+
|
|
4186
|
+
```ts
|
|
4187
|
+
const ConfigZod: ZodObject<{
|
|
3010
4188
|
api: ZodDefault<ZodObject<{
|
|
3011
|
-
mnemonic: ZodOptional<ZodEffects<ZodEffects<ZodString, string, string>, string, string>>;
|
|
3012
4189
|
host: ZodDefault<ZodString>;
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
host: string;
|
|
3017
|
-
port: number;
|
|
3018
|
-
}, {
|
|
3019
|
-
mnemonic?: string;
|
|
3020
|
-
host?: string;
|
|
3021
|
-
port?: number;
|
|
3022
|
-
}>>;
|
|
4190
|
+
mnemonic: ZodOptional<ZodPipe<ZodString, ZodTransform<string, string>>>;
|
|
4191
|
+
port: ZodDefault<ZodCoercedNumber<unknown>>;
|
|
4192
|
+
}, $strip>>;
|
|
3023
4193
|
app: ZodDefault<ZodObject<{
|
|
3024
|
-
port: ZodDefault<
|
|
3025
|
-
|
|
3026
|
-
port: number;
|
|
3027
|
-
}, {
|
|
3028
|
-
port?: number;
|
|
3029
|
-
}>>;
|
|
4194
|
+
port: ZodDefault<ZodCoercedNumber<unknown>>;
|
|
4195
|
+
}, $strip>>;
|
|
3030
4196
|
chain: ZodDefault<ZodObject<{
|
|
3031
4197
|
id: ZodOptional<ZodString>;
|
|
3032
|
-
|
|
3033
|
-
id?: string;
|
|
3034
|
-
}, {
|
|
3035
|
-
id?: string;
|
|
3036
|
-
}>>;
|
|
4198
|
+
}, $strip>>;
|
|
3037
4199
|
evm: ZodDefault<ZodObject<{
|
|
3038
4200
|
chainId: ZodOptional<ZodString>;
|
|
3039
4201
|
infura: ZodOptional<ZodObject<{
|
|
3040
4202
|
projectId: ZodOptional<ZodString>;
|
|
3041
4203
|
projectSecret: ZodOptional<ZodString>;
|
|
3042
|
-
|
|
3043
|
-
projectId?: string;
|
|
3044
|
-
projectSecret?: string;
|
|
3045
|
-
}, {
|
|
3046
|
-
projectId?: string;
|
|
3047
|
-
projectSecret?: string;
|
|
3048
|
-
}>>;
|
|
4204
|
+
}, $strip>>;
|
|
3049
4205
|
jsonRpc: ZodOptional<ZodObject<{
|
|
3050
|
-
url: ZodOptional<
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
}, {
|
|
3054
|
-
url?: string;
|
|
3055
|
-
}>>;
|
|
3056
|
-
}, "strip", ZodTypeAny, {
|
|
3057
|
-
chainId?: string;
|
|
3058
|
-
infura?: {
|
|
3059
|
-
projectId?: string;
|
|
3060
|
-
projectSecret?: string;
|
|
3061
|
-
};
|
|
3062
|
-
jsonRpc?: {
|
|
3063
|
-
url?: string;
|
|
3064
|
-
};
|
|
3065
|
-
}, {
|
|
3066
|
-
chainId?: string;
|
|
3067
|
-
infura?: {
|
|
3068
|
-
projectId?: string;
|
|
3069
|
-
projectSecret?: string;
|
|
3070
|
-
};
|
|
3071
|
-
jsonRpc?: {
|
|
3072
|
-
url?: string;
|
|
3073
|
-
};
|
|
3074
|
-
}>>;
|
|
4206
|
+
url: ZodOptional<ZodURL>;
|
|
4207
|
+
}, $strip>>;
|
|
4208
|
+
}, $strip>>;
|
|
3075
4209
|
producer: ZodDefault<ZodObject<{
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
mnemonic: ZodOptional<ZodEffects<ZodEffects<ZodString, string, string>, string, string>>;
|
|
3079
|
-
port: ZodDefault<ZodNumber>;
|
|
4210
|
+
allowlist: ZodPipe<ZodTransform<unknown, unknown>, ZodOptional<ZodArray<ZodType<Brand<Brand<..., ...>, {
|
|
4211
|
+
}>, unknown, $ZodTypeInternals<Brand<..., ...>, unknown>>>>>;
|
|
3080
4212
|
disableIntentRedeclaration: ZodOptional<ZodBoolean>;
|
|
4213
|
+
healthCheckPort: ZodOptional<ZodCoercedNumber<unknown>>;
|
|
4214
|
+
heartbeatInterval: ZodDefault<ZodCoercedNumber<unknown>>;
|
|
4215
|
+
minStake: ZodDefault<ZodCoercedNumber<unknown>>;
|
|
4216
|
+
mnemonic: ZodOptional<ZodPipe<ZodString, ZodTransform<string, string>>>;
|
|
4217
|
+
port: ZodDefault<ZodCoercedNumber<unknown>>;
|
|
3081
4218
|
rewardAddress: ZodOptional<ZodString>;
|
|
3082
|
-
|
|
3083
|
-
healthCheckPort?: number;
|
|
3084
|
-
minStake: number;
|
|
3085
|
-
mnemonic?: string;
|
|
3086
|
-
port: number;
|
|
3087
|
-
disableIntentRedeclaration?: boolean;
|
|
3088
|
-
rewardAddress?: string;
|
|
3089
|
-
}, {
|
|
3090
|
-
healthCheckPort?: number;
|
|
3091
|
-
minStake?: number;
|
|
3092
|
-
mnemonic?: string;
|
|
3093
|
-
port?: number;
|
|
3094
|
-
disableIntentRedeclaration?: boolean;
|
|
3095
|
-
rewardAddress?: string;
|
|
3096
|
-
}>>;
|
|
4219
|
+
}, $strip>>;
|
|
3097
4220
|
storage: ZodDefault<ZodObject<{
|
|
3098
4221
|
mongo: ZodOptional<ZodObject<{
|
|
3099
4222
|
connectionString: ZodOptional<ZodString>;
|
|
@@ -3101,161 +4224,74 @@ const ConfigSchema: ZodObject<{
|
|
|
3101
4224
|
domain: ZodOptional<ZodString>;
|
|
3102
4225
|
password: ZodOptional<ZodString>;
|
|
3103
4226
|
username: ZodOptional<ZodString>;
|
|
3104
|
-
|
|
3105
|
-
connectionString?: string;
|
|
3106
|
-
database?: string;
|
|
3107
|
-
domain?: string;
|
|
3108
|
-
password?: string;
|
|
3109
|
-
username?: string;
|
|
3110
|
-
}, {
|
|
3111
|
-
connectionString?: string;
|
|
3112
|
-
database?: string;
|
|
3113
|
-
domain?: string;
|
|
3114
|
-
password?: string;
|
|
3115
|
-
username?: string;
|
|
3116
|
-
}>>;
|
|
4227
|
+
}, $strip>>;
|
|
3117
4228
|
root: ZodOptional<ZodString>;
|
|
3118
|
-
|
|
3119
|
-
mongo?: {
|
|
3120
|
-
connectionString?: string;
|
|
3121
|
-
database?: string;
|
|
3122
|
-
domain?: string;
|
|
3123
|
-
password?: string;
|
|
3124
|
-
username?: string;
|
|
3125
|
-
};
|
|
3126
|
-
root?: string;
|
|
3127
|
-
}, {
|
|
3128
|
-
mongo?: {
|
|
3129
|
-
connectionString?: string;
|
|
3130
|
-
database?: string;
|
|
3131
|
-
domain?: string;
|
|
3132
|
-
password?: string;
|
|
3133
|
-
username?: string;
|
|
3134
|
-
};
|
|
3135
|
-
root?: string;
|
|
3136
|
-
}>>;
|
|
4229
|
+
}, $strip>>;
|
|
3137
4230
|
telemetry: ZodDefault<ZodObject<{
|
|
3138
4231
|
otel: ZodOptional<ZodObject<{
|
|
3139
|
-
otlpEndpoint: ZodOptional<
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
}, {
|
|
3150
|
-
otel?: {
|
|
3151
|
-
otlpEndpoint?: string;
|
|
3152
|
-
};
|
|
4232
|
+
otlpEndpoint: ZodOptional<ZodURL>;
|
|
4233
|
+
}, $strip>>;
|
|
4234
|
+
}, $strip>>;
|
|
4235
|
+
logLevel: ZodDefault<ZodEnum<{
|
|
4236
|
+
error: "error";
|
|
4237
|
+
warn: "warn";
|
|
4238
|
+
info: "info";
|
|
4239
|
+
log: "log";
|
|
4240
|
+
debug: "debug";
|
|
4241
|
+
trace: "trace";
|
|
3153
4242
|
}>>;
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
host?: string;
|
|
3207
|
-
port?: number;
|
|
3208
|
-
};
|
|
3209
|
-
app?: {
|
|
3210
|
-
port?: number;
|
|
3211
|
-
};
|
|
3212
|
-
chain?: {
|
|
3213
|
-
id?: string;
|
|
3214
|
-
};
|
|
3215
|
-
evm?: {
|
|
3216
|
-
chainId?: string;
|
|
3217
|
-
infura?: {
|
|
3218
|
-
projectId?: string;
|
|
3219
|
-
projectSecret?: string;
|
|
3220
|
-
};
|
|
3221
|
-
jsonRpc?: {
|
|
3222
|
-
url?: string;
|
|
3223
|
-
};
|
|
3224
|
-
};
|
|
3225
|
-
producer?: {
|
|
3226
|
-
healthCheckPort?: number;
|
|
3227
|
-
minStake?: number;
|
|
3228
|
-
mnemonic?: string;
|
|
3229
|
-
port?: number;
|
|
3230
|
-
disableIntentRedeclaration?: boolean;
|
|
3231
|
-
rewardAddress?: string;
|
|
3232
|
-
};
|
|
3233
|
-
storage?: {
|
|
3234
|
-
mongo?: {
|
|
3235
|
-
connectionString?: string;
|
|
3236
|
-
database?: string;
|
|
3237
|
-
domain?: string;
|
|
3238
|
-
password?: string;
|
|
3239
|
-
username?: string;
|
|
3240
|
-
};
|
|
3241
|
-
root?: string;
|
|
3242
|
-
};
|
|
3243
|
-
telemetry?: {
|
|
3244
|
-
otel?: {
|
|
3245
|
-
otlpEndpoint?: string;
|
|
3246
|
-
};
|
|
3247
|
-
};
|
|
3248
|
-
}>;
|
|
3249
|
-
```
|
|
3250
|
-
|
|
3251
|
-
### <a id="MnemonicStringSchema"></a>MnemonicStringSchema
|
|
3252
|
-
|
|
3253
|
-
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
3254
|
-
|
|
3255
|
-
***
|
|
3256
|
-
|
|
3257
|
-
```ts
|
|
3258
|
-
const MnemonicStringSchema: ZodEffects<ZodEffects<ZodString, string, string>, string, string>;
|
|
4243
|
+
silent: ZodDefault<ZodBoolean>;
|
|
4244
|
+
}, $strip>;
|
|
4245
|
+
```
|
|
4246
|
+
|
|
4247
|
+
### <a id="DEFAULT_WALLET_PATH"></a>DEFAULT_WALLET_PATH
|
|
4248
|
+
|
|
4249
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4250
|
+
|
|
4251
|
+
***
|
|
4252
|
+
|
|
4253
|
+
```ts
|
|
4254
|
+
const DEFAULT_WALLET_PATH: string;
|
|
4255
|
+
```
|
|
4256
|
+
|
|
4257
|
+
### <a id="GlobalMetaSchema"></a>GlobalMetaSchema
|
|
4258
|
+
|
|
4259
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4260
|
+
|
|
4261
|
+
***
|
|
4262
|
+
|
|
4263
|
+
```ts
|
|
4264
|
+
const GlobalMetaSchema: ZodObject<{
|
|
4265
|
+
id: ZodOptional<ZodString>;
|
|
4266
|
+
title: ZodOptional<ZodString>;
|
|
4267
|
+
description: ZodOptional<ZodString>;
|
|
4268
|
+
deprecated: ZodOptional<ZodBoolean>;
|
|
4269
|
+
}, $catchall<ZodUnknown>>;
|
|
4270
|
+
```
|
|
4271
|
+
|
|
4272
|
+
### <a id="JSONSchemaMetaSchema"></a>JSONSchemaMetaSchema
|
|
4273
|
+
|
|
4274
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4275
|
+
|
|
4276
|
+
***
|
|
4277
|
+
|
|
4278
|
+
```ts
|
|
4279
|
+
const JSONSchemaMetaSchema: ZodObject<{
|
|
4280
|
+
id: ZodOptional<ZodString>;
|
|
4281
|
+
title: ZodOptional<ZodString>;
|
|
4282
|
+
description: ZodOptional<ZodString>;
|
|
4283
|
+
deprecated: ZodOptional<ZodBoolean>;
|
|
4284
|
+
}, $catchall<ZodUnknown>>;
|
|
4285
|
+
```
|
|
4286
|
+
|
|
4287
|
+
### <a id="MnemonicStringZod"></a>MnemonicStringZod
|
|
4288
|
+
|
|
4289
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4290
|
+
|
|
4291
|
+
***
|
|
4292
|
+
|
|
4293
|
+
```ts
|
|
4294
|
+
const MnemonicStringZod: ZodPipe<ZodString, ZodTransform<string, string>>;
|
|
3259
4295
|
```
|
|
3260
4296
|
|
|
3261
4297
|
Validates a single string containing a BIP-39 mnemonic.
|
|
@@ -3283,6 +4319,46 @@ const StepSummarySchema: Schema = 'network.xyo.step.summary';
|
|
|
3283
4319
|
|
|
3284
4320
|
```ts
|
|
3285
4321
|
const TODO: true = true;
|
|
4322
|
+
```
|
|
4323
|
+
|
|
4324
|
+
### <a id="TransfersStepSummarySchema"></a>TransfersStepSummarySchema
|
|
4325
|
+
|
|
4326
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4327
|
+
|
|
4328
|
+
***
|
|
4329
|
+
|
|
4330
|
+
```ts
|
|
4331
|
+
const TransfersStepSummarySchema: Schema = 'network.xyo.step.summary.transfer';
|
|
4332
|
+
```
|
|
4333
|
+
|
|
4334
|
+
### <a id="UsageMetaSchema"></a>UsageMetaSchema
|
|
4335
|
+
|
|
4336
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4337
|
+
|
|
4338
|
+
***
|
|
4339
|
+
|
|
4340
|
+
```ts
|
|
4341
|
+
const UsageMetaSchema: ZodObject<{
|
|
4342
|
+
id: ZodOptional<ZodString>;
|
|
4343
|
+
deprecated: ZodOptional<ZodBoolean>;
|
|
4344
|
+
choices: ZodOptional<ZodReadonly<ZodArray<ZodUnion<readonly [ZodString, ZodNumber, ZodLiteral<true>, ZodUndefined]>>>>;
|
|
4345
|
+
default: ZodOptional<ZodUnknown>;
|
|
4346
|
+
description: ZodString;
|
|
4347
|
+
group: ZodOptional<ZodString>;
|
|
4348
|
+
hidden: ZodOptional<ZodBoolean>;
|
|
4349
|
+
title: ZodString;
|
|
4350
|
+
type: ZodUnion<readonly [ZodLiteral<"array">, ZodLiteral<"count">, ZodLiteral<"boolean">, ZodLiteral<"number">, ZodLiteral<"string">]>;
|
|
4351
|
+
}, $catchall<ZodUnknown>>;
|
|
4352
|
+
```
|
|
4353
|
+
|
|
4354
|
+
### <a id="WALLET_COMPLIANCE"></a>WALLET_COMPLIANCE
|
|
4355
|
+
|
|
4356
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4357
|
+
|
|
4358
|
+
***
|
|
4359
|
+
|
|
4360
|
+
```ts
|
|
4361
|
+
const WALLET_COMPLIANCE: "44'";
|
|
3286
4362
|
```
|
|
3287
4363
|
|
|
3288
4364
|
### <a id="Xl1CommonConfigSchema"></a>Xl1CommonConfigSchema
|
|
@@ -3293,15 +4369,16 @@ const TODO: true = true;
|
|
|
3293
4369
|
|
|
3294
4370
|
```ts
|
|
3295
4371
|
const Xl1CommonConfigSchema: ZodObject<{
|
|
4372
|
+
logLevel: ZodDefault<ZodEnum<{
|
|
4373
|
+
error: "error";
|
|
4374
|
+
warn: "warn";
|
|
4375
|
+
info: "info";
|
|
4376
|
+
log: "log";
|
|
4377
|
+
debug: "debug";
|
|
4378
|
+
trace: "trace";
|
|
4379
|
+
}>>;
|
|
3296
4380
|
silent: ZodDefault<ZodBoolean>;
|
|
3297
|
-
|
|
3298
|
-
}, "strip", ZodTypeAny, {
|
|
3299
|
-
silent: boolean;
|
|
3300
|
-
logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
|
|
3301
|
-
}, {
|
|
3302
|
-
silent?: boolean;
|
|
3303
|
-
logLevel?: "error" | "warn" | "info" | "log" | "debug" | "trace";
|
|
3304
|
-
}>;
|
|
4381
|
+
}, $strip>;
|
|
3305
4382
|
```
|
|
3306
4383
|
|
|
3307
4384
|
### <a id="asBalancesStepSummary"></a>asBalancesStepSummary
|
|
@@ -3322,6 +4399,26 @@ const asBalancesStepSummary: AsTypeFunction<BalancesStepSummary>;
|
|
|
3322
4399
|
|
|
3323
4400
|
```ts
|
|
3324
4401
|
const asBalancesStepSummaryWithStorageMeta: AsTypeFunction<WithStorageMeta<BalancesStepSummary>>;
|
|
4402
|
+
```
|
|
4403
|
+
|
|
4404
|
+
### <a id="asTransfersStepSummary"></a>asTransfersStepSummary
|
|
4405
|
+
|
|
4406
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4407
|
+
|
|
4408
|
+
***
|
|
4409
|
+
|
|
4410
|
+
```ts
|
|
4411
|
+
const asTransfersStepSummary: AsTypeFunction<TransfersStepSummary>;
|
|
4412
|
+
```
|
|
4413
|
+
|
|
4414
|
+
### <a id="asTransfersStepSummaryWithStorageMeta"></a>asTransfersStepSummaryWithStorageMeta
|
|
4415
|
+
|
|
4416
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4417
|
+
|
|
4418
|
+
***
|
|
4419
|
+
|
|
4420
|
+
```ts
|
|
4421
|
+
const asTransfersStepSummaryWithStorageMeta: AsTypeFunction<WithStorageMeta<TransfersStepSummary>>;
|
|
3325
4422
|
```
|
|
3326
4423
|
|
|
3327
4424
|
### <a id="isBalancesStepSummary"></a>isBalancesStepSummary
|
|
@@ -3346,6 +4443,28 @@ Identity function for determining if an object is an BalancesStepSummary
|
|
|
3346
4443
|
|
|
3347
4444
|
`x is BalancesStepSummary`
|
|
3348
4445
|
|
|
4446
|
+
### <a id="isTransfersStepSummary"></a>isTransfersStepSummary
|
|
4447
|
+
|
|
4448
|
+
[**@xyo-network/xl1-protocol-sdk**](#../README)
|
|
4449
|
+
|
|
4450
|
+
***
|
|
4451
|
+
|
|
4452
|
+
```ts
|
|
4453
|
+
const isTransfersStepSummary: (x?) => x is TransfersStepSummary;
|
|
4454
|
+
```
|
|
4455
|
+
|
|
4456
|
+
Identity function for determining if an object is an TransfersStepSummary
|
|
4457
|
+
|
|
4458
|
+
## Parameters
|
|
4459
|
+
|
|
4460
|
+
### x?
|
|
4461
|
+
|
|
4462
|
+
`unknown`
|
|
4463
|
+
|
|
4464
|
+
## Returns
|
|
4465
|
+
|
|
4466
|
+
`x is TransfersStepSummary`
|
|
4467
|
+
|
|
3349
4468
|
|
|
3350
4469
|
## Maintainers
|
|
3351
4470
|
|