Class ProgramMessageClient

Hierarchy

DefaultMessageClient<
    ProgramPublishConfiguration,
    ProgramContent,
    CostEstimationProgramPublishConfiguration,
    CostEstimationProgramContent,
>
- ProgramMessageClient

Index

Constructors

Properties

apiServer baseMessageClient messageType storeMessageClient

Methods

getCost getCostComputableMessage getEstimatedCost prepareBaseContent prepareCostEstimationMessageContent prepareMessageContent publish spawn

Constructors

constructor

new ProgramMessageClient(
    apiServer?: string,
    baseMessageClient?: BaseMessageClient,
    storeMessageClient?: StoreMessageClient,
): ProgramMessageClient
Parameters
- apiServer: string = DEFAULT_API_V2
- baseMessageClient: BaseMessageClient = ...
- storeMessageClient: StoreMessageClient = ...
Returns ProgramMessageClient
Overrides DefaultMessageClient< ProgramPublishConfiguration, ProgramContent, CostEstimationProgramPublishConfiguration, CostEstimationProgramContent >.constructor
- Defined in message/src/program/impl.ts:28

Properties

`Protected`apiServer

apiServer: string

`Protected`baseMessageClient

baseMessageClient: BaseMessageClient = ...

`Protected`messageType

messageType: MessageType

`Protected`storeMessageClient

storeMessageClient: StoreMessageClient = ...

Methods

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: CostEstimationProgramPublishConfiguration,
): Promise<CostComputableMessage<CostEstimationProgramContent>>
Parameters
- config: CostEstimationProgramPublishConfiguration
Returns Promise<CostComputableMessage<CostEstimationProgramContent>>
Inherited from DefaultMessageClient.getCostComputableMessage
- Defined in message/src/utils/base.ts:42

getEstimatedCost

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

`Protected`prepareBaseContent

prepareBaseContent(
    __namedParameters: Omit<
        ProgramPublishConfiguration,
        "programRef"
        | "file",
    >,
): Omit<ProgramContent, "code">
Parameters
- __namedParameters: Omit<ProgramPublishConfiguration, "programRef" | "file">
Returns Omit<ProgramContent, "code">
- Defined in message/src/program/impl.ts:192

`Protected`prepareCostEstimationMessageContent

prepareCostEstimationMessageContent(
config: CostEstimationProgramPublishConfiguration,
): Promise<CostEstimationProgramContent>
Parameters
- config: CostEstimationProgramPublishConfiguration
Returns Promise<CostEstimationProgramContent>
Overrides DefaultMessageClient.prepareCostEstimationMessageContent
- Defined in message/src/program/impl.ts:66

`Protected`prepareMessageContent

prepareMessageContent(
config: ProgramPublishConfiguration,
): Promise<ProgramContent>
Parameters
- config: ProgramPublishConfiguration
Returns Promise<ProgramContent>
Overrides DefaultMessageClient.prepareMessageContent
- Defined in message/src/program/impl.ts:139

publish

publish(conf: ProgramPublishConfiguration): Promise<ProgramMessage>
Parameters
- conf: ProgramPublishConfiguration
Returns Promise<ProgramMessage>
- Defined in message/src/program/impl.ts:36

spawn

spawn(__namedParameters: ProgramSpawnConfiguration): Promise<ProgramMessage>
Parameters
- __namedParameters: ProgramSpawnConfiguration
Returns Promise<ProgramMessage>
- Defined in message/src/program/impl.ts:98

Class ProgramMessageClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProgramMessageClient

Properties

ProtectedapiServer

ProtectedbaseMessageClient

ProtectedmessageType

ProtectedstoreMessageClient

Methods

getCost

Parameters

Returns Promise<MessageCost>

getCostComputableMessage

Parameters

Returns Promise<CostComputableMessage<CostEstimationProgramContent>>

getEstimatedCost

Parameters

Returns Promise<MessageCost>

ProtectedprepareBaseContent

Parameters

Returns Omit<ProgramContent, "code">

ProtectedprepareCostEstimationMessageContent

Parameters

Returns Promise<CostEstimationProgramContent>

ProtectedprepareMessageContent

Parameters

Returns Promise<ProgramContent>

publish

Parameters

Returns Promise<ProgramMessage>

spawn

Parameters

Returns Promise<ProgramMessage>

Settings

On This Page

`Protected`apiServer

`Protected`baseMessageClient

`Protected`messageType

`Protected`storeMessageClient

`Protected`prepareBaseContent

`Protected`prepareCostEstimationMessageContent

`Protected`prepareMessageContent