@vallum/shared-types

Shared TypeScript policy and request/decision types for Vallum packages.

Install

For the npm release, install:

npm install @vallum/shared-types

Usage

import type { SponsorshipPolicy, SponsorshipRequestContext } from "@vallum/shared-types";
import { POLICY_REASON_CODES } from "@vallum/shared-types";

const policy: SponsorshipPolicy = {
  appId: "demo-app",
  appStatus: "active",
  allowedPackages: [],
  maxGasBudgetPerTx: 10_000_000,
};

const request: SponsorshipRequestContext = {
  authenticated: true,
  appId: "demo-app",
  gasBudget: 1_000_000,
};

console.log(POLICY_REASON_CODES, policy, request);

This package contains types and constants only; it does not contact IOTA RPC, an official Gas Station service, or any external network.