Function makeIssuerKit

Used only to make a new issuerKit that is effectively non-durable. This is currently done by making a durable one in a baggage not reachable from anywhere. TODO Once rebuilt on zones, this should instead just build on the virtual zone. See https://github.com/Agoric/agoric-sdk/pull/7116

Currently used for testing only. Should probably continue to be used for testing only.

  • makeIssuerKit<K>(name, assetKind?, displayInfo?, optShutdownWithFailure?, options?): IssuerKit<K, any>

  • Type Parameters

    • K extends AssetKind = "nat"

      The name becomes part of the brand in asset descriptions. The name is useful for debugging and double-checking assumptions, but should not be trusted wrt any external namespace. For example, anyone could create a new issuer kit with name 'BTC', but it is not bitcoin or even related. It is only the name according to that issuer and brand.

      The assetKind will be used to import a specific mathHelpers from the mathHelpers library. For example, natMathHelpers, the default, is used for basic fungible tokens.

      displayInfo gives information to the UI on how to display the amount.

    Parameters

    • name: string
    • OptionalassetKind: K = AssetKind.NAT
    • OptionaldisplayInfo: AdditionalDisplayInfo = ...
    • OptionaloptShutdownWithFailure: ShutdownWithFailure = undefined

      If this issuer fails in the middle of an atomic action (which btw should never happen), it potentially leaves its ledger in a corrupted state. If this function was provided, then the failed atomic action will call it, so that some larger unit of computation, like the enclosing vat, can be shutdown before anything else is corrupted by that corrupted state. See https://github.com/Agoric/agoric-sdk/issues/3434

    • Optionaloptions: Partial<{
          elementShape: Pattern;
          recoverySetsOption: RecoverySetsOption;
      }> = {}

    Returns IssuerKit<K, any>

Settings

Member Visibility