ThreeDNS DNSRecordChanged Parsing #697
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: f5c624c The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
…nd implicit resolver association
tk-o
reviewed
May 12, 2025
Comment on lines
332
to
393
| // subgraph ignores this event | ||
| if (pluginName === PluginName.Subgraph) return; | ||
|
|
||
| // but for non-subgraph plugins, we parse the RR set data for relevant records | ||
| const { node, name, resource, record } = event.args; | ||
|
|
||
| // we only index TXT records (resource id 16) | ||
| if (resource !== 16) return; | ||
|
|
||
| // parse the record's name, which is the key of the DNS record | ||
| const [, recordName] = decodeDNSPacketBytes(hexToBytes(name)); | ||
|
|
||
| // invariant: recordName is always available and parsed correctly | ||
| if (!recordName) throw new Error(`Invalid DNSPacket, cannot parse name '${name}'.`); | ||
|
|
||
| // relevant keys end with .ens | ||
| if (!recordName.endsWith(".ens")) return; | ||
|
|
||
| // trim the .ens off the end to match ENS record naming | ||
| const key = recordName.slice(0, -4); | ||
|
|
||
| // parse the `record` parameter, which is an RRSet describing the value of the DNS record | ||
| const answers = parseRRSet(record); | ||
| for (const answer of answers) { | ||
| switch (answer.type) { | ||
| case "TXT": { | ||
| // > When decoding, the return value will always be an array of Buffer. | ||
| // https://github.com/mafintosh/dns-packet | ||
| const value = decodeTXTData(answer.data as Buffer[]); | ||
|
|
||
| const id = makeResolverId(event.log.address, node); | ||
| const resolver = await upsertResolver(context, { | ||
| id, | ||
| domainId: node, | ||
| address: event.log.address, | ||
| }); | ||
|
|
||
| // upsert new key | ||
| await context.db | ||
| .update(schema.resolver, { id }) | ||
| .set({ texts: uniq([...(resolver.texts ?? []), key]) }); | ||
|
|
||
| // log ResolverEvent | ||
| await context.db.insert(schema.textChanged).values({ | ||
| ...sharedEventValues(context.network.chainId, event), | ||
| resolverId: id, | ||
| key, | ||
| // note: coalesce empty string to null, see `handleTextChanged` for context | ||
| value: value || null, | ||
| }); | ||
| break; | ||
| } | ||
| default: { | ||
| // no-op unhandled records | ||
| // NOTE: should never occur due to resource id check above | ||
| console.warn( | ||
| `Invariant: received answer ${JSON.stringify(answer)} that is not type === TXT despite resource === 16 check!`, | ||
| ); | ||
| break; | ||
| } | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Making exceptions based on the plugin makes me think we could inject the new logic behind an interface from a particular plugin. Meaning, the subgraph plugin would implement a no-op for that interface, and both basenames and lineanames would implement the interface with the exact logic you proposed above.
Thoughts on that approach?
Collaborator
Author
There was a problem hiding this comment.
now that we have the tooling to confirm that subgraph compatibility isn't affected by changes to the shared handlers, i'm less worried about including per-plugin logic here
0xBison
reviewed
May 12, 2025
0xBison
reviewed
May 12, 2025
0xBison
reviewed
May 12, 2025
tk-o
reviewed
May 12, 2025
Comment on lines
407
to
445
| // subgraph ignores this event | ||
| if (pluginName === PluginName.Subgraph) return; | ||
|
|
||
| const { node, name, resource } = event.args; | ||
|
|
||
| // we only index TXT records (resource id 16) | ||
| if (resource !== 16) return; | ||
|
|
||
| // parse the record's name, which is the key of the DNS record | ||
| const [, recordName] = decodeDNSPacketBytes(hexToBytes(name)); | ||
|
|
||
| // invariant: recordName is always available and parsed correctly | ||
| if (!recordName) throw new Error(`Invalid DNSPacket, cannot parse name '${name}'.`); | ||
|
|
||
| // relevant keys end with .ens | ||
| if (!recordName.endsWith(".ens")) return; | ||
|
|
||
| // trim the .ens off the end to match ENS record naming | ||
| const key = recordName.slice(0, -4); | ||
|
|
||
| const id = makeResolverId(event.log.address, node); | ||
| const resolver = await upsertResolver(context, { | ||
| id, | ||
| domainId: node, | ||
| address: event.log.address, | ||
| }); | ||
|
|
||
| // remove relevant key | ||
| await context.db | ||
| .update(schema.resolver, { id }) | ||
| .set({ texts: (resolver.texts ?? []).filter((text) => text !== key) }); | ||
|
|
||
| // log ResolverEvent | ||
| await context.db.insert(schema.textChanged).values({ | ||
| ...sharedEventValues(context.network.chainId, event), | ||
| resolverId: id, | ||
| key, | ||
| value: null, | ||
| }); |
Contributor
There was a problem hiding this comment.
Making exceptions based on the plugin makes me think we could inject the new logic behind an interface from a particular plugin. Meaning, the subgraph plugin would implement a no-op for that interface, and both basenames and lineanames would implement the interface with the exact logic you proposed above.
Thoughts on that approach?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #678
the threedns resolvers don't emit
TextChanged, they emitDNSRecordChangedwhich we previously didn't parse. this implements RRSet parsing to bring the behavior in-line with the other plugins'