Skip to content

Commit 4f282fe

Browse files
markopoloparadoxmarkopoloparadox
committed
Code documentation changes
1 parent d3303c3 commit 4f282fe

13 files changed

+32
-34
lines changed

‎documentation/src/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func main() {
6868
}
6969

7070
// Transaction Details
71-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, res.BlockHash.ToHexWith0x(), res.BlockNumber, res.TxHash.ToHexWith0x(), res.TxIndex))
71+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, res.BlockHash.ToHexWith0x(), res.BlockNumber, res.TxHash.ToHexWith0x(), res.TxIndex))
7272
}
7373
```
7474

‎examples/block_events.go

+10-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func RunBlockEvents() {
3030
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
3131
}
3232

33-
// Convert from Block Transaction Event to Specific Transaction Event
33+
// Find Transfer event
3434
baEvents := SDK.EventFind(blockEvents, baPallet.EventTransfer{})
3535
PanicOnError(err)
3636
AssertEq(len(baEvents), 2, "Event Transfer event count is not 2")
@@ -39,7 +39,7 @@ func RunBlockEvents() {
3939
fmt.Println(fmt.Sprintf(`From: %v, To: %v, Amount: %v`, ev.From.ToHuman(), ev.To.ToHuman(), ev.Amount))
4040
}
4141

42-
// Convert from Block Transaction Event to Specific ApplicationKeyCreated Event
42+
// Find ApplicationKeyCreated event
4343
daEventMyb := SDK.EventFindFirst(blockEvents, daPallet.EventApplicationKeyCreated{})
4444
daEvent := daEventMyb.UnsafeUnwrap().UnsafeUnwrap()
4545
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, Id: %v, Key: %v, Owner: %v`, daEvent.PalletName(), daEvent.EventName(), daEvent.Id, string(daEvent.Key), daEvent.Owner.ToHuman()))
@@ -59,10 +59,17 @@ func RunBlockEvents() {
5959
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
6060
}
6161

62-
// Convert from Block Transaction Event to Specific Transaction Event
62+
// Find ExtrinsicSuccess event
6363
syEventMyb := SDK.EventFindFirst(txEvents, syPallet.EventExtrinsicSuccess{})
6464
syEvent := syEventMyb.UnsafeUnwrap().UnsafeUnwrap()
6565
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, Class: %v`, syEvent.PalletName(), syEvent.EventName(), syEvent.DispatchInfo.Class))
6666

67+
// Check
68+
tx2 := block.Transactions(SDK.Filter{}.WTxIndex(txIndex))
69+
AssertEq(len(tx2), 1, "")
70+
tx2Events := tx2[0].Events()
71+
AssertTrue(tx2Events.IsSome(), "")
72+
AssertEq(len(tx2Events.Unwrap()), len(txEvents), "")
73+
6774
fmt.Println("RunBlockEvents finished correctly.")
6875
}

‎examples/block_transaction_all.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func RunBlockTransactionAll() {
4545
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
4646
}
4747

48-
// Convert from Generic Transaction Event to Specific Transaction Event
48+
// Find DataSubmitted event
4949
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventDataSubmitted{})
5050
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
5151
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, Who: %v, Data Hash: %v`, event.PalletName(), event.EventName(), event.Who.ToHuman(), event.DataHash))

‎examples/block_transaction_by_app_id.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ func RunBlockTransactionByAppId() {
2020
block, err := SDK.NewBlock(sdk.Client, blockHash)
2121
PanicOnError(err)
2222

23-
// All Transaction filtered by Signer
23+
// All Transaction filtered by App Id
2424
appId := uint32(2)
2525
blockTxs := block.Transactions(SDK.Filter{}.WAppId(appId))
2626
fmt.Println("Transaction Count: ", len(blockTxs))
2727
AssertEq(len(blockTxs), 2, "Transaction count is not 2")
2828

29-
// Printout Block Transactions made by Signer
29+
// Printout Block Transactions filtered by App Id
3030
for _, tx := range blockTxs {
3131
AssertEq(tx.AppId().UnsafeUnwrap(), appId, "Transactions don't have App Id equal to 2")
3232
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Call Name: %v, Call Index: %v, Tx Hash: %v, Tx Index: %v`, tx.PalletName(), tx.PalletIndex(), tx.CallName(), tx.CallIndex(), tx.TxHash(), tx.TxIndex()))
@@ -47,7 +47,7 @@ func RunBlockTransactionByAppId() {
4747
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
4848
}
4949

50-
// Convert from Generic Transaction Event to Specific Transaction Event
50+
// Find DataSubmitted event
5151
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventDataSubmitted{})
5252
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
5353
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, DataHash: %v, Who: %v`, event.PalletName(), event.EventName(), event.DataHash, event.Who.ToHuman()))

