Interface RestClient

The RestClient offers a simple abstraction for the Marlowe Runtime REST API endpoints. You can create an instance of the RestClient using the mkRestClient function.

import { mkRestClient } from "@marlowe.io/runtime-rest-client";
const restClient = mkRestClient("http://localhost:8080");
const isHealthy = await restClient.healthcheck();

Remarks

This version of the RestClient targets version 0.0.5 of the Marlowe Runtime.

Hierarchy

RestClient

Methods

applyInputsToContract

applyInputsToContract(request): Promise<TransactionTextEnvelope>
Create an unsigned transaction which applies inputs to a contract.
Parameters
- request: ApplyInputsToContractRequest
Returns Promise<TransactionTextEnvelope>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:155

buildCreateContractTx

buildCreateContractTx(request): Promise<BuildCreateContractTxResponse>
Builds an unsigned transaction to create an instance of a Marlowe Contract.
Parameters
- request: BuildCreateContractTxRequest
  
  Request parameters including the Contract to create, role information, metadata, etc.
Returns Promise<BuildCreateContractTxResponse>
An object with the CBOR encoded transaction to sign (using the signTx function) and submit to the blockchain (using the TODO method).

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:81

createContractSources

createContractSources(request): Promise<CreateContractSourcesResponse>
Uploads a marlowe-object bundle to the runtime, giving back the hash of the main contract and the hashes of the intermediate objects.
Parameters
- request: CreateContractSourcesRequest
Returns Promise<CreateContractSourcesResponse>
- Defined in packages/runtime/client/rest/src/index.ts:89

getContractById

getContractById(request): Promise<ContractDetails>
Gets a single contract by id
Parameters
- request: {
  contractId: Branded<string, ContractIdBrand>;
  }
  - contractId: Branded<string, ContractIdBrand>
Returns Promise<ContractDetails>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:129

getContractSourceAdjacency

getContractSourceAdjacency(request): Promise<GetContractSourceAdjacencyResponse>
Get the contract source IDs which are adjacent to a contract source (they appear directly in the contract source).
Parameters
- request: GetContractSourceAdjacencyRequest
Returns Promise<GetContractSourceAdjacencyResponse>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:103

getContractSourceById

getContractSourceById(request): Promise<Contract>
Gets the contract associated with given source id
Parameters
- request: GetContractBySourceIdRequest
Returns Promise<Contract>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:96

getContractSourceClosure

getContractSourceClosure(request): Promise<GetContractSourceClosureResponse>
Get the contract source IDs which appear in the full hierarchy of a contract source (including the ID of the contract source itself).
Parameters
- request: GetContractSourceClosureRequest
Returns Promise<GetContractSourceClosureResponse>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:112

getContractTransactionById

getContractTransactionById(request): Promise<TransactionDetails>
Gets full transaction details for a specific applyInput transaction of a contract
Parameters
- request: GetContractTransactionByIdRequest
Returns Promise<TransactionDetails>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:173

getContracts

getContracts(request?): Promise<GetContractsResponse>
Gets a paginated list of contracts ContractHeader
Parameters
- Optional request: GetContractsRequest
  
  Optional filtering and pagination options.
Returns Promise<GetContractsResponse>

Throws
DecodingError If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:71

getNextStepsForContract

getNextStepsForContract(request): Promise<{
applicable_inputs: { notify: Option<{ case_index: bigint; is_merkleized_continuation: boolean; }>; deposits: { case_index: bigint; party: Address | Role; can_deposit: bigint; of_token: Token; into_account: Address | Role; is_merkleized_continuation: boolean; }[]; choices: { ...; }[]; };
can_reduce: boolean;
}>
Get inputs which could be performed on a contract within a time range by the requested parties.
Parameters
- request: GetNextStepsForContractRequest
Returns Promise<{
applicable_inputs: { notify: Option<{ case_index: bigint; is_merkleized_continuation: boolean; }>; deposits: { case_index: bigint; party: Address | Role; can_deposit: bigint; of_token: Token; into_account: Address | Role; is_merkleized_continuation: boolean; }[]; choices: { ...; }[]; };
can_reduce: boolean;
}>

Throws
DecodingError - If the response from the server can't be decoded

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:121

getPayoutById

getPayoutById(request): Promise<GetPayoutByIdResponse>
Get payout information associated with payout ID
Parameters
- request: GetPayoutByIdRequest
Returns Promise<GetPayoutByIdResponse>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:213

getPayouts

getPayouts(request): Promise<GetPayoutsResponse>
Get payouts to parties from role-based contracts.
Parameters
- request: GetPayoutsRequest
Returns Promise<GetPayoutsResponse>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:207

getTransactionsForContract

getTransactionsForContract(request): Promise<GetTransactionsForContractResponse>
Gets a paginated list of TxHeader for a given contract.
Parameters
- request: GetTransactionsForContractRequest
Returns Promise<GetTransactionsForContractResponse>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:144

getWithdrawalById

getWithdrawalById(request): Promise<GetWithdrawalByIdResponse>
Get published withdrawal transaction by ID.
Parameters
- request: GetWithdrawalByIdRequest
Returns Promise<GetWithdrawalByIdResponse>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:196

