PolicyId.ts
PolicyId overview
Table of contents
arbitrary
arbitrary
FastCheck arbitrary for generating random PolicyId instances.
Signature
export declare const arbitrary: FastCheck.Arbitrary<PolicyId>Added in v2.0.0
encoding
toBytes
Encode PolicyId to bytes.
Signature
export declare const toBytes: (a: PolicyId, overrideOptions?: ParseOptions) => Uint8ArrayAdded in v2.0.0
toHex
Encode PolicyId to hex string.
Signature
export declare const toHex: (a: PolicyId, overrideOptions?: ParseOptions) => stringAdded in v2.0.0
model
PolicyId (class)
PolicyId as a TaggedClass representing a minting policy identifier. A PolicyId is a script hash (hash28) that identifies a minting policy.
Note: PolicyId is equivalent to ScriptHash as defined in the CDDL: policy_id = script_hash script_hash = hash28
Signature
export declare class PolicyIdAdded in v2.0.0
toJSON (method)
Signature
toJSON()toString (method)
Signature
toString(): string[Inspectable.NodeInspectSymbol] (method)
Signature
[Inspectable.NodeInspectSymbol](): unknown[Equal.symbol] (method)
Signature
[Equal.symbol](that: unknown): boolean[Hash.symbol] (method)
Signature
[Hash.symbol](): numberparsing
fromBytes
Parse PolicyId from bytes.
Signature
export declare const fromBytes: (i: Uint8Array, overrideOptions?: ParseOptions) => PolicyIdAdded in v2.0.0
fromHex
Parse PolicyId from hex string.
Signature
export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => PolicyIdAdded in v2.0.0
predicates
isPolicyId
Check if the given value is a valid PolicyId
Signature
export declare const isPolicyId: (u: unknown, overrideOptions?: ParseOptions | number) => u is PolicyIdAdded in v2.0.0
schemas
FromBytes
Schema transformer from bytes to PolicyId.
Signature
export declare const FromBytes: Schema.transform<
Schema.SchemaClass<Uint8Array, Uint8Array, never>,
Schema.SchemaClass<PolicyId, PolicyId, never>
>Added in v2.0.0
FromHex
Schema transformer from hex string to PolicyId.
Signature
export declare const FromHex: Schema.transform<
Schema.filter<Schema.Schema<Uint8Array, string, never>>,
Schema.transform<Schema.SchemaClass<Uint8Array, Uint8Array, never>, Schema.SchemaClass<PolicyId, PolicyId, never>>
>Added in v2.0.0