mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-06-03 08:46:40 +00:00
Merge branch 'main-xahau' into workflow-publish
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "xahau-address-codec",
|
||||
"version": "5.0.0",
|
||||
"description": "encodes/decodes base58 encoded XAH Ledger identifiers",
|
||||
"description": "encodes/decodes base58 encoded Xahau Network identifiers",
|
||||
"files": [
|
||||
"dist/*",
|
||||
"src/*"
|
||||
|
||||
@@ -162,9 +162,9 @@ export {
|
||||
encodeAccountID,
|
||||
// Decode a classic address to its raw bytes
|
||||
decodeAccountID,
|
||||
// Encode bytes to XAH Ledger node public key format
|
||||
// Encode bytes to Xahau Network node public key format
|
||||
encodeNodePublic,
|
||||
// Decode an XAH Ledger node public key into its raw bytes
|
||||
// Decode an Xahau Network node public key into its raw bytes
|
||||
decodeNodePublic,
|
||||
// Encode a public key, as for payment channels
|
||||
encodeAccountPublic,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "xahau-binary-codec",
|
||||
"version": "2.1.3",
|
||||
"description": "XAH Ledger binary codec",
|
||||
"description": "Xahau Network binary codec",
|
||||
"files": [
|
||||
"dist/*",
|
||||
"src/*"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "xahau-keypairs",
|
||||
"version": "2.0.0",
|
||||
"description": "Cryptographic key pairs for the XAH Ledger",
|
||||
"description": "Cryptographic key pairs for the Xahau Network",
|
||||
"scripts": {
|
||||
"build": "tsc --build tsconfig.build.json",
|
||||
"test": "jest --verbose false --silent=false ./test/*.test.ts",
|
||||
|
||||
@@ -47,7 +47,7 @@ const ed25519: SigningScheme = {
|
||||
// ZIP 215 is a stricter Ed25519 signature verification scheme.
|
||||
// However, setting it to false adheres to the more commonly used
|
||||
// RFC8032 / NIST186-5 standards, making it compatible with systems
|
||||
// like the XAH Ledger.
|
||||
// like the Xahau Network.
|
||||
{ zip215: false },
|
||||
)
|
||||
},
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"name": "xahau",
|
||||
"version": "4.0.3",
|
||||
"license": "ISC",
|
||||
"description": "A TypeScript/JavaScript API for interacting with the XAH Ledger in Node.js and the browser",
|
||||
"description": "A TypeScript/JavaScript API for interacting with the Xahau Network in Node.js and the browser",
|
||||
"files": [
|
||||
"build/xahau-latest-min.js",
|
||||
"build/xahau-latest-min.js.map",
|
||||
|
||||
@@ -355,13 +355,13 @@ export class Wallet {
|
||||
* Output of `sign` includes a `tx_blob` and a `hash`, both of which are needed to submit & verify the results.
|
||||
* Note: If you pass a `Wallet` to `client.submit` or `client.submitAndWait` it will do signing like this under the hood.
|
||||
*
|
||||
* `tx_blob` is a binary representation of a transaction on the XAH Ledger. It's essentially a byte array
|
||||
* `tx_blob` is a binary representation of a transaction on the Xahau Network. It's essentially a byte array
|
||||
* that encodes all of the data necessary to execute the transaction, including the source address, the destination
|
||||
* address, the amount, and any additional fields required for the specific transaction type.
|
||||
*
|
||||
* `hash` is a unique identifier that's generated from the signed transaction data on the XAH Ledger. It's essentially
|
||||
* `hash` is a unique identifier that's generated from the signed transaction data on the Xahau Network. It's essentially
|
||||
* A cryptographic digest of the signed transaction blob, created using a hash function. The signed transaction hash is
|
||||
* Useful for identifying and tracking specific transactions on the XAH Ledger. It can be used to query transaction
|
||||
* Useful for identifying and tracking specific transactions on the Xahau Network. It can be used to query transaction
|
||||
* Information, verify the authenticity of a transaction, and detect any tampering with the transaction data.
|
||||
*
|
||||
* @param this - Wallet instance.
|
||||
|
||||
@@ -1063,7 +1063,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
|
||||
/**
|
||||
* The fundWallet() method is used to send an amount of XAH (usually 1000) to a new (randomly generated)
|
||||
* or existing XAH Ledger wallet.
|
||||
* or existing Xahau Network wallet.
|
||||
*
|
||||
* @category Faucet
|
||||
*
|
||||
|
||||
@@ -64,10 +64,11 @@ function isPartialPayment(
|
||||
}
|
||||
|
||||
const delivered = meta.delivered_amount
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- DeliverMax is a valid field on Payment response
|
||||
// @ts-expect-error -- DeliverMax is a valid field on Payment response
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- DeliverMax is a valid field on Payment response
|
||||
const amount = tx.DeliverMax
|
||||
const amount = tx.DeliverMax ?? tx.Amount
|
||||
|
||||
if (delivered === undefined) {
|
||||
return false
|
||||
|
||||
@@ -71,7 +71,7 @@ export interface SignerEntry {
|
||||
*/
|
||||
SignerEntry: {
|
||||
/**
|
||||
* An XAH Ledger address whose signature contributes to the multi-signature.
|
||||
* An Xahau Network address whose signature contributes to the multi-signature.
|
||||
* It does not need to be a funded address in the ledger.
|
||||
*/
|
||||
Account: string
|
||||
|
||||
@@ -11,7 +11,7 @@ export interface FeeSettingsPreAmendmentFields {
|
||||
BaseFee: string
|
||||
/** The BaseFee translated into "fee units". */
|
||||
ReferenceFeeUnits: number
|
||||
/** The base reserve for an account in the XAH Ledger, as drops of XAH. */
|
||||
/** The base reserve for an account in the Xahau Network, as drops of XAH. */
|
||||
ReserveBase: number
|
||||
/** The incremental owner reserve for owning objects, as drops of XAH. */
|
||||
ReserveIncrement: number
|
||||
@@ -20,7 +20,7 @@ export interface FeeSettingsPreAmendmentFields {
|
||||
export interface FeeSettingsPostAmendmentFields {
|
||||
/** The transaction cost of the "reference transaction" in drops of XAH as hexadecimal. */
|
||||
BaseFeeDrops: string
|
||||
/** The base reserve for an account in the XAH Ledger, as drops of XAH. */
|
||||
/** The base reserve for an account in the Xahau Network, as drops of XAH. */
|
||||
ReserveBaseDrops: string
|
||||
/** The incremental owner reserve for owning objects, as drops of XAH. */
|
||||
ReserveIncrementDrops: string
|
||||
|
||||
@@ -3,7 +3,7 @@ import { Amount } from '../common'
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
|
||||
/**
|
||||
* Represents a payment channel in the XAH Ledger.
|
||||
* Represents a payment channel in the Xahau Network.
|
||||
*/
|
||||
export interface Channel {
|
||||
/** The owner of the channel, as an Address. */
|
||||
@@ -38,7 +38,7 @@ export interface Channel {
|
||||
settle_delay: number
|
||||
|
||||
/**
|
||||
* The public key for the payment channel in the XAH Ledger's base58 format.
|
||||
* The public key for the payment channel in the Xahau Network's base58 format.
|
||||
* Signed claims against this channel must be redeemed with the matching key pair.
|
||||
*/
|
||||
public_key?: string
|
||||
|
||||
@@ -14,7 +14,7 @@ export interface AccountCurrenciesRequest
|
||||
/** A unique identifier for the account, most commonly the account's address. */
|
||||
account: string
|
||||
/**
|
||||
* If true, then the account field only accepts a public key or XAH Ledger
|
||||
* If true, then the account field only accepts a public key or Xahau Network
|
||||
* address. Otherwise, account can be a secret or passphrase (not
|
||||
* recommended). The default is false.
|
||||
*/
|
||||
|
||||
@@ -25,7 +25,7 @@ export interface AccountInfoRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
*/
|
||||
signer_lists?: boolean
|
||||
/**
|
||||
* If true, then the account field only accepts a public key or XAH Ledger
|
||||
* If true, then the account field only accepts a public key or Xahau Network
|
||||
* address. Otherwise, account can be a secret or passphrase (not
|
||||
* recommended). The default is false.
|
||||
*/
|
||||
@@ -159,7 +159,7 @@ interface BaseAccountInfoResponse extends BaseResponse {
|
||||
/**
|
||||
* Information about queued transactions sent by this account. This
|
||||
* information describes the state of the local xahaud server, which may be
|
||||
* different from other servers in the peer-to-peer XAH Ledger network. Some
|
||||
* different from other servers in the peer-to-peer Xahau Network network. Some
|
||||
* fields may be omitted because the values are calculated "lazily" by the
|
||||
* queuing mechanism.
|
||||
*/
|
||||
|
||||
@@ -26,7 +26,7 @@ export interface AccountOffersRequest
|
||||
*/
|
||||
marker?: unknown
|
||||
/**
|
||||
* If true, then the account field only accepts a public key or XAH Ledger
|
||||
* If true, then the account field only accepts a public key or Xahau Network
|
||||
* address. Otherwise, account can be a secret or passphrase (not
|
||||
* recommended). The default is false.
|
||||
*/
|
||||
|
||||
@@ -18,7 +18,7 @@ export interface ChannelVerifyRequest extends BaseRequest {
|
||||
channel_id: string
|
||||
/**
|
||||
* The public key of the channel and the key pair that was used to create the
|
||||
* signature, in hexadecimal or the XAH Ledger's base58 format.
|
||||
* signature, in hexadecimal or the Xahau Network's base58 format.
|
||||
*/
|
||||
public_key: string
|
||||
/** The signature to verify, in hexadecimal. */
|
||||
|
||||
@@ -3,7 +3,7 @@ import { LedgerEntry } from '../ledger'
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
|
||||
/**
|
||||
* The `ledger_entry` method returns a single ledger object from the XAH Ledger
|
||||
* The `ledger_entry` method returns a single ledger object from the Xahau Network
|
||||
* in its raw format. Expects a response in the form of a {@link
|
||||
* LedgerEntryResponse}.
|
||||
*
|
||||
@@ -30,7 +30,7 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
include_deleted?: boolean
|
||||
/**
|
||||
* If true, return the requested ledger object's contents as a hex string in
|
||||
* the XAH Ledger's binary format. Otherwise, return data in JSON format. The
|
||||
* the Xahau Network's binary format. Otherwise, return data in JSON format. The
|
||||
* default is false.
|
||||
*/
|
||||
binary?: boolean
|
||||
|
||||
@@ -108,7 +108,7 @@ export interface ServerInfoResponse extends BaseResponse {
|
||||
* The number of times (since starting up) that this server has had over
|
||||
* 250 transactions waiting to be processed at once. A large number here
|
||||
* may mean that your server is unable to handle the transaction load of
|
||||
* the XAH Ledger network.
|
||||
* the Xahau Network network.
|
||||
*/
|
||||
jq_trans_overflow: string
|
||||
/**
|
||||
|
||||
@@ -65,7 +65,7 @@ export interface SubmitResponse extends BaseResponse {
|
||||
applied: boolean
|
||||
/**
|
||||
* The value true indicates this transaction was broadcast to peer servers
|
||||
* in the peer-to-peer XAH Ledger network.
|
||||
* in the peer-to-peer Xahau Network network.
|
||||
*/
|
||||
broadcast: boolean
|
||||
/**
|
||||
|
||||
@@ -29,7 +29,7 @@ export interface SubscribeBook {
|
||||
taker_pays: Currency
|
||||
/**
|
||||
* Unique account address to use as a perspective for viewing offers, in the.
|
||||
* XAH Ledger's base58 format.
|
||||
* Xahau Network's base58 format.
|
||||
*/
|
||||
taker: string
|
||||
/**
|
||||
@@ -54,7 +54,7 @@ export interface SubscribeRequest extends BaseRequest {
|
||||
streams?: StreamType[]
|
||||
/**
|
||||
* Array with the unique addresses of accounts to monitor for validated
|
||||
* transactions. The addresses must be in the XAH Ledger's base58 format.
|
||||
* transactions. The addresses must be in the Xahau Network's base58 format.
|
||||
* The server sends a notification for any transaction that affects at least
|
||||
* one of these accounts.
|
||||
*/
|
||||
@@ -235,7 +235,7 @@ export interface ValidationStream extends BaseStream {
|
||||
load_fee?: number
|
||||
/**
|
||||
* The validator's master public key, if the validator is using a validator
|
||||
* token, in the XAH Ledger's base58 format.
|
||||
* token, in the Xahau Network's base58 format.
|
||||
*/
|
||||
master_key?: string
|
||||
/**
|
||||
@@ -254,7 +254,7 @@ export interface ValidationStream extends BaseStream {
|
||||
signing_time: number
|
||||
/**
|
||||
* The public key from the key-pair that the validator used to sign the
|
||||
* message, in the XAH Ledger's base58 format. This identifies the validator
|
||||
* message, in the Xahau Network's base58 format. This identifies the validator
|
||||
* sending the message and can also be used to verify the signature. If the
|
||||
* validator is using a token, this is an ephemeral public key.
|
||||
*/
|
||||
|
||||
@@ -24,7 +24,7 @@ export interface UnsubscribeRequest extends BaseRequest {
|
||||
streams?: StreamType[]
|
||||
/**
|
||||
* Array of unique account addresses to stop receiving updates for, in the.
|
||||
* XAH Ledger's base58 format.
|
||||
* Xahau Network's base58 format.
|
||||
*/
|
||||
accounts?: string[]
|
||||
/**
|
||||
|
||||
@@ -11,10 +11,10 @@ import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
*/
|
||||
export interface DepositPreauth extends BaseTransaction {
|
||||
TransactionType: 'DepositPreauth'
|
||||
/** The XAH Ledger address of the sender to preauthorize. */
|
||||
/** The Xahau Network address of the sender to preauthorize. */
|
||||
Authorize?: string
|
||||
/**
|
||||
* The XAH Ledger address of a sender whose preauthorization should be.
|
||||
* The Xahau Network address of a sender whose preauthorization should be.
|
||||
* revoked.
|
||||
*/
|
||||
Unauthorize?: string
|
||||
|
||||
@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* An OfferCancel transaction removes an Offer object from the XAH Ledger.
|
||||
* An OfferCancel transaction removes an Offer object from the Xahau Network.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* XAH Ledger namespace prefixes.
|
||||
* Xahau Network namespace prefixes.
|
||||
*
|
||||
* The XAH Ledger is a key-value store. In order to avoid name collisions,
|
||||
* The Xahau Network is a key-value store. In order to avoid name collisions,
|
||||
* names are partitioned into namespaces.
|
||||
*
|
||||
* Each namespace is just a single character prefix.
|
||||
|
||||
Reference in New Issue
Block a user