Class StoreMessageClient

Hierarchy

DefaultMessageClient<
    StorePublishConfiguration,
    StoreContent,
    CostEstimationStorePublishConfiguration,
    CostEstimationStoreContent,
>
- StoreMessageClient

Index

Constructors

Properties

Methods

download getCost getCostComputableMessage getEstimatedCost getFile getFileMetadata getFileMetadataByMessageHash getFileMetadataByRef getFilePinsCount getHash pin prepareCostEstimationMessageContent prepareMessageContent send uploadStore

Constructors

constructor

new StoreMessageClient(apiServer?: string): StoreMessageClient
Parameters
- apiServer: string = DEFAULT_API_V2
Returns StoreMessageClient
Overrides DefaultMessageClient< StorePublishConfiguration, StoreContent, CostEstimationStorePublishConfiguration, CostEstimationStoreContent >.constructor
- Defined in message/src/store/impl.ts:28

Properties

`Protected`apiServer

apiServer: string

`Protected`messageType

messageType: MessageType

Methods

download

download(fileHash: string): Promise<ArrayBuffer>
Retrieves a file from the network.
Parameters
- fileHash: string
  The item_hash of the STORE message of the file to retrieve.
Returns Promise<ArrayBuffer>
- Defined in message/src/store/impl.ts:37

getCost

getCost(hash: string): Promise<MessageCost>
Parameters
- hash: string
Returns Promise<MessageCost>
Inherited from DefaultMessageClient.getCost
- Defined in message/src/utils/base.ts:27

getCostComputableMessage

getCostComputableMessage(
config: CostEstimationStorePublishConfiguration,
): Promise<CostComputableMessage<CostEstimationStoreContent>>
Parameters
- config: CostEstimationStorePublishConfiguration
Returns Promise<CostComputableMessage<CostEstimationStoreContent>>
Inherited from DefaultMessageClient.getCostComputableMessage
- Defined in message/src/utils/base.ts:42

getEstimatedCost

getEstimatedCost(
config: CostEstimationStorePublishConfiguration,
): Promise<MessageCost>
Parameters
- config: CostEstimationStorePublishConfiguration
Returns Promise<MessageCost>
Inherited from DefaultMessageClient.getEstimatedCost
- Defined in message/src/utils/base.ts:33

getFile

getFile(fileHash: string): Promise<StorageHashResponse>
Retrieves a stored file by its hash, returning the (base64 encoded) content alongside its storage metadata.
Parameters
- fileHash: string
  The hash of the file to retrieve.
Returns Promise<StorageHashResponse>
- Defined in message/src/store/impl.ts:51

getFileMetadata

getFileMetadata(fileHash: string): Promise<Record<string, any>>
Retrieves the raw stored metadata of a file by its hash.
Parameters
- fileHash: string
  The hash of the file.
Returns Promise<Record<string, any>>
- Defined in message/src/store/impl.ts:88

getFileMetadataByMessageHash

getFileMetadataByMessageHash(messageHash: string): Promise<FileMetadataResponse>
Retrieves a file's metadata from the hash of the STORE message that references it.
Parameters
- messageHash: string
  The hash of the STORE message.
Returns Promise<FileMetadataResponse>
- Defined in message/src/store/impl.ts:63

getFileMetadataByRef

getFileMetadataByRef(ref: string): Promise<FileMetadataResponse>
Retrieves a file's metadata from its reference.
Parameters
- ref: string
  The reference of the file.
Returns Promise<FileMetadataResponse>
- Defined in message/src/store/impl.ts:76

getFilePinsCount

getFilePinsCount(hash: string): Promise<number>
Retrieves the number of pins referencing a given file hash.
Parameters
- hash: string
  The hash of the file.
Returns Promise<number>
- Defined in message/src/store/impl.ts:100

`Protected`getHash

