Class Transaction

Hierarchy

Connection
- Transaction

Index

Constructors

constructor

new Transaction(cluster: string, privkey: string, keypair: DesigKeypair): Transaction
Parameters
- cluster: string
- privkey: string
- keypair: DesigKeypair
Returns Transaction
Overrides Connection.constructor
- Defined in src/transaction/index.ts:27

Properties

`Readonly` cluster

cluster: string

`Optional` `Readonly` keypair

keypair?: DesigKeypair

`Readonly` privkey

privkey: Uint8Array

sss

sss: SecretSharing

Accessors

index

get index(): string
Returns string
Inherited from Connection.index
- Defined in src/connection.ts:33

owner

get owner(): string
Returns string
Inherited from Connection.owner
- Defined in src/connection.ts:28

Methods

execTransaction

execTransaction(transactionId: string): Promise<TransactionEntity & {
    multisig: MultisigEntity;
    signatures: (SignatureEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
}>
Execute a transaction.

Returns
Transaciton data
Parameters
- transactionId: string
  
  Transaciton id
Returns Promise<TransactionEntity & {
    multisig: MultisigEntity;
    signatures: (SignatureEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
}>
- Defined in src/transaction/index.ts:213

getSignature

getSignature(signatureId: string): Promise<ExtendedSignatureEntity>
Get a signature data.

Returns
Signature data
Parameters
- signatureId: string
  
  Signature id
Returns Promise<ExtendedSignatureEntity>
- Defined in src/transaction/index.ts:118

getTransaction

getTransaction(transactionId: string): Promise<ExtendedTransactionEntity>
Get a transaction data.

Returns
Transaction data
Parameters
- transactionId: string
  
  Transaction id
Returns Promise<ExtendedTransactionEntity>
- Defined in src/transaction/index.ts:106

getTransactions

getTransactions(__namedParameters?: Partial<{
approved: boolean;
} & PaginationParams>): Promise<ExtendedTransactionEntity[]>
Get transactions data.

Returns
Transaction data
Parameters
- __namedParameters: Partial<{
  approved: boolean;
  } & PaginationParams> = {}
Returns Promise<ExtendedTransactionEntity[]>
- Defined in src/transaction/index.ts:78

initializeTransaction

initializeTransaction(__namedParameters: {
    params: TransactionParams;
    ttl?: number;
    type: TransactionType;
}): Promise<TransactionEntity & {
    multisig: MultisigEntity;
    signatures: (SignatureEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
}>
Submit a transaction to desig cluster

Returns
Transaction data
Parameters
- __namedParameters: {
      params: TransactionParams;
      ttl?: number;
      type: TransactionType;
  }
  - params: TransactionParams
  - Optional ttl?: number
  - type: TransactionType
Returns Promise<TransactionEntity & {
    multisig: MultisigEntity;
    signatures: (SignatureEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
}>
- Defined in src/transaction/index.ts:131

on

on(event: EventStreaming, param: string, callback: ((id: string, er?: string) => void)): (() => void)
Event streaming
Parameters
- event: EventStreaming
  
  Event
- param: string
  
  owner / signerId
- callback: ((id: string, er?: string) => void)
  - - (id: string, er?: string): void
    - Parameters
      
      id: string
      
      Optional er: string
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Inherited from Connection.on
- Defined in src/connection.ts:84

signTransaction

signTransaction(transactionId: string): Promise<SignatureEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
transaction: TransactionEntity;
}>
Sign a transaction.

Returns
Signature data
Parameters
- transactionId: string
  
  Transaciton id
Returns Promise<SignatureEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
transaction: TransactionEntity;
}>
- Defined in src/transaction/index.ts:159

syncTransaction

syncTransaction(): Promise<ExtendedSignerEntity>
Sync transactions to a signer

Returns
Signer data

Returns Promise<ExtendedSignerEntity>
- Defined in src/transaction/index.ts:225

watch

watch(callback: ((signatureId: string, er?: string) => void)): (() => void)
Watch new signature

Returns
Close function
Parameters
- callback: ((signatureId: string, er?: string) => void)
  - - (signatureId: string, er?: string): void
    - Parameters
      
      signatureId: string
      
      Optional er: string
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/transaction/index.ts:65

`Static` deriveSignatureId

deriveSignatureId(transactionId: string, signerId: string): string
Derive the siganture id by the transaction id and the signer id

Returns
Signature id
Parameters
- transactionId: string
  
  Transaction id
- signerId: string
  
  Signer id
Returns string
- Defined in src/transaction/index.ts:55

`Static` deriveTransactionId

deriveTransactionId(msg: string): string
Derive the transaction id by its content

Returns
The transaction id
Parameters
- msg: string
  
  Transaction's content (Or message)
Returns string
- Defined in src/transaction/index.ts:46

Class Transaction

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cluster: string

privkey: string

keypair: DesigKeypair

Returns Transaction

Properties

Readonly cluster

Optional Readonly keypair

Readonly privkey

sss

Accessors

index

Returns string

owner

Returns string

Methods

execTransaction

Returns

Parameters

transactionId: string

Returns Promise<TransactionEntity & { multisig: MultisigEntity; signatures: (SignatureEntity & { signer: Omit<SignerEntity, "encryptedShare">; })[]; }>

getSignature

Returns

Parameters

signatureId: string

Returns Promise<ExtendedSignatureEntity>

getTransaction

Returns

Parameters

transactionId: string

Returns Promise<ExtendedTransactionEntity>

getTransactions

Returns

Parameters

__namedParameters: Partial<{ approved: boolean; } & PaginationParams> = {}

Returns Promise<ExtendedTransactionEntity[]>

initializeTransaction

Returns

Parameters

__namedParameters: { params: TransactionParams; ttl?: number; type: TransactionType; }

params: TransactionParams

Optional ttl?: number

type: TransactionType

Returns Promise<TransactionEntity & { multisig: MultisigEntity; signatures: (SignatureEntity & { signer: Omit<SignerEntity, "encryptedShare">; })[]; }>

on

Parameters

event: EventStreaming

param: string

callback: ((id: string, er?: string) => void)

Parameters

id: string

Optional er: string

Returns void

Returns (() => void)

Returns void

signTransaction

Returns

Parameters

transactionId: string

Returns Promise<SignatureEntity & { signer: Omit<SignerEntity, "encryptedShare">; transaction: TransactionEntity; }>

syncTransaction

Returns

Returns Promise<ExtendedSignerEntity>

watch

Returns

Parameters

callback: ((signatureId: string, er?: string) => void)

Parameters

signatureId: string

Optional er: string

Returns void

`Readonly` cluster

`Optional` `Readonly` keypair

`Readonly` privkey

Returns Promise<TransactionEntity & {
multisig: MultisigEntity;
signatures: (SignatureEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
})[];
}>

__namedParameters: Partial<{
approved: boolean;
} & PaginationParams> = {}

__namedParameters: {
params: TransactionParams;
ttl?: number;
type: TransactionType;
}

`Optional` ttl?: number

Returns Promise<TransactionEntity & {
multisig: MultisigEntity;
signatures: (SignatureEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
})[];
}>

`Optional` er: string

Returns Promise<SignatureEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
transaction: TransactionEntity;
}>

`Optional` er: string

`Static` deriveSignatureId

`Static` deriveTransactionId