getWithdrawals

getWithdrawals(request?): Promise<{
    page: ({ total: number; }) & {
        current?: Branded<string, ItemRangeBrand>;
    } & {
        next?: Branded<string, ItemRangeBrand>;
    };
    withdrawals: ({ withdrawalId: WithdrawalId; status: "unsigned" | "submitted" | "confirmed"; block: Option<{ slotNo: bigint; blockNo: bigint; blockHeaderHash: string; }>; })[];
}>
Get published withdrawal transactions.
Parameters
- Optional request: GetWithdrawalsRequest
Returns Promise<{
    page: ({ total: number; }) & {
        current?: Branded<string, ItemRangeBrand>;
    } & {
        next?: Branded<string, ItemRangeBrand>;
    };
    withdrawals: ({ withdrawalId: WithdrawalId; status: "unsigned" | "submitted" | "confirmed"; block: Option<{ slotNo: bigint; blockNo: bigint; blockHeaderHash: string; }>; })[];
}>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:189

healthcheck

healthcheck(): Promise<RuntimeStatus>
Runtime Healthcheck checks if the Marlowe API is up and running. It also provides a Set of Runtime Environment information (Tips, NetworkId and Runtime Version Deployed)

Returns Promise<RuntimeStatus>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:58

submitContract

submitContract(request): Promise<void>
Submits a signed contract creation transaction
Parameters
- request: SubmitContractRequest
Returns Promise<void>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:135

submitContractTransaction

submitContractTransaction(request): Promise<void>
Submit a signed transaction (generated with applyInputsToContract and signed with the signTx procedure) that applies inputs to a contract.
Parameters
- request: SubmitContractTransactionRequest
Returns Promise<void>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:164

submitWithdrawal

submitWithdrawal(request): Promise<void>
Submit a signed transaction (generated with withdrawPayouts and signed with the signTx procedure) that withdraws available payouts from a contract.
Parameters
- request: SubmitWithdrawalRequest
Returns Promise<void>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:201

version

version(): Promise<Branded<string, RuntimeVersionBrand>>
Returns the version of the connected runtime.

Returns Promise<Branded<string, RuntimeVersionBrand>>
- Defined in packages/runtime/client/rest/src/index.ts:63

withdrawPayouts

withdrawPayouts(request): Promise<{
tx: TextEnvelope;
withdrawalId: WithdrawalId;
}>
Build an unsigned transaction (sign with the signTx procedure) which withdraws available payouts from a contract (when applied with the submitWithdrawal procedure).
Parameters
- request: WithdrawPayoutsRequest
Returns Promise<{
tx: TextEnvelope;
withdrawalId: WithdrawalId;
}>

See
The backend documentation
- Defined in packages/runtime/client/rest/src/index.ts:183

Prototype Demos	Tools	Github Repositories	Resources	Legal
Payouts	Playground	Marlowe ts-sdk	IOG Tech Support	Cookie Policy
Token Plan	Preprod Runner	Payout Prototype	Documentation	Privacy Policy
	Marlowe Scan	Token Plan Prototype	Blog	Terms of Use
			Official Website

Interface RestClient

Remarks

Hierarchy

Index

Methods

Methods

applyInputsToContract

Parameters

request: ApplyInputsToContractRequest

Returns Promise<TransactionTextEnvelope>

See

buildCreateContractTx

Parameters

request: BuildCreateContractTxRequest

Returns Promise<BuildCreateContractTxResponse>

Throws

See

createContractSources

Parameters

request: CreateContractSourcesRequest

Returns Promise<CreateContractSourcesResponse>

getContractById

Parameters

request: { contractId: Branded<string, ContractIdBrand>; }

contractId: Branded<string, ContractIdBrand>

Returns Promise<ContractDetails>

Throws

See

getContractSourceAdjacency

Parameters

request: GetContractSourceAdjacencyRequest

Returns Promise<GetContractSourceAdjacencyResponse>

Throws

See

getContractSourceById

Parameters

request: GetContractBySourceIdRequest

Returns Promise<Contract>

Throws

See

getContractSourceClosure

Parameters

request: GetContractSourceClosureRequest

Returns Promise<GetContractSourceClosureResponse>

Throws

See

getContractTransactionById

Parameters

request: GetContractTransactionByIdRequest

Returns Promise<TransactionDetails>

Throws

See

getContracts

Parameters

Optional request: GetContractsRequest

Returns Promise<GetContractsResponse>

Throws

See

getNextStepsForContract

Parameters

request: GetNextStepsForContractRequest

Throws

See

getPayoutById

Parameters

request: GetPayoutByIdRequest

Returns Promise<GetPayoutByIdResponse>

See

getPayouts

Parameters

request: GetPayoutsRequest

Returns Promise<GetPayoutsResponse>

See

getTransactionsForContract

Parameters

request: GetTransactionsForContractRequest

Returns Promise<GetTransactionsForContractResponse>

See

getWithdrawalById

Parameters

request: {
contractId: Branded<string, ContractIdBrand>;
}

`Optional` request: GetContractsRequest

`Optional` request: GetWithdrawalsRequest

Returns Promise<{
tx: TextEnvelope;
withdrawalId: WithdrawalId;
}>