Class Proposal

Hierarchy

Connection
- Proposal

Index

Constructors

constructor

new Proposal(cluster: string, privkey: string, keypair: DesigKeypair): Proposal
Parameters
- cluster: string
- privkey: string
- keypair: DesigKeypair
Returns Proposal
Overrides Connection.constructor
- Defined in src/proposal.ts:17

Properties

`Readonly` cluster

cluster: string

`Optional` `Readonly` keypair

keypair?: DesigKeypair

`Readonly` privkey

privkey: Uint8Array

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

approveProposal

approveProposal(proposalId: string): Promise<ApprovalEntity & {
proposal: ProposalEntity;
signer: Omit<SignerEntity, "encryptedShare">;
}>
Approve a proposal. You will need to submit the commitment in the 1st round to be able to join the 2nd round of signing.

Returns
Proposal data
Parameters
- proposalId: string
  
  Proposal id
Returns Promise<ApprovalEntity & {
proposal: ProposalEntity;
signer: Omit<SignerEntity, "encryptedShare">;
}>
- Defined in src/proposal.ts:142

finalizeSignature

finalizeSignature(proposalId: string): Promise<{
recv?: number;
sig: Uint8Array;
}>
Finalize the partial signatures. The function will combine the partial signatures and construct the valid signature.

Returns
Master signature
Parameters
- proposalId: string
  
  Proposal id
Returns Promise<{
recv?: number;
sig: Uint8Array;
}>
- Defined in src/proposal.ts:209

getApproval

getApproval(approvalId: string): Promise<ExtendedApprovalEntity>
Get an approval data.

Returns
Approval data
Parameters
- approvalId: string
  
  Approval id
Returns Promise<ExtendedApprovalEntity>
- Defined in src/proposal.ts:96

getProposal

getProposal(proposalId: string): Promise<ExtendedProposalEntity>
Get a prposal data. Note that it's only about multisig info.

Returns
Proposal data
Parameters
- proposalId: string
  
  Proposal id
Returns Promise<ExtendedProposalEntity>
- Defined in src/proposal.ts:84

getProposals

getProposals(chainId: string, __namedParameters?: Partial<PaginationParams>): Promise<ExtendedProposalEntity[]>
Get proposals data. Note that it's only about multisig info.

Returns
Proposal data
Parameters
- chainId: string
  
  Chain id
- __namedParameters: Partial<PaginationParams> = {}
Returns Promise<ExtendedProposalEntity[]>
- Defined in src/proposal.ts:61

initializeProposal

