@metaio/meta-signature-util

Type aliases

AuthorMediaSignatureMetadata

AuthorMediaSignatureMetadata: { @context: "https://metanetwork.online/ns/cms"; @type: "author-media-sign"; @version: string; categories: string; claim: string; contentType: string; cover: string; license: string; nonce: string; platform: string; platformHash: string; publicKey: string; signature: string; signatureAlgorithm: "curve25519"; tags: string; title: string; ts: number }

Type declaration

@context: "https://metanetwork.online/ns/cms"
@type: "author-media-sign"
@version: string
categories: string
claim: string
contentType: string
cover: string
license: string
nonce: string
platform: string
platformHash: string
publicKey: string
signature: string
signatureAlgorithm: "curve25519"
tags: string
title: string
ts: number

AuthorPostDigestMetadata

AuthorPostDigestMetadata: { @context: "https://metanetwork.online/ns/cms"; @type: "author-post-digest"; @version: string; algorithm: "sha256" | "sha512"; categories: string; content: string; cover: string; digest: string; license: string; summary: string; tags: string; title: string; ts: number }

Type declaration

@context: "https://metanetwork.online/ns/cms"
@type: "author-post-digest"
@version: string
algorithm: "sha256" | "sha512"
categories: string
content: string
cover: string
digest: string
license: string
summary: string
tags: string
title: string
ts: number

AuthorPostSignatureMetadata

AuthorPostSignatureMetadata: BaseSignatureMetadata & { claim: string; digest: string; nonce: string }

BaseSignatureMetadata

BaseSignatureMetadata: { @context: "https://metanetwork.online/ns/cms"; @type: string; @version: string; claim: string; nonce: string; publicKey: string; reference: { body: any; refer: string; rel: string }[]; signature: string; signatureAlgorithm: "curve25519"; ts: number }

Type declaration

@context: "https://metanetwork.online/ns/cms"
@type: string
@version: string
claim: string
nonce: string
publicKey: string
reference: { body: any; refer: string; rel: string }[]
signature: string
signatureAlgorithm: "curve25519"
ts: number

GridMaintenanceRequestMetadata

GridMaintenanceRequestMetadata: Partial<GridProperties> & { previousTx?: string }

KeyPair

KeyPair: { private: string; public: string }

Type declaration

private: string
public: string

KeyValuePair

KeyValuePair: [string, string]

MediaMetadata

MediaMetadata: { categories: string; contentType: string; cover: string; license: string; platform: string; platformHash: string; tags: string; title: string }

Type declaration

categories: string
contentType: string
cover: string
license: string
platform: string
platformHash: string
tags: string
title: string

MediaMetadataInPayload

MediaMetadataInPayload: { claim: string; contentType: string; nonce: string; platform: string; platformHash: string }

Type declaration

claim: string
contentType: string
nonce: string
platform: string
platformHash: string

MetadataInPayload

MetadataInPayload: { claim: string; nonce: string }

Type declaration

claim: string
nonce: string

MetadataInPayloadWithDigest

MetadataInPayloadWithDigest: MetadataInPayload & { digest: string }

MetadataInPayloadWithSignature

MetadataInPayloadWithSignature: MetadataInPayload & { signature: string }

PostMetadata

PostMetadata: { categories: string; content: string; cover: string; license: string; summary: string; tags: string; title: string }

Type declaration

categories: string
content: string
cover: string
license: string
summary: string
tags: string
title: string

Properties

authorMediaSign

authorMediaSign: { generate: (authorKeys: KeyPair, serverDomain: string, mediaMetadata: MediaMetadata) => AuthorMediaSignatureMetadata; verify: (metadata: AuthorMediaSignatureMetadata) => boolean }

Type declaration

generate: (authorKeys: KeyPair, serverDomain: string, mediaMetadata: MediaMetadata) => AuthorMediaSignatureMetadata
- - (authorKeys: KeyPair, serverDomain: string, mediaMetadata: MediaMetadata): AuthorMediaSignatureMetadata
  - Generate digest metadata for author's media (video, image and other type of medias).
    
    Parameters
    - authorKeys: KeyPair
      
      The author's keys to use for signing.
    - serverDomain: string
      
      The author claims to publish their post to this domain.
    - mediaMetadata: MediaMetadata
      
      an object containing metadata and hash (or IPFS CID) of the media
    Returns AuthorMediaSignatureMetadata
    metadata and generated digest of the post
