@cheqd/sdk 3.0.2-develop.1 → 3.0.2-develop.3

package/src/utils.ts

@@ -1,246 +0,0 @@
-import { 
-    IKeyPair, 
-    IKeyValuePair, 
-    ISignInputs, 
-    VerificationMethods, 
-    TMethodSpecificId, 
-    MethodSpecificIdAlgo, 
-    TVerificationKey, 
-    TVerificationKeyPrefix, 
-    CheqdNetwork, 
-    IVerificationKeys,
-    VerificationMethod,
-    DIDDocument,
-    SpecValidationResult,
-    JsonWebKey,
-} from "./types.js"
-import {
-    fromString,
-    toString
-} from 'uint8arrays'
-import { bases } from "multiformats/basics"
-import { base64ToBytes } from "did-jwt"
-import {
-    generateKeyPair,
-    generateKeyPairFromSeed,
-    KeyPair
-} from '@stablelib/ed25519'
-import { sha256 } from '@cosmjs/crypto'
-import { v4 } from 'uuid'
-import {
-    VerificationMethod as ProtoVerificationMethod,
-    Service as ProtoService,
-} from "@cheqd/ts-proto/cheqd/did/v2/index.js"
-
-export type TImportableEd25519Key = {
-    publicKeyHex: string
-    privateKeyHex: string
-    kid: string
-    type: "Ed25519"
-}
-
-const MULTICODEC_ED25519_HEADER = new Uint8Array([0xed, 0x01]);
-
-export function isEqualKeyValuePair(kv1: IKeyValuePair[], kv2: IKeyValuePair[]): boolean {
-    return kv1.every((item, index) => item.key === kv2[index].key && item.value === kv2[index].value)
-}
-
-export function createSignInputsFromImportableEd25519Key(key: TImportableEd25519Key, verificationMethod: VerificationMethod[]): ISignInputs {
-    if (verificationMethod?.length === 0) throw new Error('No verification methods provided')
-
-    const publicKey = fromString(key.publicKeyHex, 'hex')
-
-    for(const method of verificationMethod) {
-        switch (method?.type) {
-            case VerificationMethods.Ed255192020:
-                const publicKeyMultibase = toMultibaseRaw(publicKey)
-                if (method.publicKeyMultibase === publicKeyMultibase) {
-                    return {
-                        verificationMethodId: method.id,
-                        privateKeyHex: key.privateKeyHex
-                    }
-                }
-            case VerificationMethods.Ed255192018:
-                const publicKeyBase58 = bases['base58btc'].encode(publicKey).slice(1)
-                if (method.publicKeyBase58 === publicKeyBase58) {
-                    return {
-                        verificationMethodId: method.id,
-                        privateKeyHex: key.privateKeyHex
-                    }
-                }
-            case VerificationMethods.JWK:
-                const publicKeyJwk: JsonWebKey = {
-                    crv: 'Ed25519',
-                    kty: 'OKP',
-                    x: toString( publicKey, 'base64url' )
-                }
-                if (JSON.stringify(method.publicKeyJwk) === JSON.stringify(publicKeyJwk)) {
-                    return {
-                        verificationMethodId: method.id,
-                        privateKeyHex: key.privateKeyHex
-                    }
-                }
-        }
-    }
-
-    throw new Error('No verification method type provided')
-}
-
-export function createKeyPairRaw(seed?: string): KeyPair {
-    return seed ? generateKeyPairFromSeed(fromString(seed)) : generateKeyPair()
-}
-
-export function createKeyPairBase64(seed?: string): IKeyPair {
-    const keyPair = seed ? generateKeyPairFromSeed(fromString(seed)) : generateKeyPair()
-    return {
-        publicKey: toString(keyPair.publicKey, 'base64'),
-        privateKey: toString(keyPair.secretKey, 'base64'),
-    }
-}
-
-export function createKeyPairHex(seed?: string): IKeyPair {
-    const keyPair = createKeyPairRaw(seed)
-    return {
-        publicKey: toString(keyPair.publicKey, 'hex'),
-        privateKey: toString(keyPair.secretKey, 'hex'),
-    }
-}
-
-export function createVerificationKeys(publicKey: string, algo: MethodSpecificIdAlgo, key: TVerificationKey<TVerificationKeyPrefix, number>, network: CheqdNetwork = CheqdNetwork.Testnet): IVerificationKeys {
-    let methodSpecificId: TMethodSpecificId
-    let didUrl: IVerificationKeys['didUrl']
-
-    publicKey = publicKey.length == 43 ? publicKey : toString(fromString(publicKey, 'hex'), 'base64')
-    switch (algo) {
-        case MethodSpecificIdAlgo.Base58:
-            methodSpecificId = bases['base58btc'].encode(base64ToBytes(publicKey))
-            didUrl = `did:cheqd:${network}:${(bases['base58btc'].encode((sha256(base64ToBytes(publicKey))).slice(0,16))).slice(1)}`
-            return {
-                methodSpecificId,
-                didUrl,
-                keyId: `${didUrl}#${key}`,
-                publicKey,
-            }
-        case MethodSpecificIdAlgo.Uuid:
-            methodSpecificId = bases['base58btc'].encode(base64ToBytes(publicKey))
-            didUrl = `did:cheqd:${network}:${v4()}`
-            return {
-                methodSpecificId,
-                didUrl,
-                keyId: `${didUrl}#${key}`,
-                publicKey,
-            }
-    }
-}
-
-export function createDidVerificationMethod(verificationMethodTypes: VerificationMethods[], verificationKeys: IVerificationKeys[]): VerificationMethod[] {
-    return verificationMethodTypes.map((type, _) => {
-        switch (type) {
-            case VerificationMethods.Ed255192020:
-                return {
-                    id: verificationKeys[_].keyId,
-                    type,
-                    controller: verificationKeys[_].didUrl,
-                    publicKeyMultibase: toMultibaseRaw(base64ToBytes(verificationKeys[_].publicKey))
-                } as VerificationMethod
-            case VerificationMethods.Ed255192018:
-                return {
-                    id: verificationKeys[_].keyId,
-                    type,
-                    controller: verificationKeys[_].didUrl,
-                    publicKeyBase58: verificationKeys[_].methodSpecificId.slice(1)
-                } as VerificationMethod
-            case VerificationMethods.JWK:
-                return {
-                    id: verificationKeys[_].keyId,
-                    type,
-                    controller: verificationKeys[_].didUrl,
-                    publicKeyJwk: {
-                        crv: 'Ed25519',
-                        kty: 'OKP',
-                        x: toString( fromString( verificationKeys[_].publicKey, 'base64pad' ), 'base64url' )
-                    }
-                } as VerificationMethod
-        }
-    }) ?? []
-}
-
-export function createDidPayload(verificationMethods: VerificationMethod[], verificationKeys: IVerificationKeys[]): DIDDocument {
-    if (!verificationMethods || verificationMethods.length === 0)
-        throw new Error('No verification methods provided')
-    if (!verificationKeys || verificationKeys.length === 0)
-        throw new Error('No verification keys provided')
-
-    const did = verificationKeys[0].didUrl
-    return {
-            id: did,
-            controller: verificationKeys.map(key => key.didUrl),
-            verificationMethod: verificationMethods,
-            authentication: verificationKeys.map(key => key.keyId),
-    } as DIDDocument
-}
-
-export function validateSpecCompliantPayload(didDocument: DIDDocument): SpecValidationResult {
-    // id is required, validated on both compile and runtime
-    if (!didDocument?.id) return { valid: false, error: 'id is required' }
-
-    // verificationMethod is required
-    if (!didDocument?.verificationMethod) return { valid: false, error: 'verificationMethod is required' }
-
-    // verificationMethod must be an array
-    if (!Array.isArray(didDocument?.verificationMethod)) return { valid: false, error: 'verificationMethod must be an array' }
-
-    // verificationMethod types must be supported
-    const protoVerificationMethod = didDocument.verificationMethod.map((vm) => {
-        switch (vm?.type) {
-            case VerificationMethods.Ed255192020:
-                if (!vm.publicKeyMultibase) throw new Error('publicKeyMultibase is required')
-
-                return ProtoVerificationMethod.fromPartial({
-                    id: vm.id,
-                    controller: vm.controller,
-                    verificationMethodType: VerificationMethods.Ed255192020,
-                    verificationMaterial: vm.publicKeyMultibase,
-                })
-            case VerificationMethods.JWK:
-                if (!vm.publicKeyJwk) throw new Error('publicKeyJwk is required')
-
-                return ProtoVerificationMethod.fromPartial({
-                    id: vm.id,
-                    controller: vm.controller,
-                    verificationMethodType: VerificationMethods.JWK,
-                    verificationMaterial: JSON.stringify(vm.publicKeyJwk),
-                })
-            case VerificationMethods.Ed255192018:
-                if (!vm.publicKeyBase58) throw new Error('publicKeyBase58 is required')
-
-                return ProtoVerificationMethod.fromPartial({
-                    id: vm.id,
-                    controller: vm.controller,
-                    verificationMethodType: VerificationMethods.Ed255192018,
-                    verificationMaterial: vm.publicKeyBase58,
-                })
-            default:
-                throw new Error(`Unsupported verificationMethod type: ${vm?.type}`)
-        }
-    })
-
-    const protoService = didDocument?.service?.map((s) => {
-        return ProtoService.fromPartial({
-            id: s?.id,
-            serviceType: s?.type,
-            serviceEndpoint: <string[]>s?.serviceEndpoint,
-        })
-    })
-
-    return { valid: true, protobufVerificationMethod: protoVerificationMethod, protobufService: protoService }
-}
-
-function toMultibaseRaw(key: Uint8Array) {
-    const multibase = new Uint8Array(MULTICODEC_ED25519_HEADER.length + key.length);
-
-    multibase.set(MULTICODEC_ED25519_HEADER);
-    multibase.set(key, MULTICODEC_ED25519_HEADER.length);
-
-    return bases['base58btc'].encode(multibase);
-}

