solana: add HashMap and HashSet types support

common/changes/@subsquid/borsh/borsh-hashmap_2025-01-15-14-29.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@subsquid/borsh",
+      "comment": "implement HashMap and HashSet codecs",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@subsquid/borsh"
+}

common/changes/@subsquid/solana-typegen/borsh-hashmap_2025-01-15-14-29.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@subsquid/solana-typegen",
+      "comment": "add HashMap and HashSet types support",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@subsquid/solana-typegen"
+}

solana/borsh/src/codecs/hash-map.ts

@@ -0,0 +1,27 @@
+import {Codec} from '../codec'
+import {Sink} from '../sink'
+import {Src} from '../src'
+
+
+export class HashMapCodec<K, V> implements Codec<Map<K, V>> {
+    constructor(public readonly key: Codec<K>, public readonly value: Codec<V>) {}
+
+    encode(sink: Sink, val: Map<K, V>): void {
+        sink.u32(val.size)
+        for (let [key, value] of val) {
+            this.key.encode(sink, key)
+            this.value.encode(sink, value)
+        }
+    }
+
+    decode(src: Src): Map<K, V> {
+        let len = src.u32()
+        let res = new Map<K, V>()
+        for (let i = 0; i < len; i++) {
+            let key = this.key.decode(src)
+            let value = this.value.decode(src)
+            res.set(key, value)
+        }
+        return res
+    }
+}

solana/borsh/src/codecs/hash-set.ts

@@ -0,0 +1,25 @@
+import {Codec} from '../codec'
+import {Sink} from '../sink'
+import {Src} from '../src'
+
+
+export class HashSetCodec<T> implements Codec<Set<T>> {
+    constructor(public readonly item: Codec<T>) {}
+
+    encode(sink: Sink, val: Set<T>): void {
+        sink.u32(val.size)
+        for (let value of val) {
+            this.item.encode(sink, value)
+        }
+    }
+
+    decode(src: Src): Set<T> {
+        let len = src.u32()
+        let res = new Set<T>()
+        for (let i = 0; i < len; i++) {
+            let value = this.item.decode(src)
+            res.add(value)
+        }
+        return res
+    }
+}

solana/borsh/src/dsl.ts

@@ -1,6 +1,8 @@
 import {Codec, GetCodecType} from './codec'
 import {ArrayCodec, FixedArrayCodec} from './codecs/array'
 import {SumCodec, Variant} from './codecs/enum'
+import {HashMapCodec} from './codecs/hash-map'
+import {HashSetCodec} from './codecs/hash-set'
 import {OptionCodec} from './codecs/option'
 import {RefCodec} from './codecs/ref'
 import {GetStructType, StructCodec} from './codecs/struct'
@@ -29,6 +31,7 @@ export function struct<Props extends Record<string, Codec<any>>>(
     return new StructCodec(props as any)
 }
 
+
 export function tuple(tuple: []): TupleCodec<[]>
 export function tuple<T>(tuple: [T]): TupleCodec<GetTupleType<[T]>>
 export function tuple<T1, T2>(tuple: [T1, T2]): TupleCodec<GetTupleType<[T1, T2]>>
@@ -43,6 +46,17 @@ export function tuple<T extends any[]>(tuple: T): TupleCodec<T> {
     return new TupleCodec(tuple as any)
 }
 
+
+export function hashMap<KC extends Codec<any>, VC extends Codec<any>>(key: KC, value: VC): HashMapCodec<GetCodecType<KC>, GetCodecType<VC>> {
+    return new HashMapCodec(key, value)
+}
+
+
+export function hashSet<IC extends Codec<any>>(item: IC): HashSetCodec<GetCodecType<IC>> {
+    return new HashSetCodec(item)
+}
+
+
 export function option<IC extends Codec<any>>(item: IC): OptionCodec<GetCodecType<IC>> {
     return new OptionCodec(item)
 }

solana/solana-typegen/src/program/anchor/old.spec.ts

@@ -149,6 +149,8 @@ export type IdlType =
     | IdlTypeCOption
     | IdlTypeVec
     | IdlTypeArray
