joinNetwork

joinNetwork is a method on the ARIO class that joins a gateway to the ar.io network using its associated wallet.

joinNetwork requires authentication.

Parameters

Parameter	Type	Description	Required
qty	number	Amount in mARIO to stake when joining network	Yes
autoStake	boolean	Whether to automatically stake gateway rewards	Yes
allowDelegatedStaking	boolean	Whether to allow third parties to delegate stake	Yes
minDelegatedStake	number	Minimum amount in mARIO that can be delegated	Yes
delegateRewardShareRatio	number	Percentage of rewards to share with delegates (e.g., 10)	Yes
label	string	Gateway name (1-64 characters)	Yes
note	string	Gateway description (max 256 characters)	Yes
properties	string	Arweave transaction ID containing additional gateway configuration	Yes
observerWallet	string	Wallet address used for network observations	Yes
fqdn	string	Valid domain name owned by the gateway operator	Yes
port	number	Port number for gateway access (typically 443)	Yes
protocol	string	Access protocol (only 'https' supported)	Yes
tags	array	An array of GQL tag objects to attach to the transaction	No

Example

joinNetwork

 const fs = require("fs");
 const { ARIO, ArweaveSigner, ARIOToken } = require("@ar.io/sdk");

 async function main() {
 const jwk = JSON.parse(fs.readFileSync("KeyFile.json"));
 const ario = ARIO.init({
     signer: new ArweaveSigner(jwk),
 });

 const { id: txId } = await ario.joinNetwork(
     {
         qty: new ARIOToken(10_000).toMARIO(), // minimum operator stake allowed
         autoStake: true, // auto-stake operator rewards to the gateway
         allowDelegatedStaking: true, // allows delegated staking
         minDelegatedStake: new ARIOToken(100).toMARIO(), // minimum delegated stake allowed
         delegateRewardShareRatio: 10, // percentage of rewards to share with delegates (e.g. 10%)
         label: 'john smith', // min 1, max 64 characters
         note: 'The example gateway', // max 256 characters
         properties: 'FH1aVetOoulPGqgYukj0VE0wIhDy90WiQoV3U2PeY44', // Arweave transaction ID containing additional properties of the Gateway
         observerWallet: '0VE0wIhDy90WiQoV3U2PeY44FH1aVetOoulPGqgYukj', // wallet address of the observer, must match OBSERVER_WALLET on the observer
         fqdn: 'example.com', // fully qualified domain name - note: you must own the domain and set the OBSERVER_WALLET on your gateway to match `observerWallet`
         port: 443, // port number
         protocol: 'https', // only 'https' is supported
     },
     // optional additional tags
     { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
     );
 }

 main();