Skip to main content

TypeScript: API Reference

Full method surface for @notareum/sdk. All write methods require signer in the Notareum configuration; read methods need only provider.

Factory

NotaFileClient (ntm.nota)

RegistryClient (ntm.registry)

VerificationClient (ntm.verification)

StakingClient (ntm.staking)

GovernanceClient (ntm.governance)

FeeClient (ntm.fee)

Enums and types

Errors

Every client may throw one of the following:
  • SignerRequiredError: thrown when a write method is called without a signer.
  • ContractCallError: wraps on-chain reverts with decoded messages.
  • ConfigurationError: invalid contract addresses or provider.
  • ResourceNotFoundError: resolver or getter found nothing.
See Error Codes for a full mapping.

Utilities

These helpers mirror the on-chain resource type registry and the keccak-based resource ID derivation. Call computeResourceId to preview a resourceId before paying gas to register it.