@effectstream/sm 0.101.1 → 0.103.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/LICENSE-APACHE +201 -0
  2. package/LICENSE-MIT +21 -0
  3. package/package.json +10 -10
  4. package/primitives/Primitive.ts +4 -1
  5. package/primitives/src/builtin.ts +24 -3
  6. package/primitives/src/grammar.ts +8 -0
  7. package/primitives/src/midnight-nullifier-and-commitment/midnight-nullifier-and-commitment-grammar.ts +37 -0
  8. package/primitives/src/{midnight-nullifier/midnight-nullifier.ts → midnight-nullifier-and-commitment/midnight-nullifier-and-commitment.ts} +37 -14
  9. package/primitives/src/midnight-token-mint/midnight-token-mint-grammar.ts +12 -4
  10. package/primitives/src/midnight-token-mint/midnight-token-mint-ivm.ts +105 -0
  11. package/primitives/src/midnight-token-mint/midnight-token-mint.test.ts +150 -0
  12. package/primitives/src/midnight-token-mint/midnight-token-mint.ts +80 -23
  13. package/primitives/src/midnight-unshielded-create/midnight-unshielded-create-grammar.ts +14 -1
  14. package/primitives/src/midnight-unshielded-create/midnight-unshielded-create.ts +4 -1
  15. package/primitives/src/midnight-unshielded-spend/midnight-unshielded-spend-grammar.ts +14 -1
  16. package/primitives/src/midnight-unshielded-spend/midnight-unshielded-spend.ts +4 -1
  17. package/primitives/src/mod.ts +17 -4
  18. package/primitives/src/solana-account-balance/solana-account-balance-grammar.ts +7 -0
  19. package/primitives/src/solana-account-balance/solana-account-balance-primitive.ts +108 -0
  20. package/primitives/src/solana-program-log/solana-program-log-grammar.ts +7 -0
  21. package/primitives/src/solana-program-log/solana-program-log-primitive.test.ts +128 -0
  22. package/primitives/src/solana-program-log/solana-program-log-primitive.ts +108 -0
  23. package/primitives/src/solana-token-account/solana-token-account-grammar.ts +13 -0
  24. package/primitives/src/solana-token-account/solana-token-account-primitive.test.ts +117 -0
  25. package/primitives/src/solana-token-account/solana-token-account-primitive.ts +156 -0
  26. package/primitives/src/midnight-nullifier/midnight-nullifier-grammar.ts +0 -8
package/LICENSE-APACHE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2024-2026 Midnight Foundation
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/LICENSE-MIT ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024-2026 Midnight Foundation
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@effectstream/sm",
3
- "version": "0.101.1",
4
- "license": "MIT",
3
+ "version": "0.103.0",
4
+ "license": "(MIT OR Apache-2.0)",
5
5
  "homepage": "https://effectstream.github.io/docs/",
6
6
  "repository": {
7
7
  "type": "git",
@@ -17,14 +17,14 @@
17
17
  "./grammar": "./primitives/src/grammar.ts"
18
18
  },
