@xyo-network/account-model

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

protocol

### packages

  ### crypto

    ### packages

      ### account-model

        ### .temp-typedoc

          ### functions

            ### <a id="isAccountInstance"></a>isAccountInstance

@xyo-network/account-model

function isAccountInstance(account): account is AccountInstance;

Parameters

account

any

Returns

account is AccountInstance

            ### <a id="isInitializationConfig"></a>isInitializationConfig

@xyo-network/account-model

function isInitializationConfig(value): value is InitializationConfig;

Parameters

value

unknown

Returns

value is InitializationConfig

            ### <a id="isMnemonicInitializationConfig"></a>isMnemonicInitializationConfig

@xyo-network/account-model

function isMnemonicInitializationConfig(value): value is MnemonicInitializationConfig;

Parameters

value

unknown

Returns

value is MnemonicInitializationConfig

            ### <a id="isPhraseInitializationConfig"></a>isPhraseInitializationConfig

@xyo-network/account-model

function isPhraseInitializationConfig(value): value is PhraseInitializationConfig;

Parameters

value

unknown

Returns

value is PhraseInitializationConfig

            ### <a id="isPrivateKeyInitializationConfig"></a>isPrivateKeyInitializationConfig

@xyo-network/account-model

function isPrivateKeyInitializationConfig(value): value is PrivateKeyInitializationConfig;

Parameters

value

unknown

Returns

value is PrivateKeyInitializationConfig

          ### interfaces

            ### <a id="AccountInstance"></a>AccountInstance

@xyo-network/account-model

Properties

address

readonly address: BrandedAddress;

addressBytes

readonly addressBytes: ArrayBufferLike;

previousHash

previousHash: BrandedHash | undefined;

previousHashBytes

previousHashBytes: ArrayBufferLike | undefined;

private?

readonly optional private?: PrivateKeyInstance;

public?

readonly optional public?: PublicKeyInstance;

sign

sign: (hash, previousHash?) => Promise<[ArrayBufferLike, BrandedHash?]>;

Parameters

hash

ArrayBufferLike

previousHash?

ArrayBufferLike

Returns

Promise<[ArrayBufferLike, BrandedHash?]>

verify

verify: (msg, signature) => Promise<boolean>;

Parameters

msg

ArrayBufferLike

signature

ArrayBufferLike

Returns

Promise<boolean>

            ### <a id="AccountOptions"></a>AccountOptions

@xyo-network/account-model

Properties

previousHash?

optional previousHash?: ArrayBufferLike;

            ### <a id="AccountStatic"></a>AccountStatic

@xyo-network/account-model

Type Parameters

T

T extends AccountInstance = AccountInstance

C

C extends AccountConfig = AccountConfig

Properties

previousHashStore?

optional previousHashStore?: PreviousHashStore;

Methods

create()

create(options?): Promise<T>;

Parameters

options?

C

Returns

Promise<T>

fromPrivateKey()

fromPrivateKey(key): Promise<AccountInstance>;

Parameters

key

string | bigint | ArrayBufferLike

Returns

Promise<AccountInstance>

random()

random(): Promise<AccountInstance>;

Returns

Promise<AccountInstance>

            ### <a id="MnemonicInitializationConfig"></a>MnemonicInitializationConfig

@xyo-network/account-model

Properties

mnemonic

mnemonic: string;

path?

optional path?: string;

            ### <a id="PhraseInitializationConfig"></a>PhraseInitializationConfig

@xyo-network/account-model

Properties

phrase

phrase: string;

            ### <a id="PrivateKeyInitializationConfig"></a>PrivateKeyInitializationConfig

@xyo-network/account-model

Properties

privateKey

privateKey: ArrayBufferLike;

          ### type-aliases

            ### <a id="AccountConfig"></a>AccountConfig

@xyo-network/account-model

type AccountConfig = InitializationConfig & AccountOptions;

            ### <a id="InitializationConfig"></a>InitializationConfig

@xyo-network/account-model

type InitializationConfig = 
  | PhraseInitializationConfig
  | PrivateKeyInitializationConfig
  | MnemonicInitializationConfig;

          ### variables

            ### <a id="ethMessagePrefix"></a>ethMessagePrefix

@xyo-network/account-model

const ethMessagePrefix: "\u0019Ethereum Signed Message:\n" = '\u0019Ethereum Signed Message:\n';