@digitalasset/daml-ledger/lib/model/AllocatePartyRequest.d.ts

DAML Ledger API Node.js bindings

/**
 * Example:
 *
 * ```
 * {
 *     partyIdHint: 'alice',
 *     displayName: 'Alice'
 * }
 * ```
 */
export interface AllocatePartyRequest {
    /**
     * A hint to the backing participant what party id to allocate.
     *
     * It can be ignored.
     *
     * Must be a valid party identifier.
     *
     * Optional
     */
    partyIdHint?: string;
    /**
     * Human readable name of the party to be added to the participant.
     *
     * It doesn't have to be unique.
     *
     * Optional
     */
    displayName?: string;
}