External Adapter to pin file to Crust network
cid
: IPFS CID of file to store to crust. This is required.hostNode
: Multiaddress of IPFS node the file is already stored on. This is optional, but providing this could accelerate processing speed of the pinning process.ipfsPinHost
: Ipfs host to pin the file before placing order to Crust network. This should be provided by Oracle node. If not provided, 'https://crustwebsites.net' will be used.crustNodeUrl
: Crust node to send place order request to. If not passed, 'wss:https://rocky-api.crust.network' will be used.crustOrderSeeds
: Private seeds of the Crust account to send the place-order transaction.
{
"jobRunID": "1",
"data": {
"Pins": [ "QmX7gkeWYuDUjRPpgLhUNX9MGzVMYqfqQypKQnht8Qf27P" ],
"result": "QmX7gkeWYuDUjRPpgLhUNX9MGzVMYqfqQypKQnht8Qf27P"
},
"result": "QmX7gkeWYuDUjRPpgLhUNX9MGzVMYqfqQypKQnht8Qf27P",
"statusCode": 200
}
Install dependencies:
yarn
Run the local tests:
yarn test
Natively run the application (defaults to port 8080):
yarn start
curl -X POST -H "content-type:application/json" "http:https://localhost:8080/" --data '{ "id": 0, "data": { "from": "ETH", "to": "USD" } }'
If you wish to use Docker to run the adapter, you can build the image by running the following command:
docker build . -t external-adapter
Then run it with:
docker run -p 8080:8080 -it external-adapter:latest
After installing locally:
zip -r external-adapter.zip .
- In Lambda Functions, create function
- On the Create function page:
- Give the function a name
- Use Node.js 12.x for the runtime
- Choose an existing role or create a new one
- Click Create Function
- Under Function code, select "Upload a .zip file" from the Code entry type drop-down
- Click Upload and select the
external-adapter.zip
file - Handler:
- index.handler for REST API Gateways
- index.handlerv2 for HTTP API Gateways
- Add the environment variable (repeat for all environment variables):
- Key: API_KEY
- Value: Your_API_key
- Save
If using a HTTP API Gateway, Lambda's built-in Test will fail, but you will be able to externally call the function successfully.
- Click Add Trigger
- Select API Gateway in Trigger configuration
- Under API, click Create an API
- Choose HTTP API
- Select the security for the API
- Click Add
If using a REST API Gateway, you will need to disable the Lambda proxy integration for Lambda-based adapter to function.
- Click Add Trigger
- Select API Gateway in Trigger configuration
- Under API, click Create an API
- Choose REST API
- Select the security for the API
- Click Add
- Click the API Gateway trigger
- Click the name of the trigger (this is a link, a new window opens)
- Click Integration Request
- Uncheck Use Lamba Proxy integration
- Click OK on the two dialogs
- Return to your function
- Remove the API Gateway and Save
- Click Add Trigger and use the same API Gateway
- Select the deployment stage and security
- Click Add
- In Functions, create a new function, choose to ZIP upload
- Click Browse and select the
external-adapter.zip
file - Select a Storage Bucket to keep the zip in
- Function to execute: gcpservice
- Click More, Add variable (repeat for all environment variables)
- NAME: API_KEY
- VALUE: Your_API_key