Skip to main content

sdk.AWF_IpfsConnector

Constructors

constructor

new AWF_IpfsConnector(log, ceramic, config)

Parameters

NameType
logLogging
ceramicdefault
configAWF_Config

Defined in

sdk/src/common/ipfs.connector.ts:39

Methods

buildFallBackLink(hash): string

Parameters

NameType
hashstring | CID<unknown, number, number, Version>

Returns

string

Defined in

sdk/src/common/ipfs.connector.ts:206


buildIpfsLinks(hash): Object

Parameters

NameType
hashstring | CID<unknown, number, number, Version>

Returns

Object

NameType
fallbackLinkstring
originLinkstring
pathLinkstring

Defined in

sdk/src/common/ipfs.connector.ts:224


buildOriginLink(hash): string

Parameters

NameType
hashstring | CID<unknown, number, number, Version>

Returns

string

Defined in

sdk/src/common/ipfs.connector.ts:197


buildPathLink(hash): string

Parameters

NameType
hashstring | CID<unknown, number, number, Version>

Returns

string

Defined in

sdk/src/common/ipfs.connector.ts:215


catDocument

catDocument<T>(docHash, jsonResponse?): Promise<T>

Type parameters

Name
T

Parameters

NameTypeDefault value
docHashstring | CID<unknown, number, number, Version>undefined
jsonResponsebooleanfalse

Returns

Promise<T>

Defined in

sdk/src/common/ipfs.connector.ts:158


getLegalDoc

getLegalDoc(doc): Promise<never>

Parameters

NameTypeDescription
docLEGAL_DOCSlegal docs

Returns

Promise<never>

Defined in

sdk/src/common/ipfs.connector.ts:179


getSettings

getSettings(): Object

Returns

Object

NameType
fallbackGatewaystring
originGatewaystring
pathGatewaystring

Defined in

sdk/src/common/ipfs.connector.ts:50


multiAddrToUri

multiAddrToUri(addrList): string[]

Parameters

NameType
addrListstring[]

Returns

string[]

Defined in

sdk/src/common/ipfs.connector.ts:243


transformBase16HashToV1

transformBase16HashToV1(hash): CID<unknown, number, number, 1>

Parameters

NameType
hashstring

Returns

CID<unknown, number, number, 1>

Defined in

sdk/src/common/ipfs.connector.ts:237


uploadFile

uploadFile(file): Promise<undefined | AnyLink>

Parameters

NameType
fileBlob

Returns

Promise<undefined | AnyLink>

Defined in

sdk/src/common/ipfs.connector.ts:138


validateCid

validateCid(hash): { cid: undefined ; link: string = hash } | { cid: CID<unknown, number, number, Version> ; link?: undefined = hash }

Parameters

NameType
hashstring | CID<unknown, number, number, Version>

Returns

{ cid: undefined ; link: string = hash } | { cid: CID<unknown, number, number, Version> ; link?: undefined = hash }

Defined in

sdk/src/common/ipfs.connector.ts:185