Class SdlValidationError
Hierarchy (View Summary)
- ValidationError
- SdlValidationError
Index
Constructors
Properties
Methods
Constructors
constructor
- new SdlValidationError(message: string): SdlValidationError
Creates an instance of
+SdlValidationError.Parameters
- message: string
The error message.
+
Returns SdlValidationError
- message: string
Properties
message
message: string
name
name: string
Optionalstack
stack?: string
Static Optionalprepare
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
Optional override for formatting stack traces
+Staticstack
stackTraceLimit: number
Class ValidationError
Represents a generic validation error.
+Extends the native Error class.
Hierarchy (View Summary)
- Error
- ValidationError
Index
Constructors
Properties
Methods
Constructors
constructor
- new ValidationError(message: string): ValidationError
Creates an instance of
+ValidationError.Parameters
- message: string
The error message.
+
Returns ValidationError
- message: string
Properties
message
message: string
name
name: string
Optionalstack
stack?: string
Static Optionalprepare
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
Optional override for formatting stack traces
+Staticstack
stackTraceLimit: number
Class SDL
SDL (Stack Definition Language) parser and validator +Handles parsing and validation of Akash deployment manifests
+Example
import { SDL } from './SDL';
const yaml = `
version: "2.0"
services:
web:
image: nginx
expose:
- port: 80
as: 80
to:
- global: true
`;
// Parse SDL from YAML string
const sdl = SDL.fromString(yaml);
// Get deployment manifest
const manifest = sdl.manifest();
// Get deployment groups
const groups = sdl.groups();
+ Index
Constructors
Properties
Methods
compute
Methods
compute
deployments
deployments
escape
expose
group
groups
manifest
manifest
manifest
manifest
manifest
manifest
manifest
parse
placements
profiles
resource
resource
- resourceUnitCpu(
    computeResources: v2ComputeResources,
    asString: boolean,
): {
    attributes: undefined | { key: string; value: any }[];
    units: { val: null | string | Uint8Array<ArrayBufferLike> };
} Parameters
- computeResources: v2ComputeResources
- asString: boolean
Returns {
    attributes: undefined | { key: string; value: any }[];
    units: { val: null | string | Uint8Array<ArrayBufferLike> };
}
resource
- resourceUnitGpu(
    computeResources: v3ComputeResources,
    asString: boolean,
): {
    attributes: undefined | { key: string; value: string }[];
    units: { val: null | string | Uint8Array<ArrayBufferLike> };
} Parameters
- computeResources: v3ComputeResources
- asString: boolean
Returns {
    attributes: undefined | { key: string; value: string }[];
    units: { val: null | string | Uint8Array<ArrayBufferLike> };
}
resource
- resourceUnitMemory(
    computeResources: v2ComputeResources,
    asString: boolean,
): {
    attributes: undefined | { key: string; value: any }[];
    quantity: { val: null | string | Uint8Array<ArrayBufferLike> };
} Parameters
- computeResources: v2ComputeResources
- asString: boolean
Returns {
    attributes: undefined | { key: string; value: any }[];
    quantity: { val: null | string | Uint8Array<ArrayBufferLike> };
}
resource
- resourceUnitStorage(
    computeResources: v2ComputeResources,
    asString: boolean,
): {
    attributes: undefined | { key: string; value: any }[];
    name: string;
    quantity: { val: null | string | Uint8Array<ArrayBufferLike> };
}[] Parameters
- computeResources: v2ComputeResources
- asString: boolean
Returns {
    attributes: undefined | { key: string; value: any }[];
    name: string;
    quantity: { val: null | string | Uint8Array<ArrayBufferLike> };
}[]
resource
service
service
service
- serviceResourceCpu(
    resource: v2ResourceCPU,
):
    | {
        attributes: undefined
        | { key: string; value: any }[];
        units: { val: string };
    }
    | { attributes?: undefined; units: { val: string } } Parameters
- resource: v2ResourceCPU
Returns
    | {
        attributes: undefined
        | { key: string; value: any }[];
        units: { val: string };
    }
    | { attributes?: undefined; units: { val: string } }