getHash(
    buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    storageEngine: ItemType,
    fileHash: undefined | string,
    apiServer: string,
): Promise<string>
Parameters
- buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
- storageEngine: ItemType
- fileHash: undefined | string
- apiServer: string
Returns Promise<string>
- Defined in message/src/store/impl.ts:149

pin(spc: StorePinConfiguration): Promise<StoreMessage>
Publishes a store message, containing a hash to pin an IPFS file. You also have to provide default message properties, such as the targeted channel or the account used to sign the message.
Parameters
- spc: StorePinConfiguration
  The configuration used to pin the file.
Returns Promise<StoreMessage>
- Defined in message/src/store/impl.ts:217

`Protected`prepareCostEstimationMessageContent

prepareCostEstimationMessageContent(
config: CostEstimationStorePublishConfiguration,
): Promise<CostEstimationStoreContent>
Parameters
- config: CostEstimationStorePublishConfiguration
Returns Promise<CostEstimationStoreContent>
Overrides DefaultMessageClient.prepareCostEstimationMessageContent
- Defined in message/src/store/impl.ts:229

`Protected`prepareMessageContent

prepareMessageContent(
__namedParameters: StorePublishConfiguration,
): Promise<StoreContent>
Parameters
- __namedParameters: StorePublishConfiguration
Returns Promise<StoreContent>
Overrides DefaultMessageClient.prepareMessageContent
- Defined in message/src/store/impl.ts:249

send

send(conf: StorePublishConfiguration): Promise<StoreMessage>
Publishes a store message, containing a File. You also have to provide default message properties, such as the targeted channel or the account used to sign the message.
Parameters
- conf: StorePublishConfiguration
Returns Promise<StoreMessage>
- Defined in message/src/store/impl.ts:113

`Protected`uploadStore

uploadStore(
    message: HashedMessage<StoreContent>,
    account: Account,
    file: Blob | File,
    sync: boolean,
): Promise<
    {
        message: SignedMessage<StoreContent>;
        response: { hash: string; status: string };
    },
>
Parameters
- message: HashedMessage<StoreContent>
- account: Account
- file: Blob | File
- sync: boolean
Returns Promise<
    {
        message: SignedMessage<StoreContent>;
        response: { hash: string; status: string };
    },
>
- Defined in message/src/store/impl.ts:174

Class StoreMessageClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StoreMessageClient

Properties

ProtectedapiServer

ProtectedmessageType

Methods

download

Parameters

Returns Promise<ArrayBuffer>

getCost

Parameters

Returns Promise<MessageCost>

getCostComputableMessage

Parameters

Returns Promise<CostComputableMessage<CostEstimationStoreContent>>

getEstimatedCost

Parameters

Returns Promise<MessageCost>

getFile

Parameters

Returns Promise<StorageHashResponse>

getFileMetadata

Parameters

Returns Promise<Record<string, any>>

getFileMetadataByMessageHash

Parameters

Returns Promise<FileMetadataResponse>

getFileMetadataByRef

Parameters

Returns Promise<FileMetadataResponse>

getFilePinsCount

Parameters

Returns Promise<number>

ProtectedgetHash

Parameters

Returns Promise<string>

pin

Parameters

Returns Promise<StoreMessage>

ProtectedprepareCostEstimationMessageContent

Parameters

Returns Promise<CostEstimationStoreContent>

ProtectedprepareMessageContent

Parameters

Returns Promise<StoreContent>

send

Parameters

Returns Promise<StoreMessage>

ProtecteduploadStore

Parameters

Returns Promise< { message: SignedMessage<StoreContent>; response: { hash: string; status: string }; },>

Settings

On This Page

`Protected`apiServer

`Protected`messageType

`Protected`getHash

`Protected`prepareCostEstimationMessageContent

`Protected`prepareMessageContent

`Protected`uploadStore

Returns Promise<
{
message: SignedMessage<StoreContent>;
response: { hash: string; status: string };
},
>