Interface ApplicableActionsAPIExperimental

computeEnvironment

applyInput

• applyInput(contractId, request): Promise<TxId>

• Applies an ApplicableInput to a contract.

  Parameters

  • contractId: ContractId

  • request: ApplyApplicableInputRequest

  Returns Promise<TxId>

  The transaction id of the applied input.

getApplicableActions

• getApplicableActions(contractDetails, environment?): Promise<ApplicableAction[]>

• Get what actions can be applied to a contract in a given environment.

  Parameters

  • contractDetails: ContractDetails

  • Optional environment: Environment

    An optional interval with the time bounds to apply the actions. If none is provided the environment is computed using the runtime tip as a lower bound and the next timeout as an upper bound.

  Returns Promise<ApplicableAction[]>

  An object with an array of applicable actions and the contract details

getInput

• getInput(contractDetails, action): Promise<ApplicableInput>

• Converts an ApplicableAction into an ApplicableInput.

  This function has two overloads. This one can be used with Notify, Deposit actions, or to Advance a timed out contract, none of which require further information.

  Parameters

  • contractDetails: ActiveContract

  • action: CanNotify | CanDeposit | CanAdvance

  Returns Promise<ApplicableInput>
• getInput(contractDetails, action, chosenNum): Promise<ApplicableInput>

• Converts an ApplicableAction into an ApplicableInput.

  This function has two overloads. This one can be used with the Choose action, which requires the chosen number.

  Parameters

  • contractDetails: ActiveContract

  • action: CanChoose

  • chosenNum: bigint

  Returns Promise<ApplicableInput>

mkFilter

• mkFilter(contractDetails): Promise<ApplicableActionsFilter>

• Creates a filter function for the applicable actions of the wallet owner. The wallet is configured when we instantiate the RuntimeLifecycle. This function returns a new filter function when called multiple times. This is useful to update the filter to check for new Role tokens available in the wallet.

  The function has two overloads. This one is appied with the contract details and it is useful when filtering the actions of a specific contract.

  Parameters

  • contractDetails: ActiveContract

  Returns Promise<ApplicableActionsFilter>
• mkFilter(): Promise<ApplicableActionsWithDetailsFilter>

• Creates a filter function for the applicable actions of the wallet owner. The wallet is configured when we instantiate the RuntimeLifecycle. This function returns a new filter function when called multiple times. This is useful to update the filter to check for new Role tokens available in the wallet.

  The function has two overloads. This one does not receive any argument and it is useful when filtering the actions of multiple contracts. Notice that the filter function returned by this overload will require the contract details to be passed as a second argument.

  Returns Promise<ApplicableActionsWithDetailsFilter>

simulateInput

• simulateInput(contractDetails, input): TransactionSuccess

• Simulates the result of applying an ApplicableInput. The input should be obtained by computing the applicable actions and then converting them into an input.

  Parameters

  • contractDetails: ActiveContract

  • input: ApplicableInput

  Returns TransactionSuccess

  If the input was obtained by the described flow, it is guaranteed to return a TransactionSuccess with the payments, state, warnings and new continuation.