service
- serviceResourceGpu(
    resource: undefined | v3ResourceGPU,
    asString: boolean,
):
    | {
        attributes: { key: string; value: string }[];
        units: { val: string } | { val: number | Buffer };
    }
    | {
        attributes?: undefined;
        units: { val: string }
        | { val: number | Buffer };
    } Parameters
- resource: undefined | v3ResourceGPU
- asString: boolean
Returns
    | {
        attributes: { key: string; value: string }[];
        units: { val: string } | { val: number | Buffer };
    }
    | {
        attributes?: undefined;
        units: { val: string }
        | { val: number | Buffer };
    }
service
- serviceResourceMemory(
    resource: v2ResourceMemory,
    asString: boolean,
):
    | {
        attributes: undefined
        | { key: string; value: any }[];
        [key: string]:
            | undefined
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        [key: string]: { val: string }
        | { val: number };
    } Parameters
- resource: v2ResourceMemory
- asString: boolean
Returns
    | {
        attributes: undefined
        | { key: string; value: any }[];
        [key: string]:
            | undefined
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        [key: string]: { val: string }
        | { val: number };
    }
service
- serviceResourcesBeta2(
    profile: v2ProfileCompute,
    service: v2Service,
    asString?: boolean,
): {
    cpu:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            units: { val: string };
        }
        | { attributes?: undefined; units: { val: string } };
    endpoints: null | { kind: number; sequence_number: number }[];
    memory:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            [key: string]:
                | undefined
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            [key: string]: { val: string }
            | { val: number };
        };
    storage: (
        | {
            attributes: undefined
            | { key: string; value: any }[];
            name: string;
            [key: string]:
                | undefined
                | string
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            name: string;
            [key: string]: string
            | { val: string }
            | { val: number };
        }
    )[];
} Parameters
- profile: v2ProfileCompute
- service: v2Service
- asString: boolean = false
Returns {
    cpu:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            units: { val: string };
        }
        | { attributes?: undefined; units: { val: string } };
    endpoints: null | { kind: number; sequence_number: number }[];
    memory:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            [key: string]:
                | undefined
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            [key: string]: { val: string }
            | { val: number };
        };
    storage: (
        | {
            attributes: undefined
            | { key: string; value: any }[];
            name: string;
            [key: string]:
                | undefined
                | string
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            name: string;
            [key: string]: string
            | { val: string }
            | { val: number };
        }
    )[];
}
service
- serviceResourcesBeta3(
    id: number,
    profile: v3ProfileCompute,
    service: v2Service,
    asString?: boolean,
): {
    cpu:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            units: { val: string };
        }
        | { attributes?: undefined; units: { val: string } };
    endpoints: (
        | { kind: number; sequence_number: number }
        | { kind?: undefined; sequence_number: number }
    )[];
    gpu:
        | {
            attributes: { key: string; value: string }[];
            units: { val: string } | { val: number | Buffer };
        }
        | {
            attributes?: undefined;
            units: { val: string }
            | { val: number | Buffer };
        };
    id: number;
    memory: | {
        attributes: undefined
        | { key: string; value: any }[];
        [key: string]:
            | undefined
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        [key: string]: { val: string }
        | { val: number };
    };
    storage: (
        | {
            attributes: undefined
            | { key: string; value: any }[];
            name: string;
            [key: string]:
                | undefined
                | string
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            name: string;
            [key: string]: string
            | { val: string }
            | { val: number };
        }
    )[];
} Parameters
- id: number
- profile: v3ProfileCompute
- service: v2Service
- asString: boolean = false
Returns {
    cpu:
        | {
            attributes: undefined
            | { key: string; value: any }[];
            units: { val: string };
        }
        | { attributes?: undefined; units: { val: string } };
    endpoints: (
        | { kind: number; sequence_number: number }
        | { kind?: undefined; sequence_number: number }
    )[];
    gpu:
        | {
            attributes: { key: string; value: string }[];
            units: { val: string } | { val: number | Buffer };
        }
        | {
            attributes?: undefined;
            units: { val: string }
            | { val: number | Buffer };
        };
    id: number;
    memory: | {
        attributes: undefined
        | { key: string; value: any }[];
        [key: string]:
            | undefined
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        [key: string]: { val: string }
        | { val: number };
    };
    storage: (
        | {
            attributes: undefined
            | { key: string; value: any }[];
            name: string;
            [key: string]:
                | undefined
                | string
                | { val: string }
                | { val: number }
                | { key: string; value: any }[];
        }
        | {
            attributes?: undefined;
            name: string;
            [key: string]: string
            | { val: string }
            | { val: number };
        }
    )[];
}
service
- serviceResourceStorage(
    resource: v2ResourceStorage | v2ResourceStorageArray,
    asString: boolean,
): (
    | {
        attributes: undefined
        | { key: string; value: any }[];
        name: string;
        [key: string]:
            | undefined
            | string
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        name: string;
        [key: string]: string
        | { val: string }
        | { val: number };
    }
)[] Parameters
- resource: v2ResourceStorage | v2ResourceStorageArray
- asString: boolean
Returns (
    | {
        attributes: undefined
        | { key: string; value: any }[];
        name: string;
        [key: string]:
            | undefined
            | string
            | { val: string }
            | { val: number }
            | { key: string; value: any }[];
    }
    | {
        attributes?: undefined;
        name: string;
        [key: string]: string
        | { val: string }
        | { val: number };
    }
)[]
service
services
SortJSON
transform
v2
v2
- v2HttpOptions(
    http_options: undefined | v2HTTPOptions,
): {
    MaxBodySize: number;
    NextCases: string[];
    NextTimeout: number;
    NextTries: number;
    ReadTimeout: number;
    SendTimeout: number;
} Parameters
- http_options: undefined | v2HTTPOptions
Returns {
    MaxBodySize: number;
    NextCases: string[];
    NextTimeout: number;
    NextTries: number;
    ReadTimeout: number;
    SendTimeout: number;
}
v2
v2
v2
v2
v2
v2
v3
v3
- v3HttpOptions(
    http_options: undefined | v2HTTPOptions,
): {
    maxBodySize: number;
    nextCases: string[];
    nextTimeout: number;
    nextTries: number;
    readTimeout: number;
    sendTimeout: number;
} Parameters
- http_options: undefined | v2HTTPOptions
Returns {
    maxBodySize: number;
    nextCases: string[];
    nextTimeout: number;
    nextTries: number;
    readTimeout: number;
    sendTimeout: number;
}
v3
v3
v3
v3
v3
v3
- v3ServiceResourceEndpoints(
    service: v2Service,
): (
    | { kind: number; sequence_number: number }
    | { kind?: undefined; sequence_number: number }
)[] Parameters
- service: v2Service
Returns (
    | { kind: number; sequence_number: number }
    | { kind?: undefined; sequence_number: number }
)[]
Staticfrom
- fromString(yaml: string, version?: NetworkVersion, networkId?: NetworkId): SDL
Creates an SDL instance from a YAML string.
+Parameters
- yaml: string
The YAML string containing the SDL definition.
+ Optionalversion: NetworkVersion = "beta2"The SDL version (beta2 or beta3).
+OptionalnetworkId: NetworkId = MAINNET_IDThe network ID to validate against.
+
Returns SDL
An instance of the SDL class.
+- yaml: string
Staticvalidate
StaticvalidateGPU
Staticvalidate
- validateStorage(
    name: string,
    storage?: v2ResourceStorage | v2ResourceStorageArray,
): void Validates the storage configuration for a given service.
+Parameters
- name: string
The name of the service.
+ Optionalstorage: v2ResourceStorage | v2ResourceStorageArrayThe storage resource configuration.
+
Returns void
- name: string
diff --git a/docs/enums/network.NETWORK_TYPE.html b/docs/enums/network.NETWORK_TYPE.html
new file mode 100644
index 0000000..cd881d9
--- /dev/null
+++ b/docs/enums/network.NETWORK_TYPE.html
@@ -0,0 +1,5 @@
+
diff --git a/docs/enums/stargate.Message.html b/docs/enums/stargate.Message.html
new file mode 100644
index 0000000..fecb76e
--- /dev/null
+++ b/docs/enums/stargate.Message.html
@@ -0,0 +1,22 @@
+
Enumeration Message
Enum for Akash message types.
+ Index
Enumeration Members
Msg
MsgCloseDeployment: "/akash.deployment.v1beta3.MsgCloseDeployment"
Message type for closing a deployment.
+Msg
MsgCloseGroup: "/akash.deployment.v1beta3.MsgCloseGroup"
Message type for closing a group.
+Msg
MsgCreateCertificate: "/akash.cert.v1beta3.MsgCreateCertificate"
Message type for creating a certificate.
+Msg
MsgCreateDeployment: "/akash.deployment.v1beta3.MsgCreateDeployment"
Message type for creating a deployment.
+Msg
MsgCreateLease: "/akash.market.v1beta4.MsgCreateLease"
Message type for creating a lease.
+Msg
MsgDepositDeployment: "/akash.deployment.v1beta3.MsgDepositDeployment"
Message type for depositing into a deployment.
+Msg
MsgPauseGroup: "/akash.deployment.v1beta3.MsgPauseGroup"
Message type for pausing a group.
+Msg
MsgRevokeCertificate: "/akash.cert.v1beta3.MsgRevokeCertificate"
Message type for revoking a certificate.
+Msg
MsgStartGroup: "/akash.deployment.v1beta3.MsgStartGroup"
Message type for starting a group.
+Msg
MsgUpdateDeployment: "/akash.deployment.v1beta3.MsgUpdateDeployment"
Message type for updating a deployment.
+Function broadcastCertificate
- broadcastCertificate(
    pem: pems | Pick<CertificatePem, "publicKey" | "cert">,
    owner: string,
    client: SigningStargateClient,
): Promise<DeliverTxResponse> Broadcasts a certificate to the blockchain.
+Parameters
- pem: pems | Pick<CertificatePem, "publicKey" | "cert">
The certificate PEM object.
+ - owner: string
The owner of the certificate.
+ - client: SigningStargateClient
The Stargate client used for signing and broadcasting.
+
Returns Promise<DeliverTxResponse>
A promise that resolves to the transaction response.
+- pem: pems | Pick<CertificatePem, "publicKey" | "cert">
Function createCertificate
- createCertificate(bech32Address: string): Promise<CertificatePemDeprecated>
Creates a new certificate for a given Bech32 address.
+Parameters
- bech32Address: string
The Bech32 address for which to create the certificate.
+
Returns Promise<CertificatePemDeprecated>
A promise that resolves to the deprecated certificate PEM object.
+- bech32Address: string
Function queryCertificates
Function revokeCertificate
- revokeCertificate(
    owner: string,
    serial: string,
    client: SigningStargateClient,
): Promise<DeliverTxResponse> Revokes a certificate on the blockchain.
+Parameters
- owner: string
The owner of the certificate.
+ - serial: string
The serial number of the certificate to revoke.
+ - client: SigningStargateClient
The Stargate client used for signing and broadcasting.
+
Returns Promise<DeliverTxResponse>
A promise that resolves to the transaction response.
+- owner: string
Function get
- get(
    chain: Chain,
    signer: OfflineSigner,
    endPoint: string,
): Promise<SigningStargateClient> Connects to a blockchain endpoint with a given signer.
+Parameters
- chain: Chain
The blockchain chain to connect to.
+ - signer: OfflineSigner
The signer to use for the connection.
+ - endPoint: string
The endpoint URL to connect to.
+
Returns Promise<SigningStargateClient>
A promise that resolves to the connected client.
+- chain: Chain
Function getChains
- getChains(): {
    mainnet: { id: string; messagePath: string; name: string };
    testnet: { id: string; messagePath: string; name: string };
} Returns the available blockchain chains.
+Returns {
    mainnet: { id: string; messagePath: string; name: string };
    testnet: { id: string; messagePath: string; name: string };
}An object containing mainnet and testnet chain configurations.
+
diff --git a/docs/functions/network.getEndpointHealthStatus.html b/docs/functions/network.getEndpointHealthStatus.html
new file mode 100644
index 0000000..cdd9438
--- /dev/null
+++ b/docs/functions/network.getEndpointHealthStatus.html
@@ -0,0 +1,7 @@
+
Function getEndpointHealthStatus
- getEndpointHealthStatus(
    timeout: number,
): (
    __namedParameters: { address: string },
) => Promise<
    | { address: string; responseTime: number }
    | { address: string; responseTime: null },
