Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Latest commit

 

History

History
319 lines (242 loc) · 11.6 KB

README.md

File metadata and controls

319 lines (242 loc) · 11.6 KB
Raw

⚠️ This repo is being deprecated in favor of using the Endaoment API Endpoints directly

Check out the documentation in our developers page for more information

Endaoment developers

Endaoment SDK

Gitbook Version Downloads per month
@endaomentdotorg Discord endaoment.eth

This repository contains the SDK for developers to utilize in order to easily assemble blockchain calls to interact with the Endaoment ecosystem as well as interface with Endaoment APIs in order to fetch information on entities like Funds and Orgs.

This TypeScript/JavaScript client utilizes Fetch API. The module can be used in the following environments:

🌎 Environment

  • Node.js
  • Webpack
  • Browserify

🗣️ Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

⚙️ Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Getting started

Navigate to the folder of your consuming project and run the following commands.

yarn add @endaoment/sdk

In order to use the functionality available in the library, you must then import EndaomentSdkApi from the library and instantiate it.

const api = new EndaomentSdkApi()

Optionally, you can pass a Configuration object when you create the variable in order to add things like middleware or to choose which network to use.

const apiConfig = new Configuration({ network: "goerli" })
const api = new EndaomentSdkApi(apiConfig)

Going from there, you will be able to access the available functionalities simply by accessing methods on that object.

api.[functionality to execute]()

👉 Please note the SDK is sub 1.0 release and is subject to breaking API changes

Networks

The three currently supported networks are Ethereum Mainnet, Ethereum Goerli, and Local. Mainnet is the live and fully operational network where actual transactions and operations take place. Goerli is a testnet used for testing and experimentation, allowing developers to try out new features and functionalities without using real money. Local refers to a user's local computer and can point to a locally running EVM or forked node.

The production Endaoment application, app.endaoment.org is on mainnet. Staging, located at app.staging.endaoment.org, is on Goerli. To pull data from a specific site, you may have to change the network.

Examples

Get a list of deployed Orgs, with pagination

api.getDeployedOrgs()

Example response:

[
  {
    id: "12345678-946e-4f90-ad87-b520d4db179b",
    name: "Sostento Inc",
    ein: "843739888",
    contractAddress: "0x9ee4718e6cae47c9ac0ee1cb459332698c3fd25d",
    logoUrl: "https://example.com/the-orgs-logo.jpg",
    nteeCode: "S02",
    nteeDescription: "Management & Technical Assistance",
    description: "Our mission is to save lives by supporting organizations that serve on the frontline of public health emergencies.",
    endaomentUrl: "https://app.endaoment.org/orgs/843739888",
  },
  {
    name: "Open Source Election Technology Institute",
    ein: "208743186",
    id: "..."
    ...
  },
  {
    name: "Rock the Vote",
    ein: "020767157",
    id: "..."
    ...
  },
  ...
]

Since this functionality is paginated, it accepts the arguments of count and offset

Search for an Org (paginated)

api.searchOrgs({
  searchTerm: 'health',
  nteeMajorCodes: 'S',
  countries: 'USA,BRA',
})

This call will result in something like:

[
  {
    name: "Sostento Inc",
    ein: "843739888",
    contractAddress: "0x9ee4718e6cae47c9ac0ee1cb459332698c3fd25d",
    description: "Our mission is to save lives by supporting organizations that serve on the frontline of public health emergencies.",
    endaomentUrl: "https://app.endaoment.org/orgs/843739888",
    nteeCode: "S02",
    nteeDescription: "Management & Technical Assistance",
  },
  ...
]

You can find the full list of NTEE Codes over here.

Since this functionality is paginated, it accepts the arguments of count and offset

Assemble transaction data to Deploy an Org Contract

api.getOrgDeployTransaction({
  einOrId: '020767157' // Deploying Org with this identifier
})

Executing this will return you the Contract Address you must interact with in the to field and the calldata you must provide it in the data field. The client's provider is responsible for executing this transaction with the data provided.

