-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into pxrl/batchCompute
- Loading branch information
Showing
30 changed files
with
2,825 additions
and
177 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,3 +31,4 @@ cache | |
| yarn-error.log | ||
| yarn-debug.log* | ||
| gasReporterOutput.json | ||
| logs | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 16 | ||
| 18 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| import Arweave from "arweave"; | ||
| import { JWKInterface } from "arweave/node/lib/wallet"; | ||
| import { ethers } from "ethers"; | ||
| import winston from "winston"; | ||
| import { isDefined, jsonReplacerWithBigNumbers, parseWinston, toBN } from "../../utils"; | ||
| import { Struct, is } from "superstruct"; | ||
| import { ARWEAVE_TAG_APP_NAME } from "../../constants"; | ||
|
|
||
| export class ArweaveClient { | ||
| private client: Arweave; | ||
|
|
||
| public constructor( | ||
| private arweaveJWT: JWKInterface, | ||
| private logger: winston.Logger, | ||
| gatewayURL = "arweave.net", | ||
| protocol = "https", | ||
| port = 443 | ||
| ) { | ||
| this.client = new Arweave({ | ||
| host: gatewayURL, | ||
| port, | ||
| protocol, | ||
| timeout: 20000, | ||
| logging: false, | ||
| }); | ||
| this.logger.info("Arweave client initialized"); | ||
| } | ||
|
|
||
| /** | ||
| * Stores an arbitrary record in the Arweave network. The record is stored as a JSON string and uses | ||
| * JSON.stringify to convert the record to a string. The record has all of its big numbers converted | ||
| * to strings for convenience. | ||
| * @param value The value to store | ||
| * @param topicTag An optional topic tag to add to the transaction | ||
| * @returns The transaction ID of the stored value | ||
| * @ | ||
| */ | ||
| async set(value: Record<string, unknown>, topicTag?: string | undefined): Promise<string | undefined> { | ||
| const transaction = await this.client.createTransaction( | ||
| { data: JSON.stringify(value, jsonReplacerWithBigNumbers) }, | ||
| this.arweaveJWT | ||
| ); | ||
|
|
||
| // Add tags to the transaction | ||
| transaction.addTag("Content-Type", "application/json"); | ||
| transaction.addTag("App-Name", ARWEAVE_TAG_APP_NAME); | ||
| if (isDefined(topicTag)) { | ||
| transaction.addTag("Topic", topicTag); | ||
| } | ||
|
|
||
| // Sign the transaction | ||
| await this.client.transactions.sign(transaction, this.arweaveJWT); | ||
| // Send the transaction | ||
| const result = await this.client.transactions.post(transaction); | ||
|
|
||
| // Ensure that the result is successful | ||
| if (result.status !== 200) { | ||
| const message = result?.data?.error?.msg ?? "Unknown error"; | ||
| this.logger.error({ | ||
| at: "ArweaveClient:set", | ||
| message, | ||
| result, | ||
| txn: transaction.id, | ||
| address: await this.getAddress(), | ||
| balance: (await this.getBalance()).toString(), | ||
| }); | ||
| throw new Error(message); | ||
| } else { | ||
| this.logger.debug({ | ||
| at: "ArweaveClient:set", | ||
| message: `Arweave transaction posted with ${transaction.id}`, | ||
| }); | ||
| } | ||
| return transaction.id; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves a record from the Arweave network. The record is expected to be a JSON string and is | ||
| * parsed using JSON.parse. All numeric strings are converted to big numbers for convenience. | ||
| * @param transactionID The transaction ID of the record to retrieve | ||
| * @param structValidator An optional struct validator to validate the retrieved value. If the value does not match the struct, null is returned. | ||
| * @returns The record if it exists, otherwise null | ||
| */ | ||
| async get<T>(transactionID: string, validator: Struct<T>): Promise<T | null> { | ||
| const rawData = await this.client.transactions.getData(transactionID, { decode: true, string: true }); | ||
| if (!rawData) { | ||
| return null; | ||
| } | ||
| // Parse the retrieved data - if it is an Uint8Array, it is a buffer and needs to be converted to a string | ||
| const data = JSON.parse(typeof rawData === "string" ? rawData : Buffer.from(rawData).toString("utf-8")); | ||
| // Ensure that the result is successful. If it is not, the retrieved value is not our expected type | ||
| // but rather a {status: string, statusText: string} object. We can detect that and return null. | ||
| if (data.status === 400) { | ||
| return null; | ||
| } | ||
| // If the validator does not match the retrieved value, return null and log a warning | ||
| if (!is(data, validator)) { | ||
| this.logger.warn("Retrieved value from Arweave does not match the expected type"); | ||
| return null; | ||
| } | ||
| return data; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves a list of records from the Arweave network that have a specific tag. | ||
| * The records are expected to be a JSON string and are pre-filtered by the Across | ||
| * protocol tag, the content-type tag, and this client's address. Furthermore, the | ||
| * records are expected to be an array of the given type and will be discarded if | ||
| * they do not match the given validator. | ||
| * @param tag The tag to filter all the transactions by | ||
| * @param validator The validator to validate the retrieved values | ||
| * @returns The records if they exist, otherwise an empty array | ||
| */ | ||
| async getByTopic<T>(tag: string, validator: Struct<T>): Promise<{ data: T; hash: string }[]> { | ||
| const transactions = await this.client.api.post<{ | ||
| data: { | ||
| transactions: { | ||
| edges: { | ||
| node: { | ||
| id: string; | ||
| }; | ||
| }[]; | ||
| }; | ||
| }; | ||
| }>("/graphql", { | ||
| query: ` | ||
| { | ||
| transactions ( | ||
| owners: ["${await this.getAddress()}"] | ||
| tags: [ | ||
| { name: "App-Name", values: ["${ARWEAVE_TAG_APP_NAME}"] }, | ||
| { name: "Content-Type", values: ["application/json"] }, | ||
| ${tag ? `{ name: "Topic", values: ["${tag}"] } ` : ""} | ||
| ] | ||
| ) { edges { node { id } } } | ||
| }`, | ||
| }); | ||
| const results = await Promise.all( | ||
| transactions.data.data.transactions.edges.map(async (edge) => { | ||
| const data = await this.get<T>(edge.node.id, validator); | ||
| return isDefined(data) | ||
| ? { | ||
| data, | ||
| hash: edge.node.id, | ||
| } | ||
| : null; | ||
| }) | ||
| ); | ||
| return results.filter(isDefined); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the metadata of a transaction | ||
| * @param transactionID The transaction ID of the record to retrieve | ||
| * @returns The metadata of the transaction if it exists, otherwise null | ||
| */ | ||
| async getMetadata(transactionID: string): Promise<Record<string, string> | null> { | ||
| const transaction = await this.client.transactions.get(transactionID); | ||
| if (!isDefined(transaction)) { | ||
| return null; | ||
| } | ||
| const tags = Object.fromEntries( | ||
| transaction.tags.map((tag) => [ | ||
| tag.get("name", { decode: true, string: true }), | ||
| tag.get("value", { decode: true, string: true }), | ||
| ]) | ||
| ); | ||
| return { | ||
| contentType: tags["Content-Type"], | ||
| appName: tags["App-Name"], | ||
| topic: tags.Topic, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the address of the signer of the JWT | ||
| * @returns The address of the signer in this client | ||
| */ | ||
| getAddress(): Promise<string> { | ||
| return this.client.wallets.jwkToAddress(this.arweaveJWT); | ||
| } | ||
|
|
||
| /** | ||
| * The balance of the signer | ||
| * @returns The balance of the signer in winston units | ||
| */ | ||
| async getBalance(): Promise<ethers.BigNumber> { | ||
| const address = await this.getAddress(); | ||
| const balanceInFloat = await this.client.wallets.getBalance(address); | ||
| // Sometimes the balance is returned in scientific notation, so we need to | ||
| // convert it to a BigNumber | ||
| if (balanceInFloat.includes("e")) { | ||
| const [balance, exponent] = balanceInFloat.split("e"); | ||
| const resultingBN = ethers.BigNumber.from(balance).mul(toBN(10).pow(exponent.replace("+", ""))); | ||
| return parseWinston(resultingBN.toString()); | ||
| } else { | ||
| return parseWinston(balanceInFloat); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from "./ArweaveClient"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export * from "./IPFS"; | ||
| export * from "./Arweave"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.