> Creates a function to check the health status of an endpoint.
+Parameters
- timeout: number
The timeout duration for the health check request in milliseconds.
+
Returns (
    __namedParameters: { address: string },
) => Promise<
    | { address: string; responseTime: number }
    | { address: string; responseTime: null },
>A function that takes an endpoint object and returns a promise resolving to the endpoint's health status, including its address and response time.
+Example
+ +import { getEndpointHealthStatus, getEndpoints, NETWORK_TYPE, ENDPOINT_TYPE } from "@akashnetwork/akashjs/build/network";
const checkEndpointHealth = async () => {
try {
const endpoints = await getEndpoints(NETWORK_TYPE.MAINNET, ENDPOINT_TYPE.RPC);
const healthStatusPromises = endpoints.map(endpoint => getEndpointHealthStatus(800)(endpoint));
const healthStatuses = await Promise.all(healthStatusPromises);
console.log("Endpoint Health Statuses:");
healthStatuses.forEach(status => {
console.log(`Address: ${status.address}, Response Time: ${status.responseTime !== null ? status.responseTime + 'ms' : 'Unresponsive'}`);
});
} catch (error) {
console.error("Error checking endpoint health:", error);
}
};
checkEndpointHealth(); +- timeout: number
Function getEndpoints
- getEndpoints(
    network: NETWORK_TYPE,
    type: ENDPOINT_TYPE,
): Promise<{ address: string }[]> Retrieves endpoints for a specific network and type.
+Parameters
- network: NETWORK_TYPE
The network to get endpoints for.
+ - type: ENDPOINT_TYPE
The type of endpoint to retrieve.
+
Returns Promise<{ address: string }[]>
A promise that resolves to an array of endpoint addresses.
+Example
+ +import { NETWORK_TYPE, ENDPOINT_TYPE, getEndpoints } from "@akashnetwork/akashjs/build/network";
async function fetchEndpoints() {
try {
const endpoints = await getEndpoints(NETWORK_TYPE.MAINNET, ENDPOINT_TYPE.REST);
console.log("Endpoints:", JSON.stringify(endpoints, null, 2));
} catch (error) {
console.error("Error fetching endpoints:", error);
}
}
fetchEndpoints(); +- network: NETWORK_TYPE
Function getEndpointsSorted
- getEndpointsSorted(
    network: NETWORK_TYPE,
    type: ENDPOINT_TYPE,
): Promise<{ address: string; responseTime: number | null }[]> Retrieves and sorts endpoints by their health status.
+Parameters
- network: NETWORK_TYPE
The network to get endpoints for.
+ - type: ENDPOINT_TYPE
The type of endpoint to retrieve.
+
Returns Promise<{ address: string; responseTime: number | null }[]>
A promise that resolves to an array of endpoints sorted by response time.
+Example
+ +import { NETWORK_TYPE, ENDPOINT_TYPE, getEndpointsSorted } from "@akashnetwork/akashjs/build/network";
const displaySortedEndpoints = async () => {
try {
const endpoints = await getEndpointsSorted(NETWORK_TYPE.MAINNET, ENDPOINT_TYPE.RPC);
console.log("Sorted Endpoints:", JSON.stringify(endpoints, null, 2));
} catch (error) {
console.error("Error fetching sorted endpoints:", error);
}
};
displaySortedEndpoints(); +- network: NETWORK_TYPE
Function getMetadata
- getMetadata(network: NETWORK_TYPE): Promise<INetworkMetadata>
Fetches metadata for a specified network.
+Parameters
- network: NETWORK_TYPE
The network identifier for which to fetch metadata.
+
Returns Promise<INetworkMetadata>
A promise that resolves to the network metadata.
+Example
+ +import { NETWORK_TYPE, getMetadata } from "@akashnetwork/akashjs/build/network";
async function displayNetworkMetadata() {
try {
const metadata = await getMetadata(NETWORK_TYPE.MAINNET);
console.log("Network Metadata:", metadata);
} catch (error) {
console.error("Error fetching network metadata:", error);
}
}
displayNetworkMetadata(); +- network: NETWORK_TYPE
Function createAminoMessage
- createAminoMessage(
    message: Message,
    messageBody: AminoMsg,
): { typeUrl: Message; value: AminoMsg } Creates an Amino message object.
+Parameters
- message: Message
The type of the message.
+ - messageBody: AminoMsg
The body of the message.
+
Returns { typeUrl: Message; value: AminoMsg }
The Amino message object.
+- message: Message
Function createStarGateMessage
- createStarGateMessage<T extends keyof MessageTypes>(
    message: T,
    messageBody: MessageTypes[T],
): {
    fee: { amount: { amount: string; denom: string }[]; gas: string };
    message: { typeUrl: T; value: MessageTypes[T] };
} Creates a Stargate message object with a fee.
+Type Parameters
Parameters
Returns {
    fee: { amount: { amount: string; denom: string }[]; gas: string };
    message: { typeUrl: T; value: MessageTypes[T] };
}The Stargate message object with a fee.
+
Function getMsgClient
- getMsgClient(
    endpoint: string,
    signer: OfflineSigner,
): Promise<SigningStargateClient> Creates a message client for sending transactions to the Akash network
+Parameters
- endpoint: string
The RPC endpoint URL to connect to
+ - signer: OfflineSigner
The signer used to sign transactions
+
Returns Promise<SigningStargateClient>
A client for signing and sending transactions
+- endpoint: string
Function getQueryClient
diff --git a/docs/functions/stargate.getAkashTypeRegistry.html b/docs/functions/stargate.getAkashTypeRegistry.html
new file mode 100644
index 0000000..dac8b78
--- /dev/null
+++ b/docs/functions/stargate.getAkashTypeRegistry.html
@@ -0,0 +1,3 @@
+
diff --git a/docs/functions/stargate.getTypeUrl.html b/docs/functions/stargate.getTypeUrl.html
new file mode 100644
index 0000000..57c3199
--- /dev/null
+++ b/docs/functions/stargate.getTypeUrl.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/wallet.createAccount.html b/docs/functions/wallet.createAccount.html
new file mode 100644
index 0000000..47fbc29
--- /dev/null
+++ b/docs/functions/wallet.createAccount.html
@@ -0,0 +1,6 @@
+
Function createAccount
Function getAccount
- getAccount(address: string): Promise<any>
Retrieves a wallet account by address.
+This function fetches the mnemonic associated with the given address from local storage +and imports the account using that mnemonic.
+Parameters
- address: string
The address of the account to retrieve.
+
Returns Promise<any>
The wallet accounts associated with the given address.
+- address: string
diff --git a/docs/functions/wallet.importAccount.html b/docs/functions/wallet.importAccount.html
new file mode 100644
index 0000000..7e6d4d0
--- /dev/null
+++ b/docs/functions/wallet.importAccount.html
@@ -0,0 +1,7 @@
+
Function importAccount
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..bd85591
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,122 @@
+
@akashnetwork/akashjs
akashjs
Connect and communicate with the Akash Network. Pure JS library can be used in browser for unsigned transactions, and with node.js for full compatibility.
+Packages
This repository is the home of akashjs, a library designed to facilitate interaction with the Akash Network. However, for full functionality, users will need to integrate several additional libraries. The Akash Network is built using the Cosmos SDK and utilizes the Stargate client for transaction signing and broadcasting. These packages are specifically tailored to enhance interaction with the Akash Network.
| Package | +Description | +
|---|---|
| @akashnetwork/akashjs | +Main library for interacting with the Akash Network | +
| @akashnetwork/akash-api | +Akash API generated from Akash API for interacting with the Akash Network. Documentation is available for node and provider. | +
| @cosmjs/stargate | +A client library for the Cosmos SDK 0.40+ (Stargate). | +
| @cosmjs/proto-signing | +A library for signing and broadcasting transactions using the Cosmos SDK. | +
Documentation
Documentation for the library is available here.
+Compatibility
Compatible with modern browsers, nodejs 14+ and Webpack 5
+Installation
To install the library, run the following command:
+npm install @akashnetwork/akashjs
+Or use the UMD bundle (the object returned is Window.akjs):
<script type="text/javascript" src="https://unpkg.com/@akashnetwork/akashjs@0.10.0/umd/akashjs.js" ></script>
+Getting Started
The following example demonstrates how to fetch the state of the network.
+import { getMetadata } from "@akashnetwork/akashjs/build/network/index.js";
console.log(JSON.stringify(await getMetadata("mainnet"), null, 2))
+More elborate examples can be found in the examples directory.
+Contributing
Project Stack
This repository is primarily written in TypeScript and uses Node.js version 18. We use Webpack 5 for UMD bundling. These tools ensure that our development environment is consistent and our builds are stable.
+Development Setup
-
+
-
+
Prerequisites
+-
+
- Node.js 18 or higher +
- npm or yarn +
- Go 1.19 or higher (for akash-api dependency) +
+ -
+
Installation
+
+
# Clone the repository
git clone https://github.com/akash-network/akashjs
cd akashjs
# Install dependencies
npm install
# Setup git hooks
npm run setup-git-hooks
+-
+
- Development Commands +
# Watch mode for development
npm run dev:watch
# Run tests
npm run test
# Run linting
npm run lint
# Fix linting issues
npm run lint:fix
# Format code
npm run format
# Build the project
npm run build
+Development Guidelines
-
+
-
+
TypeScript
+-
+
- Use strict TypeScript types +
- Avoid using
anytype where possible
+ - Document complex types with JSDoc comments +
+ -
+
Testing
+-
+
- Write unit tests for new features +
- Maintain test coverage +
- Run
npm testbefore submitting PRs
+
+ -
+
Code Style
+-
+
- Follow the existing code style +
- Use Prettier for formatting +
- Follow ESLint rules +
+
Automated CI Checks and Releases
Our project enforces high standards of code quality and consistency through:
+-
+
- Code Linting: ESLint analyzes code for potential errors and style issues +
- Code Formatting: Prettier ensures consistent code formatting +
- Commit Linting: Commits must follow Conventional Commits specification +
- Automated Testing: Tests run automatically on pull requests +
- Semantic Release: Automated versioning based on commit messages +
- Continuous Integration: Validates PRs and manages releases +
To enable git hooks for local development:
+npm run setup-git-hooks
+Pull Request Process
-
+
- Create a feature branch from
main
+ - Make your changes following our guidelines +
- Ensure all tests pass +
- Update documentation as needed +
- Submit a PR with a clear description of changes +
- Wait for review and address any feedback +
Debugging Tips
-
+
- Use the
dev:watchcommand for live reloading during development
+ - Check the
examplesdirectory for implementation references
+ - Use Jest's debugging capabilities with
--inspectflag
+ - Set
DEBUG=akashjs:*environment variable for detailed logs
+
PRs are welcome! By adhering to these guidelines and leveraging our automated systems, we can maintain a high-quality codebase and streamline our development processes.
+Interface pems
Interface representing the PEM-formatted certificate components
+ Index
Properties
Interface INetworkMetadata
Network metadata interface +INetworkMetadata
+interface INetworkMetadata {
    apis: { [type: string]: { address: string }[] };
    bech32_prefix: string;
    chain_id: string;
    chain_name: string;
    codebase: {
        binaries: { [target: string]: string };
        compatible_versions: string[];
        git_repo: string;
        recommended_version: string;
    };
    daemon_name: string;
    genesis: { genesis_url: string };
    network_type: string;
    node_home: string;
    peers: {
        persistent_peers: { address: string; id: string }[];
        seeds: { address: string; id: string }[];
    };
    pretty_name: string;
    status: string;
}
    apis: { [type: string]: { address: string }[] };
    bech32_prefix: string;
    chain_id: string;
    chain_name: string;
    codebase: {
        binaries: { [target: string]: string };
        compatible_versions: string[];
        git_repo: string;
        recommended_version: string;
    };
    daemon_name: string;
    genesis: { genesis_url: string };
    network_type: string;
    node_home: string;
    peers: {
        persistent_peers: { address: string; id: string }[];
        seeds: { address: string; id: string }[];
    };
    pretty_name: string;
    status: string;
}
Index
Properties
Properties
apis
apis: { [type: string]: { address: string }[] }
A mapping of API types to their respective endpoint addresses.
+bech32_
bech32_prefix: string
The prefix used for Bech32 encoded addresses on the network.
+chain_
chain_id: string
A unique identifier for the blockchain network.
+chain_
chain_name: string
The name of the blockchain network.
+codebase
codebase: {
    binaries: { [target: string]: string };
    compatible_versions: string[];
    git_repo: string;
    recommended_version: string;
}
    binaries: { [target: string]: string };
    compatible_versions: string[];
    git_repo: string;
    recommended_version: string;
}
Details about the codebase of the network.
+daemon_
daemon_name: string
The name of the daemon process used by the network.
+genesis
genesis: { genesis_url: string }
Information about the genesis block of the network.
+network_
network_type: string
The type of network, indicating whether it's a mainnet, testnet, or edgenet.
+node_
node_home: string
The directory path where the node's data is stored.
+peers
peers: {
    persistent_peers: { address: string; id: string }[];
    seeds: { address: string; id: string }[];
}
    persistent_peers: { address: string; id: string }[];
    seeds: { address: string; id: string }[];
}
Information about network peers.
+pretty_
pretty_name: string
A human-readable name for the network.
+status
status: string
The current operational status of the network (e.g., active, inactive).
+@akashnetwork/akashjs
Main exports for the Akash JS
+Namespace certificate
Certificate module for handling SSL/TLS certificates.
+ Interfaces
Type Aliases
diff --git a/docs/modules/network.html b/docs/modules/network.html
new file mode 100644
index 0000000..7eb83f2
--- /dev/null
+++ b/docs/modules/network.html
@@ -0,0 +1,3 @@
+
Namespace network
Network module for network-related operations.
+ Enumerations
Interfaces
Namespace protoclient
Protocol client module for protocol buffer client operations.
+Namespace rpc
RPC module for remote procedure calls.
+ Functions
Namespace sdl
SDL module for handling SDL files.
+ Classes
Namespace stargate
Stargate module for interacting with the Cosmos SDK.
+ Enumerations
Functions
Namespace wallet
Wallet module for managing cryptocurrency wallets.
+
diff --git a/docs/variables/sdl.GPU_SUPPORTED_INTERFACES.html b/docs/variables/sdl.GPU_SUPPORTED_INTERFACES.html
new file mode 100644
index 0000000..9624219
--- /dev/null
+++ b/docs/variables/sdl.GPU_SUPPORTED_INTERFACES.html
@@ -0,0 +1 @@
+
Variable GPU_SUPPORTED_INTERFACESConst
GPU_SUPPORTED_INTERFACES: string[] = ...
Variable GPU_SUPPORTED_VENDORSConst
GPU_SUPPORTED_VENDORS: string[] = ...
Variable DEFAULT_ACCOUNT_PASSWORDConst
DEFAULT_ACCOUNT_PASSWORD: "AkashNetwork"
Variable DEFAULT_ADDRESS_PREFIXConst
DEFAULT_ADDRESS_PREFIX: "akash"
Represents an SDL validation error. +Extends the base
+ValidationErrorclass.