initializeProposal(__namedParameters: {
    chainId: string;
    msg: Uint8Array;
    raw: Uint8Array;
    ttl?: number;
}): Promise<ProposalEntity & {
    approvals: (ApprovalEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
    multisig: MultisigEntity;
}>
Submit a proposal to desig cluster

Returns
Proposal data
Parameters
- __namedParameters: {
      chainId: string;
      msg: Uint8Array;
      raw: Uint8Array;
      ttl?: number;
  }
  - chainId: string
  - msg: Uint8Array
  - raw: Uint8Array
  - Optional ttl?: number
Returns Promise<ProposalEntity & {
    approvals: (ApprovalEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
    multisig: MultisigEntity;
}>
- Defined in src/proposal.ts:109

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

updateTxHash

updateTxHash(proposalId: string, txHash: string): Promise<ProposalEntity & {
    approvals: (ApprovalEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
    multisig: MultisigEntity;
}>
Update tx hash for ux utilities.
Parameters
- proposalId: string
  
  Proposal id
- txHash: string
  
  Transaction hash
Returns Promise<ProposalEntity & {
    approvals: (ApprovalEntity & {
        signer: Omit<SignerEntity, "encryptedShare">;
    })[];
    multisig: MultisigEntity;
}>
- Defined in src/proposal.ts:195

verifySignature

verifySignature(id: string, signature: Uint8Array): Promise<boolean>
Verify a master signature

Returns
true/false
Parameters
- id: string
  
  Proposal id
- signature: Uint8Array
  
  Master signature
Returns Promise<boolean>
- Defined in src/proposal.ts:228

watch

watch(callback: ((approvalId: string, er?: string) => void)): (() => void)
Watch new approval

Returns
Close function
Parameters
- callback: ((approvalId: string, er?: string) => void)
  - - (approvalId: string, er?: string): void
    - Parameters
      
      approvalId: string
      
      Optional er: string
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/proposal.ts:48

`Static` deriveApprovalId

deriveApprovalId(proposalId: string, signerId: string): string
Derive the approval id by the proposal id and the signer id

Returns
Approval id
Parameters
- proposalId: string
  
  Proposal id
- signerId: string
  
  Signer id
Returns string
- Defined in src/proposal.ts:38

`Static` deriveProposalId

deriveProposalId(multisigId: string, msg: Uint8Array): string
Derive the proposal id by the multisig id and its content

Returns
Proposal id
Parameters
- multisigId: string
  
  Multisig id
- msg: Uint8Array
  
  Proposal's content (Or message)
Returns string
- Defined in src/proposal.ts:27

Class Proposal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cluster: string

privkey: string

keypair: DesigKeypair

Returns Proposal

Properties

Readonly cluster

Optional Readonly keypair

Readonly privkey

Accessors

index

Returns string

owner

Returns string

Methods

approveProposal

Returns

Parameters

proposalId: string

Returns Promise<ApprovalEntity & { proposal: ProposalEntity; signer: Omit<SignerEntity, "encryptedShare">; }>

finalizeSignature

Returns

Parameters

proposalId: string

Returns Promise<{ recv?: number; sig: Uint8Array; }>

getApproval

Returns

Parameters

approvalId: string

Returns Promise<ExtendedApprovalEntity>

getProposal

Returns

Parameters

proposalId: string

Returns Promise<ExtendedProposalEntity>

getProposals

Returns

Parameters

chainId: string

__namedParameters: Partial<PaginationParams> = {}

Returns Promise<ExtendedProposalEntity[]>

initializeProposal

Returns

Parameters

__namedParameters: { chainId: string; msg: Uint8Array; raw: Uint8Array; ttl?: number; }

chainId: string

msg: Uint8Array

raw: Uint8Array

Optional ttl?: number

Returns Promise<ProposalEntity & { approvals: (ApprovalEntity & { signer: Omit<SignerEntity, "encryptedShare">; })[]; multisig: MultisigEntity; }>

on

Parameters

event: EventStreaming

param: string

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

Parameters

id: string

Optional er: string

Returns void

Returns (() => void)

Returns void

updateTxHash

Parameters

proposalId: string

txHash: string

Returns Promise<ProposalEntity & { approvals: (ApprovalEntity & { signer: Omit<SignerEntity, "encryptedShare">; })[]; multisig: MultisigEntity; }>

verifySignature

Returns

Parameters

id: string

signature: Uint8Array

`Readonly` cluster

`Optional` `Readonly` keypair

`Readonly` privkey

Returns Promise<ApprovalEntity & {
proposal: ProposalEntity;
signer: Omit<SignerEntity, "encryptedShare">;
}>

Returns Promise<{
recv?: number;
sig: Uint8Array;
}>

__namedParameters: {
chainId: string;
msg: Uint8Array;
raw: Uint8Array;
ttl?: number;
}

`Optional` ttl?: number

Returns Promise<ProposalEntity & {
approvals: (ApprovalEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
})[];
multisig: MultisigEntity;
}>

`Optional` er: string

Returns Promise<ProposalEntity & {
approvals: (ApprovalEntity & {
signer: Omit<SignerEntity, "encryptedShare">;
})[];
multisig: MultisigEntity;
}>

`Optional` er: string

`Static` deriveApprovalId

`Static` deriveProposalId