This call will result in something like:

{
  data: "0xa60fe71d3635313031313939390000000000000000000000000000000000000000000000",
  to: "0x10fd9348136dcea154f752fe0b6db45fc298a589",
  value: "0"
}

or in the case that the identifier is invalid, it will look like:

{
  error: "Not Found",
  message: "Could not find org with identifier 123456789",
  statusCode: 404
}

Assemble transaction data to Donate to an Org Contract

api.getDonationSwapTransaction({
    einOrId: '020767157', // Donating to Org with this identifier
    amountIn: '1000000000000000000', // Donating 1 ETH
})

Executing this will return you a full quote to swap any ERC-20 to USDC and donate it to the supplied Org. In order to execute the donation, you must have the client's provider execute a Contract Interaction with the given to address and provide it with the data field as calldata.

This call will result in something like:

{
  "data": "0xa2f48b9f000000000000000000000000df01af7e93453c081408921742043df8c8f8c039000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee0000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001a45ae401dc000000000000000000000000000000000000000000000000000000006424571f00000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000e404e45aaf000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb4800000000000000000000000000000000000000000000000000000000000001f40000000000000000000000007ecc1d4936a973ec3b153c0c713e0f71c59abf530000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000004b2d360700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
  "quote": {
    "expectedUsdc": "1273866693",
    "minimumTolerableUsdc": "1261254151",
    "priceImpact": 0.286908
  },
  "to": "0x7ecc1d4936a973ec3b153c0c713e0f71c59abf53",
  "value": "1000000000000000000"
}

or in the case that the identifier is invalid, it will look like:

{
  error: "Not Found",
  message: "Could not find org with identifier 123456789",
  statusCode: 404
}

Note that USDC donations do not require a swap and will return a direct donate contract call, like the below example

{
  "data": "0xf14faf6f00000000000000000000000000000000000000000000000000000000000f4240",
  "quote": {
    "expectedUsdc": "2500000000",
    "minimumTolerableUsdc": "2500000000",
    "priceImpact": 0
  },
  "to": "0x7ecc1d4936a973ec3b153c0c713e0f71c59abf53",
  "value": "0"
}

Get a list of visible Endaoment Funds (paginated)

api.getVisibleFunds()

Due to visibility settings, this query will only return transparent and community funds. No private funds will be returned.

Search through visible Endaoment Funds (paginated)

sdk.searchVisibleFunds({ name: 'Fund Name' })

Due to visibility settings, this query will only return transparent and community funds. No private funds will be returned.

If you have questions about the different types of funds, see the Endaoment Docs.

Potential Errors

"ReferenceError: fetch is not defined"

This error is due to your environment not having fetch functionality available. It is very important to note that fetch is available in most modern browsers or on Node 18+. In order to use it you will either have to move your project into one of these environments (if its feasible to do so) or install a polyfill for it.

"TypeError: Cannot read properties of undefined (reading 'length')"

This is most likely caused by an incorrect configuration object being supplied to the EndaomentSdkApi class. Please make sure to instantiate it by providing a Configuration class as a parameter, you can import this from the SDK module.

"this.configuration.queryParamsStringify is not a function"

This is most likely caused by an incorrect configuration object being supplied to the EndaomentSdkApi class. Please make sure to instantiate it by providing a Configuration class as a parameter, you can import this from the SDK module.

"The request failed and the interceptors did not return an alternative response"

While there is many possible causes for this particular problem, it is most likely due to an issue with the connection between the client sending the requests and the Endaoment API. Please check your internet connection to make sure all is well. If that does not resolve the issue, there may be a problem occurring with a hosting provider or the API itself.

In case you find an issue that is not listed here, please open an issue on the Github repo.

Building

Please take note that most of the content in this library is automatically generated using an OpenAPI generator. In order to update descriptions or add new functionality, please refer back to the SDK module on Endaoment's backend.

To build and compile the typescript sources to javascript use:

yarn
yarn build

Publishing

First build the package then run yarn publish