Class Web3ConnectorPlugin

Plugin per la gestione delle funzionalità Web3 in ShogunCore

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_category? core description name signer version Web3

Methods

assertInitialized assertMetaMask assertSigner cleanup connectMetaMask createAuthenticator createDerivedKeyPair createGunUserFromSigningCredential createSigningCredential destroy emit generateCredentials generatePassword getGunUserPubFromSigningCredential getPassword getProvider getSigner getSigningCredential initialize isAvailable listSigningCredentials login off on once removeAllListeners removeSigningCredential setCustomProvider setupConsistentOneshotSigning signUp signWithDerivedKeys verifyConsistency verifySignature

Constructors

constructor

Properties

Optional_category

_category?: PluginCategory

Categoria del plugin

Protectedcore

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

description

description: string = "Provides Ethereum wallet connection and authentication for ShogunCore"

Descrizione opzionale del plugin

name

name: string = "web3"

Nome univoco del plugin - deve essere implementato dalle sottoclassi

Privatesigner

signer: null | Web3Signer = null

version

version: string = "1.0.0"

Versione del plugin - deve essere implementata dalle sottoclassi

PrivateWeb3

Web3: null | Web3Connector = null

Methods

ProtectedassertInitialized

  • assertInitialized(): ShogunCore

    Verifica che il plugin sia stato inizializzato prima di usare il core

    Returns ShogunCore

    L'istanza di ShogunCore non null

    Throws

    Error se il plugin non è stato inizializzato

PrivateassertMetaMask

PrivateassertSigner

  • assertSigner(): Web3Signer
    Private

    Assicura che il signer sia inizializzato

    Returns Web3Signer

cleanup

connectMetaMask

createAuthenticator

  • createAuthenticator(address: string): (data: any) => Promise<string>

    Creates an authenticator function for Web3 signing

    Parameters

    • address: string

    Returns (data: any) => Promise<string>

createDerivedKeyPair

  • createDerivedKeyPair(
        address: string,
        extra?: string[],
    ): Promise<{ epriv: string; epub: string; priv: string; pub: string }>

    Creates a derived key pair from Web3 credential

    Parameters

    • address: string
    • Optionalextra: string[]

    Returns Promise<{ epriv: string; epub: string; priv: string; pub: string }>

createGunUserFromSigningCredential

  • createGunUserFromSigningCredential(
        address: string,
    ): Promise<{ error?: string; success: boolean; userPub?: string }>

    Creates a Gun user from Web3 signing credential This ensures the SAME user is created as with normal approach

    Parameters

    • address: string

    Returns Promise<{ error?: string; success: boolean; userPub?: string }>

createSigningCredential

  • createSigningCredential(address: string): Promise<Web3SigningCredential>

    Creates a new Web3 signing credential CONSISTENT with normal Web3 approach

    Parameters

    • address: string

    Returns Promise<Web3SigningCredential>

destroy

  • destroy(): void

    Distrugge il plugin e libera le risorse

    Returns void

emit

  • emit(event: EventType, data?: unknown): boolean

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

generateCredentials

  • generateCredentials(address: string): Promise<Web3ConnectorCredentials>

    Genera credenziali utilizzando MetaMask

    Parameters

    • address: string

      Indirizzo Ethereum

    Returns Promise<Web3ConnectorCredentials>

    Promise con le credenziali generate

generatePassword

  • generatePassword(signature: string): Promise<string>

    Genera una password basata su una firma

    Parameters

    • signature: string

      Firma

    Returns Promise<string>

    Promise con la password generata

getGunUserPubFromSigningCredential

  • getGunUserPubFromSigningCredential(address: string): undefined | string

    Get the Gun user public key for a signing credential

    Parameters

    • address: string

    Returns undefined | string

getPassword

  • getPassword(address: string): undefined | string

    Get the password (for consistency checking)

    Parameters

    • address: string

    Returns undefined | string

getProvider

  • getProvider(): Promise<BrowserProvider | JsonRpcProvider>

    Returns Promise<BrowserProvider | JsonRpcProvider>

    Inherit Doc

getSigner

getSigningCredential

  • getSigningCredential(address: string): undefined | Web3SigningCredential

    Get signing credential by address

    Parameters

    • address: string

    Returns undefined | Web3SigningCredential

initialize

isAvailable

  • isAvailable(): boolean

    Verifica se MetaMask è disponibile nel browser

    Returns boolean

    true se MetaMask è disponibile, false altrimenti

listSigningCredentials

  • listSigningCredentials(): Web3SigningCredential[]

    List all signing credentials

    Returns Web3SigningCredential[]

login

  • login(address: string): Promise<AuthResult>

    Login con Web3

    Parameters

    • address: string

      Indirizzo Ethereum

    Returns Promise<AuthResult>

    Risultato dell'autenticazione

    Description

    Autentica l'utente usando le credenziali del wallet Web3 dopo la verifica della firma

off

  • off(event: EventType, listener: (data: unknown) => void): void

    Removes an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

removeSigningCredential

  • removeSigningCredential(address: string): boolean

    Remove a signing credential

    Parameters

    • address: string

    Returns boolean

setCustomProvider

  • setCustomProvider(rpcUrl: string, privateKey: string): void

    Imposta un provider personalizzato

    Parameters

    • rpcUrl: string

      URL del provider RPC

    • privateKey: string

      Chiave privata

    Returns void

setupConsistentOneshotSigning

  • setupConsistentOneshotSigning(
        address: string,
    ): Promise<
        {
            authenticator: (data: any) => Promise<string>;
            credential: Web3SigningCredential;
            gunUser: { error?: string; success: boolean; userPub?: string };
            password: string;
            username: string;
        },
    >

    Complete oneshot workflow that creates the SAME Gun user as normal approach This is the recommended method for oneshot signing with full consistency

    Parameters

    • address: string

    Returns Promise<
        {
            authenticator: (data: any) => Promise<string>;
            credential: Web3SigningCredential;
            gunUser: { error?: string; success: boolean; userPub?: string };
            password: string;
            username: string;
        },
    >

signUp

  • signUp(address: string): Promise<AuthResult>

    Registra un nuovo utente con Web3

    Parameters

    • address: string

      Indirizzo Ethereum

    Returns Promise<AuthResult>

    Risultato della registrazione

    Description

    Crea un nuovo account utente usando le credenziali del wallet Web3 dopo la verifica della firma

signWithDerivedKeys

  • signWithDerivedKeys(
        data: any,
        address: string,
        extra?: string[],
    ): Promise<string>

    Signs data with derived keys after Web3 verification

    Parameters

    • data: any
    • address: string
    • Optionalextra: string[]

    Returns Promise<string>

verifyConsistency

  • verifyConsistency(
        address: string,
        expectedUserPub?: string,
    ): Promise<
        {
            actualUserPub?: string;
            consistent: boolean;
            expectedUserPub?: string;
        },
    >

    Verify consistency between oneshot and normal approaches This ensures both approaches create the same Gun user

    Parameters

    • address: string
    • OptionalexpectedUserPub: string

    Returns Promise<
        {
            actualUserPub?: string;
            consistent: boolean;
            expectedUserPub?: string;
        },
    >

verifySignature

  • verifySignature(message: string, signature: string): Promise<string>

    Verifica una firma

    Parameters

    • message: string

      Messaggio firmato

    • signature: string

      Firma da verificare

    Returns Promise<string>

    Promise con l'indirizzo che ha generato la firma

Settings

Member Visibility

On This Page

Constructors
Properties
Methods