+    | IdlTypeHashMap
+    | IdlTypeHashSet
 
 export type IdlTypeDefined = {
     defined: string
@@ -171,6 +173,14 @@ export type IdlTypeArray = {
     array: [idlType: IdlType, size: number]
 }
 
+export type IdlTypeHashMap = {
+    hashMap: [idlType: IdlType, idlType: IdlType]
+}
+
+export type IdlTypeHashSet = {
+    hashSet: IdlType
+}
+
 export type IdlEnumVariant = {
     name: string
     fields?: IdlEnumFields
@@ -355,6 +365,17 @@ function fromType(type: IdlType): Type {
             kind: TypeKind.Array,
             type: fromType(type.vec),
         }
+    } else if ('hashMap' in type) {
+        return {
+            kind: TypeKind.HashMap,
+            key: fromType(type.hashMap[0]),
+            value: fromType(type.hashMap[1]),
+        }
+    } else if ('hashSet' in type) {
+        return {
+            kind: TypeKind.HashSet,
+            type: fromType(type.hashSet),
+        }
     } else if ('defined' in type) {
         return {
             kind: TypeKind.Defined,

solana/solana-typegen/src/program/anchor/v0.spec.ts

@@ -238,6 +238,8 @@ export type IdlType =
     | IdlTypeCOption
     | IdlTypeVec
     | IdlTypeArray
+    | IdlTypeHashMap
+    | IdlTypeHashSet
     | IdlTypeDefined
     | IdlTypeGeneric
 
@@ -258,6 +260,14 @@ export type IdlTypeArray = {
     array: [idlType: IdlType, size: IdlArrayLen]
 }
 
+export type IdlTypeHashMap = {
+    hashMap: [idlType: IdlType, idlType: IdlType]
+}
+
+export type IdlTypeHashSet = {
+    hashSet: IdlType
+}
+
 export type IdlTypeDefined = {
     defined: {
         name: string
@@ -395,6 +405,17 @@ function fromType(type: IdlType): Type {
             kind: TypeKind.Array,
             type: fromType(type.vec),
         }
+    } else if ('hashMap' in type) {
+        return {
+            kind: TypeKind.HashMap,
+            key: fromType(type.hashMap[0]),
+            value: fromType(type.hashMap[1]),
+        }
+    } else if ('hashSet' in type) {
+        return {
+            kind: TypeKind.HashSet,
+            type: fromType(type.hashSet),
+        }
     } else if ('defined' in type) {
         return {
             kind: TypeKind.Defined,

solana/solana-typegen/src/program/types.ts

@@ -29,6 +29,8 @@ export enum TypeKind {
     Struct,
     Defined,
     Generic,
+    HashMap,
+    HashSet
 }
 
 export interface PrimitiveType {
@@ -52,6 +54,17 @@ export interface TupleType {
     tuple: Type[]
 }
 
+export interface HashMapType {
+    kind: TypeKind.HashMap
+    key: Type
+    value: Type
+}
+
+export interface HashSetType {
+    kind: TypeKind.HashSet
+    type: Type
+}
+
 export interface StructType {
     kind: TypeKind.Struct
     fields: Field[]
@@ -114,6 +127,8 @@ export type Type =
     | ArrayType
     | FixedArrayType
     | TupleType
+    | HashMapType
+    | HashSetType
     | StructType
     | EnumType
     | OptionType

solana/solana-typegen/src/typegen.ts

@@ -222,6 +222,19 @@ export class TypeModuleOutput extends FileOutput {
                 })
                 this.line(`])` + end)
                 break
+            case TypeKind.HashMap:
+                this.borsh.add('hashMap')
+                this.line(start + `hashMap(`)
+                this.indentation(() => {
+                    this.printDsl(``, {type: type.key}, ',')
+                    this.printDsl(``, {type: type.value}, '')
+                })
+                this.line(`)` + end)
+                break
+            case TypeKind.HashSet:
+                this.borsh.add('hashSet')
+                this.printDsl(start + `hashSet(`, {type: type.type}, `)` + end)
+                break
             case TypeKind.Defined:
                 const typeName = toTypeName(type.name)
                 this.types.add(typeName)
@@ -287,6 +300,17 @@ export class TypeModuleOutput extends FileOutput {
                 })
                 this.line(`]` + end)
                 break
+            case TypeKind.HashMap:
+                this.line(start + `Map<`)
+                this.indentation(() => {
+                    this.printType(``, {type: type.key}, `,`)
+                    this.printType(``, {type: type.value}, ``)
+                })
+                this.line(`>` + end)
+                break
+            case TypeKind.HashSet:
+                this.printType(start + `Set<`, {type: type.type}, `>` + end)
+                break
             case TypeKind.Defined:
                 this.types.add(toTypeName(type.name))
                 this.line(start + toTypeName(type.name) + end)