AnnaNodes commented 1 year ago

Discussed in https://github.com/cardano-foundation/developer-portal/discussions/161

^{Originally posted by **katomm** July 16, 2021} Please reply here if you have a topic suggestion for the Developer Portal. (unless the suggestion is worth opening its own issue) - if possible please also name the category where the suggested content is missing.

Hello,

We are a node provider NOWNodes.io. Would you kindly add the page about our service to the Cardano documentation, as so we are providing access to a Cardano node.

Get Started/Builder Tools/NOWNodes.io

id: NOWNodes.io title: Free API key on NOWNodes.io sidebar_label: NOWNodes.io description: Getting started for free with NOWNodes.io image: NN logo 2---

Get free API key on NOWNodes.io

A blockchain as a service for nodes and block explorers via API. NowNodes is a great opportunity to join ADA blockchain or to lighten your crypto infrastructure. Connect to full ADA node, block explorer and testnet now!

💻 You can get a free API key now at NOWNodes.io and start coding your next product.

NOWNodes is a blockchain-as-a-service solution that lets users get access to full nodes (shared & dedicated nodes on mainnet & testnet + archived nodes) and block explorers via API key. The service provides access to almost 60 most popular blockchain networks.

NOWNodes provides a high-quality, quick, cost-effective, and reliable infrastructure for developers, start-ups, and businesses that are developing Web 3 projects on the blockchain. The service handles the cost and expertise connected with node maintenance and gives users time to focus on their project rather than node engineering and setup.

By leveraging the power of a blockchain full node, users can access data surrounding the hash rate, block height, wallet addresses, transaction data, balance history tickers list, or anything else that they need. Major projects that need access to the full nodes are crypto wallets, exchanges, payment systems, stock markets, etc.

Vision

“Easy access to multiple blockchain networks lets developers, startups, and businesses focus on projects’ development and scalability in favour of Web 3 growth.”

Mission

“Providing high-quality, cost-effective, and reliable node infrastructure simplifies blockchain integration into your project.”

Features and Services

REST API: NOWNodes uses these APIs to build a blockchain in a quick time and manage it effectively. That said, you need to have a basic knowledge of blockchain to use NOWNodes.
Security: The company understands the importance of offering secure connectivity to manage nodes and transactions. The nodes are monitored to ensure high-level data security.
Low-Latency: The architecture is designed in a way to offer low-latency and fast services. The APIs can be connected and run on multiple data centres at once without comprising the speed of the transactions.
*247 Access**: The company’s servers are always active and accessible. Business will be up and running round the clock on a stable network. This will ensure that users don’t experience any difficulty during their crypto transactions.
Immediate Deployment: The biggest advantage of NOWNodes is that you don’t need to set up nodes on your own. Simply use the API documentation to gain access and get started. Startups, small, medium, and large enterprises, and nonprofit organisations will find it easy to use NOWNodes for their blockchain infrastructure.

Steps to use NOWNodes

Register on NOWNodes website, choose a plan that most fits your needs or start using free API key, simply pick a node address and commands from NOWNodes documentation and send your request.

API Key header

When you sign up on https://www.nownodes.io and choose your free plan, then you can create your x-api-key. You must include the HTTP header x-api-key in every request in order to authenticate the API calls.

:::tip FULL API REFERENCE

Check our API full reference documentation here https://documenter.getpostman.com/view/13630829/TVmFkLwy

:::

Example: Balance

POSTbalance

https://ada.nownodes.io/v2/wallets/{walletId}/transactions-balance

Balance a transaction body of a given transaction, add needed inputs/outputs, so as the transaction can be signed from the wallet.

Example Request


