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.

Examples

joinNetwork

const { id: txId } = await ario.joinNetwork({
    qty: new ARIOToken(10_000).toMARIO(),
    autoStake: true,
    allowDelegatedStaking: true,
    minDelegatedStake: new ARIOToken(100).toMARIO(),
    delegateRewardShareRatio: 10,
    label: 'john smith',
    note: 'The example gateway',
    properties: 'FH1aVetOoulPGqgYukj0VE0wIhDy90WiQoV3U2PeY44',
    observerWallet: '0VE0wIhDy90WiQoV3U2PeY44FH1aVetOoulPGqgYukj',
    fqdn: 'example.com',
    port: 443,
    protocol: 'https'
});

Parameters

ParameterTypeDescriptionRequired
qtynumberAmount in mARIO to stake when joining networkYes
autoStakebooleanWhether to automatically stake gateway rewardsYes
allowDelegatedStakingbooleanWhether to allow third parties to delegate stakeYes
minDelegatedStakenumberMinimum amount in mARIO that can be delegatedYes

delegateRewardShareRatio

number

Percentage of rewards to share with delegates (e.g., 10)

Yes
labelstringGateway name (1-64 characters)Yes
notestringGateway description (max 256 characters)Yes
propertiesstring

Arweave transaction ID containing additional gateway configuration

Yes
observerWalletstringWallet address used for network observationsYes
fqdnstringValid domain name owned by the gateway operatorYes
portnumberPort number for gateway access (typically 443)Yes
protocolstringAccess protocol (only 'https' supported)Yes
tagsarray

An array of GQL tag objects to attach to the transaction

No

Was this page helpful?