Class BlossomClient

constructor

• new BlossomClient(server, signer?): BlossomClient

• Parameters

  • server: string | URL
  • Optional signer: Signer

  Returns BlossomClient

server

Optional signer

deleteBlob

• deleteBlob(hash, auth?): Promise<string>

• Parameters

  • hash: string
  • auth: boolean | SignedEvent = true

  Returns Promise<string>

getBlob

• getBlob(hash, auth?): Promise<Blob>

• Parameters

  • hash: string
  • auth: boolean | SignedEvent = false

  Returns Promise<Blob>

getDeleteAuth

• getDeleteAuth(hash, message?, expiration?): Promise<SignedEvent>

• Parameters

  • hash: string
  • Optional message: string
  • Optional expiration: number

  Returns Promise<SignedEvent>

getGetAuth

• getGetAuth(message, serverOrHash, expiration?): Promise<SignedEvent>

• Parameters

  • message: string
  • serverOrHash: string
  • Optional expiration: number

  Returns Promise<SignedEvent>

getListAuth

• getListAuth(message?, expiration?): Promise<SignedEvent>

• Parameters

  • Optional message: string
  • Optional expiration: number

  Returns Promise<SignedEvent>

getMirrorAuth

• getMirrorAuth(sha256, message?, expiration?): Promise<SignedEvent>

• Parameters

  • sha256: string
  • Optional message: string
  • Optional expiration: number

  Returns Promise<SignedEvent>

getUploadAuth

• getUploadAuth(file, message?, expiration?): Promise<SignedEvent>

• Parameters

  • file: UploadType
  • Optional message: string
  • Optional expiration: number

  Returns Promise<SignedEvent>

hasBlob

• hasBlob(hash): Promise<boolean>

• Parameters

  • hash: string

  Returns Promise<boolean>

listBlobs

• listBlobs(pubkey, opts?, auth?): Promise<BlobDescriptor[]>

• Parameters

  • pubkey: string
  • Optional opts: {
        since?: number;
        until?: number;
    }

    • Optional since?: number

    • Optional until?: number

  • auth: boolean | SignedEvent = false

  Returns Promise<BlobDescriptor[]>

mirrorBlob

• mirrorBlob(sha256, url, auth?): Promise<BlobDescriptor>

• Parameters

  • sha256: string
  • url: string | URL
  • auth: boolean | SignedEvent = true

  Returns Promise<BlobDescriptor>

uploadBlob

• uploadBlob(file, auth?): Promise<BlobDescriptor>

• Parameters

  • file: UploadType
  • auth: boolean | SignedEvent = true

  Returns Promise<BlobDescriptor>

Static createUploadAuth

• createUploadAuth(sha256, signer, message?, expiration?): Promise<SignedEvent>

• Creates an upload auth event

  Parameters

  • sha256: string | string[]

    one or an array of sha256 hashes
  • signer: Signer

    the signer to use for signing the event
  • message: string = "Upload Blob"

    A human readable explanation of what the auth token will be used for
  • expiration: number = ...

    The expiration time in seconds

  Returns Promise<SignedEvent>

Static deleteBlob

• deleteBlob(server, hash, auth?): Promise<string>

• Parameters

  • server: ServerType
  • hash: string
  • Optional auth: SignedEvent

  Returns Promise<string>

Static encodeAuthorizationHeader

• encodeAuthorizationHeader(event): string

• Parameters

  • event: SignedEvent

  Returns string

Static getBlob

• getBlob(server, hash, auth?): Promise<Blob>

• Parameters

  • server: ServerType
  • hash: string
  • Optional auth: SignedEvent

  Returns Promise<Blob>

Static getDeleteAuth

• getDeleteAuth(hash, signer, message?, expiration?): Promise<SignedEvent>

• Parameters

  • hash: string | string[]
  • signer: Signer
  • message: string = "Delete Blob"
  • expiration: number = ...

  Returns Promise<SignedEvent>

Static getFileSha256

• getFileSha256(file): Promise<string>

• Parameters

  • file: UploadType

  Returns Promise<string>

Static getGetAuth

• getGetAuth(signer, message, serverOrHash, expiration?): Promise<SignedEvent>

• Creates a get auth event

  Parameters

  • signer: Signer

    the signer to use for signing the event
  • message: string

    A human readable explanation of what the auth token will be used for
  • serverOrHash: string | string[]

    A server URL or one or many blob hashes
  • expiration: number = ...

    The expiration time in seconds

  Returns Promise<SignedEvent>

Static getListAuth

• getListAuth(signer, message?, expiration?): Promise<SignedEvent>

• Parameters

  • signer: Signer
  • message: string = "List Blobs"
  • expiration: number = ...

  Returns Promise<SignedEvent>

Static getUploadAuth

• getUploadAuth(file, signer, message?, expiration?): Promise<SignedEvent>

• Creates a one-off upload auth event for a file

  Parameters

  • file: UploadType
  • signer: Signer
  • message: string = "Upload Blob"
  • expiration: number = ...

  Returns Promise<SignedEvent>

Static hasBlob

• hasBlob(server, hash): Promise<boolean>

• Parameters

  • server: ServerType
  • hash: string

  Returns Promise<boolean>

Static listBlobs

• listBlobs(server, pubkey, opts?, auth?): Promise<BlobDescriptor[]>

• Parameters

  • server: ServerType
  • pubkey: string
  • Optional opts: {
        since?: number;
        until?: number;
    }

    • Optional since?: number

    • Optional until?: number

  • Optional auth: SignedEvent

  Returns Promise<BlobDescriptor[]>

Static mirrorBlob

• mirrorBlob(server, url, auth?): Promise<BlobDescriptor>

• Parameters

  • server: ServerType
  • url: string | URL
  • Optional auth: SignedEvent

  Returns Promise<BlobDescriptor>

Static uploadBlob

• uploadBlob(server, file, auth?): Promise<BlobDescriptor>

• Parameters

  • server: ServerType
  • file: UploadType
  • Optional auth: SignedEvent

  Returns Promise<BlobDescriptor>