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

package/tests/signer.test.ts

@@ -1,202 +0,0 @@
-import {
-    MsgCreateDidDoc,
-    MsgCreateDidDocPayload,
-    VerificationMethod
-} from "@cheqd/ts-proto/cheqd/did/v2"
-import {
-    DirectSecp256k1HdWallet,
-    Registry
-} from "@cosmjs/proto-signing"
-import { EdDSASigner } from "did-jwt"
-import { typeUrlMsgCreateDidDoc } from '../src/modules/did'
-import { CheqdSigningStargateClient } from "../src/signer"
-import {
-    ISignInputs,
-    MethodSpecificIdAlgo,
-    VerificationMethods
-} from "../src/types"
-import {
-    fromString,
-    toString
-} from 'uint8arrays'
-import {
-    createDidPayload,
-    createDidVerificationMethod,
-    createKeyPairBase64,
-    createVerificationKeys,
-    validateSpecCompliantPayload
-} from '../src/utils';
-import {
-    localnet,
-    faucet
-} from "./testutils.test"
-import { verify } from "@stablelib/ed25519"
-import { v4 } from "uuid"
-
-const nonExistingDid = "did:cHeQd:fantasticnet:123"
-const nonExistingKeyId = 'did:cHeQd:fantasticnet:123#key-678'
-const nonExistingPublicKeyMultibase = '1234567890'
-const nonExistingVerificationMethod = 'ExtraTerrestrialVerificationKey2045'
-const nonExistingVerificationDidDocument = {
-    "authentication": [
-        "did:cheqd:testnet:z6Jn6NmYkaCepQe2#key-1"
-    ],
-    "controller": [
-        "did:cheqd:testnet:z6Jn6NmYkaCepQe2"
-    ],
-    "id": "did:cheqd:testnet:z6Jn6NmYkaCepQe2",
-    "verificationMethod": [
-        {
-            "controller": "did:cheqd:testnet:z6Jn6NmYkaCepQe2",
-            "id": "did:cheqd:testnet:z6Jn6NmYkaCepQe2#key-1",
-            "publicKeyMultibase": "z6Jn6NmYkaCepQe29vgCZQhFfRkN3YpEPiu14F8HbbmqW",
-            "type": nonExistingVerificationMethod
-        }
-    ]
-}
-
-describe('CheqdSigningStargateClient', () => {
-    describe('constructor', () => {
-        it('can be instantiated & works for cheqd networks', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            expect(signer).toBeInstanceOf(CheqdSigningStargateClient)
-        })
-
-        it('can be constructed with cheqd custom registry', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const registry = new Registry()
-            registry.register(typeUrlMsgCreateDidDoc, MsgCreateDidDoc)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet, { registry })
-            expect(signer.registry.lookupType(typeUrlMsgCreateDidDoc)).toBe(MsgCreateDidDoc)
-        })
-    })
-
-    describe('getDidSigner', () => {
-        it('can get a signer for a did', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const keyPair = createKeyPairBase64()
-            const verificationKeys = createVerificationKeys(keyPair.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-            const verificationMethods = createDidVerificationMethod([VerificationMethods.Ed255192020], [verificationKeys])
-            const didPayload = createDidPayload(verificationMethods, [verificationKeys])
-            const { protobufVerificationMethod } = validateSpecCompliantPayload(didPayload)
-
-            const didSigner = await signer.getDidSigner(didPayload.verificationMethod![0].id, protobufVerificationMethod!)
-
-            expect(didSigner).toBe(EdDSASigner)
-        })
-
-        it('should throw for a non-supported verification method', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-
-            await expect(signer.getDidSigner(nonExistingVerificationDidDocument.verificationMethod[0].id, nonExistingVerificationDidDocument.verificationMethod)).rejects.toThrow()
-        })
-
-        it('should throw for non-matching verification method id', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const keyPair = createKeyPairBase64()
-            const verificationKeys = createVerificationKeys(keyPair.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-            const verificationMethods = createDidVerificationMethod([VerificationMethods.Ed255192020], [verificationKeys])
-            const payload = createDidPayload(verificationMethods, [verificationKeys])
-            const { protobufVerificationMethod } = validateSpecCompliantPayload(payload)
-
-            await expect(signer.getDidSigner(nonExistingKeyId, protobufVerificationMethod!)).rejects.toThrow()
-        })
-    })
-
-    describe('checkDidSigners', () => {
-        it('it should instantiate a signer for a did', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const keyPair = createKeyPairBase64()
-            const verificationKeys = createVerificationKeys(keyPair.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-            const verificationMethods = createDidVerificationMethod([VerificationMethods.Ed255192020], [verificationKeys])
-            const payload = createDidPayload(verificationMethods, [verificationKeys])
-            const { protobufVerificationMethod } = validateSpecCompliantPayload(payload)
-            const didSigners = await signer.checkDidSigners(protobufVerificationMethod)
-
-            expect(didSigners[VerificationMethods.Ed255192020]).toBe(EdDSASigner)
-        })
-
-        it('should instantiate multiple signers for a did with multiple verification methods', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const keyPair1 = createKeyPairBase64()
-            const keyPair2 = createKeyPairBase64()
-            const keyPair3 = createKeyPairBase64()
-            const verificationKeys1 = createVerificationKeys(keyPair1.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-            const verificationKeys2 = createVerificationKeys(keyPair2.publicKey, MethodSpecificIdAlgo.Base58, 'key-2')
-            const verificationKeys3 = createVerificationKeys(keyPair3.publicKey, MethodSpecificIdAlgo.Base58, 'key-3')
-            const verificationMethods = createDidVerificationMethod([VerificationMethods.Ed255192020, VerificationMethods.JWK, VerificationMethods.Ed255192018], [verificationKeys1, verificationKeys2, verificationKeys3])
-
-            const payload = createDidPayload(verificationMethods, [verificationKeys1, verificationKeys2, verificationKeys3])
-            const { protobufVerificationMethod } = validateSpecCompliantPayload(payload)
-
-            const didSigners = await signer.checkDidSigners(protobufVerificationMethod)
-
-            expect(didSigners[VerificationMethods.Ed255192020]).toBe(EdDSASigner)
-            expect(didSigners[VerificationMethods.JWK]).toBe(EdDSASigner)
-            expect(didSigners[VerificationMethods.Ed255192018]).toBe(EdDSASigner)
-        })
-
-        it('should throw for non-supported verification method', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const verificationMethod: Partial<VerificationMethod> = {
-                id: nonExistingKeyId,
-                verificationMethodType: nonExistingVerificationMethod,
-                controller: nonExistingDid,
-                verificationMaterial: JSON.stringify({publicKeyMultibase: nonExistingPublicKeyMultibase})
-            }
-
-            await expect(signer.checkDidSigners([VerificationMethod.fromPartial(verificationMethod)])).rejects.toThrow()
-        })
-    })
-
-    describe('signcreateDidDocTx', () => {
-        it('should sign a did tx with valid signature', async () => {
-            const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic)
-            const signer = await CheqdSigningStargateClient.connectWithSigner(localnet.rpcUrl, wallet)
-            const keyPair = createKeyPairBase64()
-            const verificationKeys = createVerificationKeys(keyPair.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-            const verificationMethods = createDidVerificationMethod([VerificationMethods.Ed255192020], [verificationKeys])
-            const didPayload = createDidPayload(verificationMethods, [verificationKeys])
-            const signInputs: ISignInputs[] = [
-                {
-                    verificationMethodId: didPayload.verificationMethod![0].id,
-                    privateKeyHex: toString(fromString(keyPair.privateKey, 'base64'), 'hex')
-                }
-            ]
-            const { protobufVerificationMethod, protobufService } = validateSpecCompliantPayload(didPayload)
-            const versionId = v4()
-            const payload = MsgCreateDidDocPayload.fromPartial({
-                context: <string[]>didPayload?.['@context'],
-                id: didPayload.id,
-                controller: <string[]>didPayload.controller,
-                verificationMethod: protobufVerificationMethod,
-                authentication: <string[]>didPayload.authentication,
-                assertionMethod: <string[]>didPayload.assertionMethod,
-                capabilityInvocation: <string[]>didPayload.capabilityInvocation,
-                capabilityDelegation: <string[]>didPayload.capabilityDelegation,
-                keyAgreement: <string[]>didPayload.keyAgreement,
-                service: protobufService,
-                alsoKnownAs: <string[]>didPayload.alsoKnownAs,
-                versionId: versionId
-            })
-            const signInfos = await signer.signcreateDidDocTx(signInputs, payload)
-            const publicKeyRaw = fromString(keyPair.publicKey, 'base64')
-            const messageRaw = MsgCreateDidDocPayload.encode(payload).finish()
-
-            const verified = verify(
-                publicKeyRaw,
-                messageRaw,
-                signInfos[0].signature
-            )
-
-            expect(verified).toBe(true)
-        })
-    })
-})

