Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/blockchain-utils-validation

Utils for validation of linked blockchain accounts

This package contains utility functions to validate links of blockchain accounts linked a DID.

Installation

 
npm install @ceramicnetwork/blockchain-utils-validation

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Apache-2.0 or MIT

Index

Interfaces

Variables

Functions

Object literals

Variables

Const ADDRESS_NOT_FOUND_ERROR

ADDRESS_NOT_FOUND_ERROR: Error = new Error(`Address not found on the Tezos blockchain`)

Const ERC1271_ABI

ERC1271_ABI: string[] = ['function isValidSignature(bytes _messageHash, bytes _signature) public view returns (bytes4 magicValue)',]

Const FAKE_API_ENDPOINT

FAKE_API_ENDPOINT: "https://fake-api.example.com" = "https://fake-api.example.com"

Const MAGIC_ERC1271_VALUE

MAGIC_ERC1271_VALUE: "0x20c13b0b" = "0x20c13b0b"

Const PUBLIC_KEY_NOT_PUBLISHED_ERROR

PUBLIC_KEY_NOT_PUBLISHED_ERROR: Error = new Error(`Public key not published to the Tezos blockchain`)

TEZOS_CHAIN_REF

TEZOS_CHAIN_REF: "NetXdQprcVkpaWU"

TEZOS_NAMESPACE

TEZOS_NAMESPACE: "tezos"

Const namespace

namespace: "eip155" = "eip155"

Const namespace

namespace: "fil" = "fil"

Const namespace

namespace: "polkadot" = "polkadot"

Const namespace

namespace: "eosio" = "eosio"

Const namespace

namespace: "cosmos" = "cosmos"

Const namespace

namespace: "near" = "near"

Functions

encodeMessage

  • encodeMessage(text: string): string

Const findDID

  • findDID(did: string): string | undefined

getEthersProvider

  • getEthersProvider(chainId: string): any

publicKeyFinder

  • publicKeyFinder(address: string): () => Promise<string>

  • creates a function which attempts to resolve the public key associated with the wallet address

    throws

    {Error} - if the address is not found on the blockchain

    throws

    {Error} - if the public key is not published to the blockchain

    Parameters

    • address: string

      a Tezos wallet address to lookup

    Returns () => Promise<string>

    • the fetching function for the public key of the address
      • (): Promise<string>

      • Returns Promise<string>

Const stringDecode

  • stringDecode(str: string): string

Const stringEncode

  • stringEncode(str: string): string

Const stringHex

  • stringHex(str: string): string

toV2Proof

  • toV2Proof(proof: LinkProof, address?: string): LinkProof

utf8toHex

  • utf8toHex(message: string): string

validateEoaLink

  • validateEoaLink(proof: LinkProof): Promise<LinkProof | null>

validateErc1271Link

  • validateErc1271Link(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

validateLink

  • validateLink(proof: LinkProof): Promise<LinkProof | null>

Const verifySignature

  • verifySignature(pubKey: Uint8Array, message: string, signature: Uint8Array): Promise<Boolean>

Object literals

Const ADDRESS_TYPES

ADDRESS_TYPES: object

erc1271

erc1271: string = "erc1271"

ethereumEOA

ethereumEOA: string = "ethereum-eoa"

Const Handler

Handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const Handler

Handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const Handler

Handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const Handler

Handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const Handler

Handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const Handler

Handler: object

namespace

namespace: string = TEZOS_NAMESPACE

validateLink

validateLink: validateLink

Const handler

handler: object

namespace

namespace: string

validateLink

validateLink: validateLink

Const handlers

handlers: object

[cosmos.namespace]

[cosmos.namespace]: BlockchainHandler = cosmos

[eosio.namespace]

[eosio.namespace]: BlockchainHandler = eosio

[ethereum.namespace]

[ethereum.namespace]: BlockchainHandler = ethereum

[filecoin.namespace]

[filecoin.namespace]: BlockchainHandler = filecoin

[near.namespace]

[near.namespace]: BlockchainHandler = near

[polkadot.namespace]

[polkadot.namespace]: BlockchainHandler = polkadot

[tezos.namespace]

[tezos.namespace]: BlockchainHandler = tezos

Const proofs

proofs: object

v0

v0: object

invalid

invalid: object

message

message: string = "Create a new 3Box profile-Your unique profile ID is did:3:bafysdfwefwe"

signature

signature: string = "0xfa69ccf4a94db6139837459873459873498759834500fbb748209890a5780f3365a5335f82d424d7f9a63ee41b637c116e64ef2f32c761bb065e4409f978c4bb1c"

type

type: string = "ethereum-eoa"

valid

valid: object

message

message: string = "Create a new 3Box profile-Your unique profile ID is did:3:bafysdfwefwe"

signature

signature: string = "0xfa69ccf4a94db61325429d37c58c6de534b73f439700fbb748209890a5780f3365a5335f82d424d7f9a63ee41b637c116e64ef2f32c761bb065e4409f978c4bb1c"

type

type: string = "ethereum-eoa"

v1

v1: object

invalid

invalid: object

address

address: string = "0x8fe2c4516e920425e177658aaac451ca0463ed87"

message

message: string = "Create a new 3Box profile-Your unique profile ID is did:3:bafysdfwefwe"

signature

signature: string = "0xfa69ccf4a94db61325429d37c58c6de534b73f439700fbb748209890a5780f3365a5335f82d424d7f9a63ee41b637c116e64ef2f32c761bb065e4409f978c4bb1c"

type

type: string = "ethereum-eoa"

version

version: number = 1

valid

valid: object

address

address: string = "0x8fe2c4516e920425e177658aaac451ca0463ed69"

message

message: string = "Create a new 3Box profile-Your unique profile ID is did:3:bafysdfwefwe"

signature

signature: string = "0xfa69ccf4a94db61325429d37c58c6de534b73f439700fbb748209890a5780f3365a5335f82d424d7f9a63ee41b637c116e64ef2f32c761bb065e4409f978c4bb1c"

type

type: string = "ethereum-eoa"

version

version: number = 1