Class EnokiKeypair

TODO: Document

Hierarchy (view full)

Keypair
- EnokiKeypair

Index

Constructors

constructor

Methods

export getKeyScheme getPublicKey getSecretKey sign signPersonalMessage signTransaction signWithIntent toSuiAddress

Constructors

constructor

new EnokiKeypair(input): EnokiKeypair
Parameters
- input: {
      address: string;
      ephemeralKeypair: Ed25519Keypair;
      maxEpoch: number;
      proof: {
          addressSeed: string;
          headerBase64: string;
          issBase64Details: {
              indexMod4: number;
              value: string;
          };
          proofPoints: {
              a: Iterable<string> & {
                  length: number;
              };
              b: Iterable<Iterable<string> & {
                  length: number;
              }> & {
                  length: number;
              };
              c: Iterable<string> & {
                  length: number;
              };
          };
      };
  }
  - address: string
  - ephemeralKeypair: Ed25519Keypair
  - maxEpoch: number
  - proof: {
        addressSeed: string;
        headerBase64: string;
        issBase64Details: {
            indexMod4: number;
            value: string;
        };
        proofPoints: {
            a: Iterable<string> & {
                length: number;
            };
            b: Iterable<Iterable<string> & {
                length: number;
            }> & {
                length: number;
            };
            c: Iterable<string> & {
                length: number;
            };
        };
    }
    - addressSeed: string
    - headerBase64: string
    - issBase64Details: {
      indexMod4: number;
      value: string;
      }
      indexMod4: number
      value: string
    - proofPoints: {
          a: Iterable<string> & {
              length: number;
          };
          b: Iterable<Iterable<string> & {
              length: number;
          }> & {
              length: number;
          };
          c: Iterable<string> & {
              length: number;
          };
      }
      a: Iterable<string> & {
          length: number;
      }
      b: Iterable<Iterable<string> & {
          length: number;
      }> & {
          length: number;
      }
      c: Iterable<string> & {
          length: number;
      }
Returns EnokiKeypair
Overrides Keypair.constructor
- Defined in enoki/src/EnokiKeypair.ts:43

Methods

export

export(): never
Returns never
- Defined in enoki/src/EnokiKeypair.ts:103

getKeyScheme

getKeyScheme(): SignatureScheme
Get the key scheme of the keypair: Secp256k1 or ED25519

Returns SignatureScheme
Overrides Keypair.getKeyScheme
- Defined in enoki/src/EnokiKeypair.ts:95

getPublicKey

getPublicKey(): EnokiPublicKey
The public key for this keypair

Returns EnokiPublicKey
Overrides Keypair.getPublicKey
- Defined in enoki/src/EnokiKeypair.ts:99

getSecretKey

getSecretKey(): never
This returns the Bech32 secret key string for this keypair.

Returns never
Overrides Keypair.getSecretKey
- Defined in enoki/src/EnokiKeypair.ts:107

sign

sign(data): Promise<Uint8Array>
Parameters
- data: Uint8Array
Returns Promise<Uint8Array>
Overrides Keypair.sign
- Defined in enoki/src/EnokiKeypair.ts:59

signPersonalMessage

signPersonalMessage(bytes): Promise<SignatureWithBytes>
Signs provided personal message by calling signWithIntent() with a PersonalMessage provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
Overrides Keypair.signPersonalMessage
- Defined in enoki/src/EnokiKeypair.ts:63

signTransaction

signTransaction(bytes): Promise<SignatureWithBytes>
Signs provided transaction by calling signWithIntent() with a TransactionData provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
Overrides Keypair.signTransaction
- Defined in enoki/src/EnokiKeypair.ts:79

signWithIntent

signWithIntent(bytes, intent): Promise<SignatureWithBytes>
Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, it ensures that a signed message is tied to a specific purpose and domain separator is provided
Parameters
- bytes: Uint8Array
- intent: IntentScope
Returns Promise<SignatureWithBytes>
Inherited from Keypair.signWithIntent
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:24

toSuiAddress

toSuiAddress(): string
Returns string
Inherited from Keypair.toSuiAddress
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:36

Class EnokiKeypair

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

address: string

ephemeralKeypair: Ed25519Keypair

maxEpoch: number

proof: { addressSeed: string; headerBase64: string; issBase64Details: { indexMod4: number; value: string; }; proofPoints: { a: Iterable<string> & { length: number; }; b: Iterable<Iterable<string> & { length: number; }> & { length: number; }; c: Iterable<string> & { length: number; }; }; }

addressSeed: string

headerBase64: string

issBase64Details: { indexMod4: number; value: string; }

indexMod4: number

value: string

proofPoints: { a: Iterable<string> & { length: number; }; b: Iterable<Iterable<string> & { length: number; }> & { length: number; }; c: Iterable<string> & { length: number; }; }

a: Iterable<string> & { length: number; }

b: Iterable<Iterable<string> & { length: number; }> & { length: number; }

c: Iterable<string> & { length: number; }

Returns EnokiKeypair

Methods

export

Returns never

getKeyScheme

Returns SignatureScheme

getPublicKey

Returns EnokiPublicKey

getSecretKey

Returns never

sign

Parameters

Returns Promise<Uint8Array>

signPersonalMessage

Parameters

Returns Promise<SignatureWithBytes>

signTransaction

Parameters

Returns Promise<SignatureWithBytes>

signWithIntent

Parameters

Returns Promise<SignatureWithBytes>

toSuiAddress

Returns string

Settings

On This Page

proof: {
addressSeed: string;
headerBase64: string;
issBase64Details: {
indexMod4: number;
value: string;
};
proofPoints: {
a: Iterable<string> & {
length: number;
};
b: Iterable<Iterable<string> & {
length: number;
}> & {
length: number;
};
c: Iterable<string> & {
length: number;
};
};
}

issBase64Details: {
indexMod4: number;
value: string;
}

proofPoints: {
a: Iterable<string> & {
length: number;
};
b: Iterable<Iterable<string> & {
length: number;
}> & {
length: number;
};
c: Iterable<string> & {
length: number;
};
}

a: Iterable<string> & {
length: number;
}

b: Iterable<Iterable<string> & {
length: number;
}> & {
length: number;
}

c: Iterable<string> & {
length: number;
}