@xyo-network/key-model
v5.3.30
Published
Primary SDK for using XYO Protocol 2.0
Keywords
Readme
@xyo-network/key-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
### key-model
### .temp-typedoc
### interfaces
### <a id="AddressValueInstance"></a>AddressValueInstanceExtends
EllipticKeyInstance
Properties
base58
base58: string;Inherited from
EllipticKeyInstance.base58bytes
bytes: ArrayBufferLike;Inherited from
EllipticKeyInstance.byteshex
hex: BrandedHex;Inherited from
EllipticKeyInstance.hexkeccak256
keccak256: ArrayBufferLike;Inherited from
EllipticKeyInstance.keccak256 ### <a id="AddressValueStatic"></a>AddressValueStaticConstructors
Constructor
new AddressValueStatic(address): AddressValueInstance;Parameters
address
ArrayBuffer
Returns
Methods
addressFromAddressOrPublicKey()
addressFromAddressOrPublicKey(bytes): ArrayBufferLike;Parameters
bytes
ArrayBufferLike
Returns
ArrayBufferLike
addressFromPublicKey()
addressFromPublicKey(key): ArrayBufferLike;Parameters
key
ArrayBufferLike
Returns
ArrayBufferLike
isAddress()
isAddress(value): boolean;Parameters
value
unknown
Returns
boolean
### <a id="PrivateKeyConfig"></a>PrivateKeyConfigProperties
privateKeyData?
optional privateKeyData?: ArrayBufferLike; ### <a id="PrivateKeyInstance"></a>PrivateKeyInstanceExtends
EllipticKeyInstance
Properties
base58
base58: string;Inherited from
EllipticKeyInstance.base58bytes
bytes: ArrayBufferLike;Inherited from
EllipticKeyInstance.byteshex
hex: BrandedHex;Inherited from
EllipticKeyInstance.hexkeccak256
keccak256: ArrayBufferLike;Inherited from
EllipticKeyInstance.keccak256public
public: PublicKeyInstance;sign
sign: (hash) => ArrayBufferLike | Promise<ArrayBufferLike>;Parameters
hash
ArrayBufferLike
Returns
ArrayBufferLike | Promise<ArrayBufferLike>
verify
verify: (msg, signature) => boolean | Promise<boolean>;Parameters
msg
ArrayBufferLike
signature
ArrayBufferLike
Returns
boolean | Promise<boolean>
### <a id="PrivateKeyStatic"></a>PrivateKeyStaticMethods
create()
create(value): Promise<PrivateKeyInstance>;Parameters
value
bigint | ArrayBufferLike
Returns
Promise<PrivateKeyInstance>
isPrivateKey()
isPrivateKey(value): boolean;Parameters
value
unknown
Returns
boolean
### <a id="PublicKeyInstance"></a>PublicKeyInstanceExtends
EllipticKeyInstance
Properties
base58
base58: string;Inherited from
EllipticKeyInstance.base58bytes
bytes: ArrayBufferLike;Inherited from
EllipticKeyInstance.byteshex
hex: BrandedHex;Inherited from
EllipticKeyInstance.hexkeccak256
keccak256: ArrayBufferLike;Inherited from
EllipticKeyInstance.keccak256Accessors
address
Get Signature
get address(): AddressValueInstance;Returns
Methods
verify()
verify(msg, signature): boolean | Promise<boolean>;Parameters
msg
ArrayBufferLike
signature
ArrayBufferLike
Returns
boolean | Promise<boolean>
### <a id="PublicKeyStatic"></a>PublicKeyStaticMethods
create()
create(bytes): Promise<PublicKeyInstance>;Parameters
bytes
ArrayBufferLike
Returns
Promise<PublicKeyInstance>
isPublicKey()
isPublicKey(value): boolean;Parameters
value
unknown
Returns
boolean