package/tests/testutils.test.ts

@@ -1,29 +0,0 @@
-import { GasPrice } from "@cosmjs/stargate"
-
-export const faucet = {
-    prefix: 'cheqd',
-    minimalDenom: 'ncheq',
-    mnemonic: 'sketch mountain erode window enact net enrich smoke claim kangaroo another visual write meat latin bacon pulp similar forum guilt father state erase bright',
-    address: 'cheqd1rnr5jrt4exl0samwj0yegv99jeskl0hsxmcz96',
-}
-
-export const localnet = {
-    network: 'testnet',
-    rpcUrl: 'http://localhost:26657',
-    gasPrice: GasPrice.fromString( `50${faucet.minimalDenom}` )
-}
-
-export const json_content = "{\"message\": \"hello world\"}"
-
-export const image_content = 'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg' as const
-
-export const default_content = '<p>Test file content</p>'
-
-export function containsAll<T>(array: T[], values: T[]): boolean {
-    return values.every(value => array.includes(value))
-}
-
-export function containsAllButOmittedFields<T extends Record<string, any>>(array: T[], values: T[], omit: string[]): boolean {
-    const replacer = (key: string, value: any) => omit.includes(key) ? undefined : value
-    return values.every(value => array.some(item => JSON.stringify(item, replacer) === JSON.stringify(value, replacer)))
-}