curl --location -g --request POST 'https://ada.nownodes.io/v2/wallets/{walletId}/transactions-balance' \
--header 'api-key: your api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "transaction": {
    "cborHex": "string",
    "description": "Asset minting transaction",
    "type": "string"
  },
  "signatories": [
    "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db11423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"
  ],
  "inputs": [
    {
      "txIn": "2f8cd2ef706e5500307636b8477198ee2f204c4181b53c507f46d195140493cb#1",
      "txOut": {
        "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
        "data": "ca54c8836c475a77c6914b4fd598080acadb0f0067778773484d2c12ae7dc756",
        "value": [
          {
            "lovelace": 1423
          },
          {
            "lovelace": 1423,
            "7191ae0e1286891fe5c027a5dc041b7401689938e18e14ec83cf74fb": {
              "asset1": 12,
              "asset2": 33
            }
          }
        ]
      }
    }
  ]
}'

Example Response

{
  "transaction": "string",
  "coin_selection": {
    "inputs": [
      {
        "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
        "amount": {
          "quantity": 42000000,
          "unit": "lovelace"
        },
        "assets": [
          {
            "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
            "asset_name": "",
            "quantity": 0
          }
        ],
        "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
        "derivation_path": [
          "1852H"
        ],
        "index": 0
      }
    ],
    "outputs": [
      {
        "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
        "amount": {
          "quantity": 42000000,
          "unit": "lovelace"
        },
        "assets": [
          {
            "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
            "asset_name": "",
            "quantity": 0
          }
        ]
      }
    ],
    "change": [
      {
        "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
        "amount": {
          "quantity": 42000000,
          "unit": "lovelace"
        },
        "assets": [
          {
            "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
            "asset_name": "",
            "quantity": 0
          }
        ],
        "derivation_path": [
          "1852H"
        ]
      }
    ],
    "collateral": [
      {
        "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
        "amount": {
          "quantity": 42000000,
          "unit": "lovelace"
        },
        "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
        "derivation_path": [
          "1852H"
        ],
        "index": 0
      }
    ],
    "withdrawals": [
      {
        "stake_address": "stake1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2x",
        "derivation_path": [
          "1852H"
        ],
        "amount": {
          "quantity": 42000000,
          "unit": "lovelace"
        }
      }
    ],
    "certificates": [
      {
        "certificate_type": "join_pool",
        "pool": "pool1wqaz0q0zhtxlgn0ewssevn2mrtm30fgh2g7hr7z9rj5856457mm",
        "reward_account_path": [
          "string",
          "string",
          "string",
          "string",
          "string"
        ]
      }
    ],
    "deposits": [
      {
        "quantity": 42000000,
        "unit": "lovelace"
      }
    ],
    "metadata": "string"
  },
  "fee": {
    "quantity": 42000000,
    "unit": "lovelace"
  }
}

Methods

Estimate fee
Create transaction
Wallets
Migrate
Create a migration plan
Sign
Balance
Construct

MORE INFO

https://documenter.getpostman.com/view/13630829/TVmFkLwy#88923856-92e7-4a94-960a-d2cf5beb8883

rdlrt commented 1 year ago

Sorry, but overlay on cardano-wallet is not really a service you want to recommend on builder tools, it's use case is more suited to small-to-mid sized exchanges or individuals running full node.

When you advertise it as a service, you're putting the user at a risk to all sort of bad practices (MITM attacks, risk of keys being stored on remote servers, etc) - which requires an end user to trust the provider. It almost acts as a shared custodial wallet service.

(PS: You're still free to create a PR and maybe other reviewers might think differently)

AnnaNodes commented 1 year ago

Hello @rdlrt!

Thanks for answer! If the Builder tool is incorrect section for our service. May you recommend where in cardano documentation we can list our cardano node? Which section suits for this best?

rphair commented 1 year ago

@AnnaNodes I agree with @rdlrt's comments in https://github.com/cardano-foundation/developer-portal/issues/852#issuecomment-1307932884 and I believe your offering could fit in this section (you can submit a PR to this repository much like the one you submitted here): Essential Cardano > Infrastructure & Security

The listings on Essential Cardano are understood to have a lower threshold of endorsement: more like a directory of business listings. People would simply find a link to your service & then might rely on your own references & other proofs of trust.

cardano-foundation / developer-portal

Get Started/Builder Tools/NOWNodes.io #852