‎examples/block_transaction_by_hash.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func RunBlockTransactionByHash() {
4545
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
4646
}
4747

48-
// Convert from Generic Transaction Event to Specific Transaction Event
48+
// Find Transfer event
4949
eventMyb := SDK.EventFindFirst(txEvents, baPallet.EventTransfer{})
5050
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
5151
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, From: %v, To: %v, Amount: %v`, event.PalletName(), event.EventName(), event.From.ToHuman(), event.To.ToHuman(), event.Amount))

‎examples/block_transaction_by_index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func RunBlockTransactionByIndex() {
4545
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
4646
}
4747

48-
// Convert from Generic Transaction Event to Specific Transaction Event
48+
// Find NewAccount event
4949
eventMyb := SDK.EventFindFirst(txEvents, syPallet.EventNewAccount{})
5050
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
5151
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, Account: %v`, event.PalletName(), event.EventName(), event.Account.ToHuman()))

‎examples/block_transaction_by_signer.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func RunBlockTransactionBySigner() {
2828
fmt.Println("Transaction Count: ", len(blockTxs))
2929
AssertEq(len(blockTxs), 5, "Transaction count is not 5")
3030

31-
// Printout Block Transactions made by Signer
31+
// Printout Block Transactions filtered by Signer
3232
for _, tx := range blockTxs {
3333
AssertEq(tx.SS58Address().UnsafeUnwrap(), accountId.ToHuman(), "Signer is not the correct one")
3434
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Call Name: %v, Call Index: %v, Tx Hash: %v, Tx Index: %v`, tx.PalletName(), tx.PalletIndex(), tx.CallName(), tx.CallIndex(), tx.TxHash(), tx.TxIndex()))
@@ -49,7 +49,7 @@ func RunBlockTransactionBySigner() {
4949
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
5050
}
5151

52-
// Convert from Generic Transaction Event to Specific Transaction Event
52+
// Find ApplicationKeyCreated event
5353
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventApplicationKeyCreated{})
5454
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
5555
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, Owner: %v, Key: %v, AppId: %v`, event.PalletName(), event.EventName(), event.Owner.ToHuman(), string(event.Key), event.Id))

‎examples/data_submission.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func RunDataSubmission() {
5454
AssertTrue(res.IsSuccessful().UnsafeUnwrap(), "Tx must be successful")
5555

5656
// Transaction Details
57-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, res.BlockHash.ToHexWith0x(), res.BlockNumber, res.TxHash.ToHexWith0x(), res.TxIndex))
57+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, res.BlockHash.ToHexWith0x(), res.BlockNumber, res.TxHash.ToHexWith0x(), res.TxIndex))
5858

5959
// Events
6060
AssertTrue(res.Events.IsSome(), "Events must be present")

