Skip to content

@codesoul-co/hypha-adapters-local / execution-provider-values

Using this module

Use the Execution provider values module for binding external or local providers to Hypha ports. It exports 5 functions.

Import from the package entrypoint

ts
import {
  cloneExecutionValue,
  hashExecutionBytes,
  hashExecutionText,
  hashExecutionValue,
  shortExecutionHash,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

  • The module exposes 5 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

SymbolKindSignatureDescription
cloneExecutionValuefunctioncloneExecutionValue<T>(value: T): TClone Execution Value function with 1 public call signature; parameters and return types are listed below.
hashExecutionBytesfunctionhashExecutionBytes(value: Uint8Array): stringHash Execution Bytes function with 1 public call signature; parameters and return types are listed below.
hashExecutionTextfunctionhashExecutionText(value: string): stringHash Execution Text function with 1 public call signature; parameters and return types are listed below.
hashExecutionValuefunctionhashExecutionValue(value: unknown): stringHash Execution Value function with 1 public call signature; parameters and return types are listed below.
shortExecutionHashfunctionshortExecutionHash(value: string, length?: number): stringShort Execution Hash function with 1 public call signature; parameters and return types are listed below.

cloneExecutionValue

Clone Execution Value function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { cloneExecutionValue } from '@codesoul-co/hypha-adapters-local';
  • Source module: execution-provider-values

Declaration

text
export declare function cloneExecutionValue<T>(value: T): T;

Call signature

text
cloneExecutionValue<T>(value: T): T

Parameters

ParameterTypeRequiredDescription
valueTYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: T
  • Description: The return contract is defined by the type shown above.

hashExecutionBytes

Hash Execution Bytes function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { hashExecutionBytes } from '@codesoul-co/hypha-adapters-local';
  • Source module: execution-provider-values

Declaration

text
export declare function hashExecutionBytes(value: Uint8Array): string;

Call signature

text
hashExecutionBytes(value: Uint8Array): string

Parameters

ParameterTypeRequiredDescription
valueUint8Array<ArrayBufferLike>YesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: string
  • Description: The return contract is defined by the type shown above.

hashExecutionText

Hash Execution Text function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { hashExecutionText } from '@codesoul-co/hypha-adapters-local';
  • Source module: execution-provider-values

Declaration

text
export declare function hashExecutionText(value: string): string;

Call signature

text
hashExecutionText(value: string): string

Parameters

ParameterTypeRequiredDescription
valuestringYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: string
  • Description: The return contract is defined by the type shown above.

hashExecutionValue

Hash Execution Value function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { hashExecutionValue } from '@codesoul-co/hypha-adapters-local';
  • Source module: execution-provider-values

Declaration

text
export declare function hashExecutionValue(value: unknown): string;

Call signature

text
hashExecutionValue(value: unknown): string

Parameters

ParameterTypeRequiredDescription
valueunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: string
  • Description: The return contract is defined by the type shown above.

shortExecutionHash

Short Execution Hash function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { shortExecutionHash } from '@codesoul-co/hypha-adapters-local';
  • Source module: execution-provider-values

Declaration

text
export declare function shortExecutionHash(value: string, length?: number): string;

Call signature

text
shortExecutionHash(value: string, length?: number): string

Parameters

ParameterTypeRequiredDescription
valuestringYesRequired parameter; accepted values are defined by the type column.
lengthnumberNoOptional parameter; accepted values are defined by the type column.

Returns

  • Type: string
  • Description: The return contract is defined by the type shown above.