Interface ContractsAPI

This Interface provides capabilities for runnning a Contract over Cardano.

Hierarchy

ContractsAPI

Index

Methods

applyInputs createContract getApplicableInputs getContractIds getInputHistory

Methods

applyInputs

applyInputs(contractId, applyInputsRequest): Promise<TxId>
Submit to the Cardano Ledger, the Transaction(Tx) that will apply inputs to a given created contract.
Parameters
- contractId: ContractId
  
  Contract Id where inputs will be applied
- applyInputsRequest: ApplyInputsRequest
  
  inputs to apply
Returns Promise<TxId>

Throws
DecodingError
- Defined in packages/runtime/lifecycle/src/generic/contracts.ts:285

createContract

createContract(createContractRequest): Promise<[ContractId, TxId]>
Submit to the Cardano Ledger, the Transaction(Tx) that will create the Marlowe Contract passed in the request.
Parameters
- createContractRequest: CreateContractRequest
  
  Request parameters for creating a Marlowe Contract on Cardano
Returns Promise<[ContractId, TxId]>
ContractId (Marlowe id) and TxId (Cardano id) of the submitted Tx

Throws
DecodingError
- Defined in packages/runtime/lifecycle/src/generic/contracts.ts:277

getApplicableInputs

getApplicableInputs(contractId, environement): 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;
}>
Parameters
- contractId: ContractId
- environement: Environment
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;
}>

Deprecated
Deprecated in favour of ApplicableActionsAPI
- Defined in packages/runtime/lifecycle/src/generic/contracts.ts:290

getContractIds

getContractIds(): Promise<ContractId[]>
Returns Promise<ContractId[]>

Description
Fetches all contract ids for contracts on chain that mentions an address in your wallet.

Throws
Error | DecodingError
- Defined in packages/runtime/lifecycle/src/generic/contracts.ts:297

getInputHistory

getInputHistory(contractId): Promise<SingleInputTx[]>
Get a list of the applied inputs for a given contract
Parameters
- contractId: ContractId
Returns Promise<SingleInputTx[]>
- Defined in packages/runtime/lifecycle/src/generic/contracts.ts:303

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 ContractsAPI

Hierarchy

Index

Methods

Methods

applyInputs

Parameters

contractId: ContractId

applyInputsRequest: ApplyInputsRequest

Returns Promise<TxId>

Throws

createContract

Parameters

createContractRequest: CreateContractRequest

Returns Promise<[ContractId, TxId]>

Throws

getApplicableInputs

Parameters

contractId: ContractId

environement: Environment

Deprecated

getContractIds

Returns Promise<ContractId[]>

Description

Throws

getInputHistory

Parameters

contractId: ContractId

Returns Promise<SingleInputTx[]>

Settings

Member Visibility

Theme

On This Page