You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# 🚀 Golem Base
1
+
# 🚀 GolemDB
2
2
3
-
This is part of the [Golem Base](https://github.com/Golem-Base) project, which is which is designed as a Layer2 Network deployed on Ethereum, acting as a gateway to various Layer 3 Database Chains (DB-Chains).
3
+
This is part of the [GolemDB](https://github.com/Golem-Base) project, which is which is designed as a Layer2 Network deployed on Ethereum, acting as a gateway to various Layer 3 Database Chains (DB-Chains).
4
4
5
-
> **For an overview of Golem Base, check out our [Litepaper](https://golem-base.io/wp-content/uploads/2025/03/GolemBase-Litepaper.pdf).**
5
+
> **For an overview of GolemDB, check out our [Litepaper](https://golem-base.io/wp-content/uploads/2025/03/GolemDB-Litepaper.pdf).**
6
6
7
-
# 🌌GolemBase SDK for TypeScript
7
+
# 🌌GolemDB SDK for TypeScript
8
8
9
-
This SDK allows you to use [GolemBase](https://github.com/Golem-Base) from TypeScript. It is available [on NPM](https://www.npmjs.com/package/golem-base-sdk).
9
+
This SDK allows you to use [GolemDB](https://github.com/Golem-Base) from TypeScript. It is available [on NPM](https://www.npmjs.com/package/golemdb-sdk).
10
10
11
11
We also publish [generated documentation](https://golem-base.github.io/typescript-sdk/).
And now add the golem TypeScript SDK to your package by typing:
59
59
60
60
```
61
-
npm i golem-base-sdk
61
+
npm i golemdb-sdk
62
62
```
63
63
64
64
Now update your package.json file, changing the `type` member to `"type": "module",` and adding the two script lines for `build` and `start`. (Be sure to add a comma after the first script line called test. Also, you can leave the `name` member set to whatever it is. And the order of the members doesn't matter.)
@@ -82,7 +82,7 @@ Now update your package.json file, changing the `type` member to `"type": "modul
82
82
"typescript": "^5.8.3"
83
83
},
84
84
"dependencies": {
85
-
"golem-base-sdk": "^0.1.8"
85
+
"golemdb-sdk": "^0.1.8"
86
86
}
87
87
}
88
88
@@ -121,9 +121,9 @@ This is a basic TypeScript application that:
121
121
122
122
1. Imports several items from the SDK (called "golem-base-sdk") including:
123
123
124
-
*`createClient`: A function that creates a client to interact with GolemBase
125
-
*`type GolemBaseClient`: A type that represents the base client for interacting with Golem
126
-
*`type GolemBaseCreate`: A type representing a create transaction in GolemBase
124
+
*`createClient`: A function that creates a client to interact with GolemDB
125
+
*`type GolemDBClient`: A type that represents the base client for interacting with Golem
126
+
*`type GolemDBCreate`: A type representing a create transaction in GolemDB
127
127
*`Annotation`: A type representing an annotation with a key and a value, used for efficient lookups
128
128
129
129
2. Reads the private key from a wallet, which it locates through the `xdg-portable` module.
@@ -144,7 +144,7 @@ The `main` function demonstrates how to create, modify, and delete entities:
144
144
* One with data `"bar"` and a time to live of `2`, and a numeric annotation of `2`
145
145
* One with data `"qux"` and a time to live of `50`, and a numeric annotation also of `2`
146
146
147
-
Notice that the type of each is GolemBaseCreate.
147
+
Notice that the type of each is GolemDBCreate.
148
148
149
149
4. It then calls client.createEntities to create the entities within Golem. Notice that this returns a promise of an array of items, each of which contain an `entityKey` and an `expirationBlock`.
0 commit comments