oc · docs
documentation

@orangecheck/sdk


@orangecheck/sdk / issueBondMessage

Function: issueBondMessage()

function issueBondMessage(opts: {
  address: string;
  now?: Date;
  outpoint: string;
  subject: string;
  ttlSeconds?: number;
}): {
  expiresAt: number;
  message: string;
  nonce: string;
};

Defined in: bond.ts:113

A fresh bond message with a random nonce and a short signing window.

Parameters

ParameterTypeDescription
opts{ address: string; now?: Date; outpoint: string; subject: string; ttlSeconds?: number; }-
opts.addressstring-
opts.now?Date-
opts.outpointstring-
opts.subjectstring-
opts.ttlSeconds?numberSigning window in seconds. Default 600.

Returns

{
  expiresAt: number;
  message: string;
  nonce: string;
}
NameTypeDefined in
expiresAtnumberbond.ts:120
messagestringbond.ts:120
noncestringbond.ts:120