Class Marionette

Contract

Marionette

Hierarchy

AccessControlEnumerable
- Marionette

Index

Constructors

constructor

new Marionette(params: IInitParams): Marionette
Initialization of the Marionette Contract This is a wrapper of the solidity smart contract
Parameters
- params: IInitParams
  
  The core parameters passed into the constructor
Returns Marionette
Overrides AccessControlEnumerable.constructor
- Defined in ../../packages/marionette/src/contract.ts:33

Properties

DEFAULT_ADMIN_ROLE

DEFAULT_ADMIN_ROLE: string

IMA_ROLE

IMA_ROLE: string = ...

PUPPETEER_ROLE

PUPPETEER_ROLE: string = ...

contract

contract: Contract

`Protected` hasSigner

hasSigner: boolean

`Protected` signer

signer: Wallet

Methods

checkSigner

checkSigner(): void
Returns void
Inherited from AccessControlEnumerable.checkSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:22

encodeFunctionCall

encodeFunctionCall(params: IExecute): Promise<BytesLike>
Wrapper for Solidity Function execute. Must have {PUPPETEER_ROLE} to successfully call

Function
execute

Returns
Transaction Information
Parameters
- params: IExecute
  
  IExecute contains the target destination, value (sFUEL), and data to be executed by marionette
Returns Promise<BytesLike>
- Defined in ../../packages/marionette/src/contract.ts:96

execute

execute(params: IExecute): Promise<ContractReceipt>
Wrapper for Solidity Function execute. Allows Marionette to call other contracts. Highly Valuable on MULTISIG Chain Creation as Originator can control marionette which controls the chain. Must have {PUPPETEER_ROLE} to successfully call

Function
execute

Returns
Transaction Information
Parameters
- params: IExecute
  
  IExecute contains the target destination, value (sFUEL), and data to be executed by marionette
Returns Promise<ContractReceipt>
- Defined in ../../packages/marionette/src/contract.ts:55

getEventNames

getEventNames(__namedParameters: {
nameOnly?: boolean;
}): string[]
Parameters
- __namedParameters: {
  nameOnly?: boolean;
  }
  - Optional nameOnly?: boolean
Returns string[]
Inherited from AccessControlEnumerable.getEventNames
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:24

getRoleAdmin

getRoleAdmin(role: IRole): Promise<any>
Function
getRoleAdmin

Returns
string
Parameters
- role: IRole
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleAdmin
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:17

getRoleMember

getRoleMember(params: IGetRoleMember): Promise<any>
Function
getRoleMember

Returns
address
Parameters
- params: IGetRoleMember
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleMember
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control_enumerable.d.ts:16

getRoleMemberCount

getRoleMemberCount(role: IRole): Promise<any>
Function
getRoleMemberCount

Returns
BigNumber
Parameters
- role: IRole
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleMemberCount
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control_enumerable.d.ts:23

grantRole

grantRole(params: IRoleAccount): Promise<any>
Function
grantRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.grantRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:24

hasRole

hasRole(params: IRoleAccount): Promise<any>
Function
hasRole

Returns
string

Async
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.hasRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:32

renounceRole

renounceRole(params: IRoleAccount): Promise<any>
Function
renounceRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.renounceRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:46

revokeRole

revokeRole(params: IRoleAccount): Promise<any>
Function
revokeRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.revokeRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:39

sendSFuel

sendSFuel(params: ISendSFuel): Promise<ContractReceipt>
Wrapper for Solidity Function sendSFuel. Sends sFUEL to Target. Must have {PUPPETEER_ROLE} to successfully call

Function
sendSFuel

Returns
Transaction Information
Parameters
- params: ISendSFuel
  
  ISendSFuel contains the target and amount to send
Returns Promise<ContractReceipt>
- Defined in ../../packages/marionette/src/contract.ts:76

setSigner

setSigner(__namedParameters: {
signer: Wallet;
}): void
Parameters
- __namedParameters: {
  signer: Wallet;
  }
  - signer: Wallet
Returns void
Inherited from AccessControlEnumerable.setSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:27

Class Marionette

Contract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: IInitParams

Returns Marionette

Properties

DEFAULT_ADMIN_ROLE

IMA_ROLE

PUPPETEER_ROLE

contract

Protected hasSigner

Protected signer

Methods

checkSigner

Returns void

encodeFunctionCall

Function

Returns

Parameters

params: IExecute

Returns Promise<BytesLike>

execute

Function

Returns

Parameters

params: IExecute

Returns Promise<ContractReceipt>

getEventNames

Parameters

__namedParameters: { nameOnly?: boolean; }

Optional nameOnly?: boolean

Returns string[]

getRoleAdmin

Function

Returns

Parameters

role: IRole

Returns Promise<any>

getRoleMember

Function

Returns

Parameters

params: IGetRoleMember

Returns Promise<any>

getRoleMemberCount

Function

Returns

Parameters

role: IRole

Returns Promise<any>

grantRole

Function

Returns

Parameters

params: IRoleAccount

Returns Promise<any>

hasRole

Function

Returns

Async

Parameters

params: IRoleAccount

Returns Promise<any>

renounceRole

Function

Returns

Parameters

params: IRoleAccount

Returns Promise<any>

revokeRole

Function

Returns

Parameters

`Protected` hasSigner

`Protected` signer

__namedParameters: {
nameOnly?: boolean;
}

`Optional` nameOnly?: boolean

__namedParameters: {
signer: Wallet;
}