19
19
  "dependencies": {
20
- "@effectstream/concise": "0.101.1",
21
- "@effectstream/config": "0.101.1",
22
- "@effectstream/coroutine": "0.101.1",
23
- "@effectstream/crypto": "0.101.1",
24
- "@effectstream/db": "0.101.1",
25
- "@effectstream/event-client": "0.101.1",
26
- "@effectstream/log": "0.101.1",
27
- "@effectstream/utils": "0.101.1",
20
+ "@effectstream/concise": "0.103.0",
21
+ "@effectstream/config": "0.103.0",
22
+ "@effectstream/coroutine": "0.103.0",
23
+ "@effectstream/crypto": "0.103.0",
24
+ "@effectstream/db": "0.103.0",
25
+ "@effectstream/event-client": "0.103.0",
26
+ "@effectstream/log": "0.103.0",
27
+ "@effectstream/utils": "0.103.0",
28
28
  "pg": "8.21.0",
29
29
  "pg-tx": "^1.0.1",
30
30
  "@sinclair/typebox": "0.34.41",
@@ -50,9 +50,12 @@ export abstract class Primitive<
50
50
  // maintained `pg_ivm` view (when the extension is available) and a plain
51
51
  // SQL view fallback (when it isn't). All other DDL — intermediate table,
52
52
  // trigger function, trigger — is identical across strategies.
53
+ // May return `undefined` to emit no DDL — e.g. a primitive can gate its
54
+ // owned table behind a config flag. `getDynamicTables` already surfaces
55
+ // `string | undefined`, and `createDynamicTables` skips on undefined.
53
56
  dynamicTables:
54
57
  | undefined
55
- | ((name: string, strategy: MaterializedViewStrategy) => string) =
58
+ | ((name: string, strategy: MaterializedViewStrategy) => string | undefined) =
56
59
  undefined;
57
60
  getIntermediatePrefix(): string[] {
58
61
  return [];
@@ -1,7 +1,13 @@
1
1
  // list of built-in primitives
2
2
  // this list is exposed to the effectstream-sdk modules via the @effectstream/sm/builtin module
3
+ import {
4
+ SOLANA_PRIMITIVE_ACCOUNT_BALANCE,
5
+ SOLANA_PRIMITIVE_PROGRAM_LOG,
6
+ SOLANA_PRIMITIVE_TOKEN_ACCOUNT,
7
+ } from "@effectstream/config";
8
+
3
9
  export const PrimitiveTypeMidnightGeneric = "Midnight:Generic" as const;
4
- export const PrimitiveTypeMidnightNullifier = "Midnight:Nullifier" as const;
10
+ export const PrimitiveTypeMidnightNullifierAndCommitment = "Midnight:NullifierAndCommitment" as const;
5
11
  export const PrimitiveTypeMidnightUnshieldedSpend = "Midnight:UnshieldedSpend" as const;
6
12
  export const PrimitiveTypeMidnightUnshieldedCreate = "Midnight:UnshieldedCreate" as const;
7
13
  export const PrimitiveTypeMidnightZswapRoot = "Midnight:ZswapRoot" as const;
@@ -33,9 +39,21 @@ export const PrimitiveTypeNEARIntent = "NEAR:Intent" as const;
33
39
  export const PrimitiveTypeNEARGeneric = "NEAR:Generic" as const;
34
40
  export const PrimitiveTypeNEARAccountWatch = "NEAR:AccountWatch" as const;
35
41
 
42
+ // Solana's discriminators are defined in @effectstream/config, beside the
43
+ // `SolanaPrimitive` type they discriminate, because the sync fetcher dispatches on
44
+ // them and @effectstream/sync does not depend on @effectstream/sm. Re-exported here
45
+ // under the PrimitiveType* names so consumers keep importing them from
46
+ // @effectstream/sm/builtin like every other primitive.
47
+ // Aliased through local consts rather than `export { X as Y } from`, because the
48
+ // `BuiltInPrimitives` union below needs `typeof PrimitiveTypeSolana*` in scope and a
49
+ // bare re-export does not bind the name locally.
50
+ export const PrimitiveTypeSolanaProgramLog = SOLANA_PRIMITIVE_PROGRAM_LOG;
51
+ export const PrimitiveTypeSolanaAccountBalance = SOLANA_PRIMITIVE_ACCOUNT_BALANCE;
52
+ export const PrimitiveTypeSolanaTokenAccount = SOLANA_PRIMITIVE_TOKEN_ACCOUNT;
53
+
36
54
  type BuiltInPrimitives =
37
55
  typeof PrimitiveTypeMidnightGeneric |
38
- typeof PrimitiveTypeMidnightNullifier |
56
+ typeof PrimitiveTypeMidnightNullifierAndCommitment |
39
57
  typeof PrimitiveTypeMidnightUnshieldedSpend |
40
58
  typeof PrimitiveTypeMidnightUnshieldedCreate |
41
59
  typeof PrimitiveTypeMidnightZswapRoot |
@@ -58,7 +76,10 @@ type BuiltInPrimitives =
58
76
  typeof PrimitiveTypeNEARNEP245 |
59
77
  typeof PrimitiveTypeNEARIntent |
60
78
  typeof PrimitiveTypeNEARGeneric |
61
- typeof PrimitiveTypeNEARAccountWatch // |
79
+ typeof PrimitiveTypeNEARAccountWatch |
80
+ typeof PrimitiveTypeSolanaProgramLog |
81
+ typeof PrimitiveTypeSolanaAccountBalance |
82
+ typeof PrimitiveTypeSolanaTokenAccount // |
62
83
  // typeof PrimitiveTypeEVMGeneric
63
84
  ;
64
85
 
@@ -15,14 +15,19 @@ import { nep245Grammar } from "./near-nep245/nep245-grammar.ts";
15
15
  import { nearIntentGrammar } from "./near-intent/near-intent-grammar.ts";
16
16
  import { nearGenericGrammar } from "./near-generic/near-generic-grammar.ts";
17
17
  import { nearAccountWatchGrammar } from "./near-account-watch/near-account-watch-grammar.ts";
18
+ import { solanaProgramLogGrammar } from "./solana-program-log/solana-program-log-grammar.ts";
19
+ import { solanaAccountBalanceGrammar } from "./solana-account-balance/solana-account-balance-grammar.ts";
20
+ import { solanaTokenAccountGrammar } from "./solana-token-account/solana-token-account-grammar.ts";
18
21
  import { mintBurnGrammar } from "./cardano-mint-burn/mint-burn-grammar.ts";
19
22
  import { transferGrammar } from "./cardano-transfer/transfer-grammar.ts";
20
23
  import { poolDelegationGrammar } from "./cardano-pool-delegation/pool-delegation-grammar.ts";
21
24
  import { delayedAssetGrammar } from "./cardano-delayed-asset/delayed-asset-grammar.ts";
22
25
  import { projectedNftGrammar } from "./cardano-projected-nft/projected-nft-grammar.ts";
26
+ import { midnightTokenMintGrammar } from "./midnight-token-mint/midnight-token-mint-grammar.ts";
23
27
 
24
28
  export const builtinGrammars = {
25
29
  midnightGeneric: midnightGenericGrammar,
30
+ midnightTokenMint: midnightTokenMintGrammar,
26
31
  evmErc721: erc721Grammar,
27
32
  evmErc20: erc20Grammar,
28
33
  availGeneric: availGenericGrammar,
@@ -36,6 +41,9 @@ export const builtinGrammars = {
36
41
  nearIntent: nearIntentGrammar,
37
42
  nearGeneric: nearGenericGrammar,
38
43
  nearAccountWatch: nearAccountWatchGrammar,
44
+ solanaProgramLog: solanaProgramLogGrammar,
45
+ solanaAccountBalance: solanaAccountBalanceGrammar,
46
+ solanaTokenAccount: solanaTokenAccountGrammar,
39
47
  cardanoMintBurn: mintBurnGrammar,
40
48
  cardanoTransfer: transferGrammar,
41
49
  cardanoPoolDelegation: poolDelegationGrammar,
@@ -0,0 +1,37 @@
1
+ import { Type } from "@sinclair/typebox";
2
+
3
+ export const midnightNullifierAndCommitmentGrammar = [
4
+ [
5
+ "payload",
6
+ Type.Union([
7
+ Type.Object({
8
+ kind: Type.Literal("nullifier"),
9
+ /** 32-byte nullifier, hex (no 0x prefix) */
10
+ nullifier: Type.String(),
11
+ /** 32-byte transaction hash, hex (no 0x prefix) */
12
+ txHash: Type.String(),
13
+ /** Indexer-assigned zswap ledger event id */
14
+ eventId: Type.Number(),
15
+ /** Logical segment the event was emitted in */
16
+ logicalSegment: Type.Number(),
17
+ /** Contract address that spent the coin, hex — absent for user coins */
18
+ contract: Type.Optional(Type.String()),
19
+ }),
20
+ Type.Object({
21
+ kind: Type.Literal("commitment"),
22
+ /** 32-byte coin commitment, hex (no 0x prefix) */
23
+ commitment: Type.String(),
24
+ /** Index of the commitment in the zswap Merkle tree (u64 as decimal string) */
25
+ mtIndex: Type.String(),
26
+ /** 32-byte transaction hash, hex (no 0x prefix) */
27
+ txHash: Type.String(),
28
+ /** Indexer-assigned zswap ledger event id */
29
+ eventId: Type.Number(),
30
+ /** Logical segment the event was emitted in */
31
+ logicalSegment: Type.Number(),
32
+ /** Contract address that received the coin, hex — absent for user coins */
33
+ contract: Type.Optional(Type.String()),
34
+ }),
35
+ ]),
36
+ ],
37
+ ] as const;
@@ -16,28 +16,40 @@ import type {
16
16
  ProtocolPrimitiveMap,
17
17
  } from "@effectstream/config";
18
18
  import type { SyncStateUpdateStream } from "@effectstream/coroutine";
19
- import { PrimitiveTypeMidnightNullifier } from "../builtin.ts";
20
- import { midnightNullifierGrammar } from "./midnight-nullifier-grammar.ts";
19
+ import { PrimitiveTypeMidnightNullifierAndCommitment } from "../builtin.ts";
20
+ import { midnightNullifierAndCommitmentGrammar } from "./midnight-nullifier-and-commitment-grammar.ts";
21
+
22
+ /** Which zswap ledger event kinds the primitive emits. */
23
+ export type MidnightZswapCapture = "nullifiers" | "commitments" | "both";
21
24
 
22
25
  /**
23
- * MidnightNullifierPrimitive
26
+ * MidnightNullifierAndCommitmentPrimitive
24
27
  *
25
- * Watches all ZswapInput (nullifier-spend) events on the Midnight shielded
26
- * ledger. One state-machine input is emitted per nullifier event observed in
27
- * a block, regardless of which contract produced it.
28
+ * Watches ZswapInput (nullifier-spend) and ZswapOutput (commitment-create)
29
+ * events on the Midnight shielded ledger. Both event kinds arrive in the
30
+ * same indexer field (`zswapLedgerEvents`), so tracking both costs no extra
31
+ * indexer queries. One state-machine input is emitted per event observed in
32
+ * a block, regardless of which contract produced it. The `capture` option
33
+ * selects which kinds are emitted (default: both).
28
34
  *
29
35
  * Usage:
30
36
  * stm.addStateTransition("myPrefix", function* (data) {
31
37
  * const { payload } = data.parsedInput;
32
- * // payload = { nullifier, txHash, eventId, logicalSegment }
38
+ * if (payload.kind === "nullifier") {
39
+ * // { kind, nullifier, txHash, eventId, logicalSegment, contract? }
40
+ * } else {
41
+ * // { kind, commitment, mtIndex, txHash, eventId, logicalSegment, contract? }
42
+ * }
33
43
  * });
34
44
  */
35
- export class MidnightNullifierPrimitive extends Primitive<
45
+ export class MidnightNullifierAndCommitmentPrimitive extends Primitive<
36
46
  ConfigSyncProtocolType.MIDNIGHT_PARALLEL,
37
- typeof midnightNullifierGrammar
47
+ typeof midnightNullifierAndCommitmentGrammar
38
48
  > {
39
- readonly internalTypeName = PrimitiveTypeMidnightNullifier;
40
- override readonly grammar = midnightNullifierGrammar;
49
+ readonly internalTypeName = PrimitiveTypeMidnightNullifierAndCommitment;
50
+ override readonly grammar = midnightNullifierAndCommitmentGrammar;
51
+
52
+ readonly capture: MidnightZswapCapture;
41
53
 
42
54
  override dynamicTables = undefined;
43
55
  override getIntermediatePrefix(): string[] {
@@ -51,8 +63,11 @@ export class MidnightNullifierPrimitive extends Primitive<
51
63
  instanceName: string;
52
64
  startBlockHeight: number;
53
65
  stateMachinePrefix: string;
66
+ /** Which zswap event kinds to emit. Default: "both". */
67
+ capture?: MidnightZswapCapture;
54
68
  }) {
55
69
  super(config);
70
+ this.capture = config.capture ?? "both";
56
71
  }
57
72
 
58
73
  override *getPayload(
@@ -65,12 +80,19 @@ export class MidnightNullifierPrimitive extends Primitive<
65
80
  data: {
66
81
  fromAddressAndType: AddressAndType;
67
82
  stateMachinePayload:
68
- | StaticDecode<CommandTuple<string, typeof midnightNullifierGrammar>>
83
+ | StaticDecode<
84
+ CommandTuple<string, typeof midnightNullifierAndCommitmentGrammar>
85
+ >
69
86
  | null;
70
- accountingPayload: ParamToData<typeof midnightNullifierGrammar>;
87
+ accountingPayload: ParamToData<
88
+ typeof midnightNullifierAndCommitmentGrammar
89
+ >;
71
90
  }[];
72
91
  }> {
73
- const payload = primitiveTransactionData.output.payload;
92
+ // The sync-protocol payload map types Midnight payloads as Record<string, any>;
93
+ // the fetcher's fetchZswapEvents builds exactly the grammar's payload shape.
94
+ const payload = primitiveTransactionData.output
95
+ .payload as ParamToData<typeof this.grammar>["payload"];
74
96
 
75
97
  const accountingPayload: ParamToData<typeof this.grammar> = {
76
98
  payload,
@@ -109,6 +131,7 @@ export class MidnightNullifierPrimitive extends Primitive<
109
131
  type: this.internalTypeName,
110
132
  startBlockHeight: this.startBlockHeight,
111
133
  scheduledPrefix: this.stateMachinePrefix ?? "",
134
+ capture: this.capture,
112
135
  } as const;
113
136
  }
114
137
  }
@@ -1,8 +1,16 @@
1
1
  import { Type } from "@sinclair/typebox";
2
2
 
3
+ // Flat named fields (not a single `payload` blob) so the owned-table trigger
4
+ // on effectstream.primitive_accounting can read each column directly via
5
+ // `payload->>'field'` — mirrors the ERC20/NEP141 grammars. All strings;
6
+ // `amount` is a decimal string (u64 mints exceed MAX_SAFE_INTEGER) cast to
7
+ // numeric in SQL; `entryPoint` is informational (defaulted to "").
3
8
  export const midnightTokenMintGrammar = [
4
- [
5
- "payload",
6
- Type.Any(),
7
- ],
9
+ ["contractAddress", Type.String()],
10
+ ["domainSep", Type.String()],
11
+ ["rawTokenType", Type.String()],
12
+ ["kind", Type.String()],
13
+ ["amount", Type.String()],
14
+ ["txHash", Type.String()],
15
+ ["entryPoint", Type.String()],
8
16
  ] as const;
@@ -0,0 +1,105 @@
1
+ import { PrimitiveTypeMidnightTokenMint } from "../builtin.ts";
2
+ import type { MaterializedViewStrategy } from "@effectstream/db";
3
+
4
+ /**
5
+ * Owned-table DDL for the Midnight:TokenMint primitive — the registry
6
+ * `token_type → (contract_address, domain_sep, kind)` with an accumulating
7
+ * `total_minted`. Maintained entirely by a trigger on
8
+ * effectstream.primitive_accounting (which is written for every primitive
9
+ * event regardless of any state-machine prefix), so consumers get the table
10
+ * for free — no STM handler / migration required.
11
+ *
12
+ * Mirrors the ERC20/NEP141 IVM shape: intermediate table + trigger + a
13
+ * read-side view published per `strategy` (pg_ivm or plain VIEW).
14
+ */
15
+ export function midnightTokenMintIvm(
16
+ name: string,
17
+ strategy: MaterializedViewStrategy,
18
+ ) {
19
+ // The instance name becomes part of an SQL identifier, so strip anything that
20
+ // isn't identifier-safe. The ERC20/NEP141 IVMs *throw* here instead, which
21
+ // makes the owned table reject the repo's own naming convention (hyphenated
22
+ // instance names like "Midnight-TokenMint") — and it throws at sync startup,
23
+ // taking the whole node down for what is only a naming concern. Names that
24
+ // were already safe are untouched, so no existing table/view name shifts.
25
+ const lowerName = name.toLowerCase();
26
+ const validSQLName = lowerName.replace(/[^a-zA-Z0-9_]/g, "");
27
+ if (validSQLName.length === 0) {
28
+ throw new Error(
29
+ `Primitive instance name "${name}" has no SQL-identifier-safe characters`,
30
+ );
31
+ }
32
+ // The name is also compared as a string literal inside the trigger body, and
33
+ // that use is not identifier-restricted — so escape quotes rather than strip
34
+ // them. Without this, a name containing `'` emits DDL that fails to parse.
35
+ const sqlLiteralName = name.replace(/'/g, "''");
36
+
37
+ const mintsTable =
38
+ `primitives.midnight_token_mint_intermediate_${validSQLName}`;
39
+ const viewName = `primitives.midnight_token_mint_view_${validSQLName}`;
40
+ const selectSql =
41
+ `SELECT primitive_name, token_type, kind, contract_address, domain_sep, total_minted, tx_hash, block_height FROM ${mintsTable}`;
42
+
43
+ return `
44
+ -- Token-mint registry (maintained by a trigger on primitive_accounting).
45
+ -- The mapping columns are immutable (token_type is a pure function of
46
+ -- (domain_sep, contract_address)); total_minted accumulates; tx_hash /
47
+ -- block_height keep first-mint provenance. kind is in the key because the
48
+ -- shielded and unshielded derivation formula is identical.
49
+ CREATE TABLE IF NOT EXISTS ${mintsTable} (
50
+ primitive_name TEXT NOT NULL,
51
+ token_type TEXT NOT NULL,
52
+ kind TEXT NOT NULL,
53
+ contract_address TEXT NOT NULL,
54
+ domain_sep TEXT NOT NULL,
55
+ total_minted numeric(78,0) DEFAULT 0,
56
+ tx_hash TEXT,
57
+ block_height INTEGER,
58
+ PRIMARY KEY (primitive_name, token_type, kind)
59
+ );
60
+
61
+ CREATE OR REPLACE FUNCTION update_midnight_token_mint_${validSQLName}() RETURNS TRIGGER AS $$
62
+ DECLARE
63
+ mint_amount numeric(78,0);
64
+ BEGIN
65
+ IF NEW.payload_type = '${PrimitiveTypeMidnightTokenMint}'
66
+ AND NEW.primitive_name = '${sqlLiteralName}'
67
+ AND NEW.payload->>'rawTokenType' IS NOT NULL THEN
68
+
69
+ mint_amount := COALESCE((NEW.payload->>'amount')::numeric(78,0), 0);
70
+
71
+ INSERT INTO ${mintsTable} (
72
+ primitive_name, token_type, kind, contract_address, domain_sep,
73
+ total_minted, tx_hash, block_height
74
+ )
75
+ VALUES (
76
+ NEW.primitive_name,
77
+ NEW.payload->>'rawTokenType',
78
+ NEW.payload->>'kind',
79
+ NEW.payload->>'contractAddress',
80
+ NEW.payload->>'domainSep',
81
+ mint_amount,
82
+ NEW.payload->>'txHash',
83
+ NEW.effectstream_block_height
84
+ )
85
+ ON CONFLICT (primitive_name, token_type, kind) DO UPDATE SET
86
+ total_minted = ${mintsTable}.total_minted + EXCLUDED.total_minted;
87
+ END IF;
88
+
89
+ RETURN NEW;
90
+ END;
91
+ $$ LANGUAGE plpgsql;
92
+
93
+ CREATE TRIGGER trigger_update_midnight_token_mint_${validSQLName}
94
+ AFTER INSERT ON effectstream.primitive_accounting
95
+ FOR EACH ROW
96
+ EXECUTE FUNCTION update_midnight_token_mint_${validSQLName}();
97
+
98
+ ${strategy.createView(viewName, selectSql)}
99
+ `;
100
+ }
101
+
102
+ export const MIDNIGHT_TOKEN_MINT_VIEW_PREFIX =
103
+ "midnight_token_mint_view_" as const;
104
+ export const MIDNIGHT_TOKEN_MINT_INTERMEDIATE_PREFIX =
105
+ "midnight_token_mint_intermediate_" as const;