package/tests/index.test.ts

@@ -1,155 +0,0 @@
-import {
-    DirectSecp256k1HdWallet,
-    GeneratedType
-} from '@cosmjs/proto-signing'
-import {
-    createCheqdSDK,
-    DIDModule,
-    ICheqdSDKOptions,
-    ResourceModule
-} from '../src/index'
-import {
-    localnet,
-    faucet
-} from './testutils.test'
-import { AbstractCheqdSDKModule } from '../src/modules/_'
-import { CheqdSigningStargateClient } from '../src/signer'
-import { createDefaultCheqdRegistry } from '../src/registry'
-import { CheqdQuerier } from '../src/querier'
-import {
-    setupDidExtension,
-    DidExtension,
-    defaultDidExtensionKey
-} from '../src/modules/did';
-import { QueryExtensionSetup } from '../src/types'
-import {
-    setupResourceExtension,
-    ResourceExtension,
-    defaultResourceExtensionKey
-} from '../src/modules/resource'
-import { jest } from '@jest/globals'
-
-describe(
-    'CheqdSDK', () => {
-        describe('constructor', () => {
-            it('can be instantiated with modules', async () => {
-                const options = {
-                    modules: [DIDModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl: localnet.rpcUrl,
-                    wallet: await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-                } as ICheqdSDKOptions
-                const cheqdSDK = await createCheqdSDK(options)
-
-                const sdkMethods = Object.keys(cheqdSDK.methods)
-                const testSigner = await CheqdSigningStargateClient.connectWithSigner(options.rpcUrl, options.wallet)
-                const testQuerier = await CheqdQuerier.connectWithExtension(options.rpcUrl, setupDidExtension) as CheqdQuerier & DidExtension
-                const moduleMethods = Object.keys(new DIDModule(testSigner, testQuerier).methods)
-
-                moduleMethods.forEach((method) => {
-                    expect(sdkMethods).toContain(method)
-                })
-            })
-
-            it('should use module methods', async () => {
-                const rpcUrl = localnet.rpcUrl
-                const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-
-                class TestModule extends AbstractCheqdSDKModule {
-                    registryTypes: Iterable<[string, GeneratedType]> = []
-                    methods = {
-                        doSomething: this.doSomething.bind(this)
-                    }
-                    constructor(signer: CheqdSigningStargateClient, querier: CheqdQuerier) {
-                        super(signer, querier)
-                    }
-                    public getRegistryTypes(): Iterable<[string, GeneratedType]> {
-                        return TestModule.registryTypes
-                    }
-                    public getQuerierExtensionSetup(): QueryExtensionSetup<{}> {
-                        return () => ({})
-                    }
-                    async doSomething(): Promise<string> {
-                        return 'did something'
-                    }
-                }
-                const options = {
-                    modules: [TestModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl,
-                    wallet 
-                } as ICheqdSDKOptions
-
-                const cheqdSDK = await createCheqdSDK(options)
-
-                //@ts-ignore
-                const doSomething = await cheqdSDK.doSomething()
-                expect(doSomething).toBe('did something')
-
-                const spy = jest.spyOn(cheqdSDK.methods, 'doSomething')
-                //@ts-ignore
-                await cheqdSDK.doSomething()
-                expect(spy).toHaveBeenCalled()
-            })
-
-            it('should instantiate registry from passed modules', async () => {
-                const options = {
-                    modules: [DIDModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl: localnet.rpcUrl,
-                    wallet: await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-                } as ICheqdSDKOptions
-                const cheqdSDK = await createCheqdSDK(options)
-
-                const didRegistryTypes = DIDModule.registryTypes
-                const cheqdRegistry = createDefaultCheqdRegistry(didRegistryTypes)
-
-                expect(cheqdSDK.signer.registry).toStrictEqual(cheqdRegistry)
-            })
-
-            it('should instantiate registry from multiple passed modules', async () => {
-                const options = {
-                    modules: [DIDModule as unknown as AbstractCheqdSDKModule, ResourceModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl: localnet.rpcUrl,
-                    wallet: await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-                } as ICheqdSDKOptions
-                const cheqdSDK = await createCheqdSDK(options)
-
-                const didRegistryTypes = DIDModule.registryTypes
-                const resourceRegistryTypes = ResourceModule.registryTypes
-                const cheqdRegistry = createDefaultCheqdRegistry([...didRegistryTypes, ...resourceRegistryTypes])
-
-                expect(cheqdSDK.signer.registry).toStrictEqual(cheqdRegistry)
-            })
-
-            it('should instantiate querier extension from passed modules', async () => {
-                const options = {
-                    modules: [DIDModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl: localnet.rpcUrl,
-                    wallet: await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-                } as ICheqdSDKOptions
-                const cheqdSDK = await createCheqdSDK(options)
-
-                const querier = await CheqdQuerier.connectWithExtension(options.rpcUrl, setupDidExtension) as CheqdQuerier & DidExtension
-
-                // we need to stringify the querier extension because it's a proxy object
-                // and the equality check will fail
-                expect(JSON.stringify(cheqdSDK.querier[defaultDidExtensionKey])).toStrictEqual(JSON.stringify(querier[defaultDidExtensionKey]))
-            })
-
-            it('should instantiate querier extension from multiple passed modules', async () => {
-                const options = {
-                    modules: [DIDModule as unknown as AbstractCheqdSDKModule, ResourceModule as unknown as AbstractCheqdSDKModule],
-                    rpcUrl: localnet.rpcUrl,
-                    wallet: await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-                } as ICheqdSDKOptions
-                const cheqdSDK = await createCheqdSDK(options)
-
-                const didQuerier = await CheqdQuerier.connectWithExtension(options.rpcUrl, setupDidExtension) as CheqdQuerier & DidExtension
-                const resourceQuerier = await CheqdQuerier.connectWithExtension(options.rpcUrl, setupResourceExtension) as CheqdQuerier & ResourceExtension
-
-                // we need to stringify the querier extension because it's a proxy object
-                // and the equality check will fail
-                expect(JSON.stringify(cheqdSDK.querier[defaultDidExtensionKey])).toStrictEqual(JSON.stringify(didQuerier[defaultDidExtensionKey]))
-                expect(JSON.stringify(cheqdSDK.querier[defaultResourceExtensionKey])).toStrictEqual(JSON.stringify(resourceQuerier[defaultResourceExtensionKey]))
-            })
-        })
-    }
-)