verify: (metadata: AuthorMediaSignatureMetadata) => boolean
- - (metadata: AuthorMediaSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: AuthorMediaSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

authorPostDigest

authorPostDigest: { generate: (postMetadata: PostMetadata) => AuthorPostDigestMetadata; verify: (metadata: AuthorPostDigestMetadata) => boolean }

Type declaration

generate: (postMetadata: PostMetadata) => AuthorPostDigestMetadata
- - (postMetadata: PostMetadata): AuthorPostDigestMetadata
  - Generate digest metadata for author's post.
    
    Parameters
    - postMetadata: PostMetadata
      
      an object containing metadata and content of the post
    Returns AuthorPostDigestMetadata
    metadata and generated digest of the post
verify: (metadata: AuthorPostDigestMetadata) => boolean
- - (metadata: AuthorPostDigestMetadata): boolean
  - Verify the digest generated by the generate method.
    
    Parameters
    - metadata: AuthorPostDigestMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

authorPostDigestSign

authorPostDigestSign: { generate: (authorKeys: KeyPair, serverDomain: string, digest: string) => AuthorPostSignatureMetadata; verify: (metadata: AuthorPostSignatureMetadata) => boolean }

Type declaration

generate: (authorKeys: KeyPair, serverDomain: string, digest: string) => AuthorPostSignatureMetadata
- - (authorKeys: KeyPair, serverDomain: string, digest: string): AuthorPostSignatureMetadata
  - Generate signature metadata for the author's post digest.
    
    Parameters
    - authorKeys: KeyPair
      
      The author's keys to use for signing.
    - serverDomain: string
      
      The author claims to publish their post to this domain.
    - digest: string
      
      Should be generated by author-digest module.
    Returns AuthorPostSignatureMetadata
    The author's signature metadata of the post digest.
verify: (metadata: AuthorPostSignatureMetadata) => boolean
- - (metadata: AuthorPostSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: AuthorPostSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

authorPublishMetaSpaceRequest

authorPublishMetaSpaceRequest: { generate: (authorKeys: KeyPair, serverDomain: string) => BaseSignatureMetadata; verify: (metadata: BaseSignatureMetadata) => boolean }

Type declaration

generate: (authorKeys: KeyPair, serverDomain: string) => BaseSignatureMetadata
- - (authorKeys: KeyPair, serverDomain: string): BaseSignatureMetadata
  - Generate signature metadata of the author request to publish their Meta Space to a server.
    
    Parameters
    - authorKeys: KeyPair
      
      The author's keys to use for signing.
    - serverDomain: string
      
      The author claims to publish their Meta Space to this domain
    Returns BaseSignatureMetadata
verify: (metadata: BaseSignatureMetadata) => boolean
- - (metadata: BaseSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: BaseSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

authorPublishMetaSpaceServerVerificationSign

authorPublishMetaSpaceServerVerificationSign: { generate: (serverKeys: KeyPair, serverDomain: string, authorPublishMetaSpaceRequestMetadata: BaseSignatureMetadata, authorPublishMetaSpaceRequestMetadataRefer: string) => BaseSignatureMetadata; verify: (metadata: BaseSignatureMetadata) => boolean }

Type declaration

generate: (serverKeys: KeyPair, serverDomain: string, authorPublishMetaSpaceRequestMetadata: BaseSignatureMetadata, authorPublishMetaSpaceRequestMetadataRefer: string) => BaseSignatureMetadata
- - (serverKeys: KeyPair, serverDomain: string, authorPublishMetaSpaceRequestMetadata: BaseSignatureMetadata, authorPublishMetaSpaceRequestMetadataRefer: string): BaseSignatureMetadata
  - Generate the server's verification signature metadata for the author's request to publish their Meta Space to this server.
    
    Parameters
    - serverKeys: KeyPair
      
      The server keys to use for signing.
    - serverDomain: string
      
      The server domain to use in the claim.
    - authorPublishMetaSpaceRequestMetadata: BaseSignatureMetadata
      
      The author's publish request metadata object.
    - authorPublishMetaSpaceRequestMetadataRefer: string
      
      URI reference to the author's publish request metadata.
    Returns BaseSignatureMetadata
    The server's signed verification metadata.
verify: (metadata: BaseSignatureMetadata) => boolean
- - (metadata: BaseSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: BaseSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

metaNetworkGridsServerSign

metaNetworkGridsServerSign: { generate: (serverKeys: KeyPair, serverDomain: string, items: GridMaintenanceRequestMetadata[]) => BatchGridActionsMetadata; verify: (metadata: BatchGridActionsMetadata) => boolean }

Type declaration

generate: (serverKeys: KeyPair, serverDomain: string, items: GridMaintenanceRequestMetadata[]) => BatchGridActionsMetadata
- - (serverKeys: KeyPair, serverDomain: string, items: GridMaintenanceRequestMetadata[]): BatchGridActionsMetadata
  - Generate a batch grid actions metadata.
    
    Parameters
    - serverKeys: KeyPair
      
      The server keys to use for signing.
    - serverDomain: string
      
      The server domain to use in the claim.
    - items: GridMaintenanceRequestMetadata[]
      
      The maintain grid requests to generate the metadata.
    Returns BatchGridActionsMetadata
    Generated metadata.
verify: (metadata: BatchGridActionsMetadata) => boolean
- - (metadata: BatchGridActionsMetadata): boolean
  - Verify the digest and the signature of the batch grid actions metadata.
    
    Parameters
    - metadata: BatchGridActionsMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

serverVerificationSign

serverVerificationSign: { generate: (serverKeys: KeyPair, serverDomain: string, authorDigestSignatureMetadata: BaseSignatureMetadata, authorDigestSignatureMetadataRefer: string) => BaseSignatureMetadata; verify: (metadata: BaseSignatureMetadata) => boolean }

Type declaration

generate: (serverKeys: KeyPair, serverDomain: string, authorDigestSignatureMetadata: BaseSignatureMetadata, authorDigestSignatureMetadataRefer: string) => BaseSignatureMetadata
- - (serverKeys: KeyPair, serverDomain: string, authorDigestSignatureMetadata: BaseSignatureMetadata, authorDigestSignatureMetadataRefer: string): BaseSignatureMetadata
  - Generate the server's verification signature metadata for the author's signature metadata of their post digest.
    
    Parameters
    - serverKeys: KeyPair
      
      the server's private and public key pair
    - serverDomain: string
      
      The server domain to use in the claim.
    - authorDigestSignatureMetadata: BaseSignatureMetadata
      
      the author's signature metadata of their post digest or media
    - authorDigestSignatureMetadataRefer: string
      
      URI reference to the author's signature metadata of their post digest or media
    Returns BaseSignatureMetadata
    server's signed verification metadata
verify: (metadata: BaseSignatureMetadata) => boolean
- - (metadata: BaseSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: BaseSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

serverVerificationSignWithContent

serverVerificationSignWithContent: { generate: (authorPostDigestMetadata: AuthorPostDigestMetadata, authorPostDigestMetadataRefer: string, serverVerificationSignatureMetadata: BaseSignatureMetadata) => BaseSignatureMetadata; verify: (metadata: BaseSignatureMetadata) => boolean }

Type declaration

generate: (authorPostDigestMetadata: AuthorPostDigestMetadata, authorPostDigestMetadataRefer: string, serverVerificationSignatureMetadata: BaseSignatureMetadata) => BaseSignatureMetadata
- - (authorPostDigestMetadata: AuthorPostDigestMetadata, authorPostDigestMetadataRefer: string, serverVerificationSignatureMetadata: BaseSignatureMetadata): BaseSignatureMetadata
  - Bind the author's digest metadata (with post metadata and content) to the server's verification's reference.
    
    Parameters
    - authorPostDigestMetadata: AuthorPostDigestMetadata
      
      metadata and generated digest of the author's post
    - authorPostDigestMetadataRefer: string
      
      URI reference to the author's post digest metadata
    - serverVerificationSignatureMetadata: BaseSignatureMetadata
      
      server's signed verification metadata
    Returns BaseSignatureMetadata
    server's signed verification metadata with the reference
verify: (metadata: BaseSignatureMetadata) => boolean
- - (metadata: BaseSignatureMetadata): boolean
  - Verify the signature generated by the generate method.
    
    Parameters
    - metadata: BaseSignatureMetadata
      
      output of the generate method to get verified
    Returns boolean
    result

Functions

Const generateKeys

generateKeys(passphrase: string[]): { private: string; public: string }

- Defined in utils.ts:49
Generates a new key pair from the given seed and returns it as object. Each word of the passphrase array should be in the 'niceware' wordlist. see: https://www.npmjs.com/package/niceware

Parameters
- passphrase: string[]
Returns { private: string; public: string }
key pair
- private: string
- public: string

Const generateSeed

generateSeed(): string[]

- Defined in utils.ts:40
Generate a random 16 words (32bits length) passphrase as seed by niceware. You can pass the seed to generateKey function.

Returns string[]
passphrase array

Index

Interfaces

Type aliases

Properties

Functions

Type aliases

AuthorMediaSignatureMetadata

Type declaration

@context: "https://metanetwork.online/ns/cms"

@type: "author-media-sign"

@version: string

categories: string

claim: string

contentType: string

cover: string

license: string

nonce: string

platform: string

platformHash: string

publicKey: string

signature: string

signatureAlgorithm: "curve25519"

tags: string

title: string

ts: number

AuthorPostDigestMetadata

Type declaration

@context: "https://metanetwork.online/ns/cms"

@type: "author-post-digest"

@version: string

algorithm: "sha256" | "sha512"

categories: string

content: string

cover: string

digest: string

license: string

summary: string

tags: string

title: string

ts: number

AuthorPostSignatureMetadata

BaseSignatureMetadata

Type declaration

@context: "https://metanetwork.online/ns/cms"

@type: string

@version: string

claim: string

nonce: string

publicKey: string

reference: { body: any; refer: string; rel: string }[]

signature: string

signatureAlgorithm: "curve25519"

ts: number

GridMaintenanceRequestMetadata

KeyPair

Type declaration

private: string

public: string

KeyValuePair

MediaMetadata

Type declaration

categories: string

contentType: string

cover: string

license: string

platform: string

platformHash: string

tags: string

title: string

MediaMetadataInPayload

Type declaration

claim: string

contentType: string

nonce: string

platform: string

platformHash: string

MetadataInPayload

Type declaration

claim: string

nonce: string