@certifaction/verification-vue-component

@certifaction/verification-vue-component

The verification vue-component enables you to easily integrate the Certifaction Verification Tool into your VueJS project.

Table of contents

• Requirements
• Install
  • As NPM package
• Usage
  • ES6
  • Load locales
  • Load stylesheet
• Props
  • demo
  • pdfWasmUrl
  • pdfjsWorkerSrc
  • pdfjsCMapUrl
  • providerUrl
  • legacyContractAddress
  • legacyContractFallbackAddresses
  • claimContractAddress
  • acceptedIssuerKey
  • certifactionApiUrl
  • offchainVerifier
• License

Requirements

• Vue.js (^2.6)
• Vue I18n (^8.21)

Install

As NPM package

npm install @certifaction/verification-vue-component

# or if using yarn
yarn add @certifaction/verification-vue-component

Usage

ES6

import CertifactionVerification from '@certifaction/verification-vue-component'

new Vue({
    components: {
        CertifactionVerification
    }
})

Load locales

Example code how to load the component translations:

import merge from 'lodash.merge'

import verificationDE from '@certifaction/verification-vue-component/src/locales/de.json'
import verificationEN from '@certifaction/verification-vue-component/src/locales/en.json'
import verificationFR from '@certifaction/verification-vue-component/src/locales/fr.json'
import verificationIT from '@certifaction/verification-vue-component/src/locales/it.json'

function loadLocaleMessages() {
    // Load your messages
}

const messages = merge({
    de: verificationDE,
    en: verificationEN,
    fr: verificationFR,
    it: verificationIT
}, loadLocaleMessages())

new VueI18n({
    messages
})

Load stylesheet

@import "~@certifaction/verification-vue-component/src/style/components/certifaction_verification";

// To include the PDF viewer style:
.certifaction-verification {
  @import "~@certifaction/verification-vue-component/dist/pdf/pdf_viewer";
}

Props

demo

Type: boolean | Required: false | Default: false

Show demo documents to see the different verification results.

pdfWasmUrl

Type: URL | Required: true

URL to the PDF webassembly file.

Example to use the wasm from the Certifaction CDN:

// vue.config.js
process.env.VUE_APP_CACHE_BUSTER = new Date().getTime().toString()

const pdfWasmUrl = new URL(`/wasm/pdf_reader.wasm?t=${process.env.VUE_APP_CACHE_BUSTER}`, process.env.VUE_APP_CERTIFACTION_CDN_BASE_URL)

pdfjsWorkerSrc

Type: string | Required: true

URL to the PDF.js worker (@certifaction/verification-vue-component/dist/pdf/pdfjs.worker.min.js)

vue.config.js example:

chainWebpack: config => {
    config.module
        .rule('js')
        .exclude.add(/\.worker(\.min)?\.js$/)

    config.module
        .rule('worker')
        .test(/\.worker(\.min)?\.js$/)
        .use('file-loader')
        .loader('file-loader')
        .tap(() => ({
            name: 'js/[name].[hash:8].[ext]',
            esModule: false
        }))
}

pdfjsCMapUrl

Type: string | Required: true

URL to the folder where the cmaps are stored. (pdf/cmaps/ when using the vue.config.js example below)

vue.config.js example:

chainWebpack: config => {
    config.plugin('copy')
        .tap(args => {
            args[0].push({
                from: '@certifaction/verification-vue-component/dist/pdf/cmaps',
                to: 'pdf/cmaps',
                toType: 'dir',
                context: '../../node_modules'
            })
            return args
        })
}

providerUrl

Type: string | Required: false | Default: https://mainnet.infura.io/v3/4559d381898847c0b13ced86a45a4ec0

legacyContractAddress

Type: string (HEX format) | Required: false | Default: 0xf73e27c5008ff487803d2337fc3ac4016f6526e4

legacyContractFallbackAddresses

Type: array (strings in HEX format) | Required: false | Default: ['0x5ee4ec3cbee909050e68c7ff7a8b422cfbd72244']

claimContractAddress

Type: string (HEX format) | Required: false | Default: 0x5532ba4add77dd25fa11acc5a84e5f183f57525e

acceptedIssuerKey

Type: string (HEX format) | Required: false | Default: 0x3f647d9f6a22768EA9c91C299d0AD5924c6164Be

certifactionApiUrl

Type: string | Required: false | Default: https://api.certifaction.io

offchainVerifier

Type: Object<VerifierInterface> | Required: false

If you want to double check, add information, or simply make sure the user gets the correct result even though the block containing your transaction isn't finalized, you can provide a VerifierInterface's implementation.

The class should only contain the method verify(fileHash). The method should return the attributes you want to override.

For an example on how to do that, check @certifaction/verification-core/examples/CertifactionOffchainVerifierExample.js

License

Released by Certifaction AG