Skip to content

Commit

Permalink
Merge pull request #90 from algorandfoundation/block-fields
Browse files Browse the repository at this point in the history
fix: Add block and transaction fields
  • Loading branch information
negar-abbasi authored Jul 12, 2024
2 parents 1b397e8 + fc49d80 commit dead14e
Show file tree
Hide file tree
Showing 34 changed files with 768 additions and 131 deletions.
10 changes: 5 additions & 5 deletions docs/code/enums/types_subscription.BalanceChangeRole.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Account was creating an asset and holds the full asset supply

#### Defined in

[types/subscription.ts:135](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L135)
[types/subscription.ts:195](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L195)

___

Expand All @@ -39,7 +39,7 @@ A balance change with this role will always have a 0 amount and use the asset ma

#### Defined in

[types/subscription.ts:139](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L139)
[types/subscription.ts:199](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L199)

___

Expand All @@ -51,7 +51,7 @@ Account was having an asset amount closed to it

#### Defined in

[types/subscription.ts:133](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L133)
[types/subscription.ts:193](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L193)

___

Expand All @@ -63,7 +63,7 @@ Account was receiving a transaction

#### Defined in

[types/subscription.ts:131](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L131)
[types/subscription.ts:191](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L191)

___

Expand All @@ -75,4 +75,4 @@ Account was sending a transaction (sending asset and/or spending fee if asset `0

#### Defined in

[types/subscription.ts:129](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L129)
[types/subscription.ts:189](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L189)
78 changes: 78 additions & 0 deletions docs/code/interfaces/types_block.Block.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,24 @@ https://github.com/algorand/go-algorand/blob/master/data/bookkeeping/block.go#L3
- [nextproto](types_block.Block.md#nextproto)
- [nextswitch](types_block.Block.md#nextswitch)
- [nextyes](types_block.Block.md#nextyes)
- [partupdabs](types_block.Block.md#partupdabs)
- [partupdrmv](types_block.Block.md#partupdrmv)
- [prev](types_block.Block.md#prev)
- [proto](types_block.Block.md#proto)
- [rate](types_block.Block.md#rate)
- [rnd](types_block.Block.md#rnd)
- [rwcalr](types_block.Block.md#rwcalr)
- [rwd](types_block.Block.md#rwd)
- [seed](types_block.Block.md#seed)
- [spt](types_block.Block.md#spt)
- [tc](types_block.Block.md#tc)
- [ts](types_block.Block.md#ts)
- [txn](types_block.Block.md#txn)
- [txn256](types_block.Block.md#txn256)
- [txns](types_block.Block.md#txns)
- [upgradedelay](types_block.Block.md#upgradedelay)
- [upgradeprop](types_block.Block.md#upgradeprop)
- [upgradeyes](types_block.Block.md#upgradeyes)

## Properties

Expand Down Expand Up @@ -149,6 +155,32 @@ Number of blocks which approved the protocol upgrade.

___

### partupdabs

`Optional` **partupdabs**: `Uint8Array`[]

AbsentParticipationAccounts contains a list of online accounts that
needs to be converted to offline since they are not proposing.

#### Defined in

[types/block.ts:154](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L154)

___

### partupdrmv

`Optional` **partupdrmv**: `Uint8Array`[]

ExpiredParticipationAccounts contains a list of online accounts that needs to be
converted to offline since their participation key expired.

#### Defined in

[types/block.ts:159](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L159)

___

### prev

`Optional` **prev**: `Uint8Array`
Expand Down Expand Up @@ -234,6 +266,16 @@ Sortition seed

___

### spt

`Optional` **spt**: `Record`\<`number`, [`StateProofTracking`](types_block.StateProofTracking.md)\>

#### Defined in

[types/block.ts:173](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L173)

___

### tc

**tc**: `number`
Expand Down Expand Up @@ -295,3 +337,39 @@ The transactions within the block.
#### Defined in

[types/block.ts:149](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L149)

___

### upgradedelay

`Optional` **upgradedelay**: `number`

UpgradeDelay indicates the time between acceptance and execution

#### Defined in

[types/block.ts:167](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L167)

___

### upgradeprop

`Optional` **upgradeprop**: `string`

UpgradePropose indicates a proposed upgrade

#### Defined in

[types/block.ts:171](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L171)

___

### upgradeyes

`Optional` **upgradeyes**: `boolean`

UpgradeApprove indicates a yes vote for the current proposal

#### Defined in

[types/block.ts:163](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L163)
24 changes: 12 additions & 12 deletions docs/code/interfaces/types_block.BlockTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Asset closing amount in decimal units

#### Defined in

[types/block.ts:166](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L166)
[types/block.ts:190](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L190)

___

Expand All @@ -49,7 +49,7 @@ App ID when an app is created by the transaction

#### Defined in

[types/block.ts:164](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L164)
[types/block.ts:188](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L188)

___

Expand All @@ -61,7 +61,7 @@ Algo closing amount in microAlgos

#### Defined in

[types/block.ts:168](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L168)
[types/block.ts:192](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L192)

___

Expand All @@ -73,7 +73,7 @@ Asset ID when an asset is created by the transaction

#### Defined in

[types/block.ts:162](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L162)
[types/block.ts:186](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L186)

___

Expand All @@ -85,7 +85,7 @@ The eval deltas for the block

#### Defined in

[types/block.ts:160](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L160)
[types/block.ts:184](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L184)

___

Expand All @@ -97,7 +97,7 @@ Has genesis hash

#### Defined in

[types/block.ts:172](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L172)
[types/block.ts:196](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L196)

___

Expand All @@ -109,7 +109,7 @@ Has genesis id

#### Defined in

[types/block.ts:170](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L170)
[types/block.ts:194](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L194)

___

Expand All @@ -121,7 +121,7 @@ Logic signature

#### Defined in

[types/block.ts:176](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L176)
[types/block.ts:200](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L200)

___

Expand All @@ -133,7 +133,7 @@ Transaction multisig signature

#### Defined in

[types/block.ts:178](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L178)
[types/block.ts:202](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L202)

___

Expand All @@ -145,7 +145,7 @@ The signer, if signing with a different key than the Transaction type `from` pro

#### Defined in

[types/block.ts:180](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L180)
[types/block.ts:204](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L204)

___

Expand All @@ -157,7 +157,7 @@ Transaction ED25519 signature

#### Defined in

[types/block.ts:174](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L174)
[types/block.ts:198](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L198)

___

Expand All @@ -169,4 +169,4 @@ The encoded transaction data

#### Defined in

[types/block.ts:158](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L158)
[types/block.ts:182](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L182)
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_block.BlockTransactionEvalDelta.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The delta of global state, keyed by key

#### Defined in

[types/block.ts:220](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L220)
[types/block.ts:244](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L244)

___

Expand All @@ -37,7 +37,7 @@ Inner transactions

#### Defined in

[types/block.ts:226](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L226)
[types/block.ts:250](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L250)

___

Expand All @@ -49,7 +49,7 @@ The delta of local state keyed by account ID offset in [txn.Sender, ...txn.Accou

#### Defined in

[types/block.ts:222](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L222)
[types/block.ts:246](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L246)

___

Expand All @@ -61,4 +61,4 @@ Logs

#### Defined in

[types/block.ts:224](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L224)
[types/block.ts:248](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L248)
6 changes: 3 additions & 3 deletions docs/code/interfaces/types_block.BlockValueDelta.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ DeltaAction is an enum of actions that may be performed when applying a delta to

#### Defined in

[types/block.ts:236](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L236)
[types/block.ts:260](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L260)

___

Expand All @@ -39,7 +39,7 @@ Bytes value

#### Defined in

[types/block.ts:239](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L239)
[types/block.ts:263](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L263)

___

Expand All @@ -51,4 +51,4 @@ Uint64 value

#### Defined in

[types/block.ts:242](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L242)
[types/block.ts:266](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L266)
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_block.LogicSig.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Arguments passed into the logic signature

#### Defined in

[types/block.ts:194](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L194)
[types/block.ts:218](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L218)

___

Expand All @@ -41,7 +41,7 @@ Logic sig code

#### Defined in

[types/block.ts:188](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L188)
[types/block.ts:212](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L212)

___

Expand All @@ -53,7 +53,7 @@ Multisig signature for delegated operations

#### Defined in

[types/block.ts:192](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L192)
[types/block.ts:216](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L216)

___

Expand All @@ -65,4 +65,4 @@ ED25519 signature for delegated operations

#### Defined in

[types/block.ts:190](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L190)
[types/block.ts:214](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L214)
6 changes: 3 additions & 3 deletions docs/code/interfaces/types_block.MultisigSig.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Sub-signatures

#### Defined in

[types/block.ts:206](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L206)
[types/block.ts:230](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L230)

___

Expand All @@ -40,7 +40,7 @@ Multisig threshold

#### Defined in

[types/block.ts:204](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L204)
[types/block.ts:228](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L228)

___

Expand All @@ -52,4 +52,4 @@ Multisig version

#### Defined in

[types/block.ts:202](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L202)
[types/block.ts:226](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L226)
Loading

0 comments on commit dead14e

Please sign in to comment.