Class InvitationBuilder

constructor

• new InvitationBuilder(
      invitation: InvitationCreationParameters,
  ): InvitationBuilder

  Create a new InvitationBuilder.

  Parameters

  • invitation: InvitationCreationParameters

    Context for invitation creation.

  Returns InvitationBuilder

addCommit

• addCommit(commit: XOInvitationCommit): this

  Add a commit to the invitation.

  Parameters

  • commit: XOInvitationCommit

    The commit to add.

  Returns this

  The builder instance.

build

• build(): XOInvitation

  Build the XOInvitation object to be shared.

  Returns XOInvitation

  The built XOInvitation.

createUnsignedCommit

• createUnsignedCommit(
      params: {
          expiresAtTimestamp?: number;
          inputs?: XOInvitationInput[];
          outputs?: XOInvitationOutput[];
          transactionLocktime?: number;
          transactionVersion?: number;
          variables?: XOInvitationVariable[];
      },
  ): Omit<XOInvitationCommit, "signature" | "entityIdentifier">

  Creates an unsigned commit without adding it to the invitation. This allows for atomic commit creation with signature.

  Parameters

  • params: {
        expiresAtTimestamp?: number;
        inputs?: XOInvitationInput[];
        outputs?: XOInvitationOutput[];
        transactionLocktime?: number;
        transactionVersion?: number;
        variables?: XOInvitationVariable[];
    }

    Parameters for creating the commit

    • OptionalexpiresAtTimestamp?: number

      Optional expiration timestamp (defaults to now + DEFAULT_COMMIT_EXPIRATION_IN_MILLISECONDS)

    • Optionalinputs?: XOInvitationInput[]

      Optional array of inputs to add

    • Optionaloutputs?: XOInvitationOutput[]

      Optional array of outputs to add

    • OptionaltransactionLocktime?: number

      Optional transaction locktime

    • OptionaltransactionVersion?: number

      Optional transaction version

    • Optionalvariables?: XOInvitationVariable[]

      Optional array of variables to add

  Returns Omit<XOInvitationCommit, "signature" | "entityIdentifier">

  The unsigned commit (without signature)

getLastCommit

• getLastCommit(): XOInvitationCommit

  Returns the last InvitationCommit in the invitation.

  Returns XOInvitationCommit

  The last InvitationCommit object, or undefined if there are no commits.

getLastCommitIdentifier

• getLastCommitIdentifier(): string

  Returns the commitIdentifier of the last commit in the invitation.

  Returns string

  The commitIdentifier as a string, or undefined if there are no commits.

validate

• validate(template: XOTemplate): this

  Fully validates a given XOInvitation.

  Parameters

  • template: XOTemplate

    The template to validate against.

  Returns this

  Throws

  If the invitation has expired.

  Throws

  If the entity identifiers are invalid.

  Throws

  If the requirements are invalid.

  Throws

  If the commit signatures are invalid.

StaticfromInvitation

• fromInvitation(invitation: XOInvitation): InvitationBuilder

  Create a builder from an existing invitation.

  Parameters

  • invitation: XOInvitation

    An existing XOInvitation.

  Returns InvitationBuilder

actionIdentifier

invitationIdentifier

templateIdentifier