Governance | @certusone/wormhole-sdk

Hierarchy

BaseContract
- Governance

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Governance(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): Governance

Inherited from BaseContract.constructor
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:107
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns Governance

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

[eventTag: string]: (...args: any[]) => void
- - (...args: any[]): void
  - Parameters
    - Rest ...args: any[]
    Returns void

Readonly address

address: string

callStatic

callStatic: { chainId: any; evmChainId: any; getCurrentGuardianSetIndex: any; getGuardianSet: any; getGuardianSetExpiry: any; governanceActionIsConsumed: any; governanceChainId: any; governanceContract: any; isFork: any; isInitialized: any; messageFee: any; nextSequence: any; parseAndVerifyVM: any; parseContractUpgrade: any; parseGuardianSetUpgrade: any; parseRecoverChainId: any; parseSetMessageFee: any; parseTransferFees: any; parseVM: any; quorum: any; submitContractUpgrade: any; submitNewGuardianSet: any; submitRecoverChainId: any; submitSetMessageFee: any; submitTransferFees: any; verifySignatures: any; verifyVM: any }

Type declaration

chainId: function
- chainId(overrides?: CallOverrides): Promise<number>
- - Defined in src/ethers-contracts/Governance.d.ts:1085
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<number>
evmChainId: function
- evmChainId(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1087
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getCurrentGuardianSetIndex: function
- getCurrentGuardianSetIndex(overrides?: CallOverrides): Promise<number>
- - Defined in src/ethers-contracts/Governance.d.ts:1089
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<number>
getGuardianSet: function
- getGuardianSet(index: BigNumberish, overrides?: CallOverrides): Promise<[string[], number] & { expirationTime: number; keys: string[] }>
- - Defined in src/ethers-contracts/Governance.d.ts:1091
  Parameters
  - index: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<[string[], number] & { expirationTime: number; keys: string[] }>
getGuardianSetExpiry: function
- getGuardianSetExpiry(overrides?: CallOverrides): Promise<number>
- - Defined in src/ethers-contracts/Governance.d.ts:1096
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<number>
governanceActionIsConsumed: function
- governanceActionIsConsumed(hash: BytesLike, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/Governance.d.ts:1098
  Parameters
  - hash: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
governanceChainId: function
- governanceChainId(overrides?: CallOverrides): Promise<number>
- - Defined in src/ethers-contracts/Governance.d.ts:1103
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<number>
governanceContract: function
- governanceContract(overrides?: CallOverrides): Promise<string>
- - Defined in src/ethers-contracts/Governance.d.ts:1105
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
isFork: function
- isFork(overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/Governance.d.ts:1107
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
isInitialized: function
- isInitialized(impl: string, overrides?: CallOverrides): Promise<boolean>
- - Defined in src/ethers-contracts/Governance.d.ts:1109
  Parameters
  - impl: string
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
messageFee: function
- messageFee(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1111
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
nextSequence: function
- nextSequence(emitter: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1113
  Parameters
  - emitter: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseAndVerifyVM: function
- parseAndVerifyVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
- - Defined in src/ethers-contracts/Governance.d.ts:1121
  parseAndVerifyVM serves to parse an encodedVM and wholy validate it for consumption
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
parseContractUpgrade: function
- parseContractUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1207
  Parse a contract upgrade (action 1) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }>
parseGuardianSetUpgrade: function
- parseGuardianSetUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }>
- - Defined in src/ethers-contracts/Governance.d.ts:1222
  Parse a guardianSet upgrade (action 2) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }>
parseRecoverChainId: function
- parseRecoverChainId(encodedRecoverChainId: BytesLike, overrides?: CallOverrides): Promise<[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }>
- - Defined in src/ethers-contracts/Governance.d.ts:1247
  Parse a recoverChainId (action 5) with minimal validation
  
  Parameters
  - encodedRecoverChainId: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }>
parseSetMessageFee: function
- parseSetMessageFee(encodedSetMessageFee: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1262
  Parse a setMessageFee (action 3) with minimal validation
  
  Parameters
  - encodedSetMessageFee: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }>
parseTransferFees: function
- parseTransferFees(encodedTransferFees: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1277
  Parse a transferFees (action 4) with minimal validation
  
  Parameters
  - encodedTransferFees: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }>
parseVM: function
- parseVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }>
- - Defined in src/ethers-contracts/Governance.d.ts:1293
  parseVM serves to parse an encodedVM into a vm struct - it intentionally performs no validation functions, it simply parses raw into a struct
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }>
quorum: function
- quorum(numGuardians: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1337
  quorum serves solely to determine the number of signatures required to acheive quorum
  
  Parameters
  - numGuardians: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
submitContractUpgrade: function
- submitContractUpgrade(_vm: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in src/ethers-contracts/Governance.d.ts:1379
  Upgrades a contract via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
submitNewGuardianSet: function
- submitNewGuardianSet(_vm: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in src/ethers-contracts/Governance.d.ts:1395
  Deploys a new guardianSet via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
submitRecoverChainId: function
- submitRecoverChainId(_vm: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in src/ethers-contracts/Governance.d.ts:1411
  Updates the chainId and evmChainId on a forked chain via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
submitSetMessageFee: function
- submitSetMessageFee(_vm: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in src/ethers-contracts/Governance.d.ts:1387
  Sets a messageFee via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
submitTransferFees: function
- submitTransferFees(_vm: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in src/ethers-contracts/Governance.d.ts:1403
  Submits transfer fees to the recipient via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
verifySignatures: function
- verifySignatures(hash: BytesLike, signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[], guardianSet: { expirationTime: BigNumberish; keys: string[] }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>
- - Defined in src/ethers-contracts/Governance.d.ts:1342
  Parameters
  - hash: BytesLike
  - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
  - guardianSet: { expirationTime: BigNumberish; keys: string[] }
    - expirationTime: BigNumberish
    - keys: string[]
  - Optional overrides: CallOverrides
  Returns Promise<[boolean, string] & { reason: string; valid: boolean }>
verifyVM: function
- verifyVM(vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>
- - Defined in src/ethers-contracts/Governance.d.ts:1354
  Parameters
  - vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }
    - consistencyLevel: BigNumberish
    - emitterAddress: BytesLike
    - emitterChainId: BigNumberish
    - guardianSetIndex: BigNumberish
    - hash: BytesLike
    - nonce: BigNumberish
    - payload: BytesLike
    - sequence: BigNumberish
    - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
    - timestamp: BigNumberish
    - version: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<[boolean, string] & { reason: string; valid: boolean }>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { chainId: any; evmChainId: any; getCurrentGuardianSetIndex: any; getGuardianSet: any; getGuardianSetExpiry: any; governanceActionIsConsumed: any; governanceChainId: any; governanceContract: any; isFork: any; isInitialized: any; messageFee: any; nextSequence: any; parseAndVerifyVM: any; parseContractUpgrade: any; parseGuardianSetUpgrade: any; parseRecoverChainId: any; parseSetMessageFee: any; parseTransferFees: any; parseVM: any; quorum: any; submitContractUpgrade: any; submitNewGuardianSet: any; submitRecoverChainId: any; submitSetMessageFee: any; submitTransferFees: any; verifySignatures: any; verifyVM: any }

Type declaration

chainId: function
- chainId(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1448
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
evmChainId: function
- evmChainId(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1450
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getCurrentGuardianSetIndex: function
- getCurrentGuardianSetIndex(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1452
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getGuardianSet: function
- getGuardianSet(index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1454
  Parameters
  - index: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getGuardianSetExpiry: function
- getGuardianSetExpiry(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1459
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
governanceActionIsConsumed: function
- governanceActionIsConsumed(hash: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1461
  Parameters
  - hash: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
governanceChainId: function
- governanceChainId(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1466
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
governanceContract: function
- governanceContract(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1468
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
isFork: function
- isFork(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1470
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
isInitialized: function
- isInitialized(impl: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1472
  Parameters
  - impl: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
messageFee: function
- messageFee(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1474
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
nextSequence: function
- nextSequence(emitter: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1476
  Parameters
  - emitter: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseAndVerifyVM: function
- parseAndVerifyVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1484
  parseAndVerifyVM serves to parse an encodedVM and wholy validate it for consumption
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseContractUpgrade: function
- parseContractUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1492
  Parse a contract upgrade (action 1) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseGuardianSetUpgrade: function
- parseGuardianSetUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1500
  Parse a guardianSet upgrade (action 2) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseRecoverChainId: function
- parseRecoverChainId(encodedRecoverChainId: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1508
  Parse a recoverChainId (action 5) with minimal validation
  
  Parameters
  - encodedRecoverChainId: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseSetMessageFee: function
- parseSetMessageFee(encodedSetMessageFee: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1516
  Parse a setMessageFee (action 3) with minimal validation
  
  Parameters
  - encodedSetMessageFee: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseTransferFees: function
- parseTransferFees(encodedTransferFees: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1524
  Parse a transferFees (action 4) with minimal validation
  
  Parameters
  - encodedTransferFees: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parseVM: function
- parseVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1532
  parseVM serves to parse an encodedVM into a vm struct - it intentionally performs no validation functions, it simply parses raw into a struct
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
quorum: function
- quorum(numGuardians: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1540
  quorum serves solely to determine the number of signatures required to acheive quorum
  
  Parameters
  - numGuardians: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
submitContractUpgrade: function
- submitContractUpgrade(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1582
  Upgrades a contract via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
submitNewGuardianSet: function
- submitNewGuardianSet(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1598
  Deploys a new guardianSet via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
submitRecoverChainId: function
- submitRecoverChainId(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1614
  Updates the chainId and evmChainId on a forked chain via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
submitSetMessageFee: function
- submitSetMessageFee(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1590
  Sets a messageFee via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
submitTransferFees: function
- submitTransferFees(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1606
  Submits transfer fees to the recipient via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
verifySignatures: function
- verifySignatures(hash: BytesLike, signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[], guardianSet: { expirationTime: BigNumberish; keys: string[] }, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1545
  Parameters
  - hash: BytesLike
  - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
  - guardianSet: { expirationTime: BigNumberish; keys: string[] }
    - expirationTime: BigNumberish
    - keys: string[]
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
verifyVM: function
- verifyVM(vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in src/ethers-contracts/Governance.d.ts:1557
  Parameters
  - vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }
    - consistencyLevel: BigNumberish
    - emitterAddress: BytesLike
    - emitterChainId: BigNumberish
    - guardianSetIndex: BigNumberish
    - hash: BytesLike
    - nonce: BigNumberish
    - payload: BytesLike
    - sequence: BigNumberish
    - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
    - timestamp: BigNumberish
    - version: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>

filters

filters: { AdminChanged: any; BeaconUpgraded: any; ContractUpgraded: any; GuardianSetAdded: any; Upgraded: any }

Type declaration

AdminChanged: function
- AdminChanged(previousAdmin?: null, newAdmin?: null): TypedEventFilter<[string, string], { newAdmin: string; previousAdmin: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1418
  Parameters
  - Optional previousAdmin: null
  - Optional newAdmin: null
  Returns TypedEventFilter<[string, string], { newAdmin: string; previousAdmin: string }>
BeaconUpgraded: function
- BeaconUpgraded(beacon?: null | string): TypedEventFilter<[string], { beacon: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1426
  Parameters
  - Optional beacon: null | string
  Returns TypedEventFilter<[string], { beacon: string }>
ContractUpgraded: function
- ContractUpgraded(oldContract?: null | string, newContract?: null | string): TypedEventFilter<[string, string], { newContract: string; oldContract: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1430
  Parameters
  - Optional oldContract: null | string
  - Optional newContract: null | string
  Returns TypedEventFilter<[string, string], { newContract: string; oldContract: string }>
GuardianSetAdded: function
- GuardianSetAdded(index?: null | BigNumberish): TypedEventFilter<[number], { index: number }>
- - Defined in src/ethers-contracts/Governance.d.ts:1438
  Parameters
  - Optional index: null | BigNumberish
  Returns TypedEventFilter<[number], { index: number }>
Upgraded: function
- Upgraded(implementation?: null | string): TypedEventFilter<[string], { implementation: string }>
- - Defined in src/ethers-contracts/Governance.d.ts:1442
  Parameters
  - Optional implementation: null | string
  Returns TypedEventFilter<[string], { implementation: string }>

functions

functions: { chainId: any; evmChainId: any; getCurrentGuardianSetIndex: any; getGuardianSet: any; getGuardianSetExpiry: any; governanceActionIsConsumed: any; governanceChainId: any; governanceContract: any; isFork: any; isInitialized: any; messageFee: any; nextSequence: any; parseAndVerifyVM: any; parseContractUpgrade: any; parseGuardianSetUpgrade: any; parseRecoverChainId: any; parseSetMessageFee: any; parseTransferFees: any; parseVM: any; quorum: any; submitContractUpgrade: any; submitNewGuardianSet: any; submitRecoverChainId: any; submitSetMessageFee: any; submitTransferFees: any; verifySignatures: any; verifyVM: any }

Type declaration

chainId: function
- chainId(overrides?: CallOverrides): Promise<[number]>
- - Defined in src/ethers-contracts/Governance.d.ts:328
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[number]>
evmChainId: function
- evmChainId(overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/Governance.d.ts:330
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
getCurrentGuardianSetIndex: function
- getCurrentGuardianSetIndex(overrides?: CallOverrides): Promise<[number]>
- - Defined in src/ethers-contracts/Governance.d.ts:332
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[number]>
getGuardianSet: function
- getGuardianSet(index: BigNumberish, overrides?: CallOverrides): Promise<[[string[], number] & { expirationTime: number; keys: string[] }]>
- - Defined in src/ethers-contracts/Governance.d.ts:334
  Parameters
  - index: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<[[string[], number] & { expirationTime: number; keys: string[] }]>
getGuardianSetExpiry: function
- getGuardianSetExpiry(overrides?: CallOverrides): Promise<[number]>
- - Defined in src/ethers-contracts/Governance.d.ts:341
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[number]>
governanceActionIsConsumed: function
- governanceActionIsConsumed(hash: BytesLike, overrides?: CallOverrides): Promise<[boolean]>
- - Defined in src/ethers-contracts/Governance.d.ts:343
  Parameters
  - hash: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[boolean]>
governanceChainId: function
- governanceChainId(overrides?: CallOverrides): Promise<[number]>
- - Defined in src/ethers-contracts/Governance.d.ts:348
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[number]>
governanceContract: function
- governanceContract(overrides?: CallOverrides): Promise<[string]>
- - Defined in src/ethers-contracts/Governance.d.ts:350
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
isFork: function
- isFork(overrides?: CallOverrides): Promise<[boolean]>
- - Defined in src/ethers-contracts/Governance.d.ts:352
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[boolean]>
isInitialized: function
- isInitialized(impl: string, overrides?: CallOverrides): Promise<[boolean]>
- - Defined in src/ethers-contracts/Governance.d.ts:354
  Parameters
  - impl: string
  - Optional overrides: CallOverrides
  Returns Promise<[boolean]>
messageFee: function
- messageFee(overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/Governance.d.ts:356
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
nextSequence: function
- nextSequence(emitter: string, overrides?: CallOverrides): Promise<[BigNumber]>
- - Defined in src/ethers-contracts/Governance.d.ts:358
  Parameters
  - emitter: string
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber]>
parseAndVerifyVM: function
- parseAndVerifyVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
- - Defined in src/ethers-contracts/Governance.d.ts:366
  parseAndVerifyVM serves to parse an encodedVM and wholy validate it for consumption
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
parseContractUpgrade: function
- parseContractUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }] & { cu: [string, number, number, string] & { action: number; chain: number; module: string; newContract: string } }>
- - Defined in src/ethers-contracts/Governance.d.ts:452
  Parse a contract upgrade (action 1) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }] & { cu: [string, number, number, string] & { action: number; chain: number; module: string; newContract: string } }>
parseGuardianSetUpgrade: function
- parseGuardianSetUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }] & { gsu: [string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number } }>
- - Defined in src/ethers-contracts/Governance.d.ts:476
  Parse a guardianSet upgrade (action 2) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }] & { gsu: [string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number } }>
parseRecoverChainId: function
- parseRecoverChainId(encodedRecoverChainId: BytesLike, overrides?: CallOverrides): Promise<[[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }] & { rci: [string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number } }>
- - Defined in src/ethers-contracts/Governance.d.ts:520
  Parse a recoverChainId (action 5) with minimal validation
  
  Parameters
  - encodedRecoverChainId: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }] & { rci: [string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number } }>
parseSetMessageFee: function
- parseSetMessageFee(encodedSetMessageFee: BytesLike, overrides?: CallOverrides): Promise<[[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }] & { smf: [string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string } }>
- - Defined in src/ethers-contracts/Governance.d.ts:544
  Parse a setMessageFee (action 3) with minimal validation
  
  Parameters
  - encodedSetMessageFee: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }] & { smf: [string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string } }>
parseTransferFees: function
- parseTransferFees(encodedTransferFees: BytesLike, overrides?: CallOverrides): Promise<[[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }] & { tf: [string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string } }>
- - Defined in src/ethers-contracts/Governance.d.ts:568
  Parse a transferFees (action 4) with minimal validation
  
  Parameters
  - encodedTransferFees: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }] & { tf: [string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string } }>
parseVM: function
- parseVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }] & { vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
- - Defined in src/ethers-contracts/Governance.d.ts:594
  parseVM serves to parse an encodedVM into a vm struct - it intentionally performs no validation functions, it simply parses raw into a struct
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }] & { vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>
quorum: function
- quorum(numGuardians: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber] & { numSignaturesRequiredForQuorum: BigNumber }>
- - Defined in src/ethers-contracts/Governance.d.ts:676
  quorum serves solely to determine the number of signatures required to acheive quorum
  
  Parameters
  - numGuardians: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<[BigNumber] & { numSignaturesRequiredForQuorum: BigNumber }>
submitContractUpgrade: function
- submitContractUpgrade(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:718
  Upgrades a contract via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
submitNewGuardianSet: function
- submitNewGuardianSet(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:734
  Deploys a new guardianSet via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
submitRecoverChainId: function
- submitRecoverChainId(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:750
  Updates the chainId and evmChainId on a forked chain via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
submitSetMessageFee: function
- submitSetMessageFee(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:726
  Sets a messageFee via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
submitTransferFees: function
- submitTransferFees(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:742
  Submits transfer fees to the recipient via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
verifySignatures: function
- verifySignatures(hash: BytesLike, signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[], guardianSet: { expirationTime: BigNumberish; keys: string[] }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>
- - Defined in src/ethers-contracts/Governance.d.ts:681
  Parameters
  - hash: BytesLike
  - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
  - guardianSet: { expirationTime: BigNumberish; keys: string[] }
    - expirationTime: BigNumberish
    - keys: string[]
  - Optional overrides: CallOverrides
  Returns Promise<[boolean, string] & { reason: string; valid: boolean }>
verifyVM: function
- verifyVM(vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>
- - Defined in src/ethers-contracts/Governance.d.ts:693
  Parameters
  - vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }
    - consistencyLevel: BigNumberish
    - emitterAddress: BytesLike
    - emitterChainId: BigNumberish
    - guardianSetIndex: BigNumberish
    - hash: BytesLike
    - nonce: BigNumberish
    - payload: BytesLike
    - sequence: BigNumberish
    - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
    - timestamp: BigNumberish
    - version: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<[boolean, string] & { reason: string; valid: boolean }>

interface

interface: GovernanceInterface

populateTransaction

populateTransaction: { chainId: any; evmChainId: any; getCurrentGuardianSetIndex: any; getGuardianSet: any; getGuardianSetExpiry: any; governanceActionIsConsumed: any; governanceChainId: any; governanceContract: any; isFork: any; isInitialized: any; messageFee: any; nextSequence: any; parseAndVerifyVM: any; parseContractUpgrade: any; parseGuardianSetUpgrade: any; parseRecoverChainId: any; parseSetMessageFee: any; parseTransferFees: any; parseVM: any; quorum: any; submitContractUpgrade: any; submitNewGuardianSet: any; submitRecoverChainId: any; submitSetMessageFee: any; submitTransferFees: any; verifySignatures: any; verifyVM: any }

Type declaration

chainId: function
- chainId(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1621
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
evmChainId: function
- evmChainId(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1623
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getCurrentGuardianSetIndex: function
- getCurrentGuardianSetIndex(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1625
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getGuardianSet: function
- getGuardianSet(index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1629
  Parameters
  - index: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getGuardianSetExpiry: function
- getGuardianSetExpiry(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1634
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
governanceActionIsConsumed: function
- governanceActionIsConsumed(hash: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1638
  Parameters
  - hash: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
governanceChainId: function
- governanceChainId(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1643
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
governanceContract: function
- governanceContract(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1645
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
isFork: function
- isFork(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1649
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
isInitialized: function
- isInitialized(impl: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1651
  Parameters
  - impl: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
messageFee: function
- messageFee(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1656
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
nextSequence: function
- nextSequence(emitter: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1658
  Parameters
  - emitter: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseAndVerifyVM: function
- parseAndVerifyVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1666
  parseAndVerifyVM serves to parse an encodedVM and wholy validate it for consumption
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseContractUpgrade: function
- parseContractUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1674
  Parse a contract upgrade (action 1) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseGuardianSetUpgrade: function
- parseGuardianSetUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1682
  Parse a guardianSet upgrade (action 2) with minimal validation
  
  Parameters
  - encodedUpgrade: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseRecoverChainId: function
- parseRecoverChainId(encodedRecoverChainId: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1690
  Parse a recoverChainId (action 5) with minimal validation
  
  Parameters
  - encodedRecoverChainId: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseSetMessageFee: function
- parseSetMessageFee(encodedSetMessageFee: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1698
  Parse a setMessageFee (action 3) with minimal validation
  
  Parameters
  - encodedSetMessageFee: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseTransferFees: function
- parseTransferFees(encodedTransferFees: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1706
  Parse a transferFees (action 4) with minimal validation
  
  Parameters
  - encodedTransferFees: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parseVM: function
- parseVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1714
  parseVM serves to parse an encodedVM into a vm struct - it intentionally performs no validation functions, it simply parses raw into a struct
  
  Parameters
  - encodedVM: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
quorum: function
- quorum(numGuardians: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1722
  quorum serves solely to determine the number of signatures required to acheive quorum
  
  Parameters
  - numGuardians: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
submitContractUpgrade: function
- submitContractUpgrade(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1764
  Upgrades a contract via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
submitNewGuardianSet: function
- submitNewGuardianSet(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1780
  Deploys a new guardianSet via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
submitRecoverChainId: function
- submitRecoverChainId(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1796
  Updates the chainId and evmChainId on a forked chain via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
submitSetMessageFee: function
- submitSetMessageFee(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1772
  Sets a messageFee via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
submitTransferFees: function
- submitTransferFees(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1788
  Submits transfer fees to the recipient via Governance VAA/VM
  
  Parameters
  - _vm: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
verifySignatures: function
- verifySignatures(hash: BytesLike, signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[], guardianSet: { expirationTime: BigNumberish; keys: string[] }, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1727
  Parameters
  - hash: BytesLike
  - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
  - guardianSet: { expirationTime: BigNumberish; keys: string[] }
    - expirationTime: BigNumberish
    - keys: string[]
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
verifyVM: function
- verifyVM(vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in src/ethers-contracts/Governance.d.ts:1739
  Parameters
  - vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }
    - consistencyLevel: BigNumberish
    - emitterAddress: BytesLike
    - emitterChainId: BigNumberish
    - guardianSetIndex: BigNumberish
    - hash: BytesLike
    - nonce: BigNumberish
    - payload: BytesLike
    - sequence: BigNumberish
    - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
    - timestamp: BigNumberish
    - version: BigNumberish
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent: RunningEvent): void

Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:121
Parameters
- runningEvent: RunningEvent
Returns void

_deployed

_deployed(blockTag?: BlockTag): Promise<Contract>

Inherited from BaseContract._deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:114
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>

_wrapEvent

_wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:122
Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event

attach

attach(addressOrName: string): Governance

Overrides BaseContract.attach
- Defined in src/ethers-contracts/Governance.d.ts:286
Parameters
- addressOrName: string
Returns Governance

chainId

chainId(overrides?: CallOverrides): Promise<number>

- Defined in src/ethers-contracts/Governance.d.ts:756
Parameters
- Optional overrides: CallOverrides
Returns Promise<number>

connect

connect(signerOrProvider: string | Signer | Provider): Governance

Overrides BaseContract.connect
- Defined in src/ethers-contracts/Governance.d.ts:285
Parameters
- signerOrProvider: string | Signer | Provider
Returns Governance

deployed

deployed(): Promise<Governance>

Overrides BaseContract.deployed
- Defined in src/ethers-contracts/Governance.d.ts:287
Returns Promise<Governance>

emit

emit(eventName: string | EventFilter, ...args: any[]): boolean

Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:127
Parameters
- eventName: string | EventFilter
- Rest ...args: any[]
Returns boolean

evmChainId

evmChainId(overrides?: CallOverrides): Promise<BigNumber>

- Defined in src/ethers-contracts/Governance.d.ts:758
Parameters
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

fallback

fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

Inherited from BaseContract.fallback
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:115
Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>

getCurrentGuardianSetIndex

getCurrentGuardianSetIndex(overrides?: CallOverrides): Promise<number>

- Defined in src/ethers-contracts/Governance.d.ts:760
Parameters
- Optional overrides: CallOverrides
Returns Promise<number>

getGuardianSet

getGuardianSet(index: BigNumberish, overrides?: CallOverrides): Promise<[string[], number] & { expirationTime: number; keys: string[] }>

- Defined in src/ethers-contracts/Governance.d.ts:762
Parameters
- index: BigNumberish
- Optional overrides: CallOverrides
Returns Promise<[string[], number] & { expirationTime: number; keys: string[] }>

getGuardianSetExpiry

getGuardianSetExpiry(overrides?: CallOverrides): Promise<number>

- Defined in src/ethers-contracts/Governance.d.ts:767
Parameters
- Optional overrides: CallOverrides
Returns Promise<number>

governanceActionIsConsumed

governanceActionIsConsumed(hash: BytesLike, overrides?: CallOverrides): Promise<boolean>

- Defined in src/ethers-contracts/Governance.d.ts:769
Parameters
- hash: BytesLike
- Optional overrides: CallOverrides
Returns Promise<boolean>

governanceChainId

governanceChainId(overrides?: CallOverrides): Promise<number>

- Defined in src/ethers-contracts/Governance.d.ts:774
Parameters
- Optional overrides: CallOverrides
Returns Promise<number>

governanceContract

governanceContract(overrides?: CallOverrides): Promise<string>

- Defined in src/ethers-contracts/Governance.d.ts:776
Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

isFork

isFork(overrides?: CallOverrides): Promise<boolean>

- Defined in src/ethers-contracts/Governance.d.ts:778
Parameters
- Optional overrides: CallOverrides
Returns Promise<boolean>

isInitialized

isInitialized(impl: string, overrides?: CallOverrides): Promise<boolean>

- Defined in src/ethers-contracts/Governance.d.ts:780
Parameters
- impl: string
- Optional overrides: CallOverrides
Returns Promise<boolean>

listenerCount

listenerCount(eventName?: string | EventFilter): number

Inherited from BaseContract.listenerCount
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:128
Parameters
- Optional eventName: string | EventFilter
Returns number

listeners

listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
listeners(eventName?: string): Listener[]

Overrides BaseContract.listeners
- Defined in src/ethers-contracts/Governance.d.ts:289
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns TypedListener<EventArgsArray, EventArgsObject>[]
Overrides BaseContract.listeners
- Defined in src/ethers-contracts/Governance.d.ts:312
Parameters
- Optional eventName: string
Returns Listener[]

messageFee

messageFee(overrides?: CallOverrides): Promise<BigNumber>

- Defined in src/ethers-contracts/Governance.d.ts:782
Parameters
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

nextSequence

nextSequence(emitter: string, overrides?: CallOverrides): Promise<BigNumber>

- Defined in src/ethers-contracts/Governance.d.ts:784
Parameters
- emitter: string
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

off

off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Governance
off(eventName: string, listener: Listener): Governance

Overrides BaseContract.off
- Defined in src/ethers-contracts/Governance.d.ts:292
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns Governance
Overrides BaseContract.off
- Defined in src/ethers-contracts/Governance.d.ts:313
Parameters
- eventName: string
- listener: Listener
Returns Governance

on

on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Governance
on(eventName: string, listener: Listener): Governance

Overrides BaseContract.on
- Defined in src/ethers-contracts/Governance.d.ts:296
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns Governance
Overrides BaseContract.on
- Defined in src/ethers-contracts/Governance.d.ts:314
Parameters
- eventName: string
- listener: Listener
Returns Governance

once

once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Governance
once(eventName: string, listener: Listener): Governance

Overrides BaseContract.once
- Defined in src/ethers-contracts/Governance.d.ts:300
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns Governance
Overrides BaseContract.once
- Defined in src/ethers-contracts/Governance.d.ts:315
Parameters
- eventName: string
- listener: Listener
Returns Governance

parseAndVerifyVM

parseAndVerifyVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>

- Defined in src/ethers-contracts/Governance.d.ts:789
parseAndVerifyVM serves to parse an encodedVM and wholy validate it for consumption

Parameters
- encodedVM: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }, boolean, string] & { reason: string; valid: boolean; vm: [number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number } }>

parseContractUpgrade

parseContractUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }>

- Defined in src/ethers-contracts/Governance.d.ts:875
Parse a contract upgrade (action 1) with minimal validation

Parameters
- encodedUpgrade: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[string, number, number, string] & { action: number; chain: number; module: string; newContract: string }>

parseGuardianSetUpgrade

parseGuardianSetUpgrade(encodedUpgrade: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }>

- Defined in src/ethers-contracts/Governance.d.ts:890
Parse a guardianSet upgrade (action 2) with minimal validation

Parameters
- encodedUpgrade: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[string, number, number, [string[], number] & { expirationTime: number; keys: string[] }, number] & { action: number; chain: number; module: string; newGuardianSet: [string[], number] & { expirationTime: number; keys: string[] }; newGuardianSetIndex: number }>

parseRecoverChainId

parseRecoverChainId(encodedRecoverChainId: BytesLike, overrides?: CallOverrides): Promise<[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }>

- Defined in src/ethers-contracts/Governance.d.ts:915
Parse a recoverChainId (action 5) with minimal validation

Parameters
- encodedRecoverChainId: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[string, number, BigNumber, number] & { action: number; evmChainId: BigNumber; module: string; newChainId: number }>

parseSetMessageFee

parseSetMessageFee(encodedSetMessageFee: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }>

- Defined in src/ethers-contracts/Governance.d.ts:930
Parse a setMessageFee (action 3) with minimal validation

Parameters
- encodedSetMessageFee: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[string, number, number, BigNumber] & { action: number; chain: number; messageFee: BigNumber; module: string }>

parseTransferFees

parseTransferFees(encodedTransferFees: BytesLike, overrides?: CallOverrides): Promise<[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }>

- Defined in src/ethers-contracts/Governance.d.ts:945
Parse a transferFees (action 4) with minimal validation

Parameters
- encodedTransferFees: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[string, number, number, BigNumber, string] & { action: number; amount: BigNumber; chain: number; module: string; recipient: string }>

parseVM

parseVM(encodedVM: BytesLike, overrides?: CallOverrides): Promise<[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }>

- Defined in src/ethers-contracts/Governance.d.ts:961
parseVM serves to parse an encodedVM into a vm struct - it intentionally performs no validation functions, it simply parses raw into a struct

Parameters
- encodedVM: BytesLike
- Optional overrides: CallOverrides
Returns Promise<[number, number, number, number, string, BigNumber, number, string, number, ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[], string] & { consistencyLevel: number; emitterAddress: string; emitterChainId: number; guardianSetIndex: number; hash: string; nonce: number; payload: string; sequence: BigNumber; signatures: ([string, string, number, number] & { guardianIndex: number; r: string; s: string; v: number })[]; timestamp: number; version: number }>

queryFilter

queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

Overrides BaseContract.queryFilter
- Defined in src/ethers-contracts/Governance.d.ts:319
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- event: TypedEventFilter<EventArgsArray, EventArgsObject>
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

quorum

quorum(numGuardians: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

- Defined in src/ethers-contracts/Governance.d.ts:1005
quorum serves solely to determine the number of signatures required to acheive quorum

Parameters
- numGuardians: BigNumberish
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

removeAllListeners

removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): Governance
removeAllListeners(eventName?: string): Governance

Overrides BaseContract.removeAllListeners
- Defined in src/ethers-contracts/Governance.d.ts:308
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns Governance
Overrides BaseContract.removeAllListeners
- Defined in src/ethers-contracts/Governance.d.ts:317
Parameters
- Optional eventName: string
Returns Governance

removeListener

removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Governance
removeListener(eventName: string, listener: Listener): Governance

Overrides BaseContract.removeListener
- Defined in src/ethers-contracts/Governance.d.ts:304
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns Governance
Overrides BaseContract.removeListener
- Defined in src/ethers-contracts/Governance.d.ts:316
Parameters
- eventName: string
- listener: Listener
Returns Governance

submitContractUpgrade

submitContractUpgrade(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/Governance.d.ts:1047
Upgrades a contract via Governance VAA/VM

Parameters
- _vm: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

submitNewGuardianSet

submitNewGuardianSet(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/Governance.d.ts:1063
Deploys a new guardianSet via Governance VAA/VM

Parameters
- _vm: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

submitRecoverChainId

submitRecoverChainId(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/Governance.d.ts:1079
Updates the chainId and evmChainId on a forked chain via Governance VAA/VM

Parameters
- _vm: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

submitSetMessageFee

submitSetMessageFee(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/Governance.d.ts:1055
Sets a messageFee via Governance VAA/VM

Parameters
- _vm: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

submitTransferFees

submitTransferFees(_vm: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in src/ethers-contracts/Governance.d.ts:1071
Submits transfer fees to the recipient via Governance VAA/VM

Parameters
- _vm: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

verifySignatures

verifySignatures(hash: BytesLike, signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[], guardianSet: { expirationTime: BigNumberish; keys: string[] }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>

- Defined in src/ethers-contracts/Governance.d.ts:1010
Parameters
- hash: BytesLike
- signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
- guardianSet: { expirationTime: BigNumberish; keys: string[] }
  - expirationTime: BigNumberish
  - keys: string[]
- Optional overrides: CallOverrides
Returns Promise<[boolean, string] & { reason: string; valid: boolean }>

verifyVM

verifyVM(vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }, overrides?: CallOverrides): Promise<[boolean, string] & { reason: string; valid: boolean }>

- Defined in src/ethers-contracts/Governance.d.ts:1022
Parameters
- vm: { consistencyLevel: BigNumberish; emitterAddress: BytesLike; emitterChainId: BigNumberish; guardianSetIndex: BigNumberish; hash: BytesLike; nonce: BigNumberish; payload: BytesLike; sequence: BigNumberish; signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]; timestamp: BigNumberish; version: BigNumberish }
  - consistencyLevel: BigNumberish
  - emitterAddress: BytesLike
  - emitterChainId: BigNumberish
  - guardianSetIndex: BigNumberish
  - hash: BytesLike
  - nonce: BigNumberish
  - payload: BytesLike
  - sequence: BigNumberish
  - signatures: { guardianIndex: BigNumberish; r: BytesLike; s: BytesLike; v: BigNumberish }[]
  - timestamp: BigNumberish
  - version: BigNumberish
- Optional overrides: CallOverrides
Returns Promise<[boolean, string] & { reason: string; valid: boolean }>

Static getContractAddress

getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

Inherited from BaseContract.getContractAddress
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:108
Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

Static getInterface

getInterface(contractInterface: ContractInterface): Interface

Inherited from BaseContract.getInterface
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:112
Parameters
- contractInterface: ContractInterface
Returns Interface

Static isIndexed

isIndexed(value: any): value is Indexed

Inherited from BaseContract.isIndexed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:118
Parameters
- value: any
Returns value is Indexed

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressOrName: string

contractInterface: ContractInterface

Optional signerOrProvider: Signer | Provider

Returns Governance

Properties

_deployedPromise

_runningEvents

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

Type declaration

[eventTag: string]: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Readonly address

callStatic

Type declaration

chainId: function

Parameters

Optional overrides: CallOverrides

Returns Promise<number>

evmChainId: function

Parameters

Optional overrides: CallOverrides

Returns Promise<BigNumber>

getCurrentGuardianSetIndex: function

Parameters

Optional overrides: CallOverrides

Returns Promise<number>

getGuardianSet: function

Parameters

index: BigNumberish

Optional overrides: CallOverrides

Returns Promise<[string[], number] & { expirationTime: number; keys: string[] }>

getGuardianSetExpiry: function

Parameters

Optional overrides: CallOverrides

Returns Promise<number>

governanceActionIsConsumed: function

Parameters

hash: BytesLike

Optional overrides: CallOverrides

Returns Promise<boolean>

governanceChainId: function

Parameters

Optional overrides: CallOverrides

Returns Promise<number>

governanceContract: function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

isFork: function

Parameters

Optional overrides: CallOverrides

Returns Promise<boolean>

isInitialized: function

Parameters

impl: string

Optional overrides: CallOverrides

Returns Promise<boolean>

messageFee: function

Parameters

Optional overrides: CallOverrides

Returns Promise<BigNumber>

nextSequence: function

Parameters

emitter: string

Optional overrides: CallOverrides

Returns Promise<BigNumber>

parseAndVerifyVM: function

Parameters