Interface SignedOperationType<TBody>

Signing helpers bound to one payload type.

interface SignedOperationType<TBody> {
    typeDef: ContractTypeDef;
    typeName: string;
    encodeBody(body: TBody): Uint8Array;
    preimage(request: SignedOperationRequest<TBody>): Uint8Array;
    sign(
        signer: Signer,
        request: SignedOperationRequest<TBody>,
    ): Promise<SignedOperation>;
}

Type Parameters

TBody

Index

Properties

typeDef typeName

Methods

encodeBody preimage sign

Properties

`Readonly`typeDef

typeDef: ContractTypeDef

The payload type's spec definition, as bound into every preimage.

`Readonly`typeName

typeName: string

Declared name of the payload type: the declared segment of its spec id. SignedOperationType.typeDef carries the full id.

Methods

encodeBody

encodeBody(body: TBody): Uint8Array
CXS-encode a payload value the way the contract decodes it.
Parameters
- body: TBody
Returns Uint8Array
- Defined in signedOp/operation.ts:85

preimage

preimage(request: SignedOperationRequest<TBody>): Uint8Array
The bytes a signature over request covers.
Parameters
- request: SignedOperationRequest<TBody>
Returns Uint8Array
- Defined in signedOp/operation.ts:87

sign

sign(
signer: Signer,
request: SignedOperationRequest<TBody>,
): Promise<SignedOperation>
Encode, sign, and package request for the verifying contract.
Parameters
- signer: Signer
- request: SignedOperationRequest<TBody>
Returns Promise<SignedOperation>
- Defined in signedOp/operation.ts:89