‎examples/transaction_custom.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func RunTransactionCustom() {
4646
AssertTrue(txDetails.IsSuccessful().UnsafeUnwrap(), "Transaction is supposed to succeed")
4747

4848
// Printout Transaction Details
49-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
49+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
5050

5151
// Printout Transaction Events
5252
txEvents := txDetails.Events.UnsafeUnwrap()

‎examples/transaction_execute.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ func RunTransactionExecute() {
3232

3333
// Printout Transaction Details
3434
txDetails := mybTxDetails.UnsafeUnwrap()
35-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
35+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
3636

3737
// Printout Transaction Events
3838
txEvents := txDetails.Events.UnsafeUnwrap()
3939
for _, ev := range txEvents {
4040
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
4141
}
4242

43-
// Converts generic event to a specific one
43+
// Find DataSubmitted event
4444
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventDataSubmitted{})
4545
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
4646
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, DataHash: %v, Who: %v`, event.PalletName(), event.EventName(), event.DataHash, event.Who.ToHuman()))

‎examples/transaction_execute_and_watch_finalization.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ func RunTransactionExecuteAndWatchFinalization() {
2626
AssertTrue(txDetails.IsSuccessful().UnsafeUnwrap(), "Transaction is supposed to succeed")
2727

2828
// Printout Transaction Details
29-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
29+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
3030

3131
// Printout Transaction Events
3232
txEvents := txDetails.Events.UnsafeUnwrap()
3333
for _, ev := range txEvents {
3434
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
3535
}
3636

37-
// Converts generic event to a specific one
37+
// Find DataSubmitted event
3838
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventDataSubmitted{})
3939
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
4040
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, DataHash: %v, Who: %v`, event.PalletName(), event.EventName(), event.DataHash, event.Who.ToHuman()))

‎examples/transaction_execute_and_watch_inclusion.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ func RunTransactionExecuteAndWatchInclusion() {
2727
AssertTrue(txDetails.IsSuccessful().UnsafeUnwrap(), "Transaction is supposed to succeed")
2828

2929
// Printout Transaction Details
30-
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Index: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
30+
fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Number: %v, Tx Hash: %v, Tx Index: %v`, txDetails.BlockHash, txDetails.BlockNumber, txDetails.TxHash, txDetails.TxIndex))
3131

3232
// Printout Transaction Events
3333
txEvents := txDetails.Events.UnsafeUnwrap()
3434
for _, ev := range txEvents {
3535
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Pallet Index: %v, Event Name: %v, Event Index: %v, Event Position: %v, Tx Index: %v`, ev.PalletName, ev.PalletIndex, ev.EventName, ev.EventIndex, ev.Position, ev.TxIndex()))
3636
}
3737

38-
// Converts generic event to a specific one
38+
// Find DataSubmitted event
3939
eventMyb := SDK.EventFindFirst(txEvents, daPallet.EventDataSubmitted{})
4040
event := eventMyb.UnsafeUnwrap().UnsafeUnwrap()
4141
fmt.Println(fmt.Sprintf(`Pallet Name: %v, Event Name: %v, DataHash: %v, Who: %v`, event.PalletName(), event.EventName(), event.DataHash, event.Who.ToHuman()))

‎sdk/block.go

+5-14
Original file line numberDiff line numberDiff line change
@@ -161,26 +161,17 @@ func (this *Block) DataSubmissions(filter Filter) []DataSubmission {
161161
}
162162

163163
func (this *Block) EventsForTransaction(txIndex uint32) prim.Option[EventRecords] {
164-
extrinsics := this.Block.Extrinsics
165-
166-
if txIndex >= uint32(len(extrinsics)) {
167-
return prim.None[EventRecords]()
168-
}
169-
170164
if this.events.IsNone() {
171165
return prim.None[EventRecords]()
172166
}
173167

174-
for i := range extrinsics {
175-
if extrinsics[i].TxIndex != txIndex {
176-
continue
177-
}
178-
allEvents := this.events.Unwrap()
179-
txEvents := EventFilterByTxIndex(allEvents, txIndex)
180-
return prim.Some(txEvents)
168+
if txIndex >= uint32(len(this.Block.Extrinsics)) {
169+
return prim.None[EventRecords]()
181170
}
182171

183-
return prim.None[EventRecords]()
172+
allEvents := this.events.Unwrap()
173+
txEvents := EventFilterByTxIndex(allEvents, txIndex)
174+
return prim.Some(txEvents)
184175
}
185176

186177
func (this *Block) Events() prim.Option[EventRecords] {

0 commit comments

Comments
 (0)