package/tests/utils.test.ts

@@ -1,77 +0,0 @@
-import {
-    TImportableEd25519Key,
-    createSignInputsFromImportableEd25519Key
-} from '../src/utils'
-import {
-    createDidVerificationMethod,
-    createVerificationKeys,
-    createKeyPairRaw
-} from '../src/utils'
-import { toString } from 'uint8arrays'
-import {
-    IKeyPair,
-    MethodSpecificIdAlgo,
-    VerificationMethods
-} from '../src/types'
-
-describe('createSignInputsFromImportableEd25519Key', () => {
-    it('should create a sign input from an importable ed25519 key 2020', async () => {
-        const keyPair = createKeyPairRaw()
-        const importableEd25519Key: TImportableEd25519Key = {
-            publicKeyHex: toString(keyPair.publicKey, 'hex'),
-            privateKeyHex: toString(keyPair.secretKey, 'hex'),
-            kid: toString(keyPair.publicKey, 'hex'),
-            type: 'Ed25519'
-        }
-        const keyPairBase64: IKeyPair = {
-            publicKey: toString(keyPair.publicKey, 'base64'),
-            privateKey: toString(keyPair.secretKey, 'base64'),
-        }
-
-        const verificationKeys = createVerificationKeys(keyPairBase64.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-        const verificationMethod = createDidVerificationMethod([VerificationMethods.Ed255192020], [verificationKeys])
-        const signInput = createSignInputsFromImportableEd25519Key(importableEd25519Key, verificationMethod)
-
-        expect(signInput).toEqual({ verificationMethodId: verificationKeys.keyId, privateKeyHex: importableEd25519Key.privateKeyHex })
-    })
-
-    it('should create a sign input from an importable ed25519 key 2018', async () => {
-        const keyPair = createKeyPairRaw()
-        const importableEd25519Key: TImportableEd25519Key = {
-            publicKeyHex: toString(keyPair.publicKey, 'hex'),
-            privateKeyHex: toString(keyPair.secretKey, 'hex'),
-            kid: toString(keyPair.publicKey, 'hex'),
-            type: 'Ed25519'
-        }
-        const keyPairBase64: IKeyPair = {
-            publicKey: toString(keyPair.publicKey, 'base64'),
-            privateKey: toString(keyPair.secretKey, 'base64'),
-        }
-
-        const verificationKeys = createVerificationKeys(keyPairBase64.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-        const verificationMethod = createDidVerificationMethod([VerificationMethods.Ed255192018], [verificationKeys])
-        const signInput = createSignInputsFromImportableEd25519Key(importableEd25519Key, verificationMethod)
-
-        expect(signInput).toEqual({ verificationMethodId: verificationKeys.keyId, privateKeyHex: importableEd25519Key.privateKeyHex })
-    })
-
-    it('should create a sign input from an importable ed25519 key with VM type JWK', () => {
-        const keyPair = createKeyPairRaw()
-        const importableEd25519Key: TImportableEd25519Key = {
-            publicKeyHex: toString(keyPair.publicKey, 'hex'),
-            privateKeyHex: toString(keyPair.secretKey, 'hex'),
-            kid: toString(keyPair.publicKey, 'hex'),
-            type: 'Ed25519'
-        }
-        const keyPairBase64: IKeyPair = {
-            publicKey: toString(keyPair.publicKey, 'base64'),
-            privateKey: toString(keyPair.secretKey, 'base64'),
-        }
-
-        const verificationKeys = createVerificationKeys(keyPairBase64.publicKey, MethodSpecificIdAlgo.Base58, 'key-1')
-        const verificationMethod = createDidVerificationMethod([VerificationMethods.JWK], [verificationKeys])
-        const signInput = createSignInputsFromImportableEd25519Key(importableEd25519Key, verificationMethod)
-
-        expect(signInput).toEqual({ verificationMethodId: verificationKeys.keyId, privateKeyHex: importableEd25519Key.privateKeyHex })
-    })
-})

package/tsconfig.cjs.json

@@ -1,8 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "module": "commonjs",     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-        "outDir": "build/cjs",  /* Redirect output structure to the directory. */
-        "target": "esnext",     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    }
-}

package/tsconfig.esm.json

@@ -1,8 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "module": "esnext",     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-        "outDir": "build/esm",  /* Redirect output structure to the directory. */
-        "target": "esnext",     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    }
-}

package/tsconfig.json

@@ -1,84 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    // "target": "esnext",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    // "module": "nodenext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    // "outDir": "build",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
-
-    /* Module Resolution Options */
-    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    "resolveJsonModule": true,               /* Include modules imported with '.json' extension. */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    "types": [
-      "@types/node",
-      "@types/jest",
-    ],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
-  },
-  "ts-node": {
-    "esm": true,
-    "experimentalSpecifierResolution": "node"
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "tests"
-  ]
-}

package/tsconfig.types.json

@@ -1,10 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "build/types",
-        "declaration": true,
-        "emitDeclarationOnly": true,
-        "module": "esnext",
-        "target": "esnext",
-    }
-}