@effectstream/sm 0.101.0 → 0.102.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.
- package/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/package.json +10 -10
- package/primitives/Primitive.ts +4 -1
- package/primitives/src/builtin.ts +6 -1
- package/primitives/src/grammar.ts +6 -0
- package/primitives/src/midnight-token-mint/midnight-token-mint-grammar.ts +12 -4
- package/primitives/src/midnight-token-mint/midnight-token-mint-ivm.ts +105 -0
- package/primitives/src/midnight-token-mint/midnight-token-mint.test.ts +150 -0
- package/primitives/src/midnight-token-mint/midnight-token-mint.ts +80 -23
- package/primitives/src/mod.ts +8 -0
- package/primitives/src/solana-account-balance/solana-account-balance-grammar.ts +7 -0
- package/primitives/src/solana-account-balance/solana-account-balance-primitive.ts +108 -0
- package/primitives/src/solana-program-log/solana-program-log-grammar.ts +7 -0
- package/primitives/src/solana-program-log/solana-program-log-primitive.test.ts +128 -0
- package/primitives/src/solana-program-log/solana-program-log-primitive.ts +108 -0
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.
|
|
4
|
-
"license": "MIT",
|
|
3
|
+
"version": "0.102.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.
|
|
21
|
-
"@effectstream/config": "0.
|
|
22
|
-
"@effectstream/coroutine": "0.
|
|
23
|
-
"@effectstream/crypto": "0.
|
|
24
|
-
"@effectstream/db": "0.
|
|
25
|
-
"@effectstream/event-client": "0.
|
|
26
|
-
"@effectstream/log": "0.
|
|
27
|
-
"@effectstream/utils": "0.
|
|
20
|
+
"@effectstream/concise": "0.102.0",
|
|
21
|
+
"@effectstream/config": "0.102.0",
|
|
22
|
+
"@effectstream/coroutine": "0.102.0",
|
|
23
|
+
"@effectstream/crypto": "0.102.0",
|
|
24
|
+
"@effectstream/db": "0.102.0",
|
|
25
|
+
"@effectstream/event-client": "0.102.0",
|
|
26
|
+
"@effectstream/log": "0.102.0",
|
|
27
|
+
"@effectstream/utils": "0.102.0",
|
|
28
28
|
"pg": "8.21.0",
|
|
29
29
|
"pg-tx": "^1.0.1",
|
|
30
30
|
"@sinclair/typebox": "0.34.41",
|
package/primitives/Primitive.ts
CHANGED
|
@@ -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 [];
|
|
@@ -33,6 +33,9 @@ export const PrimitiveTypeNEARIntent = "NEAR:Intent" as const;
|
|
|
33
33
|
export const PrimitiveTypeNEARGeneric = "NEAR:Generic" as const;
|
|
34
34
|
export const PrimitiveTypeNEARAccountWatch = "NEAR:AccountWatch" as const;
|
|
35
35
|
|
|
36
|
+
export const PrimitiveTypeSolanaProgramLog = "SOLANA:ProgramLog" as const;
|
|
37
|
+
export const PrimitiveTypeSolanaAccountBalance = "SOLANA:AccountBalance" as const;
|
|
38
|
+
|
|
36
39
|
type BuiltInPrimitives =
|
|
37
40
|
typeof PrimitiveTypeMidnightGeneric |
|
|
38
41
|
typeof PrimitiveTypeMidnightNullifier |
|
|
@@ -58,7 +61,9 @@ type BuiltInPrimitives =
|
|
|
58
61
|
typeof PrimitiveTypeNEARNEP245 |
|
|
59
62
|
typeof PrimitiveTypeNEARIntent |
|
|
60
63
|
typeof PrimitiveTypeNEARGeneric |
|
|
61
|
-
typeof PrimitiveTypeNEARAccountWatch
|
|
64
|
+
typeof PrimitiveTypeNEARAccountWatch |
|
|
65
|
+
typeof PrimitiveTypeSolanaProgramLog |
|
|
66
|
+
typeof PrimitiveTypeSolanaAccountBalance // |
|
|
62
67
|
// typeof PrimitiveTypeEVMGeneric
|
|
63
68
|
;
|
|
64
69
|
|
|
@@ -15,14 +15,18 @@ 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";
|
|
18
20
|
import { mintBurnGrammar } from "./cardano-mint-burn/mint-burn-grammar.ts";
|
|
19
21
|
import { transferGrammar } from "./cardano-transfer/transfer-grammar.ts";
|
|
20
22
|
import { poolDelegationGrammar } from "./cardano-pool-delegation/pool-delegation-grammar.ts";
|
|
21
23
|
import { delayedAssetGrammar } from "./cardano-delayed-asset/delayed-asset-grammar.ts";
|
|
22
24
|
import { projectedNftGrammar } from "./cardano-projected-nft/projected-nft-grammar.ts";
|
|
25
|
+
import { midnightTokenMintGrammar } from "./midnight-token-mint/midnight-token-mint-grammar.ts";
|
|
23
26
|
|
|
24
27
|
export const builtinGrammars = {
|
|
25
28
|
midnightGeneric: midnightGenericGrammar,
|
|
29
|
+
midnightTokenMint: midnightTokenMintGrammar,
|
|
26
30
|
evmErc721: erc721Grammar,
|
|
27
31
|
evmErc20: erc20Grammar,
|
|
28
32
|
availGeneric: availGenericGrammar,
|
|
@@ -36,6 +40,8 @@ export const builtinGrammars = {
|
|
|
36
40
|
nearIntent: nearIntentGrammar,
|
|
37
41
|
nearGeneric: nearGenericGrammar,
|
|
38
42
|
nearAccountWatch: nearAccountWatchGrammar,
|
|
43
|
+
solanaProgramLog: solanaProgramLogGrammar,
|
|
44
|
+
solanaAccountBalance: solanaAccountBalanceGrammar,
|
|
39
45
|
cardanoMintBurn: mintBurnGrammar,
|
|
40
46
|
cardanoTransfer: transferGrammar,
|
|
41
47
|
cardanoPoolDelegation: poolDelegationGrammar,
|
|
@@ -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
|
-
|
|
6
|
-
|
|
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;
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { test, expect } from "bun:test";
|
|
2
|
+
import { run } from "effection";
|
|
3
|
+
import type {
|
|
4
|
+
ConfigSyncProtocolType,
|
|
5
|
+
FlattenSyncProtocolIOFor,
|
|
6
|
+
} from "@effectstream/config";
|
|
7
|
+
// Import via mod.ts (not the primitive file directly) to avoid the
|
|
8
|
+
// primitive ⇄ @effectstream/sm ⇄ mod.ts init cycle — same as erc20-primitive.test.ts.
|
|
9
|
+
import { MidnightTokenMintPrimitive } from "../mod.ts";
|
|
10
|
+
import { PrimitiveRegistry } from "../../PrimitiveRegistry.ts";
|
|
11
|
+
|
|
12
|
+
// Minimal view strategy — the IVM only calls strategy.createView(...).
|
|
13
|
+
const STRATEGY = {
|
|
14
|
+
migrationSuffix: "",
|
|
15
|
+
createView: (name: string, sql: string) => `CREATE VIEW ${name} AS ${sql};`,
|
|
16
|
+
} as any;
|
|
17
|
+
|
|
18
|
+
const MOCK_TX_DATA = {
|
|
19
|
+
output: {
|
|
20
|
+
payload: {
|
|
21
|
+
contractAddress: "0200abcd",
|
|
22
|
+
domainSep: "ab".repeat(32),
|
|
23
|
+
rawTokenType: "cd".repeat(32),
|
|
24
|
+
kind: "shielded",
|
|
25
|
+
amount: "18446744073709551615", // u64 max — exceeds MAX_SAFE_INTEGER
|
|
26
|
+
txHash: "ef".repeat(32),
|
|
27
|
+
entryPoint: "mint",
|
|
28
|
+
},
|
|
29
|
+
},
|
|
30
|
+
} as unknown as FlattenSyncProtocolIOFor<
|
|
31
|
+
ConfigSyncProtocolType.MIDNIGHT_PARALLEL
|
|
32
|
+
>;
|
|
33
|
+
|
|
34
|
+
function cleanup() {
|
|
35
|
+
// The base constructor registers `this` by instanceName and throws on dupes.
|
|
36
|
+
PrimitiveRegistry.primitives = {};
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
async function getPayloadOnce(p: MidnightTokenMintPrimitive) {
|
|
40
|
+
let item: any;
|
|
41
|
+
await run(function* () {
|
|
42
|
+
const result = p.getPayload(123, MOCK_TX_DATA).next().value;
|
|
43
|
+
if (!result || !("isBatched" in result)) {
|
|
44
|
+
throw new Error("No payload generated");
|
|
45
|
+
}
|
|
46
|
+
item = result.data[0];
|
|
47
|
+
});
|
|
48
|
+
return item;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
test("MidnightTokenMint - persist defaults to true and owns its table", () => {
|
|
52
|
+
cleanup();
|
|
53
|
+
const p = new MidnightTokenMintPrimitive({
|
|
54
|
+
instanceName: "tok",
|
|
55
|
+
startBlockHeight: 1,
|
|
56
|
+
stateMachinePrefix: undefined,
|
|
57
|
+
});
|
|
58
|
+
expect(p.persist).toBe(true);
|
|
59
|
+
|
|
60
|
+
const ddl = p.getDynamicTables("tok", STRATEGY);
|
|
61
|
+
expect(ddl).toBeDefined();
|
|
62
|
+
// Owned intermediate table + the trigger on primitive_accounting.
|
|
63
|
+
expect(ddl).toContain("primitives.midnight_token_mint_intermediate_tok");
|
|
64
|
+
expect(ddl).toContain("trigger_update_midnight_token_mint_tok");
|
|
65
|
+
expect(ddl).toContain("effectstream.primitive_accounting");
|
|
66
|
+
expect(p.getViewPrefix()).toContain("midnight_token_mint_view_");
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
test("MidnightTokenMint - persist:false disables the owned table", () => {
|
|
70
|
+
cleanup();
|
|
71
|
+
const p = new MidnightTokenMintPrimitive({
|
|
72
|
+
instanceName: "tok",
|
|
73
|
+
startBlockHeight: 1,
|
|
74
|
+
stateMachinePrefix: undefined,
|
|
75
|
+
persist: false,
|
|
76
|
+
});
|
|
77
|
+
expect(p.persist).toBe(false);
|
|
78
|
+
// No DDL emitted → createDynamicTables skips it → no table/trigger.
|
|
79
|
+
expect(p.getDynamicTables("tok", STRATEGY)).toBeUndefined();
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
test("MidnightTokenMint - hyphenated instance names are sanitized, not rejected", () => {
|
|
83
|
+
cleanup();
|
|
84
|
+
// "Midnight-TokenMint" is the repo's own naming convention. Throwing here
|
|
85
|
+
// killed the sync node at startup ("Invalid name: Midnight-TokenMint").
|
|
86
|
+
const p = new MidnightTokenMintPrimitive({
|
|
87
|
+
instanceName: "Midnight-TokenMint",
|
|
88
|
+
startBlockHeight: 1,
|
|
89
|
+
stateMachinePrefix: "midnightTokenMintState",
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
const ddl = p.getDynamicTables("Midnight-TokenMint", STRATEGY)!;
|
|
93
|
+
expect(ddl).toContain(
|
|
94
|
+
"primitives.midnight_token_mint_view_midnighttokenmint",
|
|
95
|
+
);
|
|
96
|
+
expect(ddl).toContain(
|
|
97
|
+
"primitives.midnight_token_mint_intermediate_midnighttokenmint",
|
|
98
|
+
);
|
|
99
|
+
// No hyphen may survive into an SQL identifier.
|
|
100
|
+
expect(ddl).not.toContain("midnight_token_mint_view_midnight-tokenmint");
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
test("MidnightTokenMint - a quote in the name is escaped in the trigger literal", () => {
|
|
104
|
+
cleanup();
|
|
105
|
+
// The name is stripped for identifiers but compared as a string literal in
|
|
106
|
+
// the trigger body, where a bare `'` would emit unparseable DDL.
|
|
107
|
+
const p = new MidnightTokenMintPrimitive({
|
|
108
|
+
instanceName: "Bob's-Mints",
|
|
109
|
+
startBlockHeight: 1,
|
|
110
|
+
stateMachinePrefix: undefined,
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
const ddl = p.getDynamicTables("Bob's-Mints", STRATEGY)!;
|
|
114
|
+
expect(ddl).toContain("NEW.primitive_name = 'Bob''s-Mints'");
|
|
115
|
+
expect(ddl).toContain("midnight_token_mint_view_bobsmints");
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
test("MidnightTokenMint - owning a table does not suppress the STM input", async () => {
|
|
119
|
+
cleanup();
|
|
120
|
+
const p = new MidnightTokenMintPrimitive({
|
|
121
|
+
instanceName: "tok",
|
|
122
|
+
startBlockHeight: 1,
|
|
123
|
+
stateMachinePrefix: "midnightTokenMintState",
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
// Both paths are live at once: owned table DDL *and* an STM payload.
|
|
127
|
+
expect(p.getDynamicTables("tok", STRATEGY)).toBeDefined();
|
|
128
|
+
expect(p.getConfig().scheduledPrefix).toBe("midnightTokenMintState");
|
|
129
|
+
|
|
130
|
+
const item = await getPayloadOnce(p);
|
|
131
|
+
expect(Array.isArray(item.stateMachinePayload)).toBe(true);
|
|
132
|
+
expect(item.stateMachinePayload[0]).toBe("midnightTokenMintState");
|
|
133
|
+
// Flat fields, in grammar order, so the STM handler reads them by name.
|
|
134
|
+
expect(item.accountingPayload.rawTokenType).toBe("cd".repeat(32));
|
|
135
|
+
expect(item.accountingPayload.amount).toBe("18446744073709551615");
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
test("MidnightTokenMint - no prefix means accounting only (opt-out is explicit)", async () => {
|
|
139
|
+
cleanup();
|
|
140
|
+
const p = new MidnightTokenMintPrimitive({
|
|
141
|
+
instanceName: "tok",
|
|
142
|
+
startBlockHeight: 1,
|
|
143
|
+
stateMachinePrefix: undefined,
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
const item = await getPayloadOnce(p);
|
|
147
|
+
expect(item.stateMachinePayload).toBe(null);
|
|
148
|
+
// The accounting row (and therefore the owned table) is still written.
|
|
149
|
+
expect(item.accountingPayload.rawTokenType).toBe("cd".repeat(32));
|
|
150
|
+
});
|
|
@@ -18,31 +18,50 @@ import type {
|
|
|
18
18
|
import type { SyncStateUpdateStream } from "@effectstream/coroutine";
|
|
19
19
|
import { PrimitiveTypeMidnightTokenMint } from "../builtin.ts";
|
|
20
20
|
import { midnightTokenMintGrammar } from "./midnight-token-mint-grammar.ts";
|
|
21
|
+
import {
|
|
22
|
+
MIDNIGHT_TOKEN_MINT_INTERMEDIATE_PREFIX,
|
|
23
|
+
MIDNIGHT_TOKEN_MINT_VIEW_PREFIX,
|
|
24
|
+
midnightTokenMintIvm,
|
|
25
|
+
} from "./midnight-token-mint-ivm.ts";
|
|
21
26
|
|
|
22
27
|
/**
|
|
23
28
|
* MidnightTokenMintPrimitive
|
|
24
29
|
*
|
|
25
|
-
* Watches custom token *mints* on the Midnight ledger
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* emits one state-machine input per `(tx, call, domainSep, kind)` — only
|
|
33
|
-
* for effects that actually applied on chain (failed segments roll back).
|
|
30
|
+
* Watches custom token *mints* on the Midnight ledger and maps a token id
|
|
31
|
+
* ("color") back to the contract that minted it — the mapping wallets cannot
|
|
32
|
+
* provide. A contract call's effects record mints as `domain_sep → amount`
|
|
33
|
+
* maps (shielded and unshielded); the token type is
|
|
34
|
+
* `rawTokenType(domain_sep, contract_address)`. The fetcher deserializes each
|
|
35
|
+
* regular transaction with ledger-v8, walks the contract calls, and emits one
|
|
36
|
+
* event per `(tx, call, domainSep, kind)`.
|
|
34
37
|
*
|
|
35
|
-
* The
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
+
* The primitive OWNS its registry table: `dynamicTables` declares
|
|
39
|
+
* `primitives.midnight_token_mint_view_<instance>` (maintained by a trigger on
|
|
40
|
+
* effectstream.primitive_accounting), so a consumer gets the registry with
|
|
41
|
+
* only an `.addPrimitive(...)` line — no state-machine handler, grammar entry,
|
|
42
|
+
* or migration. Set `persist: false` in config to skip the owned table on a
|
|
43
|
+
* fresh database (the accounting row is still written; useful when a consumer
|
|
44
|
+
* wants to handle the data itself or skip it) — see the flag's own docs for why
|
|
45
|
+
* it does not tear down a table an earlier run already created.
|
|
38
46
|
*
|
|
39
|
-
*
|
|
47
|
+
* The owned table does NOT replace the state machine: the two paths are
|
|
48
|
+
* independent and run together. Whenever `stateMachinePrefix` is set the
|
|
49
|
+
* primitive still emits an STM input for every mint, exactly as it would
|
|
50
|
+
* without an owned table — the registry is the read model, the STM handler is
|
|
51
|
+
* where app-specific logic lives. Pass `stateMachinePrefix: undefined` to opt
|
|
52
|
+
* out explicitly (the flag is a required config key so the choice is never
|
|
53
|
+
* made by omission).
|
|
54
|
+
*
|
|
55
|
+
* Usage (STM path, in addition to the owned view):
|
|
56
|
+
* grammar: { myPrefix: builtinGrammars.midnightTokenMint }
|
|
40
57
|
* stm.addStateTransition("myPrefix", function* (data) {
|
|
41
|
-
* const {
|
|
42
|
-
*
|
|
43
|
-
* // kind: "shielded" | "unshielded", amount, entryPoint }
|
|
58
|
+
* const { rawTokenType, kind, contractAddress, domainSep, amount, txHash }
|
|
59
|
+
* = data.parsedInput;
|
|
44
60
|
* // amount is a decimal string (u64 mints can exceed MAX_SAFE_INTEGER)
|
|
45
61
|
* });
|
|
62
|
+
*
|
|
63
|
+
* The mint nonce is NOT part of token identity (it only randomizes coin
|
|
64
|
+
* commitments) and is never public for shielded mints, so it is not recorded.
|
|
46
65
|
*/
|
|
47
66
|
export class MidnightTokenMintPrimitive extends Primitive<
|
|
48
67
|
ConfigSyncProtocolType.MIDNIGHT_PARALLEL,
|
|
@@ -51,20 +70,42 @@ export class MidnightTokenMintPrimitive extends Primitive<
|
|
|
51
70
|
readonly internalTypeName = PrimitiveTypeMidnightTokenMint;
|
|
52
71
|
override readonly grammar = midnightTokenMintGrammar;
|
|
53
72
|
|
|
54
|
-
|
|
73
|
+
/**
|
|
74
|
+
* When true (default) the primitive owns + populates its registry table.
|
|
75
|
+
*
|
|
76
|
+
* Only affects whether the DDL is emitted, and the DDL is applied once per
|
|
77
|
+
* instance behind a migration row with no down path — so flipping this to
|
|
78
|
+
* `false` on a database that already ran with `true` leaves the table and its
|
|
79
|
+
* trigger in place, still accumulating. It skips the table on a fresh
|
|
80
|
+
* database; it is not a runtime off switch.
|
|
81
|
+
*/
|
|
82
|
+
readonly persist: boolean;
|
|
83
|
+
|
|
84
|
+
// Owned table — gated by `persist`. When disabled, no DDL is emitted, so no
|
|
85
|
+
// table/trigger is created and nothing is consolidated (accounting only).
|
|
86
|
+
override dynamicTables = (
|
|
87
|
+
name: string,
|
|
88
|
+
strategy: Parameters<typeof midnightTokenMintIvm>[1],
|
|
89
|
+
): string | undefined =>
|
|
90
|
+
this.persist ? midnightTokenMintIvm(name, strategy) : undefined;
|
|
91
|
+
|
|
55
92
|
override getIntermediatePrefix(): string[] {
|
|
56
|
-
return [];
|
|
93
|
+
return [MIDNIGHT_TOKEN_MINT_INTERMEDIATE_PREFIX];
|
|
57
94
|
}
|
|
58
95
|
override getViewPrefix(): string[] {
|
|
59
|
-
return [];
|
|
96
|
+
return [MIDNIGHT_TOKEN_MINT_VIEW_PREFIX];
|
|
60
97
|
}
|
|
61
98
|
|
|
62
99
|
constructor(config: {
|
|
63
100
|
instanceName: string;
|
|
64
101
|
startBlockHeight: number;
|
|
65
|
-
|
|
102
|
+
// Required key (may be `undefined`) like every other primitive: owning a
|
|
103
|
+
// table is not a reason to skip the STM, so opting out has to be deliberate.
|
|
104
|
+
stateMachinePrefix: string | undefined;
|
|
105
|
+
persist?: boolean;
|
|
66
106
|
}) {
|
|
67
107
|
super(config);
|
|
108
|
+
this.persist = config.persist ?? true;
|
|
68
109
|
}
|
|
69
110
|
|
|
70
111
|
override *getPayload(
|
|
@@ -82,10 +123,26 @@ export class MidnightTokenMintPrimitive extends Primitive<
|
|
|
82
123
|
accountingPayload: ParamToData<typeof midnightTokenMintGrammar>;
|
|
83
124
|
}[];
|
|
84
125
|
}> {
|
|
85
|
-
const
|
|
126
|
+
const p = primitiveTransactionData.output.payload as {
|
|
127
|
+
contractAddress: string;
|
|
128
|
+
domainSep: string;
|
|
129
|
+
rawTokenType: string;
|
|
130
|
+
kind: string;
|
|
131
|
+
amount: string;
|
|
132
|
+
txHash: string;
|
|
133
|
+
entryPoint?: string;
|
|
134
|
+
};
|
|
86
135
|
|
|
136
|
+
// Flat accounting payload so the owned-table trigger reads columns via
|
|
137
|
+
// payload->>'field' (matches ERC20/NEP141).
|
|
87
138
|
const accountingPayload: ParamToData<typeof this.grammar> = {
|
|
88
|
-
|
|
139
|
+
contractAddress: p.contractAddress,
|
|
140
|
+
domainSep: p.domainSep,
|
|
141
|
+
rawTokenType: p.rawTokenType,
|
|
142
|
+
kind: p.kind,
|
|
143
|
+
amount: p.amount,
|
|
144
|
+
txHash: p.txHash,
|
|
145
|
+
entryPoint: p.entryPoint ?? "",
|
|
89
146
|
};
|
|
90
147
|
|
|
91
148
|
const stateMachinePayload:
|
|
@@ -120,7 +177,7 @@ export class MidnightTokenMintPrimitive extends Primitive<
|
|
|
120
177
|
name: this.instanceName,
|
|
121
178
|
type: this.internalTypeName,
|
|
122
179
|
startBlockHeight: this.startBlockHeight,
|
|
123
|
-
scheduledPrefix: this.stateMachinePrefix
|
|
180
|
+
scheduledPrefix: this.stateMachinePrefix,
|
|
124
181
|
} as const;
|
|
125
182
|
}
|
|
126
183
|
}
|
package/primitives/src/mod.ts
CHANGED
|
@@ -19,6 +19,8 @@ import {
|
|
|
19
19
|
PrimitiveTypeNEARIntent,
|
|
20
20
|
PrimitiveTypeNEARGeneric,
|
|
21
21
|
PrimitiveTypeNEARAccountWatch,
|
|
22
|
+
PrimitiveTypeSolanaProgramLog,
|
|
23
|
+
PrimitiveTypeSolanaAccountBalance,
|
|
22
24
|
PrimitiveTypeCardanoMintBurn,
|
|
23
25
|
PrimitiveTypeCardanoTransfer,
|
|
24
26
|
PrimitiveTypeCardanoPoolDelegation,
|
|
@@ -47,6 +49,8 @@ import { Nep245Primitive } from "./near-nep245/nep245-primitive.ts";
|
|
|
47
49
|
import { NearIntentPrimitive } from "./near-intent/near-intent-primitive.ts";
|
|
48
50
|
import { NearGenericPrimitive } from "./near-generic/near-generic-primitive.ts";
|
|
49
51
|
import { NearAccountWatchPrimitive } from "./near-account-watch/near-account-watch-primitive.ts";
|
|
52
|
+
import { SolanaProgramLogPrimitive } from "./solana-program-log/solana-program-log-primitive.ts";
|
|
53
|
+
import { SolanaAccountBalancePrimitive } from "./solana-account-balance/solana-account-balance-primitive.ts";
|
|
50
54
|
import { CardanoMintBurnPrimitive } from "./cardano-mint-burn/mint-burn-primitive.ts";
|
|
51
55
|
import { CardanoTransferPrimitive } from "./cardano-transfer/transfer-primitive.ts";
|
|
52
56
|
import { CardanoPoolDelegationPrimitive } from "./cardano-pool-delegation/pool-delegation-primitive.ts";
|
|
@@ -75,6 +79,8 @@ const builtInPrimitivesMap = {
|
|
|
75
79
|
[PrimitiveTypeNEARIntent]: NearIntentPrimitive,
|
|
76
80
|
[PrimitiveTypeNEARGeneric]: NearGenericPrimitive,
|
|
77
81
|
[PrimitiveTypeNEARAccountWatch]: NearAccountWatchPrimitive,
|
|
82
|
+
[PrimitiveTypeSolanaProgramLog]: SolanaProgramLogPrimitive,
|
|
83
|
+
[PrimitiveTypeSolanaAccountBalance]: SolanaAccountBalancePrimitive,
|
|
78
84
|
[PrimitiveTypeCardanoMintBurn]: CardanoMintBurnPrimitive,
|
|
79
85
|
[PrimitiveTypeCardanoTransfer]: CardanoTransferPrimitive,
|
|
80
86
|
[PrimitiveTypeCardanoPoolDelegation]: CardanoPoolDelegationPrimitive,
|
|
@@ -108,6 +114,8 @@ export {
|
|
|
108
114
|
NearIntentPrimitive,
|
|
109
115
|
NearGenericPrimitive,
|
|
110
116
|
NearAccountWatchPrimitive,
|
|
117
|
+
SolanaProgramLogPrimitive,
|
|
118
|
+
SolanaAccountBalancePrimitive,
|
|
111
119
|
CardanoMintBurnPrimitive,
|
|
112
120
|
CardanoTransferPrimitive,
|
|
113
121
|
CardanoPoolDelegationPrimitive,
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { StaticDecode } from "@sinclair/typebox";
|
|
2
|
+
import type {
|
|
3
|
+
ConfigSyncProtocolType,
|
|
4
|
+
FlattenSyncProtocolIOFor,
|
|
5
|
+
ProtocolPrimitiveMap,
|
|
6
|
+
} from "@effectstream/config";
|
|
7
|
+
import {
|
|
8
|
+
type AddressAndType,
|
|
9
|
+
AddressType,
|
|
10
|
+
type EffectstreamBlockNumber,
|
|
11
|
+
} from "@effectstream/utils";
|
|
12
|
+
import { type JsonObject, Primitive } from "@effectstream/sm";
|
|
13
|
+
import {
|
|
14
|
+
type CommandTuple,
|
|
15
|
+
generateRawStmInput,
|
|
16
|
+
type ParamToData,
|
|
17
|
+
} from "@effectstream/concise";
|
|
18
|
+
import type { StateUpdateStream } from "@effectstream/coroutine";
|
|
19
|
+
import { solanaAccountBalanceGrammar } from "./solana-account-balance-grammar.ts";
|
|
20
|
+
import { PrimitiveTypeSolanaAccountBalance } from "../builtin.ts";
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Built-in primitive: tracks the lamport balance of a watched `address` per
|
|
24
|
+
* slot (derived from a transaction's postBalances by SolanaFetcher.readPrimitives).
|
|
25
|
+
*/
|
|
26
|
+
export class SolanaAccountBalancePrimitive extends Primitive<
|
|
27
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL,
|
|
28
|
+
typeof solanaAccountBalanceGrammar
|
|
29
|
+
> {
|
|
30
|
+
readonly internalTypeName = PrimitiveTypeSolanaAccountBalance;
|
|
31
|
+
override grammar = solanaAccountBalanceGrammar;
|
|
32
|
+
readonly address: string;
|
|
33
|
+
|
|
34
|
+
constructor(config: {
|
|
35
|
+
instanceName: string;
|
|
36
|
+
startBlockHeight: number;
|
|
37
|
+
address: string;
|
|
38
|
+
stateMachinePrefix: string | undefined;
|
|
39
|
+
}) {
|
|
40
|
+
super(config);
|
|
41
|
+
this.address = config.address;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
override *getPayload(
|
|
45
|
+
_: EffectstreamBlockNumber,
|
|
46
|
+
primitiveTransactionData: FlattenSyncProtocolIOFor<
|
|
47
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
48
|
+
>,
|
|
49
|
+
): StateUpdateStream<{
|
|
50
|
+
isBatched: boolean;
|
|
51
|
+
data: {
|
|
52
|
+
fromAddressAndType: AddressAndType;
|
|
53
|
+
stateMachinePayload:
|
|
54
|
+
| StaticDecode<CommandTuple<string, typeof solanaAccountBalanceGrammar>>
|
|
55
|
+
| null;
|
|
56
|
+
accountingPayload: JsonObject;
|
|
57
|
+
}[];
|
|
58
|
+
}> {
|
|
59
|
+
const payload = primitiveTransactionData.output.payload as {
|
|
60
|
+
address?: string;
|
|
61
|
+
lamports?: number;
|
|
62
|
+
slot?: number;
|
|
63
|
+
};
|
|
64
|
+
const address = String(payload.address ?? this.address);
|
|
65
|
+
const lamports = Number(payload.lamports ?? 0);
|
|
66
|
+
const slot = Number(payload.slot ?? 0);
|
|
67
|
+
|
|
68
|
+
const accountingPayload: ParamToData<typeof solanaAccountBalanceGrammar> = {
|
|
69
|
+
address,
|
|
70
|
+
lamports,
|
|
71
|
+
slot,
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
const stateMachinePayload = this.stateMachinePrefix
|
|
75
|
+
? generateRawStmInput(
|
|
76
|
+
this.grammar,
|
|
77
|
+
this.stateMachinePrefix,
|
|
78
|
+
accountingPayload,
|
|
79
|
+
)
|
|
80
|
+
: null;
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
isBatched: false,
|
|
84
|
+
data: [
|
|
85
|
+
{
|
|
86
|
+
fromAddressAndType: {
|
|
87
|
+
type: AddressType.SOLANA,
|
|
88
|
+
address,
|
|
89
|
+
},
|
|
90
|
+
accountingPayload,
|
|
91
|
+
stateMachinePayload,
|
|
92
|
+
},
|
|
93
|
+
],
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
override getConfig(): ProtocolPrimitiveMap[
|
|
98
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
99
|
+
] {
|
|
100
|
+
return {
|
|
101
|
+
name: this.instanceName,
|
|
102
|
+
type: this.internalTypeName,
|
|
103
|
+
startBlockHeight: this.startBlockHeight,
|
|
104
|
+
address: this.address,
|
|
105
|
+
scheduledPrefix: this.stateMachinePrefix,
|
|
106
|
+
} as ProtocolPrimitiveMap[ConfigSyncProtocolType.SOLANA_RPC_PARALLEL];
|
|
107
|
+
}
|
|
108
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { test, expect } from "bun:test";
|
|
2
|
+
import { run } from "effection";
|
|
3
|
+
import type { ConfigSyncProtocolType, FlattenSyncProtocolIOFor } from "@effectstream/config";
|
|
4
|
+
import { SolanaProgramLogPrimitive } from "./../mod.ts";
|
|
5
|
+
import { PrimitiveRegistry } from "../../PrimitiveRegistry.ts";
|
|
6
|
+
|
|
7
|
+
const PROGRAM_ID = "11111111111111111111111111111111";
|
|
8
|
+
const PrimitiveTypeSolanaProgramLog = "SOLANA:ProgramLog";
|
|
9
|
+
|
|
10
|
+
function cleanup() {
|
|
11
|
+
PrimitiveRegistry.primitives = {};
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
test("SolanaProgramLogPrimitive - initializes correctly", () => {
|
|
15
|
+
cleanup();
|
|
16
|
+
const primitive = new SolanaProgramLogPrimitive({
|
|
17
|
+
instanceName: "spl",
|
|
18
|
+
startBlockHeight: 0,
|
|
19
|
+
programId: PROGRAM_ID,
|
|
20
|
+
stateMachinePrefix: "solana-program-log",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
expect(primitive.instanceName).toEqual("spl");
|
|
24
|
+
expect(primitive.startBlockHeight).toEqual(0);
|
|
25
|
+
expect(primitive.programId).toEqual(PROGRAM_ID);
|
|
26
|
+
expect(primitive.internalTypeName).toEqual(PrimitiveTypeSolanaProgramLog);
|
|
27
|
+
|
|
28
|
+
const config = primitive.getConfig();
|
|
29
|
+
expect(config.name).toEqual("spl");
|
|
30
|
+
expect(config.type).toEqual(PrimitiveTypeSolanaProgramLog);
|
|
31
|
+
expect(config.programId).toEqual(PROGRAM_ID);
|
|
32
|
+
expect(config.scheduledPrefix).toEqual("solana-program-log");
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
test("SolanaProgramLogPrimitive - getPayload generates correct state update", async () => {
|
|
36
|
+
cleanup();
|
|
37
|
+
const primitive = new SolanaProgramLogPrimitive({
|
|
38
|
+
instanceName: "spl",
|
|
39
|
+
startBlockHeight: 0,
|
|
40
|
+
programId: PROGRAM_ID,
|
|
41
|
+
stateMachinePrefix: "solana-program-log",
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
const mockTxData = {
|
|
45
|
+
syncProtocol: {
|
|
46
|
+
name: "parallelSolanaRPC",
|
|
47
|
+
blockNumber: 42,
|
|
48
|
+
transactionHash: "5x…signature",
|
|
49
|
+
contractAddress: PROGRAM_ID,
|
|
50
|
+
},
|
|
51
|
+
output: {
|
|
52
|
+
payloadType: "solana:transaction",
|
|
53
|
+
payload: {
|
|
54
|
+
programId: PROGRAM_ID,
|
|
55
|
+
slot: 42,
|
|
56
|
+
logMessages: ["Program log: hi", "Program log: bye"],
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
} as unknown as FlattenSyncProtocolIOFor<
|
|
60
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
61
|
+
>;
|
|
62
|
+
|
|
63
|
+
await run(function* () {
|
|
64
|
+
const generator = primitive.getPayload(123, mockTxData);
|
|
65
|
+
const result = generator.next().value;
|
|
66
|
+
|
|
67
|
+
if (!result) throw new Error("No payload generated");
|
|
68
|
+
if (!("isBatched" in result)) {
|
|
69
|
+
throw new Error("Result is not a SyncStateUpdate");
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
expect(result.isBatched).toEqual(false);
|
|
73
|
+
expect(result.data.length).toEqual(1);
|
|
74
|
+
|
|
75
|
+
const item = result.data[0];
|
|
76
|
+
expect(item.accountingPayload.slot).toEqual(42);
|
|
77
|
+
expect(item.accountingPayload.programId).toEqual(PROGRAM_ID);
|
|
78
|
+
expect(item.accountingPayload.logMessages).toEqual([
|
|
79
|
+
"Program log: hi",
|
|
80
|
+
"Program log: bye",
|
|
81
|
+
]);
|
|
82
|
+
|
|
83
|
+
expect(Array.isArray(item.stateMachinePayload)).toEqual(true);
|
|
84
|
+
// @ts-ignore: safe to access
|
|
85
|
+
expect(item.stateMachinePayload?.[0]).toEqual("solana-program-log");
|
|
86
|
+
});
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
test("SolanaProgramLogPrimitive - getPayload skips state machine payload if no prefix", async () => {
|
|
90
|
+
cleanup();
|
|
91
|
+
const primitive = new SolanaProgramLogPrimitive({
|
|
92
|
+
instanceName: "spl",
|
|
93
|
+
startBlockHeight: 0,
|
|
94
|
+
programId: PROGRAM_ID,
|
|
95
|
+
stateMachinePrefix: undefined,
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
const mockTxData = {
|
|
99
|
+
syncProtocol: {
|
|
100
|
+
name: "parallelSolanaRPC",
|
|
101
|
+
blockNumber: 7,
|
|
102
|
+
transactionHash: "sig",
|
|
103
|
+
contractAddress: PROGRAM_ID,
|
|
104
|
+
},
|
|
105
|
+
output: {
|
|
106
|
+
payload: {
|
|
107
|
+
programId: PROGRAM_ID,
|
|
108
|
+
slot: 7,
|
|
109
|
+
logMessages: ["Program log: x"],
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
} as unknown as FlattenSyncProtocolIOFor<
|
|
113
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
114
|
+
>;
|
|
115
|
+
|
|
116
|
+
await run(function* () {
|
|
117
|
+
const generator = primitive.getPayload(123, mockTxData);
|
|
118
|
+
const result = generator.next().value;
|
|
119
|
+
|
|
120
|
+
if (!result) throw new Error("No payload generated");
|
|
121
|
+
if (!("isBatched" in result)) {
|
|
122
|
+
throw new Error("Result is not a SyncStateUpdate");
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
const item = result.data[0];
|
|
126
|
+
expect(item.stateMachinePayload).toEqual(null);
|
|
127
|
+
});
|
|
128
|
+
});
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { StaticDecode } from "@sinclair/typebox";
|
|
2
|
+
import {
|
|
3
|
+
type ConfigSyncProtocolType,
|
|
4
|
+
type FlattenSyncProtocolIOFor,
|
|
5
|
+
type ProtocolPrimitiveMap,
|
|
6
|
+
} from "@effectstream/config";
|
|
7
|
+
import {
|
|
8
|
+
type AddressAndType,
|
|
9
|
+
AddressType,
|
|
10
|
+
type EffectstreamBlockNumber,
|
|
11
|
+
} from "@effectstream/utils";
|
|
12
|
+
import { type JsonObject, Primitive } from "@effectstream/sm";
|
|
13
|
+
import {
|
|
14
|
+
type CommandTuple,
|
|
15
|
+
generateRawStmInput,
|
|
16
|
+
type ParamToData,
|
|
17
|
+
} from "@effectstream/concise";
|
|
18
|
+
import type { StateUpdateStream } from "@effectstream/coroutine";
|
|
19
|
+
import { solanaProgramLogGrammar } from "./solana-program-log-grammar.ts";
|
|
20
|
+
import { PrimitiveTypeSolanaProgramLog } from "../builtin.ts";
|
|
21
|
+
|
|
22
|
+
export class SolanaProgramLogPrimitive extends Primitive<
|
|
23
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL,
|
|
24
|
+
typeof solanaProgramLogGrammar
|
|
25
|
+
> {
|
|
26
|
+
readonly internalTypeName = PrimitiveTypeSolanaProgramLog;
|
|
27
|
+
override grammar = solanaProgramLogGrammar;
|
|
28
|
+
readonly programId: string;
|
|
29
|
+
readonly eventType: string | undefined;
|
|
30
|
+
|
|
31
|
+
constructor(config: {
|
|
32
|
+
instanceName: string;
|
|
33
|
+
startBlockHeight: number;
|
|
34
|
+
programId: string;
|
|
35
|
+
eventType?: string;
|
|
36
|
+
stateMachinePrefix: string | undefined;
|
|
37
|
+
}) {
|
|
38
|
+
super(config);
|
|
39
|
+
this.programId = config.programId;
|
|
40
|
+
this.eventType = config.eventType;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
override *getPayload(
|
|
44
|
+
_: EffectstreamBlockNumber,
|
|
45
|
+
primitiveTransactionData: FlattenSyncProtocolIOFor<
|
|
46
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
47
|
+
>,
|
|
48
|
+
): StateUpdateStream<{
|
|
49
|
+
isBatched: boolean;
|
|
50
|
+
data: {
|
|
51
|
+
fromAddressAndType: AddressAndType;
|
|
52
|
+
stateMachinePayload:
|
|
53
|
+
| StaticDecode<CommandTuple<string, typeof solanaProgramLogGrammar>>
|
|
54
|
+
| null;
|
|
55
|
+
accountingPayload: JsonObject;
|
|
56
|
+
}[];
|
|
57
|
+
}> {
|
|
58
|
+
const { programId, slot, logMessages } =
|
|
59
|
+
primitiveTransactionData.output.payload as {
|
|
60
|
+
programId: string;
|
|
61
|
+
slot: number;
|
|
62
|
+
logMessages: string[];
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
const accountingPayload: ParamToData<typeof solanaProgramLogGrammar> = {
|
|
66
|
+
slot,
|
|
67
|
+
programId,
|
|
68
|
+
logMessages,
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
const stateMachinePayload = this.stateMachinePrefix
|
|
72
|
+
? generateRawStmInput(
|
|
73
|
+
this.grammar,
|
|
74
|
+
this.stateMachinePrefix,
|
|
75
|
+
accountingPayload,
|
|
76
|
+
)
|
|
77
|
+
: null;
|
|
78
|
+
|
|
79
|
+
return {
|
|
80
|
+
isBatched: false,
|
|
81
|
+
data: [
|
|
82
|
+
{
|
|
83
|
+
fromAddressAndType: {
|
|
84
|
+
type: AddressType.SOLANA,
|
|
85
|
+
address: String(
|
|
86
|
+
primitiveTransactionData.syncProtocol.contractAddress ?? "",
|
|
87
|
+
),
|
|
88
|
+
},
|
|
89
|
+
accountingPayload,
|
|
90
|
+
stateMachinePayload,
|
|
91
|
+
},
|
|
92
|
+
],
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
override getConfig(): ProtocolPrimitiveMap[
|
|
97
|
+
ConfigSyncProtocolType.SOLANA_RPC_PARALLEL
|
|
98
|
+
] {
|
|
99
|
+
return {
|
|
100
|
+
name: this.instanceName,
|
|
101
|
+
type: this.internalTypeName,
|
|
102
|
+
startBlockHeight: this.startBlockHeight,
|
|
103
|
+
programId: this.programId,
|
|
104
|
+
eventType: this.eventType,
|
|
105
|
+
scheduledPrefix: this.stateMachinePrefix,
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
}
|